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