Safe Haskell	None
Language	GHC2024

Circuit.Meter.Space

Contents

Space meter
Types

Description

Space measurement as a Circuit.

GHC RTS allocation statistics read before and after a computation. allocX measures allocated bytes; SpaceStats is available for users who want the full RTS snapshot.

Synopsis

allocX :: Meter (K IO) Bytes Bytes
allocGC :: Meter (K IO) Bytes Bytes
data SpaceStats = SpaceStats {
- allocated :: !Word64
- copied :: !Word64
- maxmem :: !Word64
- minorgcs :: !Word32
- majorgcs :: !Word32
}
newtype Bytes = Bytes {
- unbytes :: Word64
}

Space meter

allocX :: Meter (K IO) Bytes Bytes Source #

Measure only allocated bytes.

allocGC :: Meter (K IO) Bytes Bytes Source #

Measure allocated bytes with GC-forced boundaries.

Forces a major GC before reading the counter at both start and stop. This gives accurate per-interval allocation at the cost of GC overhead (a stop-the-world collection on every measurement boundary).

Use allocX for lightweight (but potentially stale) measurements; use allocGC when you need accurate per-stage numbers.

Types

data SpaceStats Source #

Allocation statistics from the GHC RTS.

Constructors

SpaceStats
Fields allocated :: !Word64 copied :: !Word64 maxmem :: !Word64 minorgcs :: !Word32 majorgcs :: !Word32

Instances

Instances details

Monoid SpaceStats Source #
Instance details Defined in Circuit.Meter.Space Methods mempty :: SpaceStats # mappend :: SpaceStats -> SpaceStats -> SpaceStats # mconcat :: [SpaceStats] -> SpaceStats #
Semigroup SpaceStats Source #
Instance details Defined in Circuit.Meter.Space Methods (<>) :: SpaceStats -> SpaceStats -> SpaceStats # sconcat :: NonEmpty SpaceStats -> SpaceStats # stimes :: Integral b => b -> SpaceStats -> SpaceStats #
Eq SpaceStats Source #
Instance details Defined in Circuit.Meter.Space Methods (==) :: SpaceStats -> SpaceStats -> Bool # (/=) :: SpaceStats -> SpaceStats -> Bool #
Read SpaceStats Source #
Instance details Defined in Circuit.Meter.Space Methods readsPrec :: Int -> ReadS SpaceStats # readList :: ReadS [SpaceStats] # readPrec :: ReadPrec SpaceStats # readListPrec :: ReadPrec [SpaceStats] #
Show SpaceStats Source #
Instance details Defined in Circuit.Meter.Space Methods showsPrec :: Int -> SpaceStats -> ShowS # show :: SpaceStats -> String # showList :: [SpaceStats] -> ShowS #

newtype Bytes Source #

Number of bytes.

Constructors

Bytes
Fields unbytes :: Word64

Instances

Instances details

Monoid Bytes Source #
Instance details Defined in Circuit.Meter.Space Methods mempty :: Bytes # mappend :: Bytes -> Bytes -> Bytes # mconcat :: [Bytes] -> Bytes #
Semigroup Bytes Source #
Instance details Defined in Circuit.Meter.Space Methods (<>) :: Bytes -> Bytes -> Bytes # sconcat :: NonEmpty Bytes -> Bytes # stimes :: Integral b => b -> Bytes -> Bytes #
Eq Bytes Source #
Instance details Defined in Circuit.Meter.Space Methods (==) :: Bytes -> Bytes -> Bool # (/=) :: Bytes -> Bytes -> Bool #
Ord Bytes Source #
Instance details Defined in Circuit.Meter.Space Methods compare :: Bytes -> Bytes -> Ordering # (<) :: Bytes -> Bytes -> Bool # (<=) :: Bytes -> Bytes -> Bool # (>) :: Bytes -> Bytes -> Bool # (>=) :: Bytes -> Bytes -> Bool # max :: Bytes -> Bytes -> Bytes # min :: Bytes -> Bytes -> Bytes #
Enum Bytes Source #
Instance details Defined in Circuit.Meter.Space Methods succ :: Bytes -> Bytes # pred :: Bytes -> Bytes # toEnum :: Int -> Bytes # fromEnum :: Bytes -> Int # enumFrom :: Bytes -> [Bytes] # enumFromThen :: Bytes -> Bytes -> [Bytes] # enumFromTo :: Bytes -> Bytes -> [Bytes] # enumFromThenTo :: Bytes -> Bytes -> Bytes -> [Bytes] #
Num Bytes Source #
Instance details Defined in Circuit.Meter.Space Methods (+) :: Bytes -> Bytes -> Bytes # (-) :: Bytes -> Bytes -> Bytes # (*) :: Bytes -> Bytes -> Bytes # negate :: Bytes -> Bytes # abs :: Bytes -> Bytes # signum :: Bytes -> Bytes # fromInteger :: Integer -> Bytes #
Read Bytes Source #
Instance details Defined in Circuit.Meter.Space Methods readsPrec :: Int -> ReadS Bytes # readList :: ReadS [Bytes] # readPrec :: ReadPrec Bytes # readListPrec :: ReadPrec [Bytes] #
Integral Bytes Source #
Instance details Defined in Circuit.Meter.Space Methods quot :: Bytes -> Bytes -> Bytes # rem :: Bytes -> Bytes -> Bytes # div :: Bytes -> Bytes -> Bytes # mod :: Bytes -> Bytes -> Bytes # quotRem :: Bytes -> Bytes -> (Bytes, Bytes) # divMod :: Bytes -> Bytes -> (Bytes, Bytes) # toInteger :: Bytes -> Integer #
Real Bytes Source #
Instance details Defined in Circuit.Meter.Space Methods toRational :: Bytes -> Rational #
Show Bytes Source #
Instance details Defined in Circuit.Meter.Space Methods showsPrec :: Int -> Bytes -> ShowS # show :: Bytes -> String # showList :: [Bytes] -> ShowS #