Disable the -gmlt optimization implemented in r218129 under Darwin due to issues...
[oota-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 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFDEBUG_H
15 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFDEBUG_H
16
17 #include "DwarfFile.h"
18 #include "AsmPrinterHandler.h"
19 #include "DIE.h"
20 #include "DbgValueHistoryCalculator.h"
21 #include "DebugLocEntry.h"
22 #include "DebugLocList.h"
23 #include "DwarfAccelTable.h"
24 #include "llvm/ADT/DenseMap.h"
25 #include "llvm/ADT/MapVector.h"
26 #include "llvm/ADT/SmallPtrSet.h"
27 #include "llvm/ADT/StringMap.h"
28 #include "llvm/ADT/FoldingSet.h"
29 #include "llvm/CodeGen/LexicalScopes.h"
30 #include "llvm/CodeGen/MachineInstr.h"
31 #include "llvm/IR/DebugInfo.h"
32 #include "llvm/IR/DebugLoc.h"
33 #include "llvm/MC/MachineLocation.h"
34 #include "llvm/MC/MCDwarf.h"
35 #include "llvm/Support/Allocator.h"
36
37 #include <memory>
38
39 namespace llvm {
40
41 class AsmPrinter;
42 class ByteStreamer;
43 class ConstantInt;
44 class ConstantFP;
45 class DwarfCompileUnit;
46 class DwarfDebug;
47 class DwarfTypeUnit;
48 class DwarfUnit;
49 class MachineModuleInfo;
50
51 //===----------------------------------------------------------------------===//
52 /// \brief This class is used to record source line correspondence.
53 class SrcLineInfo {
54   unsigned Line;     // Source line number.
55   unsigned Column;   // Source column.
56   unsigned SourceID; // Source ID number.
57   MCSymbol *Label;   // Label in code ID number.
58 public:
59   SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
60       : Line(L), Column(C), SourceID(S), Label(label) {}
61
62   // Accessors
63   unsigned getLine() const { return Line; }
64   unsigned getColumn() const { return Column; }
65   unsigned getSourceID() const { return SourceID; }
66   MCSymbol *getLabel() const { return Label; }
67 };
68
69 //===----------------------------------------------------------------------===//
70 /// \brief This class is used to track local variable information.
71 class DbgVariable {
72   DIVariable Var;             // Variable Descriptor.
73   DIE *TheDIE;                // Variable DIE.
74   unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
75   const MachineInstr *MInsn;  // DBG_VALUE instruction of the variable.
76   int FrameIndex;
77   DwarfDebug *DD;
78
79 public:
80   /// Construct a DbgVariable from a DIVariable.
81   DbgVariable(DIVariable V, DwarfDebug *DD)
82       : Var(V), TheDIE(nullptr), DotDebugLocOffset(~0U), MInsn(nullptr),
83         FrameIndex(~0), DD(DD) {}
84
85   /// Construct a DbgVariable from a DEBUG_VALUE.
86   /// AbstractVar may be NULL.
87   DbgVariable(const MachineInstr *DbgValue, DwarfDebug *DD)
88       : Var(DbgValue->getDebugVariable()), TheDIE(nullptr),
89         DotDebugLocOffset(~0U), MInsn(DbgValue), FrameIndex(~0), DD(DD) {}
90
91   // Accessors.
92   DIVariable getVariable() const { return Var; }
93   void setDIE(DIE &D) { TheDIE = &D; }
94   DIE *getDIE() const { return TheDIE; }
95   void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
96   unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
97   StringRef getName() const { return Var.getName(); }
98   const MachineInstr *getMInsn() const { return MInsn; }
99   int getFrameIndex() const { return FrameIndex; }
100   void setFrameIndex(int FI) { FrameIndex = FI; }
101   // Translate tag to proper Dwarf tag.
102   dwarf::Tag getTag() const {
103     if (Var.getTag() == dwarf::DW_TAG_arg_variable)
104       return dwarf::DW_TAG_formal_parameter;
105
106     return dwarf::DW_TAG_variable;
107   }
108   /// \brief Return true if DbgVariable is artificial.
109   bool isArtificial() const {
110     if (Var.isArtificial())
111       return true;
112     if (getType().isArtificial())
113       return true;
114     return false;
115   }
116
117   bool isObjectPointer() const {
118     if (Var.isObjectPointer())
119       return true;
120     if (getType().isObjectPointer())
121       return true;
122     return false;
123   }
124
125   bool variableHasComplexAddress() const {
126     assert(Var.isVariable() && "Invalid complex DbgVariable!");
127     return Var.hasComplexAddress();
128   }
129   bool isBlockByrefVariable() const;
130   unsigned getNumAddrElements() const {
131     assert(Var.isVariable() && "Invalid complex DbgVariable!");
132     return Var.getNumAddrElements();
133   }
134   uint64_t getAddrElement(unsigned i) const { return Var.getAddrElement(i); }
135   DIType getType() const;
136
137 private:
138   /// resolve - Look in the DwarfDebug map for the MDNode that
139   /// corresponds to the reference.
140   template <typename T> T resolve(DIRef<T> Ref) const;
141 };
142
143
144 /// \brief Helper used to pair up a symbol and its DWARF compile unit.
145 struct SymbolCU {
146   SymbolCU(DwarfCompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(CU) {}
147   const MCSymbol *Sym;
148   DwarfCompileUnit *CU;
149 };
150
151 /// \brief Collects and handles dwarf debug information.
152 class DwarfDebug : public AsmPrinterHandler {
153   // Target of Dwarf emission.
154   AsmPrinter *Asm;
155
156   // Collected machine module information.
157   MachineModuleInfo *MMI;
158
159   // All DIEValues are allocated through this allocator.
160   BumpPtrAllocator DIEValueAllocator;
161
162   // Handle to the compile unit used for the inline extension handling,
163   // this is just so that the DIEValue allocator has a place to store
164   // the particular elements.
165   // FIXME: Store these off of DwarfDebug instead?
166   DwarfCompileUnit *FirstCU;
167
168   // Maps MDNode with its corresponding DwarfCompileUnit.
169   MapVector<const MDNode *, DwarfCompileUnit *> CUMap;
170
171   // Maps subprogram MDNode with its corresponding DwarfCompileUnit.
172   DenseMap<const MDNode *, DwarfCompileUnit *> SPMap;
173
174   // Maps a CU DIE with its corresponding DwarfCompileUnit.
175   DenseMap<const DIE *, DwarfCompileUnit *> CUDieMap;
176
177   /// Maps MDNodes for type system with the corresponding DIEs. These DIEs can
178   /// be shared across CUs, that is why we keep the map here instead
179   /// of in DwarfCompileUnit.
180   DenseMap<const MDNode *, DIE *> MDTypeNodeToDieMap;
181
182   // List of all labels used in aranges generation.
183   std::vector<SymbolCU> ArangeLabels;
184
185   // Size of each symbol emitted (for those symbols that have a specific size).
186   DenseMap<const MCSymbol *, uint64_t> SymSize;
187
188   // Provides a unique id per text section.
189   typedef DenseMap<const MCSection *, SmallVector<SymbolCU, 8> > SectionMapType;
190   SectionMapType SectionMap;
191
192   // List of arguments for current function.
193   SmallVector<DbgVariable *, 8> CurrentFnArguments;
194
195   LexicalScopes LScopes;
196
197   // Collection of abstract subprogram DIEs.
198   DenseMap<const MDNode *, DIE *> AbstractSPDies;
199
200   // Collection of dbg variables of a scope.
201   typedef DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >
202   ScopeVariablesMap;
203   ScopeVariablesMap ScopeVariables;
204
205   // Collection of abstract variables.
206   DenseMap<const MDNode *, std::unique_ptr<DbgVariable>> AbstractVariables;
207   SmallVector<std::unique_ptr<DbgVariable>, 64> ConcreteVariables;
208
209   // Collection of DebugLocEntry. Stored in a linked list so that DIELocLists
210   // can refer to them in spite of insertions into this list.
211   SmallVector<DebugLocList, 4> DotDebugLocEntries;
212
213   // Collection of subprogram DIEs that are marked (at the end of the module)
214   // as DW_AT_inline.
215   SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
216
217   // This is a collection of subprogram MDNodes that are processed to
218   // create DIEs.
219   SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
220
221   // Maps instruction with label emitted before instruction.
222   DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
223
224   // Maps instruction with label emitted after instruction.
225   DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
226
227   // History of DBG_VALUE and clobber instructions for each user variable.
228   // Variables are listed in order of appearance.
229   DbgValueHistoryMap DbgValues;
230
231   // Previous instruction's location information. This is used to determine
232   // label location to indicate scope boundries in dwarf debug info.
233   DebugLoc PrevInstLoc;
234   MCSymbol *PrevLabel;
235
236   // This location indicates end of function prologue and beginning of function
237   // body.
238   DebugLoc PrologEndLoc;
239
240   // If nonnull, stores the current machine function we're processing.
241   const MachineFunction *CurFn;
242
243   // If nonnull, stores the current machine instruction we're processing.
244   const MachineInstr *CurMI;
245
246   // If nonnull, stores the CU in which the previous subprogram was contained.
247   const DwarfCompileUnit *PrevCU;
248
249   // Section Symbols: these are assembler temporary labels that are emitted at
250   // the beginning of each supported dwarf section.  These are used to form
251   // section offsets and are created by EmitSectionLabels.
252   MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
253   MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
254   MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
255   MCSymbol *FunctionBeginSym, *FunctionEndSym;
256   MCSymbol *DwarfInfoDWOSectionSym, *DwarfAbbrevDWOSectionSym;
257   MCSymbol *DwarfTypesDWOSectionSym;
258   MCSymbol *DwarfStrDWOSectionSym;
259   MCSymbol *DwarfGnuPubNamesSectionSym, *DwarfGnuPubTypesSectionSym;
260
261   // As an optimization, there is no need to emit an entry in the directory
262   // table for the same directory as DW_AT_comp_dir.
263   StringRef CompilationDir;
264
265   // Counter for assigning globally unique IDs for ranges.
266   unsigned GlobalRangeCount;
267
268   // Holder for the file specific debug information.
269   DwarfFile InfoHolder;
270
271   // Holders for the various debug information flags that we might need to
272   // have exposed. See accessor functions below for description.
273
274   // Holder for imported entities.
275   typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
276   ImportedEntityMap;
277   ImportedEntityMap ScopesWithImportedEntities;
278
279   // Map from MDNodes for user-defined types to the type units that describe
280   // them.
281   DenseMap<const MDNode *, const DwarfTypeUnit *> DwarfTypeUnits;
282
283   SmallVector<std::pair<std::unique_ptr<DwarfTypeUnit>, DICompositeType>, 1> TypeUnitsUnderConstruction;
284
285   // Whether to emit the pubnames/pubtypes sections.
286   bool HasDwarfPubSections;
287
288   // Whether or not to use AT_ranges for compilation units.
289   bool HasCURanges;
290
291   // Whether we emitted a function into a section other than the default
292   // text.
293   bool UsedNonDefaultText;
294
295   // Version of dwarf we're emitting.
296   unsigned DwarfVersion;
297
298   // Maps from a type identifier to the actual MDNode.
299   DITypeIdentifierMap TypeIdentifierMap;
300
301   // DWARF5 Experimental Options
302   bool HasDwarfAccelTables;
303   bool HasSplitDwarf;
304
305   // Separated Dwarf Variables
306   // In general these will all be for bits that are left in the
307   // original object file, rather than things that are meant
308   // to be in the .dwo sections.
309
310   // Holder for the skeleton information.
311   DwarfFile SkeletonHolder;
312
313   /// Store file names for type units under fission in a line table header that
314   /// will be emitted into debug_line.dwo.
315   // FIXME: replace this with a map from comp_dir to table so that we can emit
316   // multiple tables during LTO each of which uses directory 0, referencing the
317   // comp_dir of all the type units that use it.
318   MCDwarfDwoLineTable SplitTypeUnitFileTable;
319
320   // True iff there are multiple CUs in this module.
321   bool SingleCU;
322   bool IsDarwin;
323
324   AddressPool AddrPool;
325
326   DwarfAccelTable AccelNames;
327   DwarfAccelTable AccelObjC;
328   DwarfAccelTable AccelNamespace;
329   DwarfAccelTable AccelTypes;
330
331   DenseMap<const Function *, DISubprogram> FunctionDIs;
332
333   MCDwarfDwoLineTable *getDwoLineTable(const DwarfCompileUnit &);
334
335   void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
336
337   const SmallVectorImpl<std::unique_ptr<DwarfUnit>> &getUnits() {
338     return InfoHolder.getUnits();
339   }
340
341   /// \brief Find abstract variable associated with Var.
342   DbgVariable *getExistingAbstractVariable(const DIVariable &DV,
343                                            DIVariable &Cleansed);
344   DbgVariable *getExistingAbstractVariable(const DIVariable &DV);
345   void createAbstractVariable(const DIVariable &DV, LexicalScope *Scope);
346   void ensureAbstractVariableIsCreated(const DIVariable &Var,
347                                        const MDNode *Scope);
348   void ensureAbstractVariableIsCreatedIfScoped(const DIVariable &Var,
349                                                const MDNode *Scope);
350
351   /// \brief Find DIE for the given subprogram and attach appropriate
352   /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
353   /// variables in this scope then create and insert DIEs for these
354   /// variables.
355   DIE &updateSubprogramScopeDIE(DwarfCompileUnit &SPCU, DISubprogram SP);
356
357   /// \brief A helper function to check whether the DIE for a given Scope is
358   /// going to be null.
359   bool isLexicalScopeDIENull(LexicalScope *Scope);
360
361   /// \brief A helper function to construct a RangeSpanList for a given
362   /// lexical scope.
363   void addScopeRangeList(DwarfCompileUnit &TheCU, DIE &ScopeDIE,
364                          const SmallVectorImpl<InsnRange> &Range);
365
366   /// \brief Construct new DW_TAG_lexical_block for this scope and
367   /// attach DW_AT_low_pc/DW_AT_high_pc labels.
368   std::unique_ptr<DIE> constructLexicalScopeDIE(DwarfCompileUnit &TheCU,
369                                                 LexicalScope *Scope);
370
371   /// \brief This scope represents inlined body of a function. Construct
372   /// DIE to represent this concrete inlined copy of the function.
373   std::unique_ptr<DIE> constructInlinedScopeDIE(DwarfCompileUnit &TheCU,
374                                                 LexicalScope *Scope);
375
376   /// \brief Construct a DIE for this scope.
377   void constructScopeDIE(DwarfCompileUnit &TheCU, LexicalScope *Scope,
378                          SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren);
379   DIE *createAndAddScopeChildren(DwarfCompileUnit &TheCU, LexicalScope *Scope,
380                                  DIE &ScopeDIE);
381   /// \brief Construct a DIE for this abstract scope.
382   void constructAbstractSubprogramScopeDIE(DwarfCompileUnit &TheCU,
383                                            LexicalScope *Scope);
384   /// \brief Construct a DIE for this subprogram scope.
385   DIE &constructSubprogramScopeDIE(DwarfCompileUnit &TheCU,
386                                    LexicalScope *Scope);
387   /// A helper function to create children of a Scope DIE.
388   DIE *createScopeChildrenDIE(DwarfCompileUnit &TheCU, LexicalScope *Scope,
389                               SmallVectorImpl<std::unique_ptr<DIE>> &Children,
390                               unsigned *ChildScopeCount = nullptr);
391
392   /// \brief Emit initial Dwarf sections with a label at the start of each one.
393   void emitSectionLabels();
394
395   /// \brief Compute the size and offset of a DIE given an incoming Offset.
396   unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
397
398   /// \brief Compute the size and offset of all the DIEs.
399   void computeSizeAndOffsets();
400
401   /// \brief Collect info for variables that were optimized out.
402   void collectDeadVariables();
403
404   void finishVariableDefinitions();
405
406   void finishSubprogramDefinitions();
407
408   /// \brief Finish off debug information after all functions have been
409   /// processed.
410   void finalizeModuleInfo();
411
412   /// \brief Emit labels to close any remaining sections that have been left
413   /// open.
414   void endSections();
415
416   /// \brief Emit the debug info section.
417   void emitDebugInfo();
418
419   /// \brief Emit the abbreviation section.
420   void emitAbbreviations();
421
422   /// \brief Emit the last address of the section and the end of
423   /// the line matrix.
424   void emitEndOfLineMatrix(unsigned SectionEnd);
425
426   /// \brief Emit a specified accelerator table.
427   void emitAccel(DwarfAccelTable &Accel, const MCSection *Section,
428                  StringRef TableName, StringRef SymName);
429
430   /// \brief Emit visible names into a hashed accelerator table section.
431   void emitAccelNames();
432
433   /// \brief Emit objective C classes and categories into a hashed
434   /// accelerator table section.
435   void emitAccelObjC();
436
437   /// \brief Emit namespace dies into a hashed accelerator table.
438   void emitAccelNamespaces();
439
440   /// \brief Emit type dies into a hashed accelerator table.
441   void emitAccelTypes();
442
443   /// \brief Emit visible names into a debug pubnames section.
444   /// \param GnuStyle determines whether or not we want to emit
445   /// additional information into the table ala newer gcc for gdb
446   /// index.
447   void emitDebugPubNames(bool GnuStyle = false);
448
449   /// \brief Emit visible types into a debug pubtypes section.
450   /// \param GnuStyle determines whether or not we want to emit
451   /// additional information into the table ala newer gcc for gdb
452   /// index.
453   void emitDebugPubTypes(bool GnuStyle = false);
454
455   void
456   emitDebugPubSection(bool GnuStyle, const MCSection *PSec, StringRef Name,
457                       const StringMap<const DIE *> &(DwarfUnit::*Accessor)()
458                       const);
459
460   /// \brief Emit visible names into a debug str section.
461   void emitDebugStr();
462
463   /// \brief Emit visible names into a debug loc section.
464   void emitDebugLoc();
465
466   /// \brief Emit visible names into a debug loc dwo section.
467   void emitDebugLocDWO();
468
469   /// \brief Emit visible names into a debug aranges section.
470   void emitDebugARanges();
471
472   /// \brief Emit visible names into a debug ranges section.
473   void emitDebugRanges();
474
475   /// \brief Emit inline info using custom format.
476   void emitDebugInlineInfo();
477
478   /// DWARF 5 Experimental Split Dwarf Emitters
479
480   /// \brief Initialize common features of skeleton units.
481   void initSkeletonUnit(const DwarfUnit &U, DIE &Die,
482                         std::unique_ptr<DwarfUnit> NewU);
483
484   /// \brief Construct the split debug info compile unit for the debug info
485   /// section.
486   DwarfCompileUnit &constructSkeletonCU(const DwarfCompileUnit &CU);
487
488   /// \brief Construct the split debug info compile unit for the debug info
489   /// section.
490   DwarfTypeUnit &constructSkeletonTU(DwarfTypeUnit &TU);
491
492   /// \brief Emit the debug info dwo section.
493   void emitDebugInfoDWO();
494
495   /// \brief Emit the debug abbrev dwo section.
496   void emitDebugAbbrevDWO();
497
498   /// \brief Emit the debug line dwo section.
499   void emitDebugLineDWO();
500
501   /// \brief Emit the debug str dwo section.
502   void emitDebugStrDWO();
503
504   /// Flags to let the linker know we have emitted new style pubnames. Only
505   /// emit it here if we don't have a skeleton CU for split dwarf.
506   void addGnuPubAttributes(DwarfUnit &U, DIE &D) const;
507
508   /// \brief Create new DwarfCompileUnit for the given metadata node with tag
509   /// DW_TAG_compile_unit.
510   DwarfCompileUnit &constructDwarfCompileUnit(DICompileUnit DIUnit);
511
512   /// \brief Construct imported_module or imported_declaration DIE.
513   void constructAndAddImportedEntityDIE(DwarfCompileUnit &TheCU,
514                                         const MDNode *N);
515
516   /// \brief Construct import_module DIE.
517   std::unique_ptr<DIE>
518   constructImportedEntityDIE(DwarfCompileUnit &TheCU,
519                              const DIImportedEntity &Module);
520
521   /// \brief Register a source line with debug info. Returns the unique
522   /// label that was emitted and which provides correspondence to the
523   /// source line list.
524   void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
525                         unsigned Flags);
526
527   /// \brief Indentify instructions that are marking the beginning of or
528   /// ending of a scope.
529   void identifyScopeMarkers();
530
531   /// \brief If Var is an current function argument that add it in
532   /// CurrentFnArguments list.
533   bool addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope);
534
535   /// \brief Populate LexicalScope entries with variables' info.
536   void collectVariableInfo(SmallPtrSetImpl<const MDNode *> &ProcessedVars);
537
538   /// \brief Build the location list for all DBG_VALUEs in the
539   /// function that describe the same variable.
540   void buildLocationList(SmallVectorImpl<DebugLocEntry> &DebugLoc,
541                          const DbgValueHistoryMap::InstrRanges &Ranges);
542
543   /// \brief Collect variable information from the side table maintained
544   /// by MMI.
545   void collectVariableInfoFromMMITable(SmallPtrSetImpl<const MDNode *> &P);
546
547   /// \brief Ensure that a label will be emitted before MI.
548   void requestLabelBeforeInsn(const MachineInstr *MI) {
549     LabelsBeforeInsn.insert(std::make_pair(MI, nullptr));
550   }
551
552   /// \brief Return Label preceding the instruction.
553   MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
554
555   /// \brief Ensure that a label will be emitted after MI.
556   void requestLabelAfterInsn(const MachineInstr *MI) {
557     LabelsAfterInsn.insert(std::make_pair(MI, nullptr));
558   }
559
560   /// \brief Return Label immediately following the instruction.
561   MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
562
563   void attachRangesOrLowHighPC(DwarfCompileUnit &Unit, DIE &D,
564                                const SmallVectorImpl<InsnRange> &Ranges);
565   void attachLowHighPC(DwarfCompileUnit &Unit, DIE &D, const MCSymbol *Begin,
566                        const MCSymbol *End);
567
568 public:
569   //===--------------------------------------------------------------------===//
570   // Main entry points.
571   //
572   DwarfDebug(AsmPrinter *A, Module *M);
573
574   ~DwarfDebug() override;
575
576   void insertDIE(const MDNode *TypeMD, DIE *Die) {
577     MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
578   }
579   DIE *getDIE(const MDNode *TypeMD) {
580     return MDTypeNodeToDieMap.lookup(TypeMD);
581   }
582
583   /// \brief Emit all Dwarf sections that should come prior to the
584   /// content.
585   void beginModule();
586
587   /// \brief Emit all Dwarf sections that should come after the content.
588   void endModule() override;
589
590   /// \brief Gather pre-function debug information.
591   void beginFunction(const MachineFunction *MF) override;
592
593   /// \brief Gather and emit post-function debug information.
594   void endFunction(const MachineFunction *MF) override;
595
596   /// \brief Process beginning of an instruction.
597   void beginInstruction(const MachineInstr *MI) override;
598
599   /// \brief Process end of an instruction.
600   void endInstruction() override;
601
602   /// \brief Add a DIE to the set of types that we're going to pull into
603   /// type units.
604   void addDwarfTypeUnitType(DwarfCompileUnit &CU, StringRef Identifier,
605                             DIE &Die, DICompositeType CTy);
606
607   /// \brief Add a label so that arange data can be generated for it.
608   void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
609
610   /// \brief For symbols that have a size designated (e.g. common symbols),
611   /// this tracks that size.
612   void setSymbolSize(const MCSymbol *Sym, uint64_t Size) override {
613     SymSize[Sym] = Size;
614   }
615
616   /// \brief Recursively Emits a debug information entry.
617   void emitDIE(DIE &Die);
618
619   // Experimental DWARF5 features.
620
621   /// \brief Returns whether or not to emit tables that dwarf consumers can
622   /// use to accelerate lookup.
623   bool useDwarfAccelTables() const { return HasDwarfAccelTables; }
624
625   /// \brief Returns whether or not to change the current debug info for the
626   /// split dwarf proposal support.
627   bool useSplitDwarf() const { return HasSplitDwarf; }
628
629   /// Returns the Dwarf Version.
630   unsigned getDwarfVersion() const { return DwarfVersion; }
631
632   /// Returns the section symbol for the .debug_loc section.
633   MCSymbol *getDebugLocSym() const { return DwarfDebugLocSectionSym; }
634
635   /// Returns the section symbol for the .debug_str section.
636   MCSymbol *getDebugStrSym() const { return DwarfStrSectionSym; }
637
638   /// Returns the previous CU that was being updated
639   const DwarfCompileUnit *getPrevCU() const { return PrevCU; }
640   void setPrevCU(const DwarfCompileUnit *PrevCU) { this->PrevCU = PrevCU; }
641
642   /// Returns the entries for the .debug_loc section.
643   const SmallVectorImpl<DebugLocList> &
644   getDebugLocEntries() const {
645     return DotDebugLocEntries;
646   }
647
648   /// \brief Emit an entry for the debug loc section. This can be used to
649   /// handle an entry that's going to be emitted into the debug loc section.
650   void emitDebugLocEntry(ByteStreamer &Streamer, const DebugLocEntry &Entry);
651   /// \brief emit a single value for the debug loc section.
652   void emitDebugLocValue(ByteStreamer &Streamer,
653                          const DebugLocEntry::Value &Value);
654   /// Emits an optimal (=sorted) sequence of DW_OP_pieces.
655   void emitLocPieces(ByteStreamer &Streamer,
656                      const DITypeIdentifierMap &Map,
657                      ArrayRef<DebugLocEntry::Value> Values);
658
659   /// Emit the location for a debug loc entry, including the size header.
660   void emitDebugLocEntryLocation(const DebugLocEntry &Entry);
661
662   /// Find the MDNode for the given reference.
663   template <typename T> T resolve(DIRef<T> Ref) const {
664     return Ref.resolve(TypeIdentifierMap);
665   }
666
667   /// \brief Return the TypeIdentifierMap.
668   const DITypeIdentifierMap &getTypeIdentifierMap() const {
669     return TypeIdentifierMap;
670   }
671
672   /// Find the DwarfCompileUnit for the given CU Die.
673   DwarfCompileUnit *lookupUnit(const DIE *CU) const {
674     return CUDieMap.lookup(CU);
675   }
676   /// isSubprogramContext - Return true if Context is either a subprogram
677   /// or another context nested inside a subprogram.
678   bool isSubprogramContext(const MDNode *Context);
679
680   void addSubprogramNames(DISubprogram SP, DIE &Die);
681
682   AddressPool &getAddressPool() { return AddrPool; }
683
684   void addAccelName(StringRef Name, const DIE &Die);
685
686   void addAccelObjC(StringRef Name, const DIE &Die);
687
688   void addAccelNamespace(StringRef Name, const DIE &Die);
689
690   void addAccelType(StringRef Name, const DIE &Die, char Flags);
691 };
692 } // End of namespace llvm
693
694 #endif