DwarfDebug.h revision c1df879dbd07bb4d63e7cc6358ed73263c631c12
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 /// AbstractSubprogramDIEs - Collection of abstruct subprogram DIEs. 158 SmallPtrSet<DIE *, 4> AbstractSubprogramDIEs; 159 160 /// TopLevelDIEs - Collection of top level DIEs. 161 SmallPtrSet<DIE *, 4> TopLevelDIEs; 162 SmallVector<DIE *, 4> TopLevelDIEsVector; 163 164 /// ScopedGVs - Tracks global variables that are not at file scope. 165 /// For example void f() { static int b = 42; } 166 SmallVector<WeakVH, 4> ScopedGVs; 167 168 typedef SmallVector<DbgScope *, 2> ScopeVector; 169 typedef DenseMap<const MachineInstr *, ScopeVector> 170 InsnToDbgScopeMapTy; 171 172 /// DbgScopeBeginMap - Maps instruction with a list of DbgScopes it starts. 173 InsnToDbgScopeMapTy DbgScopeBeginMap; 174 175 /// DbgScopeEndMap - Maps instruction with a list DbgScopes it ends. 176 InsnToDbgScopeMapTy DbgScopeEndMap; 177 178 /// InlineInfo - Keep track of inlined functions and their location. This 179 /// information is used to populate debug_inlined section. 180 typedef std::pair<unsigned, DIE *> InlineInfoLabels; 181 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo; 182 SmallVector<MDNode *, 4> InlinedSPNodes; 183 184 /// CompileUnitOffsets - A vector of the offsets of the compile units. This is 185 /// used when calculating the "origin" of a concrete instance of an inlined 186 /// function. 187 DenseMap<CompileUnit *, unsigned> CompileUnitOffsets; 188 189 /// DebugTimer - Timer for the Dwarf debug writer. 190 Timer *DebugTimer; 191 192 struct FunctionDebugFrameInfo { 193 unsigned Number; 194 std::vector<MachineMove> Moves; 195 196 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M) 197 : Number(Num), Moves(M) {} 198 }; 199 200 std::vector<FunctionDebugFrameInfo> DebugFrames; 201 202 /// getSourceDirectoryAndFileIds - Return the directory and file ids that 203 /// maps to the source id. Source id starts at 1. 204 std::pair<unsigned, unsigned> 205 getSourceDirectoryAndFileIds(unsigned SId) const { 206 return SourceIds[SId-1]; 207 } 208 209 /// getNumSourceDirectories - Return the number of source directories in the 210 /// debug info. 211 unsigned getNumSourceDirectories() const { 212 return DirectoryNames.size(); 213 } 214 215 /// getSourceDirectoryName - Return the name of the directory corresponding 216 /// to the id. 217 const std::string &getSourceDirectoryName(unsigned Id) const { 218 return DirectoryNames[Id - 1]; 219 } 220 221 /// getSourceFileName - Return the name of the source file corresponding 222 /// to the id. 223 const std::string &getSourceFileName(unsigned Id) const { 224 return SourceFileNames[Id - 1]; 225 } 226 227 /// getNumSourceIds - Return the number of unique source ids. 228 unsigned getNumSourceIds() const { 229 return SourceIds.size(); 230 } 231 232 /// assignAbbrevNumber - Define a unique number for the abbreviation. 233 /// 234 void assignAbbrevNumber(DIEAbbrev &Abbrev); 235 236 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug 237 /// information entry. 238 DIEEntry *createDIEEntry(DIE *Entry = NULL); 239 240 /// addUInt - Add an unsigned integer attribute data and value. 241 /// 242 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer); 243 244 /// addSInt - Add an signed integer attribute data and value. 245 /// 246 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer); 247 248 /// addString - Add a string attribute data and value. 249 /// 250 void addString(DIE *Die, unsigned Attribute, unsigned Form, 251 const StringRef Str); 252 253 /// addLabel - Add a Dwarf label attribute data and value. 254 /// 255 void addLabel(DIE *Die, unsigned Attribute, unsigned Form, 256 const DWLabel &Label); 257 258 /// addObjectLabel - Add an non-Dwarf label attribute data and value. 259 /// 260 void addObjectLabel(DIE *Die, unsigned Attribute, unsigned Form, 261 const std::string &Label); 262 263 /// addSectionOffset - Add a section offset label attribute data and value. 264 /// 265 void addSectionOffset(DIE *Die, unsigned Attribute, unsigned Form, 266 const DWLabel &Label, const DWLabel &Section, 267 bool isEH = false, bool useSet = true); 268 269 /// addDelta - Add a label delta attribute data and value. 270 /// 271 void addDelta(DIE *Die, unsigned Attribute, unsigned Form, 272 const DWLabel &Hi, const DWLabel &Lo); 273 274 /// addDIEEntry - Add a DIE attribute data and value. 275 /// 276 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) { 277 Die->addValue(Attribute, Form, createDIEEntry(Entry)); 278 } 279 280 /// addBlock - Add block data. 281 /// 282 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block); 283 284 /// addSourceLine - Add location information to specified debug information 285 /// entry. 286 void addSourceLine(DIE *Die, const DIVariable *V); 287 void addSourceLine(DIE *Die, const DIGlobal *G); 288 void addSourceLine(DIE *Die, const DISubprogram *SP); 289 void addSourceLine(DIE *Die, const DIType *Ty); 290 291 /// addAddress - Add an address attribute to a die based on the location 292 /// provided. 293 void addAddress(DIE *Die, unsigned Attribute, 294 const MachineLocation &Location); 295 296 /// addComplexAddress - Start with the address based on the location provided, 297 /// and generate the DWARF information necessary to find the actual variable 298 /// (navigating the extra location information encoded in the type) based on 299 /// the starting location. Add the DWARF information to the die. 300 /// 301 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute, 302 const MachineLocation &Location); 303 304 // FIXME: Should be reformulated in terms of addComplexAddress. 305 /// addBlockByrefAddress - Start with the address based on the location 306 /// provided, and generate the DWARF information necessary to find the 307 /// actual Block variable (navigating the Block struct) based on the 308 /// starting location. Add the DWARF information to the die. Obsolete, 309 /// please use addComplexAddress instead. 310 /// 311 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute, 312 const MachineLocation &Location); 313 314 /// addType - Add a new type attribute to the specified entity. 315 void addType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty); 316 317 void addPubTypes(DISubprogram SP); 318 319 /// constructTypeDIE - Construct basic type die from DIBasicType. 320 void constructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 321 DIBasicType BTy); 322 323 /// constructTypeDIE - Construct derived type die from DIDerivedType. 324 void constructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 325 DIDerivedType DTy); 326 327 /// constructTypeDIE - Construct type DIE from DICompositeType. 328 void constructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 329 DICompositeType CTy); 330 331 /// constructSubrangeDIE - Construct subrange DIE from DISubrange. 332 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy); 333 334 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType. 335 void constructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 336 DICompositeType *CTy); 337 338 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator. 339 DIE *constructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy); 340 341 /// createGlobalVariableDIE - Create new DIE using GV. 342 DIE *createGlobalVariableDIE(CompileUnit *DW_Unit, 343 const DIGlobalVariable &GV); 344 345 /// createMemberDIE - Create new member DIE. 346 DIE *createMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT); 347 348 /// createSubprogramDIE - Create new DIE using SP. 349 DIE *createSubprogramDIE(CompileUnit *DW_Unit, const DISubprogram &SP); 350 351 /// createMemberSubprogramDIE - Create new member DIE using SP. This 352 /// routine always returns a die with DW_AT_declaration attribute. 353 354 DIE *createMemberSubprogramDIE(CompileUnit *DW_Unit, const DISubprogram &SP); 355 356 /// createRawSubprogramDIE - Create new partially incomplete DIE. This is 357 /// a helper routine used by createMemberSubprogramDIE and 358 /// createSubprogramDIE. 359 DIE *createRawSubprogramDIE(CompileUnit *DW_Unit, const DISubprogram &SP); 360 361 /// findCompileUnit - Get the compile unit for the given descriptor. 362 /// 363 CompileUnit &findCompileUnit(DICompileUnit Unit) const; 364 365 /// createDbgScopeVariable - Create a new scope variable. 366 /// 367 DIE *createDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit); 368 369 /// getUpdatedDbgScope - Find or create DbgScope assicated with 370 /// the instruction. Initialize scope and update scope hierarchy. 371 DbgScope *getUpdatedDbgScope(MDNode *N, const MachineInstr *MI, MDNode *InlinedAt); 372 373 /// createDbgScope - Create DbgScope for the scope. 374 void createDbgScope(MDNode *Scope, MDNode *InlinedAt); 375 376 DbgScope *getOrCreateAbstractScope(MDNode *N); 377 378 /// findAbstractVariable - Find abstract variable associated with Var. 379 DbgVariable *findAbstractVariable(DIVariable &Var, unsigned FrameIdx, 380 DILocation &Loc); 381 382 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and 383 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes. 384 /// If there are global variables in this scope then create and insert 385 /// DIEs for these variables. 386 DIE *updateSubprogramScopeDIE(MDNode *SPNode); 387 388 /// constructLexicalScope - Construct new DW_TAG_lexical_block 389 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels. 390 DIE *constructLexicalScopeDIE(DbgScope *Scope); 391 392 /// constructInlinedScopeDIE - This scope represents inlined body of 393 /// a function. Construct DIE to represent this concrete inlined copy 394 /// of the function. 395 DIE *constructInlinedScopeDIE(DbgScope *Scope); 396 397 /// constructVariableDIE - Construct a DIE for the given DbgVariable. 398 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S, CompileUnit *Unit); 399 400 /// constructScopeDIE - Construct a DIE for this scope. 401 DIE *constructScopeDIE(DbgScope *Scope); 402 403 /// emitInitial - Emit initial Dwarf declarations. This is necessary for cc 404 /// tools to recognize the object file contains Dwarf information. 405 void emitInitial(); 406 407 /// emitDIE - Recusively Emits a debug information entry. 408 /// 409 void emitDIE(DIE *Die); 410 411 /// computeSizeAndOffset - Compute the size and offset of a DIE. 412 /// 413 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last); 414 415 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs. 416 /// 417 void computeSizeAndOffsets(); 418 419 /// EmitDebugInfo / emitDebugInfoPerCU - Emit the debug info section. 420 /// 421 void emitDebugInfoPerCU(CompileUnit *Unit); 422 423 void emitDebugInfo(); 424 425 /// emitAbbreviations - Emit the abbreviation section. 426 /// 427 void emitAbbreviations() const; 428 429 /// emitEndOfLineMatrix - Emit the last address of the section and the end of 430 /// the line matrix. 431 /// 432 void emitEndOfLineMatrix(unsigned SectionEnd); 433 434 /// emitDebugLines - Emit source line information. 435 /// 436 void emitDebugLines(); 437 438 /// emitCommonDebugFrame - Emit common frame info into a debug frame section. 439 /// 440 void emitCommonDebugFrame(); 441 442 /// emitFunctionDebugFrame - Emit per function frame info into a debug frame 443 /// section. 444 void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo); 445 446 void emitDebugPubNamesPerCU(CompileUnit *Unit); 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 maps 499 /// 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 514public: 515 //===--------------------------------------------------------------------===// 516 // Main entry points. 517 // 518 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T); 519 virtual ~DwarfDebug(); 520 521 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should 522 /// be emitted. 523 bool ShouldEmitDwarfDebug() const { return shouldEmit; } 524 525 /// beginModule - Emit all Dwarf sections that should come prior to the 526 /// content. 527 void beginModule(Module *M, MachineModuleInfo *MMI); 528 529 /// endModule - Emit all Dwarf sections that should come after the content. 530 /// 531 void endModule(); 532 533 /// beginFunction - Gather pre-function debug information. Assumes being 534 /// emitted immediately after the function entry point. 535 void beginFunction(MachineFunction *MF); 536 537 /// endFunction - Gather and emit post-function debug information. 538 /// 539 void endFunction(MachineFunction *MF); 540 541 /// recordSourceLine - Records location information and associates it with a 542 /// label. Returns a unique label ID used to generate a label and provide 543 /// correspondence to the source line list. 544 unsigned recordSourceLine(unsigned Line, unsigned Col, MDNode *Scope); 545 546 /// getSourceLineCount - Return the number of source lines in the debug 547 /// info. 548 unsigned getSourceLineCount() const { 549 return Lines.size(); 550 } 551 552 /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be 553 /// timed. Look up the source id with the given directory and source file 554 /// names. If none currently exists, create a new id and insert it in the 555 /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as 556 /// well. 557 unsigned getOrCreateSourceID(const std::string &DirName, 558 const std::string &FileName); 559 560 /// extractScopeInformation - Scan machine instructions in this function 561 /// and collect DbgScopes. Return true, if atleast one scope was found. 562 bool extractScopeInformation(MachineFunction *MF); 563 564 /// collectVariableInfo - Populate DbgScope entries with variables' info. 565 void collectVariableInfo(); 566 567 /// beginScope - Process beginning of a scope starting at Label. 568 void beginScope(const MachineInstr *MI, unsigned Label); 569 570 /// endScope - Prcess end of a scope. 571 void endScope(const MachineInstr *MI); 572}; 573} // End of namespace llvm 574 575#endif 576