Safe Haskell	None
Language	GHC2021

GHC.Cmm.DebugBlock

Contents

Unwinding information

Synopsis

data DebugBlock = DebugBlock {
- dblProcedure :: !Label
- dblLabel :: !Label
- dblCLabel :: !CLabel
- dblHasInfoTbl :: !Bool
- dblParent :: !(Maybe DebugBlock)
- dblTicks :: ![CmmTickish]
- dblSourceTick :: !(Maybe CmmTickish)
- dblPosition :: !(Maybe Int)
- dblUnwind :: [UnwindPoint]
- dblBlocks :: ![DebugBlock]
}
cmmDebugGen :: ModLocation -> RawCmmGroup -> [DebugBlock]
cmmDebugLabels :: (BlockId -> Bool) -> (i -> Bool) -> GenCmmGroup d g (ListGraph i) -> [Label]
cmmDebugLink :: [Label] -> LabelMap [UnwindPoint] -> [DebugBlock] -> [DebugBlock]
debugToMap :: [DebugBlock] -> LabelMap DebugBlock
type UnwindTable = Map GlobalReg (Maybe UnwindExpr)
data UnwindPoint = UnwindPoint !CLabel !UnwindTable
data UnwindExpr
- = UwConst !Int
- | UwReg !GlobalRegUse !Int
- | UwDeref UnwindExpr
- | UwLabel CLabel
- | UwPlus UnwindExpr UnwindExpr
- | UwMinus UnwindExpr UnwindExpr
- | UwTimes UnwindExpr UnwindExpr
toUnwindExpr :: Platform -> CmmExpr -> UnwindExpr
pprUnwindTable :: IsLine doc => Platform -> UnwindTable -> doc

Documentation

data DebugBlock Source #

Debug information about a block of code. Ticks scope over nested blocks.

Constructors

DebugBlock

Fields

dblProcedure :: !Label
Entry label of containing proc
dblLabel :: !Label
Hoopl label
dblCLabel :: !CLabel
Output label
dblHasInfoTbl :: !Bool
Has an info table?
dblParent :: !(Maybe DebugBlock)
The parent of this proc. See Note [Splitting DebugBlocks]
dblTicks :: ![CmmTickish]
Ticks defined in this block
dblSourceTick :: !(Maybe CmmTickish)
Best source tick covering block
dblPosition :: !(Maybe Int)
Output position relative to other blocks. Nothing means the block was optimized out
dblUnwind :: [UnwindPoint]
dblBlocks :: ![DebugBlock]
Nested blocks

Instances

Instances details

OutputableP Platform DebugBlock Source #
Instance details Defined in GHC.Cmm.DebugBlock Methods pdoc :: Platform -> DebugBlock -> SDoc Source #

cmmDebugGen :: ModLocation -> RawCmmGroup -> [DebugBlock] Source #

Extract debug data from a group of procedures. We will prefer source notes that come from the given module (presumably the module that we are currently compiling).

cmmDebugLabels :: (BlockId -> Bool) -> (i -> Bool) -> GenCmmGroup d g (ListGraph i) -> [Label] Source #

cmmDebugLink :: [Label] -> LabelMap [UnwindPoint] -> [DebugBlock] -> [DebugBlock] Source #

Sets position and unwind table fields in the debug block tree according to native generated code.

debugToMap :: [DebugBlock] -> LabelMap DebugBlock Source #

Converts debug blocks into a label map for easier lookups

Unwinding information

type UnwindTable = Map GlobalReg (Maybe UnwindExpr) Source #

Maps registers to expressions that yield their "old" values further up the stack. Most interesting for the stack pointer Sp, but might be useful to document saved registers, too. Note that a register's value will be Nothing when the register's previous value cannot be reconstructed.

data UnwindPoint Source #

A label associated with an UnwindTable

Constructors

UnwindPoint !CLabel !UnwindTable

Instances

Instances details

OutputableP Platform UnwindPoint Source #
Instance details Defined in GHC.Cmm.DebugBlock Methods pdoc :: Platform -> UnwindPoint -> SDoc Source #

data UnwindExpr Source #

Expressions, used for unwind information

Constructors

UwConst !Int	literal value
UwReg !GlobalRegUse !Int	register plus offset
UwDeref UnwindExpr	pointer dereferencing
UwLabel CLabel
UwPlus UnwindExpr UnwindExpr
UwMinus UnwindExpr UnwindExpr
UwTimes UnwindExpr UnwindExpr

Instances

Instances details

Eq UnwindExpr Source #
Instance details Defined in GHC.Cmm.DebugBlock Methods (==) :: UnwindExpr -> UnwindExpr -> Bool # (/=) :: UnwindExpr -> UnwindExpr -> Bool #
OutputableP Platform UnwindExpr Source #
Instance details Defined in GHC.Cmm.DebugBlock Methods pdoc :: Platform -> UnwindExpr -> SDoc Source #

toUnwindExpr :: Platform -> CmmExpr -> UnwindExpr Source #

Conversion of Cmm expressions to unwind expressions. We check for unsupported operator usages and simplify the expression as far as possible.

pprUnwindTable :: IsLine doc => Platform -> UnwindTable -> doc Source #