GHC.Debug.Types.Ptr

Data types for representing different pointers and raw information All pointers are stored in little-endian to make arithmetic easier.

We have to send and recieve the pointers in big endian though. This conversion is dealt with in the Binary instance for ClosurePtr and then the other pointers are derived from this instance using DerivingVia

InfoTables

newtype InfoTablePtr

Constructors

InfoTablePtr Word64

Instances

Show InfoTablePtr

Defined in GHC.Debug.Types.Ptr

Methods

showsPrec :: Int -> InfoTablePtr -> ShowS

show :: InfoTablePtr -> String

showList :: [InfoTablePtr] -> ShowS

Binary InfoTablePtr

Defined in GHC.Debug.Types.Ptr

Methods

put :: InfoTablePtr -> Put

get :: Get InfoTablePtr

putList :: [InfoTablePtr] -> Put

Eq InfoTablePtr

Defined in GHC.Debug.Types.Ptr

Methods

(==) :: InfoTablePtr -> InfoTablePtr -> Bool

(/=) :: InfoTablePtr -> InfoTablePtr -> Bool

Ord InfoTablePtr

Defined in GHC.Debug.Types.Ptr

Methods

compare :: InfoTablePtr -> InfoTablePtr -> Ordering

(<) :: InfoTablePtr -> InfoTablePtr -> Bool

(<=) :: InfoTablePtr -> InfoTablePtr -> Bool

(>) :: InfoTablePtr -> InfoTablePtr -> Bool

(>=) :: InfoTablePtr -> InfoTablePtr -> Bool

max :: InfoTablePtr -> InfoTablePtr -> InfoTablePtr

min :: InfoTablePtr -> InfoTablePtr -> InfoTablePtr

Hashable InfoTablePtr

Defined in GHC.Debug.Types.Ptr

Methods

hashWithSalt :: Int -> InfoTablePtr -> Int

hash :: InfoTablePtr -> Int

newtype RawInfoTable

Constructors

RawInfoTable ByteString

Instances

Show RawInfoTable

Defined in GHC.Debug.Types.Ptr

Methods

showsPrec :: Int -> RawInfoTable -> ShowS

show :: RawInfoTable -> String

showList :: [RawInfoTable] -> ShowS

Binary RawInfoTable

Defined in GHC.Debug.Types.Ptr

Methods

put :: RawInfoTable -> Put

get :: Get RawInfoTable

putList :: [RawInfoTable] -> Put

Eq RawInfoTable

Defined in GHC.Debug.Types.Ptr

Methods

(==) :: RawInfoTable -> RawInfoTable -> Bool

(/=) :: RawInfoTable -> RawInfoTable -> Bool

Ord RawInfoTable

Defined in GHC.Debug.Types.Ptr

Methods

compare :: RawInfoTable -> RawInfoTable -> Ordering

(<) :: RawInfoTable -> RawInfoTable -> Bool

(<=) :: RawInfoTable -> RawInfoTable -> Bool

(>) :: RawInfoTable -> RawInfoTable -> Bool

(>=) :: RawInfoTable -> RawInfoTable -> Bool

max :: RawInfoTable -> RawInfoTable -> RawInfoTable

min :: RawInfoTable -> RawInfoTable -> RawInfoTable

Closures

newtype ClosurePtr

Constructors

UntaggedClosurePtr Word64

Bundled Patterns

pattern ClosurePtr :: Word64 -> ClosurePtr

Instances

Show ClosurePtr

Defined in GHC.Debug.Types.Ptr

Methods

showsPrec :: Int -> ClosurePtr -> ShowS

show :: ClosurePtr -> String

showList :: [ClosurePtr] -> ShowS

Binary ClosurePtr

Defined in GHC.Debug.Types.Ptr

Methods

put :: ClosurePtr -> Put

get :: Get ClosurePtr

putList :: [ClosurePtr] -> Put

Eq ClosurePtr

Defined in GHC.Debug.Types.Ptr

Methods

(==) :: ClosurePtr -> ClosurePtr -> Bool

(/=) :: ClosurePtr -> ClosurePtr -> Bool

Ord ClosurePtr

Defined in GHC.Debug.Types.Ptr

Methods

compare :: ClosurePtr -> ClosurePtr -> Ordering

(<) :: ClosurePtr -> ClosurePtr -> Bool

(<=) :: ClosurePtr -> ClosurePtr -> Bool

(>) :: ClosurePtr -> ClosurePtr -> Bool

(>=) :: ClosurePtr -> ClosurePtr -> Bool

max :: ClosurePtr -> ClosurePtr -> ClosurePtr

min :: ClosurePtr -> ClosurePtr -> ClosurePtr

Hashable ClosurePtr

Defined in GHC.Debug.Types.Ptr

Methods

hashWithSalt :: Int -> ClosurePtr -> Int

hash :: ClosurePtr -> Int

mkClosurePtr :: Word64 -> ClosurePtr

newtype RawClosure

Constructors

RawClosure ByteString

Instances

Show RawClosure

Defined in GHC.Debug.Types.Ptr

Methods

showsPrec :: Int -> RawClosure -> ShowS

show :: RawClosure -> String

showList :: [RawClosure] -> ShowS

Binary RawClosure

Defined in GHC.Debug.Types.Ptr

Methods

put :: RawClosure -> Put

get :: Get RawClosure

putList :: [RawClosure] -> Put

Eq RawClosure

Defined in GHC.Debug.Types.Ptr

Methods

(==) :: RawClosure -> RawClosure -> Bool

(/=) :: RawClosure -> RawClosure -> Bool

Ord RawClosure

Defined in GHC.Debug.Types.Ptr

Methods

compare :: RawClosure -> RawClosure -> Ordering

(<) :: RawClosure -> RawClosure -> Bool

(<=) :: RawClosure -> RawClosure -> Bool

(>) :: RawClosure -> RawClosure -> Bool

(>=) :: RawClosure -> RawClosure -> Bool

max :: RawClosure -> RawClosure -> RawClosure

min :: RawClosure -> RawClosure -> RawClosure

rawClosureSize :: RawClosure -> Int

getInfoTblPtr :: HasCallStack => RawClosure -> InfoTablePtr

Operations on ClosurePtr

applyBlockMask :: ClosurePtr -> BlockPtr

applyMBlockMask :: ClosurePtr -> BlockPtr

subtractBlockPtr :: ClosurePtr -> BlockPtr -> Word64

heapAlloced :: ClosurePtr -> Bool

Check if the ClosurePtr is block allocated or not TODO: MP: These numbers are hard-coded from what mblock_address_space.begin and mblock_address_space.end were when I inspected them in gdb. I don't know if they are always the same of should be queried from the debuggee

getBlockOffset :: ClosurePtr -> Word64

Blocks

newtype BlockPtr

Constructors

BlockPtr Word64

Instances

Show BlockPtr

Defined in GHC.Debug.Types.Ptr

Methods

showsPrec :: Int -> BlockPtr -> ShowS

show :: BlockPtr -> String

showList :: [BlockPtr] -> ShowS

Binary BlockPtr

Defined in GHC.Debug.Types.Ptr

Methods

put :: BlockPtr -> Put

get :: Get BlockPtr

putList :: [BlockPtr] -> Put

Eq BlockPtr

Defined in GHC.Debug.Types.Ptr

Methods

(==) :: BlockPtr -> BlockPtr -> Bool

(/=) :: BlockPtr -> BlockPtr -> Bool

Ord BlockPtr

Defined in GHC.Debug.Types.Ptr

Methods

compare :: BlockPtr -> BlockPtr -> Ordering

(<) :: BlockPtr -> BlockPtr -> Bool

(<=) :: BlockPtr -> BlockPtr -> Bool

(>) :: BlockPtr -> BlockPtr -> Bool

(>=) :: BlockPtr -> BlockPtr -> Bool

max :: BlockPtr -> BlockPtr -> BlockPtr

min :: BlockPtr -> BlockPtr -> BlockPtr

Hashable BlockPtr

Defined in GHC.Debug.Types.Ptr

Methods

hashWithSalt :: Int -> BlockPtr -> Int

hash :: BlockPtr -> Int

data RawBlock

Constructors

RawBlock BlockPtr Word16 ByteString

Instances

Show RawBlock

Defined in GHC.Debug.Types.Ptr

Methods

showsPrec :: Int -> RawBlock -> ShowS

show :: RawBlock -> String

showList :: [RawBlock] -> ShowS

Binary RawBlock

Defined in GHC.Debug.Types.Ptr

Methods

put :: RawBlock -> Put

get :: Get RawBlock

putList :: [RawBlock] -> Put

isLargeBlock :: RawBlock -> Bool

isPinnedBlock :: RawBlock -> Bool

rawBlockAddr :: RawBlock -> BlockPtr

extractFromBlock :: ClosurePtr -> RawBlock -> RawClosure

Invariant: ClosurePtr is within the range of the block The RawClosure this returns is actually the tail of the whole block, this is fine because the memory for each block is only allocated once due to how BS.drop is implemented via pointer arithmetic.

blockMBlock :: BlockPtr -> Word64

rawBlockSize :: RawBlock -> Int

Stacks

newtype StackPtr

Constructors

StackPtr Word64

Instances

Show StackPtr

Defined in GHC.Debug.Types.Ptr

Methods

showsPrec :: Int -> StackPtr -> ShowS

show :: StackPtr -> String

showList :: [StackPtr] -> ShowS

Binary StackPtr

Defined in GHC.Debug.Types.Ptr

Methods

put :: StackPtr -> Put

get :: Get StackPtr

putList :: [StackPtr] -> Put

Eq StackPtr

Defined in GHC.Debug.Types.Ptr

Methods

(==) :: StackPtr -> StackPtr -> Bool

(/=) :: StackPtr -> StackPtr -> Bool

Ord StackPtr

Defined in GHC.Debug.Types.Ptr

Methods

compare :: StackPtr -> StackPtr -> Ordering

(<) :: StackPtr -> StackPtr -> Bool

(<=) :: StackPtr -> StackPtr -> Bool

(>) :: StackPtr -> StackPtr -> Bool

(>=) :: StackPtr -> StackPtr -> Bool

max :: StackPtr -> StackPtr -> StackPtr

min :: StackPtr -> StackPtr -> StackPtr

Hashable StackPtr

Defined in GHC.Debug.Types.Ptr

Methods

hashWithSalt :: Int -> StackPtr -> Int

hash :: StackPtr -> Int

newtype RawStack

Constructors

RawStack ByteString

Instances

Show RawStack

Defined in GHC.Debug.Types.Ptr

Methods

showsPrec :: Int -> RawStack -> ShowS

show :: RawStack -> String

showList :: [RawStack] -> ShowS

Eq RawStack

Defined in GHC.Debug.Types.Ptr

Methods

(==) :: RawStack -> RawStack -> Bool

(/=) :: RawStack -> RawStack -> Bool

Ord RawStack

Defined in GHC.Debug.Types.Ptr

Methods

compare :: RawStack -> RawStack -> Ordering

(<) :: RawStack -> RawStack -> Bool

(<=) :: RawStack -> RawStack -> Bool

(>) :: RawStack -> RawStack -> Bool

(>=) :: RawStack -> RawStack -> Bool

max :: RawStack -> RawStack -> RawStack

min :: RawStack -> RawStack -> RawStack

subtractStackPtr :: StackPtr -> ClosurePtr -> Word64

calculateStackLen :: Word32 -> Word64 -> ClosurePtr -> StackPtr -> Word64

addStackPtr :: StackPtr -> Word64 -> StackPtr

rawStackSize :: RawStack -> Int

printStack :: RawStack -> String

Bitmaps

newtype PtrBitmap

A bitmap that records whether each field of a stack frame is a pointer.

Constructors

PtrBitmap (Array Int Bool)

Instances

Show PtrBitmap

Defined in GHC.Debug.Types.Ptr

Methods

showsPrec :: Int -> PtrBitmap -> ShowS

show :: PtrBitmap -> String

showList :: [PtrBitmap] -> ShowS

Binary PtrBitmap

Defined in GHC.Debug.Types.Ptr

Methods

put :: PtrBitmap -> Put

get :: Get PtrBitmap

putList :: [PtrBitmap] -> Put

traversePtrBitmap :: Monad m => (Bool -> m a) -> PtrBitmap -> m [a]

Constants

blockMask :: Word64

mblockMask :: Word64

mblockMaxSize :: Word64

blockMaxSize :: Word64

profiling :: Bool

tablesNextToCode :: Bool

Other utility

arrWordsBS :: [Word] -> ByteString

prettyPrint :: ByteString -> String

printBS :: HasCallStack => ByteString -> String