-- SPDX-FileCopyrightText: 2026 Alexandra de Wit
--
-- SPDX-License-Identifier: MIT

{- | Retained-document accounting and fixed resource estimates.
Compact representation charges differ from original source bytes. The retained estimate
does not bound active input, parser, policy, merge, or output memory.
-}
module Ecluse.Core.Server.MemoryModel (
    expandWireBytes,
    expandWireBytesInteger,
    chargeForResident,
    mirrorJobEstimatedBytes,
    bufferedChunkCharge,
    decodedDocumentCharge,
    saturatingCharge,
) where

import Data.ByteString qualified as BS

{- | Estimate retained bytes from a compact representation charge using the 7.5 factor.
This factor is independent of source-byte regression envelopes and active-work admission.
-}
expandWireBytes :: Int -> Int
expandWireBytes :: Int -> Int
expandWireBytes = Int -> Int
forall a. Integral a => a -> a
expandWireCharge

-- | Expand retained-state terms before their final saturating conversion to Int.
expandWireBytesInteger :: Integer -> Integer
expandWireBytesInteger :: Integer -> Integer
expandWireBytesInteger = Integer -> Integer
forall a. Integral a => a -> a
expandWireCharge

expandWireCharge :: (Integral a) => a -> a
expandWireCharge :: forall a. Integral a => a -> a
expandWireCharge a
wireBytes = a
wireBytes a -> a -> a
forall a. Num a => a -> a -> a
* Int -> a
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
residentRatioNumerator a -> a -> a
forall a. Integral a => a -> a -> a
`div` Int -> a
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
residentRatioDenominator

-- | The smallest compact charge that 'expandWireBytes' expands to at least the given heap bytes.
chargeForResident :: Int -> Int
chargeForResident :: Int -> Int
chargeForResident Int
resident = (Int
resident Int -> Int -> Int
forall a. Num a => a -> a -> a
* Int
residentRatioDenominator Int -> Int -> Int
forall a. Num a => a -> a -> a
+ Int
residentRatioNumerator Int -> Int -> Int
forall a. Num a => a -> a -> a
- Int
1) Int -> Int -> Int
forall a. Integral a => a -> a -> a
`div` Int
residentRatioNumerator

residentRatioNumerator :: Int
residentRatioNumerator :: Int
residentRatioNumerator = Int
15

residentRatioDenominator :: Int
residentRatioDenominator :: Int
residentRatioDenominator = Int
2

-- | The resident-byte allowance per in-memory mirror queue slot.
mirrorJobEstimatedBytes :: Int
mirrorJobEstimatedBytes :: Int
mirrorJobEstimatedBytes = Int
1024

-- | Allow four overlapping byte copies and builder/list cells before retaining a nonempty chunk.
bufferedChunkCharge :: Int -> Int
bufferedChunkCharge :: Int -> Int
bufferedChunkCharge = Integer -> Int
saturatingCharge (Integer -> Int) -> (Int -> Integer) -> Int -> Int
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Integer -> Integer
bufferedChargeInteger (Integer -> Integer) -> (Int -> Integer) -> Int -> Integer
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> Integer
forall a. Integral a => a -> Integer
toInteger

bufferedChargeInteger :: Integer -> Integer
bufferedChargeInteger :: Integer -> Integer
bufferedChargeInteger Integer
bytes
    | Integer
bytes Integer -> Integer -> Bool
forall a. Ord a => a -> a -> Bool
<= Integer
0 = Integer
0
    | Bool
otherwise = Integer
4 Integer -> Integer -> Integer
forall a. Num a => a -> a -> a
* Integer
bytes Integer -> Integer -> Integer
forall a. Num a => a -> a -> a
+ Integer
128

-- | Estimate scalar copies and tree/domain slots from actual JSON or XML bytes before decoding.
decodedDocumentCharge :: ByteString -> Int
decodedDocumentCharge :: ByteString -> Int
decodedDocumentCharge ByteString
bytes
    | ByteString -> Bool
BS.null ByteString
bytes = Int
0
    | Bool
otherwise = Integer -> Int
saturatingCharge (Integer
4096 Integer -> Integer -> Integer
forall a. Num a => a -> a -> a
+ Integer
8 Integer -> Integer -> Integer
forall a. Num a => a -> a -> a
* Int -> Integer
forall a. Integral a => a -> Integer
toInteger (ByteString -> Int
BS.length ByteString
bytes) Integer -> Integer -> Integer
forall a. Num a => a -> a -> a
+ Integer
512 Integer -> Integer -> Integer
forall a. Num a => a -> a -> a
* Integer
markers)
  where
    markers :: Integer
markers = (Integer -> Word8 -> Integer) -> Integer -> ByteString -> Integer
forall a. (a -> Word8 -> a) -> a -> ByteString -> a
BS.foldl' (\Integer
count Word8
byte -> if Word8
byte Word8 -> [Word8] -> Bool
forall (f :: * -> *) a.
(Foldable f, DisallowElem f, Eq a) =>
a -> f a -> Bool
`elem` [Word8
34, Word8
44, Word8
58, Word8
60, Word8
62, Word8
91, Word8
93, Word8
123, Word8
125] then Integer
count Integer -> Integer -> Integer
forall a. Num a => a -> a -> a
+ Integer
1 else Integer
count) Integer
0 ByteString
bytes

-- | Clamp an Integer charge into the Int admission interface: below zero to zero, past 'maxBound' to 'maxBound'.
saturatingCharge :: Integer -> Int
saturatingCharge :: Integer -> Int
saturatingCharge = Integer -> Int
forall a. Num a => Integer -> a
fromInteger (Integer -> Int) -> (Integer -> Integer) -> Integer -> Int
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Integer -> Integer -> Integer
forall a. Ord a => a -> a -> a
max Integer
0 (Integer -> Integer) -> (Integer -> Integer) -> Integer -> Integer
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Integer -> Integer -> Integer
forall a. Ord a => a -> a -> a
min (Int -> Integer
forall a. Integral a => a -> Integer
toInteger (Int
forall a. Bounded a => a
maxBound :: Int))