Safe Haskell	Safe-Inferred
Language	Haskell2010

GHC.Debug.Types

Contents

Serialisation functions

Synopsis

module GHC.Debug.Types.Ptr
module GHC.Debug.Types.Closures
data Request a where
- RequestVersion :: Request Word32
- RequestPause :: ForkOrPause -> Request ()
- RequestResume :: Request ()
- RequestRoots :: Request [ClosurePtr]
- RequestClosure :: ClosurePtr -> Request RawClosure
- RequestInfoTable :: InfoTablePtr -> Request (StgInfoTableWithPtr, RawInfoTable)
- RequestPoll :: Request ()
- RequestSavedObjects :: Request [ClosurePtr]
- RequestStackBitmap :: StackPtr -> Word32 -> Request PtrBitmap
- RequestFunBitmap :: Word16 -> ClosurePtr -> Request PtrBitmap
- RequestConstrDesc :: InfoTablePtr -> Request ConstrDesc
- RequestSourceInfo :: InfoTablePtr -> Request (Maybe SourceInformation)
- RequestAllBlocks :: Request [RawBlock]
- RequestBlock :: ClosurePtr -> Request RawBlock
data ForkOrPause
- = Pause
- | Fork
requestCommandId :: Request a -> CommandId
doRequest :: MVar Handle -> Request a -> IO a
isWriteRequest :: Request a -> Bool
withWriteRequest :: Request a -> r a -> (a ~ () => Request a -> r a) -> r a
isImmutableRequest :: Request a -> Bool
data AnyReq = forall req. AnyReq !(Request req)
data AnyResp = forall a. AnyResp !a !(a -> Put)
newtype CommandId = CommandId Word32
data SourceInformation = SourceInformation {
- infoName :: !String
- infoClosureType :: !ClosureType
- infoType :: !String
- infoLabel :: !String
- infoModule :: !String
- infoPosition :: !String
}
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
getIPE :: Get (Maybe SourceInformation)
putIPE :: Maybe SourceInformation -> Put
getInfoTable :: Get (StgInfoTable, RawInfoTable)
putInfoTable :: RawInfoTable -> Put
putRequest :: Request a -> Put
getRequest :: Get AnyReq

Documentation

module GHC.Debug.Types.Ptr

module GHC.Debug.Types.Closures

data Request a where Source #

A request sent from the debugger to the debuggee parametrized on the result type.

Constructors

RequestVersion :: Request Word32	Request protocol version
RequestPause :: ForkOrPause -> Request ()	Pause the debuggee.
RequestResume :: Request ()	Resume the debuggee.
RequestRoots :: Request [ClosurePtr]	Request the debuggee's root pointers.
RequestClosure :: ClosurePtr -> Request RawClosure	Request a closure
RequestInfoTable :: InfoTablePtr -> Request (StgInfoTableWithPtr, RawInfoTable)	Request an info table
RequestPoll :: Request ()	Wait for the debuggee to pause itself and then execute an action. It currently impossible to resume after a pause caused by a poll.
RequestSavedObjects :: Request [ClosurePtr]	A client can save objects by calling a special RTS method This function returns the closures it saved.
RequestStackBitmap :: StackPtr -> Word32 -> Request PtrBitmap	Request the pointer bitmap for a stack frame at a given offset from a StackPtr.
RequestFunBitmap :: Word16 -> ClosurePtr -> Request PtrBitmap	Decode the bitmap contained in a StgFunInfoTable Used by PAP and AP closure types.
RequestConstrDesc :: InfoTablePtr -> Request ConstrDesc	Request the constructor description for an info table. The info table must be from a `ConstrClosure`
RequestSourceInfo :: InfoTablePtr -> Request (Maybe SourceInformation)	Lookup source information of an info table
RequestAllBlocks :: Request [RawBlock]	Copy all blocks from the process at once
RequestBlock :: ClosurePtr -> Request RawBlock	Request the block which contains a specific pointer

Instances

Instances details

Show (Request a) Source #
Instance details Defined in GHC.Debug.Types Methods showsPrec :: Int -> Request a -> ShowS # show :: Request a -> String # showList :: [Request a] -> ShowS #
Eq (Request a) Source #
Instance details Defined in GHC.Debug.Types Methods (==) :: Request a -> Request a -> Bool # (/=) :: Request a -> Request a -> Bool #
Hashable (Request a) Source #
Instance details Defined in GHC.Debug.Types Methods hashWithSalt :: Int -> Request a -> Int hash :: Request a -> Int

data ForkOrPause Source #

The decision about whether to fork the running process or pause it running whilst we are debugging it.

Constructors

Pause
Fork

Instances

Instances details

Enum ForkOrPause Source #
Instance details Defined in GHC.Debug.Types Methods succ :: ForkOrPause -> ForkOrPause # pred :: ForkOrPause -> ForkOrPause # toEnum :: Int -> ForkOrPause # fromEnum :: ForkOrPause -> Int # enumFrom :: ForkOrPause -> [ForkOrPause] # enumFromThen :: ForkOrPause -> ForkOrPause -> [ForkOrPause] # enumFromTo :: ForkOrPause -> ForkOrPause -> [ForkOrPause] # enumFromThenTo :: ForkOrPause -> ForkOrPause -> ForkOrPause -> [ForkOrPause] #
Show ForkOrPause Source #
Instance details Defined in GHC.Debug.Types Methods showsPrec :: Int -> ForkOrPause -> ShowS # show :: ForkOrPause -> String # showList :: [ForkOrPause] -> ShowS #
Binary ForkOrPause Source #
Instance details Defined in GHC.Debug.Types Methods put :: ForkOrPause -> Put # get :: Get ForkOrPause # putList :: [ForkOrPause] -> Put #
Eq ForkOrPause Source #
Instance details Defined in GHC.Debug.Types Methods (==) :: ForkOrPause -> ForkOrPause -> Bool # (/=) :: ForkOrPause -> ForkOrPause -> Bool #
Ord ForkOrPause Source #
Instance details Defined in GHC.Debug.Types Methods compare :: ForkOrPause -> ForkOrPause -> Ordering # (<) :: ForkOrPause -> ForkOrPause -> Bool # (<=) :: ForkOrPause -> ForkOrPause -> Bool # (>) :: ForkOrPause -> ForkOrPause -> Bool # (>=) :: ForkOrPause -> ForkOrPause -> Bool # max :: ForkOrPause -> ForkOrPause -> ForkOrPause # min :: ForkOrPause -> ForkOrPause -> ForkOrPause #
Hashable ForkOrPause Source #
Instance details Defined in GHC.Debug.Types Methods hashWithSalt :: Int -> ForkOrPause -> Int hash :: ForkOrPause -> Int

requestCommandId :: Request a -> CommandId Source #

doRequest :: MVar Handle -> Request a -> IO a Source #

Perform a request

isWriteRequest :: Request a -> Bool Source #

Whether a request mutates the debuggee state, don't cache these ones

withWriteRequest :: Request a -> r a -> (a ~ () => Request a -> r a) -> r a Source #

isImmutableRequest :: Request a -> Bool Source #

Requests which will always answer the same. For example, info tables are immutable and so requesting an info table will always result in the same value and is safe to cache across pause lines.

data AnyReq Source #

Constructors

forall req. AnyReq !(Request req)

Instances

Instances details

Eq AnyReq Source #
Instance details Defined in GHC.Debug.Types Methods (==) :: AnyReq -> AnyReq -> Bool # (/=) :: AnyReq -> AnyReq -> Bool #
Hashable AnyReq Source #
Instance details Defined in GHC.Debug.Types Methods hashWithSalt :: Int -> AnyReq -> Int hash :: AnyReq -> Int

data AnyResp Source #

Constructors

forall a. AnyResp !a !(a -> Put)

newtype CommandId Source #

Constructors

CommandId Word32

Instances

Instances details

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

data SourceInformation Source #

Constructors

SourceInformation
Fields infoName :: !String infoClosureType :: !ClosureType infoType :: !String infoLabel :: !String infoModule :: !String infoPosition :: !String

Instances

Instances details

Show SourceInformation Source #
Instance details Defined in GHC.Debug.Types Methods showsPrec :: Int -> SourceInformation -> ShowS # show :: SourceInformation -> String # showList :: [SourceInformation] -> ShowS #
Eq SourceInformation Source #
Instance details Defined in GHC.Debug.Types Methods (==) :: SourceInformation -> SourceInformation -> Bool # (/=) :: SourceInformation -> SourceInformation -> Bool #
Ord SourceInformation Source #
Instance details Defined in GHC.Debug.Types Methods compare :: SourceInformation -> SourceInformation -> Ordering # (<) :: SourceInformation -> SourceInformation -> Bool # (<=) :: SourceInformation -> SourceInformation -> Bool # (>) :: SourceInformation -> SourceInformation -> Bool # (>=) :: SourceInformation -> SourceInformation -> Bool # max :: SourceInformation -> SourceInformation -> SourceInformation # min :: SourceInformation -> SourceInformation -> SourceInformation #

data ClosureType #

Constructors

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

Instances

Instances details

Enum ClosureType
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] #
Generic ClosureType
Instance details Defined in GHC.Exts.Heap.ClosureTypes Associated Types type Rep ClosureType :: Type -> Type # Methods from :: ClosureType -> Rep ClosureType x # to :: Rep ClosureType x -> ClosureType #
Show ClosureType
Instance details Defined in GHC.Exts.Heap.ClosureTypes Methods showsPrec :: Int -> ClosureType -> ShowS # show :: ClosureType -> String # showList :: [ClosureType] -> ShowS #
Eq ClosureType
Instance details Defined in GHC.Exts.Heap.ClosureTypes Methods (==) :: ClosureType -> ClosureType -> Bool # (/=) :: ClosureType -> ClosureType -> Bool #
Ord ClosureType
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 #
type Rep ClosureType
Instance details Defined in GHC.Exts.Heap.ClosureTypes type Rep ClosureType = D1 ('MetaData "ClosureType" "GHC.Exts.Heap.ClosureTypes" "ghc-heap-9.2.2" 'False) ((((((C1 ('MetaCons "INVALID_OBJECT" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CONSTR" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CONSTR_1_0" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CONSTR_0_1" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "CONSTR_2_0" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CONSTR_1_1" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CONSTR_0_2" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CONSTR_NOCAF" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "FUN" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FUN_1_0" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "FUN_0_1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FUN_2_0" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "FUN_1_1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FUN_0_2" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "FUN_STATIC" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "THUNK" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: ((((C1 ('MetaCons "THUNK_1_0" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "THUNK_0_1" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "THUNK_2_0" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "THUNK_1_1" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "THUNK_0_2" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "THUNK_STATIC" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "THUNK_SELECTOR" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BCO" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "AP" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PAP" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "AP_STACK" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IND" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "IND_STATIC" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RET_BCO" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "RET_SMALL" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RET_BIG" 'PrefixI 'False) (U1 :: Type -> Type)))))) :+: (((((C1 ('MetaCons "RET_FUN" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UPDATE_FRAME" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CATCH_FRAME" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UNDERFLOW_FRAME" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "STOP_FRAME" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BLOCKING_QUEUE" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "BLACKHOLE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MVAR_CLEAN" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "MVAR_DIRTY" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TVAR" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ARR_WORDS" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MUT_ARR_PTRS_CLEAN" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "MUT_ARR_PTRS_DIRTY" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MUT_ARR_PTRS_FROZEN_DIRTY" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MUT_ARR_PTRS_FROZEN_CLEAN" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MUT_VAR_CLEAN" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: ((((C1 ('MetaCons "MUT_VAR_DIRTY" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WEAK" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PRIM" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MUT_PRIM" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "TSO" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "STACK" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "TREC_CHUNK" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ATOMICALLY_FRAME" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "CATCH_RETRY_FRAME" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CATCH_STM_FRAME" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "WHITEHOLE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SMALL_MUT_ARR_PTRS_CLEAN" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "SMALL_MUT_ARR_PTRS_DIRTY" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SMALL_MUT_ARR_PTRS_FROZEN_DIRTY" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SMALL_MUT_ARR_PTRS_FROZEN_CLEAN" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "COMPACT_NFDATA" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "N_CLOSURE_TYPES" 'PrefixI 'False) (U1 :: Type -> Type))))))))

Serialisation functions

getIPE :: Get (Maybe SourceInformation) Source #

putIPE :: Maybe SourceInformation -> Put Source #

getInfoTable :: Get (StgInfoTable, RawInfoTable) Source #

putInfoTable :: RawInfoTable -> Put Source #

putRequest :: Request a -> Put Source #

getRequest :: Get AnyReq Source #