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