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"
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.
158 // AbsVar may be NULL.
159 DbgVariable(DIVariable V, DbgVariable *AV, DwarfDebug *DD)
160 : Var(V), TheDIE(0), DotDebugLocOffset(~0U), AbsVar(AV), MInsn(0),
161 FrameIndex(~0), DD(DD) {}
164 DIVariable getVariable() const { return Var; }
165 void setDIE(DIE *D) { TheDIE = D; }
166 DIE *getDIE() const { return TheDIE; }
167 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
168 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
169 StringRef getName() const { return Var.getName(); }
170 DbgVariable *getAbstractVariable() const { return AbsVar; }
171 const MachineInstr *getMInsn() const { return MInsn; }
172 void setMInsn(const MachineInstr *M) { MInsn = M; }
173 int getFrameIndex() const { return FrameIndex; }
174 void setFrameIndex(int FI) { FrameIndex = FI; }
175 // Translate tag to proper Dwarf tag.
176 uint16_t getTag() const {
177 if (Var.getTag() == dwarf::DW_TAG_arg_variable)
178 return dwarf::DW_TAG_formal_parameter;
180 return dwarf::DW_TAG_variable;
182 /// \brief Return true if DbgVariable is artificial.
183 bool isArtificial() const {
184 if (Var.isArtificial())
186 if (getType().isArtificial())
191 bool isObjectPointer() const {
192 if (Var.isObjectPointer())
194 if (getType().isObjectPointer())
199 bool variableHasComplexAddress() const {
200 assert(Var.isVariable() && "Invalid complex DbgVariable!");
201 return Var.hasComplexAddress();
203 bool isBlockByrefVariable() const {
204 assert(Var.isVariable() && "Invalid complex DbgVariable!");
205 return Var.isBlockByrefVariable();
207 unsigned getNumAddrElements() const {
208 assert(Var.isVariable() && "Invalid complex DbgVariable!");
209 return Var.getNumAddrElements();
211 uint64_t getAddrElement(unsigned i) const {
212 return Var.getAddrElement(i);
214 DIType getType() const;
217 /// resolve - Look in the DwarfDebug map for the MDNode that
218 /// corresponds to the reference.
219 template <typename T> T resolve(DIRef<T> Ref) const;
222 /// \brief Collects and handles information specific to a particular
223 /// collection of units.
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<Unit *, 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>,
241 BumpPtrAllocator&> StrPool;
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 DwarfUnits(AsmPrinter *AP, FoldingSet<DIEAbbrev> *AS,
255 std::vector<DIEAbbrev *> &A, const char *Pref,
256 BumpPtrAllocator &DA)
257 : Asm(AP), AbbreviationsSet(AS), Abbreviations(A), StringPool(DA),
258 NextStringPoolNumber(0), StringPref(Pref), AddressPool(),
259 NextAddrPoolNumber(0) {}
263 const SmallVectorImpl<Unit *> &getUnits() { return CUs; }
265 /// \brief Compute the size and offset of a DIE given an incoming Offset.
266 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
268 /// \brief Compute the size and offset of all the DIEs.
269 void computeSizeAndOffsets();
271 /// \brief Define a unique number for the abbreviation.
272 void assignAbbrevNumber(DIEAbbrev &Abbrev);
274 /// \brief Add a unit to the list of CUs.
275 void addUnit(Unit *CU) { CUs.push_back(CU); }
277 /// \brief Emit all of the units to the section listed with the given
278 /// abbreviation section.
279 void emitUnits(DwarfDebug *DD, const MCSection *USection,
280 const MCSection *ASection, const MCSymbol *ASectionSym);
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(CompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(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 a compile unit used for the inline extension handling.
331 CompileUnit *FirstCU;
333 // Maps MDNode with its corresponding CompileUnit.
334 DenseMap <const MDNode *, CompileUnit *> CUMap;
336 // Maps subprogram MDNode with its corresponding CompileUnit.
337 DenseMap <const MDNode *, CompileUnit *> SPMap;
339 // Maps a CU DIE with its corresponding CompileUnit.
340 DenseMap <const DIE *, CompileUnit *> CUDieMap;
342 /// Maps MDNodes for type sysstem with the corresponding DIEs. These DIEs can
343 /// be shared across CUs, that is why we keep the map here instead
344 /// of in CompileUnit.
345 DenseMap<const MDNode *, DIE *> MDTypeNodeToDieMap;
347 // Used to uniquely define abbreviations.
348 FoldingSet<DIEAbbrev> AbbreviationsSet;
350 // A list of all the unique abbreviations in use.
351 std::vector<DIEAbbrev *> Abbreviations;
353 // Stores the current file ID for a given compile unit.
354 DenseMap <unsigned, unsigned> FileIDCUMap;
355 // Source id map, i.e. CUID, source filename and directory,
356 // separated by a zero byte, mapped to a unique id.
357 StringMap<unsigned, BumpPtrAllocator&> SourceIdMap;
359 // List of all labels used in aranges generation.
360 std::vector<SymbolCU> ArangeLabels;
362 // Size of each symbol emitted (for those symbols that have a specific size).
363 DenseMap <const MCSymbol *, uint64_t> SymSize;
365 // Provides a unique id per text section.
366 typedef DenseMap<const MCSection *, SmallVector<SymbolCU, 8> > SectionMapType;
367 SectionMapType SectionMap;
369 // List of arguments for current function.
370 SmallVector<DbgVariable *, 8> CurrentFnArguments;
372 LexicalScopes LScopes;
374 // Collection of abstract subprogram DIEs.
375 DenseMap<const MDNode *, DIE *> AbstractSPDies;
377 // Collection of dbg variables of a scope.
378 typedef DenseMap<LexicalScope *,
379 SmallVector<DbgVariable *, 8> > ScopeVariablesMap;
380 ScopeVariablesMap ScopeVariables;
382 // Collection of abstract variables.
383 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
385 // Collection of DotDebugLocEntry.
386 SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
388 // Collection of subprogram DIEs that are marked (at the end of the module)
390 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
392 // This is a collection of subprogram MDNodes that are processed to
394 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
396 // Maps instruction with label emitted before instruction.
397 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
399 // Maps instruction with label emitted after instruction.
400 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
402 // Every user variable mentioned by a DBG_VALUE instruction in order of
404 SmallVector<const MDNode*, 8> UserVariables;
406 // For each user variable, keep a list of DBG_VALUE instructions in order.
407 // The list can also contain normal instructions that clobber the previous
409 typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
411 DbgValueHistoryMap DbgValues;
413 // Previous instruction's location information. This is used to determine
414 // label location to indicate scope boundries in dwarf debug info.
415 DebugLoc PrevInstLoc;
418 // This location indicates end of function prologue and beginning of function
420 DebugLoc PrologEndLoc;
422 // If nonnull, stores the current machine function we're processing.
423 const MachineFunction *CurFn;
425 // If nonnull, stores the current machine instruction we're processing.
426 const MachineInstr *CurMI;
428 // Section Symbols: these are assembler temporary labels that are emitted at
429 // the beginning of each supported dwarf section. These are used to form
430 // section offsets and are created by EmitSectionLabels.
431 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
432 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
433 MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
434 MCSymbol *FunctionBeginSym, *FunctionEndSym;
435 MCSymbol *DwarfAbbrevDWOSectionSym, *DwarfStrDWOSectionSym;
436 MCSymbol *DwarfGnuPubNamesSectionSym, *DwarfGnuPubTypesSectionSym;
438 // As an optimization, there is no need to emit an entry in the directory
439 // table for the same directory as DW_AT_comp_dir.
440 StringRef CompilationDir;
442 // Counter for assigning globally unique IDs for CUs.
443 unsigned GlobalCUIndexCount;
445 // Counter for assigning globally unique IDs for ranges.
446 unsigned GlobalRangeCount;
448 // Holder for the file specific debug information.
449 DwarfUnits InfoHolder;
451 // Holders for the various debug information flags that we might need to
452 // have exposed. See accessor functions below for description.
454 // Holder for imported entities.
455 typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
457 ImportedEntityMap ScopesWithImportedEntities;
459 // Map from type MDNodes to a pair used as a union. If the pointer is
460 // non-null, proxy DIEs in CUs meant to reference this type should be stored
461 // in the vector. The hash will be added to these DIEs once it is computed. If
462 // the pointer is null, the hash is immediately available in the uint64_t and
463 // should be directly used for proxy DIEs.
464 DenseMap<const MDNode *, std::pair<uint64_t, SmallVectorImpl<DIE *> *> >
467 // Whether to emit the pubnames/pubtypes sections.
468 bool HasDwarfPubSections;
470 // Version of dwarf we're emitting.
471 unsigned DwarfVersion;
473 // Maps from a type identifier to the actual MDNode.
474 DITypeIdentifierMap TypeIdentifierMap;
476 // DWARF5 Experimental Options
477 bool HasDwarfAccelTables;
480 // Separated Dwarf Variables
481 // In general these will all be for bits that are left in the
482 // original object file, rather than things that are meant
483 // to be in the .dwo sections.
485 // Used to uniquely define abbreviations for the skeleton emission.
486 FoldingSet<DIEAbbrev> SkeletonAbbrevSet;
488 // A list of all the unique abbreviations in use.
489 std::vector<DIEAbbrev *> SkeletonAbbrevs;
491 // Holder for the skeleton information.
492 DwarfUnits SkeletonHolder;
494 void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
496 const SmallVectorImpl<Unit *> &getUnits() { return InfoHolder.getUnits(); }
498 /// \brief Find abstract variable associated with Var.
499 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
501 /// \brief Find DIE for the given subprogram and attach appropriate
502 /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
503 /// variables in this scope then create and insert DIEs for these
505 DIE *updateSubprogramScopeDIE(CompileUnit *SPCU, DISubprogram SP);
507 /// \brief A helper function to check whether the DIE for a given Scope is
508 /// going to be null.
509 bool isLexicalScopeDIENull(LexicalScope *Scope);
511 /// \brief A helper function to construct a RangeSpanList for a given
513 void addScopeRangeList(CompileUnit *TheCU, DIE *ScopeDIE,
514 const SmallVectorImpl<InsnRange> &Range);
516 /// \brief Construct new DW_TAG_lexical_block for this scope and
517 /// attach DW_AT_low_pc/DW_AT_high_pc labels.
518 DIE *constructLexicalScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
520 /// \brief This scope represents inlined body of a function. Construct
521 /// DIE to represent this concrete inlined copy of the function.
522 DIE *constructInlinedScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
524 /// \brief Construct a DIE for this scope.
525 DIE *constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
526 /// A helper function to create children of a Scope DIE.
527 DIE *createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
528 SmallVectorImpl<DIE*> &Children);
530 /// \brief Emit initial Dwarf sections with a label at the start of each one.
531 void emitSectionLabels();
533 /// \brief Compute the size and offset of a DIE given an incoming Offset.
534 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
536 /// \brief Compute the size and offset of all the DIEs.
537 void computeSizeAndOffsets();
539 /// \brief Attach DW_AT_inline attribute with inlined subprogram DIEs.
540 void computeInlinedDIEs();
542 /// \brief Collect info for variables that were optimized out.
543 void collectDeadVariables();
545 /// \brief Finish off debug information after all functions have been
547 void finalizeModuleInfo();
549 /// \brief Emit labels to close any remaining sections that have been left
553 /// \brief Emit a set of abbreviations to the specific section.
554 void emitAbbrevs(const MCSection *, std::vector<DIEAbbrev*> *);
556 /// \brief Emit the debug info section.
557 void emitDebugInfo();
559 /// \brief Emit the abbreviation section.
560 void emitAbbreviations();
562 /// \brief Emit the last address of the section and the end of
564 void emitEndOfLineMatrix(unsigned SectionEnd);
566 /// \brief Emit visible names into a hashed accelerator table section.
567 void emitAccelNames();
569 /// \brief Emit objective C classes and categories into a hashed
570 /// accelerator table section.
571 void emitAccelObjC();
573 /// \brief Emit namespace dies into a hashed accelerator table.
574 void emitAccelNamespaces();
576 /// \brief Emit type dies into a hashed accelerator table.
577 void emitAccelTypes();
579 /// \brief Emit visible names into a debug pubnames section.
580 /// \param GnuStyle determines whether or not we want to emit
581 /// additional information into the table ala newer gcc for gdb
583 void emitDebugPubNames(bool GnuStyle = false);
585 /// \brief Emit visible types into a debug pubtypes section.
586 /// \param GnuStyle determines whether or not we want to emit
587 /// additional information into the table ala newer gcc for gdb
589 void emitDebugPubTypes(bool GnuStyle = false);
591 /// \brief Emit visible names into a debug str section.
594 /// \brief Emit visible names into a debug loc section.
597 /// \brief Emit visible names into a debug aranges section.
598 void emitDebugARanges();
600 /// \brief Emit visible names into a debug ranges section.
601 void emitDebugRanges();
603 /// \brief Emit visible names into a debug macinfo section.
604 void emitDebugMacInfo();
606 /// \brief Emit inline info using custom format.
607 void emitDebugInlineInfo();
609 /// DWARF 5 Experimental Split Dwarf Emitters
611 /// \brief Construct the split debug info compile unit for the debug info
613 CompileUnit *constructSkeletonCU(const CompileUnit *CU);
615 /// \brief Emit the local split abbreviations.
616 void emitSkeletonAbbrevs(const MCSection *);
618 /// \brief Emit the debug info dwo section.
619 void emitDebugInfoDWO();
621 /// \brief Emit the debug abbrev dwo section.
622 void emitDebugAbbrevDWO();
624 /// \brief Emit the debug str dwo section.
625 void emitDebugStrDWO();
627 /// \brief Create new CompileUnit for the given metadata node with tag
628 /// DW_TAG_compile_unit.
629 CompileUnit *constructCompileUnit(DICompileUnit DIUnit);
631 /// \brief Construct subprogram DIE.
632 void constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N);
634 /// \brief Construct imported_module or imported_declaration DIE.
635 void constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N);
637 /// \brief Construct import_module DIE.
638 void constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
641 /// \brief Construct import_module DIE.
642 void constructImportedEntityDIE(CompileUnit *TheCU,
643 const DIImportedEntity &Module,
646 /// \brief Register a source line with debug info. Returns the unique
647 /// label that was emitted and which provides correspondence to the
648 /// source line list.
649 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
652 /// \brief Indentify instructions that are marking the beginning of or
653 /// ending of a scope.
654 void identifyScopeMarkers();
656 /// \brief If Var is an current function argument that add it in
657 /// CurrentFnArguments list.
658 bool addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope);
660 /// \brief Populate LexicalScope entries with variables' info.
661 void collectVariableInfo(SmallPtrSet<const MDNode *, 16> &ProcessedVars);
663 /// \brief Collect variable information from the side table maintained
665 void collectVariableInfoFromMMITable(SmallPtrSet<const MDNode *, 16> &P);
667 /// \brief Ensure that a label will be emitted before MI.
668 void requestLabelBeforeInsn(const MachineInstr *MI) {
669 LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
672 /// \brief Return Label preceding the instruction.
673 MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
675 /// \brief Ensure that a label will be emitted after MI.
676 void requestLabelAfterInsn(const MachineInstr *MI) {
677 LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
680 /// \brief Return Label immediately following the instruction.
681 MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
684 //===--------------------------------------------------------------------===//
685 // Main entry points.
687 DwarfDebug(AsmPrinter *A, Module *M);
689 void insertDIE(const MDNode *TypeMD, DIE *Die) {
690 MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
692 DIE *getDIE(const MDNode *TypeMD) {
693 return MDTypeNodeToDieMap.lookup(TypeMD);
696 /// \brief Emit all Dwarf sections that should come prior to the
700 /// \brief Emit all Dwarf sections that should come after the content.
703 /// \brief Gather pre-function debug information.
704 void beginFunction(const MachineFunction *MF);
706 /// \brief Gather and emit post-function debug information.
709 /// \brief Process beginning of an instruction.
710 void beginInstruction(const MachineInstr *MI);
712 /// \brief Process end of an instruction.
713 void endInstruction();
715 /// \brief Add a DIE to the set of types that we're going to pull into
717 void addTypeUnitType(uint16_t Language, DIE *Die, DICompositeType CTy);
719 /// \brief Add a label so that arange data can be generated for it.
720 void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
722 /// \brief For symbols that have a size designated (e.g. common symbols),
723 /// this tracks that size.
724 void setSymbolSize(const MCSymbol *Sym, uint64_t Size) { SymSize[Sym] = Size;}
726 /// \brief Look up the source id with the given directory and source file
727 /// names. If none currently exists, create a new id and insert it in the
729 unsigned getOrCreateSourceID(StringRef DirName, StringRef FullName,
732 /// \brief Recursively Emits a debug information entry.
733 void emitDIE(DIE *Die, ArrayRef<DIEAbbrev *> Abbrevs);
735 // Experimental DWARF5 features.
737 /// \brief Returns whether or not to emit tables that dwarf consumers can
738 /// use to accelerate lookup.
739 bool useDwarfAccelTables() { return HasDwarfAccelTables; }
741 /// \brief Returns whether or not to change the current debug info for the
742 /// split dwarf proposal support.
743 bool useSplitDwarf() { return HasSplitDwarf; }
745 /// Returns the Dwarf Version.
746 unsigned getDwarfVersion() const { return DwarfVersion; }
748 /// Find the MDNode for the given reference.
749 template <typename T> T resolve(DIRef<T> Ref) const {
750 return Ref.resolve(TypeIdentifierMap);
753 /// isSubprogramContext - Return true if Context is either a subprogram
754 /// or another context nested inside a subprogram.
755 bool isSubprogramContext(const MDNode *Context);
758 } // End of namespace llvm