DwarfDebug.h revision 6f01d9c2f0a97b0dccde93a232c88f088877819f
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 /// Values - A list of all the unique values in use. 110 /// 111 std::vector<DIEValue *> Values; 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 /// ScopedGVs - Tracks global variables that are not at file scope. 161 /// For example void f() { static int b = 42; } 162 SmallVector<WeakVH, 4> ScopedGVs; 163 164 typedef SmallVector<DbgScope *, 2> ScopeVector; 165 typedef DenseMap<const MachineInstr *, ScopeVector> 166 InsnToDbgScopeMapTy; 167 168 /// DbgScopeBeginMap - Maps instruction with a list of DbgScopes it starts. 169 InsnToDbgScopeMapTy DbgScopeBeginMap; 170 171 /// DbgScopeEndMap - Maps instruction with a list DbgScopes it ends. 172 InsnToDbgScopeMapTy DbgScopeEndMap; 173 174 /// InlineInfo - Keep track of inlined functions and their location. This 175 /// information is used to populate debug_inlined section. 176 typedef std::pair<unsigned, DIE *> InlineInfoLabels; 177 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo; 178 SmallVector<MDNode *, 4> InlinedSPNodes; 179 180 /// CompileUnitOffsets - A vector of the offsets of the compile units. This is 181 /// used when calculating the "origin" of a concrete instance of an inlined 182 /// function. 183 DenseMap<CompileUnit *, unsigned> CompileUnitOffsets; 184 185 /// DebugTimer - Timer for the Dwarf debug writer. 186 Timer *DebugTimer; 187 188 struct FunctionDebugFrameInfo { 189 unsigned Number; 190 std::vector<MachineMove> Moves; 191 192 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M) 193 : Number(Num), Moves(M) {} 194 }; 195 196 std::vector<FunctionDebugFrameInfo> DebugFrames; 197 198 /// getSourceDirectoryAndFileIds - Return the directory and file ids that 199 /// maps to the source id. Source id starts at 1. 200 std::pair<unsigned, unsigned> 201 getSourceDirectoryAndFileIds(unsigned SId) const { 202 return SourceIds[SId-1]; 203 } 204 205 /// getNumSourceDirectories - Return the number of source directories in the 206 /// debug info. 207 unsigned getNumSourceDirectories() const { 208 return DirectoryNames.size(); 209 } 210 211 /// getSourceDirectoryName - Return the name of the directory corresponding 212 /// to the id. 213 const std::string &getSourceDirectoryName(unsigned Id) const { 214 return DirectoryNames[Id - 1]; 215 } 216 217 /// getSourceFileName - Return the name of the source file corresponding 218 /// to the id. 219 const std::string &getSourceFileName(unsigned Id) const { 220 return SourceFileNames[Id - 1]; 221 } 222 223 /// getNumSourceIds - Return the number of unique source ids. 224 unsigned getNumSourceIds() const { 225 return SourceIds.size(); 226 } 227 228 /// AssignAbbrevNumber - Define a unique number for the abbreviation. 229 /// 230 void AssignAbbrevNumber(DIEAbbrev &Abbrev); 231 232 /// CreateDIEEntry - Creates a new DIEEntry to be a proxy for a debug 233 /// information entry. 234 DIEEntry *CreateDIEEntry(DIE *Entry = NULL); 235 236 /// SetDIEEntry - Set a DIEEntry once the debug information entry is defined. 237 /// 238 void SetDIEEntry(DIEEntry *Value, DIE *Entry); 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 std::string &String); 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 /// ConstructTypeDIE - Construct basic type die from DIBasicType. 318 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 319 DIBasicType BTy); 320 321 /// ConstructTypeDIE - Construct derived type die from DIDerivedType. 322 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 323 DIDerivedType DTy); 324 325 /// ConstructTypeDIE - Construct type DIE from DICompositeType. 326 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 327 DICompositeType CTy); 328 329 /// ConstructSubrangeDIE - Construct subrange DIE from DISubrange. 330 void ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy); 331 332 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType. 333 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 334 DICompositeType *CTy); 335 336 /// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator. 337 DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy); 338 339 /// CreateGlobalVariableDIE - Create new DIE using GV. 340 DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit, 341 const DIGlobalVariable &GV); 342 343 /// CreateMemberDIE - Create new member DIE. 344 DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT); 345 346 /// CreateSubprogramDIE - Create new DIE using SP. 347 DIE *CreateSubprogramDIE(CompileUnit *DW_Unit, 348 const DISubprogram &SP, 349 bool IsConstructor = false, 350 bool IsInlined = false); 351 352 /// FindCompileUnit - Get the compile unit for the given descriptor. 353 /// 354 CompileUnit &FindCompileUnit(DICompileUnit Unit) const; 355 356 /// CreateDbgScopeVariable - Create a new scope variable. 357 /// 358 DIE *CreateDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit); 359 360 /// getUpdatedDbgScope - Find or create DbgScope assicated with 361 /// the instruction. Initialize scope and update scope hierarchy. 362 DbgScope *getUpdatedDbgScope(MDNode *N, const MachineInstr *MI, MDNode *InlinedAt); 363 364 /// createDbgScope - Create DbgScope for the scope. 365 void createDbgScope(MDNode *Scope, MDNode *InlinedAt); 366 367 DbgScope *getOrCreateAbstractScope(MDNode *N); 368 369 /// findAbstractVariable - Find abstract variable associated with Var. 370 DbgVariable *findAbstractVariable(DIVariable &Var, unsigned FrameIdx, 371 DILocation &Loc); 372 373 DIE *UpdateSubprogramScopeDIE(MDNode *SPNode); 374 DIE *ConstructLexicalScopeDIE(DbgScope *Scope); 375 DIE *ConstructScopeDIE(DbgScope *Scope); 376 DIE *ConstructInlinedScopeDIE(DbgScope *Scope); 377 DIE *ConstructVariableDIE(DbgVariable *DV, DbgScope *S, CompileUnit *Unit); 378 379 /// ConstructDbgScope - Construct the components of a scope. 380 /// 381 void ConstructDbgScope(DbgScope *ParentScope, 382 unsigned ParentStartID, unsigned ParentEndID, 383 DIE *ParentDie, CompileUnit *Unit); 384 385 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc 386 /// tools to recognize the object file contains Dwarf information. 387 void EmitInitial(); 388 389 /// EmitDIE - Recusively Emits a debug information entry. 390 /// 391 void EmitDIE(DIE *Die); 392 393 /// SizeAndOffsetDie - Compute the size and offset of a DIE. 394 /// 395 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last); 396 397 /// SizeAndOffsets - Compute the size and offset of all the DIEs. 398 /// 399 void SizeAndOffsets(); 400 401 /// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section. 402 /// 403 void EmitDebugInfoPerCU(CompileUnit *Unit); 404 405 void EmitDebugInfo(); 406 407 /// EmitAbbreviations - Emit the abbreviation section. 408 /// 409 void EmitAbbreviations() const; 410 411 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of 412 /// the line matrix. 413 /// 414 void EmitEndOfLineMatrix(unsigned SectionEnd); 415 416 /// EmitDebugLines - Emit source line information. 417 /// 418 void EmitDebugLines(); 419 420 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section. 421 /// 422 void EmitCommonDebugFrame(); 423 424 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame 425 /// section. 426 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo); 427 428 void EmitDebugPubNamesPerCU(CompileUnit *Unit); 429 430 /// EmitDebugPubNames - Emit visible names into a debug pubnames section. 431 /// 432 void EmitDebugPubNames(); 433 434 /// EmitDebugStr - Emit visible names into a debug str section. 435 /// 436 void EmitDebugStr(); 437 438 /// EmitDebugLoc - Emit visible names into a debug loc section. 439 /// 440 void EmitDebugLoc(); 441 442 /// EmitDebugARanges - Emit visible names into a debug aranges section. 443 /// 444 void EmitDebugARanges(); 445 446 /// EmitDebugRanges - Emit visible names into a debug ranges section. 447 /// 448 void EmitDebugRanges(); 449 450 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section. 451 /// 452 void EmitDebugMacInfo(); 453 454 /// EmitDebugInlineInfo - Emit inline info using following format. 455 /// Section Header: 456 /// 1. length of section 457 /// 2. Dwarf version number 458 /// 3. address size. 459 /// 460 /// Entries (one "entry" for each function that was inlined): 461 /// 462 /// 1. offset into __debug_str section for MIPS linkage name, if exists; 463 /// otherwise offset into __debug_str for regular function name. 464 /// 2. offset into __debug_str section for regular function name. 465 /// 3. an unsigned LEB128 number indicating the number of distinct inlining 466 /// instances for the function. 467 /// 468 /// The rest of the entry consists of a {die_offset, low_pc} pair for each 469 /// inlined instance; the die_offset points to the inlined_subroutine die in 470 /// the __debug_info section, and the low_pc is the starting address for the 471 /// inlining instance. 472 void EmitDebugInlineInfo(); 473 474 /// GetOrCreateSourceID - Look up the source id with the given directory and 475 /// source file names. If none currently exists, create a new id and insert it 476 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps 477 /// as well. 478 unsigned GetOrCreateSourceID(const char *DirName, 479 const char *FileName); 480 481 void ConstructCompileUnit(MDNode *N); 482 483 void ConstructGlobalVariableDIE(MDNode *N); 484 485 void ConstructSubprogram(MDNode *N); 486 487 // FIXME: This should go away in favor of complex addresses. 488 /// Find the type the programmer originally declared the variable to be 489 /// and return that type. Obsolete, use GetComplexAddrType instead. 490 /// 491 DIType GetBlockByrefType(DIType Ty, std::string Name); 492 493public: 494 //===--------------------------------------------------------------------===// 495 // Main entry points. 496 // 497 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T); 498 virtual ~DwarfDebug(); 499 500 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should 501 /// be emitted. 502 bool ShouldEmitDwarfDebug() const { return shouldEmit; } 503 504 /// BeginModule - Emit all Dwarf sections that should come prior to the 505 /// content. 506 void BeginModule(Module *M, MachineModuleInfo *MMI); 507 508 /// EndModule - Emit all Dwarf sections that should come after the content. 509 /// 510 void EndModule(); 511 512 /// BeginFunction - Gather pre-function debug information. Assumes being 513 /// emitted immediately after the function entry point. 514 void BeginFunction(MachineFunction *MF); 515 516 /// EndFunction - Gather and emit post-function debug information. 517 /// 518 void EndFunction(MachineFunction *MF); 519 520 /// RecordSourceLine - Records location information and associates it with a 521 /// label. Returns a unique label ID used to generate a label and provide 522 /// correspondence to the source line list. 523 unsigned RecordSourceLine(unsigned Line, unsigned Col, MDNode *Scope); 524 525 /// getRecordSourceLineCount - Return the number of source lines in the debug 526 /// info. 527 unsigned getRecordSourceLineCount() const { 528 return Lines.size(); 529 } 530 531 /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be 532 /// timed. Look up the source id with the given directory and source file 533 /// names. If none currently exists, create a new id and insert it in the 534 /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as 535 /// well. 536 unsigned getOrCreateSourceID(const std::string &DirName, 537 const std::string &FileName); 538 539 /// ExtractScopeInformation - Scan machine instructions in this function 540 /// and collect DbgScopes. Return true, if atleast one scope was found. 541 bool ExtractScopeInformation(MachineFunction *MF); 542 543 /// CollectVariableInfo - Populate DbgScope entries with variables' info. 544 void CollectVariableInfo(); 545 546 /// SetDbgScopeEndLabels - Update DbgScope end labels for the scopes that 547 /// end with this machine instruction. 548 void SetDbgScopeEndLabels(const MachineInstr *MI, unsigned Label); 549 550 /// BeginScope - Process beginning of a scope starting at Label. 551 void BeginScope(const MachineInstr *MI, unsigned Label); 552 553 /// EndScope - Prcess end of a scope. 554 void EndScope(const MachineInstr *MI); 555}; 556} // End of namespace llvm 557 558#endif 559