DwarfDebug.cpp revision b71a16d10dd47f70947386064783eeac2abe29b2
1//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===// 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#define DEBUG_TYPE "dwarfdebug" 14#include "DwarfDebug.h" 15#include "llvm/Module.h" 16#include "llvm/CodeGen/MachineFunction.h" 17#include "llvm/CodeGen/MachineModuleInfo.h" 18#include "llvm/MC/MCSection.h" 19#include "llvm/MC/MCStreamer.h" 20#include "llvm/MC/MCAsmInfo.h" 21#include "llvm/Target/TargetData.h" 22#include "llvm/Target/TargetFrameInfo.h" 23#include "llvm/Target/TargetLoweringObjectFile.h" 24#include "llvm/Target/TargetRegisterInfo.h" 25#include "llvm/ADT/StringExtras.h" 26#include "llvm/Support/Mangler.h" 27#include "llvm/Support/Timer.h" 28#include "llvm/Support/Debug.h" 29#include "llvm/System/Path.h" 30using namespace llvm; 31 32static TimerGroup &getDwarfTimerGroup() { 33 static TimerGroup DwarfTimerGroup("Dwarf Debugging"); 34 return DwarfTimerGroup; 35} 36 37//===----------------------------------------------------------------------===// 38 39/// Configuration values for initial hash set sizes (log2). 40/// 41static const unsigned InitDiesSetSize = 9; // log2(512) 42static const unsigned InitAbbreviationsSetSize = 9; // log2(512) 43static const unsigned InitValuesSetSize = 9; // log2(512) 44 45namespace llvm { 46 47//===----------------------------------------------------------------------===// 48/// CompileUnit - This dwarf writer support class manages information associate 49/// with a source file. 50class VISIBILITY_HIDDEN CompileUnit { 51 /// ID - File identifier for source. 52 /// 53 unsigned ID; 54 55 /// Die - Compile unit debug information entry. 56 /// 57 DIE *Die; 58 59 /// GVToDieMap - Tracks the mapping of unit level debug informaton 60 /// variables to debug information entries. 61 /// FIXME : Rename GVToDieMap -> NodeToDieMap 62 std::map<MDNode *, DIE *> GVToDieMap; 63 64 /// GVToDIEEntryMap - Tracks the mapping of unit level debug informaton 65 /// descriptors to debug information entries using a DIEEntry proxy. 66 /// FIXME : Rename 67 std::map<MDNode *, DIEEntry *> GVToDIEEntryMap; 68 69 /// Globals - A map of globally visible named entities for this unit. 70 /// 71 StringMap<DIE*> Globals; 72 73 /// DiesSet - Used to uniquely define dies within the compile unit. 74 /// 75 FoldingSet<DIE> DiesSet; 76public: 77 CompileUnit(unsigned I, DIE *D) 78 : ID(I), Die(D), DiesSet(InitDiesSetSize) {} 79 ~CompileUnit() { delete Die; } 80 81 // Accessors. 82 unsigned getID() const { return ID; } 83 DIE* getDie() const { return Die; } 84 StringMap<DIE*> &getGlobals() { return Globals; } 85 86 /// hasContent - Return true if this compile unit has something to write out. 87 /// 88 bool hasContent() const { return !Die->getChildren().empty(); } 89 90 /// AddGlobal - Add a new global entity to the compile unit. 91 /// 92 void AddGlobal(const std::string &Name, DIE *Die) { Globals[Name] = Die; } 93 94 /// getDieMapSlotFor - Returns the debug information entry map slot for the 95 /// specified debug variable. 96 DIE *&getDieMapSlotFor(MDNode *N) { return GVToDieMap[N]; } 97 98 /// getDIEEntrySlotFor - Returns the debug information entry proxy slot for 99 /// the specified debug variable. 100 DIEEntry *&getDIEEntrySlotFor(MDNode *N) { 101 return GVToDIEEntryMap[N]; 102 } 103 104 /// AddDie - Adds or interns the DIE to the compile unit. 105 /// 106 DIE *AddDie(DIE &Buffer) { 107 FoldingSetNodeID ID; 108 Buffer.Profile(ID); 109 void *Where; 110 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where); 111 112 if (!Die) { 113 Die = new DIE(Buffer); 114 DiesSet.InsertNode(Die, Where); 115 this->Die->AddChild(Die); 116 Buffer.Detach(); 117 } 118 119 return Die; 120 } 121}; 122 123//===----------------------------------------------------------------------===// 124/// DbgVariable - This class is used to track local variable information. 125/// 126class VISIBILITY_HIDDEN DbgVariable { 127 DIVariable Var; // Variable Descriptor. 128 unsigned FrameIndex; // Variable frame index. 129 bool InlinedFnVar; // Variable for an inlined function. 130public: 131 DbgVariable(DIVariable V, unsigned I, bool IFV) 132 : Var(V), FrameIndex(I), InlinedFnVar(IFV) {} 133 134 // Accessors. 135 DIVariable getVariable() const { return Var; } 136 unsigned getFrameIndex() const { return FrameIndex; } 137 bool isInlinedFnVar() const { return InlinedFnVar; } 138}; 139 140//===----------------------------------------------------------------------===// 141/// DbgScope - This class is used to track scope information. 142/// 143class DbgConcreteScope; 144class VISIBILITY_HIDDEN DbgScope { 145 DbgScope *Parent; // Parent to this scope. 146 DIDescriptor Desc; // Debug info descriptor for scope. 147 // Either subprogram or block. 148 unsigned StartLabelID; // Label ID of the beginning of scope. 149 unsigned EndLabelID; // Label ID of the end of scope. 150 const MachineInstr *LastInsn; // Last instruction of this scope. 151 const MachineInstr *FirstInsn; // First instruction of this scope. 152 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope. 153 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope. 154 SmallVector<DbgConcreteScope *, 8> ConcreteInsts;// Concrete insts of funcs. 155 156 // Private state for dump() 157 mutable unsigned IndentLevel; 158public: 159 DbgScope(DbgScope *P, DIDescriptor D) 160 : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), LastInsn(0), 161 FirstInsn(0), IndentLevel(0) {} 162 virtual ~DbgScope(); 163 164 // Accessors. 165 DbgScope *getParent() const { return Parent; } 166 DIDescriptor getDesc() const { return Desc; } 167 unsigned getStartLabelID() const { return StartLabelID; } 168 unsigned getEndLabelID() const { return EndLabelID; } 169 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; } 170 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; } 171 SmallVector<DbgConcreteScope*,8> &getConcreteInsts() { return ConcreteInsts; } 172 void setStartLabelID(unsigned S) { StartLabelID = S; } 173 void setEndLabelID(unsigned E) { EndLabelID = E; } 174 void setLastInsn(const MachineInstr *MI) { LastInsn = MI; } 175 const MachineInstr *getLastInsn() { return LastInsn; } 176 void setFirstInsn(const MachineInstr *MI) { FirstInsn = MI; } 177 const MachineInstr *getFirstInsn() { return FirstInsn; } 178 /// AddScope - Add a scope to the scope. 179 /// 180 void AddScope(DbgScope *S) { Scopes.push_back(S); } 181 182 /// AddVariable - Add a variable to the scope. 183 /// 184 void AddVariable(DbgVariable *V) { Variables.push_back(V); } 185 186 /// AddConcreteInst - Add a concrete instance to the scope. 187 /// 188 void AddConcreteInst(DbgConcreteScope *C) { ConcreteInsts.push_back(C); } 189 190 void FixInstructionMarkers() { 191 assert (getFirstInsn() && "First instruction is missing!"); 192 if (getLastInsn()) 193 return; 194 195 // If a scope does not have an instruction to mark an end then use 196 // the end of last child scope. 197 SmallVector<DbgScope *, 4> &Scopes = getScopes(); 198 assert (!Scopes.empty() && "Inner most scope does not have last insn!"); 199 DbgScope *L = Scopes.back(); 200 if (!L->getLastInsn()) 201 L->FixInstructionMarkers(); 202 setLastInsn(L->getLastInsn()); 203 } 204 205#ifndef NDEBUG 206 void dump() const; 207#endif 208}; 209 210#ifndef NDEBUG 211void DbgScope::dump() const { 212 raw_ostream &err = errs(); 213 err.indent(IndentLevel); 214 Desc.dump(); 215 err << " [" << StartLabelID << ", " << EndLabelID << "]\n"; 216 217 IndentLevel += 2; 218 219 for (unsigned i = 0, e = Scopes.size(); i != e; ++i) 220 if (Scopes[i] != this) 221 Scopes[i]->dump(); 222 223 IndentLevel -= 2; 224} 225#endif 226 227//===----------------------------------------------------------------------===// 228/// DbgConcreteScope - This class is used to track a scope that holds concrete 229/// instance information. 230/// 231class VISIBILITY_HIDDEN DbgConcreteScope : public DbgScope { 232 CompileUnit *Unit; 233 DIE *Die; // Debug info for this concrete scope. 234public: 235 DbgConcreteScope(DIDescriptor D) : DbgScope(NULL, D) {} 236 237 // Accessors. 238 DIE *getDie() const { return Die; } 239 void setDie(DIE *D) { Die = D; } 240}; 241 242DbgScope::~DbgScope() { 243 for (unsigned i = 0, N = Scopes.size(); i < N; ++i) 244 delete Scopes[i]; 245 for (unsigned j = 0, M = Variables.size(); j < M; ++j) 246 delete Variables[j]; 247 for (unsigned k = 0, O = ConcreteInsts.size(); k < O; ++k) 248 delete ConcreteInsts[k]; 249} 250 251} // end llvm namespace 252 253DwarfDebug::DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T) 254 : Dwarf(OS, A, T, "dbg"), ModuleCU(0), 255 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(), 256 ValuesSet(InitValuesSetSize), Values(), StringPool(), 257 SectionSourceLines(), didInitial(false), shouldEmit(false), 258 FunctionDbgScope(0), DebugTimer(0) { 259 if (TimePassesIsEnabled) 260 DebugTimer = new Timer("Dwarf Debug Writer", 261 getDwarfTimerGroup()); 262} 263DwarfDebug::~DwarfDebug() { 264 for (unsigned j = 0, M = Values.size(); j < M; ++j) 265 delete Values[j]; 266 267 for (DenseMap<const MDNode *, DbgScope *>::iterator 268 I = AbstractInstanceRootMap.begin(), 269 E = AbstractInstanceRootMap.end(); I != E;++I) 270 delete I->second; 271 272 delete DebugTimer; 273} 274 275/// AssignAbbrevNumber - Define a unique number for the abbreviation. 276/// 277void DwarfDebug::AssignAbbrevNumber(DIEAbbrev &Abbrev) { 278 // Profile the node so that we can make it unique. 279 FoldingSetNodeID ID; 280 Abbrev.Profile(ID); 281 282 // Check the set for priors. 283 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev); 284 285 // If it's newly added. 286 if (InSet == &Abbrev) { 287 // Add to abbreviation list. 288 Abbreviations.push_back(&Abbrev); 289 290 // Assign the vector position + 1 as its number. 291 Abbrev.setNumber(Abbreviations.size()); 292 } else { 293 // Assign existing abbreviation number. 294 Abbrev.setNumber(InSet->getNumber()); 295 } 296} 297 298/// CreateDIEEntry - Creates a new DIEEntry to be a proxy for a debug 299/// information entry. 300DIEEntry *DwarfDebug::CreateDIEEntry(DIE *Entry) { 301 DIEEntry *Value; 302 303 if (Entry) { 304 FoldingSetNodeID ID; 305 DIEEntry::Profile(ID, Entry); 306 void *Where; 307 Value = static_cast<DIEEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where)); 308 309 if (Value) return Value; 310 311 Value = new DIEEntry(Entry); 312 ValuesSet.InsertNode(Value, Where); 313 } else { 314 Value = new DIEEntry(Entry); 315 } 316 317 Values.push_back(Value); 318 return Value; 319} 320 321/// SetDIEEntry - Set a DIEEntry once the debug information entry is defined. 322/// 323void DwarfDebug::SetDIEEntry(DIEEntry *Value, DIE *Entry) { 324 Value->setEntry(Entry); 325 326 // Add to values set if not already there. If it is, we merely have a 327 // duplicate in the values list (no harm.) 328 ValuesSet.GetOrInsertNode(Value); 329} 330 331/// AddUInt - Add an unsigned integer attribute data and value. 332/// 333void DwarfDebug::AddUInt(DIE *Die, unsigned Attribute, 334 unsigned Form, uint64_t Integer) { 335 if (!Form) Form = DIEInteger::BestForm(false, Integer); 336 337 FoldingSetNodeID ID; 338 DIEInteger::Profile(ID, Integer); 339 void *Where; 340 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where); 341 342 if (!Value) { 343 Value = new DIEInteger(Integer); 344 ValuesSet.InsertNode(Value, Where); 345 Values.push_back(Value); 346 } 347 348 Die->AddValue(Attribute, Form, Value); 349} 350 351/// AddSInt - Add an signed integer attribute data and value. 352/// 353void DwarfDebug::AddSInt(DIE *Die, unsigned Attribute, 354 unsigned Form, int64_t Integer) { 355 if (!Form) Form = DIEInteger::BestForm(true, Integer); 356 357 FoldingSetNodeID ID; 358 DIEInteger::Profile(ID, (uint64_t)Integer); 359 void *Where; 360 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where); 361 362 if (!Value) { 363 Value = new DIEInteger(Integer); 364 ValuesSet.InsertNode(Value, Where); 365 Values.push_back(Value); 366 } 367 368 Die->AddValue(Attribute, Form, Value); 369} 370 371/// AddString - Add a string attribute data and value. 372/// 373void DwarfDebug::AddString(DIE *Die, unsigned Attribute, unsigned Form, 374 const std::string &String) { 375 FoldingSetNodeID ID; 376 DIEString::Profile(ID, String); 377 void *Where; 378 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where); 379 380 if (!Value) { 381 Value = new DIEString(String); 382 ValuesSet.InsertNode(Value, Where); 383 Values.push_back(Value); 384 } 385 386 Die->AddValue(Attribute, Form, Value); 387} 388 389/// AddLabel - Add a Dwarf label attribute data and value. 390/// 391void DwarfDebug::AddLabel(DIE *Die, unsigned Attribute, unsigned Form, 392 const DWLabel &Label) { 393 FoldingSetNodeID ID; 394 DIEDwarfLabel::Profile(ID, Label); 395 void *Where; 396 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where); 397 398 if (!Value) { 399 Value = new DIEDwarfLabel(Label); 400 ValuesSet.InsertNode(Value, Where); 401 Values.push_back(Value); 402 } 403 404 Die->AddValue(Attribute, Form, Value); 405} 406 407/// AddObjectLabel - Add an non-Dwarf label attribute data and value. 408/// 409void DwarfDebug::AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form, 410 const std::string &Label) { 411 FoldingSetNodeID ID; 412 DIEObjectLabel::Profile(ID, Label); 413 void *Where; 414 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where); 415 416 if (!Value) { 417 Value = new DIEObjectLabel(Label); 418 ValuesSet.InsertNode(Value, Where); 419 Values.push_back(Value); 420 } 421 422 Die->AddValue(Attribute, Form, Value); 423} 424 425/// AddSectionOffset - Add a section offset label attribute data and value. 426/// 427void DwarfDebug::AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form, 428 const DWLabel &Label, const DWLabel &Section, 429 bool isEH, bool useSet) { 430 FoldingSetNodeID ID; 431 DIESectionOffset::Profile(ID, Label, Section); 432 void *Where; 433 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where); 434 435 if (!Value) { 436 Value = new DIESectionOffset(Label, Section, isEH, useSet); 437 ValuesSet.InsertNode(Value, Where); 438 Values.push_back(Value); 439 } 440 441 Die->AddValue(Attribute, Form, Value); 442} 443 444/// AddDelta - Add a label delta attribute data and value. 445/// 446void DwarfDebug::AddDelta(DIE *Die, unsigned Attribute, unsigned Form, 447 const DWLabel &Hi, const DWLabel &Lo) { 448 FoldingSetNodeID ID; 449 DIEDelta::Profile(ID, Hi, Lo); 450 void *Where; 451 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where); 452 453 if (!Value) { 454 Value = new DIEDelta(Hi, Lo); 455 ValuesSet.InsertNode(Value, Where); 456 Values.push_back(Value); 457 } 458 459 Die->AddValue(Attribute, Form, Value); 460} 461 462/// AddBlock - Add block data. 463/// 464void DwarfDebug::AddBlock(DIE *Die, unsigned Attribute, unsigned Form, 465 DIEBlock *Block) { 466 Block->ComputeSize(TD); 467 FoldingSetNodeID ID; 468 Block->Profile(ID); 469 void *Where; 470 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where); 471 472 if (!Value) { 473 Value = Block; 474 ValuesSet.InsertNode(Value, Where); 475 Values.push_back(Value); 476 } else { 477 // Already exists, reuse the previous one. 478 delete Block; 479 Block = cast<DIEBlock>(Value); 480 } 481 482 Die->AddValue(Attribute, Block->BestForm(), Value); 483} 484 485/// AddSourceLine - Add location information to specified debug information 486/// entry. 487void DwarfDebug::AddSourceLine(DIE *Die, const DIVariable *V) { 488 // If there is no compile unit specified, don't add a line #. 489 if (V->getCompileUnit().isNull()) 490 return; 491 492 unsigned Line = V->getLineNumber(); 493 unsigned FileID = FindCompileUnit(V->getCompileUnit()).getID(); 494 assert(FileID && "Invalid file id"); 495 AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID); 496 AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line); 497} 498 499/// AddSourceLine - Add location information to specified debug information 500/// entry. 501void DwarfDebug::AddSourceLine(DIE *Die, const DIGlobal *G) { 502 // If there is no compile unit specified, don't add a line #. 503 if (G->getCompileUnit().isNull()) 504 return; 505 506 unsigned Line = G->getLineNumber(); 507 unsigned FileID = FindCompileUnit(G->getCompileUnit()).getID(); 508 assert(FileID && "Invalid file id"); 509 AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID); 510 AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line); 511} 512 513/// AddSourceLine - Add location information to specified debug information 514/// entry. 515void DwarfDebug::AddSourceLine(DIE *Die, const DISubprogram *SP) { 516 // If there is no compile unit specified, don't add a line #. 517 if (SP->getCompileUnit().isNull()) 518 return; 519 // If the line number is 0, don't add it. 520 if (SP->getLineNumber() == 0) 521 return; 522 523 524 unsigned Line = SP->getLineNumber(); 525 unsigned FileID = FindCompileUnit(SP->getCompileUnit()).getID(); 526 assert(FileID && "Invalid file id"); 527 AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID); 528 AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line); 529} 530 531/// AddSourceLine - Add location information to specified debug information 532/// entry. 533void DwarfDebug::AddSourceLine(DIE *Die, const DIType *Ty) { 534 // If there is no compile unit specified, don't add a line #. 535 DICompileUnit CU = Ty->getCompileUnit(); 536 if (CU.isNull()) 537 return; 538 539 unsigned Line = Ty->getLineNumber(); 540 unsigned FileID = FindCompileUnit(CU).getID(); 541 assert(FileID && "Invalid file id"); 542 AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID); 543 AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line); 544} 545 546/* Byref variables, in Blocks, are declared by the programmer as 547 "SomeType VarName;", but the compiler creates a 548 __Block_byref_x_VarName struct, and gives the variable VarName 549 either the struct, or a pointer to the struct, as its type. This 550 is necessary for various behind-the-scenes things the compiler 551 needs to do with by-reference variables in blocks. 552 553 However, as far as the original *programmer* is concerned, the 554 variable should still have type 'SomeType', as originally declared. 555 556 The following function dives into the __Block_byref_x_VarName 557 struct to find the original type of the variable. This will be 558 passed back to the code generating the type for the Debug 559 Information Entry for the variable 'VarName'. 'VarName' will then 560 have the original type 'SomeType' in its debug information. 561 562 The original type 'SomeType' will be the type of the field named 563 'VarName' inside the __Block_byref_x_VarName struct. 564 565 NOTE: In order for this to not completely fail on the debugger 566 side, the Debug Information Entry for the variable VarName needs to 567 have a DW_AT_location that tells the debugger how to unwind through 568 the pointers and __Block_byref_x_VarName struct to find the actual 569 value of the variable. The function AddBlockByrefType does this. */ 570 571/// Find the type the programmer originally declared the variable to be 572/// and return that type. 573/// 574DIType DwarfDebug::GetBlockByrefType(DIType Ty, std::string Name) { 575 576 DIType subType = Ty; 577 unsigned tag = Ty.getTag(); 578 579 if (tag == dwarf::DW_TAG_pointer_type) { 580 DIDerivedType DTy = DIDerivedType(Ty.getNode()); 581 subType = DTy.getTypeDerivedFrom(); 582 } 583 584 DICompositeType blockStruct = DICompositeType(subType.getNode()); 585 586 DIArray Elements = blockStruct.getTypeArray(); 587 588 if (Elements.isNull()) 589 return Ty; 590 591 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) { 592 DIDescriptor Element = Elements.getElement(i); 593 DIDerivedType DT = DIDerivedType(Element.getNode()); 594 if (strcmp(Name.c_str(), DT.getName()) == 0) 595 return (DT.getTypeDerivedFrom()); 596 } 597 598 return Ty; 599} 600 601/// AddComplexAddress - Start with the address based on the location provided, 602/// and generate the DWARF information necessary to find the actual variable 603/// given the extra address information encoded in the DIVariable, starting from 604/// the starting location. Add the DWARF information to the die. 605/// 606void DwarfDebug::AddComplexAddress(DbgVariable *&DV, DIE *Die, 607 unsigned Attribute, 608 const MachineLocation &Location) { 609 const DIVariable &VD = DV->getVariable(); 610 DIType Ty = VD.getType(); 611 612 // Decode the original location, and use that as the start of the byref 613 // variable's location. 614 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false); 615 DIEBlock *Block = new DIEBlock(); 616 617 if (Location.isReg()) { 618 if (Reg < 32) { 619 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg); 620 } else { 621 Reg = Reg - dwarf::DW_OP_reg0; 622 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg); 623 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg); 624 } 625 } else { 626 if (Reg < 32) 627 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg); 628 else { 629 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx); 630 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg); 631 } 632 633 AddUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset()); 634 } 635 636 for (unsigned i = 0, N = VD.getNumAddrElements(); i < N; ++i) { 637 uint64_t Element = VD.getAddrElement(i); 638 639 if (Element == DIFactory::OpPlus) { 640 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst); 641 AddUInt(Block, 0, dwarf::DW_FORM_udata, VD.getAddrElement(++i)); 642 } else if (Element == DIFactory::OpDeref) { 643 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref); 644 } else llvm_unreachable("unknown DIFactory Opcode"); 645 } 646 647 // Now attach the location information to the DIE. 648 AddBlock(Die, Attribute, 0, Block); 649} 650 651/* Byref variables, in Blocks, are declared by the programmer as "SomeType 652 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and 653 gives the variable VarName either the struct, or a pointer to the struct, as 654 its type. This is necessary for various behind-the-scenes things the 655 compiler needs to do with by-reference variables in Blocks. 656 657 However, as far as the original *programmer* is concerned, the variable 658 should still have type 'SomeType', as originally declared. 659 660 The function GetBlockByrefType dives into the __Block_byref_x_VarName 661 struct to find the original type of the variable, which is then assigned to 662 the variable's Debug Information Entry as its real type. So far, so good. 663 However now the debugger will expect the variable VarName to have the type 664 SomeType. So we need the location attribute for the variable to be an 665 expression that explains to the debugger how to navigate through the 666 pointers and struct to find the actual variable of type SomeType. 667 668 The following function does just that. We start by getting 669 the "normal" location for the variable. This will be the location 670 of either the struct __Block_byref_x_VarName or the pointer to the 671 struct __Block_byref_x_VarName. 672 673 The struct will look something like: 674 675 struct __Block_byref_x_VarName { 676 ... <various fields> 677 struct __Block_byref_x_VarName *forwarding; 678 ... <various other fields> 679 SomeType VarName; 680 ... <maybe more fields> 681 }; 682 683 If we are given the struct directly (as our starting point) we 684 need to tell the debugger to: 685 686 1). Add the offset of the forwarding field. 687 688 2). Follow that pointer to get the the real __Block_byref_x_VarName 689 struct to use (the real one may have been copied onto the heap). 690 691 3). Add the offset for the field VarName, to find the actual variable. 692 693 If we started with a pointer to the struct, then we need to 694 dereference that pointer first, before the other steps. 695 Translating this into DWARF ops, we will need to append the following 696 to the current location description for the variable: 697 698 DW_OP_deref -- optional, if we start with a pointer 699 DW_OP_plus_uconst <forward_fld_offset> 700 DW_OP_deref 701 DW_OP_plus_uconst <varName_fld_offset> 702 703 That is what this function does. */ 704 705/// AddBlockByrefAddress - Start with the address based on the location 706/// provided, and generate the DWARF information necessary to find the 707/// actual Block variable (navigating the Block struct) based on the 708/// starting location. Add the DWARF information to the die. For 709/// more information, read large comment just above here. 710/// 711void DwarfDebug::AddBlockByrefAddress(DbgVariable *&DV, DIE *Die, 712 unsigned Attribute, 713 const MachineLocation &Location) { 714 const DIVariable &VD = DV->getVariable(); 715 DIType Ty = VD.getType(); 716 DIType TmpTy = Ty; 717 unsigned Tag = Ty.getTag(); 718 bool isPointer = false; 719 720 const char *varName = VD.getName(); 721 722 if (Tag == dwarf::DW_TAG_pointer_type) { 723 DIDerivedType DTy = DIDerivedType(Ty.getNode()); 724 TmpTy = DTy.getTypeDerivedFrom(); 725 isPointer = true; 726 } 727 728 DICompositeType blockStruct = DICompositeType(TmpTy.getNode()); 729 730 // Find the __forwarding field and the variable field in the __Block_byref 731 // struct. 732 DIArray Fields = blockStruct.getTypeArray(); 733 DIDescriptor varField = DIDescriptor(); 734 DIDescriptor forwardingField = DIDescriptor(); 735 736 737 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) { 738 DIDescriptor Element = Fields.getElement(i); 739 DIDerivedType DT = DIDerivedType(Element.getNode()); 740 const char *fieldName = DT.getName(); 741 if (strcmp(fieldName, "__forwarding") == 0) 742 forwardingField = Element; 743 else if (strcmp(fieldName, varName) == 0) 744 varField = Element; 745 } 746 747 assert(!varField.isNull() && "Can't find byref variable in Block struct"); 748 assert(!forwardingField.isNull() 749 && "Can't find forwarding field in Block struct"); 750 751 // Get the offsets for the forwarding field and the variable field. 752 unsigned int forwardingFieldOffset = 753 DIDerivedType(forwardingField.getNode()).getOffsetInBits() >> 3; 754 unsigned int varFieldOffset = 755 DIDerivedType(varField.getNode()).getOffsetInBits() >> 3; 756 757 // Decode the original location, and use that as the start of the byref 758 // variable's location. 759 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false); 760 DIEBlock *Block = new DIEBlock(); 761 762 if (Location.isReg()) { 763 if (Reg < 32) 764 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg); 765 else { 766 Reg = Reg - dwarf::DW_OP_reg0; 767 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg); 768 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg); 769 } 770 } else { 771 if (Reg < 32) 772 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg); 773 else { 774 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx); 775 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg); 776 } 777 778 AddUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset()); 779 } 780 781 // If we started with a pointer to the __Block_byref... struct, then 782 // the first thing we need to do is dereference the pointer (DW_OP_deref). 783 if (isPointer) 784 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref); 785 786 // Next add the offset for the '__forwarding' field: 787 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in 788 // adding the offset if it's 0. 789 if (forwardingFieldOffset > 0) { 790 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst); 791 AddUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset); 792 } 793 794 // Now dereference the __forwarding field to get to the real __Block_byref 795 // struct: DW_OP_deref. 796 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref); 797 798 // Now that we've got the real __Block_byref... struct, add the offset 799 // for the variable's field to get to the location of the actual variable: 800 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0. 801 if (varFieldOffset > 0) { 802 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst); 803 AddUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset); 804 } 805 806 // Now attach the location information to the DIE. 807 AddBlock(Die, Attribute, 0, Block); 808} 809 810/// AddAddress - Add an address attribute to a die based on the location 811/// provided. 812void DwarfDebug::AddAddress(DIE *Die, unsigned Attribute, 813 const MachineLocation &Location) { 814 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false); 815 DIEBlock *Block = new DIEBlock(); 816 817 if (Location.isReg()) { 818 if (Reg < 32) { 819 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg); 820 } else { 821 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx); 822 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg); 823 } 824 } else { 825 if (Reg < 32) { 826 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg); 827 } else { 828 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx); 829 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg); 830 } 831 832 AddUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset()); 833 } 834 835 AddBlock(Die, Attribute, 0, Block); 836} 837 838/// AddType - Add a new type attribute to the specified entity. 839void DwarfDebug::AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) { 840 if (Ty.isNull()) 841 return; 842 843 // Check for pre-existence. 844 DIEEntry *&Slot = DW_Unit->getDIEEntrySlotFor(Ty.getNode()); 845 846 // If it exists then use the existing value. 847 if (Slot) { 848 Entity->AddValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Slot); 849 return; 850 } 851 852 // Set up proxy. 853 Slot = CreateDIEEntry(); 854 855 // Construct type. 856 DIE Buffer(dwarf::DW_TAG_base_type); 857 if (Ty.isBasicType()) 858 ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getNode())); 859 else if (Ty.isCompositeType()) 860 ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getNode())); 861 else { 862 assert(Ty.isDerivedType() && "Unknown kind of DIType"); 863 ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getNode())); 864 } 865 866 // Add debug information entry to entity and appropriate context. 867 DIE *Die = NULL; 868 DIDescriptor Context = Ty.getContext(); 869 if (!Context.isNull()) 870 Die = DW_Unit->getDieMapSlotFor(Context.getNode()); 871 872 if (Die) { 873 DIE *Child = new DIE(Buffer); 874 Die->AddChild(Child); 875 Buffer.Detach(); 876 SetDIEEntry(Slot, Child); 877 } else { 878 Die = DW_Unit->AddDie(Buffer); 879 SetDIEEntry(Slot, Die); 880 } 881 882 Entity->AddValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Slot); 883} 884 885/// ConstructTypeDIE - Construct basic type die from DIBasicType. 886void DwarfDebug::ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 887 DIBasicType BTy) { 888 // Get core information. 889 const char *Name = BTy.getName(); 890 Buffer.setTag(dwarf::DW_TAG_base_type); 891 AddUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1, 892 BTy.getEncoding()); 893 894 // Add name if not anonymous or intermediate type. 895 if (Name) 896 AddString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name); 897 uint64_t Size = BTy.getSizeInBits() >> 3; 898 AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size); 899} 900 901/// ConstructTypeDIE - Construct derived type die from DIDerivedType. 902void DwarfDebug::ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 903 DIDerivedType DTy) { 904 // Get core information. 905 const char *Name = DTy.getName(); 906 uint64_t Size = DTy.getSizeInBits() >> 3; 907 unsigned Tag = DTy.getTag(); 908 909 // FIXME - Workaround for templates. 910 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type; 911 912 Buffer.setTag(Tag); 913 914 // Map to main type, void will not have a type. 915 DIType FromTy = DTy.getTypeDerivedFrom(); 916 AddType(DW_Unit, &Buffer, FromTy); 917 918 // Add name if not anonymous or intermediate type. 919 if (Name) 920 AddString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name); 921 922 // Add size if non-zero (derived types might be zero-sized.) 923 if (Size) 924 AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size); 925 926 // Add source line info if available and TyDesc is not a forward declaration. 927 if (!DTy.isForwardDecl()) 928 AddSourceLine(&Buffer, &DTy); 929} 930 931/// ConstructTypeDIE - Construct type DIE from DICompositeType. 932void DwarfDebug::ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 933 DICompositeType CTy) { 934 // Get core information. 935 const char *Name = CTy.getName(); 936 937 uint64_t Size = CTy.getSizeInBits() >> 3; 938 unsigned Tag = CTy.getTag(); 939 Buffer.setTag(Tag); 940 941 switch (Tag) { 942 case dwarf::DW_TAG_vector_type: 943 case dwarf::DW_TAG_array_type: 944 ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy); 945 break; 946 case dwarf::DW_TAG_enumeration_type: { 947 DIArray Elements = CTy.getTypeArray(); 948 949 // Add enumerators to enumeration type. 950 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) { 951 DIE *ElemDie = NULL; 952 DIEnumerator Enum(Elements.getElement(i).getNode()); 953 ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum); 954 Buffer.AddChild(ElemDie); 955 } 956 } 957 break; 958 case dwarf::DW_TAG_subroutine_type: { 959 // Add return type. 960 DIArray Elements = CTy.getTypeArray(); 961 DIDescriptor RTy = Elements.getElement(0); 962 AddType(DW_Unit, &Buffer, DIType(RTy.getNode())); 963 964 // Add prototype flag. 965 AddUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1); 966 967 // Add arguments. 968 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) { 969 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter); 970 DIDescriptor Ty = Elements.getElement(i); 971 AddType(DW_Unit, Arg, DIType(Ty.getNode())); 972 Buffer.AddChild(Arg); 973 } 974 } 975 break; 976 case dwarf::DW_TAG_structure_type: 977 case dwarf::DW_TAG_union_type: 978 case dwarf::DW_TAG_class_type: { 979 // Add elements to structure type. 980 DIArray Elements = CTy.getTypeArray(); 981 982 // A forward struct declared type may not have elements available. 983 if (Elements.isNull()) 984 break; 985 986 // Add elements to structure type. 987 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) { 988 DIDescriptor Element = Elements.getElement(i); 989 if (Element.isNull()) 990 continue; 991 DIE *ElemDie = NULL; 992 if (Element.getTag() == dwarf::DW_TAG_subprogram) 993 ElemDie = CreateSubprogramDIE(DW_Unit, 994 DISubprogram(Element.getNode())); 995 else 996 ElemDie = CreateMemberDIE(DW_Unit, 997 DIDerivedType(Element.getNode())); 998 Buffer.AddChild(ElemDie); 999 } 1000 1001 if (CTy.isAppleBlockExtension()) 1002 AddUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1); 1003 1004 unsigned RLang = CTy.getRunTimeLang(); 1005 if (RLang) 1006 AddUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class, 1007 dwarf::DW_FORM_data1, RLang); 1008 break; 1009 } 1010 default: 1011 break; 1012 } 1013 1014 // Add name if not anonymous or intermediate type. 1015 if (Name) 1016 AddString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name); 1017 1018 if (Tag == dwarf::DW_TAG_enumeration_type || 1019 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) { 1020 // Add size if non-zero (derived types might be zero-sized.) 1021 if (Size) 1022 AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size); 1023 else { 1024 // Add zero size if it is not a forward declaration. 1025 if (CTy.isForwardDecl()) 1026 AddUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1); 1027 else 1028 AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0); 1029 } 1030 1031 // Add source line info if available. 1032 if (!CTy.isForwardDecl()) 1033 AddSourceLine(&Buffer, &CTy); 1034 } 1035} 1036 1037/// ConstructSubrangeDIE - Construct subrange DIE from DISubrange. 1038void DwarfDebug::ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){ 1039 int64_t L = SR.getLo(); 1040 int64_t H = SR.getHi(); 1041 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type); 1042 1043 AddDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy); 1044 if (L) 1045 AddSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L); 1046 if (H) 1047 AddSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H); 1048 1049 Buffer.AddChild(DW_Subrange); 1050} 1051 1052/// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType. 1053void DwarfDebug::ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 1054 DICompositeType *CTy) { 1055 Buffer.setTag(dwarf::DW_TAG_array_type); 1056 if (CTy->getTag() == dwarf::DW_TAG_vector_type) 1057 AddUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1); 1058 1059 // Emit derived type. 1060 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom()); 1061 DIArray Elements = CTy->getTypeArray(); 1062 1063 // Construct an anonymous type for index type. 1064 DIE IdxBuffer(dwarf::DW_TAG_base_type); 1065 AddUInt(&IdxBuffer, dwarf::DW_AT_byte_size, 0, sizeof(int32_t)); 1066 AddUInt(&IdxBuffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1, 1067 dwarf::DW_ATE_signed); 1068 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer); 1069 1070 // Add subranges to array type. 1071 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) { 1072 DIDescriptor Element = Elements.getElement(i); 1073 if (Element.getTag() == dwarf::DW_TAG_subrange_type) 1074 ConstructSubrangeDIE(Buffer, DISubrange(Element.getNode()), IndexTy); 1075 } 1076} 1077 1078/// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator. 1079DIE *DwarfDebug::ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) { 1080 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator); 1081 const char *Name = ETy->getName(); 1082 AddString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name); 1083 int64_t Value = ETy->getEnumValue(); 1084 AddSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value); 1085 return Enumerator; 1086} 1087 1088/// CreateGlobalVariableDIE - Create new DIE using GV. 1089DIE *DwarfDebug::CreateGlobalVariableDIE(CompileUnit *DW_Unit, 1090 const DIGlobalVariable &GV) { 1091 DIE *GVDie = new DIE(dwarf::DW_TAG_variable); 1092 AddString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, 1093 GV.getDisplayName()); 1094 1095 const char *LinkageName = GV.getLinkageName(); 1096 if (LinkageName) { 1097 // Skip special LLVM prefix that is used to inform the asm printer to not 1098 // emit usual symbol prefix before the symbol name. This happens for 1099 // Objective-C symbol names and symbol whose name is replaced using GCC's 1100 // __asm__ attribute. 1101 if (LinkageName[0] == 1) 1102 LinkageName = &LinkageName[1]; 1103 AddString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string, 1104 LinkageName); 1105 } 1106 AddType(DW_Unit, GVDie, GV.getType()); 1107 if (!GV.isLocalToUnit()) 1108 AddUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1); 1109 AddSourceLine(GVDie, &GV); 1110 1111 // Add address. 1112 DIEBlock *Block = new DIEBlock(); 1113 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr); 1114 AddObjectLabel(Block, 0, dwarf::DW_FORM_udata, 1115 Asm->Mang->getMangledName(GV.getGlobal())); 1116 AddBlock(GVDie, dwarf::DW_AT_location, 0, Block); 1117 1118 return GVDie; 1119} 1120 1121/// CreateMemberDIE - Create new member DIE. 1122DIE *DwarfDebug::CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT){ 1123 DIE *MemberDie = new DIE(DT.getTag()); 1124 if (const char *Name = DT.getName()) 1125 AddString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name); 1126 1127 AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom()); 1128 1129 AddSourceLine(MemberDie, &DT); 1130 1131 uint64_t Size = DT.getSizeInBits(); 1132 uint64_t FieldSize = DT.getOriginalTypeSize(); 1133 1134 if (Size != FieldSize) { 1135 // Handle bitfield. 1136 AddUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3); 1137 AddUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits()); 1138 1139 uint64_t Offset = DT.getOffsetInBits(); 1140 uint64_t FieldOffset = Offset; 1141 uint64_t AlignMask = ~(DT.getAlignInBits() - 1); 1142 uint64_t HiMark = (Offset + FieldSize) & AlignMask; 1143 FieldOffset = (HiMark - FieldSize); 1144 Offset -= FieldOffset; 1145 1146 // Maybe we need to work from the other end. 1147 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size); 1148 AddUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset); 1149 } 1150 1151 DIEBlock *Block = new DIEBlock(); 1152 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst); 1153 AddUInt(Block, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3); 1154 AddBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, Block); 1155 1156 if (DT.isProtected()) 1157 AddUInt(MemberDie, dwarf::DW_AT_accessibility, 0, 1158 dwarf::DW_ACCESS_protected); 1159 else if (DT.isPrivate()) 1160 AddUInt(MemberDie, dwarf::DW_AT_accessibility, 0, 1161 dwarf::DW_ACCESS_private); 1162 1163 return MemberDie; 1164} 1165 1166/// CreateSubprogramDIE - Create new DIE using SP. 1167DIE *DwarfDebug::CreateSubprogramDIE(CompileUnit *DW_Unit, 1168 const DISubprogram &SP, 1169 bool IsConstructor, 1170 bool IsInlined) { 1171 DIE *SPDie = new DIE(dwarf::DW_TAG_subprogram); 1172 1173 const char * Name = SP.getName(); 1174 AddString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name); 1175 1176 const char *LinkageName = SP.getLinkageName(); 1177 if (LinkageName) { 1178 // Skip special LLVM prefix that is used to inform the asm printer to not emit 1179 // usual symbol prefix before the symbol name. This happens for Objective-C 1180 // symbol names and symbol whose name is replaced using GCC's __asm__ attribute. 1181 if (LinkageName[0] == 1) 1182 LinkageName = &LinkageName[1]; 1183 AddString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string, 1184 LinkageName); 1185 } 1186 AddSourceLine(SPDie, &SP); 1187 1188 DICompositeType SPTy = SP.getType(); 1189 DIArray Args = SPTy.getTypeArray(); 1190 1191 // Add prototyped tag, if C or ObjC. 1192 unsigned Lang = SP.getCompileUnit().getLanguage(); 1193 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 || 1194 Lang == dwarf::DW_LANG_ObjC) 1195 AddUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1); 1196 1197 // Add Return Type. 1198 unsigned SPTag = SPTy.getTag(); 1199 if (!IsConstructor) { 1200 if (Args.isNull() || SPTag != dwarf::DW_TAG_subroutine_type) 1201 AddType(DW_Unit, SPDie, SPTy); 1202 else 1203 AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getNode())); 1204 } 1205 1206 if (!SP.isDefinition()) { 1207 AddUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1); 1208 1209 // Add arguments. Do not add arguments for subprogram definition. They will 1210 // be handled through RecordVariable. 1211 if (SPTag == dwarf::DW_TAG_subroutine_type) 1212 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) { 1213 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter); 1214 AddType(DW_Unit, Arg, DIType(Args.getElement(i).getNode())); 1215 AddUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ?? 1216 SPDie->AddChild(Arg); 1217 } 1218 } 1219 1220 if (!SP.isLocalToUnit() && !IsInlined) 1221 AddUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1); 1222 1223 // DW_TAG_inlined_subroutine may refer to this DIE. 1224 DIE *&Slot = DW_Unit->getDieMapSlotFor(SP.getNode()); 1225 Slot = SPDie; 1226 return SPDie; 1227} 1228 1229/// FindCompileUnit - Get the compile unit for the given descriptor. 1230/// 1231CompileUnit &DwarfDebug::FindCompileUnit(DICompileUnit Unit) const { 1232 DenseMap<Value *, CompileUnit *>::const_iterator I = 1233 CompileUnitMap.find(Unit.getNode()); 1234 assert(I != CompileUnitMap.end() && "Missing compile unit."); 1235 return *I->second; 1236} 1237 1238/// CreateDbgScopeVariable - Create a new scope variable. 1239/// 1240DIE *DwarfDebug::CreateDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) { 1241 // Get the descriptor. 1242 const DIVariable &VD = DV->getVariable(); 1243 1244 // Translate tag to proper Dwarf tag. The result variable is dropped for 1245 // now. 1246 unsigned Tag; 1247 switch (VD.getTag()) { 1248 case dwarf::DW_TAG_return_variable: 1249 return NULL; 1250 case dwarf::DW_TAG_arg_variable: 1251 Tag = dwarf::DW_TAG_formal_parameter; 1252 break; 1253 case dwarf::DW_TAG_auto_variable: // fall thru 1254 default: 1255 Tag = dwarf::DW_TAG_variable; 1256 break; 1257 } 1258 1259 // Define variable debug information entry. 1260 DIE *VariableDie = new DIE(Tag); 1261 const char *Name = VD.getName(); 1262 AddString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name); 1263 1264 // Add source line info if available. 1265 AddSourceLine(VariableDie, &VD); 1266 1267 // Add variable type. 1268 // FIXME: isBlockByrefVariable should be reformulated in terms of complex addresses instead. 1269 if (VD.isBlockByrefVariable()) 1270 AddType(Unit, VariableDie, GetBlockByrefType(VD.getType(), Name)); 1271 else 1272 AddType(Unit, VariableDie, VD.getType()); 1273 1274 // Add variable address. 1275 if (!DV->isInlinedFnVar()) { 1276 // Variables for abstract instances of inlined functions don't get a 1277 // location. 1278 MachineLocation Location; 1279 Location.set(RI->getFrameRegister(*MF), 1280 RI->getFrameIndexOffset(*MF, DV->getFrameIndex())); 1281 1282 1283 if (VD.hasComplexAddress()) 1284 AddComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location); 1285 else if (VD.isBlockByrefVariable()) 1286 AddBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location); 1287 else 1288 AddAddress(VariableDie, dwarf::DW_AT_location, Location); 1289 } 1290 1291 return VariableDie; 1292} 1293 1294/// getOrCreateScope - Returns the scope associated with the given descriptor. 1295/// 1296DbgScope *DwarfDebug::getDbgScope(MDNode *N, const MachineInstr *MI) { 1297 DbgScope *&Slot = DbgScopeMap[N]; 1298 if (Slot) return Slot; 1299 1300 DbgScope *Parent = NULL; 1301 1302 DIDescriptor Scope(N); 1303 if (Scope.isCompileUnit()) { 1304 return NULL; 1305 } else if (Scope.isSubprogram()) { 1306 DISubprogram SP(N); 1307 DIDescriptor ParentDesc = SP.getContext(); 1308 if (!ParentDesc.isNull() && !ParentDesc.isCompileUnit()) 1309 Parent = getDbgScope(ParentDesc.getNode(), MI); 1310 } else if (Scope.isLexicalBlock()) { 1311 DILexicalBlock DB(N); 1312 DIDescriptor ParentDesc = DB.getContext(); 1313 if (!ParentDesc.isNull()) 1314 Parent = getDbgScope(ParentDesc.getNode(), MI); 1315 } else 1316 assert (0 && "Unexpected scope info"); 1317 1318 Slot = new DbgScope(Parent, DIDescriptor(N)); 1319 Slot->setFirstInsn(MI); 1320 1321 if (Parent) 1322 Parent->AddScope(Slot); 1323 else 1324 // First function is top level function. 1325 // FIXME - Dpatel - What is FunctionDbgScope ? 1326 if (!FunctionDbgScope) 1327 FunctionDbgScope = Slot; 1328 1329 return Slot; 1330} 1331 1332 1333/// getOrCreateScope - Returns the scope associated with the given descriptor. 1334/// FIXME - Remove this method. 1335DbgScope *DwarfDebug::getOrCreateScope(MDNode *N) { 1336 DbgScope *&Slot = DbgScopeMap[N]; 1337 if (Slot) return Slot; 1338 1339 DbgScope *Parent = NULL; 1340 DILexicalBlock Block(N); 1341 1342 // Don't create a new scope if we already created one for an inlined function. 1343 DenseMap<const MDNode *, DbgScope *>::iterator 1344 II = AbstractInstanceRootMap.find(N); 1345 if (II != AbstractInstanceRootMap.end()) 1346 return LexicalScopeStack.back(); 1347 1348 if (!Block.isNull()) { 1349 DIDescriptor ParentDesc = Block.getContext(); 1350 Parent = 1351 ParentDesc.isNull() ? NULL : getOrCreateScope(ParentDesc.getNode()); 1352 } 1353 1354 Slot = new DbgScope(Parent, DIDescriptor(N)); 1355 1356 if (Parent) 1357 Parent->AddScope(Slot); 1358 else 1359 // First function is top level function. 1360 FunctionDbgScope = Slot; 1361 1362 return Slot; 1363} 1364 1365/// ConstructDbgScope - Construct the components of a scope. 1366/// 1367void DwarfDebug::ConstructDbgScope(DbgScope *ParentScope, 1368 unsigned ParentStartID, 1369 unsigned ParentEndID, 1370 DIE *ParentDie, CompileUnit *Unit) { 1371 // Add variables to scope. 1372 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables(); 1373 for (unsigned i = 0, N = Variables.size(); i < N; ++i) { 1374 DIE *VariableDie = CreateDbgScopeVariable(Variables[i], Unit); 1375 if (VariableDie) ParentDie->AddChild(VariableDie); 1376 } 1377 1378 // Add concrete instances to scope. 1379 SmallVector<DbgConcreteScope *, 8> &ConcreteInsts = 1380 ParentScope->getConcreteInsts(); 1381 for (unsigned i = 0, N = ConcreteInsts.size(); i < N; ++i) { 1382 DbgConcreteScope *ConcreteInst = ConcreteInsts[i]; 1383 DIE *Die = ConcreteInst->getDie(); 1384 1385 unsigned StartID = ConcreteInst->getStartLabelID(); 1386 unsigned EndID = ConcreteInst->getEndLabelID(); 1387 1388 // Add the scope bounds. 1389 if (StartID) 1390 AddLabel(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 1391 DWLabel("label", StartID)); 1392 else 1393 AddLabel(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 1394 DWLabel("func_begin", SubprogramCount)); 1395 1396 if (EndID) 1397 AddLabel(Die, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, 1398 DWLabel("label", EndID)); 1399 else 1400 AddLabel(Die, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, 1401 DWLabel("func_end", SubprogramCount)); 1402 1403 ParentDie->AddChild(Die); 1404 } 1405 1406 // Add nested scopes. 1407 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes(); 1408 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) { 1409 // Define the Scope debug information entry. 1410 DbgScope *Scope = Scopes[j]; 1411 1412 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID()); 1413 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID()); 1414 1415 // Ignore empty scopes. 1416 if (StartID == EndID && StartID != 0) continue; 1417 1418 // Do not ignore inlined scopes even if they don't have any variables or 1419 // scopes. 1420 if (Scope->getScopes().empty() && Scope->getVariables().empty() && 1421 Scope->getConcreteInsts().empty()) 1422 continue; 1423 1424 if (StartID == ParentStartID && EndID == ParentEndID) { 1425 // Just add stuff to the parent scope. 1426 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit); 1427 } else { 1428 DIE *ScopeDie = new DIE(dwarf::DW_TAG_lexical_block); 1429 1430 // Add the scope bounds. 1431 if (StartID) 1432 AddLabel(ScopeDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 1433 DWLabel("label", StartID)); 1434 else 1435 AddLabel(ScopeDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 1436 DWLabel("func_begin", SubprogramCount)); 1437 1438 if (EndID) 1439 AddLabel(ScopeDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, 1440 DWLabel("label", EndID)); 1441 else 1442 AddLabel(ScopeDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, 1443 DWLabel("func_end", SubprogramCount)); 1444 1445 // Add the scope's contents. 1446 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit); 1447 ParentDie->AddChild(ScopeDie); 1448 } 1449 } 1450} 1451 1452/// ConstructFunctionDbgScope - Construct the scope for the subprogram. 1453/// 1454void DwarfDebug::ConstructFunctionDbgScope(DbgScope *RootScope, 1455 bool AbstractScope) { 1456 // Exit if there is no root scope. 1457 if (!RootScope) return; 1458 DIDescriptor Desc = RootScope->getDesc(); 1459 if (Desc.isNull()) 1460 return; 1461 1462 // Get the subprogram debug information entry. 1463 DISubprogram SPD(Desc.getNode()); 1464 1465 // Get the subprogram die. 1466 DIE *SPDie = ModuleCU->getDieMapSlotFor(SPD.getNode()); 1467 assert(SPDie && "Missing subprogram descriptor"); 1468 1469 if (!AbstractScope) { 1470 // Add the function bounds. 1471 AddLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 1472 DWLabel("func_begin", SubprogramCount)); 1473 AddLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, 1474 DWLabel("func_end", SubprogramCount)); 1475 MachineLocation Location(RI->getFrameRegister(*MF)); 1476 AddAddress(SPDie, dwarf::DW_AT_frame_base, Location); 1477 } 1478 1479 ConstructDbgScope(RootScope, 0, 0, SPDie, ModuleCU); 1480} 1481 1482/// ConstructDefaultDbgScope - Construct a default scope for the subprogram. 1483/// 1484void DwarfDebug::ConstructDefaultDbgScope(MachineFunction *MF) { 1485 StringMap<DIE*> &Globals = ModuleCU->getGlobals(); 1486 StringMap<DIE*>::iterator GI = Globals.find(MF->getFunction()->getName()); 1487 if (GI != Globals.end()) { 1488 DIE *SPDie = GI->second; 1489 1490 // Add the function bounds. 1491 AddLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 1492 DWLabel("func_begin", SubprogramCount)); 1493 AddLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, 1494 DWLabel("func_end", SubprogramCount)); 1495 1496 MachineLocation Location(RI->getFrameRegister(*MF)); 1497 AddAddress(SPDie, dwarf::DW_AT_frame_base, Location); 1498 } 1499} 1500 1501/// GetOrCreateSourceID - Look up the source id with the given directory and 1502/// source file names. If none currently exists, create a new id and insert it 1503/// in the SourceIds map. This can update DirectoryNames and SourceFileNames 1504/// maps as well. 1505unsigned DwarfDebug::GetOrCreateSourceID(const char *DirName, 1506 const char *FileName) { 1507 unsigned DId; 1508 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName); 1509 if (DI != DirectoryIdMap.end()) { 1510 DId = DI->getValue(); 1511 } else { 1512 DId = DirectoryNames.size() + 1; 1513 DirectoryIdMap[DirName] = DId; 1514 DirectoryNames.push_back(DirName); 1515 } 1516 1517 unsigned FId; 1518 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName); 1519 if (FI != SourceFileIdMap.end()) { 1520 FId = FI->getValue(); 1521 } else { 1522 FId = SourceFileNames.size() + 1; 1523 SourceFileIdMap[FileName] = FId; 1524 SourceFileNames.push_back(FileName); 1525 } 1526 1527 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI = 1528 SourceIdMap.find(std::make_pair(DId, FId)); 1529 if (SI != SourceIdMap.end()) 1530 return SI->second; 1531 1532 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0. 1533 SourceIdMap[std::make_pair(DId, FId)] = SrcId; 1534 SourceIds.push_back(std::make_pair(DId, FId)); 1535 1536 return SrcId; 1537} 1538 1539void DwarfDebug::ConstructCompileUnit(MDNode *N) { 1540 DICompileUnit DIUnit(N); 1541 const char *FN = DIUnit.getFilename(); 1542 const char *Dir = DIUnit.getDirectory(); 1543 unsigned ID = GetOrCreateSourceID(Dir, FN); 1544 1545 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit); 1546 AddSectionOffset(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 1547 DWLabel("section_line", 0), DWLabel("section_line", 0), 1548 false); 1549 AddString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string, 1550 DIUnit.getProducer()); 1551 AddUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1, 1552 DIUnit.getLanguage()); 1553 AddString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN); 1554 1555 if (Dir) 1556 AddString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir); 1557 if (DIUnit.isOptimized()) 1558 AddUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1); 1559 1560 if (const char *Flags = DIUnit.getFlags()) 1561 AddString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags); 1562 1563 unsigned RVer = DIUnit.getRunTimeVersion(); 1564 if (RVer) 1565 AddUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers, 1566 dwarf::DW_FORM_data1, RVer); 1567 1568 CompileUnit *Unit = new CompileUnit(ID, Die); 1569 if (!ModuleCU && DIUnit.isMain()) { 1570 // Use first compile unit marked as isMain as the compile unit 1571 // for this module. 1572 ModuleCU = Unit; 1573 } 1574 1575 CompileUnitMap[DIUnit.getNode()] = Unit; 1576 CompileUnits.push_back(Unit); 1577} 1578 1579void DwarfDebug::ConstructGlobalVariableDIE(MDNode *N) { 1580 DIGlobalVariable DI_GV(N); 1581 1582 // If debug information is malformed then ignore it. 1583 if (DI_GV.Verify() == false) 1584 return; 1585 1586 // Check for pre-existence. 1587 DIE *&Slot = ModuleCU->getDieMapSlotFor(DI_GV.getNode()); 1588 if (Slot) 1589 return; 1590 1591 DIE *VariableDie = CreateGlobalVariableDIE(ModuleCU, DI_GV); 1592 1593 // Add to map. 1594 Slot = VariableDie; 1595 1596 // Add to context owner. 1597 ModuleCU->getDie()->AddChild(VariableDie); 1598 1599 // Expose as global. FIXME - need to check external flag. 1600 ModuleCU->AddGlobal(DI_GV.getName(), VariableDie); 1601 return; 1602} 1603 1604void DwarfDebug::ConstructSubprogram(MDNode *N) { 1605 DISubprogram SP(N); 1606 1607 // Check for pre-existence. 1608 DIE *&Slot = ModuleCU->getDieMapSlotFor(N); 1609 if (Slot) 1610 return; 1611 1612 if (!SP.isDefinition()) 1613 // This is a method declaration which will be handled while constructing 1614 // class type. 1615 return; 1616 1617 DIE *SubprogramDie = CreateSubprogramDIE(ModuleCU, SP); 1618 1619 // Add to map. 1620 Slot = SubprogramDie; 1621 1622 // Add to context owner. 1623 ModuleCU->getDie()->AddChild(SubprogramDie); 1624 1625 // Expose as global. 1626 ModuleCU->AddGlobal(SP.getName(), SubprogramDie); 1627 return; 1628} 1629 1630/// BeginModule - Emit all Dwarf sections that should come prior to the 1631/// content. Create global DIEs and emit initial debug info sections. 1632/// This is inovked by the target AsmPrinter. 1633void DwarfDebug::BeginModule(Module *M, MachineModuleInfo *mmi) { 1634 this->M = M; 1635 1636 if (TimePassesIsEnabled) 1637 DebugTimer->startTimer(); 1638 1639 DebugInfoFinder DbgFinder; 1640 DbgFinder.processModule(*M); 1641 1642 // Create all the compile unit DIEs. 1643 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(), 1644 E = DbgFinder.compile_unit_end(); I != E; ++I) 1645 ConstructCompileUnit(*I); 1646 1647 if (CompileUnits.empty()) { 1648 if (TimePassesIsEnabled) 1649 DebugTimer->stopTimer(); 1650 1651 return; 1652 } 1653 1654 // If main compile unit for this module is not seen than randomly 1655 // select first compile unit. 1656 if (!ModuleCU) 1657 ModuleCU = CompileUnits[0]; 1658 1659 // If there is not any debug info available for any global variables and any 1660 // subprograms then there is not any debug info to emit. 1661 if (DbgFinder.global_variable_count() == 0 1662 && DbgFinder.subprogram_count() == 0) { 1663 if (TimePassesIsEnabled) 1664 DebugTimer->stopTimer(); 1665 return; 1666 } 1667 1668 // Create DIEs for each of the externally visible global variables. 1669 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(), 1670 E = DbgFinder.global_variable_end(); I != E; ++I) 1671 ConstructGlobalVariableDIE(*I); 1672 1673 // Create DIEs for each of the externally visible subprograms. 1674 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(), 1675 E = DbgFinder.subprogram_end(); I != E; ++I) 1676 ConstructSubprogram(*I); 1677 1678 MMI = mmi; 1679 shouldEmit = true; 1680 MMI->setDebugInfoAvailability(true); 1681 1682 // Prime section data. 1683 SectionMap.insert(Asm->getObjFileLowering().getTextSection()); 1684 1685 // Print out .file directives to specify files for .loc directives. These are 1686 // printed out early so that they precede any .loc directives. 1687 if (MAI->hasDotLocAndDotFile()) { 1688 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) { 1689 // Remember source id starts at 1. 1690 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i); 1691 sys::Path FullPath(getSourceDirectoryName(Id.first)); 1692 bool AppendOk = 1693 FullPath.appendComponent(getSourceFileName(Id.second)); 1694 assert(AppendOk && "Could not append filename to directory!"); 1695 AppendOk = false; 1696 Asm->EmitFile(i, FullPath.str()); 1697 Asm->EOL(); 1698 } 1699 } 1700 1701 // Emit initial sections 1702 EmitInitial(); 1703 1704 if (TimePassesIsEnabled) 1705 DebugTimer->stopTimer(); 1706} 1707 1708/// EndModule - Emit all Dwarf sections that should come after the content. 1709/// 1710void DwarfDebug::EndModule() { 1711 if (!ShouldEmitDwarfDebug()) 1712 return; 1713 1714 if (TimePassesIsEnabled) 1715 DebugTimer->startTimer(); 1716 1717 // Standard sections final addresses. 1718 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection()); 1719 EmitLabel("text_end", 0); 1720 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection()); 1721 EmitLabel("data_end", 0); 1722 1723 // End text sections. 1724 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) { 1725 Asm->OutStreamer.SwitchSection(SectionMap[i]); 1726 EmitLabel("section_end", i); 1727 } 1728 1729 // Emit common frame information. 1730 EmitCommonDebugFrame(); 1731 1732 // Emit function debug frame information 1733 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(), 1734 E = DebugFrames.end(); I != E; ++I) 1735 EmitFunctionDebugFrame(*I); 1736 1737 // Compute DIE offsets and sizes. 1738 SizeAndOffsets(); 1739 1740 // Emit all the DIEs into a debug info section 1741 EmitDebugInfo(); 1742 1743 // Corresponding abbreviations into a abbrev section. 1744 EmitAbbreviations(); 1745 1746 // Emit source line correspondence into a debug line section. 1747 EmitDebugLines(); 1748 1749 // Emit info into a debug pubnames section. 1750 EmitDebugPubNames(); 1751 1752 // Emit info into a debug str section. 1753 EmitDebugStr(); 1754 1755 // Emit info into a debug loc section. 1756 EmitDebugLoc(); 1757 1758 // Emit info into a debug aranges section. 1759 EmitDebugARanges(); 1760 1761 // Emit info into a debug ranges section. 1762 EmitDebugRanges(); 1763 1764 // Emit info into a debug macinfo section. 1765 EmitDebugMacInfo(); 1766 1767 // Emit inline info. 1768 EmitDebugInlineInfo(); 1769 1770 if (TimePassesIsEnabled) 1771 DebugTimer->stopTimer(); 1772} 1773 1774/// ExtractScopeInformation - Scan machine instructions in this function 1775/// and collect DbgScopes. Return true, if atleast one scope was found. 1776bool DwarfDebug::ExtractScopeInformation(MachineFunction *MF) { 1777 // If scope information was extracted using .dbg intrinsics then there is not 1778 // any need to extract these information by scanning each instruction. 1779 if (!DbgScopeMap.empty()) 1780 return false; 1781 1782 // Scan each instruction and create scopes. 1783 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end(); 1784 I != E; ++I) { 1785 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end(); 1786 II != IE; ++II) { 1787 const MachineInstr *MInsn = II; 1788 DebugLoc DL = MInsn->getDebugLoc(); 1789 if (DL.isUnknown()) 1790 continue; 1791 DebugLocTuple DLT = MF->getDebugLocTuple(DL); 1792 if (!DLT.CompileUnit) 1793 continue; 1794 // There is no need to create another DIE for compile unit. For all 1795 // other scopes, create one DbgScope now. This will be translated 1796 // into a scope DIE at the end. 1797 DIDescriptor D(DLT.CompileUnit); 1798 if (!D.isCompileUnit()) { 1799 DbgScope *Scope = getDbgScope(DLT.CompileUnit, MInsn); 1800 Scope->setLastInsn(MInsn); 1801 } 1802 } 1803 } 1804 1805 // If a scope's last instruction is not set then use its child scope's 1806 // last instruction as this scope's last instrunction. 1807 for (DenseMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(), 1808 DE = DbgScopeMap.end(); DI != DE; ++DI) { 1809 assert (DI->second->getFirstInsn() && "Invalid first instruction!"); 1810 DI->second->FixInstructionMarkers(); 1811 assert (DI->second->getLastInsn() && "Invalid last instruction!"); 1812 } 1813 1814 // Each scope has first instruction and last instruction to mark beginning 1815 // and end of a scope respectively. Create an inverse map that list scopes 1816 // starts (and ends) with an instruction. One instruction may start (or end) 1817 // multiple scopes. 1818 for (DenseMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(), 1819 DE = DbgScopeMap.end(); DI != DE; ++DI) { 1820 DbgScope *S = DI->second; 1821 assert (S && "DbgScope is missing!"); 1822 const MachineInstr *MI = S->getFirstInsn(); 1823 assert (MI && "DbgScope does not have first instruction!"); 1824 1825 InsnToDbgScopeMapTy::iterator IDI = DbgScopeBeginMap.find(MI); 1826 if (IDI != DbgScopeBeginMap.end()) 1827 IDI->second.push_back(S); 1828 else 1829 DbgScopeBeginMap.insert(std::make_pair(MI, 1830 SmallVector<DbgScope *, 2>(2, S))); 1831 1832 MI = S->getLastInsn(); 1833 assert (MI && "DbgScope does not have last instruction!"); 1834 IDI = DbgScopeEndMap.find(MI); 1835 if (IDI != DbgScopeEndMap.end()) 1836 IDI->second.push_back(S); 1837 else 1838 DbgScopeEndMap.insert(std::make_pair(MI, 1839 SmallVector<DbgScope *, 2>(2, S))); 1840 } 1841 1842 return !DbgScopeMap.empty(); 1843} 1844 1845/// BeginFunction - Gather pre-function debug information. Assumes being 1846/// emitted immediately after the function entry point. 1847void DwarfDebug::BeginFunction(MachineFunction *MF) { 1848 this->MF = MF; 1849 1850 if (!ShouldEmitDwarfDebug()) return; 1851 1852 if (TimePassesIsEnabled) 1853 DebugTimer->startTimer(); 1854 1855 // Begin accumulating function debug information. 1856 MMI->BeginFunction(MF); 1857 1858 // Assumes in correct section after the entry point. 1859 EmitLabel("func_begin", ++SubprogramCount); 1860 1861 // Emit label for the implicitly defined dbg.stoppoint at the start of the 1862 // function. 1863 DebugLoc FDL = MF->getDefaultDebugLoc(); 1864 if (!FDL.isUnknown()) { 1865 DebugLocTuple DLT = MF->getDebugLocTuple(FDL); 1866 unsigned LabelID = RecordSourceLine(DLT.Line, DLT.Col, DLT.CompileUnit); 1867 Asm->printLabel(LabelID); 1868 O << '\n'; 1869 } 1870 1871 if (TimePassesIsEnabled) 1872 DebugTimer->stopTimer(); 1873} 1874 1875/// EndFunction - Gather and emit post-function debug information. 1876/// 1877void DwarfDebug::EndFunction(MachineFunction *MF) { 1878 if (!ShouldEmitDwarfDebug()) return; 1879 1880 if (TimePassesIsEnabled) 1881 DebugTimer->startTimer(); 1882 1883 // Define end label for subprogram. 1884 EmitLabel("func_end", SubprogramCount); 1885 1886 // Get function line info. 1887 if (!Lines.empty()) { 1888 // Get section line info. 1889 unsigned ID = SectionMap.insert(Asm->getCurrentSection()); 1890 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID); 1891 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1]; 1892 // Append the function info to section info. 1893 SectionLineInfos.insert(SectionLineInfos.end(), 1894 Lines.begin(), Lines.end()); 1895 } 1896 1897 // Construct the DbgScope for abstract instances. 1898 for (SmallVector<DbgScope *, 32>::iterator 1899 I = AbstractInstanceRootList.begin(), 1900 E = AbstractInstanceRootList.end(); I != E; ++I) 1901 ConstructFunctionDbgScope(*I); 1902 1903 // Construct scopes for subprogram. 1904 if (FunctionDbgScope) 1905 ConstructFunctionDbgScope(FunctionDbgScope); 1906 else 1907 // FIXME: This is wrong. We are essentially getting past a problem with 1908 // debug information not being able to handle unreachable blocks that have 1909 // debug information in them. In particular, those unreachable blocks that 1910 // have "region end" info in them. That situation results in the "root 1911 // scope" not being created. If that's the case, then emit a "default" 1912 // scope, i.e., one that encompasses the whole function. This isn't 1913 // desirable. And a better way of handling this (and all of the debugging 1914 // information) needs to be explored. 1915 ConstructDefaultDbgScope(MF); 1916 1917 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount, 1918 MMI->getFrameMoves())); 1919 1920 // Clear debug info 1921 if (FunctionDbgScope) { 1922 delete FunctionDbgScope; 1923 DbgScopeMap.clear(); 1924 DbgScopeBeginMap.clear(); 1925 DbgScopeEndMap.clear(); 1926 DbgAbstractScopeMap.clear(); 1927 DbgConcreteScopeMap.clear(); 1928 FunctionDbgScope = NULL; 1929 LexicalScopeStack.clear(); 1930 AbstractInstanceRootList.clear(); 1931 AbstractInstanceRootMap.clear(); 1932 } 1933 1934 Lines.clear(); 1935 1936 if (TimePassesIsEnabled) 1937 DebugTimer->stopTimer(); 1938} 1939 1940/// RecordSourceLine - Records location information and associates it with a 1941/// label. Returns a unique label ID used to generate a label and provide 1942/// correspondence to the source line list. 1943unsigned DwarfDebug::RecordSourceLine(Value *V, unsigned Line, unsigned Col) { 1944 if (TimePassesIsEnabled) 1945 DebugTimer->startTimer(); 1946 1947 CompileUnit *Unit = CompileUnitMap[V]; 1948 assert(Unit && "Unable to find CompileUnit"); 1949 unsigned ID = MMI->NextLabelID(); 1950 Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID)); 1951 1952 if (TimePassesIsEnabled) 1953 DebugTimer->stopTimer(); 1954 1955 return ID; 1956} 1957 1958/// RecordSourceLine - Records location information and associates it with a 1959/// label. Returns a unique label ID used to generate a label and provide 1960/// correspondence to the source line list. 1961unsigned DwarfDebug::RecordSourceLine(unsigned Line, unsigned Col, 1962 MDNode *S) { 1963 if (!MMI) 1964 return 0; 1965 1966 if (TimePassesIsEnabled) 1967 DebugTimer->startTimer(); 1968 1969 const char *Dir = NULL; 1970 const char *Fn = NULL; 1971 1972 DIDescriptor Scope(S); 1973 if (Scope.isCompileUnit()) { 1974 DICompileUnit CU(S); 1975 Dir = CU.getDirectory(); 1976 Fn = CU.getFilename(); 1977 } else if (Scope.isSubprogram()) { 1978 DISubprogram SP(S); 1979 Dir = SP.getDirectory(); 1980 Fn = SP.getFilename(); 1981 } else if (Scope.isLexicalBlock()) { 1982 DILexicalBlock DB(S); 1983 Dir = DB.getDirectory(); 1984 Fn = DB.getFilename(); 1985 } else 1986 assert (0 && "Unexpected scope info"); 1987 1988 unsigned Src = GetOrCreateSourceID(Dir, Fn); 1989 unsigned ID = MMI->NextLabelID(); 1990 Lines.push_back(SrcLineInfo(Line, Col, Src, ID)); 1991 1992 if (TimePassesIsEnabled) 1993 DebugTimer->stopTimer(); 1994 1995 return ID; 1996} 1997 1998/// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be 1999/// timed. Look up the source id with the given directory and source file 2000/// names. If none currently exists, create a new id and insert it in the 2001/// SourceIds map. This can update DirectoryNames and SourceFileNames maps as 2002/// well. 2003unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName, 2004 const std::string &FileName) { 2005 if (TimePassesIsEnabled) 2006 DebugTimer->startTimer(); 2007 2008 unsigned SrcId = GetOrCreateSourceID(DirName.c_str(), FileName.c_str()); 2009 2010 if (TimePassesIsEnabled) 2011 DebugTimer->stopTimer(); 2012 2013 return SrcId; 2014} 2015 2016/// RecordRegionStart - Indicate the start of a region. 2017unsigned DwarfDebug::RecordRegionStart(MDNode *N) { 2018 if (TimePassesIsEnabled) 2019 DebugTimer->startTimer(); 2020 2021 DbgScope *Scope = getOrCreateScope(N); 2022 unsigned ID = MMI->NextLabelID(); 2023 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID); 2024 LexicalScopeStack.push_back(Scope); 2025 2026 if (TimePassesIsEnabled) 2027 DebugTimer->stopTimer(); 2028 2029 return ID; 2030} 2031 2032/// RecordRegionEnd - Indicate the end of a region. 2033unsigned DwarfDebug::RecordRegionEnd(MDNode *N) { 2034 if (TimePassesIsEnabled) 2035 DebugTimer->startTimer(); 2036 2037 DbgScope *Scope = getOrCreateScope(N); 2038 unsigned ID = MMI->NextLabelID(); 2039 Scope->setEndLabelID(ID); 2040 // FIXME : region.end() may not be in the last basic block. 2041 // For now, do not pop last lexical scope because next basic 2042 // block may start new inlined function's body. 2043 unsigned LSSize = LexicalScopeStack.size(); 2044 if (LSSize != 0 && LSSize != 1) 2045 LexicalScopeStack.pop_back(); 2046 2047 if (TimePassesIsEnabled) 2048 DebugTimer->stopTimer(); 2049 2050 return ID; 2051} 2052 2053/// RecordVariable - Indicate the declaration of a local variable. 2054void DwarfDebug::RecordVariable(MDNode *N, unsigned FrameIndex) { 2055 if (TimePassesIsEnabled) 2056 DebugTimer->startTimer(); 2057 2058 DIDescriptor Desc(N); 2059 DbgScope *Scope = NULL; 2060 bool InlinedFnVar = false; 2061 2062 if (Desc.getTag() == dwarf::DW_TAG_variable) 2063 Scope = getOrCreateScope(DIGlobalVariable(N).getContext().getNode()); 2064 else { 2065 bool InlinedVar = false; 2066 MDNode *Context = DIVariable(N).getContext().getNode(); 2067 DISubprogram SP(Context); 2068 if (!SP.isNull()) { 2069 // SP is inserted into DbgAbstractScopeMap when inlined function 2070 // start was recorded by RecordInlineFnStart. 2071 DenseMap<MDNode *, DbgScope *>::iterator 2072 I = DbgAbstractScopeMap.find(SP.getNode()); 2073 if (I != DbgAbstractScopeMap.end()) { 2074 InlinedVar = true; 2075 Scope = I->second; 2076 } 2077 } 2078 if (!InlinedVar) 2079 Scope = getOrCreateScope(Context); 2080 } 2081 2082 assert(Scope && "Unable to find the variable's scope"); 2083 DbgVariable *DV = new DbgVariable(DIVariable(N), FrameIndex, InlinedFnVar); 2084 Scope->AddVariable(DV); 2085 2086 if (TimePassesIsEnabled) 2087 DebugTimer->stopTimer(); 2088} 2089 2090//// RecordInlinedFnStart - Indicate the start of inlined subroutine. 2091unsigned DwarfDebug::RecordInlinedFnStart(DISubprogram &SP, DICompileUnit CU, 2092 unsigned Line, unsigned Col) { 2093 unsigned LabelID = MMI->NextLabelID(); 2094 2095 if (!MAI->doesDwarfUsesInlineInfoSection()) 2096 return LabelID; 2097 2098 if (TimePassesIsEnabled) 2099 DebugTimer->startTimer(); 2100 2101 MDNode *Node = SP.getNode(); 2102 DenseMap<const MDNode *, DbgScope *>::iterator 2103 II = AbstractInstanceRootMap.find(Node); 2104 2105 if (II == AbstractInstanceRootMap.end()) { 2106 // Create an abstract instance entry for this inlined function if it doesn't 2107 // already exist. 2108 DbgScope *Scope = new DbgScope(NULL, DIDescriptor(Node)); 2109 2110 // Get the compile unit context. 2111 DIE *SPDie = ModuleCU->getDieMapSlotFor(Node); 2112 if (!SPDie) 2113 SPDie = CreateSubprogramDIE(ModuleCU, SP, false, true); 2114 2115 // Mark as being inlined. This makes this subprogram entry an abstract 2116 // instance root. 2117 // FIXME: Our debugger doesn't care about the value of DW_AT_inline, only 2118 // that it's defined. That probably won't change in the future. However, 2119 // this could be more elegant. 2120 AddUInt(SPDie, dwarf::DW_AT_inline, 0, dwarf::DW_INL_declared_not_inlined); 2121 2122 // Keep track of the abstract scope for this function. 2123 DbgAbstractScopeMap[Node] = Scope; 2124 2125 AbstractInstanceRootMap[Node] = Scope; 2126 AbstractInstanceRootList.push_back(Scope); 2127 } 2128 2129 // Create a concrete inlined instance for this inlined function. 2130 DbgConcreteScope *ConcreteScope = new DbgConcreteScope(DIDescriptor(Node)); 2131 DIE *ScopeDie = new DIE(dwarf::DW_TAG_inlined_subroutine); 2132 ScopeDie->setAbstractCompileUnit(ModuleCU); 2133 2134 DIE *Origin = ModuleCU->getDieMapSlotFor(Node); 2135 AddDIEEntry(ScopeDie, dwarf::DW_AT_abstract_origin, 2136 dwarf::DW_FORM_ref4, Origin); 2137 AddUInt(ScopeDie, dwarf::DW_AT_call_file, 0, ModuleCU->getID()); 2138 AddUInt(ScopeDie, dwarf::DW_AT_call_line, 0, Line); 2139 AddUInt(ScopeDie, dwarf::DW_AT_call_column, 0, Col); 2140 2141 ConcreteScope->setDie(ScopeDie); 2142 ConcreteScope->setStartLabelID(LabelID); 2143 MMI->RecordUsedDbgLabel(LabelID); 2144 2145 LexicalScopeStack.back()->AddConcreteInst(ConcreteScope); 2146 2147 // Keep track of the concrete scope that's inlined into this function. 2148 DenseMap<MDNode *, SmallVector<DbgScope *, 8> >::iterator 2149 SI = DbgConcreteScopeMap.find(Node); 2150 2151 if (SI == DbgConcreteScopeMap.end()) 2152 DbgConcreteScopeMap[Node].push_back(ConcreteScope); 2153 else 2154 SI->second.push_back(ConcreteScope); 2155 2156 // Track the start label for this inlined function. 2157 DenseMap<MDNode *, SmallVector<unsigned, 4> >::iterator 2158 I = InlineInfo.find(Node); 2159 2160 if (I == InlineInfo.end()) 2161 InlineInfo[Node].push_back(LabelID); 2162 else 2163 I->second.push_back(LabelID); 2164 2165 if (TimePassesIsEnabled) 2166 DebugTimer->stopTimer(); 2167 2168 return LabelID; 2169} 2170 2171/// RecordInlinedFnEnd - Indicate the end of inlined subroutine. 2172unsigned DwarfDebug::RecordInlinedFnEnd(DISubprogram &SP) { 2173 if (!MAI->doesDwarfUsesInlineInfoSection()) 2174 return 0; 2175 2176 if (TimePassesIsEnabled) 2177 DebugTimer->startTimer(); 2178 2179 MDNode *Node = SP.getNode(); 2180 DenseMap<MDNode *, SmallVector<DbgScope *, 8> >::iterator 2181 I = DbgConcreteScopeMap.find(Node); 2182 2183 if (I == DbgConcreteScopeMap.end()) { 2184 // FIXME: Can this situation actually happen? And if so, should it? 2185 if (TimePassesIsEnabled) 2186 DebugTimer->stopTimer(); 2187 2188 return 0; 2189 } 2190 2191 SmallVector<DbgScope *, 8> &Scopes = I->second; 2192 if (Scopes.empty()) { 2193 // Returned ID is 0 if this is unbalanced "end of inlined 2194 // scope". This could happen if optimizer eats dbg intrinsics 2195 // or "beginning of inlined scope" is not recoginized due to 2196 // missing location info. In such cases, ignore this region.end. 2197 return 0; 2198 } 2199 2200 DbgScope *Scope = Scopes.back(); Scopes.pop_back(); 2201 unsigned ID = MMI->NextLabelID(); 2202 MMI->RecordUsedDbgLabel(ID); 2203 Scope->setEndLabelID(ID); 2204 2205 if (TimePassesIsEnabled) 2206 DebugTimer->stopTimer(); 2207 2208 return ID; 2209} 2210 2211//===----------------------------------------------------------------------===// 2212// Emit Methods 2213//===----------------------------------------------------------------------===// 2214 2215/// SizeAndOffsetDie - Compute the size and offset of a DIE. 2216/// 2217unsigned DwarfDebug::SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) { 2218 // Get the children. 2219 const std::vector<DIE *> &Children = Die->getChildren(); 2220 2221 // If not last sibling and has children then add sibling offset attribute. 2222 if (!Last && !Children.empty()) Die->AddSiblingOffset(); 2223 2224 // Record the abbreviation. 2225 AssignAbbrevNumber(Die->getAbbrev()); 2226 2227 // Get the abbreviation for this DIE. 2228 unsigned AbbrevNumber = Die->getAbbrevNumber(); 2229 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1]; 2230 2231 // Set DIE offset 2232 Die->setOffset(Offset); 2233 2234 // Start the size with the size of abbreviation code. 2235 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber); 2236 2237 const SmallVector<DIEValue*, 32> &Values = Die->getValues(); 2238 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData(); 2239 2240 // Size the DIE attribute values. 2241 for (unsigned i = 0, N = Values.size(); i < N; ++i) 2242 // Size attribute value. 2243 Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm()); 2244 2245 // Size the DIE children if any. 2246 if (!Children.empty()) { 2247 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes && 2248 "Children flag not set"); 2249 2250 for (unsigned j = 0, M = Children.size(); j < M; ++j) 2251 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M); 2252 2253 // End of children marker. 2254 Offset += sizeof(int8_t); 2255 } 2256 2257 Die->setSize(Offset - Die->getOffset()); 2258 return Offset; 2259} 2260 2261/// SizeAndOffsets - Compute the size and offset of all the DIEs. 2262/// 2263void DwarfDebug::SizeAndOffsets() { 2264 // Compute size of compile unit header. 2265 static unsigned Offset = 2266 sizeof(int32_t) + // Length of Compilation Unit Info 2267 sizeof(int16_t) + // DWARF version number 2268 sizeof(int32_t) + // Offset Into Abbrev. Section 2269 sizeof(int8_t); // Pointer Size (in bytes) 2270 2271 SizeAndOffsetDie(ModuleCU->getDie(), Offset, true); 2272 CompileUnitOffsets[ModuleCU] = 0; 2273} 2274 2275/// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc 2276/// tools to recognize the object file contains Dwarf information. 2277void DwarfDebug::EmitInitial() { 2278 // Check to see if we already emitted intial headers. 2279 if (didInitial) return; 2280 didInitial = true; 2281 2282 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering(); 2283 2284 // Dwarf sections base addresses. 2285 if (MAI->doesDwarfRequireFrameSection()) { 2286 Asm->OutStreamer.SwitchSection(TLOF.getDwarfFrameSection()); 2287 EmitLabel("section_debug_frame", 0); 2288 } 2289 2290 Asm->OutStreamer.SwitchSection(TLOF.getDwarfInfoSection()); 2291 EmitLabel("section_info", 0); 2292 Asm->OutStreamer.SwitchSection(TLOF.getDwarfAbbrevSection()); 2293 EmitLabel("section_abbrev", 0); 2294 Asm->OutStreamer.SwitchSection(TLOF.getDwarfARangesSection()); 2295 EmitLabel("section_aranges", 0); 2296 2297 if (const MCSection *LineInfoDirective = TLOF.getDwarfMacroInfoSection()) { 2298 Asm->OutStreamer.SwitchSection(LineInfoDirective); 2299 EmitLabel("section_macinfo", 0); 2300 } 2301 2302 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLineSection()); 2303 EmitLabel("section_line", 0); 2304 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLocSection()); 2305 EmitLabel("section_loc", 0); 2306 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubNamesSection()); 2307 EmitLabel("section_pubnames", 0); 2308 Asm->OutStreamer.SwitchSection(TLOF.getDwarfStrSection()); 2309 EmitLabel("section_str", 0); 2310 Asm->OutStreamer.SwitchSection(TLOF.getDwarfRangesSection()); 2311 EmitLabel("section_ranges", 0); 2312 2313 Asm->OutStreamer.SwitchSection(TLOF.getTextSection()); 2314 EmitLabel("text_begin", 0); 2315 Asm->OutStreamer.SwitchSection(TLOF.getDataSection()); 2316 EmitLabel("data_begin", 0); 2317} 2318 2319/// EmitDIE - Recusively Emits a debug information entry. 2320/// 2321void DwarfDebug::EmitDIE(DIE *Die) { 2322 // Get the abbreviation for this DIE. 2323 unsigned AbbrevNumber = Die->getAbbrevNumber(); 2324 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1]; 2325 2326 Asm->EOL(); 2327 2328 // Emit the code (index) for the abbreviation. 2329 Asm->EmitULEB128Bytes(AbbrevNumber); 2330 2331 if (Asm->isVerbose()) 2332 Asm->EOL(std::string("Abbrev [" + 2333 utostr(AbbrevNumber) + 2334 "] 0x" + utohexstr(Die->getOffset()) + 2335 ":0x" + utohexstr(Die->getSize()) + " " + 2336 dwarf::TagString(Abbrev->getTag()))); 2337 else 2338 Asm->EOL(); 2339 2340 SmallVector<DIEValue*, 32> &Values = Die->getValues(); 2341 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData(); 2342 2343 // Emit the DIE attribute values. 2344 for (unsigned i = 0, N = Values.size(); i < N; ++i) { 2345 unsigned Attr = AbbrevData[i].getAttribute(); 2346 unsigned Form = AbbrevData[i].getForm(); 2347 assert(Form && "Too many attributes for DIE (check abbreviation)"); 2348 2349 switch (Attr) { 2350 case dwarf::DW_AT_sibling: 2351 Asm->EmitInt32(Die->SiblingOffset()); 2352 break; 2353 case dwarf::DW_AT_abstract_origin: { 2354 DIEEntry *E = cast<DIEEntry>(Values[i]); 2355 DIE *Origin = E->getEntry(); 2356 unsigned Addr = 2357 CompileUnitOffsets[Die->getAbstractCompileUnit()] + 2358 Origin->getOffset(); 2359 2360 Asm->EmitInt32(Addr); 2361 break; 2362 } 2363 default: 2364 // Emit an attribute using the defined form. 2365 Values[i]->EmitValue(this, Form); 2366 break; 2367 } 2368 2369 Asm->EOL(dwarf::AttributeString(Attr)); 2370 } 2371 2372 // Emit the DIE children if any. 2373 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) { 2374 const std::vector<DIE *> &Children = Die->getChildren(); 2375 2376 for (unsigned j = 0, M = Children.size(); j < M; ++j) 2377 EmitDIE(Children[j]); 2378 2379 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark"); 2380 } 2381} 2382 2383/// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section. 2384/// 2385void DwarfDebug::EmitDebugInfoPerCU(CompileUnit *Unit) { 2386 DIE *Die = Unit->getDie(); 2387 2388 // Emit the compile units header. 2389 EmitLabel("info_begin", Unit->getID()); 2390 2391 // Emit size of content not including length itself 2392 unsigned ContentSize = Die->getSize() + 2393 sizeof(int16_t) + // DWARF version number 2394 sizeof(int32_t) + // Offset Into Abbrev. Section 2395 sizeof(int8_t) + // Pointer Size (in bytes) 2396 sizeof(int32_t); // FIXME - extra pad for gdb bug. 2397 2398 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info"); 2399 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number"); 2400 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false); 2401 Asm->EOL("Offset Into Abbrev. Section"); 2402 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)"); 2403 2404 EmitDIE(Die); 2405 // FIXME - extra padding for gdb bug. 2406 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB"); 2407 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB"); 2408 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB"); 2409 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB"); 2410 EmitLabel("info_end", Unit->getID()); 2411 2412 Asm->EOL(); 2413} 2414 2415void DwarfDebug::EmitDebugInfo() { 2416 // Start debug info section. 2417 Asm->OutStreamer.SwitchSection( 2418 Asm->getObjFileLowering().getDwarfInfoSection()); 2419 2420 EmitDebugInfoPerCU(ModuleCU); 2421} 2422 2423/// EmitAbbreviations - Emit the abbreviation section. 2424/// 2425void DwarfDebug::EmitAbbreviations() const { 2426 // Check to see if it is worth the effort. 2427 if (!Abbreviations.empty()) { 2428 // Start the debug abbrev section. 2429 Asm->OutStreamer.SwitchSection( 2430 Asm->getObjFileLowering().getDwarfAbbrevSection()); 2431 2432 EmitLabel("abbrev_begin", 0); 2433 2434 // For each abbrevation. 2435 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) { 2436 // Get abbreviation data 2437 const DIEAbbrev *Abbrev = Abbreviations[i]; 2438 2439 // Emit the abbrevations code (base 1 index.) 2440 Asm->EmitULEB128Bytes(Abbrev->getNumber()); 2441 Asm->EOL("Abbreviation Code"); 2442 2443 // Emit the abbreviations data. 2444 Abbrev->Emit(Asm); 2445 2446 Asm->EOL(); 2447 } 2448 2449 // Mark end of abbreviations. 2450 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)"); 2451 2452 EmitLabel("abbrev_end", 0); 2453 Asm->EOL(); 2454 } 2455} 2456 2457/// EmitEndOfLineMatrix - Emit the last address of the section and the end of 2458/// the line matrix. 2459/// 2460void DwarfDebug::EmitEndOfLineMatrix(unsigned SectionEnd) { 2461 // Define last address of section. 2462 Asm->EmitInt8(0); Asm->EOL("Extended Op"); 2463 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size"); 2464 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address"); 2465 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label"); 2466 2467 // Mark end of matrix. 2468 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence"); 2469 Asm->EmitULEB128Bytes(1); Asm->EOL(); 2470 Asm->EmitInt8(1); Asm->EOL(); 2471} 2472 2473/// EmitDebugLines - Emit source line information. 2474/// 2475void DwarfDebug::EmitDebugLines() { 2476 // If the target is using .loc/.file, the assembler will be emitting the 2477 // .debug_line table automatically. 2478 if (MAI->hasDotLocAndDotFile()) 2479 return; 2480 2481 // Minimum line delta, thus ranging from -10..(255-10). 2482 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1); 2483 // Maximum line delta, thus ranging from -10..(255-10). 2484 const int MaxLineDelta = 255 + MinLineDelta; 2485 2486 // Start the dwarf line section. 2487 Asm->OutStreamer.SwitchSection( 2488 Asm->getObjFileLowering().getDwarfLineSection()); 2489 2490 // Construct the section header. 2491 EmitDifference("line_end", 0, "line_begin", 0, true); 2492 Asm->EOL("Length of Source Line Info"); 2493 EmitLabel("line_begin", 0); 2494 2495 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number"); 2496 2497 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true); 2498 Asm->EOL("Prolog Length"); 2499 EmitLabel("line_prolog_begin", 0); 2500 2501 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length"); 2502 2503 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag"); 2504 2505 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)"); 2506 2507 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)"); 2508 2509 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base"); 2510 2511 // Line number standard opcode encodings argument count 2512 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count"); 2513 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count"); 2514 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count"); 2515 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count"); 2516 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count"); 2517 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count"); 2518 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count"); 2519 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count"); 2520 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count"); 2521 2522 // Emit directories. 2523 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) { 2524 Asm->EmitString(getSourceDirectoryName(DI)); 2525 Asm->EOL("Directory"); 2526 } 2527 2528 Asm->EmitInt8(0); Asm->EOL("End of directories"); 2529 2530 // Emit files. 2531 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) { 2532 // Remember source id starts at 1. 2533 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI); 2534 Asm->EmitString(getSourceFileName(Id.second)); 2535 Asm->EOL("Source"); 2536 Asm->EmitULEB128Bytes(Id.first); 2537 Asm->EOL("Directory #"); 2538 Asm->EmitULEB128Bytes(0); 2539 Asm->EOL("Mod date"); 2540 Asm->EmitULEB128Bytes(0); 2541 Asm->EOL("File size"); 2542 } 2543 2544 Asm->EmitInt8(0); Asm->EOL("End of files"); 2545 2546 EmitLabel("line_prolog_end", 0); 2547 2548 // A sequence for each text section. 2549 unsigned SecSrcLinesSize = SectionSourceLines.size(); 2550 2551 for (unsigned j = 0; j < SecSrcLinesSize; ++j) { 2552 // Isolate current sections line info. 2553 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j]; 2554 2555 /*if (Asm->isVerbose()) { 2556 const MCSection *S = SectionMap[j + 1]; 2557 O << '\t' << MAI->getCommentString() << " Section" 2558 << S->getName() << '\n'; 2559 }*/ 2560 Asm->EOL(); 2561 2562 // Dwarf assumes we start with first line of first source file. 2563 unsigned Source = 1; 2564 unsigned Line = 1; 2565 2566 // Construct rows of the address, source, line, column matrix. 2567 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) { 2568 const SrcLineInfo &LineInfo = LineInfos[i]; 2569 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID()); 2570 if (!LabelID) continue; 2571 2572 if (LineInfo.getLine() == 0) continue; 2573 2574 if (!Asm->isVerbose()) 2575 Asm->EOL(); 2576 else { 2577 std::pair<unsigned, unsigned> SourceID = 2578 getSourceDirectoryAndFileIds(LineInfo.getSourceID()); 2579 O << '\t' << MAI->getCommentString() << ' ' 2580 << getSourceDirectoryName(SourceID.first) << ' ' 2581 << getSourceFileName(SourceID.second) 2582 <<" :" << utostr_32(LineInfo.getLine()) << '\n'; 2583 } 2584 2585 // Define the line address. 2586 Asm->EmitInt8(0); Asm->EOL("Extended Op"); 2587 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size"); 2588 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address"); 2589 EmitReference("label", LabelID); Asm->EOL("Location label"); 2590 2591 // If change of source, then switch to the new source. 2592 if (Source != LineInfo.getSourceID()) { 2593 Source = LineInfo.getSourceID(); 2594 Asm->EmitInt8(dwarf::DW_LNS_set_file); Asm->EOL("DW_LNS_set_file"); 2595 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source"); 2596 } 2597 2598 // If change of line. 2599 if (Line != LineInfo.getLine()) { 2600 // Determine offset. 2601 int Offset = LineInfo.getLine() - Line; 2602 int Delta = Offset - MinLineDelta; 2603 2604 // Update line. 2605 Line = LineInfo.getLine(); 2606 2607 // If delta is small enough and in range... 2608 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) { 2609 // ... then use fast opcode. 2610 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta"); 2611 } else { 2612 // ... otherwise use long hand. 2613 Asm->EmitInt8(dwarf::DW_LNS_advance_line); 2614 Asm->EOL("DW_LNS_advance_line"); 2615 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset"); 2616 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy"); 2617 } 2618 } else { 2619 // Copy the previous row (different address or source) 2620 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy"); 2621 } 2622 } 2623 2624 EmitEndOfLineMatrix(j + 1); 2625 } 2626 2627 if (SecSrcLinesSize == 0) 2628 // Because we're emitting a debug_line section, we still need a line 2629 // table. The linker and friends expect it to exist. If there's nothing to 2630 // put into it, emit an empty table. 2631 EmitEndOfLineMatrix(1); 2632 2633 EmitLabel("line_end", 0); 2634 Asm->EOL(); 2635} 2636 2637/// EmitCommonDebugFrame - Emit common frame info into a debug frame section. 2638/// 2639void DwarfDebug::EmitCommonDebugFrame() { 2640 if (!MAI->doesDwarfRequireFrameSection()) 2641 return; 2642 2643 int stackGrowth = 2644 Asm->TM.getFrameInfo()->getStackGrowthDirection() == 2645 TargetFrameInfo::StackGrowsUp ? 2646 TD->getPointerSize() : -TD->getPointerSize(); 2647 2648 // Start the dwarf frame section. 2649 Asm->OutStreamer.SwitchSection( 2650 Asm->getObjFileLowering().getDwarfFrameSection()); 2651 2652 EmitLabel("debug_frame_common", 0); 2653 EmitDifference("debug_frame_common_end", 0, 2654 "debug_frame_common_begin", 0, true); 2655 Asm->EOL("Length of Common Information Entry"); 2656 2657 EmitLabel("debug_frame_common_begin", 0); 2658 Asm->EmitInt32((int)dwarf::DW_CIE_ID); 2659 Asm->EOL("CIE Identifier Tag"); 2660 Asm->EmitInt8(dwarf::DW_CIE_VERSION); 2661 Asm->EOL("CIE Version"); 2662 Asm->EmitString(""); 2663 Asm->EOL("CIE Augmentation"); 2664 Asm->EmitULEB128Bytes(1); 2665 Asm->EOL("CIE Code Alignment Factor"); 2666 Asm->EmitSLEB128Bytes(stackGrowth); 2667 Asm->EOL("CIE Data Alignment Factor"); 2668 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false)); 2669 Asm->EOL("CIE RA Column"); 2670 2671 std::vector<MachineMove> Moves; 2672 RI->getInitialFrameState(Moves); 2673 2674 EmitFrameMoves(NULL, 0, Moves, false); 2675 2676 Asm->EmitAlignment(2, 0, 0, false); 2677 EmitLabel("debug_frame_common_end", 0); 2678 2679 Asm->EOL(); 2680} 2681 2682/// EmitFunctionDebugFrame - Emit per function frame info into a debug frame 2683/// section. 2684void 2685DwarfDebug::EmitFunctionDebugFrame(const FunctionDebugFrameInfo&DebugFrameInfo){ 2686 if (!MAI->doesDwarfRequireFrameSection()) 2687 return; 2688 2689 // Start the dwarf frame section. 2690 Asm->OutStreamer.SwitchSection( 2691 Asm->getObjFileLowering().getDwarfFrameSection()); 2692 2693 EmitDifference("debug_frame_end", DebugFrameInfo.Number, 2694 "debug_frame_begin", DebugFrameInfo.Number, true); 2695 Asm->EOL("Length of Frame Information Entry"); 2696 2697 EmitLabel("debug_frame_begin", DebugFrameInfo.Number); 2698 2699 EmitSectionOffset("debug_frame_common", "section_debug_frame", 2700 0, 0, true, false); 2701 Asm->EOL("FDE CIE offset"); 2702 2703 EmitReference("func_begin", DebugFrameInfo.Number); 2704 Asm->EOL("FDE initial location"); 2705 EmitDifference("func_end", DebugFrameInfo.Number, 2706 "func_begin", DebugFrameInfo.Number); 2707 Asm->EOL("FDE address range"); 2708 2709 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, 2710 false); 2711 2712 Asm->EmitAlignment(2, 0, 0, false); 2713 EmitLabel("debug_frame_end", DebugFrameInfo.Number); 2714 2715 Asm->EOL(); 2716} 2717 2718void DwarfDebug::EmitDebugPubNamesPerCU(CompileUnit *Unit) { 2719 EmitDifference("pubnames_end", Unit->getID(), 2720 "pubnames_begin", Unit->getID(), true); 2721 Asm->EOL("Length of Public Names Info"); 2722 2723 EmitLabel("pubnames_begin", Unit->getID()); 2724 2725 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version"); 2726 2727 EmitSectionOffset("info_begin", "section_info", 2728 Unit->getID(), 0, true, false); 2729 Asm->EOL("Offset of Compilation Unit Info"); 2730 2731 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(), 2732 true); 2733 Asm->EOL("Compilation Unit Length"); 2734 2735 StringMap<DIE*> &Globals = Unit->getGlobals(); 2736 for (StringMap<DIE*>::const_iterator 2737 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) { 2738 const char *Name = GI->getKeyData(); 2739 DIE * Entity = GI->second; 2740 2741 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset"); 2742 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name"); 2743 } 2744 2745 Asm->EmitInt32(0); Asm->EOL("End Mark"); 2746 EmitLabel("pubnames_end", Unit->getID()); 2747 2748 Asm->EOL(); 2749} 2750 2751/// EmitDebugPubNames - Emit visible names into a debug pubnames section. 2752/// 2753void DwarfDebug::EmitDebugPubNames() { 2754 // Start the dwarf pubnames section. 2755 Asm->OutStreamer.SwitchSection( 2756 Asm->getObjFileLowering().getDwarfPubNamesSection()); 2757 2758 EmitDebugPubNamesPerCU(ModuleCU); 2759} 2760 2761/// EmitDebugStr - Emit visible names into a debug str section. 2762/// 2763void DwarfDebug::EmitDebugStr() { 2764 // Check to see if it is worth the effort. 2765 if (!StringPool.empty()) { 2766 // Start the dwarf str section. 2767 Asm->OutStreamer.SwitchSection( 2768 Asm->getObjFileLowering().getDwarfStrSection()); 2769 2770 // For each of strings in the string pool. 2771 for (unsigned StringID = 1, N = StringPool.size(); 2772 StringID <= N; ++StringID) { 2773 // Emit a label for reference from debug information entries. 2774 EmitLabel("string", StringID); 2775 2776 // Emit the string itself. 2777 const std::string &String = StringPool[StringID]; 2778 Asm->EmitString(String); Asm->EOL(); 2779 } 2780 2781 Asm->EOL(); 2782 } 2783} 2784 2785/// EmitDebugLoc - Emit visible names into a debug loc section. 2786/// 2787void DwarfDebug::EmitDebugLoc() { 2788 // Start the dwarf loc section. 2789 Asm->OutStreamer.SwitchSection( 2790 Asm->getObjFileLowering().getDwarfLocSection()); 2791 Asm->EOL(); 2792} 2793 2794/// EmitDebugARanges - Emit visible names into a debug aranges section. 2795/// 2796void DwarfDebug::EmitDebugARanges() { 2797 // Start the dwarf aranges section. 2798 Asm->OutStreamer.SwitchSection( 2799 Asm->getObjFileLowering().getDwarfARangesSection()); 2800 2801 // FIXME - Mock up 2802#if 0 2803 CompileUnit *Unit = GetBaseCompileUnit(); 2804 2805 // Don't include size of length 2806 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info"); 2807 2808 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version"); 2809 2810 EmitReference("info_begin", Unit->getID()); 2811 Asm->EOL("Offset of Compilation Unit Info"); 2812 2813 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address"); 2814 2815 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor"); 2816 2817 Asm->EmitInt16(0); Asm->EOL("Pad (1)"); 2818 Asm->EmitInt16(0); Asm->EOL("Pad (2)"); 2819 2820 // Range 1 2821 EmitReference("text_begin", 0); Asm->EOL("Address"); 2822 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length"); 2823 2824 Asm->EmitInt32(0); Asm->EOL("EOM (1)"); 2825 Asm->EmitInt32(0); Asm->EOL("EOM (2)"); 2826#endif 2827 2828 Asm->EOL(); 2829} 2830 2831/// EmitDebugRanges - Emit visible names into a debug ranges section. 2832/// 2833void DwarfDebug::EmitDebugRanges() { 2834 // Start the dwarf ranges section. 2835 Asm->OutStreamer.SwitchSection( 2836 Asm->getObjFileLowering().getDwarfRangesSection()); 2837 Asm->EOL(); 2838} 2839 2840/// EmitDebugMacInfo - Emit visible names into a debug macinfo section. 2841/// 2842void DwarfDebug::EmitDebugMacInfo() { 2843 if (const MCSection *LineInfo = 2844 Asm->getObjFileLowering().getDwarfMacroInfoSection()) { 2845 // Start the dwarf macinfo section. 2846 Asm->OutStreamer.SwitchSection(LineInfo); 2847 Asm->EOL(); 2848 } 2849} 2850 2851/// EmitDebugInlineInfo - Emit inline info using following format. 2852/// Section Header: 2853/// 1. length of section 2854/// 2. Dwarf version number 2855/// 3. address size. 2856/// 2857/// Entries (one "entry" for each function that was inlined): 2858/// 2859/// 1. offset into __debug_str section for MIPS linkage name, if exists; 2860/// otherwise offset into __debug_str for regular function name. 2861/// 2. offset into __debug_str section for regular function name. 2862/// 3. an unsigned LEB128 number indicating the number of distinct inlining 2863/// instances for the function. 2864/// 2865/// The rest of the entry consists of a {die_offset, low_pc} pair for each 2866/// inlined instance; the die_offset points to the inlined_subroutine die in the 2867/// __debug_info section, and the low_pc is the starting address for the 2868/// inlining instance. 2869void DwarfDebug::EmitDebugInlineInfo() { 2870 if (!MAI->doesDwarfUsesInlineInfoSection()) 2871 return; 2872 2873 if (!ModuleCU) 2874 return; 2875 2876 Asm->OutStreamer.SwitchSection( 2877 Asm->getObjFileLowering().getDwarfDebugInlineSection()); 2878 Asm->EOL(); 2879 EmitDifference("debug_inlined_end", 1, 2880 "debug_inlined_begin", 1, true); 2881 Asm->EOL("Length of Debug Inlined Information Entry"); 2882 2883 EmitLabel("debug_inlined_begin", 1); 2884 2885 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version"); 2886 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)"); 2887 2888 for (DenseMap<MDNode *, SmallVector<unsigned, 4> >::iterator 2889 I = InlineInfo.begin(), E = InlineInfo.end(); I != E; ++I) { 2890 MDNode *Node = I->first; 2891 SmallVector<unsigned, 4> &Labels = I->second; 2892 DISubprogram SP(Node); 2893 const char *LName = SP.getLinkageName(); 2894 const char *Name = SP.getName(); 2895 2896 if (!LName) 2897 Asm->EmitString(Name); 2898 else { 2899 // Skip special LLVM prefix that is used to inform the asm printer to not 2900 // emit usual symbol prefix before the symbol name. This happens for 2901 // Objective-C symbol names and symbol whose name is replaced using GCC's 2902 // __asm__ attribute. 2903 if (LName[0] == 1) 2904 LName = &LName[1]; 2905 Asm->EmitString(LName); 2906 } 2907 Asm->EOL("MIPS linkage name"); 2908 2909 Asm->EmitString(Name); Asm->EOL("Function name"); 2910 2911 Asm->EmitULEB128Bytes(Labels.size()); Asm->EOL("Inline count"); 2912 2913 for (SmallVector<unsigned, 4>::iterator LI = Labels.begin(), 2914 LE = Labels.end(); LI != LE; ++LI) { 2915 DIE *SP = ModuleCU->getDieMapSlotFor(Node); 2916 Asm->EmitInt32(SP->getOffset()); Asm->EOL("DIE offset"); 2917 2918 if (TD->getPointerSize() == sizeof(int32_t)) 2919 O << MAI->getData32bitsDirective(); 2920 else 2921 O << MAI->getData64bitsDirective(); 2922 2923 PrintLabelName("label", *LI); Asm->EOL("low_pc"); 2924 } 2925 } 2926 2927 EmitLabel("debug_inlined_end", 1); 2928 Asm->EOL(); 2929} 2930