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