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