1 //===-- llvm/CodeGen/DwarfDebug.h - Dwarf Debug Framework ------*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing dwarf debug info into asm files.
12 //===----------------------------------------------------------------------===//
14 #ifndef CODEGEN_ASMPRINTER_DWARFDEBUG_H__
15 #define CODEGEN_ASMPRINTER_DWARFDEBUG_H__
17 #include "AsmPrinterHandler.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/FoldingSet.h"
21 #include "llvm/ADT/SetVector.h"
22 #include "llvm/ADT/SmallPtrSet.h"
23 #include "llvm/ADT/StringMap.h"
24 #include "llvm/CodeGen/AsmPrinter.h"
25 #include "llvm/CodeGen/LexicalScopes.h"
26 #include "llvm/DebugInfo.h"
27 #include "llvm/MC/MachineLocation.h"
28 #include "llvm/Support/Allocator.h"
29 #include "llvm/Support/DebugLoc.h"
34 class DwarfCompileUnit;
38 class MachineFrameInfo;
39 class MachineModuleInfo;
42 class MCObjectFileInfo;
48 //===----------------------------------------------------------------------===//
49 /// \brief This class is used to record source line correspondence.
51 unsigned Line; // Source line number.
52 unsigned Column; // Source column.
53 unsigned SourceID; // Source ID number.
54 MCSymbol *Label; // Label in code ID number.
56 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
57 : Line(L), Column(C), SourceID(S), Label(label) {}
60 unsigned getLine() const { return Line; }
61 unsigned getColumn() const { return Column; }
62 unsigned getSourceID() const { return SourceID; }
63 MCSymbol *getLabel() const { return Label; }
66 /// \brief This struct describes location entries emitted in the .debug_loc
68 class DotDebugLocEntry {
69 // Begin and end symbols for the address range that this location is valid.
70 const MCSymbol *Begin;
73 // Type of entry that this represents.
80 enum EntryType EntryKind;
84 const ConstantFP *CFP;
85 const ConstantInt *CIP;
88 // The location in the machine frame.
91 // The variable to which this location entry corresponds.
92 const MDNode *Variable;
94 // Whether this location has been merged.
98 DotDebugLocEntry() : Begin(0), End(0), Variable(0), Merged(false) {
101 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, MachineLocation &L,
103 : Begin(B), End(E), Loc(L), Variable(V), Merged(false) {
105 EntryKind = E_Location;
107 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, int64_t i)
108 : Begin(B), End(E), Variable(0), Merged(false) {
110 EntryKind = E_Integer;
112 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, const ConstantFP *FPtr)
113 : Begin(B), End(E), Variable(0), Merged(false) {
114 Constants.CFP = FPtr;
115 EntryKind = E_ConstantFP;
117 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E,
118 const ConstantInt *IPtr)
119 : Begin(B), End(E), Variable(0), Merged(false) {
120 Constants.CIP = IPtr;
121 EntryKind = E_ConstantInt;
124 /// \brief Empty entries are also used as a trigger to emit temp label. Such
125 /// labels are referenced is used to find debug_loc offset for a given DIE.
126 bool isEmpty() { return Begin == 0 && End == 0; }
127 bool isMerged() { return Merged; }
128 void Merge(DotDebugLocEntry *Next) {
129 if (!(Begin && Loc == Next->Loc && End == Next->Begin))
134 bool isLocation() const { return EntryKind == E_Location; }
135 bool isInt() const { return EntryKind == E_Integer; }
136 bool isConstantFP() const { return EntryKind == E_ConstantFP; }
137 bool isConstantInt() const { return EntryKind == E_ConstantInt; }
138 int64_t getInt() const { return Constants.Int; }
139 const ConstantFP *getConstantFP() const { return Constants.CFP; }
140 const ConstantInt *getConstantInt() const { return Constants.CIP; }
141 const MDNode *getVariable() const { return Variable; }
142 const MCSymbol *getBeginSym() const { return Begin; }
143 const MCSymbol *getEndSym() const { return End; }
144 MachineLocation getLoc() const { return Loc; }
147 //===----------------------------------------------------------------------===//
148 /// \brief This class is used to track local variable information.
150 DIVariable Var; // Variable Descriptor.
151 DIE *TheDIE; // Variable DIE.
152 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
153 DbgVariable *AbsVar; // Corresponding Abstract variable, if any.
154 const MachineInstr *MInsn; // DBG_VALUE instruction of the variable.
159 // AbsVar may be NULL.
160 DbgVariable(DIVariable V, DbgVariable *AV, DwarfDebug *DD)
161 : Var(V), TheDIE(0), DotDebugLocOffset(~0U), AbsVar(AV), MInsn(0),
162 FrameIndex(~0), DD(DD) {}
165 DIVariable getVariable() const { return Var; }
166 void setDIE(DIE *D) { TheDIE = D; }
167 DIE *getDIE() const { return TheDIE; }
168 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
169 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
170 StringRef getName() const { return Var.getName(); }
171 DbgVariable *getAbstractVariable() const { return AbsVar; }
172 const MachineInstr *getMInsn() const { return MInsn; }
173 void setMInsn(const MachineInstr *M) { MInsn = M; }
174 int getFrameIndex() const { return FrameIndex; }
175 void setFrameIndex(int FI) { FrameIndex = FI; }
176 // Translate tag to proper Dwarf tag.
177 uint16_t getTag() const {
178 if (Var.getTag() == dwarf::DW_TAG_arg_variable)
179 return dwarf::DW_TAG_formal_parameter;
181 return dwarf::DW_TAG_variable;
183 /// \brief Return true if DbgVariable is artificial.
184 bool isArtificial() const {
185 if (Var.isArtificial())
187 if (getType().isArtificial())
192 bool isObjectPointer() const {
193 if (Var.isObjectPointer())
195 if (getType().isObjectPointer())
200 bool variableHasComplexAddress() const {
201 assert(Var.isVariable() && "Invalid complex DbgVariable!");
202 return Var.hasComplexAddress();
204 bool isBlockByrefVariable() const {
205 assert(Var.isVariable() && "Invalid complex DbgVariable!");
206 return Var.isBlockByrefVariable();
208 unsigned getNumAddrElements() const {
209 assert(Var.isVariable() && "Invalid complex DbgVariable!");
210 return Var.getNumAddrElements();
212 uint64_t getAddrElement(unsigned i) const { return Var.getAddrElement(i); }
213 DIType getType() const;
216 /// resolve - Look in the DwarfDebug map for the MDNode that
217 /// corresponds to the reference.
218 template <typename T> T resolve(DIRef<T> Ref) const;
221 /// \brief Collects and handles information specific to a particular
222 /// collection of units. This collection represents all of the units
223 /// that will be ultimately output into a single object file.
225 // Target of Dwarf emission, used for sizing of abbreviations.
228 // Used to uniquely define abbreviations.
229 FoldingSet<DIEAbbrev> AbbreviationsSet;
231 // A list of all the unique abbreviations in use.
232 std::vector<DIEAbbrev *> Abbreviations;
234 // A pointer to all units in the section.
235 SmallVector<DwarfUnit *, 1> CUs;
237 // Collection of strings for this unit and assorted symbols.
238 // A String->Symbol mapping of strings used by indirect
240 typedef StringMap<std::pair<MCSymbol *, unsigned>, BumpPtrAllocator &>
243 unsigned NextStringPoolNumber;
244 std::string StringPref;
246 // Collection of addresses for this unit and assorted labels.
247 // A Symbol->unsigned mapping of addresses used by indirect
249 typedef DenseMap<const MCExpr *, unsigned> AddrPool;
250 AddrPool AddressPool;
251 unsigned NextAddrPoolNumber;
254 DwarfFile(AsmPrinter *AP, const char *Pref, BumpPtrAllocator &DA)
255 : Asm(AP), StringPool(DA), NextStringPoolNumber(0), StringPref(Pref),
256 AddressPool(), NextAddrPoolNumber(0) {}
260 const SmallVectorImpl<DwarfUnit *> &getUnits() { return CUs; }
262 /// \brief Compute the size and offset of a DIE given an incoming Offset.
263 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
265 /// \brief Compute the size and offset of all the DIEs.
266 void computeSizeAndOffsets();
268 /// \brief Define a unique number for the abbreviation.
269 void assignAbbrevNumber(DIEAbbrev &Abbrev);
271 /// \brief Add a unit to the list of CUs.
272 void addUnit(DwarfUnit *CU) { CUs.push_back(CU); }
274 /// \brief Emit all of the units to the section listed with the given
275 /// abbreviation section.
276 void emitUnits(DwarfDebug *DD, const MCSection *ASection,
277 const MCSymbol *ASectionSym);
279 /// \brief Emit a set of abbreviations to the specific section.
280 void emitAbbrevs(const MCSection *);
282 /// \brief Emit all of the strings to the section given.
283 void emitStrings(const MCSection *StrSection, const MCSection *OffsetSection,
284 const MCSymbol *StrSecSym);
286 /// \brief Emit all of the addresses to the section given.
287 void emitAddresses(const MCSection *AddrSection);
289 /// \brief Returns the entry into the start of the pool.
290 MCSymbol *getStringPoolSym();
292 /// \brief Returns an entry into the string pool with the given
294 MCSymbol *getStringPoolEntry(StringRef Str);
296 /// \brief Returns the index into the string pool with the given
298 unsigned getStringPoolIndex(StringRef Str);
300 /// \brief Returns the string pool.
301 StrPool *getStringPool() { return &StringPool; }
303 /// \brief Returns the index into the address pool with the given
305 unsigned getAddrPoolIndex(const MCExpr *Sym);
306 unsigned getAddrPoolIndex(const MCSymbol *Sym);
308 /// \brief Returns the address pool.
309 AddrPool *getAddrPool() { return &AddressPool; }
312 /// \brief Helper used to pair up a symbol and its DWARF compile unit.
314 SymbolCU(DwarfCompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(CU) {}
316 DwarfCompileUnit *CU;
319 /// \brief Collects and handles dwarf debug information.
320 class DwarfDebug : public AsmPrinterHandler {
321 // Target of Dwarf emission.
324 // Collected machine module information.
325 MachineModuleInfo *MMI;
327 // All DIEValues are allocated through this allocator.
328 BumpPtrAllocator DIEValueAllocator;
330 // Handle to the compile unit used for the inline extension handling,
331 // this is just so that the DIEValue allocator has a place to store
332 // the particular elements.
333 // FIXME: Store these off of DwarfDebug instead?
334 DwarfCompileUnit *FirstCU;
336 // Maps MDNode with its corresponding DwarfCompileUnit.
337 DenseMap<const MDNode *, DwarfCompileUnit *> CUMap;
339 // Maps subprogram MDNode with its corresponding DwarfCompileUnit.
340 DenseMap<const MDNode *, DwarfCompileUnit *> SPMap;
342 // Maps a CU DIE with its corresponding DwarfCompileUnit.
343 DenseMap<const DIE *, DwarfCompileUnit *> CUDieMap;
345 /// Maps MDNodes for type sysstem with the corresponding DIEs. These DIEs can
346 /// be shared across CUs, that is why we keep the map here instead
347 /// of in DwarfCompileUnit.
348 DenseMap<const MDNode *, DIE *> MDTypeNodeToDieMap;
350 // Stores the current file ID for a given compile unit.
351 DenseMap<unsigned, unsigned> FileIDCUMap;
352 // Source id map, i.e. CUID, source filename and directory,
353 // separated by a zero byte, mapped to a unique id.
354 StringMap<unsigned, BumpPtrAllocator &> SourceIdMap;
356 // List of all labels used in aranges generation.
357 std::vector<SymbolCU> ArangeLabels;
359 // Size of each symbol emitted (for those symbols that have a specific size).
360 DenseMap<const MCSymbol *, uint64_t> SymSize;
362 // Provides a unique id per text section.
363 typedef DenseMap<const MCSection *, SmallVector<SymbolCU, 8> > SectionMapType;
364 SectionMapType SectionMap;
366 // List of arguments for current function.
367 SmallVector<DbgVariable *, 8> CurrentFnArguments;
369 LexicalScopes LScopes;
371 // Collection of abstract subprogram DIEs.
372 DenseMap<const MDNode *, DIE *> AbstractSPDies;
374 // Collection of dbg variables of a scope.
375 typedef DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >
377 ScopeVariablesMap ScopeVariables;
379 // Collection of abstract variables.
380 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
382 // Collection of DotDebugLocEntry.
383 SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
385 // Collection of subprogram DIEs that are marked (at the end of the module)
387 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
389 // This is a collection of subprogram MDNodes that are processed to
391 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
393 // Maps instruction with label emitted before instruction.
394 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
396 // Maps instruction with label emitted after instruction.
397 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
399 // Every user variable mentioned by a DBG_VALUE instruction in order of
401 SmallVector<const MDNode *, 8> UserVariables;
403 // For each user variable, keep a list of DBG_VALUE instructions in order.
404 // The list can also contain normal instructions that clobber the previous
406 typedef DenseMap<const MDNode *, SmallVector<const MachineInstr *, 4> >
408 DbgValueHistoryMap DbgValues;
410 // Previous instruction's location information. This is used to determine
411 // label location to indicate scope boundries in dwarf debug info.
412 DebugLoc PrevInstLoc;
415 // This location indicates end of function prologue and beginning of function
417 DebugLoc PrologEndLoc;
419 // If nonnull, stores the current machine function we're processing.
420 const MachineFunction *CurFn;
422 // If nonnull, stores the current machine instruction we're processing.
423 const MachineInstr *CurMI;
425 // Section Symbols: these are assembler temporary labels that are emitted at
426 // the beginning of each supported dwarf section. These are used to form
427 // section offsets and are created by EmitSectionLabels.
428 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
429 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
430 MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
431 MCSymbol *FunctionBeginSym, *FunctionEndSym;
432 MCSymbol *DwarfInfoDWOSectionSym, *DwarfAbbrevDWOSectionSym;
433 MCSymbol *DwarfStrDWOSectionSym;
434 MCSymbol *DwarfGnuPubNamesSectionSym, *DwarfGnuPubTypesSectionSym;
435 MCSymbol *TextSectionBeginSym, *TextSectionEndSym;
437 // As an optimization, there is no need to emit an entry in the directory
438 // table for the same directory as DW_AT_comp_dir.
439 StringRef CompilationDir;
441 // Counter for assigning globally unique IDs for ranges.
442 unsigned GlobalRangeCount;
444 // Holder for the file specific debug information.
445 DwarfFile InfoHolder;
447 // Holders for the various debug information flags that we might need to
448 // have exposed. See accessor functions below for description.
450 // Holder for imported entities.
451 typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
453 ImportedEntityMap ScopesWithImportedEntities;
455 // Map from MDNodes for user-defined types to the type units that describe
457 DenseMap<const MDNode *, const DwarfTypeUnit *> DwarfTypeUnits;
459 // Whether to emit the pubnames/pubtypes sections.
460 bool HasDwarfPubSections;
462 // Whether or not to use AT_ranges for compilation units.
465 // Version of dwarf we're emitting.
466 unsigned DwarfVersion;
468 // Maps from a type identifier to the actual MDNode.
469 DITypeIdentifierMap TypeIdentifierMap;
471 // DWARF5 Experimental Options
472 bool HasDwarfAccelTables;
475 // Separated Dwarf Variables
476 // In general these will all be for bits that are left in the
477 // original object file, rather than things that are meant
478 // to be in the .dwo sections.
480 // Holder for the skeleton information.
481 DwarfFile SkeletonHolder;
483 void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
485 const SmallVectorImpl<DwarfUnit *> &getUnits() {
486 return InfoHolder.getUnits();
489 /// \brief Find abstract variable associated with Var.
490 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
492 /// \brief Find DIE for the given subprogram and attach appropriate
493 /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
494 /// variables in this scope then create and insert DIEs for these
496 DIE *updateSubprogramScopeDIE(DwarfCompileUnit *SPCU, DISubprogram SP);
498 /// \brief A helper function to check whether the DIE for a given Scope is
499 /// going to be null.
500 bool isLexicalScopeDIENull(LexicalScope *Scope);
502 /// \brief A helper function to construct a RangeSpanList for a given
504 void addScopeRangeList(DwarfCompileUnit *TheCU, DIE *ScopeDIE,
505 const SmallVectorImpl<InsnRange> &Range);
507 /// \brief Construct new DW_TAG_lexical_block for this scope and
508 /// attach DW_AT_low_pc/DW_AT_high_pc labels.
509 DIE *constructLexicalScopeDIE(DwarfCompileUnit *TheCU, LexicalScope *Scope);
511 /// \brief This scope represents inlined body of a function. Construct
512 /// DIE to represent this concrete inlined copy of the function.
513 DIE *constructInlinedScopeDIE(DwarfCompileUnit *TheCU, LexicalScope *Scope);
515 /// \brief Construct a DIE for this scope.
516 DIE *constructScopeDIE(DwarfCompileUnit *TheCU, LexicalScope *Scope);
517 /// A helper function to create children of a Scope DIE.
518 DIE *createScopeChildrenDIE(DwarfCompileUnit *TheCU, LexicalScope *Scope,
519 SmallVectorImpl<DIE *> &Children);
521 /// \brief Emit initial Dwarf sections with a label at the start of each one.
522 void emitSectionLabels();
524 /// \brief Compute the size and offset of a DIE given an incoming Offset.
525 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
527 /// \brief Compute the size and offset of all the DIEs.
528 void computeSizeAndOffsets();
530 /// \brief Attach DW_AT_inline attribute with inlined subprogram DIEs.
531 void computeInlinedDIEs();
533 /// \brief Collect info for variables that were optimized out.
534 void collectDeadVariables();
536 /// \brief Finish off debug information after all functions have been
538 void finalizeModuleInfo();
540 /// \brief Emit labels to close any remaining sections that have been left
544 /// \brief Emit the debug info section.
545 void emitDebugInfo();
547 /// \brief Emit the abbreviation section.
548 void emitAbbreviations();
550 /// \brief Emit the last address of the section and the end of
552 void emitEndOfLineMatrix(unsigned SectionEnd);
554 /// \brief Emit visible names into a hashed accelerator table section.
555 void emitAccelNames();
557 /// \brief Emit objective C classes and categories into a hashed
558 /// accelerator table section.
559 void emitAccelObjC();
561 /// \brief Emit namespace dies into a hashed accelerator table.
562 void emitAccelNamespaces();
564 /// \brief Emit type dies into a hashed accelerator table.
565 void emitAccelTypes();
567 /// \brief Emit visible names into a debug pubnames section.
568 /// \param GnuStyle determines whether or not we want to emit
569 /// additional information into the table ala newer gcc for gdb
571 void emitDebugPubNames(bool GnuStyle = false);
573 /// \brief Emit visible types into a debug pubtypes section.
574 /// \param GnuStyle determines whether or not we want to emit
575 /// additional information into the table ala newer gcc for gdb
577 void emitDebugPubTypes(bool GnuStyle = false);
579 /// \brief Emit visible names into a debug str section.
582 /// \brief Emit visible names into a debug loc section.
585 /// \brief Emit visible names into a debug aranges section.
586 void emitDebugARanges();
588 /// \brief Emit visible names into a debug ranges section.
589 void emitDebugRanges();
591 /// \brief Emit inline info using custom format.
592 void emitDebugInlineInfo();
594 /// DWARF 5 Experimental Split Dwarf Emitters
596 /// \brief Initialize common features of skeleton units.
597 void initSkeletonUnit(const DwarfUnit *U, DIE *Die, DwarfUnit *NewU);
599 /// \brief Construct the split debug info compile unit for the debug info
601 DwarfCompileUnit *constructSkeletonCU(const DwarfCompileUnit *CU);
603 /// \brief Construct the split debug info compile unit for the debug info
605 DwarfTypeUnit *constructSkeletonTU(const DwarfTypeUnit *TU);
607 /// \brief Emit the debug info dwo section.
608 void emitDebugInfoDWO();
610 /// \brief Emit the debug abbrev dwo section.
611 void emitDebugAbbrevDWO();
613 /// \brief Emit the debug str dwo section.
614 void emitDebugStrDWO();
616 /// Flags to let the linker know we have emitted new style pubnames. Only
617 /// emit it here if we don't have a skeleton CU for split dwarf.
618 void addGnuPubAttributes(DwarfUnit *U, DIE *D) const;
620 /// \brief Create new DwarfCompileUnit for the given metadata node with tag
621 /// DW_TAG_compile_unit.
622 DwarfCompileUnit *constructDwarfCompileUnit(DICompileUnit DIUnit);
624 /// \brief Construct subprogram DIE.
625 void constructSubprogramDIE(DwarfCompileUnit *TheCU, const MDNode *N);
627 /// \brief Construct imported_module or imported_declaration DIE.
628 void constructImportedEntityDIE(DwarfCompileUnit *TheCU, const MDNode *N);
630 /// \brief Construct import_module DIE.
631 void constructImportedEntityDIE(DwarfCompileUnit *TheCU, const MDNode *N,
634 /// \brief Construct import_module DIE.
635 void constructImportedEntityDIE(DwarfCompileUnit *TheCU,
636 const DIImportedEntity &Module, DIE *Context);
638 /// \brief Register a source line with debug info. Returns the unique
639 /// label that was emitted and which provides correspondence to the
640 /// source line list.
641 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
644 /// \brief Indentify instructions that are marking the beginning of or
645 /// ending of a scope.
646 void identifyScopeMarkers();
648 /// \brief If Var is an current function argument that add it in
649 /// CurrentFnArguments list.
650 bool addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope);
652 /// \brief Populate LexicalScope entries with variables' info.
653 void collectVariableInfo(SmallPtrSet<const MDNode *, 16> &ProcessedVars);
655 /// \brief Collect variable information from the side table maintained
657 void collectVariableInfoFromMMITable(SmallPtrSet<const MDNode *, 16> &P);
659 /// \brief Ensure that a label will be emitted before MI.
660 void requestLabelBeforeInsn(const MachineInstr *MI) {
661 LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol *)0));
664 /// \brief Return Label preceding the instruction.
665 MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
667 /// \brief Ensure that a label will be emitted after MI.
668 void requestLabelAfterInsn(const MachineInstr *MI) {
669 LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol *)0));
672 /// \brief Return Label immediately following the instruction.
673 MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
676 //===--------------------------------------------------------------------===//
677 // Main entry points.
679 DwarfDebug(AsmPrinter *A, Module *M);
681 void insertDIE(const MDNode *TypeMD, DIE *Die) {
682 MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
684 DIE *getDIE(const MDNode *TypeMD) {
685 return MDTypeNodeToDieMap.lookup(TypeMD);
688 /// \brief Emit all Dwarf sections that should come prior to the
692 /// \brief Emit all Dwarf sections that should come after the content.
695 /// \brief Gather pre-function debug information.
696 void beginFunction(const MachineFunction *MF);
698 /// \brief Gather and emit post-function debug information.
699 void endFunction(const MachineFunction *MF);
701 /// \brief Process beginning of an instruction.
702 void beginInstruction(const MachineInstr *MI);
704 /// \brief Process end of an instruction.
705 void endInstruction();
707 /// \brief Add a DIE to the set of types that we're going to pull into
709 void addDwarfTypeUnitType(DICompileUnit CUNode, StringRef Identifier,
710 DIE *Die, DICompositeType CTy);
712 /// \brief Add a label so that arange data can be generated for it.
713 void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
715 /// \brief For symbols that have a size designated (e.g. common symbols),
716 /// this tracks that size.
717 void setSymbolSize(const MCSymbol *Sym, uint64_t Size) {
721 /// \brief Look up the source id with the given directory and source file
722 /// names. If none currently exists, create a new id and insert it in the
724 unsigned getOrCreateSourceID(StringRef DirName, StringRef FullName,
727 /// \brief Recursively Emits a debug information entry.
728 void emitDIE(DIE *Die);
730 // Experimental DWARF5 features.
732 /// \brief Returns whether or not to emit tables that dwarf consumers can
733 /// use to accelerate lookup.
734 bool useDwarfAccelTables() { return HasDwarfAccelTables; }
736 /// \brief Returns whether or not to change the current debug info for the
737 /// split dwarf proposal support.
738 bool useSplitDwarf() { return HasSplitDwarf; }
740 /// \brief Returns whether or not to use AT_ranges for compilation units.
741 bool useCURanges() { return HasCURanges; }
743 /// Returns the Dwarf Version.
744 unsigned getDwarfVersion() const { return DwarfVersion; }
746 /// Find the MDNode for the given reference.
747 template <typename T> T resolve(DIRef<T> Ref) const {
748 return Ref.resolve(TypeIdentifierMap);
751 /// isSubprogramContext - Return true if Context is either a subprogram
752 /// or another context nested inside a subprogram.
753 bool isSubprogramContext(const MDNode *Context);
755 } // End of namespace llvm