DwarfDebug.h revision f63b226c1187a5fa59d30eaf795c6be7f0a8234e
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 /// AbstractSubprogramDIEs - Collection of abstruct subprogram DIEs. 179 SmallPtrSet<DIE *, 4> AbstractSubprogramDIEs; 180 181 typedef SmallVector<DbgScope *, 2> ScopeVector; 182 183 SmallPtrSet<const MachineInstr *, 8> InsnsBeginScopeSet; 184 SmallPtrSet<const MachineInstr *, 8> InsnsEndScopeSet; 185 186 /// InlineInfo - Keep track of inlined functions and their location. This 187 /// information is used to populate debug_inlined section. 188 typedef std::pair<MCSymbol*, DIE *> InlineInfoLabels; 189 DenseMap<MDNode*, SmallVector<InlineInfoLabels, 4> > InlineInfo; 190 SmallVector<MDNode *, 4> InlinedSPNodes; 191 192 /// InsnBeforeLabelMap - Maps instruction with label emitted before 193 /// instruction. 194 DenseMap<const MachineInstr *, MCSymbol *> InsnBeforeLabelMap; 195 196 /// InsnAfterLabelMap - Maps instruction with label emitted after 197 /// instruction. 198 DenseMap<const MachineInstr *, MCSymbol *> InsnAfterLabelMap; 199 200 /// CompileUnitOffsets - A vector of the offsets of the compile units. This is 201 /// used when calculating the "origin" of a concrete instance of an inlined 202 /// function. 203 DenseMap<CompileUnit *, unsigned> CompileUnitOffsets; 204 205 /// Previous instruction's location information. This is used to determine 206 /// label location to indicate scope boundries in dwarf debug info. 207 DebugLoc PrevInstLoc; 208 209 struct FunctionDebugFrameInfo { 210 unsigned Number; 211 std::vector<MachineMove> Moves; 212 213 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M) 214 : Number(Num), Moves(M) {} 215 }; 216 217 std::vector<FunctionDebugFrameInfo> DebugFrames; 218 219 // Section Symbols: these are assembler temporary labels that are emitted at 220 // the beginning of each supported dwarf section. These are used to form 221 // section offsets and are created by EmitSectionLabels. 222 MCSymbol *DwarfFrameSectionSym, *DwarfInfoSectionSym, *DwarfAbbrevSectionSym; 223 MCSymbol *DwarfStrSectionSym, *TextSectionSym; 224 225private: 226 227 /// getSourceDirectoryAndFileIds - Return the directory and file ids that 228 /// maps to the source id. Source id starts at 1. 229 std::pair<unsigned, unsigned> 230 getSourceDirectoryAndFileIds(unsigned SId) const { 231 return SourceIds[SId-1]; 232 } 233 234 /// getNumSourceDirectories - Return the number of source directories in the 235 /// debug info. 236 unsigned getNumSourceDirectories() const { 237 return DirectoryNames.size(); 238 } 239 240 /// getSourceDirectoryName - Return the name of the directory corresponding 241 /// to the id. 242 const std::string &getSourceDirectoryName(unsigned Id) const { 243 return DirectoryNames[Id - 1]; 244 } 245 246 /// getSourceFileName - Return the name of the source file corresponding 247 /// to the id. 248 const std::string &getSourceFileName(unsigned Id) const { 249 return SourceFileNames[Id - 1]; 250 } 251 252 /// getNumSourceIds - Return the number of unique source ids. 253 unsigned getNumSourceIds() const { 254 return SourceIds.size(); 255 } 256 257 /// assignAbbrevNumber - Define a unique number for the abbreviation. 258 /// 259 void assignAbbrevNumber(DIEAbbrev &Abbrev); 260 261 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug 262 /// information entry. 263 DIEEntry *createDIEEntry(DIE *Entry); 264 265 /// addUInt - Add an unsigned integer attribute data and value. 266 /// 267 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer); 268 269 /// addSInt - Add an signed integer attribute data and value. 270 /// 271 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer); 272 273 /// addString - Add a string attribute data and value. 274 /// 275 void addString(DIE *Die, unsigned Attribute, unsigned Form, 276 const StringRef Str); 277 278 /// addLabel - Add a Dwarf label attribute data and value. 279 /// 280 void addLabel(DIE *Die, unsigned Attribute, unsigned Form, 281 const MCSymbol *Label); 282 283 /// addDelta - Add a label delta attribute data and value. 284 /// 285 void addDelta(DIE *Die, unsigned Attribute, unsigned Form, 286 const MCSymbol *Hi, const MCSymbol *Lo); 287 288 /// addDIEEntry - Add a DIE attribute data and value. 289 /// 290 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry); 291 292 /// addBlock - Add block data. 293 /// 294 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block); 295 296 /// addSourceLine - Add location information to specified debug information 297 /// entry. 298 void addSourceLine(DIE *Die, const DIVariable *V); 299 void addSourceLine(DIE *Die, const DIGlobal *G); 300 void addSourceLine(DIE *Die, const DISubprogram *SP); 301 void addSourceLine(DIE *Die, const DIType *Ty); 302 void addSourceLine(DIE *Die, const DINameSpace *NS); 303 304 /// addAddress - Add an address attribute to a die based on the location 305 /// provided. 306 void addAddress(DIE *Die, unsigned Attribute, 307 const MachineLocation &Location); 308 309 /// addComplexAddress - Start with the address based on the location provided, 310 /// and generate the DWARF information necessary to find the actual variable 311 /// (navigating the extra location information encoded in the type) based on 312 /// the starting location. Add the DWARF information to the die. 313 /// 314 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute, 315 const MachineLocation &Location); 316 317 // FIXME: Should be reformulated in terms of addComplexAddress. 318 /// addBlockByrefAddress - Start with the address based on the location 319 /// provided, and generate the DWARF information necessary to find the 320 /// actual Block variable (navigating the Block struct) based on the 321 /// starting location. Add the DWARF information to the die. Obsolete, 322 /// please use addComplexAddress instead. 323 /// 324 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute, 325 const MachineLocation &Location); 326 327 /// addToContextOwner - Add Die into the list of its context owner's children. 328 void addToContextOwner(DIE *Die, DIDescriptor Context); 329 330 /// addType - Add a new type attribute to the specified entity. 331 void addType(DIE *Entity, DIType Ty); 332 333 334 /// getOrCreateNameSpace - Create a DIE for DINameSpace. 335 DIE *getOrCreateNameSpace(DINameSpace NS); 336 337 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the 338 /// given DIType. 339 DIE *getOrCreateTypeDIE(DIType Ty); 340 341 void addPubTypes(DISubprogram SP); 342 343 /// constructTypeDIE - Construct basic type die from DIBasicType. 344 void constructTypeDIE(DIE &Buffer, 345 DIBasicType BTy); 346 347 /// constructTypeDIE - Construct derived type die from DIDerivedType. 348 void constructTypeDIE(DIE &Buffer, 349 DIDerivedType DTy); 350 351 /// constructTypeDIE - Construct type DIE from DICompositeType. 352 void constructTypeDIE(DIE &Buffer, 353 DICompositeType CTy); 354 355 /// constructSubrangeDIE - Construct subrange DIE from DISubrange. 356 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy); 357 358 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType. 359 void constructArrayTypeDIE(DIE &Buffer, 360 DICompositeType *CTy); 361 362 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator. 363 DIE *constructEnumTypeDIE(DIEnumerator ETy); 364 365 /// createGlobalVariableDIE - Create new DIE using GV. 366 DIE *createGlobalVariableDIE(const DIGlobalVariable &GV); 367 368 /// createMemberDIE - Create new member DIE. 369 DIE *createMemberDIE(const DIDerivedType &DT); 370 371 /// createSubprogramDIE - Create new DIE using SP. 372 DIE *createSubprogramDIE(const DISubprogram &SP, bool MakeDecl = false); 373 374 /// getUpdatedDbgScope - Find or create DbgScope assicated with 375 /// the instruction. Initialize scope and update scope hierarchy. 376 DbgScope *getUpdatedDbgScope(MDNode *N, const MachineInstr *MI, 377 MDNode *InlinedAt); 378 379 /// createDbgScope - Create DbgScope for the scope. 380 void createDbgScope(MDNode *Scope, MDNode *InlinedAt); 381 382 DbgScope *getOrCreateAbstractScope(MDNode *N); 383 384 /// findAbstractVariable - Find abstract variable associated with Var. 385 DbgVariable *findAbstractVariable(DIVariable &Var, unsigned FrameIdx, 386 DebugLoc Loc); 387 DbgVariable *findAbstractVariable(DIVariable &Var, const MachineInstr *MI, 388 DebugLoc Loc); 389 390 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and 391 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes. 392 /// If there are global variables in this scope then create and insert 393 /// DIEs for these variables. 394 DIE *updateSubprogramScopeDIE(MDNode *SPNode); 395 396 /// constructLexicalScope - Construct new DW_TAG_lexical_block 397 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels. 398 DIE *constructLexicalScopeDIE(DbgScope *Scope); 399 400 /// constructInlinedScopeDIE - This scope represents inlined body of 401 /// a function. Construct DIE to represent this concrete inlined copy 402 /// of the function. 403 DIE *constructInlinedScopeDIE(DbgScope *Scope); 404 405 /// constructVariableDIE - Construct a DIE for the given DbgVariable. 406 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S); 407 408 /// constructScopeDIE - Construct a DIE for this scope. 409 DIE *constructScopeDIE(DbgScope *Scope); 410 411 /// EmitSectionLabels - Emit initial Dwarf sections with a label at 412 /// the start of each one. 413 void EmitSectionLabels(); 414 415 /// emitDIE - Recusively Emits a debug information entry. 416 /// 417 void emitDIE(DIE *Die); 418 419 /// computeSizeAndOffset - Compute the size and offset of a DIE. 420 /// 421 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last); 422 423 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs. 424 /// 425 void computeSizeAndOffsets(); 426 427 /// EmitDebugInfo - Emit the debug info section. 428 /// 429 void emitDebugInfo(); 430 431 /// emitAbbreviations - Emit the abbreviation section. 432 /// 433 void emitAbbreviations() const; 434 435 /// emitEndOfLineMatrix - Emit the last address of the section and the end of 436 /// the line matrix. 437 /// 438 void emitEndOfLineMatrix(unsigned SectionEnd); 439 440 /// emitDebugLines - Emit source line information. 441 /// 442 void emitDebugLines(); 443 444 /// emitCommonDebugFrame - Emit common frame info into a debug frame section. 445 /// 446 void emitCommonDebugFrame(); 447 448 /// emitFunctionDebugFrame - Emit per function frame info into a debug frame 449 /// section. 450 void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo); 451 452 /// emitDebugPubNames - Emit visible names into a debug pubnames section. 453 /// 454 void emitDebugPubNames(); 455 456 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section. 457 /// 458 void emitDebugPubTypes(); 459 460 /// emitDebugStr - Emit visible names into a debug str section. 461 /// 462 void emitDebugStr(); 463 464 /// emitDebugLoc - Emit visible names into a debug loc section. 465 /// 466 void emitDebugLoc(); 467 468 /// EmitDebugARanges - Emit visible names into a debug aranges section. 469 /// 470 void EmitDebugARanges(); 471 472 /// emitDebugRanges - Emit visible names into a debug ranges section. 473 /// 474 void emitDebugRanges(); 475 476 /// emitDebugMacInfo - Emit visible names into a debug macinfo section. 477 /// 478 void emitDebugMacInfo(); 479 480 /// emitDebugInlineInfo - Emit inline info using following format. 481 /// Section Header: 482 /// 1. length of section 483 /// 2. Dwarf version number 484 /// 3. address size. 485 /// 486 /// Entries (one "entry" for each function that was inlined): 487 /// 488 /// 1. offset into __debug_str section for MIPS linkage name, if exists; 489 /// otherwise offset into __debug_str for regular function name. 490 /// 2. offset into __debug_str section for regular function name. 491 /// 3. an unsigned LEB128 number indicating the number of distinct inlining 492 /// instances for the function. 493 /// 494 /// The rest of the entry consists of a {die_offset, low_pc} pair for each 495 /// inlined instance; the die_offset points to the inlined_subroutine die in 496 /// the __debug_info section, and the low_pc is the starting address for the 497 /// inlining instance. 498 void emitDebugInlineInfo(); 499 500 /// GetOrCreateSourceID - Look up the source id with the given directory and 501 /// source file names. If none currently exists, create a new id and insert it 502 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames 503 /// maps as well. 504 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName); 505 506 void constructCompileUnit(MDNode *N); 507 508 void constructGlobalVariableDIE(MDNode *N); 509 510 void constructSubprogramDIE(MDNode *N); 511 512 // FIXME: This should go away in favor of complex addresses. 513 /// Find the type the programmer originally declared the variable to be 514 /// and return that type. Obsolete, use GetComplexAddrType instead. 515 /// 516 DIType getBlockByrefType(DIType Ty, std::string Name); 517 518 /// recordSourceLine - Register a source line with debug info. Returns the 519 /// unique label that was emitted and which provides correspondence to 520 /// the source line list. 521 MCSymbol *recordSourceLine(unsigned Line, unsigned Col, MDNode *Scope); 522 523 /// getSourceLineCount - Return the number of source lines in the debug 524 /// info. 525 unsigned getSourceLineCount() const { 526 return Lines.size(); 527 } 528 529 /// identifyScopeMarkers() - Indentify instructions that are marking 530 /// beginning of or end of a scope. 531 void identifyScopeMarkers(); 532 533 /// extractScopeInformation - Scan machine instructions in this function 534 /// and collect DbgScopes. Return true, if atleast one scope was found. 535 bool extractScopeInformation(); 536 537 /// collectVariableInfo - Populate DbgScope entries with variables' info. 538 void collectVariableInfo(); 539 540public: 541 //===--------------------------------------------------------------------===// 542 // Main entry points. 543 // 544 DwarfDebug(AsmPrinter *A, Module *M); 545 ~DwarfDebug(); 546 547 /// beginModule - Emit all Dwarf sections that should come prior to the 548 /// content. 549 void beginModule(Module *M); 550 551 /// endModule - Emit all Dwarf sections that should come after the content. 552 /// 553 void endModule(); 554 555 /// beginFunction - Gather pre-function debug information. Assumes being 556 /// emitted immediately after the function entry point. 557 void beginFunction(const MachineFunction *MF); 558 559 /// endFunction - Gather and emit post-function debug information. 560 /// 561 void endFunction(const MachineFunction *MF); 562 563 /// beginScope - Process beginning of a scope. 564 void beginScope(const MachineInstr *MI); 565 566 /// endScope - Prcess end of a scope. 567 void endScope(const MachineInstr *MI); 568}; 569} // End of namespace llvm 570 571#endif 572