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