Debug info: Remove OdrMemberMap from DwarfDebug, it's not necessary.
[opencl/llvm.git] / lib / CodeGen / AsmPrinter / DwarfDebug.h
1 //===-- llvm/CodeGen/DwarfDebug.h - Dwarf Debug Framework ------*- C++ -*--===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains support for writing dwarf debug info into asm files.
11 //
12 //===----------------------------------------------------------------------===//
14 #ifndef CODEGEN_ASMPRINTER_DWARFDEBUG_H__
15 #define CODEGEN_ASMPRINTER_DWARFDEBUG_H__
17 #include "AsmPrinterHandler.h"
18 #include "DIE.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/FoldingSet.h"
21 #include "llvm/ADT/MapVector.h"
22 #include "llvm/ADT/SetVector.h"
23 #include "llvm/ADT/SmallPtrSet.h"
24 #include "llvm/ADT/StringMap.h"
25 #include "llvm/CodeGen/LexicalScopes.h"
26 #include "llvm/IR/DebugInfo.h"
27 #include "llvm/IR/DebugLoc.h"
28 #include "llvm/MC/MachineLocation.h"
29 #include "llvm/MC/MCDwarf.h"
30 #include "llvm/Support/Allocator.h"
32 namespace llvm {
34 class AsmPrinter;
35 class ByteStreamer;
36 class DwarfDebug;
37 class DwarfUnit;
38 class DwarfCompileUnit;
39 class ConstantInt;
40 class ConstantFP;
41 class DbgVariable;
42 class MachineFrameInfo;
43 class MachineModuleInfo;
44 class MachineOperand;
45 class MCAsmInfo;
46 class MCObjectFileInfo;
47 class DIEAbbrev;
48 class DIE;
49 class DIELoc;
50 class DIEEntry;
52 //===----------------------------------------------------------------------===//
53 /// \brief This class is used to record source line correspondence.
54 class SrcLineInfo {
55   unsigned Line;     // Source line number.
56   unsigned Column;   // Source column.
57   unsigned SourceID; // Source ID number.
58   MCSymbol *Label;   // Label in code ID number.
59 public:
60   SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
61       : Line(L), Column(C), SourceID(S), Label(label) {}
63   // Accessors
64   unsigned getLine() const { return Line; }
65   unsigned getColumn() const { return Column; }
66   unsigned getSourceID() const { return SourceID; }
67   MCSymbol *getLabel() const { return Label; }
68 };
70 /// \brief This struct describes location entries emitted in the .debug_loc
71 /// section.
72 class DebugLocEntry {
73   // Begin and end symbols for the address range that this location is valid.
74   const MCSymbol *Begin;
75   const MCSymbol *End;
77   // Type of entry that this represents.
78   enum EntryType { E_Location, E_Integer, E_ConstantFP, E_ConstantInt };
79   enum EntryType EntryKind;
81   union {
82     int64_t Int;
83     const ConstantFP *CFP;
84     const ConstantInt *CIP;
85   } Constants;
87   // The location in the machine frame.
88   MachineLocation Loc;
90   // The variable to which this location entry corresponds.
91   const MDNode *Variable;
93   // Whether this location has been merged.
94   bool Merged;
96 public:
97   DebugLocEntry() : Begin(0), End(0), Variable(0), Merged(false) {
98     Constants.Int = 0;
99   }
100   DebugLocEntry(const MCSymbol *B, const MCSymbol *E, MachineLocation &L,
101                 const MDNode *V)
102       : Begin(B), End(E), Loc(L), Variable(V), Merged(false) {
103     Constants.Int = 0;
104     EntryKind = E_Location;
105   }
106   DebugLocEntry(const MCSymbol *B, const MCSymbol *E, int64_t i)
107       : Begin(B), End(E), Variable(0), Merged(false) {
108     Constants.Int = i;
109     EntryKind = E_Integer;
110   }
111   DebugLocEntry(const MCSymbol *B, const MCSymbol *E, const ConstantFP *FPtr)
112       : Begin(B), End(E), Variable(0), Merged(false) {
113     Constants.CFP = FPtr;
114     EntryKind = E_ConstantFP;
115   }
116   DebugLocEntry(const MCSymbol *B, const MCSymbol *E, const ConstantInt *IPtr)
117       : Begin(B), End(E), Variable(0), Merged(false) {
118     Constants.CIP = IPtr;
119     EntryKind = E_ConstantInt;
120   }
122   /// \brief Empty entries are also used as a trigger to emit temp label. Such
123   /// labels are referenced is used to find debug_loc offset for a given DIE.
124   bool isEmpty() const { return Begin == 0 && End == 0; }
125   bool isMerged() const { return Merged; }
126   void Merge(DebugLocEntry *Next) {
127     if (!(Begin && Loc == Next->Loc && End == Next->Begin))
128       return;
129     Next->Begin = Begin;
130     Merged = true;
131   }
132   bool isLocation() const { return EntryKind == E_Location; }
133   bool isInt() const { return EntryKind == E_Integer; }
134   bool isConstantFP() const { return EntryKind == E_ConstantFP; }
135   bool isConstantInt() const { return EntryKind == E_ConstantInt; }
136   int64_t getInt() const { return Constants.Int; }
137   const ConstantFP *getConstantFP() const { return Constants.CFP; }
138   const ConstantInt *getConstantInt() const { return Constants.CIP; }
139   const MDNode *getVariable() const { return Variable; }
140   const MCSymbol *getBeginSym() const { return Begin; }
141   const MCSymbol *getEndSym() const { return End; }
142   MachineLocation getLoc() const { return Loc; }
143 };
145 //===----------------------------------------------------------------------===//
146 /// \brief This class is used to track local variable information.
147 class DbgVariable {
148   DIVariable Var;             // Variable Descriptor.
149   DIE *TheDIE;                // Variable DIE.
150   unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
151   DbgVariable *AbsVar;        // Corresponding Abstract variable, if any.
152   const MachineInstr *MInsn;  // DBG_VALUE instruction of the variable.
153   int FrameIndex;
154   DwarfDebug *DD;
156 public:
157   // AbsVar may be NULL.
158   DbgVariable(DIVariable V, DbgVariable *AV, DwarfDebug *DD)
159       : Var(V), TheDIE(0), DotDebugLocOffset(~0U), AbsVar(AV), MInsn(0),
160         FrameIndex(~0), DD(DD) {}
162   // Accessors.
163   DIVariable getVariable() const { return Var; }
164   void setDIE(DIE *D) { TheDIE = D; }
165   DIE *getDIE() const { return TheDIE; }
166   void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
167   unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
168   StringRef getName() const { return Var.getName(); }
169   DbgVariable *getAbstractVariable() const { return AbsVar; }
170   const MachineInstr *getMInsn() const { return MInsn; }
171   void setMInsn(const MachineInstr *M) { MInsn = M; }
172   int getFrameIndex() const { return FrameIndex; }
173   void setFrameIndex(int FI) { FrameIndex = FI; }
174   // Translate tag to proper Dwarf tag.
175   uint16_t getTag() const {
176     if (Var.getTag() == dwarf::DW_TAG_arg_variable)
177       return dwarf::DW_TAG_formal_parameter;
179     return dwarf::DW_TAG_variable;
180   }
181   /// \brief Return true if DbgVariable is artificial.
182   bool isArtificial() const {
183     if (Var.isArtificial())
184       return true;
185     if (getType().isArtificial())
186       return true;
187     return false;
188   }
190   bool isObjectPointer() const {
191     if (Var.isObjectPointer())
192       return true;
193     if (getType().isObjectPointer())
194       return true;
195     return false;
196   }
198   bool variableHasComplexAddress() const {
199     assert(Var.isVariable() && "Invalid complex DbgVariable!");
200     return Var.hasComplexAddress();
201   }
202   bool isBlockByrefVariable() const;
203   unsigned getNumAddrElements() const {
204     assert(Var.isVariable() && "Invalid complex DbgVariable!");
205     return Var.getNumAddrElements();
206   }
207   uint64_t getAddrElement(unsigned i) const { return Var.getAddrElement(i); }
208   DIType getType() const;
210 private:
211   /// resolve - Look in the DwarfDebug map for the MDNode that
212   /// corresponds to the reference.
213   template <typename T> T resolve(DIRef<T> Ref) const;
214 };
216 /// \brief Collects and handles information specific to a particular
217 /// collection of units. This collection represents all of the units
218 /// that will be ultimately output into a single object file.
219 class DwarfFile {
220   // Target of Dwarf emission, used for sizing of abbreviations.
221   AsmPrinter *Asm;
223   // Used to uniquely define abbreviations.
224   FoldingSet<DIEAbbrev> AbbreviationsSet;
226   // A list of all the unique abbreviations in use.
227   std::vector<DIEAbbrev *> Abbreviations;
229   // A pointer to all units in the section.
230   SmallVector<DwarfUnit *, 1> CUs;
232   // Collection of strings for this unit and assorted symbols.
233   // A String->Symbol mapping of strings used by indirect
234   // references.
235   typedef StringMap<std::pair<MCSymbol *, unsigned>, BumpPtrAllocator &>
236   StrPool;
237   StrPool StringPool;
238   unsigned NextStringPoolNumber;
239   std::string StringPref;
241   struct AddressPoolEntry {
242     unsigned Number;
243     bool TLS;
244     AddressPoolEntry(unsigned Number, bool TLS) : Number(Number), TLS(TLS) {}
245   };
246   // Collection of addresses for this unit and assorted labels.
247   // A Symbol->unsigned mapping of addresses used by indirect
248   // references.
249   typedef DenseMap<const MCSymbol *, AddressPoolEntry> AddrPool;
250   AddrPool AddressPool;
251   unsigned NextAddrPoolNumber;
253 public:
254   DwarfFile(AsmPrinter *AP, const char *Pref, BumpPtrAllocator &DA)
255       : Asm(AP), StringPool(DA), NextStringPoolNumber(0), StringPref(Pref),
256         AddressPool(), NextAddrPoolNumber(0) {}
258   ~DwarfFile();
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
293   /// string text.
294   MCSymbol *getStringPoolEntry(StringRef Str);
296   /// \brief Returns the index into the string pool with the given
297   /// string text.
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
304   /// label/symbol.
305   unsigned getAddrPoolIndex(const MCSymbol *Sym, bool TLS = false);
307   /// \brief Returns the address pool.
308   AddrPool *getAddrPool() { return &AddressPool; }
309 };
311 /// \brief Helper used to pair up a symbol and its DWARF compile unit.
312 struct SymbolCU {
313   SymbolCU(DwarfCompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(CU) {}
314   const MCSymbol *Sym;
315   DwarfCompileUnit *CU;
316 };
318 /// \brief Collects and handles dwarf debug information.
319 class DwarfDebug : public AsmPrinterHandler {
320   // Target of Dwarf emission.
321   AsmPrinter *Asm;
323   // Collected machine module information.
324   MachineModuleInfo *MMI;
326   // All DIEValues are allocated through this allocator.
327   BumpPtrAllocator DIEValueAllocator;
329   // Handle to the compile unit used for the inline extension handling,
330   // this is just so that the DIEValue allocator has a place to store
331   // the particular elements.
332   // FIXME: Store these off of DwarfDebug instead?
333   DwarfCompileUnit *FirstCU;
335   // Maps MDNode with its corresponding DwarfCompileUnit.
336   MapVector<const MDNode *, DwarfCompileUnit *> CUMap;
338   // Maps subprogram MDNode with its corresponding DwarfCompileUnit.
339   DenseMap<const MDNode *, DwarfCompileUnit *> SPMap;
341   // Maps a CU DIE with its corresponding DwarfCompileUnit.
342   DenseMap<const DIE *, DwarfCompileUnit *> CUDieMap;
344   /// Maps MDNodes for type sysstem with the corresponding DIEs. These DIEs can
345   /// be shared across CUs, that is why we keep the map here instead
346   /// of in DwarfCompileUnit.
347   DenseMap<const MDNode *, DIE *> MDTypeNodeToDieMap;
349   // List of all labels used in aranges generation.
350   std::vector<SymbolCU> ArangeLabels;
352   // Size of each symbol emitted (for those symbols that have a specific size).
353   DenseMap<const MCSymbol *, uint64_t> SymSize;
355   // Provides a unique id per text section.
356   typedef DenseMap<const MCSection *, SmallVector<SymbolCU, 8> > SectionMapType;
357   SectionMapType SectionMap;
359   // List of arguments for current function.
360   SmallVector<DbgVariable *, 8> CurrentFnArguments;
362   LexicalScopes LScopes;
364   // Collection of abstract subprogram DIEs.
365   DenseMap<const MDNode *, DIE *> AbstractSPDies;
367   // Collection of dbg variables of a scope.
368   typedef DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >
369   ScopeVariablesMap;
370   ScopeVariablesMap ScopeVariables;
372   // Collection of abstract variables.
373   DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
375   // Collection of DebugLocEntry.
376   SmallVector<DebugLocEntry, 4> DotDebugLocEntries;
378   // Collection of subprogram DIEs that are marked (at the end of the module)
379   // as DW_AT_inline.
380   SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
382   // This is a collection of subprogram MDNodes that are processed to
383   // create DIEs.
384   SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
386   // Maps instruction with label emitted before instruction.
387   DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
389   // Maps instruction with label emitted after instruction.
390   DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
392   // Every user variable mentioned by a DBG_VALUE instruction in order of
393   // appearance.
394   SmallVector<const MDNode *, 8> UserVariables;
396   // For each user variable, keep a list of DBG_VALUE instructions in order.
397   // The list can also contain normal instructions that clobber the previous
398   // DBG_VALUE.
399   typedef DenseMap<const MDNode *, SmallVector<const MachineInstr *, 4> >
400   DbgValueHistoryMap;
401   DbgValueHistoryMap DbgValues;
403   // Previous instruction's location information. This is used to determine
404   // label location to indicate scope boundries in dwarf debug info.
405   DebugLoc PrevInstLoc;
406   MCSymbol *PrevLabel;
408   // This location indicates end of function prologue and beginning of function
409   // body.
410   DebugLoc PrologEndLoc;
412   // If nonnull, stores the current machine function we're processing.
413   const MachineFunction *CurFn;
415   // If nonnull, stores the current machine instruction we're processing.
416   const MachineInstr *CurMI;
418   // Section Symbols: these are assembler temporary labels that are emitted at
419   // the beginning of each supported dwarf section.  These are used to form
420   // section offsets and are created by EmitSectionLabels.
421   MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
422   MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
423   MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
424   MCSymbol *FunctionBeginSym, *FunctionEndSym;
425   MCSymbol *DwarfInfoDWOSectionSym, *DwarfAbbrevDWOSectionSym;
426   MCSymbol *DwarfStrDWOSectionSym;
427   MCSymbol *DwarfGnuPubNamesSectionSym, *DwarfGnuPubTypesSectionSym;
429   // As an optimization, there is no need to emit an entry in the directory
430   // table for the same directory as DW_AT_comp_dir.
431   StringRef CompilationDir;
433   // Counter for assigning globally unique IDs for ranges.
434   unsigned GlobalRangeCount;
436   // Holder for the file specific debug information.
437   DwarfFile InfoHolder;
439   // Holders for the various debug information flags that we might need to
440   // have exposed. See accessor functions below for description.
442   // Holder for imported entities.
443   typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
444   ImportedEntityMap;
445   ImportedEntityMap ScopesWithImportedEntities;
447   // Map from MDNodes for user-defined types to the type units that describe
448   // them.
449   DenseMap<const MDNode *, const DwarfTypeUnit *> DwarfTypeUnits;
451   // Whether to emit the pubnames/pubtypes sections.
452   bool HasDwarfPubSections;
454   // Whether or not to use AT_ranges for compilation units.
455   bool HasCURanges;
457   // Whether we emitted a function into a section other than the default
458   // text.
459   bool UsedNonDefaultText;
461   // Version of dwarf we're emitting.
462   unsigned DwarfVersion;
464   // Maps from a type identifier to the actual MDNode.
465   DITypeIdentifierMap TypeIdentifierMap;
467   // DWARF5 Experimental Options
468   bool HasDwarfAccelTables;
469   bool HasSplitDwarf;
471   // Separated Dwarf Variables
472   // In general these will all be for bits that are left in the
473   // original object file, rather than things that are meant
474   // to be in the .dwo sections.
476   // Holder for the skeleton information.
477   DwarfFile SkeletonHolder;
479   // Store file names for type units under fission in a line table header that
480   // will be emitted into debug_line.dwo.
481   MCDwarfDwoLineTable SplitTypeUnitFileTable;
483   void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
485   const SmallVectorImpl<DwarfUnit *> &getUnits() {
486     return InfoHolder.getUnits();
487   }
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
495   /// variables.
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
503   /// lexical scope.
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
537   /// processed.
538   void finalizeModuleInfo();
540   /// \brief Emit labels to close any remaining sections that have been left
541   /// open.
542   void endSections();
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
551   /// the line matrix.
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
570   /// index.
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
576   /// index.
577   void emitDebugPubTypes(bool GnuStyle = false);
579   void
580   emitDebugPubSection(bool GnuStyle, const MCSection *PSec, StringRef Name,
581                       const StringMap<const DIE *> &(DwarfUnit::*Accessor)()
582                       const);
584   /// \brief Emit visible names into a debug str section.
585   void emitDebugStr();
587   /// \brief Emit visible names into a debug loc section.
588   void emitDebugLoc();
590   /// \brief Emit visible names into a debug aranges section.
591   void emitDebugARanges();
593   /// \brief Emit visible names into a debug ranges section.
594   void emitDebugRanges();
596   /// \brief Emit inline info using custom format.
597   void emitDebugInlineInfo();
599   /// DWARF 5 Experimental Split Dwarf Emitters
601   /// \brief Initialize common features of skeleton units.
602   void initSkeletonUnit(const DwarfUnit *U, DIE *Die, DwarfUnit *NewU);
604   /// \brief Construct the split debug info compile unit for the debug info
605   /// section.
606   DwarfCompileUnit *constructSkeletonCU(const DwarfCompileUnit *CU);
608   /// \brief Construct the split debug info compile unit for the debug info
609   /// section.
610   DwarfTypeUnit *constructSkeletonTU(DwarfTypeUnit *TU);
612   /// \brief Emit the debug info dwo section.
613   void emitDebugInfoDWO();
615   /// \brief Emit the debug abbrev dwo section.
616   void emitDebugAbbrevDWO();
618   /// \brief Emit the debug line dwo section.
619   void emitDebugLineDWO();
621   /// \brief Emit the debug str dwo section.
622   void emitDebugStrDWO();
624   /// Flags to let the linker know we have emitted new style pubnames. Only
625   /// emit it here if we don't have a skeleton CU for split dwarf.
626   void addGnuPubAttributes(DwarfUnit *U, DIE *D) const;
628   /// \brief Create new DwarfCompileUnit for the given metadata node with tag
629   /// DW_TAG_compile_unit.
630   DwarfCompileUnit *constructDwarfCompileUnit(DICompileUnit DIUnit,
631                                               bool Singular);
633   /// \brief Construct subprogram DIE.
634   void constructSubprogramDIE(DwarfCompileUnit *TheCU, const MDNode *N);
636   /// \brief Construct imported_module or imported_declaration DIE.
637   void constructImportedEntityDIE(DwarfCompileUnit *TheCU, const MDNode *N);
639   /// \brief Construct import_module DIE.
640   void constructImportedEntityDIE(DwarfCompileUnit *TheCU, const MDNode *N,
641                                   DIE *Context);
643   /// \brief Construct import_module DIE.
644   void constructImportedEntityDIE(DwarfCompileUnit *TheCU,
645                                   const DIImportedEntity &Module, DIE *Context);
647   /// \brief Register a source line with debug info. Returns the unique
648   /// label that was emitted and which provides correspondence to the
649   /// source line list.
650   void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
651                         unsigned Flags);
653   /// \brief Indentify instructions that are marking the beginning of or
654   /// ending of a scope.
655   void identifyScopeMarkers();
657   /// \brief If Var is an current function argument that add it in
658   /// CurrentFnArguments list.
659   bool addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope);
661   /// \brief Populate LexicalScope entries with variables' info.
662   void collectVariableInfo(SmallPtrSet<const MDNode *, 16> &ProcessedVars);
664   /// \brief Collect variable information from the side table maintained
665   /// by MMI.
666   void collectVariableInfoFromMMITable(SmallPtrSet<const MDNode *, 16> &P);
668   /// \brief Ensure that a label will be emitted before MI.
669   void requestLabelBeforeInsn(const MachineInstr *MI) {
670     LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol *)0));
671   }
673   /// \brief Return Label preceding the instruction.
674   MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
676   /// \brief Ensure that a label will be emitted after MI.
677   void requestLabelAfterInsn(const MachineInstr *MI) {
678     LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol *)0));
679   }
681   /// \brief Return Label immediately following the instruction.
682   MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
684   void attachLowHighPC(DwarfCompileUnit *Unit, DIE *D, MCSymbol *Begin,
685                        MCSymbol *End);
687 public:
688   //===--------------------------------------------------------------------===//
689   // Main entry points.
690   //
691   DwarfDebug(AsmPrinter *A, Module *M);
693   void insertDIE(const MDNode *TypeMD, DIE *Die) {
694     MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
695   }
696   DIE *getDIE(const MDNode *TypeMD) {
697     return MDTypeNodeToDieMap.lookup(TypeMD);
698   }
700   /// \brief Emit all Dwarf sections that should come prior to the
701   /// content.
702   void beginModule();
704   /// \brief Emit all Dwarf sections that should come after the content.
705   void endModule() override;
707   /// \brief Gather pre-function debug information.
708   void beginFunction(const MachineFunction *MF) override;
710   /// \brief Gather and emit post-function debug information.
711   void endFunction(const MachineFunction *MF) override;
713   /// \brief Process beginning of an instruction.
714   void beginInstruction(const MachineInstr *MI) override;
716   /// \brief Process end of an instruction.
717   void endInstruction() override;
719   /// \brief Add a DIE to the set of types that we're going to pull into
720   /// type units.
721   void addDwarfTypeUnitType(DwarfCompileUnit &CU, StringRef Identifier,
722                             DIE *Die, DICompositeType CTy);
724   /// \brief Add a label so that arange data can be generated for it.
725   void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
727   /// \brief For symbols that have a size designated (e.g. common symbols),
728   /// this tracks that size.
729   void setSymbolSize(const MCSymbol *Sym, uint64_t Size) override {
730     SymSize[Sym] = Size;
731   }
733   /// \brief Recursively Emits a debug information entry.
734   void emitDIE(DIE *Die);
736   // Experimental DWARF5 features.
738   /// \brief Returns whether or not to emit tables that dwarf consumers can
739   /// use to accelerate lookup.
740   bool useDwarfAccelTables() const { return HasDwarfAccelTables; }
742   /// \brief Returns whether or not to change the current debug info for the
743   /// split dwarf proposal support.
744   bool useSplitDwarf() const { return HasSplitDwarf; }
746   /// \brief Returns whether or not to use AT_ranges for compilation units.
747   bool useCURanges() const { return HasCURanges; }
749   /// Returns the Dwarf Version.
750   unsigned getDwarfVersion() const { return DwarfVersion; }
752   /// Returns the section symbol for the .debug_loc section.
753   MCSymbol *getDebugLocSym() const { return DwarfDebugLocSectionSym; }
755   /// Returns the entries for the .debug_loc section.
756   const SmallVectorImpl<DebugLocEntry> &getDebugLocEntries() const {
757     return DotDebugLocEntries;
758   }
760   /// \brief Emit an entry for the debug loc section. This can be used to
761   /// handle an entry that's going to be emitted into the debug loc section.
762   void emitDebugLocEntry(ByteStreamer &Streamer, const DebugLocEntry &Entry);
764   /// Find the MDNode for the given reference.
765   template <typename T> T resolve(DIRef<T> Ref) const {
766     return Ref.resolve(TypeIdentifierMap);
767   }
769   /// \brief Return the TypeIdentifierMap.
770   const DITypeIdentifierMap& getTypeIdentifierMap() const {
771     return TypeIdentifierMap;
772   }
774   /// Find the DwarfCompileUnit for the given CU Die.
775   DwarfCompileUnit *lookupUnit(const DIE *CU) const {
776     return CUDieMap.lookup(CU);
777   }
778   /// isSubprogramContext - Return true if Context is either a subprogram
779   /// or another context nested inside a subprogram.
780   bool isSubprogramContext(const MDNode *Context);
781 };
782 } // End of namespace llvm
784 #endif