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