| Copyright | (c) 2012 Joachim Breitner |
|---|---|
| License | BSD3 |
| Maintainer | Joachim Breitner <mail@joachim-breitner.de> |
| Safe Haskell | None |
| Language | Haskell2010 |
GHC.Exts.Heap
Description
With this module, you can investigate the heap representation of Haskell values, i.e. to investigate sharing and lazy evaluation.
Synopsis
- type Closure = GenClosure Box
- data GenClosure b
- = ConstrClosure { }
- | FunClosure {
- info :: !StgInfoTable
- ptrArgs :: ![b]
- dataArgs :: ![Word]
- | ThunkClosure {
- info :: !StgInfoTable
- ptrArgs :: ![b]
- dataArgs :: ![Word]
- | SelectorClosure {
- info :: !StgInfoTable
- selectee :: !b
- | PAPClosure { }
- | APClosure { }
- | APStackClosure {
- info :: !StgInfoTable
- fun :: !b
- payload :: ![b]
- | IndClosure {
- info :: !StgInfoTable
- indirectee :: !b
- | BCOClosure { }
- | BlackholeClosure {
- info :: !StgInfoTable
- indirectee :: !b
- | ArrWordsClosure { }
- | MutArrClosure {
- info :: !StgInfoTable
- mccPtrs :: !Word
- mccSize :: !Word
- mccPayload :: ![b]
- | MVarClosure {
- info :: !StgInfoTable
- queueHead :: !b
- queueTail :: !b
- value :: !b
- | MutVarClosure {
- info :: !StgInfoTable
- var :: !b
- | BlockingQueueClosure { }
- | IntClosure { }
- | WordClosure { }
- | Int64Closure { }
- | Word64Closure { }
- | AddrClosure { }
- | FloatClosure { }
- | DoubleClosure { }
- | OtherClosure {
- info :: !StgInfoTable
- hvalues :: ![b]
- rawWords :: ![Word]
- | UnsupportedClosure {
- info :: !StgInfoTable
- data ClosureType
- = INVALID_OBJECT
- | CONSTR
- | CONSTR_1_0
- | CONSTR_0_1
- | CONSTR_2_0
- | CONSTR_1_1
- | CONSTR_0_2
- | CONSTR_NOCAF
- | FUN
- | FUN_1_0
- | FUN_0_1
- | FUN_2_0
- | FUN_1_1
- | FUN_0_2
- | FUN_STATIC
- | THUNK
- | THUNK_1_0
- | THUNK_0_1
- | THUNK_2_0
- | THUNK_1_1
- | THUNK_0_2
- | THUNK_STATIC
- | THUNK_SELECTOR
- | BCO
- | AP
- | PAP
- | AP_STACK
- | IND
- | IND_STATIC
- | RET_BCO
- | RET_SMALL
- | RET_BIG
- | RET_FUN
- | UPDATE_FRAME
- | CATCH_FRAME
- | UNDERFLOW_FRAME
- | STOP_FRAME
- | BLOCKING_QUEUE
- | BLACKHOLE
- | MVAR_CLEAN
- | MVAR_DIRTY
- | TVAR
- | ARR_WORDS
- | MUT_ARR_PTRS_CLEAN
- | MUT_ARR_PTRS_DIRTY
- | MUT_ARR_PTRS_FROZEN_DIRTY
- | MUT_ARR_PTRS_FROZEN_CLEAN
- | MUT_VAR_CLEAN
- | MUT_VAR_DIRTY
- | WEAK
- | PRIM
- | MUT_PRIM
- | TSO
- | STACK
- | TREC_CHUNK
- | ATOMICALLY_FRAME
- | CATCH_RETRY_FRAME
- | CATCH_STM_FRAME
- | WHITEHOLE
- | SMALL_MUT_ARR_PTRS_CLEAN
- | SMALL_MUT_ARR_PTRS_DIRTY
- | SMALL_MUT_ARR_PTRS_FROZEN_DIRTY
- | SMALL_MUT_ARR_PTRS_FROZEN_CLEAN
- | COMPACT_NFDATA
- | N_CLOSURE_TYPES
- data PrimType
- class HasHeapRep (a :: TYPE rep) where
- getClosureData :: a -> IO Closure
- data StgInfoTable = StgInfoTable {}
- type EntryFunPtr = FunPtr (Ptr () -> IO (Ptr ()))
- type HalfWord = Word32
- type ItblCodes = Either [Word8] [Word32]
- itblSize :: Int
- peekItbl :: Ptr StgInfoTable -> IO StgInfoTable
- pokeItbl :: Ptr StgInfoTable -> StgInfoTable -> IO ()
- getBoxedClosureData :: Box -> IO Closure
- allClosures :: GenClosure b -> [b]
- data Box = Box Any
- asBox :: a -> Box
- areBoxesEqual :: Box -> Box -> IO Bool
Closure types
type Closure = GenClosure Box Source #
data GenClosure b Source #
This is the representation of a Haskell value on the heap. It reflects http://ghc.haskell.org/trac/ghc/browser/includes/rts/storage/Closures.h
The data type is parametrized by the type to store references in. Usually
this is a Box with the type synonym Closure .
All Heap objects have the same basic layout. A header containing a pointer
to the info table and a payload with various fields. The info field below
always refers to the info table pointed to by the header. The remaining
fields are the payload.
See https://ghc.haskell.org/trac/ghc/wiki/Commentary/Rts/Storage/HeapObjects for more information.
Constructors
A data constructor
A function
Fields
- info :: !StgInfoTable
- ptrArgs :: ![b]
Pointer arguments
- dataArgs :: ![Word]
Non-pointer arguments
A thunk, an expression not obviously in head normal form
Fields
- info :: !StgInfoTable
- ptrArgs :: ![b]
Pointer arguments
- dataArgs :: ![Word]
Non-pointer arguments
A thunk which performs a simple selection operation
Fields
- info :: !StgInfoTable
- selectee :: !b
Pointer to the object being selected from
An unsaturated function application
Fields
- info :: !StgInfoTable
- arity :: !HalfWord
Arity of the partial application
- n_args :: !HalfWord
Size of the payload in words
- fun :: !b
Pointer to a
FunClosure - payload :: ![b]
Sequence of already applied arguments
A function application
Fields
- info :: !StgInfoTable
- arity :: !HalfWord
Arity of the partial application
- n_args :: !HalfWord
Size of the payload in words
- fun :: !b
Pointer to a
FunClosure - payload :: ![b]
Sequence of already applied arguments
A suspended thunk evaluation
Fields
- info :: !StgInfoTable
- fun :: !b
Pointer to a
FunClosure - payload :: ![b]
Sequence of already applied arguments
A pointer to another closure, introduced when a thunk is updated to point at its value
Fields
- info :: !StgInfoTable
- indirectee :: !b
Target closure
A byte-code object (BCO) which can be interpreted by GHC's byte-code interpreter (e.g. as used by GHCi)
Fields
- info :: !StgInfoTable
- instrs :: !b
A pointer to an ArrWords of instructions
- literals :: !b
A pointer to an ArrWords of literals
- bcoptrs :: !b
A pointer to an ArrWords of byte code objects
- arity :: !HalfWord
Arity of the partial application
- size :: !HalfWord
The size of this BCO in words
- bitmap :: ![Word]
An StgLargeBitmap describing the pointerhood of its args/free vars
A thunk under evaluation by another thread
Fields
- info :: !StgInfoTable
- indirectee :: !b
Target closure
A ByteArray#
A MutableByteArray#
Fields
- info :: !StgInfoTable
- mccPtrs :: !Word
Number of pointers
- mccSize :: !Word
?? Closures.h vs ClosureMacros.h
- mccPayload :: ![b]
Array payload Card table ignored
An MVar#, with a queue of thread state objects blocking on them
Fields
- info :: !StgInfoTable
- queueHead :: !b
Pointer to head of queue
- queueTail :: !b
Pointer to tail of queue
- value :: !b
Pointer to closure
A MutVar#
Fields
- info :: !StgInfoTable
- var :: !b
Pointer to contents
An STM blocking queue.
Primitive Int
Primitive Word
Primitive Int64
Primitive Word64
Primitive Addr
Primitive Float
Primitive Double
Another kind of closure
Fields
- info :: !StgInfoTable
- hvalues :: ![b]
- rawWords :: ![Word]
Fields
- info :: !StgInfoTable
Instances
Instance details
Defined in GHC.Exts.Heap.Closures
Methods
fmap :: (a -> b) -> GenClosure a -> GenClosure b #
(<$) :: a -> GenClosure b -> GenClosure a #
Instance details
Defined in GHC.Exts.Heap.Closures
Methods
fold :: Monoid m => GenClosure m -> m #
foldMap :: Monoid m => (a -> m) -> GenClosure a -> m #
foldr :: (a -> b -> b) -> b -> GenClosure a -> b #
foldr' :: (a -> b -> b) -> b -> GenClosure a -> b #
foldl :: (b -> a -> b) -> b -> GenClosure a -> b #
foldl' :: (b -> a -> b) -> b -> GenClosure a -> b #
foldr1 :: (a -> a -> a) -> GenClosure a -> a #
foldl1 :: (a -> a -> a) -> GenClosure a -> a #
toList :: GenClosure a -> [a] #
null :: GenClosure a -> Bool #
length :: GenClosure a -> Int #
elem :: Eq a => a -> GenClosure a -> Bool #
maximum :: Ord a => GenClosure a -> a #
minimum :: Ord a => GenClosure a -> a #
sum :: Num a => GenClosure a -> a #
product :: Num a => GenClosure a -> a #
Instance details
Defined in GHC.Exts.Heap.Closures
Methods
traverse :: Applicative f => (a -> f b) -> GenClosure a -> f (GenClosure b) #
sequenceA :: Applicative f => GenClosure (f a) -> f (GenClosure a) #
mapM :: Monad m => (a -> m b) -> GenClosure a -> m (GenClosure b) #
sequence :: Monad m => GenClosure (m a) -> m (GenClosure a) #
Instance details
Defined in GHC.Exts.Heap.Closures
Methods
showsPrec :: Int -> GenClosure b -> ShowS #
show :: GenClosure b -> String #
showList :: [GenClosure b] -> ShowS #
Instance details
Defined in GHC.Exts.Heap.Closures
Associated Types
type Rep (GenClosure b) :: Type -> Type #
Instance details
Defined in GHCi.Message
Instance details
Defined in GHC.Exts.Heap.Closures
data ClosureType Source #
Constructors
Instances
Instance details
Defined in GHC.Exts.Heap.ClosureTypes
Methods
succ :: ClosureType -> ClosureType #
pred :: ClosureType -> ClosureType #
toEnum :: Int -> ClosureType #
fromEnum :: ClosureType -> Int #
enumFrom :: ClosureType -> [ClosureType] #
enumFromThen :: ClosureType -> ClosureType -> [ClosureType] #
enumFromTo :: ClosureType -> ClosureType -> [ClosureType] #
enumFromThenTo :: ClosureType -> ClosureType -> ClosureType -> [ClosureType] #
Instance details
Defined in GHC.Exts.Heap.ClosureTypes
Instance details
Defined in GHC.Exts.Heap.ClosureTypes
Methods
compare :: ClosureType -> ClosureType -> Ordering #
(<) :: ClosureType -> ClosureType -> Bool #
(<=) :: ClosureType -> ClosureType -> Bool #
(>) :: ClosureType -> ClosureType -> Bool #
(>=) :: ClosureType -> ClosureType -> Bool #
max :: ClosureType -> ClosureType -> ClosureType #
min :: ClosureType -> ClosureType -> ClosureType #
Instance details
Defined in GHC.Exts.Heap.ClosureTypes
Methods
showsPrec :: Int -> ClosureType -> ShowS #
show :: ClosureType -> String #
showList :: [ClosureType] -> ShowS #
Instance details
Defined in GHC.Exts.Heap.ClosureTypes
Associated Types
type Rep ClosureType :: Type -> Type #
Instance details
Defined in GHCi.Message
Instance details
Defined in GHC.Exts.Heap.ClosureTypes
Instances
Instance details
Defined in GHC.Exts.Heap.Closures
class HasHeapRep (a :: TYPE rep) where Source #
Methods
getClosureData :: a -> IO Closure Source #
Instances
Info Table types
data StgInfoTable Source #
This is a somewhat faithful representation of an info table. See http://ghc.haskell.org/trac/ghc/browser/includes/rts/storage/InfoTables.h for more details on this data structure.
Constructors
Instances
Instance details
Defined in GHC.Exts.Heap.InfoTable.Types
Methods
showsPrec :: Int -> StgInfoTable -> ShowS #
show :: StgInfoTable -> String #
showList :: [StgInfoTable] -> ShowS #
Instance details
Defined in GHC.Exts.Heap.InfoTable.Types
Associated Types
type Rep StgInfoTable :: Type -> Type #
Instance details
Defined in GHCi.Message
Instance details
Defined in GHC.Exts.Heap.InfoTable.Types
peekItbl :: Ptr StgInfoTable -> IO StgInfoTable Source #
Read an InfoTable from the heap into a haskell type. WARNING: This code assumes it is passed a pointer to a "standard" info table. If tables_next_to_code is enabled, it will look 1 byte before the start for the entry field.
pokeItbl :: Ptr StgInfoTable -> StgInfoTable -> IO () Source #
Closure inspection
getBoxedClosureData :: Box -> IO Closure Source #
Like getClosureData , but taking a Box , so it is easier to work with.
allClosures :: GenClosure b -> [b] Source #
For generic code, this function returns all referenced closures.
Boxes
An arbitrary Haskell value in a safe Box. The point is that even
unevaluated thunks can safely be moved around inside the Box, and when
required, e.g. in getBoxedClosureData, the function knows how far it has
to evaluate the argument.
This takes an arbitrary value and puts it into a box. Note that calls like
asBox (head list)
will put the thunk "head list" into the box, not the element at the head of the list. For that, use careful case expressions:
case list of x:_ -> asBox x