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   DwarfDebug *DD;
 154 public:
 155   // AbsVar may be NULL.
 156   DbgVariable(DIVariable V, DbgVariable *AV, DwarfDebug *DD)
 157     : Var(V), TheDIE(0), DotDebugLocOffset(~0U), AbsVar(AV), MInsn(0),
 158       FrameIndex(~0), DD(DD) {}
 159
 160   // Accessors.
 161   DIVariable getVariable()           const { return Var; }
 162   void setDIE(DIE *D)                      { TheDIE = D; }
 163   DIE *getDIE()                      const { return TheDIE; }
 164   void setDotDebugLocOffset(unsigned O)    { DotDebugLocOffset = O; }
 165   unsigned getDotDebugLocOffset()    const { return DotDebugLocOffset; }
 166   StringRef getName()                const { return Var.getName(); }
 167   DbgVariable *getAbstractVariable() const { return AbsVar; }
 168   const MachineInstr *getMInsn()     const { return MInsn; }
 169   void setMInsn(const MachineInstr *M)     { MInsn = M; }
 170   int getFrameIndex()                const { return FrameIndex; }
 171   void setFrameIndex(int FI)               { FrameIndex = FI; }
 172   // Translate tag to proper Dwarf tag.
 173   uint16_t getTag()                  const {
 174     if (Var.getTag() == dwarf::DW_TAG_arg_variable)
 175       return dwarf::DW_TAG_formal_parameter;
 176
 177     return dwarf::DW_TAG_variable;
 178   }
 179   /// \brief Return true if DbgVariable is artificial.
 180   bool isArtificial()                const {
 181     if (Var.isArtificial())
 182       return true;
 183     if (getType().isArtificial())
 184       return true;
 185     return false;
 186   }
 187
 188   bool isObjectPointer()             const {
 189     if (Var.isObjectPointer())
 190       return true;
 191     if (getType().isObjectPointer())
 192       return true;
 193     return false;
 194   }
 195
 196   bool variableHasComplexAddress()   const {
 197     assert(Var.isVariable() && "Invalid complex DbgVariable!");
 198     return Var.hasComplexAddress();
 199   }
 200   bool isBlockByrefVariable()        const {
 201     assert(Var.isVariable() && "Invalid complex DbgVariable!");
 202     return Var.isBlockByrefVariable();
 203   }
 204   unsigned getNumAddrElements()      const {
 205     assert(Var.isVariable() && "Invalid complex DbgVariable!");
 206     return Var.getNumAddrElements();
 207   }
 208   uint64_t getAddrElement(unsigned i) const {
 209     return Var.getAddrElement(i);
 210   }
 211   DIType getType() const;
 212 };
 213
 214 /// \brief Collects and handles information specific to a particular
 215 /// collection of units.
 216 class DwarfUnits {
 217   // Target of Dwarf emission, used for sizing of abbreviations.
 218   AsmPrinter *Asm;
 219
 220   // Used to uniquely define abbreviations.
 221   FoldingSet<DIEAbbrev> *AbbreviationsSet;
 222
 223   // A list of all the unique abbreviations in use.
 224   std::vector<DIEAbbrev *> *Abbreviations;
 225
 226   // A pointer to all units in the section.
 227   SmallVector<CompileUnit *, 1> CUs;
 228
 229   // Collection of strings for this unit and assorted symbols.
 230   // A String->Symbol mapping of strings used by indirect
 231   // references.
 232   typedef StringMap<std::pair<MCSymbol*, unsigned>,
 233                     BumpPtrAllocator&> StrPool;
 234   StrPool StringPool;
 235   unsigned NextStringPoolNumber;
 236   std::string StringPref;
 237
 238   // Collection of addresses for this unit and assorted labels.
 239   // A Symbol->unsigned mapping of addresses used by indirect
 240   // references.
 241   typedef DenseMap<const MCExpr *, unsigned> AddrPool;
 242   AddrPool AddressPool;
 243   unsigned NextAddrPoolNumber;
 244
 245 public:
 246   DwarfUnits(AsmPrinter *AP, FoldingSet<DIEAbbrev> *AS,
 247              std::vector<DIEAbbrev *> *A, const char *Pref,
 248              BumpPtrAllocator &DA)
 249       : Asm(AP), AbbreviationsSet(AS), Abbreviations(A), StringPool(DA),
 250         NextStringPoolNumber(0), StringPref(Pref), AddressPool(),
 251         NextAddrPoolNumber(0) {}
 252
 253   /// \brief Compute the size and offset of a DIE given an incoming Offset.
 254   unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
 255
 256   /// \brief Compute the size and offset of all the DIEs.
 257   void computeSizeAndOffsets();
 258
 259   /// \brief Define a unique number for the abbreviation.
 260   void assignAbbrevNumber(DIEAbbrev &Abbrev);
 261
 262   /// \brief Add a unit to the list of CUs.
 263   void addUnit(CompileUnit *CU) { CUs.push_back(CU); }
 264
 265   /// \brief Emit all of the units to the section listed with the given
 266   /// abbreviation section.
 267   void emitUnits(DwarfDebug *DD, const MCSection *USection,
 268                  const MCSection *ASection, const MCSymbol *ASectionSym);
 269
 270   /// \brief Emit all of the strings to the section given.
 271   void emitStrings(const MCSection *StrSection, const MCSection *OffsetSection,
 272                    const MCSymbol *StrSecSym);
 273
 274   /// \brief Emit all of the addresses to the section given.
 275   void emitAddresses(const MCSection *AddrSection);
 276
 277   /// \brief Returns the entry into the start of the pool.
 278   MCSymbol *getStringPoolSym();
 279
 280   /// \brief Returns an entry into the string pool with the given
 281   /// string text.
 282   MCSymbol *getStringPoolEntry(StringRef Str);
 283
 284   /// \brief Returns the index into the string pool with the given
 285   /// string text.
 286   unsigned getStringPoolIndex(StringRef Str);
 287
 288   /// \brief Returns the string pool.
 289   StrPool *getStringPool() { return &StringPool; }
 290
 291   /// \brief Returns the index into the address pool with the given
 292   /// label/symbol.
 293   unsigned getAddrPoolIndex(const MCExpr *Sym);
 294   unsigned getAddrPoolIndex(const MCSymbol *Sym);
 295
 296   /// \brief Returns the address pool.
 297   AddrPool *getAddrPool() { return &AddressPool; }
 298
 299   /// \brief for a given compile unit DIE, returns offset from beginning of
 300   /// debug info.
 301   unsigned getCUOffset(DIE *Die);
 302 };
 303
 304 /// \brief Helper used to pair up a symbol and it's DWARF compile unit.
 305 struct SymbolCU {
 306   SymbolCU(CompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(CU) {}
 307   const MCSymbol *Sym;
 308   CompileUnit *CU;
 309 };
 310
 311 /// \brief Collects and handles dwarf debug information.
 312 class DwarfDebug {
 313   // Target of Dwarf emission.
 314   AsmPrinter *Asm;
 315
 316   // Collected machine module information.
 317   MachineModuleInfo *MMI;
 318
 319   // All DIEValues are allocated through this allocator.
 320   BumpPtrAllocator DIEValueAllocator;
 321
 322   // Handle to the a compile unit used for the inline extension handling.
 323   CompileUnit *FirstCU;
 324
 325   // Maps MDNode with its corresponding CompileUnit.
 326   DenseMap <const MDNode *, CompileUnit *> CUMap;
 327
 328   // Maps subprogram MDNode with its corresponding CompileUnit.
 329   DenseMap <const MDNode *, CompileUnit *> SPMap;
 330
 331   /// Maps type MDNode with its corresponding DIE. These DIEs can be
 332   /// shared across CUs, that is why we keep the map here instead
 333   /// of in CompileUnit.
 334   DenseMap<const MDNode *, DIE *> MDTypeNodeToDieMap;
 335   /// Maps subprogram MDNode with its corresponding DIE.
 336   DenseMap<const MDNode *, DIE *> MDSPNodeToDieMap;
 337   /// Maps static member MDNode with its corresponding DIE.
 338   DenseMap<const MDNode *, DIE *> MDStaticMemberNodeToDieMap;
 339
 340   /// Specifies a worklist item. Sometimes, when we try to add an attribute to
 341   /// a DIE, the DIE is not yet added to its owner yet, so we don't know whether
 342   /// we should use ref_addr or ref4. We create a worklist that will be
 343   /// processed during finalization to add attributes with the correct form
 344   /// (ref_addr or ref4).
 345   struct DIEEntryWorkItem {
 346     DIE *Die;
 347     uint16_t Attribute;
 348     DIEEntry *Entry;
 349     DIEEntryWorkItem(DIE *D, uint16_t A, DIEEntry *E) :
 350       Die(D), Attribute(A), Entry(E) {
 351     }
 352   };
 353   SmallVector<DIEEntryWorkItem, 64> DIEEntryWorklist;
 354
 355   // Used to uniquely define abbreviations.
 356   FoldingSet<DIEAbbrev> AbbreviationsSet;
 357
 358   // A list of all the unique abbreviations in use.
 359   std::vector<DIEAbbrev *> Abbreviations;
 360
 361   // Stores the current file ID for a given compile unit.
 362   DenseMap <unsigned, unsigned> FileIDCUMap;
 363   // Source id map, i.e. CUID, source filename and directory,
 364   // separated by a zero byte, mapped to a unique id.
 365   StringMap<unsigned, BumpPtrAllocator&> SourceIdMap;
 366
 367   // List of all labels used in aranges generation.
 368   std::vector<SymbolCU> ArangeLabels;
 369
 370   // Size of each symbol emitted (for those symbols that have a specific size).
 371   DenseMap <const MCSymbol *, uint64_t> SymSize;
 372
 373   // Provides a unique id per text section.
 374   typedef DenseMap<const MCSection *, SmallVector<SymbolCU, 8> > SectionMapType;
 375   SectionMapType SectionMap;
 376
 377   // List of arguments for current function.
 378   SmallVector<DbgVariable *, 8> CurrentFnArguments;
 379
 380   LexicalScopes LScopes;
 381
 382   // Collection of abstract subprogram DIEs.
 383   DenseMap<const MDNode *, DIE *> AbstractSPDies;
 384
 385   // Collection of dbg variables of a scope.
 386   typedef DenseMap<LexicalScope *,
 387                    SmallVector<DbgVariable *, 8> > ScopeVariablesMap;
 388   ScopeVariablesMap ScopeVariables;
 389
 390   // Collection of abstract variables.
 391   DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
 392
 393   // Collection of DotDebugLocEntry.
 394   SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
 395
 396   // Collection of subprogram DIEs that are marked (at the end of the module)
 397   // as DW_AT_inline.
 398   SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
 399
 400   // This is a collection of subprogram MDNodes that are processed to
 401   // create DIEs.
 402   SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
 403
 404   // Maps instruction with label emitted before instruction.
 405   DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
 406
 407   // Maps instruction with label emitted after instruction.
 408   DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
 409
 410   // Every user variable mentioned by a DBG_VALUE instruction in order of
 411   // appearance.
 412   SmallVector<const MDNode*, 8> UserVariables;
 413
 414   // For each user variable, keep a list of DBG_VALUE instructions in order.
 415   // The list can also contain normal instructions that clobber the previous
 416   // DBG_VALUE.
 417   typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
 418     DbgValueHistoryMap;
 419   DbgValueHistoryMap DbgValues;
 420
 421   SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
 422
 423   // Previous instruction's location information. This is used to determine
 424   // label location to indicate scope boundries in dwarf debug info.
 425   DebugLoc PrevInstLoc;
 426   MCSymbol *PrevLabel;
 427
 428   // This location indicates end of function prologue and beginning of function
 429   // body.
 430   DebugLoc PrologEndLoc;
 431
 432   // Section Symbols: these are assembler temporary labels that are emitted at
 433   // the beginning of each supported dwarf section.  These are used to form
 434   // section offsets and are created by EmitSectionLabels.
 435   MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
 436   MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
 437   MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
 438   MCSymbol *FunctionBeginSym, *FunctionEndSym;
 439   MCSymbol *DwarfAbbrevDWOSectionSym, *DwarfStrDWOSectionSym;
 440   MCSymbol *DwarfGnuPubNamesSectionSym, *DwarfGnuPubTypesSectionSym;
 441
 442   // As an optimization, there is no need to emit an entry in the directory
 443   // table for the same directory as DW_AT_comp_dir.
 444   StringRef CompilationDir;
 445
 446   // Counter for assigning globally unique IDs for CUs.
 447   unsigned GlobalCUIndexCount;
 448
 449   // Holder for the file specific debug information.
 450   DwarfUnits InfoHolder;
 451
 452   // Holders for the various debug information flags that we might need to
 453   // have exposed. See accessor functions below for description.
 454
 455   // Whether or not we're emitting info for older versions of gdb on darwin.
 456   bool IsDarwinGDBCompat;
 457
 458   // Holder for imported entities.
 459   typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
 460     ImportedEntityMap;
 461   ImportedEntityMap ScopesWithImportedEntities;
 462
 463   // Holder for types that are going to be extracted out into a type unit.
 464   std::vector<DIE *> TypeUnits;
 465
 466   // Whether to emit the pubnames/pubtypes sections.
 467   bool HasDwarfPubSections;
 468
 469   // Version of dwarf we're emitting.
 470   unsigned DwarfVersion;
 471
 472   // DWARF5 Experimental Options
 473   bool HasDwarfAccelTables;
 474   bool HasSplitDwarf;
 475
 476   // Separated Dwarf Variables
 477   // In general these will all be for bits that are left in the
 478   // original object file, rather than things that are meant
 479   // to be in the .dwo sections.
 480
 481   // The CUs left in the original object file for separated debug info.
 482   SmallVector<CompileUnit *, 1> SkeletonCUs;
 483
 484   // Used to uniquely define abbreviations for the skeleton emission.
 485   FoldingSet<DIEAbbrev> SkeletonAbbrevSet;
 486
 487   // A list of all the unique abbreviations in use.
 488   std::vector<DIEAbbrev *> SkeletonAbbrevs;
 489
 490   // Holder for the skeleton information.
 491   DwarfUnits SkeletonHolder;
 492
 493   // Maps from a type identifier to the actual MDNode.
 494   DITypeIdentifierMap TypeIdentifierMap;
 495
 496 private:
 497
 498   void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
 499
 500   /// \brief Find abstract variable associated with Var.
 501   DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
 502
 503   /// \brief Find DIE for the given subprogram and attach appropriate
 504   /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
 505   /// variables in this scope then create and insert DIEs for these
 506   /// variables.
 507   DIE *updateSubprogramScopeDIE(CompileUnit *SPCU, const MDNode *SPNode);
 508
 509   /// \brief Construct new DW_TAG_lexical_block for this scope and
 510   /// attach DW_AT_low_pc/DW_AT_high_pc labels.
 511   DIE *constructLexicalScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
 512   /// A helper function to check whether the DIE for a given Scope is going
 513   /// to be null.
 514   bool isLexicalScopeDIENull(LexicalScope *Scope);
 515
 516   /// \brief This scope represents inlined body of a function. Construct
 517   /// DIE to represent this concrete inlined copy of the function.
 518   DIE *constructInlinedScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
 519
 520   /// \brief Construct a DIE for this scope.
 521   DIE *constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
 522   /// A helper function to create children of a Scope DIE.
 523   DIE *createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
 524                               SmallVectorImpl<DIE*> &Children);
 525
 526   /// \brief Emit initial Dwarf sections with a label at the start of each one.
 527   void emitSectionLabels();
 528
 529   /// \brief Compute the size and offset of a DIE given an incoming Offset.
 530   unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
 531
 532   /// \brief Compute the size and offset of all the DIEs.
 533   void computeSizeAndOffsets();
 534
 535   /// \brief Attach DW_AT_inline attribute with inlined subprogram DIEs.
 536   void computeInlinedDIEs();
 537
 538   /// \brief Collect info for variables that were optimized out.
 539   void collectDeadVariables();
 540
 541   /// \brief Finish off debug information after all functions have been
 542   /// processed.
 543   void finalizeModuleInfo();
 544
 545   /// \brief Emit labels to close any remaining sections that have been left
 546   /// open.
 547   void endSections();
 548
 549   /// \brief Emit a set of abbreviations to the specific section.
 550   void emitAbbrevs(const MCSection *, std::vector<DIEAbbrev*> *);
 551
 552   /// \brief Emit the debug info section.
 553   void emitDebugInfo();
 554
 555   /// \brief Emit the abbreviation section.
 556   void emitAbbreviations();
 557
 558   /// \brief Emit the last address of the section and the end of
 559   /// the line matrix.
 560   void emitEndOfLineMatrix(unsigned SectionEnd);
 561
 562   /// \brief Emit visible names into a hashed accelerator table section.
 563   void emitAccelNames();
 564
 565   /// \brief Emit objective C classes and categories into a hashed
 566   /// accelerator table section.
 567   void emitAccelObjC();
 568
 569   /// \brief Emit namespace dies into a hashed accelerator table.
 570   void emitAccelNamespaces();
 571
 572   /// \brief Emit type dies into a hashed accelerator table.
 573   void emitAccelTypes();
 574
 575   /// \brief Emit visible names into a debug pubnames section.
 576   /// \param GnuStyle determines whether or not we want to emit
 577   /// additional information into the table ala newer gcc for gdb
 578   /// index.
 579   void emitDebugPubNames(bool GnuStyle = false);
 580
 581   /// \brief Emit visible types into a debug pubtypes section.
 582   /// \param GnuStyle determines whether or not we want to emit
 583   /// additional information into the table ala newer gcc for gdb
 584   /// index.
 585   void emitDebugPubTypes(bool GnuStyle = false);
 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 visible names into a debug macinfo section.
 600   void emitDebugMacInfo();
 601
 602   /// \brief Emit inline info using custom format.
 603   void emitDebugInlineInfo();
 604
 605   /// DWARF 5 Experimental Split Dwarf Emitters
 606
 607   /// \brief Construct the split debug info compile unit for the debug info
 608   /// section.
 609   CompileUnit *constructSkeletonCU(const CompileUnit *CU);
 610
 611   /// \brief Emit the local split abbreviations.
 612   void emitSkeletonAbbrevs(const MCSection *);
 613
 614   /// \brief Emit the debug info dwo section.
 615   void emitDebugInfoDWO();
 616
 617   /// \brief Emit the debug abbrev dwo section.
 618   void emitDebugAbbrevDWO();
 619
 620   /// \brief Emit the debug str dwo section.
 621   void emitDebugStrDWO();
 622
 623   /// \brief Create new CompileUnit for the given metadata node with tag
 624   /// DW_TAG_compile_unit.
 625   CompileUnit *constructCompileUnit(const MDNode *N);
 626
 627   /// \brief Construct subprogram DIE.
 628   void constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N);
 629
 630   /// \brief Construct imported_module or imported_declaration DIE.
 631   void constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N);
 632
 633   /// \brief Construct import_module DIE.
 634   void constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
 635                                   DIE *Context);
 636
 637   /// \brief Construct import_module DIE.
 638   void constructImportedEntityDIE(CompileUnit *TheCU,
 639                                   const DIImportedEntity &Module,
 640                                   DIE *Context);
 641
 642   /// \brief Register a source line with debug info. Returns the unique
 643   /// label that was emitted and which provides correspondence to the
 644   /// source line list.
 645   void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
 646                         unsigned Flags);
 647
 648   /// \brief Indentify instructions that are marking the beginning of or
 649   /// ending of a scope.
 650   void identifyScopeMarkers();
 651
 652   /// \brief If Var is an current function argument that add it in
 653   /// CurrentFnArguments list.
 654   bool addCurrentFnArgument(const MachineFunction *MF,
 655                             DbgVariable *Var, LexicalScope *Scope);
 656
 657   /// \brief Populate LexicalScope entries with variables' info.
 658   void collectVariableInfo(const MachineFunction *,
 659                            SmallPtrSet<const MDNode *, 16> &ProcessedVars);
 660
 661   /// \brief Collect variable information from the side table maintained
 662   /// by MMI.
 663   void collectVariableInfoFromMMITable(const MachineFunction * MF,
 664                                        SmallPtrSet<const MDNode *, 16> &P);
 665
 666   /// \brief Ensure that a label will be emitted before MI.
 667   void requestLabelBeforeInsn(const MachineInstr *MI) {
 668     LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
 669   }
 670
 671   /// \brief Return Label preceding the instruction.
 672   MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
 673
 674   /// \brief Ensure that a label will be emitted after MI.
 675   void requestLabelAfterInsn(const MachineInstr *MI) {
 676     LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
 677   }
 678
 679   /// \brief Return Label immediately following the instruction.
 680   MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
 681
 682 public:
 683   //===--------------------------------------------------------------------===//
 684   // Main entry points.
 685   //
 686   DwarfDebug(AsmPrinter *A, Module *M);
 687   ~DwarfDebug();
 688
 689   void insertTypeDIE(const MDNode *TypeMD, DIE *Die) {
 690     MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
 691   }
 692   DIE *getTypeDIE(const MDNode *TypeMD) {
 693     return MDTypeNodeToDieMap.lookup(TypeMD);
 694   }
 695   void insertSPDIE(const MDNode *SPMD, DIE *Die) {
 696     MDSPNodeToDieMap.insert(std::make_pair(SPMD, Die));
 697   }
 698   DIE *getSPDIE(const MDNode *SPMD) {
 699     return MDSPNodeToDieMap.lookup(SPMD);
 700   }
 701   void insertStaticMemberDIE(const MDNode *StaticMD, DIE *Die) {
 702     MDStaticMemberNodeToDieMap.insert(std::make_pair(StaticMD, Die));
 703   }
 704   DIE *getStaticMemberDIE(const MDNode *StaticMD) {
 705     return MDStaticMemberNodeToDieMap.lookup(StaticMD);
 706   }
 707   void insertDIEEntryWorklist(DIE *Die, uint16_t Attribute, DIEEntry *Entry) {
 708     DIEEntryWorklist.push_back(DIEEntryWorkItem(Die, Attribute, Entry));
 709   }
 710
 711   /// \brief Emit all Dwarf sections that should come prior to the
 712   /// content.
 713   void beginModule();
 714
 715   /// \brief Emit all Dwarf sections that should come after the content.
 716   void endModule();
 717
 718   /// \brief Gather pre-function debug information.
 719   void beginFunction(const MachineFunction *MF);
 720
 721   /// \brief Gather and emit post-function debug information.
 722   void endFunction(const MachineFunction *MF);
 723
 724   /// \brief Process beginning of an instruction.
 725   void beginInstruction(const MachineInstr *MI);
 726
 727   /// \brief Process end of an instruction.
 728   void endInstruction(const MachineInstr *MI);
 729
 730   /// \brief Add a DIE to the set of types that we're going to pull into
 731   /// type units.
 732   void addTypeUnitType(DIE *Die) { TypeUnits.push_back(Die); }
 733
 734   /// \brief Add a label so that arange data can be generated for it.
 735   void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
 736
 737   /// \brief For symbols that have a size designated (e.g. common symbols),
 738   /// this tracks that size.
 739   void setSymbolSize(const MCSymbol *Sym, uint64_t Size) { SymSize[Sym] = Size;}
 740
 741   /// \brief Look up the source id with the given directory and source file
 742   /// names. If none currently exists, create a new id and insert it in the
 743   /// SourceIds map.
 744   unsigned getOrCreateSourceID(StringRef DirName, StringRef FullName,
 745                                unsigned CUID);
 746
 747   /// \brief Recursively Emits a debug information entry.
 748   void emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs);
 749
 750   /// \brief Returns whether or not to limit some of our debug
 751   /// output to the limitations of darwin gdb.
 752   bool useDarwinGDBCompat() { return IsDarwinGDBCompat; }
 753
 754   // Experimental DWARF5 features.
 755
 756   /// \brief Returns whether or not to emit tables that dwarf consumers can
 757   /// use to accelerate lookup.
 758   bool useDwarfAccelTables() { return HasDwarfAccelTables; }
 759
 760   /// \brief Returns whether or not to change the current debug info for the
 761   /// split dwarf proposal support.
 762   bool useSplitDwarf() { return HasSplitDwarf; }
 763
 764   /// Returns the Dwarf Version.
 765   unsigned getDwarfVersion() const { return DwarfVersion; }
 766
 767   /// Find the MDNode for the given scope reference.
 768   template <typename T>
 769   T resolve(DIRef<T> Ref) const {
 770     return Ref.resolve(TypeIdentifierMap);
 771   }
 772
 773   /// When we don't know whether the correct form is ref4 or ref_addr, we create
 774   /// a worklist item and insert it to DIEEntryWorklist.
 775   void addDIEEntry(DIE *Die, uint16_t Attribute, uint16_t Form,
 776                    DIEEntry *Entry);
 777
 778   /// isSubprogramContext - Return true if Context is either a subprogram
 779   /// or another context nested inside a subprogram.
 780   bool isSubprogramContext(const MDNode *Context);
 781
 782 };
 783 } // End of namespace llvm
 784
 785 #endif