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   // 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   SmallVector<std::unique_ptr<DbgVariable>, 64> ConcreteVariables;
 213
 214   // Collection of DebugLocEntry. Stored in a linked list so that DIELocLists
 215   // can refer to them in spite of insertions into this list.
 216   SmallVector<DebugLocList, 4> DotDebugLocEntries;
 217
 218   // This is a collection of subprogram MDNodes that are processed to
 219   // create DIEs.
 220   SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
 221
 222   // Maps instruction with label emitted before instruction.
 223   DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
 224
 225   // Maps instruction with label emitted after instruction.
 226   DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
 227
 228   // History of DBG_VALUE and clobber instructions for each user variable.
 229   // Variables are listed in order of appearance.
 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 CU in which the previous subprogram was contained.
 248   const DwarfCompileUnit *PrevCU;
 249
 250   // Section Symbols: these are assembler temporary labels that are emitted at
 251   // the beginning of each supported dwarf section.  These are used to form
 252   // section offsets and are created by EmitSectionLabels.
 253   MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
 254   MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
 255   MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
 256   MCSymbol *FunctionBeginSym, *FunctionEndSym;
 257   MCSymbol *DwarfInfoDWOSectionSym, *DwarfAbbrevDWOSectionSym;
 258   MCSymbol *DwarfTypesDWOSectionSym;
 259   MCSymbol *DwarfStrDWOSectionSym;
 260   MCSymbol *DwarfGnuPubNamesSectionSym, *DwarfGnuPubTypesSectionSym;
 261
 262   // As an optimization, there is no need to emit an entry in the directory
 263   // table for the same directory as DW_AT_comp_dir.
 264   StringRef CompilationDir;
 265
 266   // Counter for assigning globally unique IDs for ranges.
 267   unsigned GlobalRangeCount;
 268
 269   // Holder for the file specific debug information.
 270   DwarfFile InfoHolder;
 271
 272   // Holders for the various debug information flags that we might need to
 273   // have exposed. See accessor functions below for description.
 274
 275   // Holder for imported entities.
 276   typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
 277   ImportedEntityMap;
 278   ImportedEntityMap ScopesWithImportedEntities;
 279
 280   // Map from MDNodes for user-defined types to the type units that describe
 281   // them.
 282   DenseMap<const MDNode *, const DwarfTypeUnit *> DwarfTypeUnits;
 283
 284   SmallVector<std::pair<std::unique_ptr<DwarfTypeUnit>, DICompositeType>, 1> TypeUnitsUnderConstruction;
 285
 286   // Whether to emit the pubnames/pubtypes sections.
 287   bool HasDwarfPubSections;
 288
 289   // Whether or not to use AT_ranges for compilation units.
 290   bool HasCURanges;
 291
 292   // Whether we emitted a function into a section other than the default
 293   // text.
 294   bool UsedNonDefaultText;
 295
 296   // Version of dwarf we're emitting.
 297   unsigned DwarfVersion;
 298
 299   // Maps from a type identifier to the actual MDNode.
 300   DITypeIdentifierMap TypeIdentifierMap;
 301
 302   // DWARF5 Experimental Options
 303   bool HasDwarfAccelTables;
 304   bool HasSplitDwarf;
 305
 306   // Separated Dwarf Variables
 307   // In general these will all be for bits that are left in the
 308   // original object file, rather than things that are meant
 309   // to be in the .dwo sections.
 310
 311   // Holder for the skeleton information.
 312   DwarfFile SkeletonHolder;
 313
 314   /// Store file names for type units under fission in a line table header that
 315   /// will be emitted into debug_line.dwo.
 316   // FIXME: replace this with a map from comp_dir to table so that we can emit
 317   // multiple tables during LTO each of which uses directory 0, referencing the
 318   // comp_dir of all the type units that use it.
 319   MCDwarfDwoLineTable SplitTypeUnitFileTable;
 320
 321   // True iff there are multiple CUs in this module.
 322   bool SingleCU;
 323   bool IsDarwin;
 324
 325   AddressPool AddrPool;
 326
 327   DwarfAccelTable AccelNames;
 328   DwarfAccelTable AccelObjC;
 329   DwarfAccelTable AccelNamespace;
 330   DwarfAccelTable AccelTypes;
 331
 332   DenseMap<const Function *, DISubprogram> FunctionDIs;
 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 *getExistingAbstractVariable(const DIVariable &DV,
 344                                            DIVariable &Cleansed);
 345   DbgVariable *getExistingAbstractVariable(const DIVariable &DV);
 346   void createAbstractVariable(const DIVariable &DV, LexicalScope *Scope);
 347   void ensureAbstractVariableIsCreated(const DIVariable &Var,
 348                                        const MDNode *Scope);
 349   void ensureAbstractVariableIsCreatedIfScoped(const DIVariable &Var,
 350                                                const MDNode *Scope);
 351
 352   /// \brief A helper function to check whether the DIE for a given Scope is
 353   /// going to be null.
 354   bool isLexicalScopeDIENull(LexicalScope *Scope);
 355
 356   /// \brief A helper function to construct a RangeSpanList for a given
 357   /// lexical scope.
 358   void addScopeRangeList(DwarfCompileUnit &TheCU, DIE &ScopeDIE,
 359                          const SmallVectorImpl<InsnRange> &Range);
 360
 361   /// \brief Construct new DW_TAG_lexical_block for this scope and
 362   /// attach DW_AT_low_pc/DW_AT_high_pc labels.
 363   std::unique_ptr<DIE> constructLexicalScopeDIE(DwarfCompileUnit &TheCU,
 364                                                 LexicalScope *Scope);
 365
 366   /// \brief This scope represents inlined body of a function. Construct
 367   /// DIE to represent this concrete inlined copy of the function.
 368   std::unique_ptr<DIE> constructInlinedScopeDIE(DwarfCompileUnit &TheCU,
 369                                                 LexicalScope *Scope);
 370
 371   /// \brief Construct a DIE for this scope.
 372   void constructScopeDIE(DwarfCompileUnit &TheCU, LexicalScope *Scope,
 373                          SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren);
 374   DIE *createAndAddScopeChildren(DwarfCompileUnit &TheCU, LexicalScope *Scope,
 375                                  DIE &ScopeDIE);
 376   /// \brief Construct a DIE for this abstract scope.
 377   void constructAbstractSubprogramScopeDIE(DwarfCompileUnit &TheCU,
 378                                            LexicalScope *Scope);
 379   /// \brief Construct a DIE for this subprogram scope.
 380   void constructSubprogramScopeDIE(DwarfCompileUnit &TheCU,
 381                                    LexicalScope *Scope);
 382   /// A helper function to create children of a Scope DIE.
 383   DIE *createScopeChildrenDIE(DwarfCompileUnit &TheCU, LexicalScope *Scope,
 384                               SmallVectorImpl<std::unique_ptr<DIE>> &Children,
 385                               unsigned *ChildScopeCount = nullptr);
 386
 387   /// \brief Emit initial Dwarf sections with a label at the start of each one.
 388   void emitSectionLabels();
 389
 390   /// \brief Compute the size and offset of a DIE given an incoming Offset.
 391   unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
 392
 393   /// \brief Compute the size and offset of all the DIEs.
 394   void computeSizeAndOffsets();
 395
 396   /// \brief Collect info for variables that were optimized out.
 397   void collectDeadVariables();
 398
 399   void finishVariableDefinitions();
 400
 401   void finishSubprogramDefinitions();
 402
 403   /// \brief Finish off debug information after all functions have been
 404   /// processed.
 405   void finalizeModuleInfo();
 406
 407   /// \brief Emit labels to close any remaining sections that have been left
 408   /// open.
 409   void endSections();
 410
 411   /// \brief Emit the debug info section.
 412   void emitDebugInfo();
 413
 414   /// \brief Emit the abbreviation section.
 415   void emitAbbreviations();
 416
 417   /// \brief Emit the last address of the section and the end of
 418   /// the line matrix.
 419   void emitEndOfLineMatrix(unsigned SectionEnd);
 420
 421   /// \brief Emit a specified accelerator table.
 422   void emitAccel(DwarfAccelTable &Accel, const MCSection *Section,
 423                  StringRef TableName, StringRef SymName);
 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 constructAndAddImportedEntityDIE(DwarfCompileUnit &TheCU,
 509                                         const MDNode *N);
 510
 511   /// \brief Register a source line with debug info. Returns the unique
 512   /// label that was emitted and which provides correspondence to the
 513   /// source line list.
 514   void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
 515                         unsigned Flags);
 516
 517   /// \brief Indentify instructions that are marking the beginning of or
 518   /// ending of a scope.
 519   void identifyScopeMarkers();
 520
 521   /// \brief If Var is an current function argument that add it in
 522   /// CurrentFnArguments list.
 523   bool addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope);
 524
 525   /// \brief Populate LexicalScope entries with variables' info.
 526   void collectVariableInfo(SmallPtrSetImpl<const MDNode *> &ProcessedVars);
 527
 528   /// \brief Build the location list for all DBG_VALUEs in the
 529   /// function that describe the same variable.
 530   void buildLocationList(SmallVectorImpl<DebugLocEntry> &DebugLoc,
 531                          const DbgValueHistoryMap::InstrRanges &Ranges);
 532
 533   /// \brief Collect variable information from the side table maintained
 534   /// by MMI.
 535   void collectVariableInfoFromMMITable(SmallPtrSetImpl<const MDNode *> &P);
 536
 537   /// \brief Ensure that a label will be emitted before MI.
 538   void requestLabelBeforeInsn(const MachineInstr *MI) {
 539     LabelsBeforeInsn.insert(std::make_pair(MI, nullptr));
 540   }
 541
 542   /// \brief Return Label preceding the instruction.
 543   MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
 544
 545   /// \brief Ensure that a label will be emitted after MI.
 546   void requestLabelAfterInsn(const MachineInstr *MI) {
 547     LabelsAfterInsn.insert(std::make_pair(MI, nullptr));
 548   }
 549
 550   /// \brief Return Label immediately following the instruction.
 551   MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
 552
 553   void attachRangesOrLowHighPC(DwarfCompileUnit &Unit, DIE &D,
 554                                const SmallVectorImpl<InsnRange> &Ranges);
 555
 556 public:
 557   //===--------------------------------------------------------------------===//
 558   // Main entry points.
 559   //
 560   DwarfDebug(AsmPrinter *A, Module *M);
 561
 562   ~DwarfDebug() override;
 563
 564   void insertDIE(const MDNode *TypeMD, DIE *Die) {
 565     MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
 566   }
 567   DIE *getDIE(const MDNode *TypeMD) {
 568     return MDTypeNodeToDieMap.lookup(TypeMD);
 569   }
 570
 571   /// \brief Emit all Dwarf sections that should come prior to the
 572   /// content.
 573   void beginModule();
 574
 575   /// \brief Emit all Dwarf sections that should come after the content.
 576   void endModule() override;
 577
 578   /// \brief Gather pre-function debug information.
 579   void beginFunction(const MachineFunction *MF) override;
 580
 581   /// \brief Gather and emit post-function debug information.
 582   void endFunction(const MachineFunction *MF) override;
 583
 584   /// \brief Process beginning of an instruction.
 585   void beginInstruction(const MachineInstr *MI) override;
 586
 587   /// \brief Process end of an instruction.
 588   void endInstruction() override;
 589
 590   /// \brief Add a DIE to the set of types that we're going to pull into
 591   /// type units.
 592   void addDwarfTypeUnitType(DwarfCompileUnit &CU, StringRef Identifier,
 593                             DIE &Die, DICompositeType CTy);
 594
 595   /// \brief Add a label so that arange data can be generated for it.
 596   void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
 597
 598   /// \brief For symbols that have a size designated (e.g. common symbols),
 599   /// this tracks that size.
 600   void setSymbolSize(const MCSymbol *Sym, uint64_t Size) override {
 601     SymSize[Sym] = Size;
 602   }
 603
 604   /// \brief Recursively Emits a debug information entry.
 605   void emitDIE(DIE &Die);
 606
 607   // Experimental DWARF5 features.
 608
 609   /// \brief Returns whether or not to emit tables that dwarf consumers can
 610   /// use to accelerate lookup.
 611   bool useDwarfAccelTables() const { return HasDwarfAccelTables; }
 612
 613   /// \brief Returns whether or not to change the current debug info for the
 614   /// split dwarf proposal support.
 615   bool useSplitDwarf() const { return HasSplitDwarf; }
 616
 617   /// Returns the Dwarf Version.
 618   unsigned getDwarfVersion() const { return DwarfVersion; }
 619
 620   /// Returns the section symbol for the .debug_loc section.
 621   MCSymbol *getDebugLocSym() const { return DwarfDebugLocSectionSym; }
 622
 623   /// Returns the section symbol for the .debug_str section.
 624   MCSymbol *getDebugStrSym() const { return DwarfStrSectionSym; }
 625
 626   /// Returns the previous CU that was being updated
 627   const DwarfCompileUnit *getPrevCU() const { return PrevCU; }
 628   void setPrevCU(const DwarfCompileUnit *PrevCU) { this->PrevCU = PrevCU; }
 629
 630   /// Returns the entries for the .debug_loc section.
 631   const SmallVectorImpl<DebugLocList> &
 632   getDebugLocEntries() const {
 633     return DotDebugLocEntries;
 634   }
 635
 636   /// \brief Emit an entry for the debug loc section. This can be used to
 637   /// handle an entry that's going to be emitted into the debug loc section.
 638   void emitDebugLocEntry(ByteStreamer &Streamer, const DebugLocEntry &Entry);
 639   /// \brief emit a single value for the debug loc section.
 640   void emitDebugLocValue(ByteStreamer &Streamer,
 641                          const DebugLocEntry::Value &Value);
 642   /// Emits an optimal (=sorted) sequence of DW_OP_pieces.
 643   void emitLocPieces(ByteStreamer &Streamer,
 644                      const DITypeIdentifierMap &Map,
 645                      ArrayRef<DebugLocEntry::Value> Values);
 646
 647   /// Emit the location for a debug loc entry, including the size header.
 648   void emitDebugLocEntryLocation(const DebugLocEntry &Entry);
 649
 650   /// Find the MDNode for the given reference.
 651   template <typename T> T resolve(DIRef<T> Ref) const {
 652     return Ref.resolve(TypeIdentifierMap);
 653   }
 654
 655   /// \brief Return the TypeIdentifierMap.
 656   const DITypeIdentifierMap &getTypeIdentifierMap() const {
 657     return TypeIdentifierMap;
 658   }
 659
 660   /// Find the DwarfCompileUnit for the given CU Die.
 661   DwarfCompileUnit *lookupUnit(const DIE *CU) const {
 662     return CUDieMap.lookup(CU);
 663   }
 664   /// isSubprogramContext - Return true if Context is either a subprogram
 665   /// or another context nested inside a subprogram.
 666   bool isSubprogramContext(const MDNode *Context);
 667
 668   void addSubprogramNames(DISubprogram SP, DIE &Die);
 669
 670   AddressPool &getAddressPool() { return AddrPool; }
 671
 672   void addAccelName(StringRef Name, const DIE &Die);
 673
 674   void addAccelObjC(StringRef Name, const DIE &Die);
 675
 676   void addAccelNamespace(StringRef Name, const DIE &Die);
 677
 678   void addAccelType(StringRef Name, const DIE &Die, char Flags);
 679
 680   const MachineFunction *getCurrentFunction() const { return CurFn; }
 681   const MCSymbol *getFunctionBeginSym() const { return FunctionBeginSym; }
 682   const MCSymbol *getFunctionEndSym() const { return FunctionEndSym; }
 683 };
 684 } // End of namespace llvm
 685
 686 #endif