Safe Haskell | None |
---|---|
Language | GHC2021 |
Synopsis
- type WordOff = Int
- type ByteOff = Int
- wordsToBytes :: Num a => Platform -> a -> a
- bytesToWordsRoundUp :: Platform -> ByteOff -> WordOff
- roundUpToWords :: Platform -> ByteOff -> ByteOff
- roundUpTo :: ByteOff -> ByteOff -> ByteOff
- data StgWord
- fromStgWord :: StgWord -> Integer
- toStgWord :: Platform -> Integer -> StgWord
- data StgHalfWord
- fromStgHalfWord :: StgHalfWord -> Integer
- toStgHalfWord :: Platform -> Integer -> StgHalfWord
- halfWordSize :: Platform -> ByteOff
- halfWordSizeInBits :: Platform -> Int
- data SMRep
- type IsStatic = Bool
- data ClosureTypeInfo
- = Constr ConTagZ ConstrDescription
- | Fun FunArity ArgDescr
- | Thunk
- | ThunkSelector SelectorOffset
- | BlackHole
- | IndStatic
- data ArgDescr
- = ArgSpec !Int
- | ArgGen Liveness
- | ArgUnknown
- type Liveness = [Bool]
- type ConstrDescription = ByteString
- mkHeapRep :: Profile -> IsStatic -> WordOff -> WordOff -> ClosureTypeInfo -> SMRep
- blackHoleRep :: SMRep
- indStaticRep :: SMRep
- mkStackRep :: [Bool] -> SMRep
- mkRTSRep :: Int -> SMRep -> SMRep
- arrPtrsRep :: Platform -> WordOff -> SMRep
- smallArrPtrsRep :: WordOff -> SMRep
- arrWordsRep :: Platform -> ByteOff -> SMRep
- isStaticRep :: SMRep -> IsStatic
- isConRep :: SMRep -> Bool
- isThunkRep :: SMRep -> Bool
- isFunRep :: SMRep -> Bool
- isStaticNoCafCon :: SMRep -> Bool
- isStackRep :: SMRep -> Bool
- heapClosureSizeW :: Profile -> SMRep -> WordOff
- fixedHdrSizeW :: Profile -> WordOff
- arrWordsHdrSize :: Profile -> ByteOff
- arrWordsHdrSizeW :: Profile -> WordOff
- arrPtrsHdrSize :: Profile -> ByteOff
- arrPtrsHdrSizeW :: Profile -> WordOff
- profHdrSize :: Profile -> WordOff
- thunkHdrSize :: Profile -> WordOff
- nonHdrSize :: Platform -> SMRep -> ByteOff
- nonHdrSizeW :: SMRep -> WordOff
- smallArrPtrsHdrSize :: Profile -> ByteOff
- smallArrPtrsHdrSizeW :: Profile -> WordOff
- hdrSize :: Profile -> SMRep -> ByteOff
- hdrSizeW :: Profile -> SMRep -> WordOff
- fixedHdrSize :: Profile -> ByteOff
- rtsClosureType :: SMRep -> Int
- rET_SMALL :: Int
- rET_BIG :: Int
- aRG_GEN :: Int
- aRG_GEN_BIG :: Int
- card :: Platform -> Int -> Int
- cardRoundUp :: Platform -> Int -> Int
- cardTableSizeB :: Platform -> Int -> ByteOff
- cardTableSizeW :: Platform -> Int -> WordOff
Words and bytes
wordsToBytes :: Num a => Platform -> a -> a Source #
Convert the given number of words to a number of bytes.
This function morally has type WordOff -> ByteOff
, but uses Num
a
to allow for overloading.
bytesToWordsRoundUp :: Platform -> ByteOff -> WordOff Source #
First round the given byte count up to a multiple of the machine's word size and then convert the result to words.
roundUpToWords :: Platform -> ByteOff -> ByteOff Source #
Round up the given byte count to the next byte count that's a multiple of the machine's word size.
Instances
Outputable StgWord Source # | |
Bits StgWord Source # | |
Defined in GHC.Runtime.Heap.Layout (.&.) :: StgWord -> StgWord -> StgWord # (.|.) :: StgWord -> StgWord -> StgWord # xor :: StgWord -> StgWord -> StgWord # complement :: StgWord -> StgWord # shift :: StgWord -> Int -> StgWord # rotate :: StgWord -> Int -> StgWord # setBit :: StgWord -> Int -> StgWord # clearBit :: StgWord -> Int -> StgWord # complementBit :: StgWord -> Int -> StgWord # testBit :: StgWord -> Int -> Bool # bitSizeMaybe :: StgWord -> Maybe Int # shiftL :: StgWord -> Int -> StgWord # unsafeShiftL :: StgWord -> Int -> StgWord # shiftR :: StgWord -> Int -> StgWord # unsafeShiftR :: StgWord -> Int -> StgWord # rotateL :: StgWord -> Int -> StgWord # | |
Eq StgWord Source # | |
fromStgWord :: StgWord -> Integer Source #
data StgHalfWord Source #
Instances
Outputable StgHalfWord Source # | |
Defined in GHC.Runtime.Heap.Layout ppr :: StgHalfWord -> SDoc Source # | |
Eq StgHalfWord Source # | |
Defined in GHC.Runtime.Heap.Layout (==) :: StgHalfWord -> StgHalfWord -> Bool # (/=) :: StgHalfWord -> StgHalfWord -> Bool # |
fromStgHalfWord :: StgHalfWord -> Integer Source #
toStgHalfWord :: Platform -> Integer -> StgHalfWord Source #
halfWordSize :: Platform -> ByteOff Source #
Half word size in bytes
halfWordSizeInBits :: Platform -> Int Source #
Closure representation
A description of the layout of a closure. Corresponds directly to the closure types in includes/rts/storage/ClosureTypes.h.
HeapRep IsStatic !WordOff !WordOff ClosureTypeInfo | |
ArrayPtrsRep !WordOff !WordOff | |
SmallArrayPtrsRep !WordOff | |
ArrayWordsRep !WordOff | |
StackRep Liveness | |
RTSRep Int SMRep |
True <=> This is a static closure. Affects how we garbage-collect it. Static closure have an extra static link field at the end. Constructors do not have a static variant; see Note [static constructors]
data ClosureTypeInfo Source #
Constr ConTagZ ConstrDescription | |
Fun FunArity ArgDescr | |
Thunk | |
ThunkSelector SelectorOffset | |
BlackHole | |
IndStatic |
Instances
Outputable ClosureTypeInfo Source # | |
Defined in GHC.Runtime.Heap.Layout ppr :: ClosureTypeInfo -> SDoc Source # | |
Eq ClosureTypeInfo Source # | |
Defined in GHC.Runtime.Heap.Layout (==) :: ClosureTypeInfo -> ClosureTypeInfo -> Bool # (/=) :: ClosureTypeInfo -> ClosureTypeInfo -> Bool # | |
Ord ClosureTypeInfo Source # | |
Defined in GHC.Runtime.Heap.Layout compare :: ClosureTypeInfo -> ClosureTypeInfo -> Ordering # (<) :: ClosureTypeInfo -> ClosureTypeInfo -> Bool # (<=) :: ClosureTypeInfo -> ClosureTypeInfo -> Bool # (>) :: ClosureTypeInfo -> ClosureTypeInfo -> Bool # (>=) :: ClosureTypeInfo -> ClosureTypeInfo -> Bool # max :: ClosureTypeInfo -> ClosureTypeInfo -> ClosureTypeInfo # min :: ClosureTypeInfo -> ClosureTypeInfo -> ClosureTypeInfo # |
An ArgDescr describes the argument pattern of a function
type Liveness = [Bool] Source #
We represent liveness bitmaps as a Bitmap (whose internal representation really is a bitmap). These are pinned onto case return vectors to indicate the state of the stack for the garbage collector.
In the compiled program, liveness bitmaps that fit inside a single word (StgWord) are stored as a single word, while larger bitmaps are stored as a pointer to an array of words.
type ConstrDescription = ByteString Source #
Construction
blackHoleRep :: SMRep Source #
indStaticRep :: SMRep Source #
mkStackRep :: [Bool] -> SMRep Source #
smallArrPtrsRep :: WordOff -> SMRep Source #
Predicates
isStaticRep :: SMRep -> IsStatic Source #
isThunkRep :: SMRep -> Bool Source #
isStaticNoCafCon :: SMRep -> Bool Source #
isStackRep :: SMRep -> Bool Source #
Size-related things
fixedHdrSizeW :: Profile -> WordOff Source #
Size of a closure header (StgHeader in includes/rts/storage/Closures.h)
arrWordsHdrSize :: Profile -> ByteOff Source #
arrWordsHdrSizeW :: Profile -> WordOff Source #
arrPtrsHdrSize :: Profile -> ByteOff Source #
arrPtrsHdrSizeW :: Profile -> WordOff Source #
profHdrSize :: Profile -> WordOff Source #
Size of the profiling part of a closure header (StgProfHeader in includes/rts/storage/Closures.h)
thunkHdrSize :: Profile -> WordOff Source #
nonHdrSizeW :: SMRep -> WordOff Source #
smallArrPtrsHdrSize :: Profile -> ByteOff Source #
fixedHdrSize :: Profile -> ByteOff Source #
RTS closure types
aRG_GEN_BIG :: Int Source #
Arrays
card :: Platform -> Int -> Int Source #
The byte offset into the card table of the card for a given element