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 "llvm/CodeGen/AsmPrinter.h"
  18 #include "llvm/CodeGen/MachineLocation.h"
  19 #include "llvm/Analysis/DebugInfo.h"
  20 #include "DIE.h"
  21 #include "llvm/ADT/DenseMap.h"
  22 #include "llvm/ADT/FoldingSet.h"
  23 #include "llvm/ADT/SmallPtrSet.h"
  24 #include "llvm/ADT/StringMap.h"
  25 #include "llvm/ADT/UniqueVector.h"
  26 #include "llvm/Support/Allocator.h"
  27 #include "llvm/Support/DebugLoc.h"
  28
  29 namespace llvm {
  30
  31 class CompileUnit;
  32 class DbgConcreteScope;
  33 class DbgScope;
  34 class DbgVariable;
  35 class MachineFrameInfo;
  36 class MachineModuleInfo;
  37 class MachineOperand;
  38 class MCAsmInfo;
  39 class DIEAbbrev;
  40 class DIE;
  41 class DIEBlock;
  42 class DIEEntry;
  43
  44 //===----------------------------------------------------------------------===//
  45 /// SrcLineInfo - This class is used to record source line correspondence.
  46 ///
  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 /// DotDebugLocEntry - This struct describes location entries emitted in
  64 /// .debug_loc 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   int64_t iConstant;
  73   DotDebugLocEntry()
  74     : Begin(0), End(0), Variable(0), Merged(false),
  75       Constant(false), iConstant(0) {}
  76   DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, MachineLocation &L,
  77                    const MDNode *V)
  78     : Begin(B), End(E), Loc(L), Variable(V), Merged(false),
  79       Constant(false), iConstant(0) {}
  80   DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, int64_t i)
  81     : Begin(B), End(E), Variable(0), Merged(false),
  82       Constant(true), iConstant(i) {}
  83
  84   /// Empty entries are also used as a trigger to emit temp label. Such
  85   /// labels are referenced is used to find debug_loc offset for a given DIE.
  86   bool isEmpty() { return Begin == 0 && End == 0; }
  87   bool isMerged() { return Merged; }
  88   void Merge(DotDebugLocEntry *Next) {
  89     if (!(Begin && Loc == Next->Loc && End == Next->Begin))
  90       return;
  91     Next->Begin = Begin;
  92     Merged = true;
  93   }
  94   bool isConstant() { return Constant; }
  95   int64_t getConstant() { return iConstant; }
  96 } DotDebugLocEntry;
  97
  98 //===----------------------------------------------------------------------===//
  99 /// DbgVariable - This class is used to track local variable information.
 100 ///
 101 class DbgVariable {
 102   DIVariable Var;                    // Variable Descriptor.
 103   DIE *TheDIE;                       // Variable DIE.
 104   unsigned DotDebugLocOffset;        // Offset in DotDebugLocEntries.
 105 public:
 106   // AbsVar may be NULL.
 107   DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
 108
 109   // Accessors.
 110   DIVariable getVariable()           const { return Var; }
 111   void setDIE(DIE *D)                      { TheDIE = D; }
 112   DIE *getDIE()                      const { return TheDIE; }
 113   void setDotDebugLocOffset(unsigned O)    { DotDebugLocOffset = O; }
 114   unsigned getDotDebugLocOffset()    const { return DotDebugLocOffset; }
 115   StringRef getName()                const { return Var.getName(); }
 116   unsigned getTag()                  const { return Var.getTag(); }
 117   bool variableHasComplexAddress()   const {
 118     assert(Var.Verify() && "Invalid complex DbgVariable!");
 119     return Var.hasComplexAddress();
 120   }
 121   bool isBlockByrefVariable()        const {
 122     assert(Var.Verify() && "Invalid complex DbgVariable!");
 123     return Var.isBlockByrefVariable();
 124   }
 125   unsigned getNumAddrElements()      const {
 126     assert(Var.Verify() && "Invalid complex DbgVariable!");
 127     return Var.getNumAddrElements();
 128   }
 129   uint64_t getAddrElement(unsigned i) const {
 130     return Var.getAddrElement(i);
 131   }
 132   DIType getType() const;
 133 };
 134
 135 class DwarfDebug {
 136   /// Asm - Target of Dwarf emission.
 137   AsmPrinter *Asm;
 138
 139   /// MMI - Collected machine module information.
 140   MachineModuleInfo *MMI;
 141
 142   //===--------------------------------------------------------------------===//
 143   // Attributes used to construct specific Dwarf sections.
 144   //
 145
 146   CompileUnit *FirstCU;
 147   DenseMap <const MDNode *, CompileUnit *> CUMap;
 148
 149   /// AbbreviationsSet - Used to uniquely define abbreviations.
 150   ///
 151   FoldingSet<DIEAbbrev> AbbreviationsSet;
 152
 153   /// Abbreviations - A list of all the unique abbreviations in use.
 154   ///
 155   std::vector<DIEAbbrev *> Abbreviations;
 156
 157   /// SourceIdMap - Source id map, i.e. pair of directory id and source file
 158   /// id mapped to a unique id.
 159   StringMap<unsigned> SourceIdMap;
 160
 161   /// StringPool - A String->Symbol mapping of strings used by indirect
 162   /// references.
 163   StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
 164   unsigned NextStringPoolNumber;
 165
 166   MCSymbol *getStringPoolEntry(StringRef Str);
 167
 168   /// SectionMap - Provides a unique id per text section.
 169   ///
 170   UniqueVector<const MCSection*> SectionMap;
 171
 172   /// CurrentFnDbgScope - Top level scope for the current function.
 173   ///
 174   DbgScope *CurrentFnDbgScope;
 175
 176   /// CurrentFnArguments - List of Arguments (DbgValues) for current function.
 177   SmallVector<DbgVariable *, 8> CurrentFnArguments;
 178
 179   /// DbgScopeMap - Tracks the scopes in the current function.  Owns the
 180   /// contained DbgScope*s.
 181   ///
 182   DenseMap<const MDNode *, DbgScope *> DbgScopeMap;
 183
 184   /// ConcreteScopes - Tracks the concrete scopees in the current function.
 185   /// These scopes are also included in DbgScopeMap.
 186   DenseMap<const MDNode *, DbgScope *> ConcreteScopes;
 187
 188   /// AbstractScopes - Tracks the abstract scopes a module. These scopes are
 189   /// not included DbgScopeMap.  AbstractScopes owns its DbgScope*s.
 190   DenseMap<const MDNode *, DbgScope *> AbstractScopes;
 191
 192   /// AbstractSPDies - Collection of abstract subprogram DIEs.
 193   DenseMap<const MDNode *, DIE *> AbstractSPDies;
 194
 195   /// AbstractScopesList - Tracks abstract scopes constructed while processing
 196   /// a function. This list is cleared during endFunction().
 197   SmallVector<DbgScope *, 4>AbstractScopesList;
 198
 199   /// AbstractVariables - Collection on abstract variables.  Owned by the
 200   /// DbgScopes in AbstractScopes.
 201   DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
 202
 203   /// DbgVariableToFrameIndexMap - Tracks frame index used to find
 204   /// variable's value.
 205   DenseMap<const DbgVariable *, int> DbgVariableToFrameIndexMap;
 206
 207   /// DbgVariableToDbgInstMap - Maps DbgVariable to corresponding DBG_VALUE
 208   /// machine instruction.
 209   DenseMap<const DbgVariable *, const MachineInstr *> DbgVariableToDbgInstMap;
 210
 211   /// DotDebugLocEntries - Collection of DotDebugLocEntry.
 212   SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
 213
 214   /// UseDotDebugLocEntry - DW_AT_location attributes for the DIEs in this set
 215   /// idetifies corresponding .debug_loc entry offset.
 216   SmallPtrSet<const DIE *, 4> UseDotDebugLocEntry;
 217
 218   /// VarToAbstractVarMap - Maps DbgVariable with corresponding Abstract
 219   /// DbgVariable, if any.
 220   DenseMap<const DbgVariable *, const DbgVariable *> VarToAbstractVarMap;
 221
 222   /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked
 223   /// (at the end of the module) as DW_AT_inline.
 224   SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
 225
 226   /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
 227   /// need DW_AT_containing_type attribute. This attribute points to a DIE that
 228   /// corresponds to the MDNode mapped with the subprogram DIE.
 229   DenseMap<DIE *, const MDNode *> ContainingTypeMap;
 230
 231   /// InlineInfo - Keep track of inlined functions and their location.  This
 232   /// information is used to populate debug_inlined section.
 233   typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
 234   DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
 235   SmallVector<const MDNode *, 4> InlinedSPNodes;
 236
 237   // ProcessedSPNodes - This is a collection of subprogram MDNodes that
 238   // are processed to create DIEs.
 239   SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
 240
 241   /// LabelsBeforeInsn - Maps instruction with label emitted before
 242   /// instruction.
 243   DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
 244
 245   /// LabelsAfterInsn - Maps instruction with label emitted after
 246   /// instruction.
 247   DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
 248
 249   /// UserVariables - Every user variable mentioned by a DBG_VALUE instruction
 250   /// in order of appearance.
 251   SmallVector<const MDNode*, 8> UserVariables;
 252
 253   /// DbgValues - For each user variable, keep a list of DBG_VALUE
 254   /// instructions in order. The list can also contain normal instructions that
 255   /// clobber the previous DBG_VALUE.
 256   typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
 257     DbgValueHistoryMap;
 258   DbgValueHistoryMap DbgValues;
 259
 260   SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
 261
 262   /// Previous instruction's location information. This is used to determine
 263   /// label location to indicate scope boundries in dwarf debug info.
 264   DebugLoc PrevInstLoc;
 265   MCSymbol *PrevLabel;
 266
 267   /// PrologEndLoc - This location indicates end of function prologue and
 268   /// beginning of function body.
 269   DebugLoc PrologEndLoc;
 270
 271   struct FunctionDebugFrameInfo {
 272     unsigned Number;
 273     std::vector<MachineMove> Moves;
 274
 275     FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
 276       : Number(Num), Moves(M) {}
 277   };
 278
 279   std::vector<FunctionDebugFrameInfo> DebugFrames;
 280
 281   // DIEValueAllocator - All DIEValues are allocated through this allocator.
 282   BumpPtrAllocator DIEValueAllocator;
 283
 284   // Section Symbols: these are assembler temporary labels that are emitted at
 285   // the beginning of each supported dwarf section.  These are used to form
 286   // section offsets and are created by EmitSectionLabels.
 287   MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
 288   MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
 289   MCSymbol *DwarfDebugLocSectionSym;
 290   MCSymbol *FunctionBeginSym, *FunctionEndSym;
 291
 292 private:
 293
 294   /// assignAbbrevNumber - Define a unique number for the abbreviation.
 295   ///
 296   void assignAbbrevNumber(DIEAbbrev &Abbrev);
 297
 298   /// getOrCreateDbgScope - Create DbgScope for the scope.
 299   DbgScope *getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt);
 300
 301   DbgScope *getOrCreateAbstractScope(const MDNode *N);
 302
 303   /// findAbstractVariable - Find abstract variable associated with Var.
 304   DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
 305
 306   /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
 307   /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
 308   /// If there are global variables in this scope then create and insert
 309   /// DIEs for these variables.
 310   DIE *updateSubprogramScopeDIE(const MDNode *SPNode);
 311
 312   /// constructLexicalScope - Construct new DW_TAG_lexical_block
 313   /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
 314   DIE *constructLexicalScopeDIE(DbgScope *Scope);
 315
 316   /// constructInlinedScopeDIE - This scope represents inlined body of
 317   /// a function. Construct DIE to represent this concrete inlined copy
 318   /// of the function.
 319   DIE *constructInlinedScopeDIE(DbgScope *Scope);
 320
 321   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 322   DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
 323
 324   /// constructScopeDIE - Construct a DIE for this scope.
 325   DIE *constructScopeDIE(DbgScope *Scope);
 326
 327   /// EmitSectionLabels - Emit initial Dwarf sections with a label at
 328   /// the start of each one.
 329   void EmitSectionLabels();
 330
 331   /// emitDIE - Recusively Emits a debug information entry.
 332   ///
 333   void emitDIE(DIE *Die);
 334
 335   /// computeSizeAndOffset - Compute the size and offset of a DIE.
 336   ///
 337   unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
 338
 339   /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
 340   ///
 341   void computeSizeAndOffsets();
 342
 343   /// EmitDebugInfo - Emit the debug info section.
 344   ///
 345   void emitDebugInfo();
 346
 347   /// emitAbbreviations - Emit the abbreviation section.
 348   ///
 349   void emitAbbreviations() const;
 350
 351   /// emitEndOfLineMatrix - Emit the last address of the section and the end of
 352   /// the line matrix.
 353   ///
 354   void emitEndOfLineMatrix(unsigned SectionEnd);
 355
 356   /// emitDebugPubNames - Emit visible names into a debug pubnames section.
 357   ///
 358   void emitDebugPubNames();
 359
 360   /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
 361   ///
 362   void emitDebugPubTypes();
 363
 364   /// emitDebugStr - Emit visible names into a debug str section.
 365   ///
 366   void emitDebugStr();
 367
 368   /// emitDebugLoc - Emit visible names into a debug loc section.
 369   ///
 370   void emitDebugLoc();
 371
 372   /// EmitDebugARanges - Emit visible names into a debug aranges section.
 373   ///
 374   void EmitDebugARanges();
 375
 376   /// emitDebugRanges - Emit visible names into a debug ranges section.
 377   ///
 378   void emitDebugRanges();
 379
 380   /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
 381   ///
 382   void emitDebugMacInfo();
 383
 384   /// emitDebugInlineInfo - Emit inline info using following format.
 385   /// Section Header:
 386   /// 1. length of section
 387   /// 2. Dwarf version number
 388   /// 3. address size.
 389   ///
 390   /// Entries (one "entry" for each function that was inlined):
 391   ///
 392   /// 1. offset into __debug_str section for MIPS linkage name, if exists;
 393   ///   otherwise offset into __debug_str for regular function name.
 394   /// 2. offset into __debug_str section for regular function name.
 395   /// 3. an unsigned LEB128 number indicating the number of distinct inlining
 396   /// instances for the function.
 397   ///
 398   /// The rest of the entry consists of a {die_offset, low_pc}  pair for each
 399   /// inlined instance; the die_offset points to the inlined_subroutine die in
 400   /// the __debug_info section, and the low_pc is the starting address  for the
 401   ///  inlining instance.
 402   void emitDebugInlineInfo();
 403
 404   /// constructCompileUnit - Create new CompileUnit for the given
 405   /// metadata node with tag DW_TAG_compile_unit.
 406   void constructCompileUnit(const MDNode *N);
 407
 408   /// getCompielUnit - Get CompileUnit DIE.
 409   CompileUnit *getCompileUnit(const MDNode *N) const;
 410
 411   /// constructGlobalVariableDIE - Construct global variable DIE.
 412   void constructGlobalVariableDIE(const MDNode *N);
 413
 414   /// construct SubprogramDIE - Construct subprogram DIE.
 415   void constructSubprogramDIE(const MDNode *N);
 416
 417   /// recordSourceLine - Register a source line with debug info. Returns the
 418   /// unique label that was emitted and which provides correspondence to
 419   /// the source line list.
 420   void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
 421                         unsigned Flags);
 422
 423   /// recordVariableFrameIndex - Record a variable's index.
 424   void recordVariableFrameIndex(const DbgVariable *V, int Index);
 425
 426   /// findVariableFrameIndex - Return true if frame index for the variable
 427   /// is found. Update FI to hold value of the index.
 428   bool findVariableFrameIndex(const DbgVariable *V, int *FI);
 429
 430   /// findDbgScope - Find DbgScope for the debug loc attached with an
 431   /// instruction.
 432   DbgScope *findDbgScope(const MachineInstr *MI);
 433
 434   /// identifyScopeMarkers() - Indentify instructions that are marking
 435   /// beginning of or end of a scope.
 436   void identifyScopeMarkers();
 437
 438   /// extractScopeInformation - Scan machine instructions in this function
 439   /// and collect DbgScopes. Return true, if atleast one scope was found.
 440   bool extractScopeInformation();
 441
 442   /// addCurrentFnArgument - If Var is an current function argument that add
 443   /// it in CurrentFnArguments list.
 444   bool addCurrentFnArgument(const MachineFunction *MF,
 445                             DbgVariable *Var, DbgScope *Scope);
 446
 447   /// collectVariableInfo - Populate DbgScope entries with variables' info.
 448   void collectVariableInfo(const MachineFunction *,
 449                            SmallPtrSet<const MDNode *, 16> &ProcessedVars);
 450
 451   /// collectVariableInfoFromMMITable - Collect variable information from
 452   /// side table maintained by MMI.
 453   void collectVariableInfoFromMMITable(const MachineFunction * MF,
 454                                        SmallPtrSet<const MDNode *, 16> &P);
 455
 456   /// requestLabelBeforeInsn - Ensure that a label will be emitted before MI.
 457   void requestLabelBeforeInsn(const MachineInstr *MI) {
 458     LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
 459   }
 460
 461   /// getLabelBeforeInsn - Return Label preceding the instruction.
 462   const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
 463
 464   /// requestLabelAfterInsn - Ensure that a label will be emitted after MI.
 465   void requestLabelAfterInsn(const MachineInstr *MI) {
 466     LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
 467   }
 468
 469   /// getLabelAfterInsn - Return Label immediately following the instruction.
 470   const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
 471
 472 public:
 473   //===--------------------------------------------------------------------===//
 474   // Main entry points.
 475   //
 476   DwarfDebug(AsmPrinter *A, Module *M);
 477   ~DwarfDebug();
 478
 479   /// beginModule - Emit all Dwarf sections that should come prior to the
 480   /// content.
 481   void beginModule(Module *M);
 482
 483   /// endModule - Emit all Dwarf sections that should come after the content.
 484   ///
 485   void endModule();
 486
 487   /// beginFunction - Gather pre-function debug information.  Assumes being
 488   /// emitted immediately after the function entry point.
 489   void beginFunction(const MachineFunction *MF);
 490
 491   /// endFunction - Gather and emit post-function debug information.
 492   ///
 493   void endFunction(const MachineFunction *MF);
 494
 495   /// beginInstruction - Process beginning of an instruction.
 496   void beginInstruction(const MachineInstr *MI);
 497
 498   /// endInstruction - Prcess end of an instruction.
 499   void endInstruction(const MachineInstr *MI);
 500
 501   /// GetOrCreateSourceID - Look up the source id with the given directory and
 502   /// source file names. If none currently exists, create a new id and insert it
 503   /// in the SourceIds map.
 504   unsigned GetOrCreateSourceID(StringRef DirName, StringRef FullName);
 505
 506   /// createSubprogramDIE - Create new DIE using SP.
 507   DIE *createSubprogramDIE(DISubprogram SP);
 508 };
 509 } // End of namespace llvm
 510
 511 #endif