13#ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFDEBUG_H
14#define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFDEBUG_H
51class DwarfCompileUnit;
75 DIE *TheDIE =
nullptr;
80 : Entity(
N), InlinedAt(IA), SubclassID(
ID) {}
94 switch (
N->getDbgEntityID()) {
132 std::unique_ptr<DbgValueLoc> ValueLoc;
144 unsigned DebugLocListIndex;
146 std::optional<uint8_t> DebugLocListTagOffset;
149 explicit Multi(
unsigned DebugLocListIndex,
150 std::optional<uint8_t> DebugLocListTagOffset)
151 : DebugLocListIndex(DebugLocListIndex),
152 DebugLocListTagOffset(DebugLocListTagOffset) {}
155 return DebugLocListTagOffset;
164 assert((!
E ||
E->isValid()) &&
"Expected valid expression");
165 assert(FI != std::numeric_limits<int>::max() &&
"Expected valid index");
181 std::optional<const DIExpression *> NonVariadicExpr =
183 assert(NonVariadicExpr && *NonVariadicExpr);
225 template <
typename T>
bool holds()
const {
226 return std::holds_alternative<T>(*
this);
229 template <
typename T>
auto &
get() noexcept {
231 return *std::get_if<T>(
this);
234 template <
typename T>
const auto &
get()
const noexcept {
236 return *std::get_if<T>(
this);
247 return cast<DILocalVariable>(
getEntity());
256 return dwarf::DW_TAG_formal_parameter;
258 return dwarf::DW_TAG_variable;
307 return dwarf::DW_TAG_label;
324 assert(
Reg &&
"Parameter register cannot be undef");
362 std::vector<SymbolCU> ArangeLabels;
409 TypeUnitsUnderConstruction;
414 unsigned NumTypeUnitsCreated = 0;
417 bool UseGNUTLSOpcode;
420 bool UseDWARF2Bitfields;
423 bool UseAllLinkageNames;
426 bool UseInlineStrings =
false;
429 bool UseRangesSection =
true;
433 bool UseSectionsAsReferences =
false;
436 bool UseLocSection =
true;
439 bool GenerateTypeUnits;
442 bool UseDebugMacroSection;
445 bool EnableOpConvert;
468 bool HasAppleExtensionAttributes;
475 bool UseSegmentedStringOffsetsTable;
480 bool EmitDebugEntryValues;
532 void ensureAbstractEntityIsCreatedIfScoped(DwarfCompileUnit &
CU,
534 const MDNode *Scope);
536 DbgEntity *createConcreteEntity(DwarfCompileUnit &TheCU,
539 const DILocation *Location,
540 const MCSymbol *
Sym =
nullptr);
543 void constructAbstractSubprogramScopeDIE(DwarfCompileUnit &SrcCU, LexicalScope *Scope);
546 void constructCallSiteEntryDIEs(
const DISubprogram &SP, DwarfCompileUnit &
CU,
547 DIE &ScopeDIE,
const MachineFunction &MF);
549 template <
typename DataT>
550 void addAccelNameImpl(
const DwarfUnit &Unit,
552 AccelTable<DataT> &AppleAccel, StringRef
Name,
555 void finishEntityDefinitions();
557 void finishSubprogramDefinitions();
561 void finalizeModuleInfo();
564 void emitDebugInfo();
567 void emitAbbreviations();
570 void emitStringOffsetsTableHeader();
573 template <
typename AccelTableT>
574 void emitAccel(AccelTableT &Accel, MCSection *Section, StringRef TableName);
577 void emitAccelDebugNames();
580 void emitAccelNames();
584 void emitAccelObjC();
587 void emitAccelNamespaces();
590 void emitAccelTypes();
593 void emitDebugPubSections();
595 void emitDebugPubSection(
bool GnuStyle, StringRef
Name,
596 DwarfCompileUnit *TheU,
597 const StringMap<const DIE *> &Globals);
606 void emitDebugLocDWO();
608 void emitDebugLocImpl(MCSection *Sec);
611 void emitDebugARanges();
614 void emitDebugRanges();
615 void emitDebugRangesDWO();
616 void emitDebugRangesImpl(
const DwarfFile &Holder, MCSection *Section);
619 void emitDebugMacinfo();
621 void emitDebugMacinfoDWO();
622 void emitDebugMacinfoImpl(MCSection *Section);
623 void emitMacro(DIMacro &M);
624 void emitMacroFile(DIMacroFile &
F, DwarfCompileUnit &U);
625 void emitMacroFileImpl(DIMacroFile &
F, DwarfCompileUnit &U,
626 unsigned StartFile,
unsigned EndFile,
627 StringRef (*MacroFormToString)(
unsigned Form));
628 void handleMacroNodes(DIMacroNodeArray Nodes, DwarfCompileUnit &U);
633 void initSkeletonUnit(
const DwarfUnit &U, DIE &Die,
634 std::unique_ptr<DwarfCompileUnit> NewU);
643 DwarfCompileUnit &constructSkeletonCU(
const DwarfCompileUnit &
CU);
646 void emitDebugInfoDWO();
649 void emitDebugAbbrevDWO();
652 void emitDebugLineDWO();
655 void emitStringOffsetsTableHeaderDWO();
658 void emitDebugStrDWO();
661 void emitDebugAddr();
665 void addGnuPubAttributes(DwarfCompileUnit &U, DIE &
D)
const;
669 DwarfCompileUnit &getOrCreateDwarfCompileUnit(
const DICompileUnit *DIUnit);
670 void finishUnitAttributes(
const DICompileUnit *DIUnit,
671 DwarfCompileUnit &NewCU);
676 void recordSourceLine(
unsigned Line,
unsigned Col,
const MDNode *Scope,
680 void collectEntityInfo(DwarfCompileUnit &TheCU,
const DISubprogram *SP,
681 DenseSet<InlinedEntity> &ProcessedVars);
687 bool buildLocationList(SmallVectorImpl<DebugLocEntry> &DebugLoc,
691 void collectVariableInfoFromMFTable(DwarfCompileUnit &TheCU,
692 DenseSet<InlinedEntity> &
P);
695 void emitSectionReference(
const DwarfCompileUnit &
CU);
713 DwarfDebug(AsmPrinter *
A);
783 return UseSectionsAsReferences;
801 return HasAppleExtensionAttributes;
815 return UseSegmentedStringOffsetsTable;
819 return EmitDebugEntryValues;
823 return EnableOpConvert;
888 return CUDieMap.
lookup(Die);
892 return StringTypeLocMap.
lookup(ST);
898 StringTypeLocMap[ST] = Loc;
923 return LocalDeclsPerLS[S];
930 CurrentDebugNames = &AccelDebugNames;
933 CurrentDebugNames = &AccelTypeUnitsDebugNames;
This file defines the StringMap class.
This file contains support for writing accelerator tables.
This file defines the BumpPtrAllocator interface.
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
This file defines the DenseMap class.
This file defines the DenseSet and SmallDenseSet classes.
This file contains constants used for implementing Dwarf debug support.
Machine Check Debug Module
This file implements a map that provides insertion order iteration.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file implements a set that has insertion order iteration characteristics.
This file defines the SmallPtrSet class.
This file defines the SmallVector class.
Class recording the (high level) value of a variable.
This class holds an abstract representation of an Accelerator Table, consisting of a sequence of buck...
This class is intended to be used as a driving class for all asm writers.
Allocate memory in an ever growing pool, as if by bump-pointer.
Basic type, like 'int' or 'float'.
A structured debug information entry.
static std::optional< const DIExpression * > convertToNonVariadicExpression(const DIExpression *Expr)
If Expr is a valid single-location expression, i.e.
StringRef getName() const
Tagged DWARF-like metadata node.
String type, Fortran CHARACTER(n)
StringRef getName() const
Used for tracking debug info about call site parameters.
unsigned getRegister() const
DbgCallSiteParam(unsigned Reg, DbgValueLoc Val)
DbgValueLoc getValue() const
This class is defined as the common parent of DbgVariable and DbgLabel such that it could levarage po...
virtual ~DbgEntity()=default
static bool classof(const DbgEntity *N)
const DINode * getEntity() const
Accessors.
DbgEntityKind getDbgEntityID() const
DbgEntity(const DINode *N, const DILocation *IA, DbgEntityKind ID)
const DILocation * getInlinedAt() const
This class is used to track label information.
dwarf::Tag getTag() const
Translate tag to proper Dwarf tag.
static bool classof(const DbgEntity *N)
DbgLabel(const DILabel *L, const DILocation *IA, const MCSymbol *Sym=nullptr)
Symbol before DBG_LABEL instruction.
StringRef getName() const
const MCSymbol * getSymbol() const
const DILabel * getLabel() const
Accessors.
SmallVector< Entry, 4 > Entries
std::pair< const DINode *, const DILocation * > InlinedEntity
The location of a single variable, composed of an expression and 0 or more DbgValueLocEntries.
This class is used to track local variable information.
const Loc::Variant & asVariant() const
bool isArtificial() const
Return true if DbgVariable is artificial.
dwarf::Tag getTag() const
bool isObjectPointer() const
const DILocalVariable * getVariable() const
DbgVariable(const DILocalVariable *V, const DILocation *IA)
Construct a DbgVariable.
auto & get() noexcept
Asserting, noexcept member alternative to std::get.
StringRef getName() const
const DIType * getType() const
const auto & get() const noexcept
Asserting, noexcept member alternative to std::get.
Loc::Variant & asVariant()
To workaround P2162R0 https://github.com/cplusplus/papers/issues/873 the base class subobject needs t...
static bool classof(const DbgEntity *N)
bool holds() const
Member shorthand for std::holds_alternative.
Base class for debug information backends.
Byte stream of .debug_loc entries.
ValueT lookup(const_arg_type_t< KeyT > Val) const
lookup - Return the entry for the specified key, or a default constructed value if no such entry exis...
Collects and handles dwarf debug information.
bool useSegmentedStringOffsetsTable() const
Returns whether to generate a string offsets table with (possibly shared) contributions from each CU ...
MDNodeSet & getLocalDeclsForScope(const DILocalScope *S)
std::optional< MD5::MD5Result > getMD5AsBytes(const DIFile *File) const
If the File has an MD5 checksum, return it as an MD5Result allocated in the MCContext.
bool useGNUTLSOpcode() const
Returns whether to use DW_OP_GNU_push_tls_address, instead of the standard DW_OP_form_tls_address opc...
bool useAddrOffsetForm() const
const DwarfCompileUnit * getPrevCU() const
Returns the previous CU that was being updated.
void setSymbolSize(const MCSymbol *Sym, uint64_t Size) override
For symbols that have a size designated (e.g.
bool emitDebugEntryValues() const
const DwarfCompileUnit * lookupCU(const DIE *Die) const
uint16_t getDwarfVersion() const
Returns the Dwarf Version.
void emitDebugLocEntry(ByteStreamer &Streamer, const DebugLocStream::Entry &Entry, const DwarfCompileUnit *CU)
Emit an entry for the debug loc section.
void addAccelNamespace(const DwarfUnit &Unit, const DICompileUnit::DebugNameTableKind NameTableKind, StringRef Name, const DIE &Die)
void setCurrentDWARF5AccelTable(const DWARF5AccelTableKind Kind)
Sets the current DWARF5AccelTable to use.
bool alwaysUseRanges(const DwarfCompileUnit &) const
Returns whether range encodings should be used for single entry range lists.
void beginModule(Module *M) override
Emit all Dwarf sections that should come prior to the content.
void addSubprogramNames(const DwarfUnit &Unit, const DICompileUnit::DebugNameTableKind NameTableKind, const DISubprogram *SP, DIE &Die)
bool useAllLinkageNames() const
Returns whether we should emit all DW_AT_[MIPS_]linkage_name.
void insertSectionLabel(const MCSymbol *S)
void addAccelObjC(const DwarfUnit &Unit, const DICompileUnit::DebugNameTableKind NameTableKind, StringRef Name, const DIE &Die)
dwarf::Form getDwarfSectionOffsetForm() const
Returns a suitable DWARF form to represent a section offset, i.e.
bool useAppleExtensionAttributes() const
void setPrevCU(const DwarfCompileUnit *PrevCU)
const MachineFunction * getCurrentFunction() const
void skippedNonDebugFunction() override
bool useInlineStrings() const
Returns whether to use inline strings.
void addArangeLabel(SymbolCU SCU)
Add a label so that arange data can be generated for it.
bool generateTypeUnits() const
Returns whether to generate DWARF v4 type units.
void beginInstruction(const MachineInstr *MI) override
Process beginning of an instruction.
AddressPool & getAddressPool()
DWARF5AccelTable & getCurrentDWARF5AccelTable()
Returns either CU or TU DWARF5AccelTable.
bool useSectionsAsReferences() const
Returns whether to use sections as labels rather than temp symbols.
const DebugLocStream & getDebugLocs() const
Returns the entries for the .debug_loc section.
bool shareAcrossDWOCUs() const
bool useOpConvert() const
void terminateLineTable(const DwarfCompileUnit *CU)
Terminate the line table by adding the last range label.
void endFunctionImpl(const MachineFunction *MF) override
Gather and emit post-function debug information.
void addStringTypeLoc(const DIStringType *ST, unsigned Loc)
void emitDebugLocEntryLocation(const DebugLocStream::Entry &Entry, const DwarfCompileUnit *CU)
Emit the location for a debug loc entry, including the size header.
DwarfCompileUnit * lookupCU(const DIE *Die)
Find the matching DwarfCompileUnit for the given CU DIE.
const MCSymbol * getSectionLabel(const MCSection *S)
static void emitDebugLocValue(const AsmPrinter &AP, const DIBasicType *BT, const DbgValueLoc &Value, DwarfExpression &DwarfExpr)
bool useSplitDwarf() const
Returns whether or not to change the current debug info for the split dwarf proposal support.
bool useLocSection() const
Returns whether .debug_loc section should be emitted.
unsigned getDwarfCompileUnitIDForLineTable(const DwarfCompileUnit &CU)
Get Dwarf compile unit ID for line table.
void setTheAccelTableKind(AccelTableKind K)
Seet TheAccelTableKind.
bool useDWARF2Bitfields() const
Returns whether to use the DWARF2 format for bitfields instyead of the DWARF4 format.
DebugLoc emitInitialLocDirective(const MachineFunction &MF, unsigned CUID)
Emits inital debug location directive.
bool useAddrOffsetExpressions() const
bool useRangesSection() const
Returns whether ranges section should be emitted.
void addAccelName(const DwarfUnit &Unit, const DICompileUnit::DebugNameTableKind NameTableKind, StringRef Name, const DIE &Die)
unsigned getStringTypeLoc(const DIStringType *ST) const
bool isLexicalScopeDIENull(LexicalScope *Scope)
A helper function to check whether the DIE for a given Scope is going to be null.
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.
void endModule() override
Emit all Dwarf sections that should come after the content.
void addAccelType(const DwarfUnit &Unit, const DICompileUnit::DebugNameTableKind NameTableKind, StringRef Name, const DIE &Die, char Flags)
void beginFunctionImpl(const MachineFunction *MF) override
Gather pre-function debug information.
AccelTableKind getAccelTableKind() const
Returns what kind (if any) of accelerator tables to emit.
static uint64_t makeTypeSignature(StringRef Identifier)
Perform an MD5 checksum of Identifier and return the lower 64 bits.
Base class containing the logic for constructing DWARF expressions independently of whether they are ...
const SmallVectorImpl< std::unique_ptr< DwarfCompileUnit > > & getUnits()
This dwarf writer support class manages information associated with a source file.
LexicalScope - This class is used to track scope information.
Multi-value location description.
Multi(unsigned DebugLocListIndex, std::optional< uint8_t > DebugLocListTagOffset)
unsigned getDebugLocListIndex() const
std::optional< uint8_t > getDebugLocListTagOffset() const
Single value location description.
const DbgValueLoc & getValueLoc() const
const DIExpression * getExpr() const
Wrapper class representing physical registers. Should be passed by value.
Instances of this class represent a uniqued identifier for a section in the current translation unit.
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Representation of each machine instruction.
This class implements a map that also provides access to all stored values in a deterministic order.
A Module instance is used to store all the information related to an LLVM module.
Wrapper class representing virtual and physical registers.
A vector that has set insertion semantics.
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
A SetVector that performs no allocations if smaller than a certain size.
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
LLVM Value Representation.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
std::variant< std::monostate, Loc::Single, Loc::Multi, Loc::MMI, Loc::EntryValue > Variant
Alias for the std::variant specialization base class of DbgVariable.
This is an optimization pass for GlobalISel generic memory operations.
bool operator<(int64_t V1, const APSInt &V2)
AccelTableKind
The kind of accelerator tables we should emit.
@ Apple
.apple_names, .apple_namespaces, .apple_types, .apple_objc.
@ Dwarf
DWARF v5 .debug_names.
DebuggerKind
Identify a debugger for "tuning" the debug info.
@ SCE
Tune debug info for SCE targets (e.g. PS4).
@ DBX
Tune debug info for dbx.
@ Default
No specific tuning requested.
@ GDB
Tune debug info for gdb.
@ LLDB
Tune debug info for lldb.
@ Default
The result values are uniform if and only if all operands are uniform.
Represents an entry-value location, or a fragment of one.
friend bool operator<(const EntryValueInfo &LHS, const EntryValueInfo &RHS)
Operator enabling sorting based on fragment offset.
const DIExpression & Expr
const DIExpression * Expr
friend bool operator<(const FrameIndexExpr &LHS, const FrameIndexExpr &RHS)
Operator enabling sorting based on fragment offset.
Single location defined by (potentially multiple) EntryValueInfo.
void addExpr(MCRegister Reg, const DIExpression &Expr)
std::set< EntryValueInfo > EntryValues
EntryValue(MCRegister Reg, const DIExpression &Expr)
Single location defined by (potentially multiple) MMI entries.
void addFrameIndexExpr(const DIExpression *Expr, int FI)
std::set< FrameIndexExpr > FrameIndexExprs
const std::set< FrameIndexExpr > & getFrameIndexExprs() const
Get the FI entries, sorted by fragment offset.
MMI(const DIExpression *E, int FI)
Helper used to pair up a symbol and its DWARF compile unit.
SymbolCU(DwarfCompileUnit *CU, const MCSymbol *Sym)