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