Safe Haskell	None
Language	GHC2021

GHC.ByteCode.Breakpoints

Contents

Internal Mod Breaks
- Internal breakpoint identifier
Operations
- Internal-level operations
- Source-level information operations
Utils

Description

Breakpoint information constructed during ByteCode generation.

Specifically, code-generation breakpoints are referred to as "internal breakpoints", the internal breakpoint data for a module is stored in InternalModBreaks, and is uniquely identified at runtime by an InternalBreakpointId.

See Note [Breakpoint identifiers]

Synopsis

data InternalModBreaks = InternalModBreaks {
- imodBreaks_breakInfo :: !(IntMap CgBreakInfo)
- imodBreaks_modBreaks :: !ModBreaks
}
data CgBreakInfo = CgBreakInfo {
- cgb_tyvars :: ![IfaceTvBndr]
- cgb_vars :: ![Maybe (IfaceIdBndr, Word)]
- cgb_resty :: !IfaceType
}
mkInternalModBreaks :: Module -> IntMap CgBreakInfo -> ModBreaks -> InternalModBreaks
data InternalBreakpointId = InternalBreakpointId {
- ibi_tick_mod :: !Module
- ibi_tick_index :: !Int
- ibi_info_mod :: !Module
- ibi_info_index :: !BreakInfoIndex
}
type BreakInfoIndex = Int
toBreakpointId :: InternalBreakpointId -> BreakpointId
getInternalBreak :: InternalBreakpointId -> InternalModBreaks -> CgBreakInfo
addInternalBreak :: InternalBreakpointId -> CgBreakInfo -> InternalModBreaks -> InternalModBreaks
getBreakLoc :: InternalBreakpointId -> InternalModBreaks -> SrcSpan
getBreakVars :: InternalBreakpointId -> InternalModBreaks -> [OccName]
getBreakDecls :: InternalBreakpointId -> InternalModBreaks -> [String]
getBreakCCS :: InternalBreakpointId -> InternalModBreaks -> (String, String)
seqInternalModBreaks :: InternalModBreaks -> ()

Internal Mod Breaks

data InternalModBreaks Source #

Internal mod breaks store the runtime-relevant information of breakpoints.

Importantly, it maps InternalBreakpointIds to CgBreakInfo.

InternalModBreaks are constructed during bytecode generation and stored in CompiledByteCode afterwards.

Constructors

InternalModBreaks
Fields imodBreaks_breakInfo :: !(IntMap CgBreakInfo) Access code-gen time information about a breakpoint, indexed by `InternalBreakpointId`. imodBreaks_modBreaks :: !ModBreaks Store the original ModBreaks for this module, unchanged. Allows us to query about source-level breakpoint information using an internal breakpoint id.

data CgBreakInfo Source #

Information about a breakpoint that we know at code-generation time In order to be used, this needs to be hydrated relative to the current HscEnv by hydrateCgBreakInfo. Everything here can be fully forced and that's critical for preventing space leaks (see #22530)

Constructors

CgBreakInfo
Fields cgb_tyvars :: ![IfaceTvBndr] Type variables in scope at the breakpoint cgb_vars :: ![Maybe (IfaceIdBndr, Word)] cgb_resty :: !IfaceType

Instances

Instances details

Outputable CgBreakInfo Source #
Instance details Defined in GHC.ByteCode.Breakpoints Methods ppr :: CgBreakInfo -> SDoc Source #

mkInternalModBreaks :: Module -> IntMap CgBreakInfo -> ModBreaks -> InternalModBreaks Source #

Construct an InternalModBreaks

Internal breakpoint identifier

data InternalBreakpointId Source #

Internal breakpoint identifier

Indexes into the structures in the InternalModBreaks produced during ByteCode generation. See Note [Breakpoint identifiers]

Constructors

InternalBreakpointId
Fields ibi_tick_mod :: !Module Breakpoint tick module ibi_tick_index :: !Int Breakpoint tick index ibi_info_mod :: !Module Breakpoint tick module ibi_info_index :: !BreakInfoIndex Breakpoint tick index

Instances

Instances details

NFData InternalBreakpointId Source #
Instance details Defined in GHC.ByteCode.Breakpoints Methods rnf :: InternalBreakpointId -> () Source #
Outputable InternalBreakpointId Source #
Instance details Defined in GHC.ByteCode.Breakpoints Methods ppr :: InternalBreakpointId -> SDoc Source #
Eq InternalBreakpointId Source #
Instance details Defined in GHC.ByteCode.Breakpoints Methods (==) :: InternalBreakpointId -> InternalBreakpointId -> Bool Source # (/=) :: InternalBreakpointId -> InternalBreakpointId -> Bool Source #
Ord InternalBreakpointId Source #
Instance details Defined in GHC.ByteCode.Breakpoints Methods compare :: InternalBreakpointId -> InternalBreakpointId -> Ordering Source # (<) :: InternalBreakpointId -> InternalBreakpointId -> Bool Source # (<=) :: InternalBreakpointId -> InternalBreakpointId -> Bool Source # (>) :: InternalBreakpointId -> InternalBreakpointId -> Bool Source # (>=) :: InternalBreakpointId -> InternalBreakpointId -> Bool Source # max :: InternalBreakpointId -> InternalBreakpointId -> InternalBreakpointId Source # min :: InternalBreakpointId -> InternalBreakpointId -> InternalBreakpointId Source #