Moduleghc-lib-parser-9.14.1.20251220GHC2021

GHC.ByteCode.Breakpoints

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 [ModBreaks vs InternalModBreaks] and Note [Breakpoint identifiers]

5 types
10 values

Packageghc-lib-parser-9.14.1.20251220
Exports15
LanguageGHC2021
LicenceBSD-3-Clause
SourceBreakpoints.hs

Internal Mod Breaks

4 declarations

datadata InternalModBreaks

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
- imodBreaks_breakInfo :: !IntMap CgBreakInfo
  Access code-gen time information about a breakpoint, indexed by InternalBreakpointId.
- imodBreaks_modBreaks :: !ModBreaks
  Store the ModBreaks for this module
  Recall Note [Breakpoint identifiers]: for some module A, an *occurrence* of a breakpoint in A may have been inlined from some breakpoint *defined* in module B.
  This ModBreaks contains information regarding all the breakpoints defined in the module this InternalModBreaks corresponds to. It does not necessarily have information regarding all the breakpoint occurrences registered in imodBreaks_breakInfo. Some of those occurrences may refer breakpoints inlined from other modules.

datadata CgBreakInfo

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
- cgb_tyvars :: ![IfaceTvBndr]
  Type variables in scope at the breakpoint
- cgb_vars :: ![Maybe (IfaceIdBndr, Word)]
- cgb_resty :: !IfaceType
- cgb_tick_id :: !Either InternalBreakLoc BreakpointId
  This field records the original breakpoint tick identifier for this internal breakpoint info. It is used to convert a breakpoint *occurrence* index (InternalBreakpointId) into a *definition* index (BreakpointId).
  The modules of breakpoint occurrence and breakpoint definition are not necessarily the same: See Note [Breakpoint identifiers].
  If there is no original tick identifier (that is, the breakpoint was created during code generation), we re-use the BreakpointId of something else. It would also be reasonable to have an Either something BreakpointId for cgb_tick_id, but currently we can always re-use a source-level BreakpointId. In the case of step-out, see Note [Debugger: Stepout internal break locs]

Instances1Outputable

Outputable CgBreakInfoDefined in ghc-lib-parser-9.14.1.20251220 · GHC.ByteCode.Breakpoints

valuemkInternalModBreaks

Construct an InternalModBreaks.

INVARIANT: The given ModBreaks correspond to the same module as this InternalModBreaks module (the first argument) and its breakpoint infos (the IntMap CgBreakInfo argument)

valueimodBreaks_module :: InternalModBreaks -> Module

Get the module to which these InternalModBreaks correspond

Internal breakpoint identifier

datadata InternalBreakpointId

Internal breakpoint identifier

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

Constructors

InternalBreakpointId
- ibi_info_mod :: !Module
  Breakpoint info module
- ibi_info_index :: !BreakInfoIndex
  Breakpoint info index

Instances4Eq, Ord, NFData, Outputable

Eq InternalBreakpointIdDefined in ghc-lib-parser-9.14.1.20251220 · GHC.ByteCode.Breakpoints
Ord InternalBreakpointIdDefined in ghc-lib-parser-9.14.1.20251220 · GHC.ByteCode.Breakpoints
NFData InternalBreakpointIdDefined in ghc-lib-parser-9.14.1.20251220 · GHC.ByteCode.Breakpoints
Outputable InternalBreakpointIdDefined in ghc-lib-parser-9.14.1.20251220 · GHC.ByteCode.Breakpoints

typetype BreakInfoIndex = Int

Internal breakpoint info index

newtypenewtype InternalBreakLoc

Breakpoints created during code generation don't have a source-level tick location. Instead, we re-use an existing one.

Constructors

InternalBreakLoc
- internalBreakLoc :: BreakpointId

Instances3Eq, NFData, Outputable

Eq InternalBreakLocDefined in ghc-lib-parser-9.14.1.20251220 · GHC.ByteCode.Breakpoints
NFData InternalBreakLocDefined in ghc-lib-parser-9.14.1.20251220 · GHC.ByteCode.Breakpoints
Outputable InternalBreakLocDefined in ghc-lib-parser-9.14.1.20251220 · GHC.ByteCode.Breakpoints

Operations

0 declarations

Internal-level operations

valuegetInternalBreak :: InternalBreakpointId -> InternalModBreaks -> CgBreakInfo

Get an internal breakpoint info by InternalBreakpointId

Source-level information operations

valuegetBreakLoc

Get the source span for this breakpoint

valuegetBreakVars

Get the vars for this breakpoint

valuegetBreakDecls

Get the decls for this breakpoint

valuegetBreakCCS

Get the decls for this breakpoint

valuegetBreakSourceId

:: InternalBreakpointId
-> InternalModBreaks
-> BreakpointId

Get the source module and tick index for this breakpoint (as opposed to the module where this breakpoint occurs, which is in InternalBreakpointId)

valuegetBreakSourceMod :: InternalBreakpointId -> InternalModBreaks -> Module

Get the source module for this breakpoint (where the breakpoint is defined)

Utils

1 declaration

valueseqInternalModBreaks :: InternalModBreaks -> ()

Fully force an InternalModBreaks value