ghc-9.8.0.20230929: The GHC API
Safe HaskellNone
LanguageHaskell2010

GHC.CmmToAsm.Dwarf.Types

Synopsis

Dwarf information

data DwarfInfo Source #

Individual dwarf records. Each one will be encoded as an entry in the .debug_info section.

pprDwarfInfo :: IsDoc doc => Platform -> Bool -> DwarfInfo -> doc Source #

Generate assembly for DWARF data

pprAbbrevDecls :: IsDoc doc => Platform -> Bool -> doc Source #

Abbreviation declaration. This explains the binary encoding we use for representing DwarfInfo. Be aware that this must be updated along with pprDwarfInfo.

Dwarf address range table

data DwarfARange Source #

A DWARF address range. This is used by the debugger to quickly locate which compilation unit a given address belongs to. This type assumes a non-segmented address-space.

pprDwarfARanges :: IsDoc doc => Platform -> [DwarfARange] -> Unique -> doc Source #

Print assembler directives corresponding to a DWARF .debug_aranges address table entry.

Dwarf frame

data DwarfFrame Source #

Information about unwind instructions for a procedure. This corresponds to a "Common Information Entry" (CIE) in DWARF.

data DwarfFrameProc Source #

Unwind instructions for an individual procedure. Corresponds to a "Frame Description Entry" (FDE) in DWARF.

Constructors

DwarfFrameProc 

Fields

data DwarfFrameBlock Source #

Unwind instructions for a block. Will become part of the containing FDE.

Constructors

DwarfFrameBlock 

Fields

Instances

Instances details
OutputableP Platform DwarfFrameBlock Source # 
Instance details

Defined in GHC.CmmToAsm.Dwarf.Types

pprDwarfFrame :: IsDoc doc => Platform -> DwarfFrame -> doc Source #

Header for the .debug_frame section. Here we emit the "Common Information Entry" record that establishes general call frame parameters and the default stack layout.

Utilities

pprByte :: IsDoc doc => Word8 -> doc Source #

Assembly for a single byte of constant DWARF data

pprHalf :: IsDoc doc => Word16 -> doc Source #

Assembly for a two-byte constant integer

pprData4' :: IsDoc doc => Line doc -> doc Source #

Assembly for 4 bytes of dynamic DWARF data

pprDwWord :: IsDoc doc => Line doc -> doc Source #

Assembly for a DWARF word of dynamic data. This means 32 bit, as we are generating 32 bit DWARF.

pprWord :: IsDoc doc => Platform -> Line doc -> doc Source #

Assembly for a machine word of dynamic data. Depends on the architecture we are currently generating code for.

pprLEBWord :: IsDoc doc => Word -> doc Source #

Prints a number in "little endian base 128" format. The idea is to optimize for small numbers by stopping once all further bytes would be 0. The highest bit in every byte signals whether there are further bytes to read.

pprLEBInt :: IsDoc doc => Int -> doc Source #

Same as pprLEBWord, but for a signed number

wordAlign :: IsDoc doc => Platform -> doc Source #

Align assembly at (machine) word boundary

sectionOffset :: IsDoc doc => Platform -> Line doc -> Line doc -> doc Source #

Generate an offset into another section. This is tricky because this is handled differently depending on platform: Mac Os expects us to calculate the offset using assembler arithmetic. Linux expects us to just reference the target directly, and will figure out on their own that we actually need an offset. Finally, Windows has a special directive to refer to relative offsets. Fun.