ghc-8.2.2: The GHC API

Safe Haskell | None
Language | Haskell2010

SMRep

Contents

- Words and bytes
- Closure repesentation
  - Construction
  - Predicates
  - Size-related things
  - RTS closure types
  - Arrays
- Operations over [Word8] strings that don't belong here

Synopsis

- type WordOff = Int
- type ByteOff = Int
- wordsToBytes :: Num a => DynFlags -> a -> a
- bytesToWordsRoundUp :: DynFlags -> ByteOff -> WordOff
- roundUpToWords :: DynFlags -> ByteOff -> ByteOff
- data StgWord
- fromStgWord :: StgWord -> Integer
- toStgWord :: DynFlags -> Integer -> StgWord
- data StgHalfWord
- fromStgHalfWord :: StgHalfWord -> Integer
- toStgHalfWord :: DynFlags -> Integer -> StgHalfWord
- hALF_WORD_SIZE :: DynFlags -> ByteOff
- hALF_WORD_SIZE_IN_BITS :: DynFlags -> Int
- data SMRep
  - = HeapRep IsStatic !WordOff !WordOff ClosureTypeInfo
  - | ArrayPtrsRep !WordOff !WordOff
  - | SmallArrayPtrsRep !WordOff
  - | ArrayWordsRep !WordOff
  - | StackRep Liveness
  - | RTSRep Int SMRep
- type IsStatic = Bool
- data ClosureTypeInfo
  - = Constr ConstrTag ConstrDescription
  - | Fun FunArity ArgDescr
  - | Thunk
  - | ThunkSelector SelectorOffset
  - | BlackHole
  - | IndStatic
- data ArgDescr
  - = ArgSpec !Int
  - | ArgGen Liveness
- type Liveness = [Bool]
- type ConstrDescription = [Word8]
- mkHeapRep :: DynFlags -> IsStatic -> WordOff -> WordOff -> ClosureTypeInfo -> SMRep
- blackHoleRep :: SMRep
- indStaticRep :: SMRep
- mkStackRep :: [Bool] -> SMRep
- mkRTSRep :: Int -> SMRep -> SMRep
- arrPtrsRep :: DynFlags -> WordOff -> SMRep
- smallArrPtrsRep :: WordOff -> SMRep
- arrWordsRep :: DynFlags -> ByteOff -> SMRep
- isStaticRep :: SMRep -> IsStatic
- isConRep :: SMRep -> Bool
- isThunkRep :: SMRep -> Bool
- isFunRep :: SMRep -> Bool
- isStaticNoCafCon :: SMRep -> Bool
- isStackRep :: SMRep -> Bool
- heapClosureSizeW :: DynFlags -> SMRep -> WordOff
- fixedHdrSizeW :: DynFlags -> WordOff
- arrWordsHdrSize :: DynFlags -> ByteOff
- arrWordsHdrSizeW :: DynFlags -> WordOff
- arrPtrsHdrSize :: DynFlags -> ByteOff
- arrPtrsHdrSizeW :: DynFlags -> WordOff
- profHdrSize :: DynFlags -> WordOff
- thunkHdrSize :: DynFlags -> WordOff
- nonHdrSize :: DynFlags -> SMRep -> ByteOff
- nonHdrSizeW :: SMRep -> WordOff
- smallArrPtrsHdrSize :: DynFlags -> ByteOff
- smallArrPtrsHdrSizeW :: DynFlags -> WordOff
- hdrSize :: DynFlags -> SMRep -> ByteOff
- hdrSizeW :: DynFlags -> SMRep -> WordOff
- fixedHdrSize :: DynFlags -> ByteOff
- rtsClosureType :: SMRep -> Int
- rET_SMALL :: Int
- rET_BIG :: Int
- aRG_GEN :: Int
- aRG_GEN_BIG :: Int
- card :: DynFlags -> Int -> Int
- cardRoundUp :: DynFlags -> Int -> Int
- cardTableSizeB :: DynFlags -> Int -> ByteOff
- cardTableSizeW :: DynFlags -> Int -> WordOff
- pprWord8String :: [Word8] -> SDoc
- stringToWord8s :: String -> [Word8]

# Words and bytes

type WordOff = Int #

Word offset, or word count

type ByteOff = Int #

Byte offset, or byte count

wordsToBytes :: Num a => DynFlags -> a -> a #

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 :: DynFlags -> ByteOff -> WordOff #

First round the given byte count up to a multiple of the machine's word size and then convert the result to words.

roundUpToWords :: DynFlags -> ByteOff -> ByteOff #

Round up the given byte count to the next byte count that's a multiple of the machine's word size.

data StgWord #

Instances

Eq StgWord # |
Methods (==) :: StgWord -> StgWord -> Bool # (/=) :: StgWord -> StgWord -> Bool #
Bits StgWord # |

Methods

(.&.) :: StgWord -> StgWord -> StgWord Source #

(.|.) :: StgWord -> StgWord -> StgWord Source #

xor :: StgWord -> StgWord -> StgWord Source #

complement :: StgWord -> StgWord Source #

shift :: StgWord -> Int -> StgWord Source #

rotate :: StgWord -> Int -> StgWord Source #

zeroBits :: StgWord Source #

bit :: Int -> StgWord Source #

setBit :: StgWord -> Int -> StgWord Source #

clearBit :: StgWord -> Int -> StgWord Source #

complementBit :: StgWord -> Int -> StgWord Source #

testBit :: StgWord -> Int -> Bool Source #

bitSizeMaybe :: StgWord -> Maybe Int Source #

bitSize :: StgWord -> Int Source #

isSigned :: StgWord -> Bool Source #

shiftL :: StgWord -> Int -> StgWord Source #

unsafeShiftL :: StgWord -> Int -> StgWord Source #

shiftR :: StgWord -> Int -> StgWord Source #

unsafeShiftR :: StgWord -> Int -> StgWord Source #

rotateL :: StgWord -> Int -> StgWord Source #

rotateR :: StgWord -> Int -> StgWord Source #

popCount :: StgWord -> Int Source #

Outputable StgWord # |
Methods ppr :: StgWord -> SDoc # pprPrec :: Rational -> StgWord -> SDoc #

fromStgWord :: StgWord -> Integer #

toStgWord :: DynFlags -> Integer -> StgWord #

data StgHalfWord #

Instances

Eq StgHalfWord # |
Methods (==) :: StgHalfWord -> StgHalfWord -> Bool # (/=) :: StgHalfWord -> StgHalfWord -> Bool #
Outputable StgHalfWord # |
Methods ppr :: StgHalfWord -> SDoc # pprPrec :: Rational -> StgHalfWord -> SDoc #

fromStgHalfWord :: StgHalfWord -> Integer #

toStgHalfWord :: DynFlags -> Integer -> StgHalfWord #

hALF_WORD_SIZE :: DynFlags -> ByteOff #

hALF_WORD_SIZE_IN_BITS :: DynFlags -> Int #

# Closure repesentation

data SMRep #

A description of the layout of a closure. Corresponds directly to the closure types in includesrtsstorage/ClosureTypes.h.

Constructors

HeapRep IsStatic !WordOff !WordOff ClosureTypeInfo |
ArrayPtrsRep !WordOff !WordOff |
SmallArrayPtrsRep !WordOff |
ArrayWordsRep !WordOff |
StackRep Liveness |
RTSRep Int SMRep |

Instances

Outputable SMRep # |
Methods ppr :: SMRep -> SDoc # pprPrec :: Rational -> SMRep -> SDoc #

type IsStatic = Bool #

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 #

Constructors

Constr ConstrTag ConstrDescription |
Fun FunArity ArgDescr |
Thunk |
ThunkSelector SelectorOffset |
BlackHole |
IndStatic |

Instances

Outputable ClosureTypeInfo # |
Methods ppr :: ClosureTypeInfo -> SDoc # pprPrec :: Rational -> ClosureTypeInfo -> SDoc #

data ArgDescr #

Constructors

ArgSpec !Int |
ArgGen Liveness |

Instances

Outputable ArgDescr # |
Methods ppr :: ArgDescr -> SDoc # pprPrec :: Rational -> ArgDescr -> SDoc #

type Liveness = [Bool] #

type ConstrDescription = [Word8] #

## Construction

mkHeapRep :: DynFlags -> IsStatic -> WordOff -> WordOff -> ClosureTypeInfo -> SMRep #

blackHoleRep :: SMRep #

indStaticRep :: SMRep #

mkStackRep :: [Bool] -> SMRep #

mkRTSRep :: Int -> SMRep -> SMRep #

arrPtrsRep :: DynFlags -> WordOff -> SMRep #

smallArrPtrsRep :: WordOff -> SMRep #

arrWordsRep :: DynFlags -> ByteOff -> SMRep #

## Predicates

isStaticRep :: SMRep -> IsStatic #

isConRep :: SMRep -> Bool #

isThunkRep :: SMRep -> Bool #

isFunRep :: SMRep -> Bool #

isStaticNoCafCon :: SMRep -> Bool #

isStackRep :: SMRep -> Bool #

## Size-related things

heapClosureSizeW :: DynFlags -> SMRep -> WordOff #

The total size of the closure, in words.

fixedHdrSizeW :: DynFlags -> WordOff #

Size of a closure header (StgHeader in includesrtsstorage/Closures.h)

arrWordsHdrSize :: DynFlags -> ByteOff #

arrWordsHdrSizeW :: DynFlags -> WordOff #

arrPtrsHdrSize :: DynFlags -> ByteOff #

arrPtrsHdrSizeW :: DynFlags -> WordOff #

profHdrSize :: DynFlags -> WordOff #

Size of the profiling part of a closure header (StgProfHeader in includesrtsstorage/Closures.h)

thunkHdrSize :: DynFlags -> WordOff #

nonHdrSize :: DynFlags -> SMRep -> ByteOff #

nonHdrSizeW :: SMRep -> WordOff #

smallArrPtrsHdrSize :: DynFlags -> ByteOff #

smallArrPtrsHdrSizeW :: DynFlags -> WordOff #

hdrSize :: DynFlags -> SMRep -> ByteOff #

hdrSizeW :: DynFlags -> SMRep -> WordOff #

fixedHdrSize :: DynFlags -> ByteOff #

## RTS closure types

rtsClosureType :: SMRep -> Int #

Derives the RTS closure type from an `SMRep`

rET_SMALL :: Int #

rET_BIG :: Int #

aRG_GEN :: Int #

aRG_GEN_BIG :: Int #

## Arrays

card :: DynFlags -> Int -> Int #

The byte offset into the card table of the card for a given element

cardRoundUp :: DynFlags -> Int -> Int #

Convert a number of elements to a number of cards, rounding up

cardTableSizeB :: DynFlags -> Int -> ByteOff #

The size of a card table, in bytes

cardTableSizeW :: DynFlags -> Int -> WordOff #

The size of a card table, in words

# Operations over [Word8] strings that don't belong here

pprWord8String :: [Word8] -> SDoc #

stringToWord8s :: String -> [Word8] #