DwarfDebug.h revision c446f6e2191a8cf0d494fb875538ac93c22d06db
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 "DIE.h" 19#include "llvm/ADT/DenseMap.h" 20#include "llvm/ADT/FoldingSet.h" 21#include "llvm/ADT/SmallPtrSet.h" 22#include "llvm/ADT/StringMap.h" 23#include "llvm/ADT/UniqueVector.h" 24#include "llvm/Support/Allocator.h" 25 26namespace llvm { 27 28class CompileUnit; 29class DbgConcreteScope; 30class DbgScope; 31class DbgVariable; 32class MachineFrameInfo; 33class MachineLocation; 34class MachineModuleInfo; 35class MCAsmInfo; 36class DIEAbbrev; 37class DIE; 38class DIEBlock; 39class DIEEntry; 40 41class DIEnumerator; 42class DIDescriptor; 43class DIVariable; 44class DIGlobal; 45class DIGlobalVariable; 46class DISubprogram; 47class DIBasicType; 48class DIDerivedType; 49class DIType; 50class DINameSpace; 51class DISubrange; 52class DICompositeType; 53 54//===----------------------------------------------------------------------===// 55/// SrcLineInfo - This class is used to record source line correspondence. 56/// 57class SrcLineInfo { 58 unsigned Line; // Source line number. 59 unsigned Column; // Source column. 60 unsigned SourceID; // Source ID number. 61 MCSymbol *Label; // Label in code ID number. 62public: 63 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label) 64 : Line(L), Column(C), SourceID(S), Label(label) {} 65 66 // Accessors 67 unsigned getLine() const { return Line; } 68 unsigned getColumn() const { return Column; } 69 unsigned getSourceID() const { return SourceID; } 70 MCSymbol *getLabel() const { return Label; } 71}; 72 73class DwarfDebug { 74 /// Asm - Target of Dwarf emission. 75 AsmPrinter *Asm; 76 77 /// MMI - Collected machine module information. 78 MachineModuleInfo *MMI; 79 80 //===--------------------------------------------------------------------===// 81 // Attributes used to construct specific Dwarf sections. 82 // 83 84 /// ModuleCU - All DIEs are inserted in ModuleCU. 85 CompileUnit *ModuleCU; 86 87 /// AbbreviationsSet - Used to uniquely define abbreviations. 88 /// 89 FoldingSet<DIEAbbrev> AbbreviationsSet; 90 91 /// Abbreviations - A list of all the unique abbreviations in use. 92 /// 93 std::vector<DIEAbbrev *> Abbreviations; 94 95 /// DirectoryIdMap - Directory name to directory id map. 96 /// 97 StringMap<unsigned> DirectoryIdMap; 98 99 /// DirectoryNames - A list of directory names. 100 SmallVector<std::string, 8> DirectoryNames; 101 102 /// SourceFileIdMap - Source file name to source file id map. 103 /// 104 StringMap<unsigned> SourceFileIdMap; 105 106 /// SourceFileNames - A list of source file names. 107 SmallVector<std::string, 8> SourceFileNames; 108 109 /// SourceIdMap - Source id map, i.e. pair of directory id and source file 110 /// id mapped to a unique id. 111 DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap; 112 113 /// SourceIds - Reverse map from source id to directory id + file id pair. 114 /// 115 SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds; 116 117 /// Lines - List of source line correspondence. 118 std::vector<SrcLineInfo> Lines; 119 120 /// DIEBlocks - A list of all the DIEBlocks in use. 121 std::vector<DIEBlock *> DIEBlocks; 122 123 // DIEValueAllocator - All DIEValues are allocated through this allocator. 124 BumpPtrAllocator DIEValueAllocator; 125 126 /// StringPool - A String->Symbol mapping of strings used by indirect 127 /// references. 128 StringMap<std::pair<MCSymbol*, unsigned> > StringPool; 129 unsigned NextStringPoolNumber; 130 131 MCSymbol *getStringPoolEntry(StringRef Str); 132 133 /// SectionMap - Provides a unique id per text section. 134 /// 135 UniqueVector<const MCSection*> SectionMap; 136 137 /// SectionSourceLines - Tracks line numbers per text section. 138 /// 139 std::vector<std::vector<SrcLineInfo> > SectionSourceLines; 140 141 // CurrentFnDbgScope - Top level scope for the current function. 142 // 143 DbgScope *CurrentFnDbgScope; 144 145 /// DbgScopeMap - Tracks the scopes in the current function. Owns the 146 /// contained DbgScope*s. 147 /// 148 DenseMap<MDNode *, DbgScope *> DbgScopeMap; 149 150 /// ConcreteScopes - Tracks the concrete scopees in the current function. 151 /// These scopes are also included in DbgScopeMap. 152 DenseMap<MDNode *, DbgScope *> ConcreteScopes; 153 154 /// AbstractScopes - Tracks the abstract scopes a module. These scopes are 155 /// not included DbgScopeMap. AbstractScopes owns its DbgScope*s. 156 DenseMap<MDNode *, DbgScope *> AbstractScopes; 157 158 /// AbstractScopesList - Tracks abstract scopes constructed while processing 159 /// a function. This list is cleared during endFunction(). 160 SmallVector<DbgScope *, 4>AbstractScopesList; 161 162 /// AbstractVariables - Collection on abstract variables. Owned by the 163 /// DbgScopes in AbstractScopes. 164 DenseMap<MDNode *, DbgVariable *> AbstractVariables; 165 166 /// DbgValueStartMap - Tracks starting scope of variable DIEs. 167 /// If the scope of an object begins sometime after the low pc value for the 168 /// scope most closely enclosing the object, the object entry may have a 169 /// DW_AT_start_scope attribute. 170 DenseMap<const MachineInstr *, DbgVariable *> DbgValueStartMap; 171 172 /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked 173 /// (at the end of the module) as DW_AT_inline. 174 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs; 175 176 DenseMap<DIE *, MDNode *> ContainingTypeMap; 177 178 typedef SmallVector<DbgScope *, 2> ScopeVector; 179 SmallPtrSet<const MachineInstr *, 8> InsnsBeginScopeSet; 180 SmallPtrSet<const MachineInstr *, 8> InsnsEndScopeSet; 181 182 /// InlineInfo - Keep track of inlined functions and their location. This 183 /// information is used to populate debug_inlined section. 184 typedef std::pair<MCSymbol*, DIE *> InlineInfoLabels; 185 DenseMap<MDNode*, SmallVector<InlineInfoLabels, 4> > InlineInfo; 186 SmallVector<MDNode *, 4> InlinedSPNodes; 187 188 /// InsnBeforeLabelMap - Maps instruction with label emitted before 189 /// instruction. 190 DenseMap<const MachineInstr *, MCSymbol *> InsnBeforeLabelMap; 191 192 /// InsnAfterLabelMap - Maps instruction with label emitted after 193 /// instruction. 194 DenseMap<const MachineInstr *, MCSymbol *> InsnAfterLabelMap; 195 196 /// CompileUnitOffsets - A vector of the offsets of the compile units. This is 197 /// used when calculating the "origin" of a concrete instance of an inlined 198 /// function. 199 DenseMap<CompileUnit *, unsigned> CompileUnitOffsets; 200 201 /// Previous instruction's location information. This is used to determine 202 /// label location to indicate scope boundries in dwarf debug info. 203 DebugLoc PrevInstLoc; 204 205 struct FunctionDebugFrameInfo { 206 unsigned Number; 207 std::vector<MachineMove> Moves; 208 209 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M) 210 : Number(Num), Moves(M) {} 211 }; 212 213 std::vector<FunctionDebugFrameInfo> DebugFrames; 214 215 // Section Symbols: these are assembler temporary labels that are emitted at 216 // the beginning of each supported dwarf section. These are used to form 217 // section offsets and are created by EmitSectionLabels. 218 MCSymbol *DwarfFrameSectionSym, *DwarfInfoSectionSym, *DwarfAbbrevSectionSym; 219 MCSymbol *DwarfStrSectionSym, *TextSectionSym; 220 221private: 222 223 /// getSourceDirectoryAndFileIds - Return the directory and file ids that 224 /// maps to the source id. Source id starts at 1. 225 std::pair<unsigned, unsigned> 226 getSourceDirectoryAndFileIds(unsigned SId) const { 227 return SourceIds[SId-1]; 228 } 229 230 /// getNumSourceDirectories - Return the number of source directories in the 231 /// debug info. 232 unsigned getNumSourceDirectories() const { 233 return DirectoryNames.size(); 234 } 235 236 /// getSourceDirectoryName - Return the name of the directory corresponding 237 /// to the id. 238 const std::string &getSourceDirectoryName(unsigned Id) const { 239 return DirectoryNames[Id - 1]; 240 } 241 242 /// getSourceFileName - Return the name of the source file corresponding 243 /// to the id. 244 const std::string &getSourceFileName(unsigned Id) const { 245 return SourceFileNames[Id - 1]; 246 } 247 248 /// getNumSourceIds - Return the number of unique source ids. 249 unsigned getNumSourceIds() const { 250 return SourceIds.size(); 251 } 252 253 /// assignAbbrevNumber - Define a unique number for the abbreviation. 254 /// 255 void assignAbbrevNumber(DIEAbbrev &Abbrev); 256 257 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug 258 /// information entry. 259 DIEEntry *createDIEEntry(DIE *Entry); 260 261 /// addUInt - Add an unsigned integer attribute data and value. 262 /// 263 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer); 264 265 /// addSInt - Add an signed integer attribute data and value. 266 /// 267 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer); 268 269 /// addString - Add a string attribute data and value. 270 /// 271 void addString(DIE *Die, unsigned Attribute, unsigned Form, 272 const StringRef Str); 273 274 /// addLabel - Add a Dwarf label attribute data and value. 275 /// 276 void addLabel(DIE *Die, unsigned Attribute, unsigned Form, 277 const MCSymbol *Label); 278 279 /// addDelta - Add a label delta attribute data and value. 280 /// 281 void addDelta(DIE *Die, unsigned Attribute, unsigned Form, 282 const MCSymbol *Hi, const MCSymbol *Lo); 283 284 /// addDIEEntry - Add a DIE attribute data and value. 285 /// 286 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry); 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 void addSourceLine(DIE *Die, const DIGlobal *G); 296 void addSourceLine(DIE *Die, const DISubprogram *SP); 297 void addSourceLine(DIE *Die, const DIType *Ty); 298 void addSourceLine(DIE *Die, const DINameSpace *NS); 299 300 /// addAddress - Add an address attribute to a die based on the location 301 /// provided. 302 void addAddress(DIE *Die, unsigned Attribute, 303 const MachineLocation &Location); 304 305 /// addComplexAddress - Start with the address based on the location provided, 306 /// and generate the DWARF information necessary to find the actual variable 307 /// (navigating the extra location information encoded in the type) based on 308 /// the starting location. Add the DWARF information to the die. 309 /// 310 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute, 311 const MachineLocation &Location); 312 313 // FIXME: Should be reformulated in terms of addComplexAddress. 314 /// addBlockByrefAddress - Start with the address based on the location 315 /// provided, and generate the DWARF information necessary to find the 316 /// actual Block variable (navigating the Block struct) based on the 317 /// starting location. Add the DWARF information to the die. Obsolete, 318 /// please use addComplexAddress instead. 319 /// 320 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute, 321 const MachineLocation &Location); 322 323 /// addToContextOwner - Add Die into the list of its context owner's children. 324 void addToContextOwner(DIE *Die, DIDescriptor Context); 325 326 /// addType - Add a new type attribute to the specified entity. 327 void addType(DIE *Entity, DIType Ty); 328 329 330 /// getOrCreateNameSpace - Create a DIE for DINameSpace. 331 DIE *getOrCreateNameSpace(DINameSpace NS); 332 333 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the 334 /// given DIType. 335 DIE *getOrCreateTypeDIE(DIType Ty); 336 337 void addPubTypes(DISubprogram SP); 338 339 /// constructTypeDIE - Construct basic type die from DIBasicType. 340 void constructTypeDIE(DIE &Buffer, 341 DIBasicType BTy); 342 343 /// constructTypeDIE - Construct derived type die from DIDerivedType. 344 void constructTypeDIE(DIE &Buffer, 345 DIDerivedType DTy); 346 347 /// constructTypeDIE - Construct type DIE from DICompositeType. 348 void constructTypeDIE(DIE &Buffer, 349 DICompositeType CTy); 350 351 /// constructSubrangeDIE - Construct subrange DIE from DISubrange. 352 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy); 353 354 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType. 355 void constructArrayTypeDIE(DIE &Buffer, 356 DICompositeType *CTy); 357 358 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator. 359 DIE *constructEnumTypeDIE(DIEnumerator ETy); 360 361 /// createGlobalVariableDIE - Create new DIE using GV. 362 DIE *createGlobalVariableDIE(const DIGlobalVariable &GV); 363 364 /// createMemberDIE - Create new member DIE. 365 DIE *createMemberDIE(const DIDerivedType &DT); 366 367 /// createSubprogramDIE - Create new DIE using SP. 368 DIE *createSubprogramDIE(const DISubprogram &SP, bool MakeDecl = false); 369 370 /// getUpdatedDbgScope - Find or create DbgScope assicated with 371 /// the instruction. Initialize scope and update scope hierarchy. 372 DbgScope *getUpdatedDbgScope(MDNode *N, const MachineInstr *MI, 373 MDNode *InlinedAt); 374 375 /// createDbgScope - Create DbgScope for the scope. 376 void createDbgScope(MDNode *Scope, MDNode *InlinedAt); 377 378 DbgScope *getOrCreateAbstractScope(MDNode *N); 379 380 /// findAbstractVariable - Find abstract variable associated with Var. 381 DbgVariable *findAbstractVariable(DIVariable &Var, unsigned FrameIdx, 382 DebugLoc Loc); 383 DbgVariable *findAbstractVariable(DIVariable &Var, const MachineInstr *MI, 384 DebugLoc Loc); 385 386 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and 387 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes. 388 /// If there are global variables in this scope then create and insert 389 /// DIEs for these variables. 390 DIE *updateSubprogramScopeDIE(MDNode *SPNode); 391 392 /// constructLexicalScope - Construct new DW_TAG_lexical_block 393 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels. 394 DIE *constructLexicalScopeDIE(DbgScope *Scope); 395 396 /// constructInlinedScopeDIE - This scope represents inlined body of 397 /// a function. Construct DIE to represent this concrete inlined copy 398 /// of the function. 399 DIE *constructInlinedScopeDIE(DbgScope *Scope); 400 401 /// constructVariableDIE - Construct a DIE for the given DbgVariable. 402 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S); 403 404 /// constructScopeDIE - Construct a DIE for this scope. 405 DIE *constructScopeDIE(DbgScope *Scope); 406 407 /// EmitSectionLabels - Emit initial Dwarf sections with a label at 408 /// the start of each one. 409 void EmitSectionLabels(); 410 411 /// emitDIE - Recusively Emits a debug information entry. 412 /// 413 void emitDIE(DIE *Die); 414 415 /// computeSizeAndOffset - Compute the size and offset of a DIE. 416 /// 417 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last); 418 419 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs. 420 /// 421 void computeSizeAndOffsets(); 422 423 /// EmitDebugInfo - Emit the debug info section. 424 /// 425 void emitDebugInfo(); 426 427 /// emitAbbreviations - Emit the abbreviation section. 428 /// 429 void emitAbbreviations() const; 430 431 /// emitEndOfLineMatrix - Emit the last address of the section and the end of 432 /// the line matrix. 433 /// 434 void emitEndOfLineMatrix(unsigned SectionEnd); 435 436 /// emitDebugLines - Emit source line information. 437 /// 438 void emitDebugLines(); 439 440 /// emitCommonDebugFrame - Emit common frame info into a debug frame section. 441 /// 442 void emitCommonDebugFrame(); 443 444 /// emitFunctionDebugFrame - Emit per function frame info into a debug frame 445 /// section. 446 void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo); 447 448 /// emitDebugPubNames - Emit visible names into a debug pubnames section. 449 /// 450 void emitDebugPubNames(); 451 452 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section. 453 /// 454 void emitDebugPubTypes(); 455 456 /// emitDebugStr - Emit visible names into a debug str section. 457 /// 458 void emitDebugStr(); 459 460 /// emitDebugLoc - Emit visible names into a debug loc section. 461 /// 462 void emitDebugLoc(); 463 464 /// EmitDebugARanges - Emit visible names into a debug aranges section. 465 /// 466 void EmitDebugARanges(); 467 468 /// emitDebugRanges - Emit visible names into a debug ranges section. 469 /// 470 void emitDebugRanges(); 471 472 /// emitDebugMacInfo - Emit visible names into a debug macinfo section. 473 /// 474 void emitDebugMacInfo(); 475 476 /// emitDebugInlineInfo - Emit inline info using following format. 477 /// Section Header: 478 /// 1. length of section 479 /// 2. Dwarf version number 480 /// 3. address size. 481 /// 482 /// Entries (one "entry" for each function that was inlined): 483 /// 484 /// 1. offset into __debug_str section for MIPS linkage name, if exists; 485 /// otherwise offset into __debug_str for regular function name. 486 /// 2. offset into __debug_str section for regular function name. 487 /// 3. an unsigned LEB128 number indicating the number of distinct inlining 488 /// instances for the function. 489 /// 490 /// The rest of the entry consists of a {die_offset, low_pc} pair for each 491 /// inlined instance; the die_offset points to the inlined_subroutine die in 492 /// the __debug_info section, and the low_pc is the starting address for the 493 /// inlining instance. 494 void emitDebugInlineInfo(); 495 496 /// GetOrCreateSourceID - Look up the source id with the given directory and 497 /// source file names. If none currently exists, create a new id and insert it 498 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames 499 /// maps as well. 500 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName); 501 502 void constructCompileUnit(MDNode *N); 503 504 void constructGlobalVariableDIE(MDNode *N); 505 506 void constructSubprogramDIE(MDNode *N); 507 508 // FIXME: This should go away in favor of complex addresses. 509 /// Find the type the programmer originally declared the variable to be 510 /// and return that type. Obsolete, use GetComplexAddrType instead. 511 /// 512 DIType getBlockByrefType(DIType Ty, std::string Name); 513 514 /// recordSourceLine - Register a source line with debug info. Returns the 515 /// unique label that was emitted and which provides correspondence to 516 /// the source line list. 517 MCSymbol *recordSourceLine(unsigned Line, unsigned Col, MDNode *Scope); 518 519 /// getSourceLineCount - Return the number of source lines in the debug 520 /// info. 521 unsigned getSourceLineCount() const { 522 return Lines.size(); 523 } 524 525 /// identifyScopeMarkers() - Indentify instructions that are marking 526 /// beginning of or end of a scope. 527 void identifyScopeMarkers(); 528 529 /// extractScopeInformation - Scan machine instructions in this function 530 /// and collect DbgScopes. Return true, if atleast one scope was found. 531 bool extractScopeInformation(); 532 533 /// collectVariableInfo - Populate DbgScope entries with variables' info. 534 void collectVariableInfo(); 535 536public: 537 //===--------------------------------------------------------------------===// 538 // Main entry points. 539 // 540 DwarfDebug(AsmPrinter *A, Module *M); 541 ~DwarfDebug(); 542 543 /// beginModule - Emit all Dwarf sections that should come prior to the 544 /// content. 545 void beginModule(Module *M); 546 547 /// endModule - Emit all Dwarf sections that should come after the content. 548 /// 549 void endModule(); 550 551 /// beginFunction - Gather pre-function debug information. Assumes being 552 /// emitted immediately after the function entry point. 553 void beginFunction(const MachineFunction *MF); 554 555 /// endFunction - Gather and emit post-function debug information. 556 /// 557 void endFunction(const MachineFunction *MF); 558 559 /// beginScope - Process beginning of a scope. 560 void beginScope(const MachineInstr *MI); 561 562 /// endScope - Prcess end of a scope. 563 void endScope(const MachineInstr *MI); 564}; 565} // End of namespace llvm 566 567#endif 568