lib/CodeGen/AsmPrinter/DwarfDebug.cpp

   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"
  30 using namespace llvm;
  31
  32 static 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 ///
  41 static const unsigned InitDiesSetSize          = 9; // log2(512)
  42 static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
  43 static const unsigned InitValuesSetSize        = 9; // log2(512)
  44
  45 namespace llvm {
  46
  47 //===----------------------------------------------------------------------===//
  48 /// CompileUnit - This dwarf writer support class manages information associate
  49 /// with a source file.
  50 class 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;
  76 public:
  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 ///
 126 class VISIBILITY_HIDDEN DbgVariable {
 127   DIVariable Var;                    // Variable Descriptor.
 128   unsigned FrameIndex;               // Variable frame index.
 129   bool InlinedFnVar;                 // Variable for an inlined function.
 130 public:
 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 ///
 143 class DbgConcreteScope;
 144 class 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;
 158 public:
 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
 211 void 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 ///
 231 class VISIBILITY_HIDDEN DbgConcreteScope : public DbgScope {
 232   CompileUnit *Unit;
 233   DIE *Die;                           // Debug info for this concrete scope.
 234 public:
 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
 242 DbgScope::~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
 253 DwarfDebug::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 }
 263 DwarfDebug::~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 ///
 277 void 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.
 300 DIEEntry *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 ///
 323 void 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 ///
 333 void 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 ///
 353 void 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 ///
 373 void 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 ///
 391 void 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 ///
 409 void 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 ///
 427 void 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 ///
 446 void 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 ///
 464 void 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.
 487 void 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.
 501 void 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.
 515 void 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.
 533 void 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 ///
 574 DIType 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 ///
 606 void 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 ///
 711 void 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.
 812 void 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.
 839 void 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.
 886 void 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.
 902 void 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.
 932 void 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.
1038 void 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.
1053 void 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.
1079 DIE *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.
1089 DIE *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.
1122 DIE *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.
1167 DIE *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 ///
1231 CompileUnit &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 ///
1240 DIE *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 ///
1296 DbgScope *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.
1335 DbgScope *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 ///
1367 void 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 ///
1454 void 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   if (!SPDie) {
1468     ConstructSubprogram(SPD.getNode());
1469     SPDie = ModuleCU->getDieMapSlotFor(SPD.getNode());
1470   }
1471   assert(SPDie && "Missing subprogram descriptor");
1472
1473   if (!AbstractScope) {
1474     // Add the function bounds.
1475     AddLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1476              DWLabel("func_begin", SubprogramCount));
1477     AddLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1478              DWLabel("func_end", SubprogramCount));
1479     MachineLocation Location(RI->getFrameRegister(*MF));
1480     AddAddress(SPDie, dwarf::DW_AT_frame_base, Location);
1481   }
1482
1483   ConstructDbgScope(RootScope, 0, 0, SPDie, ModuleCU);
1484   // If there are global variables at this scope then add their dies.
1485   for (SmallVector<WeakVH, 4>::iterator SGI = ScopedGVs.begin(),
1486        SGE = ScopedGVs.end(); SGI != SGE; ++SGI) {
1487     MDNode *N = dyn_cast_or_null<MDNode>(*SGI);
1488     if (!N) continue;
1489     DIGlobalVariable GV(N);
1490     if (GV.getContext().getNode() == RootScope->getDesc().getNode()) {
1491       DIE *ScopedGVDie = CreateGlobalVariableDIE(ModuleCU, GV);
1492       SPDie->AddChild(ScopedGVDie);
1493     }
1494   }
1495 }
1496
1497 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
1498 ///
1499 void DwarfDebug::ConstructDefaultDbgScope(MachineFunction *MF) {
1500   StringMap<DIE*> &Globals = ModuleCU->getGlobals();
1501   StringMap<DIE*>::iterator GI = Globals.find(MF->getFunction()->getName());
1502   if (GI != Globals.end()) {
1503     DIE *SPDie = GI->second;
1504
1505     // Add the function bounds.
1506     AddLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1507              DWLabel("func_begin", SubprogramCount));
1508     AddLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1509              DWLabel("func_end", SubprogramCount));
1510
1511     MachineLocation Location(RI->getFrameRegister(*MF));
1512     AddAddress(SPDie, dwarf::DW_AT_frame_base, Location);
1513   }
1514 }
1515
1516 /// GetOrCreateSourceID - Look up the source id with the given directory and
1517 /// source file names. If none currently exists, create a new id and insert it
1518 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1519 /// maps as well.
1520 unsigned DwarfDebug::GetOrCreateSourceID(const char *DirName,
1521                                          const char *FileName) {
1522   unsigned DId;
1523   StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1524   if (DI != DirectoryIdMap.end()) {
1525     DId = DI->getValue();
1526   } else {
1527     DId = DirectoryNames.size() + 1;
1528     DirectoryIdMap[DirName] = DId;
1529     DirectoryNames.push_back(DirName);
1530   }
1531
1532   unsigned FId;
1533   StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1534   if (FI != SourceFileIdMap.end()) {
1535     FId = FI->getValue();
1536   } else {
1537     FId = SourceFileNames.size() + 1;
1538     SourceFileIdMap[FileName] = FId;
1539     SourceFileNames.push_back(FileName);
1540   }
1541
1542   DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1543     SourceIdMap.find(std::make_pair(DId, FId));
1544   if (SI != SourceIdMap.end())
1545     return SI->second;
1546
1547   unsigned SrcId = SourceIds.size() + 1;  // DW_AT_decl_file cannot be 0.
1548   SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1549   SourceIds.push_back(std::make_pair(DId, FId));
1550
1551   return SrcId;
1552 }
1553
1554 void DwarfDebug::ConstructCompileUnit(MDNode *N) {
1555   DICompileUnit DIUnit(N);
1556   const char *FN = DIUnit.getFilename();
1557   const char *Dir = DIUnit.getDirectory();
1558   unsigned ID = GetOrCreateSourceID(Dir, FN);
1559
1560   DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
1561   AddSectionOffset(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
1562                    DWLabel("section_line", 0), DWLabel("section_line", 0),
1563                    false);
1564   AddString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
1565             DIUnit.getProducer());
1566   AddUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
1567           DIUnit.getLanguage());
1568   AddString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
1569
1570   if (Dir)
1571     AddString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
1572   if (DIUnit.isOptimized())
1573     AddUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1574
1575   if (const char *Flags = DIUnit.getFlags())
1576     AddString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
1577
1578   unsigned RVer = DIUnit.getRunTimeVersion();
1579   if (RVer)
1580     AddUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
1581             dwarf::DW_FORM_data1, RVer);
1582
1583   CompileUnit *Unit = new CompileUnit(ID, Die);
1584   if (!ModuleCU && DIUnit.isMain()) {
1585     // Use first compile unit marked as isMain as the compile unit
1586     // for this module.
1587     ModuleCU = Unit;
1588   }
1589
1590   CompileUnitMap[DIUnit.getNode()] = Unit;
1591   CompileUnits.push_back(Unit);
1592 }
1593
1594 void DwarfDebug::ConstructGlobalVariableDIE(MDNode *N) {
1595   DIGlobalVariable DI_GV(N);
1596
1597   // If debug information is malformed then ignore it.
1598   if (DI_GV.Verify() == false)
1599     return;
1600
1601   // Check for pre-existence.
1602   DIE *&Slot = ModuleCU->getDieMapSlotFor(DI_GV.getNode());
1603   if (Slot)
1604     return;
1605
1606   DIE *VariableDie = CreateGlobalVariableDIE(ModuleCU, DI_GV);
1607
1608   // Add to map.
1609   Slot = VariableDie;
1610
1611   // Add to context owner.
1612   ModuleCU->getDie()->AddChild(VariableDie);
1613
1614   // Expose as global. FIXME - need to check external flag.
1615   ModuleCU->AddGlobal(DI_GV.getName(), VariableDie);
1616   return;
1617 }
1618
1619 void DwarfDebug::ConstructSubprogram(MDNode *N) {
1620   DISubprogram SP(N);
1621
1622   // Check for pre-existence.
1623   DIE *&Slot = ModuleCU->getDieMapSlotFor(N);
1624   if (Slot)
1625     return;
1626
1627   if (!SP.isDefinition())
1628     // This is a method declaration which will be handled while constructing
1629     // class type.
1630     return;
1631
1632   DIE *SubprogramDie = CreateSubprogramDIE(ModuleCU, SP);
1633
1634   // Add to map.
1635   Slot = SubprogramDie;
1636
1637   // Add to context owner.
1638   ModuleCU->getDie()->AddChild(SubprogramDie);
1639
1640   // Expose as global.
1641   ModuleCU->AddGlobal(SP.getName(), SubprogramDie);
1642   return;
1643 }
1644
1645 /// BeginModule - Emit all Dwarf sections that should come prior to the
1646 /// content. Create global DIEs and emit initial debug info sections.
1647 /// This is inovked by the target AsmPrinter.
1648 void DwarfDebug::BeginModule(Module *M, MachineModuleInfo *mmi) {
1649   this->M = M;
1650
1651   if (TimePassesIsEnabled)
1652     DebugTimer->startTimer();
1653
1654   DebugInfoFinder DbgFinder;
1655   DbgFinder.processModule(*M);
1656
1657   // Create all the compile unit DIEs.
1658   for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1659          E = DbgFinder.compile_unit_end(); I != E; ++I)
1660     ConstructCompileUnit(*I);
1661
1662   if (CompileUnits.empty()) {
1663     if (TimePassesIsEnabled)
1664       DebugTimer->stopTimer();
1665
1666     return;
1667   }
1668
1669   // If main compile unit for this module is not seen than randomly
1670   // select first compile unit.
1671   if (!ModuleCU)
1672     ModuleCU = CompileUnits[0];
1673
1674   // If there is not any debug info available for any global variables and any
1675   // subprograms then there is not any debug info to emit.
1676   if (DbgFinder.global_variable_count() == 0
1677       && DbgFinder.subprogram_count() == 0) {
1678     if (TimePassesIsEnabled)
1679       DebugTimer->stopTimer();
1680     return;
1681   }
1682
1683   // Create DIEs for each of the externally visible global variables.
1684   for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1685          E = DbgFinder.global_variable_end(); I != E; ++I) {
1686     DIGlobalVariable GV(*I);
1687     if (GV.getContext().getNode() != GV.getCompileUnit().getNode())
1688       ScopedGVs.push_back(*I);
1689     else
1690       ConstructGlobalVariableDIE(*I);
1691   }
1692
1693   // Create DIEs for each of the externally visible subprograms.
1694   for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1695          E = DbgFinder.subprogram_end(); I != E; ++I)
1696     ConstructSubprogram(*I);
1697
1698   MMI = mmi;
1699   shouldEmit = true;
1700   MMI->setDebugInfoAvailability(true);
1701
1702   // Prime section data.
1703   SectionMap.insert(Asm->getObjFileLowering().getTextSection());
1704
1705   // Print out .file directives to specify files for .loc directives. These are
1706   // printed out early so that they precede any .loc directives.
1707   if (MAI->hasDotLocAndDotFile()) {
1708     for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1709       // Remember source id starts at 1.
1710       std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
1711       sys::Path FullPath(getSourceDirectoryName(Id.first));
1712       bool AppendOk =
1713         FullPath.appendComponent(getSourceFileName(Id.second));
1714       assert(AppendOk && "Could not append filename to directory!");
1715       AppendOk = false;
1716       Asm->EmitFile(i, FullPath.str());
1717       Asm->EOL();
1718     }
1719   }
1720
1721   // Emit initial sections
1722   EmitInitial();
1723
1724   if (TimePassesIsEnabled)
1725     DebugTimer->stopTimer();
1726 }
1727
1728 /// EndModule - Emit all Dwarf sections that should come after the content.
1729 ///
1730 void DwarfDebug::EndModule() {
1731   if (!ShouldEmitDwarfDebug())
1732     return;
1733
1734   if (TimePassesIsEnabled)
1735     DebugTimer->startTimer();
1736
1737   // Standard sections final addresses.
1738   Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
1739   EmitLabel("text_end", 0);
1740   Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
1741   EmitLabel("data_end", 0);
1742
1743   // End text sections.
1744   for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
1745     Asm->OutStreamer.SwitchSection(SectionMap[i]);
1746     EmitLabel("section_end", i);
1747   }
1748
1749   // Emit common frame information.
1750   EmitCommonDebugFrame();
1751
1752   // Emit function debug frame information
1753   for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
1754          E = DebugFrames.end(); I != E; ++I)
1755     EmitFunctionDebugFrame(*I);
1756
1757   // Compute DIE offsets and sizes.
1758   SizeAndOffsets();
1759
1760   // Emit all the DIEs into a debug info section
1761   EmitDebugInfo();
1762
1763   // Corresponding abbreviations into a abbrev section.
1764   EmitAbbreviations();
1765
1766   // Emit source line correspondence into a debug line section.
1767   EmitDebugLines();
1768
1769   // Emit info into a debug pubnames section.
1770   EmitDebugPubNames();
1771
1772   // Emit info into a debug str section.
1773   EmitDebugStr();
1774
1775   // Emit info into a debug loc section.
1776   EmitDebugLoc();
1777
1778   // Emit info into a debug aranges section.
1779   EmitDebugARanges();
1780
1781   // Emit info into a debug ranges section.
1782   EmitDebugRanges();
1783
1784   // Emit info into a debug macinfo section.
1785   EmitDebugMacInfo();
1786
1787   // Emit inline info.
1788   EmitDebugInlineInfo();
1789
1790   if (TimePassesIsEnabled)
1791     DebugTimer->stopTimer();
1792 }
1793
1794 /// ExtractScopeInformation - Scan machine instructions in this function
1795 /// and collect DbgScopes. Return true, if atleast one scope was found.
1796 bool DwarfDebug::ExtractScopeInformation(MachineFunction *MF) {
1797   // If scope information was extracted using .dbg intrinsics then there is not
1798   // any need to extract these information by scanning each instruction.
1799   if (!DbgScopeMap.empty())
1800     return false;
1801
1802   // Scan each instruction and create scopes.
1803   for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
1804        I != E; ++I) {
1805     for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1806          II != IE; ++II) {
1807       const MachineInstr *MInsn = II;
1808       DebugLoc DL = MInsn->getDebugLoc();
1809       if (DL.isUnknown())
1810         continue;
1811       DebugLocTuple DLT = MF->getDebugLocTuple(DL);
1812       if (!DLT.CompileUnit)
1813         continue;
1814       // There is no need to create another DIE for compile unit. For all
1815       // other scopes, create one DbgScope now. This will be translated
1816       // into a scope DIE at the end.
1817       DIDescriptor D(DLT.CompileUnit);
1818       if (!D.isCompileUnit()) {
1819         DbgScope *Scope = getDbgScope(DLT.CompileUnit, MInsn);
1820         Scope->setLastInsn(MInsn);
1821       }
1822     }
1823   }
1824
1825   // If a scope's last instruction is not set then use its child scope's
1826   // last instruction as this scope's last instrunction.
1827   for (DenseMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(),
1828          DE = DbgScopeMap.end(); DI != DE; ++DI) {
1829     assert (DI->second->getFirstInsn() && "Invalid first instruction!");
1830     DI->second->FixInstructionMarkers();
1831     assert (DI->second->getLastInsn() && "Invalid last instruction!");
1832   }
1833
1834   // Each scope has first instruction and last instruction to mark beginning
1835   // and end of a scope respectively. Create an inverse map that list scopes
1836   // starts (and ends) with an instruction. One instruction may start (or end)
1837   // multiple scopes.
1838   for (DenseMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(),
1839          DE = DbgScopeMap.end(); DI != DE; ++DI) {
1840     DbgScope *S = DI->second;
1841     assert (S && "DbgScope is missing!");
1842     const MachineInstr *MI = S->getFirstInsn();
1843     assert (MI && "DbgScope does not have first instruction!");
1844
1845     InsnToDbgScopeMapTy::iterator IDI = DbgScopeBeginMap.find(MI);
1846     if (IDI != DbgScopeBeginMap.end())
1847       IDI->second.push_back(S);
1848     else
1849       DbgScopeBeginMap.insert(std::make_pair(MI,
1850                                              SmallVector<DbgScope *, 2>(2, S)));
1851
1852     MI = S->getLastInsn();
1853     assert (MI && "DbgScope does not have last instruction!");
1854     IDI = DbgScopeEndMap.find(MI);
1855     if (IDI != DbgScopeEndMap.end())
1856       IDI->second.push_back(S);
1857     else
1858       DbgScopeEndMap.insert(std::make_pair(MI,
1859                                              SmallVector<DbgScope *, 2>(2, S)));
1860   }
1861
1862   return !DbgScopeMap.empty();
1863 }
1864
1865 /// BeginFunction - Gather pre-function debug information.  Assumes being
1866 /// emitted immediately after the function entry point.
1867 void DwarfDebug::BeginFunction(MachineFunction *MF) {
1868   this->MF = MF;
1869
1870   if (!ShouldEmitDwarfDebug()) return;
1871
1872   if (TimePassesIsEnabled)
1873     DebugTimer->startTimer();
1874
1875   // Begin accumulating function debug information.
1876   MMI->BeginFunction(MF);
1877
1878   // Assumes in correct section after the entry point.
1879   EmitLabel("func_begin", ++SubprogramCount);
1880
1881   // Emit label for the implicitly defined dbg.stoppoint at the start of the
1882   // function.
1883   DebugLoc FDL = MF->getDefaultDebugLoc();
1884   if (!FDL.isUnknown()) {
1885     DebugLocTuple DLT = MF->getDebugLocTuple(FDL);
1886     unsigned LabelID = RecordSourceLine(DLT.Line, DLT.Col, DLT.CompileUnit);
1887     Asm->printLabel(LabelID);
1888     O << '\n';
1889   }
1890
1891   if (TimePassesIsEnabled)
1892     DebugTimer->stopTimer();
1893 }
1894
1895 /// EndFunction - Gather and emit post-function debug information.
1896 ///
1897 void DwarfDebug::EndFunction(MachineFunction *MF) {
1898   if (!ShouldEmitDwarfDebug()) return;
1899
1900   if (TimePassesIsEnabled)
1901     DebugTimer->startTimer();
1902
1903   // Define end label for subprogram.
1904   EmitLabel("func_end", SubprogramCount);
1905
1906   // Get function line info.
1907   if (!Lines.empty()) {
1908     // Get section line info.
1909     unsigned ID = SectionMap.insert(Asm->getCurrentSection());
1910     if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
1911     std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
1912     // Append the function info to section info.
1913     SectionLineInfos.insert(SectionLineInfos.end(),
1914                             Lines.begin(), Lines.end());
1915   }
1916
1917   // Construct the DbgScope for abstract instances.
1918   for (SmallVector<DbgScope *, 32>::iterator
1919          I = AbstractInstanceRootList.begin(),
1920          E = AbstractInstanceRootList.end(); I != E; ++I)
1921     ConstructFunctionDbgScope(*I);
1922
1923   // Construct scopes for subprogram.
1924   if (FunctionDbgScope)
1925     ConstructFunctionDbgScope(FunctionDbgScope);
1926   else
1927     // FIXME: This is wrong. We are essentially getting past a problem with
1928     // debug information not being able to handle unreachable blocks that have
1929     // debug information in them. In particular, those unreachable blocks that
1930     // have "region end" info in them. That situation results in the "root
1931     // scope" not being created. If that's the case, then emit a "default"
1932     // scope, i.e., one that encompasses the whole function. This isn't
1933     // desirable. And a better way of handling this (and all of the debugging
1934     // information) needs to be explored.
1935     ConstructDefaultDbgScope(MF);
1936
1937   DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
1938                                                MMI->getFrameMoves()));
1939
1940   // Clear debug info
1941   if (FunctionDbgScope) {
1942     delete FunctionDbgScope;
1943     DbgScopeMap.clear();
1944     DbgScopeBeginMap.clear();
1945     DbgScopeEndMap.clear();
1946     DbgAbstractScopeMap.clear();
1947     DbgConcreteScopeMap.clear();
1948     FunctionDbgScope = NULL;
1949     LexicalScopeStack.clear();
1950     AbstractInstanceRootList.clear();
1951     AbstractInstanceRootMap.clear();
1952   }
1953
1954   Lines.clear();
1955
1956   if (TimePassesIsEnabled)
1957     DebugTimer->stopTimer();
1958 }
1959
1960 /// RecordSourceLine - Records location information and associates it with a
1961 /// label. Returns a unique label ID used to generate a label and provide
1962 /// correspondence to the source line list.
1963 unsigned DwarfDebug::RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
1964   if (TimePassesIsEnabled)
1965     DebugTimer->startTimer();
1966
1967   CompileUnit *Unit = CompileUnitMap[V];
1968   assert(Unit && "Unable to find CompileUnit");
1969   unsigned ID = MMI->NextLabelID();
1970   Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
1971
1972   if (TimePassesIsEnabled)
1973     DebugTimer->stopTimer();
1974
1975   return ID;
1976 }
1977
1978 /// RecordSourceLine - Records location information and associates it with a
1979 /// label. Returns a unique label ID used to generate a label and provide
1980 /// correspondence to the source line list.
1981 unsigned DwarfDebug::RecordSourceLine(unsigned Line, unsigned Col,
1982                                       MDNode *S) {
1983   if (!MMI)
1984     return 0;
1985
1986   if (TimePassesIsEnabled)
1987     DebugTimer->startTimer();
1988
1989   const char *Dir = NULL;
1990   const char *Fn = NULL;
1991
1992   DIDescriptor Scope(S);
1993   if (Scope.isCompileUnit()) {
1994     DICompileUnit CU(S);
1995     Dir = CU.getDirectory();
1996     Fn = CU.getFilename();
1997   } else if (Scope.isSubprogram()) {
1998     DISubprogram SP(S);
1999     Dir = SP.getDirectory();
2000     Fn = SP.getFilename();
2001   } else if (Scope.isLexicalBlock()) {
2002     DILexicalBlock DB(S);
2003     Dir = DB.getDirectory();
2004     Fn = DB.getFilename();
2005   } else
2006     assert (0 && "Unexpected scope info");
2007
2008   unsigned Src = GetOrCreateSourceID(Dir, Fn);
2009   unsigned ID = MMI->NextLabelID();
2010   Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
2011
2012   if (TimePassesIsEnabled)
2013     DebugTimer->stopTimer();
2014
2015   return ID;
2016 }
2017
2018 /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
2019 /// timed. Look up the source id with the given directory and source file
2020 /// names. If none currently exists, create a new id and insert it in the
2021 /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
2022 /// well.
2023 unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName,
2024                                          const std::string &FileName) {
2025   if (TimePassesIsEnabled)
2026     DebugTimer->startTimer();
2027
2028   unsigned SrcId = GetOrCreateSourceID(DirName.c_str(), FileName.c_str());
2029
2030   if (TimePassesIsEnabled)
2031     DebugTimer->stopTimer();
2032
2033   return SrcId;
2034 }
2035
2036 /// RecordRegionStart - Indicate the start of a region.
2037 unsigned DwarfDebug::RecordRegionStart(MDNode *N) {
2038   if (TimePassesIsEnabled)
2039     DebugTimer->startTimer();
2040
2041   DbgScope *Scope = getOrCreateScope(N);
2042   unsigned ID = MMI->NextLabelID();
2043   if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
2044   LexicalScopeStack.push_back(Scope);
2045
2046   if (TimePassesIsEnabled)
2047     DebugTimer->stopTimer();
2048
2049   return ID;
2050 }
2051
2052 /// RecordRegionEnd - Indicate the end of a region.
2053 unsigned DwarfDebug::RecordRegionEnd(MDNode *N) {
2054   if (TimePassesIsEnabled)
2055     DebugTimer->startTimer();
2056
2057   DbgScope *Scope = getOrCreateScope(N);
2058   unsigned ID = MMI->NextLabelID();
2059   Scope->setEndLabelID(ID);
2060   // FIXME : region.end() may not be in the last basic block.
2061   // For now, do not pop last lexical scope because next basic
2062   // block may start new inlined function's body.
2063   unsigned LSSize = LexicalScopeStack.size();
2064   if (LSSize != 0 && LSSize != 1)
2065     LexicalScopeStack.pop_back();
2066
2067   if (TimePassesIsEnabled)
2068     DebugTimer->stopTimer();
2069
2070   return ID;
2071 }
2072
2073 /// RecordVariable - Indicate the declaration of a local variable.
2074 void DwarfDebug::RecordVariable(MDNode *N, unsigned FrameIndex) {
2075   if (TimePassesIsEnabled)
2076     DebugTimer->startTimer();
2077
2078   DIDescriptor Desc(N);
2079   DbgScope *Scope = NULL;
2080   bool InlinedFnVar = false;
2081
2082   if (Desc.getTag() == dwarf::DW_TAG_variable)
2083     Scope = getOrCreateScope(DIGlobalVariable(N).getContext().getNode());
2084   else {
2085     bool InlinedVar = false;
2086     MDNode *Context = DIVariable(N).getContext().getNode();
2087     DISubprogram SP(Context);
2088     if (!SP.isNull()) {
2089       // SP is inserted into DbgAbstractScopeMap when inlined function
2090       // start was recorded by RecordInlineFnStart.
2091       DenseMap<MDNode *, DbgScope *>::iterator
2092         I = DbgAbstractScopeMap.find(SP.getNode());
2093       if (I != DbgAbstractScopeMap.end()) {
2094         InlinedVar = true;
2095         Scope = I->second;
2096       }
2097     }
2098     if (!InlinedVar)
2099       Scope = getOrCreateScope(Context);
2100   }
2101
2102   assert(Scope && "Unable to find the variable's scope");
2103   DbgVariable *DV = new DbgVariable(DIVariable(N), FrameIndex, InlinedFnVar);
2104   Scope->AddVariable(DV);
2105
2106   if (TimePassesIsEnabled)
2107     DebugTimer->stopTimer();
2108 }
2109
2110 //// RecordInlinedFnStart - Indicate the start of inlined subroutine.
2111 unsigned DwarfDebug::RecordInlinedFnStart(DISubprogram &SP, DICompileUnit CU,
2112                                           unsigned Line, unsigned Col) {
2113   unsigned LabelID = MMI->NextLabelID();
2114
2115   if (!MAI->doesDwarfUsesInlineInfoSection())
2116     return LabelID;
2117
2118   if (TimePassesIsEnabled)
2119     DebugTimer->startTimer();
2120
2121   MDNode *Node = SP.getNode();
2122   DenseMap<const MDNode *, DbgScope *>::iterator
2123     II = AbstractInstanceRootMap.find(Node);
2124
2125   if (II == AbstractInstanceRootMap.end()) {
2126     // Create an abstract instance entry for this inlined function if it doesn't
2127     // already exist.
2128     DbgScope *Scope = new DbgScope(NULL, DIDescriptor(Node));
2129
2130     // Get the compile unit context.
2131     DIE *SPDie = ModuleCU->getDieMapSlotFor(Node);
2132     if (!SPDie)
2133       SPDie = CreateSubprogramDIE(ModuleCU, SP, false, true);
2134
2135     // Mark as being inlined. This makes this subprogram entry an abstract
2136     // instance root.
2137     // FIXME: Our debugger doesn't care about the value of DW_AT_inline, only
2138     // that it's defined. That probably won't change in the future. However,
2139     // this could be more elegant.
2140     AddUInt(SPDie, dwarf::DW_AT_inline, 0, dwarf::DW_INL_declared_not_inlined);
2141
2142     // Keep track of the abstract scope for this function.
2143     DbgAbstractScopeMap[Node] = Scope;
2144
2145     AbstractInstanceRootMap[Node] = Scope;
2146     AbstractInstanceRootList.push_back(Scope);
2147   }
2148
2149   // Create a concrete inlined instance for this inlined function.
2150   DbgConcreteScope *ConcreteScope = new DbgConcreteScope(DIDescriptor(Node));
2151   DIE *ScopeDie = new DIE(dwarf::DW_TAG_inlined_subroutine);
2152   ScopeDie->setAbstractCompileUnit(ModuleCU);
2153
2154   DIE *Origin = ModuleCU->getDieMapSlotFor(Node);
2155   AddDIEEntry(ScopeDie, dwarf::DW_AT_abstract_origin,
2156               dwarf::DW_FORM_ref4, Origin);
2157   AddUInt(ScopeDie, dwarf::DW_AT_call_file, 0, ModuleCU->getID());
2158   AddUInt(ScopeDie, dwarf::DW_AT_call_line, 0, Line);
2159   AddUInt(ScopeDie, dwarf::DW_AT_call_column, 0, Col);
2160
2161   ConcreteScope->setDie(ScopeDie);
2162   ConcreteScope->setStartLabelID(LabelID);
2163   MMI->RecordUsedDbgLabel(LabelID);
2164
2165   LexicalScopeStack.back()->AddConcreteInst(ConcreteScope);
2166
2167   // Keep track of the concrete scope that's inlined into this function.
2168   DenseMap<MDNode *, SmallVector<DbgScope *, 8> >::iterator
2169     SI = DbgConcreteScopeMap.find(Node);
2170
2171   if (SI == DbgConcreteScopeMap.end())
2172     DbgConcreteScopeMap[Node].push_back(ConcreteScope);
2173   else
2174     SI->second.push_back(ConcreteScope);
2175
2176   // Track the start label for this inlined function.
2177   DenseMap<MDNode *, SmallVector<unsigned, 4> >::iterator
2178     I = InlineInfo.find(Node);
2179
2180   if (I == InlineInfo.end())
2181     InlineInfo[Node].push_back(LabelID);
2182   else
2183     I->second.push_back(LabelID);
2184
2185   if (TimePassesIsEnabled)
2186     DebugTimer->stopTimer();
2187
2188   return LabelID;
2189 }
2190
2191 /// RecordInlinedFnEnd - Indicate the end of inlined subroutine.
2192 unsigned DwarfDebug::RecordInlinedFnEnd(DISubprogram &SP) {
2193   if (!MAI->doesDwarfUsesInlineInfoSection())
2194     return 0;
2195
2196   if (TimePassesIsEnabled)
2197     DebugTimer->startTimer();
2198
2199   MDNode *Node = SP.getNode();
2200   DenseMap<MDNode *, SmallVector<DbgScope *, 8> >::iterator
2201     I = DbgConcreteScopeMap.find(Node);
2202
2203   if (I == DbgConcreteScopeMap.end()) {
2204     // FIXME: Can this situation actually happen? And if so, should it?
2205     if (TimePassesIsEnabled)
2206       DebugTimer->stopTimer();
2207
2208     return 0;
2209   }
2210
2211   SmallVector<DbgScope *, 8> &Scopes = I->second;
2212   if (Scopes.empty()) {
2213     // Returned ID is 0 if this is unbalanced "end of inlined
2214     // scope". This could happen if optimizer eats dbg intrinsics
2215     // or "beginning of inlined scope" is not recoginized due to
2216     // missing location info. In such cases, ignore this region.end.
2217     return 0;
2218   }
2219
2220   DbgScope *Scope = Scopes.back(); Scopes.pop_back();
2221   unsigned ID = MMI->NextLabelID();
2222   MMI->RecordUsedDbgLabel(ID);
2223   Scope->setEndLabelID(ID);
2224
2225   if (TimePassesIsEnabled)
2226     DebugTimer->stopTimer();
2227
2228   return ID;
2229 }
2230
2231 //===----------------------------------------------------------------------===//
2232 // Emit Methods
2233 //===----------------------------------------------------------------------===//
2234
2235 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2236 ///
2237 unsigned DwarfDebug::SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2238   // Get the children.
2239   const std::vector<DIE *> &Children = Die->getChildren();
2240
2241   // If not last sibling and has children then add sibling offset attribute.
2242   if (!Last && !Children.empty()) Die->AddSiblingOffset();
2243
2244   // Record the abbreviation.
2245   AssignAbbrevNumber(Die->getAbbrev());
2246
2247   // Get the abbreviation for this DIE.
2248   unsigned AbbrevNumber = Die->getAbbrevNumber();
2249   const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2250
2251   // Set DIE offset
2252   Die->setOffset(Offset);
2253
2254   // Start the size with the size of abbreviation code.
2255   Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
2256
2257   const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2258   const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2259
2260   // Size the DIE attribute values.
2261   for (unsigned i = 0, N = Values.size(); i < N; ++i)
2262     // Size attribute value.
2263     Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
2264
2265   // Size the DIE children if any.
2266   if (!Children.empty()) {
2267     assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2268            "Children flag not set");
2269
2270     for (unsigned j = 0, M = Children.size(); j < M; ++j)
2271       Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2272
2273     // End of children marker.
2274     Offset += sizeof(int8_t);
2275   }
2276
2277   Die->setSize(Offset - Die->getOffset());
2278   return Offset;
2279 }
2280
2281 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2282 ///
2283 void DwarfDebug::SizeAndOffsets() {
2284   // Compute size of compile unit header.
2285   static unsigned Offset =
2286     sizeof(int32_t) + // Length of Compilation Unit Info
2287     sizeof(int16_t) + // DWARF version number
2288     sizeof(int32_t) + // Offset Into Abbrev. Section
2289     sizeof(int8_t);   // Pointer Size (in bytes)
2290
2291   SizeAndOffsetDie(ModuleCU->getDie(), Offset, true);
2292   CompileUnitOffsets[ModuleCU] = 0;
2293 }
2294
2295 /// EmitInitial - Emit initial Dwarf declarations.  This is necessary for cc
2296 /// tools to recognize the object file contains Dwarf information.
2297 void DwarfDebug::EmitInitial() {
2298   // Check to see if we already emitted intial headers.
2299   if (didInitial) return;
2300   didInitial = true;
2301
2302   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
2303
2304   // Dwarf sections base addresses.
2305   if (MAI->doesDwarfRequireFrameSection()) {
2306     Asm->OutStreamer.SwitchSection(TLOF.getDwarfFrameSection());
2307     EmitLabel("section_debug_frame", 0);
2308   }
2309
2310   Asm->OutStreamer.SwitchSection(TLOF.getDwarfInfoSection());
2311   EmitLabel("section_info", 0);
2312   Asm->OutStreamer.SwitchSection(TLOF.getDwarfAbbrevSection());
2313   EmitLabel("section_abbrev", 0);
2314   Asm->OutStreamer.SwitchSection(TLOF.getDwarfARangesSection());
2315   EmitLabel("section_aranges", 0);
2316
2317   if (const MCSection *LineInfoDirective = TLOF.getDwarfMacroInfoSection()) {
2318     Asm->OutStreamer.SwitchSection(LineInfoDirective);
2319     EmitLabel("section_macinfo", 0);
2320   }
2321
2322   Asm->OutStreamer.SwitchSection(TLOF.getDwarfLineSection());
2323   EmitLabel("section_line", 0);
2324   Asm->OutStreamer.SwitchSection(TLOF.getDwarfLocSection());
2325   EmitLabel("section_loc", 0);
2326   Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubNamesSection());
2327   EmitLabel("section_pubnames", 0);
2328   Asm->OutStreamer.SwitchSection(TLOF.getDwarfStrSection());
2329   EmitLabel("section_str", 0);
2330   Asm->OutStreamer.SwitchSection(TLOF.getDwarfRangesSection());
2331   EmitLabel("section_ranges", 0);
2332
2333   Asm->OutStreamer.SwitchSection(TLOF.getTextSection());
2334   EmitLabel("text_begin", 0);
2335   Asm->OutStreamer.SwitchSection(TLOF.getDataSection());
2336   EmitLabel("data_begin", 0);
2337 }
2338
2339 /// EmitDIE - Recusively Emits a debug information entry.
2340 ///
2341 void DwarfDebug::EmitDIE(DIE *Die) {
2342   // Get the abbreviation for this DIE.
2343   unsigned AbbrevNumber = Die->getAbbrevNumber();
2344   const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2345
2346   Asm->EOL();
2347
2348   // Emit the code (index) for the abbreviation.
2349   Asm->EmitULEB128Bytes(AbbrevNumber);
2350
2351   if (Asm->isVerbose())
2352     Asm->EOL(std::string("Abbrev [" +
2353                          utostr(AbbrevNumber) +
2354                          "] 0x" + utohexstr(Die->getOffset()) +
2355                          ":0x" + utohexstr(Die->getSize()) + " " +
2356                          dwarf::TagString(Abbrev->getTag())));
2357   else
2358     Asm->EOL();
2359
2360   SmallVector<DIEValue*, 32> &Values = Die->getValues();
2361   const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2362
2363   // Emit the DIE attribute values.
2364   for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2365     unsigned Attr = AbbrevData[i].getAttribute();
2366     unsigned Form = AbbrevData[i].getForm();
2367     assert(Form && "Too many attributes for DIE (check abbreviation)");
2368
2369     switch (Attr) {
2370     case dwarf::DW_AT_sibling:
2371       Asm->EmitInt32(Die->SiblingOffset());
2372       break;
2373     case dwarf::DW_AT_abstract_origin: {
2374       DIEEntry *E = cast<DIEEntry>(Values[i]);
2375       DIE *Origin = E->getEntry();
2376       unsigned Addr =
2377         CompileUnitOffsets[Die->getAbstractCompileUnit()] +
2378         Origin->getOffset();
2379
2380       Asm->EmitInt32(Addr);
2381       break;
2382     }
2383     default:
2384       // Emit an attribute using the defined form.
2385       Values[i]->EmitValue(this, Form);
2386       break;
2387     }
2388
2389     Asm->EOL(dwarf::AttributeString(Attr));
2390   }
2391
2392   // Emit the DIE children if any.
2393   if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2394     const std::vector<DIE *> &Children = Die->getChildren();
2395
2396     for (unsigned j = 0, M = Children.size(); j < M; ++j)
2397       EmitDIE(Children[j]);
2398
2399     Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2400   }
2401 }
2402
2403 /// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
2404 ///
2405 void DwarfDebug::EmitDebugInfoPerCU(CompileUnit *Unit) {
2406   DIE *Die = Unit->getDie();
2407
2408   // Emit the compile units header.
2409   EmitLabel("info_begin", Unit->getID());
2410
2411   // Emit size of content not including length itself
2412   unsigned ContentSize = Die->getSize() +
2413     sizeof(int16_t) + // DWARF version number
2414     sizeof(int32_t) + // Offset Into Abbrev. Section
2415     sizeof(int8_t) +  // Pointer Size (in bytes)
2416     sizeof(int32_t);  // FIXME - extra pad for gdb bug.
2417
2418   Asm->EmitInt32(ContentSize);  Asm->EOL("Length of Compilation Unit Info");
2419   Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2420   EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2421   Asm->EOL("Offset Into Abbrev. Section");
2422   Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2423
2424   EmitDIE(Die);
2425   // FIXME - extra padding for gdb bug.
2426   Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2427   Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2428   Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2429   Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2430   EmitLabel("info_end", Unit->getID());
2431
2432   Asm->EOL();
2433 }
2434
2435 void DwarfDebug::EmitDebugInfo() {
2436   // Start debug info section.
2437   Asm->OutStreamer.SwitchSection(
2438                             Asm->getObjFileLowering().getDwarfInfoSection());
2439
2440   EmitDebugInfoPerCU(ModuleCU);
2441 }
2442
2443 /// EmitAbbreviations - Emit the abbreviation section.
2444 ///
2445 void DwarfDebug::EmitAbbreviations() const {
2446   // Check to see if it is worth the effort.
2447   if (!Abbreviations.empty()) {
2448     // Start the debug abbrev section.
2449     Asm->OutStreamer.SwitchSection(
2450                             Asm->getObjFileLowering().getDwarfAbbrevSection());
2451
2452     EmitLabel("abbrev_begin", 0);
2453
2454     // For each abbrevation.
2455     for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2456       // Get abbreviation data
2457       const DIEAbbrev *Abbrev = Abbreviations[i];
2458
2459       // Emit the abbrevations code (base 1 index.)
2460       Asm->EmitULEB128Bytes(Abbrev->getNumber());
2461       Asm->EOL("Abbreviation Code");
2462
2463       // Emit the abbreviations data.
2464       Abbrev->Emit(Asm);
2465
2466       Asm->EOL();
2467     }
2468
2469     // Mark end of abbreviations.
2470     Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2471
2472     EmitLabel("abbrev_end", 0);
2473     Asm->EOL();
2474   }
2475 }
2476
2477 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2478 /// the line matrix.
2479 ///
2480 void DwarfDebug::EmitEndOfLineMatrix(unsigned SectionEnd) {
2481   // Define last address of section.
2482   Asm->EmitInt8(0); Asm->EOL("Extended Op");
2483   Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2484   Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2485   EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2486
2487   // Mark end of matrix.
2488   Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2489   Asm->EmitULEB128Bytes(1); Asm->EOL();
2490   Asm->EmitInt8(1); Asm->EOL();
2491 }
2492
2493 /// EmitDebugLines - Emit source line information.
2494 ///
2495 void DwarfDebug::EmitDebugLines() {
2496   // If the target is using .loc/.file, the assembler will be emitting the
2497   // .debug_line table automatically.
2498   if (MAI->hasDotLocAndDotFile())
2499     return;
2500
2501   // Minimum line delta, thus ranging from -10..(255-10).
2502   const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
2503   // Maximum line delta, thus ranging from -10..(255-10).
2504   const int MaxLineDelta = 255 + MinLineDelta;
2505
2506   // Start the dwarf line section.
2507   Asm->OutStreamer.SwitchSection(
2508                             Asm->getObjFileLowering().getDwarfLineSection());
2509
2510   // Construct the section header.
2511   EmitDifference("line_end", 0, "line_begin", 0, true);
2512   Asm->EOL("Length of Source Line Info");
2513   EmitLabel("line_begin", 0);
2514
2515   Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2516
2517   EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2518   Asm->EOL("Prolog Length");
2519   EmitLabel("line_prolog_begin", 0);
2520
2521   Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2522
2523   Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2524
2525   Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2526
2527   Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2528
2529   Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2530
2531   // Line number standard opcode encodings argument count
2532   Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2533   Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2534   Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2535   Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2536   Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2537   Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2538   Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2539   Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2540   Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2541
2542   // Emit directories.
2543   for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2544     Asm->EmitString(getSourceDirectoryName(DI));
2545     Asm->EOL("Directory");
2546   }
2547
2548   Asm->EmitInt8(0); Asm->EOL("End of directories");
2549
2550   // Emit files.
2551   for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2552     // Remember source id starts at 1.
2553     std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2554     Asm->EmitString(getSourceFileName(Id.second));
2555     Asm->EOL("Source");
2556     Asm->EmitULEB128Bytes(Id.first);
2557     Asm->EOL("Directory #");
2558     Asm->EmitULEB128Bytes(0);
2559     Asm->EOL("Mod date");
2560     Asm->EmitULEB128Bytes(0);
2561     Asm->EOL("File size");
2562   }
2563
2564   Asm->EmitInt8(0); Asm->EOL("End of files");
2565
2566   EmitLabel("line_prolog_end", 0);
2567
2568   // A sequence for each text section.
2569   unsigned SecSrcLinesSize = SectionSourceLines.size();
2570
2571   for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2572     // Isolate current sections line info.
2573     const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2574
2575     /*if (Asm->isVerbose()) {
2576       const MCSection *S = SectionMap[j + 1];
2577       O << '\t' << MAI->getCommentString() << " Section"
2578         << S->getName() << '\n';
2579     }*/
2580     Asm->EOL();
2581
2582     // Dwarf assumes we start with first line of first source file.
2583     unsigned Source = 1;
2584     unsigned Line = 1;
2585
2586     // Construct rows of the address, source, line, column matrix.
2587     for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2588       const SrcLineInfo &LineInfo = LineInfos[i];
2589       unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2590       if (!LabelID) continue;
2591
2592       if (LineInfo.getLine() == 0) continue;
2593
2594       if (!Asm->isVerbose())
2595         Asm->EOL();
2596       else {
2597         std::pair<unsigned, unsigned> SourceID =
2598           getSourceDirectoryAndFileIds(LineInfo.getSourceID());
2599         O << '\t' << MAI->getCommentString() << ' '
2600           << getSourceDirectoryName(SourceID.first) << ' '
2601           << getSourceFileName(SourceID.second)
2602           <<" :" << utostr_32(LineInfo.getLine()) << '\n';
2603       }
2604
2605       // Define the line address.
2606       Asm->EmitInt8(0); Asm->EOL("Extended Op");
2607       Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2608       Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2609       EmitReference("label",  LabelID); Asm->EOL("Location label");
2610
2611       // If change of source, then switch to the new source.
2612       if (Source != LineInfo.getSourceID()) {
2613         Source = LineInfo.getSourceID();
2614         Asm->EmitInt8(dwarf::DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2615         Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2616       }
2617
2618       // If change of line.
2619       if (Line != LineInfo.getLine()) {
2620         // Determine offset.
2621         int Offset = LineInfo.getLine() - Line;
2622         int Delta = Offset - MinLineDelta;
2623
2624         // Update line.
2625         Line = LineInfo.getLine();
2626
2627         // If delta is small enough and in range...
2628         if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2629           // ... then use fast opcode.
2630           Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2631         } else {
2632           // ... otherwise use long hand.
2633           Asm->EmitInt8(dwarf::DW_LNS_advance_line);
2634           Asm->EOL("DW_LNS_advance_line");
2635           Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2636           Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2637         }
2638       } else {
2639         // Copy the previous row (different address or source)
2640         Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2641       }
2642     }
2643
2644     EmitEndOfLineMatrix(j + 1);
2645   }
2646
2647   if (SecSrcLinesSize == 0)
2648     // Because we're emitting a debug_line section, we still need a line
2649     // table. The linker and friends expect it to exist. If there's nothing to
2650     // put into it, emit an empty table.
2651     EmitEndOfLineMatrix(1);
2652
2653   EmitLabel("line_end", 0);
2654   Asm->EOL();
2655 }
2656
2657 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2658 ///
2659 void DwarfDebug::EmitCommonDebugFrame() {
2660   if (!MAI->doesDwarfRequireFrameSection())
2661     return;
2662
2663   int stackGrowth =
2664     Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2665       TargetFrameInfo::StackGrowsUp ?
2666     TD->getPointerSize() : -TD->getPointerSize();
2667
2668   // Start the dwarf frame section.
2669   Asm->OutStreamer.SwitchSection(
2670                               Asm->getObjFileLowering().getDwarfFrameSection());
2671
2672   EmitLabel("debug_frame_common", 0);
2673   EmitDifference("debug_frame_common_end", 0,
2674                  "debug_frame_common_begin", 0, true);
2675   Asm->EOL("Length of Common Information Entry");
2676
2677   EmitLabel("debug_frame_common_begin", 0);
2678   Asm->EmitInt32((int)dwarf::DW_CIE_ID);
2679   Asm->EOL("CIE Identifier Tag");
2680   Asm->EmitInt8(dwarf::DW_CIE_VERSION);
2681   Asm->EOL("CIE Version");
2682   Asm->EmitString("");
2683   Asm->EOL("CIE Augmentation");
2684   Asm->EmitULEB128Bytes(1);
2685   Asm->EOL("CIE Code Alignment Factor");
2686   Asm->EmitSLEB128Bytes(stackGrowth);
2687   Asm->EOL("CIE Data Alignment Factor");
2688   Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2689   Asm->EOL("CIE RA Column");
2690
2691   std::vector<MachineMove> Moves;
2692   RI->getInitialFrameState(Moves);
2693
2694   EmitFrameMoves(NULL, 0, Moves, false);
2695
2696   Asm->EmitAlignment(2, 0, 0, false);
2697   EmitLabel("debug_frame_common_end", 0);
2698
2699   Asm->EOL();
2700 }
2701
2702 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2703 /// section.
2704 void
2705 DwarfDebug::EmitFunctionDebugFrame(const FunctionDebugFrameInfo&DebugFrameInfo){
2706   if (!MAI->doesDwarfRequireFrameSection())
2707     return;
2708
2709   // Start the dwarf frame section.
2710   Asm->OutStreamer.SwitchSection(
2711                               Asm->getObjFileLowering().getDwarfFrameSection());
2712
2713   EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2714                  "debug_frame_begin", DebugFrameInfo.Number, true);
2715   Asm->EOL("Length of Frame Information Entry");
2716
2717   EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2718
2719   EmitSectionOffset("debug_frame_common", "section_debug_frame",
2720                     0, 0, true, false);
2721   Asm->EOL("FDE CIE offset");
2722
2723   EmitReference("func_begin", DebugFrameInfo.Number);
2724   Asm->EOL("FDE initial location");
2725   EmitDifference("func_end", DebugFrameInfo.Number,
2726                  "func_begin", DebugFrameInfo.Number);
2727   Asm->EOL("FDE address range");
2728
2729   EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2730                  false);
2731
2732   Asm->EmitAlignment(2, 0, 0, false);
2733   EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2734
2735   Asm->EOL();
2736 }
2737
2738 void DwarfDebug::EmitDebugPubNamesPerCU(CompileUnit *Unit) {
2739   EmitDifference("pubnames_end", Unit->getID(),
2740                  "pubnames_begin", Unit->getID(), true);
2741   Asm->EOL("Length of Public Names Info");
2742
2743   EmitLabel("pubnames_begin", Unit->getID());
2744
2745   Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2746
2747   EmitSectionOffset("info_begin", "section_info",
2748                     Unit->getID(), 0, true, false);
2749   Asm->EOL("Offset of Compilation Unit Info");
2750
2751   EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
2752                  true);
2753   Asm->EOL("Compilation Unit Length");
2754
2755   StringMap<DIE*> &Globals = Unit->getGlobals();
2756   for (StringMap<DIE*>::const_iterator
2757          GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2758     const char *Name = GI->getKeyData();
2759     DIE * Entity = GI->second;
2760
2761     Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2762     Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2763   }
2764
2765   Asm->EmitInt32(0); Asm->EOL("End Mark");
2766   EmitLabel("pubnames_end", Unit->getID());
2767
2768   Asm->EOL();
2769 }
2770
2771 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2772 ///
2773 void DwarfDebug::EmitDebugPubNames() {
2774   // Start the dwarf pubnames section.
2775   Asm->OutStreamer.SwitchSection(
2776                           Asm->getObjFileLowering().getDwarfPubNamesSection());
2777
2778   EmitDebugPubNamesPerCU(ModuleCU);
2779 }
2780
2781 /// EmitDebugStr - Emit visible names into a debug str section.
2782 ///
2783 void DwarfDebug::EmitDebugStr() {
2784   // Check to see if it is worth the effort.
2785   if (!StringPool.empty()) {
2786     // Start the dwarf str section.
2787     Asm->OutStreamer.SwitchSection(
2788                                 Asm->getObjFileLowering().getDwarfStrSection());
2789
2790     // For each of strings in the string pool.
2791     for (unsigned StringID = 1, N = StringPool.size();
2792          StringID <= N; ++StringID) {
2793       // Emit a label for reference from debug information entries.
2794       EmitLabel("string", StringID);
2795
2796       // Emit the string itself.
2797       const std::string &String = StringPool[StringID];
2798       Asm->EmitString(String); Asm->EOL();
2799     }
2800
2801     Asm->EOL();
2802   }
2803 }
2804
2805 /// EmitDebugLoc - Emit visible names into a debug loc section.
2806 ///
2807 void DwarfDebug::EmitDebugLoc() {
2808   // Start the dwarf loc section.
2809   Asm->OutStreamer.SwitchSection(
2810                               Asm->getObjFileLowering().getDwarfLocSection());
2811   Asm->EOL();
2812 }
2813
2814 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2815 ///
2816 void DwarfDebug::EmitDebugARanges() {
2817   // Start the dwarf aranges section.
2818   Asm->OutStreamer.SwitchSection(
2819                           Asm->getObjFileLowering().getDwarfARangesSection());
2820
2821   // FIXME - Mock up
2822 #if 0
2823   CompileUnit *Unit = GetBaseCompileUnit();
2824
2825   // Don't include size of length
2826   Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2827
2828   Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2829
2830   EmitReference("info_begin", Unit->getID());
2831   Asm->EOL("Offset of Compilation Unit Info");
2832
2833   Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2834
2835   Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2836
2837   Asm->EmitInt16(0);  Asm->EOL("Pad (1)");
2838   Asm->EmitInt16(0);  Asm->EOL("Pad (2)");
2839
2840   // Range 1
2841   EmitReference("text_begin", 0); Asm->EOL("Address");
2842   EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2843
2844   Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2845   Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2846 #endif
2847
2848   Asm->EOL();
2849 }
2850
2851 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2852 ///
2853 void DwarfDebug::EmitDebugRanges() {
2854   // Start the dwarf ranges section.
2855   Asm->OutStreamer.SwitchSection(
2856                             Asm->getObjFileLowering().getDwarfRangesSection());
2857   Asm->EOL();
2858 }
2859
2860 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2861 ///
2862 void DwarfDebug::EmitDebugMacInfo() {
2863   if (const MCSection *LineInfo =
2864       Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
2865     // Start the dwarf macinfo section.
2866     Asm->OutStreamer.SwitchSection(LineInfo);
2867     Asm->EOL();
2868   }
2869 }
2870
2871 /// EmitDebugInlineInfo - Emit inline info using following format.
2872 /// Section Header:
2873 /// 1. length of section
2874 /// 2. Dwarf version number
2875 /// 3. address size.
2876 ///
2877 /// Entries (one "entry" for each function that was inlined):
2878 ///
2879 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
2880 ///   otherwise offset into __debug_str for regular function name.
2881 /// 2. offset into __debug_str section for regular function name.
2882 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
2883 /// instances for the function.
2884 ///
2885 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
2886 /// inlined instance; the die_offset points to the inlined_subroutine die in the
2887 /// __debug_info section, and the low_pc is the starting address for the
2888 /// inlining instance.
2889 void DwarfDebug::EmitDebugInlineInfo() {
2890   if (!MAI->doesDwarfUsesInlineInfoSection())
2891     return;
2892
2893   if (!ModuleCU)
2894     return;
2895
2896   Asm->OutStreamer.SwitchSection(
2897                         Asm->getObjFileLowering().getDwarfDebugInlineSection());
2898   Asm->EOL();
2899   EmitDifference("debug_inlined_end", 1,
2900                  "debug_inlined_begin", 1, true);
2901   Asm->EOL("Length of Debug Inlined Information Entry");
2902
2903   EmitLabel("debug_inlined_begin", 1);
2904
2905   Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2906   Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2907
2908   for (DenseMap<MDNode *, SmallVector<unsigned, 4> >::iterator
2909          I = InlineInfo.begin(), E = InlineInfo.end(); I != E; ++I) {
2910     MDNode *Node = I->first;
2911     SmallVector<unsigned, 4> &Labels = I->second;
2912     DISubprogram SP(Node);
2913     const char *LName = SP.getLinkageName();
2914     const char *Name = SP.getName();
2915
2916     if (!LName)
2917       Asm->EmitString(Name);
2918     else {
2919       // Skip special LLVM prefix that is used to inform the asm printer to not
2920       // emit usual symbol prefix before the symbol name. This happens for
2921       // Objective-C symbol names and symbol whose name is replaced using GCC's
2922       // __asm__ attribute.
2923       if (LName[0] == 1)
2924         LName = &LName[1];
2925       Asm->EmitString(LName);
2926     }
2927     Asm->EOL("MIPS linkage name");
2928
2929     Asm->EmitString(Name); Asm->EOL("Function name");
2930
2931     Asm->EmitULEB128Bytes(Labels.size()); Asm->EOL("Inline count");
2932
2933     for (SmallVector<unsigned, 4>::iterator LI = Labels.begin(),
2934            LE = Labels.end(); LI != LE; ++LI) {
2935       DIE *SP = ModuleCU->getDieMapSlotFor(Node);
2936       Asm->EmitInt32(SP->getOffset()); Asm->EOL("DIE offset");
2937
2938       if (TD->getPointerSize() == sizeof(int32_t))
2939         O << MAI->getData32bitsDirective();
2940       else
2941         O << MAI->getData64bitsDirective();
2942
2943       PrintLabelName("label", *LI); Asm->EOL("low_pc");
2944     }
2945   }
2946
2947   EmitLabel("debug_inlined_end", 1);
2948   Asm->EOL();
2949 }