Safe Haskell	Safe-Inferred
Language	Haskell2010

GHC.Debug.Types.Ptr

Contents

InfoTables
Closures
Operations on ClosurePtr
Blocks
Stacks
Bitmaps
Constants
Other utility

Description

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

Synopsis

newtype InfoTablePtr = InfoTablePtr Word64
readInfoTablePtr :: String -> Maybe InfoTablePtr
newtype RawInfoTable = RawInfoTable ByteString
newtype ClosurePtr where
- UntaggedClosurePtr Word64
- pattern ClosurePtr :: Word64 -> ClosurePtr
mkClosurePtr :: Word64 -> ClosurePtr
readClosurePtr :: String -> Maybe ClosurePtr
newtype RawClosure = RawClosure ByteString
rawClosureSize :: RawClosure -> Int
getInfoTblPtr :: HasCallStack => RawClosure -> InfoTablePtr
applyBlockMask :: ClosurePtr -> BlockPtr
applyMBlockMask :: ClosurePtr -> BlockPtr
subtractBlockPtr :: ClosurePtr -> BlockPtr -> Word64
heapAlloced :: ClosurePtr -> Bool
getBlockOffset :: ClosurePtr -> Word64
newtype BlockPtr = BlockPtr Word64
data RawBlock = RawBlock BlockPtr Word16 ByteString
isLargeBlock :: RawBlock -> Bool
isPinnedBlock :: RawBlock -> Bool
rawBlockAddr :: RawBlock -> BlockPtr
extractFromBlock :: ClosurePtr -> RawBlock -> RawClosure
blockMBlock :: BlockPtr -> Word64
rawBlockSize :: RawBlock -> Int
newtype StackPtr = StackPtr Word64
newtype RawStack = RawStack ByteString
subtractStackPtr :: StackPtr -> ClosurePtr -> Word64
calculateStackLen :: Word32 -> Word64 -> ClosurePtr -> StackPtr -> Word64
addStackPtr :: StackPtr -> Word64 -> StackPtr
rawStackSize :: RawStack -> Int
printStack :: RawStack -> String
newtype PtrBitmap = PtrBitmap (Array Int Bool)
traversePtrBitmap :: Monad m => (Bool -> m a) -> PtrBitmap -> m [a]
blockMask :: Word64
mblockMask :: Word64
mblockMaxSize :: Word64
blockMaxSize :: Word64
newtype CCSPtr = CCSPtr Word64
newtype CCPtr = CCPtr Word64
readCCPtr :: String -> Maybe CCPtr
mkCCPtr :: Word64 -> CCPtr
newtype IndexTablePtr = IndexTablePtr Word64
mkIndexTablePtr :: Word64 -> IndexTablePtr
newtype RetainerSetPtr = RetainerSetPtr Word64
arrWordsBS :: [Word] -> ByteString
prettyPrint :: ByteString -> String
printBS :: HasCallStack => ByteString -> String

InfoTables

newtype InfoTablePtr Source #

Constructors

InfoTablePtr Word64

Instances

Instances details

Show InfoTablePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> InfoTablePtr -> ShowS # show :: InfoTablePtr -> String # showList :: [InfoTablePtr] -> ShowS #
Binary InfoTablePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: InfoTablePtr -> Put # get :: Get InfoTablePtr # putList :: [InfoTablePtr] -> Put #
Eq InfoTablePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: InfoTablePtr -> InfoTablePtr -> Bool # (/=) :: InfoTablePtr -> InfoTablePtr -> Bool #
Ord InfoTablePtr Source #
Instance details 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 Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods hashWithSalt :: Int -> InfoTablePtr -> Int # hash :: InfoTablePtr -> Int #

readInfoTablePtr :: String -> Maybe InfoTablePtr Source #

newtype RawInfoTable Source #

Constructors

RawInfoTable ByteString

Instances

Instances details

Show RawInfoTable Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> RawInfoTable -> ShowS # show :: RawInfoTable -> String # showList :: [RawInfoTable] -> ShowS #
Binary RawInfoTable Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: RawInfoTable -> Put # get :: Get RawInfoTable # putList :: [RawInfoTable] -> Put #
Eq RawInfoTable Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: RawInfoTable -> RawInfoTable -> Bool # (/=) :: RawInfoTable -> RawInfoTable -> Bool #
Ord RawInfoTable Source #
Instance details 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 Source #

Constructors

UntaggedClosurePtr Word64

Bundled Patterns

pattern ClosurePtr :: Word64 -> ClosurePtr

Instances

Instances details

Show ClosurePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> ClosurePtr -> ShowS # show :: ClosurePtr -> String # showList :: [ClosurePtr] -> ShowS #
Binary ClosurePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: ClosurePtr -> Put # get :: Get ClosurePtr # putList :: [ClosurePtr] -> Put #
Eq ClosurePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: ClosurePtr -> ClosurePtr -> Bool # (/=) :: ClosurePtr -> ClosurePtr -> Bool #
Ord ClosurePtr Source #
Instance details 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 Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods hashWithSalt :: Int -> ClosurePtr -> Int # hash :: ClosurePtr -> Int #

mkClosurePtr :: Word64 -> ClosurePtr Source #

readClosurePtr :: String -> Maybe ClosurePtr Source #

newtype RawClosure Source #

Constructors

RawClosure ByteString

Instances

Instances details

Show RawClosure Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> RawClosure -> ShowS # show :: RawClosure -> String # showList :: [RawClosure] -> ShowS #
Binary RawClosure Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: RawClosure -> Put # get :: Get RawClosure # putList :: [RawClosure] -> Put #
Eq RawClosure Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: RawClosure -> RawClosure -> Bool # (/=) :: RawClosure -> RawClosure -> Bool #
Ord RawClosure Source #
Instance details 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 Source #

getInfoTblPtr :: HasCallStack => RawClosure -> InfoTablePtr Source #

Operations on `ClosurePtr`

applyBlockMask :: ClosurePtr -> BlockPtr Source #

applyMBlockMask :: ClosurePtr -> BlockPtr Source #

subtractBlockPtr :: ClosurePtr -> BlockPtr -> Word64 Source #

heapAlloced :: ClosurePtr -> Bool Source #

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 Source #

Blocks

newtype BlockPtr Source #

Constructors

BlockPtr Word64

Instances

Instances details

Show BlockPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> BlockPtr -> ShowS # show :: BlockPtr -> String # showList :: [BlockPtr] -> ShowS #
Binary BlockPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: BlockPtr -> Put # get :: Get BlockPtr # putList :: [BlockPtr] -> Put #
Eq BlockPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: BlockPtr -> BlockPtr -> Bool # (/=) :: BlockPtr -> BlockPtr -> Bool #
Ord BlockPtr Source #
Instance details 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 Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods hashWithSalt :: Int -> BlockPtr -> Int # hash :: BlockPtr -> Int #

data RawBlock Source #

Constructors

RawBlock BlockPtr Word16 ByteString

Instances

Instances details

Show RawBlock Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> RawBlock -> ShowS # show :: RawBlock -> String # showList :: [RawBlock] -> ShowS #
Binary RawBlock Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: RawBlock -> Put # get :: Get RawBlock # putList :: [RawBlock] -> Put #

isLargeBlock :: RawBlock -> Bool Source #

isPinnedBlock :: RawBlock -> Bool Source #

rawBlockAddr :: RawBlock -> BlockPtr Source #

extractFromBlock :: ClosurePtr -> RawBlock -> RawClosure Source #

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 Source #

rawBlockSize :: RawBlock -> Int Source #

Stacks

newtype StackPtr Source #

Constructors

StackPtr Word64

Instances

Instances details

Show StackPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> StackPtr -> ShowS # show :: StackPtr -> String # showList :: [StackPtr] -> ShowS #
Binary StackPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: StackPtr -> Put # get :: Get StackPtr # putList :: [StackPtr] -> Put #
Eq StackPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: StackPtr -> StackPtr -> Bool # (/=) :: StackPtr -> StackPtr -> Bool #
Ord StackPtr Source #
Instance details 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 Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods hashWithSalt :: Int -> StackPtr -> Int # hash :: StackPtr -> Int #

newtype RawStack Source #

Constructors

RawStack ByteString

Instances

Instances details

Show RawStack Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> RawStack -> ShowS # show :: RawStack -> String # showList :: [RawStack] -> ShowS #
Eq RawStack Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: RawStack -> RawStack -> Bool # (/=) :: RawStack -> RawStack -> Bool #
Ord RawStack Source #
Instance details 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 Source #

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

addStackPtr :: StackPtr -> Word64 -> StackPtr Source #

rawStackSize :: RawStack -> Int Source #

printStack :: RawStack -> String Source #

Bitmaps

newtype PtrBitmap Source #

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

Constructors

PtrBitmap (Array Int Bool)

Instances

Instances details

Show PtrBitmap Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> PtrBitmap -> ShowS # show :: PtrBitmap -> String # showList :: [PtrBitmap] -> ShowS #
Binary PtrBitmap Source #
Instance details 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] Source #

Constants

blockMask :: Word64 Source #

mblockMask :: Word64 Source #

mblockMaxSize :: Word64 Source #

blockMaxSize :: Word64 Source #

newtype CCSPtr Source #

Constructors

CCSPtr Word64

Instances

Instances details

Show CCSPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> CCSPtr -> ShowS # show :: CCSPtr -> String # showList :: [CCSPtr] -> ShowS #
Binary CCSPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: CCSPtr -> Put # get :: Get CCSPtr # putList :: [CCSPtr] -> Put #
Eq CCSPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: CCSPtr -> CCSPtr -> Bool # (/=) :: CCSPtr -> CCSPtr -> Bool #
Ord CCSPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods compare :: CCSPtr -> CCSPtr -> Ordering # (<) :: CCSPtr -> CCSPtr -> Bool # (<=) :: CCSPtr -> CCSPtr -> Bool # (>) :: CCSPtr -> CCSPtr -> Bool # (>=) :: CCSPtr -> CCSPtr -> Bool # max :: CCSPtr -> CCSPtr -> CCSPtr # min :: CCSPtr -> CCSPtr -> CCSPtr #
Hashable CCSPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods hashWithSalt :: Int -> CCSPtr -> Int # hash :: CCSPtr -> Int #

newtype CCPtr Source #

Constructors

CCPtr Word64

Instances

Instances details

Show CCPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> CCPtr -> ShowS # show :: CCPtr -> String # showList :: [CCPtr] -> ShowS #
Binary CCPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: CCPtr -> Put # get :: Get CCPtr # putList :: [CCPtr] -> Put #
Eq CCPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: CCPtr -> CCPtr -> Bool # (/=) :: CCPtr -> CCPtr -> Bool #
Ord CCPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods compare :: CCPtr -> CCPtr -> Ordering # (<) :: CCPtr -> CCPtr -> Bool # (<=) :: CCPtr -> CCPtr -> Bool # (>) :: CCPtr -> CCPtr -> Bool # (>=) :: CCPtr -> CCPtr -> Bool # max :: CCPtr -> CCPtr -> CCPtr # min :: CCPtr -> CCPtr -> CCPtr #
Hashable CCPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods hashWithSalt :: Int -> CCPtr -> Int # hash :: CCPtr -> Int #

readCCPtr :: String -> Maybe CCPtr Source #

mkCCPtr :: Word64 -> CCPtr Source #

newtype IndexTablePtr Source #

Constructors

IndexTablePtr Word64

Instances

Instances details

Show IndexTablePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> IndexTablePtr -> ShowS # show :: IndexTablePtr -> String # showList :: [IndexTablePtr] -> ShowS #
Binary IndexTablePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: IndexTablePtr -> Put # get :: Get IndexTablePtr # putList :: [IndexTablePtr] -> Put #
Eq IndexTablePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: IndexTablePtr -> IndexTablePtr -> Bool # (/=) :: IndexTablePtr -> IndexTablePtr -> Bool #
Ord IndexTablePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods compare :: IndexTablePtr -> IndexTablePtr -> Ordering # (<) :: IndexTablePtr -> IndexTablePtr -> Bool # (<=) :: IndexTablePtr -> IndexTablePtr -> Bool # (>) :: IndexTablePtr -> IndexTablePtr -> Bool # (>=) :: IndexTablePtr -> IndexTablePtr -> Bool # max :: IndexTablePtr -> IndexTablePtr -> IndexTablePtr # min :: IndexTablePtr -> IndexTablePtr -> IndexTablePtr #
Hashable IndexTablePtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods hashWithSalt :: Int -> IndexTablePtr -> Int # hash :: IndexTablePtr -> Int #

mkIndexTablePtr :: Word64 -> IndexTablePtr Source #

newtype RetainerSetPtr Source #

Constructors

RetainerSetPtr Word64

Instances

Instances details

Show RetainerSetPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods showsPrec :: Int -> RetainerSetPtr -> ShowS # show :: RetainerSetPtr -> String # showList :: [RetainerSetPtr] -> ShowS #
Binary RetainerSetPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods put :: RetainerSetPtr -> Put # get :: Get RetainerSetPtr # putList :: [RetainerSetPtr] -> Put #
Eq RetainerSetPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods (==) :: RetainerSetPtr -> RetainerSetPtr -> Bool # (/=) :: RetainerSetPtr -> RetainerSetPtr -> Bool #
Ord RetainerSetPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods compare :: RetainerSetPtr -> RetainerSetPtr -> Ordering # (<) :: RetainerSetPtr -> RetainerSetPtr -> Bool # (<=) :: RetainerSetPtr -> RetainerSetPtr -> Bool # (>) :: RetainerSetPtr -> RetainerSetPtr -> Bool # (>=) :: RetainerSetPtr -> RetainerSetPtr -> Bool # max :: RetainerSetPtr -> RetainerSetPtr -> RetainerSetPtr # min :: RetainerSetPtr -> RetainerSetPtr -> RetainerSetPtr #
Hashable RetainerSetPtr Source #
Instance details Defined in GHC.Debug.Types.Ptr Methods hashWithSalt :: Int -> RetainerSetPtr -> Int # hash :: RetainerSetPtr -> Int #

Other utility

arrWordsBS :: [Word] -> ByteString Source #

prettyPrint :: ByteString -> String Source #

printBS :: HasCallStack => ByteString -> String Source #

InfoTables

Instances

Instances

Closures

Instances

Instances

Operations on ClosurePtr

Blocks

Instances

Instances

Stacks

Instances

Instances

Bitmaps

Instances

Constants

Instances

Instances

Instances

Instances

Other utility

Operations on `ClosurePtr`