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