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 "DwarfPrinter.h"
  19 #include "llvm/CodeGen/AsmPrinter.h"
  20 #include "llvm/CodeGen/MachineLocation.h"
  21 #include "llvm/Analysis/DebugInfo.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 #include "llvm/ADT/DenseMap.h"
  24 #include "llvm/ADT/FoldingSet.h"
  25 #include "llvm/ADT/SmallSet.h"
  26 #include "llvm/ADT/StringMap.h"
  27 #include "llvm/ADT/UniqueVector.h"
  28 #include <string>
  29
  30 namespace llvm {
  31
  32 class CompileUnit;
  33 class DbgVariable;
  34 class DbgScope;
  35 class DbgConcreteScope;
  36 class MachineFrameInfo;
  37 class MachineModuleInfo;
  38 class TargetAsmInfo;
  39 class Timer;
  40
  41 //===----------------------------------------------------------------------===//
  42 /// SrcLineInfo - This class is used to record source line correspondence.
  43 ///
  44 class VISIBILITY_HIDDEN SrcLineInfo {
  45   unsigned Line;                     // Source line number.
  46   unsigned Column;                   // Source column.
  47   unsigned SourceID;                 // Source ID number.
  48   unsigned LabelID;                  // Label in code ID number.
  49 public:
  50   SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
  51     : Line(L), Column(C), SourceID(S), LabelID(I) {}
  52
  53   // Accessors
  54   unsigned getLine() const { return Line; }
  55   unsigned getColumn() const { return Column; }
  56   unsigned getSourceID() const { return SourceID; }
  57   unsigned getLabelID() const { return LabelID; }
  58 };
  59
  60 class VISIBILITY_HIDDEN DwarfDebug : public Dwarf {
  61   //===--------------------------------------------------------------------===//
  62   // Attributes used to construct specific Dwarf sections.
  63   //
  64
  65   /// CompileUnitMap - A map of global variables representing compile units to
  66   /// compile units.
  67   DenseMap<Value *, CompileUnit *> CompileUnitMap;
  68
  69   /// CompileUnits - All the compile units in this module.
  70   ///
  71   SmallVector<CompileUnit *, 8> CompileUnits;
  72
  73   /// MainCU - Some platform prefers one compile unit per .o file. In such
  74   /// cases, all dies are inserted in MainCU.
  75   CompileUnit *MainCU;
  76
  77   /// AbbreviationsSet - Used to uniquely define abbreviations.
  78   ///
  79   FoldingSet<DIEAbbrev> AbbreviationsSet;
  80
  81   /// Abbreviations - A list of all the unique abbreviations in use.
  82   ///
  83   std::vector<DIEAbbrev *> Abbreviations;
  84
  85   /// DirectoryIdMap - Directory name to directory id map.
  86   ///
  87   StringMap<unsigned> DirectoryIdMap;
  88
  89   /// DirectoryNames - A list of directory names.
  90   SmallVector<std::string, 8> DirectoryNames;
  91
  92   /// SourceFileIdMap - Source file name to source file id map.
  93   ///
  94   StringMap<unsigned> SourceFileIdMap;
  95
  96   /// SourceFileNames - A list of source file names.
  97   SmallVector<std::string, 8> SourceFileNames;
  98
  99   /// SourceIdMap - Source id map, i.e. pair of directory id and source file
 100   /// id mapped to a unique id.
 101   DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap;
 102
 103   /// SourceIds - Reverse map from source id to directory id + file id pair.
 104   ///
 105   SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds;
 106
 107   /// Lines - List of of source line correspondence.
 108   std::vector<SrcLineInfo> Lines;
 109
 110   /// ValuesSet - Used to uniquely define values.
 111   ///
 112   FoldingSet<DIEValue> ValuesSet;
 113
 114   /// Values - A list of all the unique values in use.
 115   ///
 116   std::vector<DIEValue *> Values;
 117
 118   /// StringPool - A UniqueVector of strings used by indirect references.
 119   ///
 120   UniqueVector<std::string> StringPool;
 121
 122   /// SectionMap - Provides a unique id per text section.
 123   ///
 124   UniqueVector<const Section*> SectionMap;
 125
 126   /// SectionSourceLines - Tracks line numbers per text section.
 127   ///
 128   std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
 129
 130   /// didInitial - Flag to indicate if initial emission has been done.
 131   ///
 132   bool didInitial;
 133
 134   /// shouldEmit - Flag to indicate if debug information should be emitted.
 135   ///
 136   bool shouldEmit;
 137
 138   // FunctionDbgScope - Top level scope for the current function.
 139   //
 140   DbgScope *FunctionDbgScope;
 141
 142   /// DbgScopeMap - Tracks the scopes in the current function.
 143   DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
 144
 145   /// DbgAbstractScopeMap - Tracks abstract instance scopes in the current
 146   /// function.
 147   DenseMap<GlobalVariable *, DbgScope *> DbgAbstractScopeMap;
 148
 149   /// DbgConcreteScopeMap - Tracks concrete instance scopes in the current
 150   /// function.
 151   DenseMap<GlobalVariable *,
 152            SmallVector<DbgScope *, 8> > DbgConcreteScopeMap;
 153
 154   /// InlineInfo - Keep track of inlined functions and their location.  This
 155   /// information is used to populate debug_inlined section.
 156   DenseMap<GlobalVariable *, SmallVector<unsigned, 4> > InlineInfo;
 157
 158   /// InlinedVariableScopes - Scopes information for the inlined subroutine
 159   /// variables.
 160   DenseMap<const MachineInstr *, DbgScope *> InlinedVariableScopes;
 161
 162   /// AbstractInstanceRootMap - Map of abstract instance roots of inlined
 163   /// functions. These are subroutine entries that contain a DW_AT_inline
 164   /// attribute.
 165   DenseMap<const GlobalVariable *, DbgScope *> AbstractInstanceRootMap;
 166
 167   /// InlinedParamMap - A map keeping track of which parameters are assigned to
 168   /// which abstract instance.
 169   DenseMap<const GlobalVariable *,
 170     SmallSet<const GlobalVariable *, 32> > InlinedParamMap;
 171
 172   /// AbstractInstanceRootList - List of abstract instance roots of inlined
 173   /// functions. These are subroutine entries that contain a DW_AT_inline
 174   /// attribute.
 175   SmallVector<DbgScope *, 32> AbstractInstanceRootList;
 176
 177   /// LexicalScopeStack - A stack of lexical scopes. The top one is the current
 178   /// scope.
 179   SmallVector<DbgScope *, 16> LexicalScopeStack;
 180
 181   /// CompileUnitOffsets - A vector of the offsets of the compile units. This is
 182   /// used when calculating the "origin" of a concrete instance of an inlined
 183   /// function.
 184   DenseMap<CompileUnit *, unsigned> CompileUnitOffsets;
 185
 186   /// DebugTimer - Timer for the Dwarf debug writer.
 187   Timer *DebugTimer;
 188
 189   struct FunctionDebugFrameInfo {
 190     unsigned Number;
 191     std::vector<MachineMove> Moves;
 192
 193     FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
 194       : Number(Num), Moves(M) {}
 195   };
 196
 197   std::vector<FunctionDebugFrameInfo> DebugFrames;
 198
 199   /// getSourceDirectoryAndFileIds - Return the directory and file ids that
 200   /// maps to the source id. Source id starts at 1.
 201   std::pair<unsigned, unsigned>
 202   getSourceDirectoryAndFileIds(unsigned SId) const {
 203     return SourceIds[SId-1];
 204   }
 205
 206   /// getNumSourceDirectories - Return the number of source directories in the
 207   /// debug info.
 208   unsigned getNumSourceDirectories() const {
 209     return DirectoryNames.size();
 210   }
 211
 212   /// getSourceDirectoryName - Return the name of the directory corresponding
 213   /// to the id.
 214   const std::string &getSourceDirectoryName(unsigned Id) const {
 215     return DirectoryNames[Id - 1];
 216   }
 217
 218   /// getSourceFileName - Return the name of the source file corresponding
 219   /// to the id.
 220   const std::string &getSourceFileName(unsigned Id) const {
 221     return SourceFileNames[Id - 1];
 222   }
 223
 224   /// getNumSourceIds - Return the number of unique source ids.
 225   unsigned getNumSourceIds() const {
 226     return SourceIds.size();
 227   }
 228
 229   /// AssignAbbrevNumber - Define a unique number for the abbreviation.
 230   ///
 231   void AssignAbbrevNumber(DIEAbbrev &Abbrev);
 232
 233   /// NewString - Add a string to the constant pool and returns a label.
 234   ///
 235   DWLabel NewString(const std::string &String) {
 236     unsigned StringID = StringPool.insert(String);
 237     return DWLabel("string", StringID);
 238   }
 239
 240   /// NewDIEEntry - Creates a new DIEEntry to be a proxy for a debug information
 241   /// entry.
 242   DIEEntry *NewDIEEntry(DIE *Entry = NULL);
 243
 244   /// SetDIEEntry - Set a DIEEntry once the debug information entry is defined.
 245   ///
 246   void SetDIEEntry(DIEEntry *Value, DIE *Entry);
 247
 248   /// AddUInt - Add an unsigned integer attribute data and value.
 249   ///
 250   void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
 251
 252   /// AddSInt - Add an signed integer attribute data and value.
 253   ///
 254   void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
 255
 256   /// AddString - Add a string attribute data and value.
 257   ///
 258   void AddString(DIE *Die, unsigned Attribute, unsigned Form,
 259                  const std::string &String);
 260
 261   /// AddLabel - Add a Dwarf label attribute data and value.
 262   ///
 263   void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
 264                 const DWLabel &Label);
 265
 266   /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
 267   ///
 268   void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
 269                       const std::string &Label);
 270
 271   /// AddSectionOffset - Add a section offset label attribute data and value.
 272   ///
 273   void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
 274                         const DWLabel &Label, const DWLabel &Section,
 275                         bool isEH = false, bool useSet = true);
 276
 277   /// AddDelta - Add a label delta attribute data and value.
 278   ///
 279   void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
 280                 const DWLabel &Hi, const DWLabel &Lo);
 281
 282   /// AddDIEEntry - Add a DIE attribute data and value.
 283   ///
 284   void AddDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
 285     Die->AddValue(Attribute, Form, NewDIEEntry(Entry));
 286   }
 287
 288   /// AddBlock - Add block data.
 289   ///
 290   void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
 291
 292   /// AddSourceLine - Add location information to specified debug information
 293   /// entry.
 294   void AddSourceLine(DIE *Die, const DIVariable *V);
 295
 296   /// AddSourceLine - Add location information to specified debug information
 297   /// entry.
 298   void AddSourceLine(DIE *Die, const DIGlobal *G);
 299
 300   void AddSourceLine(DIE *Die, const DIType *Ty);
 301
 302   /// AddAddress - Add an address attribute to a die based on the location
 303   /// provided.
 304   void AddAddress(DIE *Die, unsigned Attribute,
 305                   const MachineLocation &Location);
 306
 307   /// AddType - Add a new type attribute to the specified entity.
 308   void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty);
 309
 310   /// ConstructTypeDIE - Construct basic type die from DIBasicType.
 311   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
 312                         DIBasicType BTy);
 313
 314   /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
 315   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
 316                         DIDerivedType DTy);
 317
 318   /// ConstructTypeDIE - Construct type DIE from DICompositeType.
 319   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
 320                         DICompositeType CTy);
 321
 322   /// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
 323   void ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
 324
 325   /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
 326   void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
 327                              DICompositeType *CTy);
 328
 329   /// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
 330   DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy);
 331
 332   /// CreateGlobalVariableDIE - Create new DIE using GV.
 333   DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit,
 334                                const DIGlobalVariable &GV);
 335
 336   /// CreateMemberDIE - Create new member DIE.
 337   DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT);
 338
 339   /// CreateSubprogramDIE - Create new DIE using SP.
 340   DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
 341                            const DISubprogram &SP,
 342                            bool IsConstructor = false,
 343                            bool IsInlined = false);
 344
 345   /// FindCompileUnit - Get the compile unit for the given descriptor.
 346   ///
 347   CompileUnit &FindCompileUnit(DICompileUnit Unit) const;
 348
 349   /// NewDbgScopeVariable - Create a new scope variable.
 350   ///
 351   DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit);
 352
 353   /// getOrCreateScope - Returns the scope associated with the given descriptor.
 354   ///
 355   DbgScope *getOrCreateScope(GlobalVariable *V);
 356
 357   /// ConstructDbgScope - Construct the components of a scope.
 358   ///
 359   void ConstructDbgScope(DbgScope *ParentScope,
 360                          unsigned ParentStartID, unsigned ParentEndID,
 361                          DIE *ParentDie, CompileUnit *Unit);
 362
 363   /// ConstructFunctionDbgScope - Construct the scope for the subprogram.
 364   ///
 365   void ConstructFunctionDbgScope(DbgScope *RootScope);
 366
 367   /// ConstructFunctionDbgScope - Construct the scope for the abstract debug
 368   /// scope.
 369   ///
 370   void ConstructAbstractDbgScope(DbgScope *AbsScope);
 371
 372   /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
 373   ///
 374   void ConstructDefaultDbgScope(MachineFunction *MF);
 375
 376   /// EmitInitial - Emit initial Dwarf declarations.  This is necessary for cc
 377   /// tools to recognize the object file contains Dwarf information.
 378   void EmitInitial();
 379
 380   /// EmitDIE - Recusively Emits a debug information entry.
 381   ///
 382   void EmitDIE(DIE *Die);
 383
 384   /// SizeAndOffsetDie - Compute the size and offset of a DIE.
 385   ///
 386   unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last);
 387
 388   /// SizeAndOffsets - Compute the size and offset of all the DIEs.
 389   ///
 390   void SizeAndOffsets();
 391
 392   /// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
 393   ///
 394   void EmitDebugInfoPerCU(CompileUnit *Unit);
 395
 396   void EmitDebugInfo();
 397
 398   /// EmitAbbreviations - Emit the abbreviation section.
 399   ///
 400   void EmitAbbreviations() const;
 401
 402   /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
 403   /// the line matrix.
 404   ///
 405   void EmitEndOfLineMatrix(unsigned SectionEnd);
 406
 407   /// EmitDebugLines - Emit source line information.
 408   ///
 409   void EmitDebugLines();
 410
 411   /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
 412   ///
 413   void EmitCommonDebugFrame();
 414
 415   /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
 416   /// section.
 417   void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
 418
 419   void EmitDebugPubNamesPerCU(CompileUnit *Unit);
 420
 421   /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
 422   ///
 423   void EmitDebugPubNames();
 424
 425   /// EmitDebugStr - Emit visible names into a debug str section.
 426   ///
 427   void EmitDebugStr();
 428
 429   /// EmitDebugLoc - Emit visible names into a debug loc section.
 430   ///
 431   void EmitDebugLoc();
 432
 433   /// EmitDebugARanges - Emit visible names into a debug aranges section.
 434   ///
 435   void EmitDebugARanges();
 436
 437   /// EmitDebugRanges - Emit visible names into a debug ranges section.
 438   ///
 439   void EmitDebugRanges();
 440
 441   /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
 442   ///
 443   void EmitDebugMacInfo();
 444
 445   /// EmitDebugInlineInfo - Emit inline info using following format.
 446   /// Section Header:
 447   /// 1. length of section
 448   /// 2. Dwarf version number
 449   /// 3. address size.
 450   ///
 451   /// Entries (one "entry" for each function that was inlined):
 452   ///
 453   /// 1. offset into __debug_str section for MIPS linkage name, if exists;
 454   ///   otherwise offset into __debug_str for regular function name.
 455   /// 2. offset into __debug_str section for regular function name.
 456   /// 3. an unsigned LEB128 number indicating the number of distinct inlining
 457   /// instances for the function.
 458   ///
 459   /// The rest of the entry consists of a {die_offset, low_pc}  pair for each
 460   /// inlined instance; the die_offset points to the inlined_subroutine die in
 461   /// the __debug_info section, and the low_pc is the starting address  for the
 462   ///  inlining instance.
 463   void EmitDebugInlineInfo();
 464
 465   /// GetOrCreateSourceID - Look up the source id with the given directory and
 466   /// source file names. If none currently exists, create a new id and insert it
 467   /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
 468   /// as well.
 469   unsigned GetOrCreateSourceID(const std::string &DirName,
 470                                const std::string &FileName);
 471
 472   void ConstructCompileUnit(GlobalVariable *GV);
 473
 474   /// ConstructCompileUnits - Create a compile unit DIEs.
 475   void ConstructCompileUnits();
 476
 477   bool ConstructGlobalVariableDIE(GlobalVariable *GV);
 478
 479   /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
 480   /// visible global variables. Return true if at least one global DIE is
 481   /// created.
 482   bool ConstructGlobalVariableDIEs();
 483
 484   bool ConstructSubprogram(GlobalVariable *GV);
 485
 486   /// ConstructSubprograms - Create DIEs for each of the externally visible
 487   /// subprograms. Return true if at least one subprogram DIE is created.
 488   bool ConstructSubprograms();
 489 public:
 490   //===--------------------------------------------------------------------===//
 491   // Main entry points.
 492   //
 493   DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T);
 494   virtual ~DwarfDebug();
 495
 496   /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
 497   /// be emitted.
 498   bool ShouldEmitDwarfDebug() const { return shouldEmit; }
 499
 500   /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
 501   /// This is inovked by the target AsmPrinter.
 502   void SetDebugInfo(MachineModuleInfo *mmi);
 503
 504   /// BeginModule - Emit all Dwarf sections that should come prior to the
 505   /// content.
 506   void BeginModule(Module *M) {
 507     this->M = M;
 508   }
 509
 510   /// EndModule - Emit all Dwarf sections that should come after the content.
 511   ///
 512   void EndModule();
 513
 514   /// BeginFunction - Gather pre-function debug information.  Assumes being
 515   /// emitted immediately after the function entry point.
 516   void BeginFunction(MachineFunction *MF);
 517
 518   /// EndFunction - Gather and emit post-function debug information.
 519   ///
 520   void EndFunction(MachineFunction *MF);
 521
 522   /// RecordSourceLine - Records location information and associates it with a
 523   /// label. Returns a unique label ID used to generate a label and provide
 524   /// correspondence to the source line list.
 525   unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col);
 526
 527   /// RecordSourceLine - Records location information and associates it with a
 528   /// label. Returns a unique label ID used to generate a label and provide
 529   /// correspondence to the source line list.
 530   unsigned RecordSourceLine(unsigned Line, unsigned Col, DICompileUnit CU);
 531
 532   /// getRecordSourceLineCount - Return the number of source lines in the debug
 533   /// info.
 534   unsigned getRecordSourceLineCount() const {
 535     return Lines.size();
 536   }
 537
 538   /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
 539   /// timed. Look up the source id with the given directory and source file
 540   /// names. If none currently exists, create a new id and insert it in the
 541   /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
 542   /// well.
 543   unsigned getOrCreateSourceID(const std::string &DirName,
 544                                const std::string &FileName);
 545
 546   /// RecordRegionStart - Indicate the start of a region.
 547   unsigned RecordRegionStart(GlobalVariable *V);
 548
 549   /// RecordRegionEnd - Indicate the end of a region.
 550   unsigned RecordRegionEnd(GlobalVariable *V);
 551
 552   /// RecordVariable - Indicate the declaration of  a local variable.
 553   void RecordVariable(GlobalVariable *GV, unsigned FrameIndex,
 554                       const MachineInstr *MI);
 555
 556   //// RecordInlinedFnStart - Indicate the start of inlined subroutine.
 557   unsigned RecordInlinedFnStart(DISubprogram &SP, DICompileUnit CU,
 558                                 unsigned Line, unsigned Col);
 559
 560   /// RecordInlinedFnEnd - Indicate the end of inlined subroutine.
 561   unsigned RecordInlinedFnEnd(DISubprogram &SP);
 562
 563   /// RecordVariableScope - Record scope for the variable declared by
 564   /// DeclareMI. DeclareMI must describe TargetInstrInfo::DECLARE. Record scopes
 565   /// for only inlined subroutine variables. Other variables's scopes are
 566   /// determined during RecordVariable().
 567   void RecordVariableScope(DIVariable &DV, const MachineInstr *DeclareMI);
 568 };
 569
 570 } // End of namespace llvm
 571
 572 #endif