LLVM  14.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::DwarfDebug Class Reference

Collects and handles dwarf debug information. More...

#include "CodeGen/AsmPrinter/DwarfDebug.h"

Inheritance diagram for llvm::DwarfDebug:
Inheritance graph
[legend]
Collaboration diagram for llvm::DwarfDebug:
Collaboration graph
[legend]

Classes

class  NonTypeUnitContext
 

Public Types

enum  MinimizeAddrInV5 {
  MinimizeAddrInV5::Default, MinimizeAddrInV5::Disabled, MinimizeAddrInV5::Ranges, MinimizeAddrInV5::Expressions,
  MinimizeAddrInV5::Form
}
 

Public Member Functions

 DwarfDebug (AsmPrinter *A)
 
 ~DwarfDebug () override
 
void beginModule (Module *M) override
 Emit all Dwarf sections that should come prior to the content. More...
 
void endModule () override
 Emit all Dwarf sections that should come after the content. More...
 
DebugLoc emitInitialLocDirective (const MachineFunction &MF, unsigned CUID)
 Emits inital debug location directive. More...
 
void beginInstruction (const MachineInstr *MI) override
 Process beginning of an instruction. More...
 
void addDwarfTypeUnitType (DwarfCompileUnit &CU, StringRef Identifier, DIE &Die, const DICompositeType *CTy)
 Add a DIE to the set of types that we're going to pull into type units. More...
 
NonTypeUnitContext enterNonTypeUnitContext ()
 
void addArangeLabel (SymbolCU SCU)
 Add a label so that arange data can be generated for it. More...
 
void setSymbolSize (const MCSymbol *Sym, uint64_t Size) override
 For symbols that have a size designated (e.g. More...
 
bool useAllLinkageNames () const
 Returns whether we should emit all DW_AT_[MIPS_]linkage_name. More...
 
bool useGNUTLSOpcode () const
 Returns whether to use DW_OP_GNU_push_tls_address, instead of the standard DW_OP_form_tls_address opcode. More...
 
bool useDWARF2Bitfields () const
 Returns whether to use the DWARF2 format for bitfields instyead of the DWARF4 format. More...
 
bool useInlineStrings () const
 Returns whether to use inline strings. More...
 
bool useRangesSection () const
 Returns whether ranges section should be emitted. More...
 
bool alwaysUseRanges () const
 Returns whether range encodings should be used for single entry range lists. More...
 
bool useAddrOffsetExpressions () const
 
bool useAddrOffsetForm () const
 
bool useSectionsAsReferences () const
 Returns whether to use sections as labels rather than temp symbols. More...
 
bool useLocSection () const
 Returns whether .debug_loc section should be emitted. More...
 
bool generateTypeUnits () const
 Returns whether to generate DWARF v4 type units. More...
 
AccelTableKind getAccelTableKind () const
 Returns what kind (if any) of accelerator tables to emit. More...
 
bool useAppleExtensionAttributes () const
 
bool useSplitDwarf () const
 Returns whether or not to change the current debug info for the split dwarf proposal support. More...
 
bool useSegmentedStringOffsetsTable () const
 Returns whether to generate a string offsets table with (possibly shared) contributions from each CU and type unit. More...
 
bool emitDebugEntryValues () const
 
bool useOpConvert () const
 
bool shareAcrossDWOCUs () const
 
uint16_t getDwarfVersion () const
 Returns the Dwarf Version. More...
 
dwarf::Form getDwarfSectionOffsetForm () const
 Returns a suitable DWARF form to represent a section offset, i.e. More...
 
const DwarfCompileUnitgetPrevCU () const
 Returns the previous CU that was being updated. More...
 
void setPrevCU (const DwarfCompileUnit *PrevCU)
 
const DebugLocStreamgetDebugLocs () const
 Returns the entries for the .debug_loc section. More...
 
void emitDebugLocEntry (ByteStreamer &Streamer, const DebugLocStream::Entry &Entry, const DwarfCompileUnit *CU)
 Emit an entry for the debug loc section. More...
 
void emitDebugLocEntryLocation (const DebugLocStream::Entry &Entry, const DwarfCompileUnit *CU)
 Emit the location for a debug loc entry, including the size header. More...
 
void addSubprogramNames (const DICompileUnit &CU, const DISubprogram *SP, DIE &Die)
 
AddressPoolgetAddressPool ()
 
void addAccelName (const DICompileUnit &CU, StringRef Name, const DIE &Die)
 
void addAccelObjC (const DICompileUnit &CU, StringRef Name, const DIE &Die)
 
void addAccelNamespace (const DICompileUnit &CU, StringRef Name, const DIE &Die)
 
void addAccelType (const DICompileUnit &CU, StringRef Name, const DIE &Die, char Flags)
 
const MachineFunctiongetCurrentFunction () const
 
bool isLexicalScopeDIENull (LexicalScope *Scope)
 A helper function to check whether the DIE for a given Scope is going to be null. More...
 
DwarfCompileUnitlookupCU (const DIE *Die)
 Find the matching DwarfCompileUnit for the given CU DIE. More...
 
const DwarfCompileUnitlookupCU (const DIE *Die) const
 
unsigned getStringTypeLoc (const DIStringType *ST) const
 
void addStringTypeLoc (const DIStringType *ST, unsigned Loc)
 
bool tuneForGDB () const
 
bool tuneForLLDB () const
 
bool tuneForSCE () const
 
bool tuneForDBX () const
 
const MCSymbolgetSectionLabel (const MCSection *S)
 
void insertSectionLabel (const MCSymbol *S)
 
Optional< MD5::MD5ResultgetMD5AsBytes (const DIFile *File) const
 If the File has an MD5 checksum, return it as an MD5Result allocated in the MCContext. More...
 
- Public Member Functions inherited from llvm::DebugHandlerBase
void endInstruction () override
 Process end of an instruction. More...
 
void beginFunction (const MachineFunction *MF) override
 Gather pre-function debug information. More...
 
void endFunction (const MachineFunction *MF) override
 Gather post-function debug information. More...
 
void beginBasicBlock (const MachineBasicBlock &MBB) override
 Process beginning of a basic block during basic block sections. More...
 
void endBasicBlock (const MachineBasicBlock &MBB) override
 Process end of a basic block during basic block sections. More...
 
MCSymbolgetLabelBeforeInsn (const MachineInstr *MI)
 Return Label preceding the instruction. More...
 
MCSymbolgetLabelAfterInsn (const MachineInstr *MI)
 Return Label immediately following the instruction. More...
 
const InstructionOrderinggetInstOrdering () const
 
- Public Member Functions inherited from llvm::AsmPrinterHandler
virtual ~AsmPrinterHandler ()
 Pin vtable to this file. More...
 
virtual void markFunctionEnd ()
 
virtual void beginFragment (const MachineBasicBlock *MBB, ExceptionSymbolProvider ESP)
 
virtual void endFragment ()
 
virtual void beginFunclet (const MachineBasicBlock &MBB, MCSymbol *Sym=nullptr)
 Emit target-specific EH funclet machinery. More...
 
virtual void endFunclet ()
 

Static Public Member Functions

static uint64_t makeTypeSignature (StringRef Identifier)
 Perform an MD5 checksum of Identifier and return the lower 64 bits. More...
 
static void emitDebugLocValue (const AsmPrinter &AP, const DIBasicType *BT, const DbgValueLoc &Value, DwarfExpression &DwarfExpr)
 
- Static Public Member Functions inherited from llvm::DebugHandlerBase
static uint64_t getBaseTypeSize (const DIType *Ty)
 If this type is derived from a base type then return base type size. More...
 
static bool isUnsignedDIType (const DIType *Ty)
 Return true if type encoding is unsigned. More...
 

Protected Member Functions

void beginFunctionImpl (const MachineFunction *MF) override
 Gather pre-function debug information. More...
 
void endFunctionImpl (const MachineFunction *MF) override
 Gather and emit post-function debug information. More...
 
unsigned getDwarfCompileUnitIDForLineTable (const DwarfCompileUnit &CU)
 Get Dwarf compile unit ID for line table. More...
 
void skippedNonDebugFunction () override
 
- Protected Member Functions inherited from llvm::DebugHandlerBase
 DebugHandlerBase (AsmPrinter *A)
 
void identifyScopeMarkers ()
 Indentify instructions that are marking the beginning of or ending of a scope. More...
 
void requestLabelBeforeInsn (const MachineInstr *MI)
 Ensure that a label will be emitted before MI. More...
 
void requestLabelAfterInsn (const MachineInstr *MI)
 Ensure that a label will be emitted after MI. More...
 

Additional Inherited Members

- Protected Attributes inherited from llvm::DebugHandlerBase
AsmPrinterAsm
 Target of debug info emission. More...
 
MachineModuleInfoMMI
 Collected machine module information. More...
 
DebugLoc PrevInstLoc
 Previous instruction's location information. More...
 
MCSymbolPrevLabel = nullptr
 
const MachineBasicBlockPrevInstBB = nullptr
 
DebugLoc PrologEndLoc
 This location indicates end of function prologue and beginning of function body. More...
 
const MachineInstrCurMI = nullptr
 If nonnull, stores the current machine instruction we're processing. More...
 
LexicalScopes LScopes
 
DbgValueHistoryMap DbgValues
 History of DBG_VALUE and clobber instructions for each user variable. More...
 
DbgLabelInstrMap DbgLabels
 Mapping of inlined labels and DBG_LABEL machine instruction. More...
 
DenseMap< const MachineInstr *, MCSymbol * > LabelsBeforeInsn
 Maps instruction with label emitted before instruction. More...
 
DenseMap< const MachineInstr *, MCSymbol * > LabelsAfterInsn
 Maps instruction with label emitted after instruction. More...
 

Detailed Description

Collects and handles dwarf debug information.

Definition at line 295 of file DwarfDebug.h.

Member Enumeration Documentation

◆ MinimizeAddrInV5

Enumerator
Default 
Disabled 
Ranges 
Expressions 
Form 

Definition at line 382 of file DwarfDebug.h.

Constructor & Destructor Documentation

◆ DwarfDebug()

DwarfDebug::DwarfDebug ( AsmPrinter A)

◆ ~DwarfDebug()

DwarfDebug::~DwarfDebug ( )
overridedefault

Member Function Documentation

◆ addAccelName()

void DwarfDebug::addAccelName ( const DICompileUnit CU,
StringRef  Name,
const DIE Die 
)

◆ addAccelNamespace()

void DwarfDebug::addAccelNamespace ( const DICompileUnit CU,
StringRef  Name,
const DIE Die 
)

Definition at line 3493 of file DwarfDebug.cpp.

Referenced by llvm::DwarfUnit::getOrCreateNameSpace().

◆ addAccelObjC()

void DwarfDebug::addAccelObjC ( const DICompileUnit CU,
StringRef  Name,
const DIE Die 
)

Definition at line 3486 of file DwarfDebug.cpp.

References llvm::Apple, and getAccelTableKind().

Referenced by addSubprogramNames().

◆ addAccelType()

void DwarfDebug::addAccelType ( const DICompileUnit CU,
StringRef  Name,
const DIE Die,
char  Flags 
)

Definition at line 3498 of file DwarfDebug.cpp.

◆ addArangeLabel()

void llvm::DwarfDebug::addArangeLabel ( SymbolCU  SCU)
inline

◆ addDwarfTypeUnitType()

void DwarfDebug::addDwarfTypeUnitType ( DwarfCompileUnit CU,
StringRef  Identifier,
DIE Die,
const DICompositeType CTy 
)

◆ addStringTypeLoc()

void llvm::DwarfDebug::addStringTypeLoc ( const DIStringType ST,
unsigned  Loc 
)
inline

Definition at line 828 of file DwarfDebug.h.

References assert(), and llvm::ARM_MB::ST.

◆ addSubprogramNames()

void DwarfDebug::addSubprogramNames ( const DICompileUnit CU,
const DISubprogram SP,
DIE Die 
)

◆ alwaysUseRanges()

bool llvm::DwarfDebug::alwaysUseRanges ( ) const
inline

Returns whether range encodings should be used for single entry range lists.

Definition at line 711 of file DwarfDebug.h.

References Ranges.

Referenced by llvm::DwarfCompileUnit::attachRangesOrLowHighPC().

◆ beginFunctionImpl()

void DwarfDebug::beginFunctionImpl ( const MachineFunction MF)
overrideprotectedvirtual

◆ beginInstruction()

void DwarfDebug::beginInstruction ( const MachineInstr MI)
overridevirtual

◆ beginModule()

void DwarfDebug::beginModule ( Module M)
overridevirtual

◆ emitDebugEntryValues()

bool llvm::DwarfDebug::emitDebugEntryValues ( ) const
inline

Definition at line 761 of file DwarfDebug.h.

◆ emitDebugLocEntry()

void DwarfDebug::emitDebugLocEntry ( ByteStreamer Streamer,
const DebugLocStream::Entry Entry,
const DwarfCompileUnit CU 
)

Emit an entry for the debug loc section.

This can be used to handle an entry that's going to be emitted into the debug loc section.

Definition at line 2494 of file DwarfDebug.cpp.

◆ emitDebugLocEntryLocation()

void DwarfDebug::emitDebugLocEntryLocation ( const DebugLocStream::Entry Entry,
const DwarfCompileUnit CU 
)

Emit the location for a debug loc entry, including the size header.

Definition at line 2666 of file DwarfDebug.cpp.

◆ emitDebugLocValue()

void DwarfDebug::emitDebugLocValue ( const AsmPrinter AP,
const DIBasicType BT,
const DbgValueLoc Value,
DwarfExpression DwarfExpr 
)
static

◆ emitInitialLocDirective()

DebugLoc DwarfDebug::emitInitialLocDirective ( const MachineFunction MF,
unsigned  CUID 
)

◆ endFunctionImpl()

void DwarfDebug::endFunctionImpl ( const MachineFunction MF)
overrideprotectedvirtual

◆ endModule()

void DwarfDebug::endModule ( )
overridevirtual

◆ enterNonTypeUnitContext()

DwarfDebug::NonTypeUnitContext DwarfDebug::enterNonTypeUnitContext ( )

Definition at line 3445 of file DwarfDebug.cpp.

Referenced by llvm::DwarfUnit::createTypeDIE().

◆ generateTypeUnits()

bool llvm::DwarfDebug::generateTypeUnits ( ) const
inline

Returns whether to generate DWARF v4 type units.

Definition at line 736 of file DwarfDebug.h.

Referenced by llvm::DwarfUnit::createTypeDIE(), and llvm::DwarfUnit::isShareableAcrossCUs().

◆ getAccelTableKind()

AccelTableKind llvm::DwarfDebug::getAccelTableKind ( ) const
inline

Returns what kind (if any) of accelerator tables to emit.

Definition at line 741 of file DwarfDebug.h.

Referenced by addAccelObjC(), addSubprogramNames(), endModule(), and llvm::DwarfCompileUnit::hasDwarfPubSections().

◆ getAddressPool()

AddressPool& llvm::DwarfDebug::getAddressPool ( )
inline

◆ getCurrentFunction()

const MachineFunction* llvm::DwarfDebug::getCurrentFunction ( ) const
inline

Definition at line 812 of file DwarfDebug.h.

Referenced by llvm::DwarfCompileUnit::updateSubprogramScopeDIE().

◆ getDebugLocs()

const DebugLocStream& llvm::DwarfDebug::getDebugLocs ( ) const
inline

Returns the entries for the .debug_loc section.

Definition at line 785 of file DwarfDebug.h.

Referenced by emitLocList(), emitLoclistsTableHeader(), and llvm::DIELocList::emitValue().

◆ getDwarfCompileUnitIDForLineTable()

unsigned DwarfDebug::getDwarfCompileUnitIDForLineTable ( const DwarfCompileUnit CU)
protected

Get Dwarf compile unit ID for line table.

Definition at line 2159 of file DwarfDebug.cpp.

References llvm::DebugHandlerBase::Asm, and llvm::AsmPrinter::OutStreamer.

Referenced by beginFunctionImpl().

◆ getDwarfSectionOffsetForm()

dwarf::Form DwarfDebug::getDwarfSectionOffsetForm ( ) const

Returns a suitable DWARF form to represent a section offset, i.e.

  • DW_FORM_sec_offset for DWARF version >= 4;
  • DW_FORM_data8 for 64-bit DWARFv3;
  • DW_FORM_data4 for 32-bit DWARFv3 and DWARFv2.

Definition at line 3507 of file DwarfDebug.cpp.

References llvm::DebugHandlerBase::Asm, assert(), llvm::AsmPrinter::getDwarfVersion(), and llvm::AsmPrinter::isDwarf64().

Referenced by llvm::DwarfCompileUnit::addLocationList(), llvm::DwarfUnit::addSectionDelta(), llvm::DwarfUnit::addSectionLabel(), and llvm::DwarfUnit::addSectionOffset().

◆ getDwarfVersion()

uint16_t DwarfDebug::getDwarfVersion ( ) const

◆ getMD5AsBytes()

Optional< MD5::MD5Result > DwarfDebug::getMD5AsBytes ( const DIFile File) const

If the File has an MD5 checksum, return it as an MD5Result allocated in the MCContext.

Definition at line 3528 of file DwarfDebug.cpp.

References assert(), llvm::MD5::MD5Result::Bytes, copy, llvm::DIFile::CSK_MD5, File, getDwarfVersion(), and llvm::None.

Referenced by llvm::DwarfCompileUnit::getOrCreateSourceID().

◆ getPrevCU()

const DwarfCompileUnit* llvm::DwarfDebug::getPrevCU ( ) const
inline

Returns the previous CU that was being updated.

Definition at line 781 of file DwarfDebug.h.

Referenced by llvm::DwarfCompileUnit::addRange().

◆ getSectionLabel()

const MCSymbol * DwarfDebug::getSectionLabel ( const MCSection S)

◆ getStringTypeLoc()

unsigned llvm::DwarfDebug::getStringTypeLoc ( const DIStringType ST) const
inline

◆ insertSectionLabel()

void DwarfDebug::insertSectionLabel ( const MCSymbol S)

◆ isLexicalScopeDIENull()

bool DwarfDebug::isLexicalScopeDIENull ( LexicalScope Scope)

A helper function to check whether the DIE for a given Scope is going to be null.

Check whether we should create a DIE for the given Scope, return true if we don't create a DIE (the corresponding DIE is null).

Definition at line 537 of file DwarfDebug.cpp.

References llvm::DebugHandlerBase::getLabelAfterInsn().

Referenced by llvm::DwarfCompileUnit::constructLexicalScopeDIE(), and llvm::DwarfCompileUnit::constructScopeDIE().

◆ lookupCU() [1/2]

DwarfCompileUnit* llvm::DwarfDebug::lookupCU ( const DIE Die)
inline

◆ lookupCU() [2/2]

const DwarfCompileUnit* llvm::DwarfDebug::lookupCU ( const DIE Die) const
inline

◆ makeTypeSignature()

uint64_t DwarfDebug::makeTypeSignature ( StringRef  Identifier)
static

Perform an MD5 checksum of Identifier and return the lower 64 bits.

Definition at line 3336 of file DwarfDebug.cpp.

References llvm::MD5::final(), and llvm::MD5::update().

Referenced by addDwarfTypeUnitType().

◆ setPrevCU()

void llvm::DwarfDebug::setPrevCU ( const DwarfCompileUnit PrevCU)
inline

Definition at line 782 of file DwarfDebug.h.

Referenced by llvm::DwarfCompileUnit::addRange().

◆ setSymbolSize()

void llvm::DwarfDebug::setSymbolSize ( const MCSymbol Sym,
uint64_t  Size 
)
inlineoverridevirtual

For symbols that have a size designated (e.g.

common symbols), this tracks that size.

Implements llvm::AsmPrinterHandler.

Definition at line 687 of file DwarfDebug.h.

References llvm::Check::Size.

◆ shareAcrossDWOCUs()

bool DwarfDebug::shareAcrossDWOCUs ( ) const

Definition at line 561 of file DwarfDebug.cpp.

References SplitDwarfCrossCuReferences.

Referenced by llvm::DwarfUnit::isShareableAcrossCUs().

◆ skippedNonDebugFunction()

void DwarfDebug::skippedNonDebugFunction ( )
overrideprotectedvirtual

Reimplemented from llvm::DebugHandlerBase.

Definition at line 2170 of file DwarfDebug.cpp.

◆ useAddrOffsetExpressions()

bool llvm::DwarfDebug::useAddrOffsetExpressions ( ) const
inline

◆ useAddrOffsetForm()

bool llvm::DwarfDebug::useAddrOffsetForm ( ) const
inline

Definition at line 723 of file DwarfDebug.h.

References Form.

Referenced by llvm::DwarfCompileUnit::addLabelAddress(), and llvm::DwarfUnit::addPoolOpAddress().

◆ useAllLinkageNames()

bool llvm::DwarfDebug::useAllLinkageNames ( ) const
inline

Returns whether we should emit all DW_AT_[MIPS_]linkage_name.

If not, we still might emit certain cases.

Definition at line 693 of file DwarfDebug.h.

Referenced by llvm::DwarfCompileUnit::addLocationAttribute(), addSubprogramNames(), and llvm::DwarfUnit::applySubprogramDefinitionAttributes().

◆ useAppleExtensionAttributes()

bool llvm::DwarfDebug::useAppleExtensionAttributes ( ) const
inline

◆ useDWARF2Bitfields()

bool llvm::DwarfDebug::useDWARF2Bitfields ( ) const
inline

Returns whether to use the DWARF2 format for bitfields instyead of the DWARF4 format.

Definition at line 701 of file DwarfDebug.h.

◆ useGNUTLSOpcode()

bool llvm::DwarfDebug::useGNUTLSOpcode ( ) const
inline

Returns whether to use DW_OP_GNU_push_tls_address, instead of the standard DW_OP_form_tls_address opcode.

Definition at line 697 of file DwarfDebug.h.

Referenced by llvm::DwarfCompileUnit::addLocationAttribute().

◆ useInlineStrings()

bool llvm::DwarfDebug::useInlineStrings ( ) const
inline

Returns whether to use inline strings.

Definition at line 704 of file DwarfDebug.h.

Referenced by llvm::DwarfUnit::addString().

◆ useLocSection()

bool llvm::DwarfDebug::useLocSection ( ) const
inline

Returns whether .debug_loc section should be emitted.

Definition at line 733 of file DwarfDebug.h.

◆ useOpConvert()

bool llvm::DwarfDebug::useOpConvert ( ) const
inline

Definition at line 765 of file DwarfDebug.h.

◆ useRangesSection()

bool llvm::DwarfDebug::useRangesSection ( ) const
inline

Returns whether ranges section should be emitted.

Definition at line 707 of file DwarfDebug.h.

Referenced by llvm::DwarfCompileUnit::attachRangesOrLowHighPC().

◆ useSectionsAsReferences()

bool llvm::DwarfDebug::useSectionsAsReferences ( ) const
inline

Returns whether to use sections as labels rather than temp symbols.

Definition at line 728 of file DwarfDebug.h.

Referenced by llvm::DwarfUnit::emitCommonHeader(), llvm::DwarfCompileUnit::emitHeader(), and llvm::DwarfCompileUnit::initStmtList().

◆ useSegmentedStringOffsetsTable()

bool llvm::DwarfDebug::useSegmentedStringOffsetsTable ( ) const
inline

Returns whether to generate a string offsets table with (possibly shared) contributions from each CU and type unit.

This implies the use of DW_FORM_strx* indirect references with DWARF v5 and beyond. Note that DW_FORM_GNU_str_index is also an indirect reference, but it is used with a pre-DWARF v5 implementation of split DWARF sections, which uses a monolithic string offsets table.

Definition at line 757 of file DwarfDebug.h.

Referenced by addDwarfTypeUnitType(), beginModule(), and llvm::DwarfUnit::useSegmentedStringOffsetsTable().

◆ useSplitDwarf()

bool llvm::DwarfDebug::useSplitDwarf ( ) const
inline

The documentation for this class was generated from the following files: