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