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 #include <map>
  30
  31 namespace llvm {
  32
  33 class CompileUnit;
  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   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   /// isArtificial - Return true if DbgVariable is artificial.
 157   bool isArtificial()                const {
 158     if (Var.isArtificial())
 159       return true;
 160     if (Var.getTag() == dwarf::DW_TAG_arg_variable
 161         && getType().isArtificial())
 162       return true;
 163     return false;
 164   }
 165   bool variableHasComplexAddress()   const {
 166     assert(Var.Verify() && "Invalid complex DbgVariable!");
 167     return Var.hasComplexAddress();
 168   }
 169   bool isBlockByrefVariable()        const {
 170     assert(Var.Verify() && "Invalid complex DbgVariable!");
 171     return Var.isBlockByrefVariable();
 172   }
 173   unsigned getNumAddrElements()      const {
 174     assert(Var.Verify() && "Invalid complex DbgVariable!");
 175     return Var.getNumAddrElements();
 176   }
 177   uint64_t getAddrElement(unsigned i) const {
 178     return Var.getAddrElement(i);
 179   }
 180   DIType getType() const;
 181 };
 182
 183 class DwarfDebug {
 184   /// Asm - Target of Dwarf emission.
 185   AsmPrinter *Asm;
 186
 187   /// MMI - Collected machine module information.
 188   MachineModuleInfo *MMI;
 189
 190   //===--------------------------------------------------------------------===//
 191   // Attributes used to construct specific Dwarf sections.
 192   //
 193
 194   CompileUnit *FirstCU;
 195
 196   /// Maps MDNode with its corresponding CompileUnit.
 197   DenseMap <const MDNode *, CompileUnit *> CUMap;
 198
 199   /// Maps subprogram MDNode with its corresponding CompileUnit.
 200   DenseMap <const MDNode *, CompileUnit *> SPMap;
 201
 202   /// AbbreviationsSet - Used to uniquely define abbreviations.
 203   ///
 204   FoldingSet<DIEAbbrev> AbbreviationsSet;
 205
 206   /// Abbreviations - A list of all the unique abbreviations in use.
 207   ///
 208   std::vector<DIEAbbrev *> Abbreviations;
 209
 210   /// SourceIdMap - Source id map, i.e. pair of source filename and directory
 211   /// mapped to a unique id.
 212   std::map<std::pair<std::string, std::string>, unsigned> SourceIdMap;
 213
 214   /// StringPool - A String->Symbol mapping of strings used by indirect
 215   /// references.
 216   StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
 217   unsigned NextStringPoolNumber;
 218
 219   /// SectionMap - Provides a unique id per text section.
 220   ///
 221   UniqueVector<const MCSection*> SectionMap;
 222
 223   /// CurrentFnArguments - List of Arguments (DbgValues) for current function.
 224   SmallVector<DbgVariable *, 8> CurrentFnArguments;
 225
 226   LexicalScopes LScopes;
 227
 228   /// AbstractSPDies - Collection of abstract subprogram DIEs.
 229   DenseMap<const MDNode *, DIE *> AbstractSPDies;
 230
 231   /// ScopeVariables - Collection of dbg variables of a scope.
 232   DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> > ScopeVariables;
 233
 234   /// AbstractVariables - Collection on abstract variables.
 235   DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
 236
 237   /// DotDebugLocEntries - Collection of DotDebugLocEntry.
 238   SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
 239
 240   /// InlinedSubprogramDIEs - Collection of subprogram DIEs that are marked
 241   /// (at the end of the module) as DW_AT_inline.
 242   SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
 243
 244   /// InlineInfo - Keep track of inlined functions and their location.  This
 245   /// information is used to populate debug_inlined section.
 246   typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
 247   DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
 248   SmallVector<const MDNode *, 4> InlinedSPNodes;
 249
 250   // ProcessedSPNodes - This is a collection of subprogram MDNodes that
 251   // are processed to create DIEs.
 252   SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
 253
 254   /// LabelsBeforeInsn - Maps instruction with label emitted before
 255   /// instruction.
 256   DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
 257
 258   /// LabelsAfterInsn - Maps instruction with label emitted after
 259   /// instruction.
 260   DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
 261
 262   /// UserVariables - Every user variable mentioned by a DBG_VALUE instruction
 263   /// in order of appearance.
 264   SmallVector<const MDNode*, 8> UserVariables;
 265
 266   /// DbgValues - For each user variable, keep a list of DBG_VALUE
 267   /// instructions in order. The list can also contain normal instructions that
 268   /// clobber the previous DBG_VALUE.
 269   typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
 270     DbgValueHistoryMap;
 271   DbgValueHistoryMap DbgValues;
 272
 273   SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
 274
 275   /// Previous instruction's location information. This is used to determine
 276   /// label location to indicate scope boundries in dwarf debug info.
 277   DebugLoc PrevInstLoc;
 278   MCSymbol *PrevLabel;
 279
 280   /// PrologEndLoc - This location indicates end of function prologue and
 281   /// beginning of function body.
 282   DebugLoc PrologEndLoc;
 283
 284   struct FunctionDebugFrameInfo {
 285     unsigned Number;
 286     std::vector<MachineMove> Moves;
 287
 288     FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
 289       : Number(Num), Moves(M) {}
 290   };
 291
 292   std::vector<FunctionDebugFrameInfo> DebugFrames;
 293
 294   // DIEValueAllocator - All DIEValues are allocated through this allocator.
 295   BumpPtrAllocator DIEValueAllocator;
 296
 297   // Section Symbols: these are assembler temporary labels that are emitted at
 298   // the beginning of each supported dwarf section.  These are used to form
 299   // section offsets and are created by EmitSectionLabels.
 300   MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
 301   MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
 302   MCSymbol *DwarfDebugLocSectionSym;
 303   MCSymbol *FunctionBeginSym, *FunctionEndSym;
 304
 305   // As an optimization, there is no need to emit an entry in the directory
 306   // table for the same directory as DW_at_comp_dir.
 307   StringRef CompilationDir;
 308
 309 private:
 310
 311   /// assignAbbrevNumber - Define a unique number for the abbreviation.
 312   ///
 313   void assignAbbrevNumber(DIEAbbrev &Abbrev);
 314
 315   void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
 316
 317   /// findAbstractVariable - Find abstract variable associated with Var.
 318   DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
 319
 320   /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
 321   /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
 322   /// If there are global variables in this scope then create and insert
 323   /// DIEs for these variables.
 324   DIE *updateSubprogramScopeDIE(CompileUnit *SPCU, const MDNode *SPNode);
 325
 326   /// constructLexicalScope - Construct new DW_TAG_lexical_block
 327   /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
 328   DIE *constructLexicalScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
 329
 330   /// constructInlinedScopeDIE - This scope represents inlined body of
 331   /// a function. Construct DIE to represent this concrete inlined copy
 332   /// of the function.
 333   DIE *constructInlinedScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
 334
 335   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 336   DIE *constructVariableDIE(DbgVariable *DV, LexicalScope *S);
 337
 338   /// constructScopeDIE - Construct a DIE for this scope.
 339   DIE *constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
 340
 341   /// EmitSectionLabels - Emit initial Dwarf sections with a label at
 342   /// the start of each one.
 343   void EmitSectionLabels();
 344
 345   /// emitDIE - Recursively Emits a debug information entry.
 346   ///
 347   void emitDIE(DIE *Die);
 348
 349   /// computeSizeAndOffset - Compute the size and offset of a DIE.
 350   ///
 351   unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
 352
 353   /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
 354   ///
 355   void computeSizeAndOffsets();
 356
 357   /// EmitDebugInfo - Emit the debug info section.
 358   ///
 359   void emitDebugInfo();
 360
 361   /// emitAbbreviations - Emit the abbreviation section.
 362   ///
 363   void emitAbbreviations() const;
 364
 365   /// emitEndOfLineMatrix - Emit the last address of the section and the end of
 366   /// the line matrix.
 367   ///
 368   void emitEndOfLineMatrix(unsigned SectionEnd);
 369
 370   /// emitDebugPubNames - Emit visible names into a debug pubnames section.
 371   ///
 372   void emitDebugPubNames();
 373
 374   /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
 375   ///
 376   void emitDebugPubTypes();
 377
 378   /// emitDebugStr - Emit visible names into a debug str section.
 379   ///
 380   void emitDebugStr();
 381
 382   /// emitDebugLoc - Emit visible names into a debug loc section.
 383   ///
 384   void emitDebugLoc();
 385
 386   /// EmitDebugARanges - Emit visible names into a debug aranges section.
 387   ///
 388   void EmitDebugARanges();
 389
 390   /// emitDebugRanges - Emit visible names into a debug ranges section.
 391   ///
 392   void emitDebugRanges();
 393
 394   /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
 395   ///
 396   void emitDebugMacInfo();
 397
 398   /// emitDebugInlineInfo - Emit inline info using following format.
 399   /// Section Header:
 400   /// 1. length of section
 401   /// 2. Dwarf version number
 402   /// 3. address size.
 403   ///
 404   /// Entries (one "entry" for each function that was inlined):
 405   ///
 406   /// 1. offset into __debug_str section for MIPS linkage name, if exists;
 407   ///   otherwise offset into __debug_str for regular function name.
 408   /// 2. offset into __debug_str section for regular function name.
 409   /// 3. an unsigned LEB128 number indicating the number of distinct inlining
 410   /// instances for the function.
 411   ///
 412   /// The rest of the entry consists of a {die_offset, low_pc} pair for each
 413   /// inlined instance; the die_offset points to the inlined_subroutine die in
 414   /// the __debug_info section, and the low_pc is the starting address for the
 415   /// inlining instance.
 416   void emitDebugInlineInfo();
 417
 418   /// constructCompileUnit - Create new CompileUnit for the given
 419   /// metadata node with tag DW_TAG_compile_unit.
 420   CompileUnit *constructCompileUnit(const MDNode *N);
 421
 422   /// construct SubprogramDIE - Construct subprogram DIE.
 423   void constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N);
 424
 425   /// recordSourceLine - Register a source line with debug info. Returns the
 426   /// unique label that was emitted and which provides correspondence to
 427   /// the source line list.
 428   void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
 429                         unsigned Flags);
 430
 431   /// identifyScopeMarkers() - Indentify instructions that are marking the
 432   /// beginning of or ending of a scope.
 433   void identifyScopeMarkers();
 434
 435   /// addCurrentFnArgument - If Var is an current function argument that add
 436   /// it in CurrentFnArguments list.
 437   bool addCurrentFnArgument(const MachineFunction *MF,
 438                             DbgVariable *Var, LexicalScope *Scope);
 439
 440   /// collectVariableInfo - Populate LexicalScope entries with variables' info.
 441   void collectVariableInfo(const MachineFunction *,
 442                            SmallPtrSet<const MDNode *, 16> &ProcessedVars);
 443
 444   /// collectVariableInfoFromMMITable - Collect variable information from
 445   /// side table maintained by MMI.
 446   void collectVariableInfoFromMMITable(const MachineFunction * MF,
 447                                        SmallPtrSet<const MDNode *, 16> &P);
 448
 449   /// requestLabelBeforeInsn - Ensure that a label will be emitted before MI.
 450   void requestLabelBeforeInsn(const MachineInstr *MI) {
 451     LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
 452   }
 453
 454   /// getLabelBeforeInsn - Return Label preceding the instruction.
 455   const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
 456
 457   /// requestLabelAfterInsn - Ensure that a label will be emitted after MI.
 458   void requestLabelAfterInsn(const MachineInstr *MI) {
 459     LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
 460   }
 461
 462   /// getLabelAfterInsn - Return Label immediately following the instruction.
 463   const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
 464
 465 public:
 466   //===--------------------------------------------------------------------===//
 467   // Main entry points.
 468   //
 469   DwarfDebug(AsmPrinter *A, Module *M);
 470   ~DwarfDebug();
 471
 472   /// collectInfoFromNamedMDNodes - Collect debug info from named mdnodes such
 473   /// as llvm.dbg.enum and llvm.dbg.ty
 474   void collectInfoFromNamedMDNodes(Module *M);
 475
 476   /// collectLegacyDebugInfo - Collect debug info using DebugInfoFinder.
 477   /// FIXME - Remove this when DragonEgg switches to DIBuilder.
 478   bool collectLegacyDebugInfo(Module *M);
 479
 480   /// beginModule - Emit all Dwarf sections that should come prior to the
 481   /// content.
 482   void beginModule(Module *M);
 483
 484   /// endModule - Emit all Dwarf sections that should come after the content.
 485   ///
 486   void endModule();
 487
 488   /// beginFunction - Gather pre-function debug information.  Assumes being
 489   /// emitted immediately after the function entry point.
 490   void beginFunction(const MachineFunction *MF);
 491
 492   /// endFunction - Gather and emit post-function debug information.
 493   ///
 494   void endFunction(const MachineFunction *MF);
 495
 496   /// beginInstruction - Process beginning of an instruction.
 497   void beginInstruction(const MachineInstr *MI);
 498
 499   /// endInstruction - Prcess end of an instruction.
 500   void endInstruction(const MachineInstr *MI);
 501
 502   /// GetOrCreateSourceID - Look up the source id with the given directory and
 503   /// source file names. If none currently exists, create a new id and insert it
 504   /// in the SourceIds map.
 505   unsigned GetOrCreateSourceID(StringRef DirName, StringRef FullName);
 506
 507   /// createSubprogramDIE - Create new DIE using SP.
 508   DIE *createSubprogramDIE(DISubprogram SP);
 509
 510   /// getStringPool - returns the entry into the start of the pool.
 511   MCSymbol *getStringPool();
 512
 513   /// getStringPoolEntry - returns an entry into the string pool with the given
 514   /// string text.
 515   MCSymbol *getStringPoolEntry(StringRef Str);
 516 };
 517 } // End of namespace llvm
 518
 519 #endif