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