lib/CodeGen/AsmPrinter/DwarfWriter.cpp

   1 //===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains support for writing dwarf info into asm files.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/CodeGen/DwarfWriter.h"
  15 #include "llvm/Module.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/Constants.h"
  18 #include "llvm/CodeGen/AsmPrinter.h"
  19 #include "llvm/CodeGen/MachineModuleInfo.h"
  20 #include "llvm/CodeGen/MachineFrameInfo.h"
  21 #include "llvm/CodeGen/MachineLocation.h"
  22 #include "llvm/Analysis/DebugInfo.h"
  23 #include "llvm/Support/Debug.h"
  24 #include "llvm/Support/Dwarf.h"
  25 #include "llvm/Support/CommandLine.h"
  26 #include "llvm/Support/DataTypes.h"
  27 #include "llvm/Support/Mangler.h"
  28 #include "llvm/Support/Timer.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include "llvm/System/Path.h"
  31 #include "llvm/Target/TargetAsmInfo.h"
  32 #include "llvm/Target/TargetRegisterInfo.h"
  33 #include "llvm/Target/TargetData.h"
  34 #include "llvm/Target/TargetFrameInfo.h"
  35 #include "llvm/Target/TargetInstrInfo.h"
  36 #include "llvm/Target/TargetMachine.h"
  37 #include "llvm/Target/TargetOptions.h"
  38 #include "llvm/ADT/DenseMap.h"
  39 #include "llvm/ADT/FoldingSet.h"
  40 #include "llvm/ADT/StringExtras.h"
  41 #include "llvm/ADT/StringMap.h"
  42 #include <ostream>
  43 #include <string>
  44 using namespace llvm;
  45 using namespace llvm::dwarf;
  46
  47 static RegisterPass<DwarfWriter>
  48 X("dwarfwriter", "DWARF Information Writer");
  49 char DwarfWriter::ID = 0;
  50
  51 static TimerGroup &getDwarfTimerGroup() {
  52   static TimerGroup DwarfTimerGroup("Dwarf Exception and Debugging");
  53   return DwarfTimerGroup;
  54 }
  55
  56 namespace llvm {
  57
  58 //===----------------------------------------------------------------------===//
  59
  60 /// Configuration values for initial hash set sizes (log2).
  61 ///
  62 static const unsigned InitDiesSetSize          = 9; // log2(512)
  63 static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
  64 static const unsigned InitValuesSetSize        = 9; // log2(512)
  65
  66 //===----------------------------------------------------------------------===//
  67 /// Forward declarations.
  68 ///
  69 class DIE;
  70 class DIEValue;
  71
  72 //===----------------------------------------------------------------------===//
  73 /// Utility routines.
  74 ///
  75 /// getGlobalVariable - Return either a direct or cast Global value.
  76 ///
  77 static GlobalVariable *getGlobalVariable(Value *V) {
  78   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
  79     return GV;
  80   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
  81     if (CE->getOpcode() == Instruction::BitCast) {
  82       return dyn_cast<GlobalVariable>(CE->getOperand(0));
  83     } else if (CE->getOpcode() == Instruction::GetElementPtr) {
  84       for (unsigned int i=1; i<CE->getNumOperands(); i++) {
  85         if (!CE->getOperand(i)->isNullValue())
  86           return NULL;
  87       }
  88       return dyn_cast<GlobalVariable>(CE->getOperand(0));
  89     }
  90   }
  91   return NULL;
  92 }
  93
  94 //===----------------------------------------------------------------------===//
  95 /// DWLabel - Labels are used to track locations in the assembler file.
  96 /// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
  97 /// where the tag is a category of label (Ex. location) and number is a value
  98 /// unique in that category.
  99 class DWLabel {
 100 public:
 101   /// Tag - Label category tag. Should always be a staticly declared C string.
 102   ///
 103   const char *Tag;
 104
 105   /// Number - Value to make label unique.
 106   ///
 107   unsigned    Number;
 108
 109   DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
 110
 111   void Profile(FoldingSetNodeID &ID) const {
 112     ID.AddString(Tag);
 113     ID.AddInteger(Number);
 114   }
 115
 116 #ifndef NDEBUG
 117   void print(std::ostream *O) const {
 118     if (O) print(*O);
 119   }
 120   void print(std::ostream &O) const {
 121     O << "." << Tag;
 122     if (Number) O << Number;
 123   }
 124 #endif
 125 };
 126
 127 //===----------------------------------------------------------------------===//
 128 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
 129 /// Dwarf abbreviation.
 130 class DIEAbbrevData {
 131   /// Attribute - Dwarf attribute code.
 132   ///
 133   unsigned Attribute;
 134
 135   /// Form - Dwarf form code.
 136   ///
 137   unsigned Form;
 138 public:
 139   DIEAbbrevData(unsigned A, unsigned F) : Attribute(A), Form(F) {}
 140
 141   // Accessors.
 142   unsigned getAttribute() const { return Attribute; }
 143   unsigned getForm()      const { return Form; }
 144
 145   /// Profile - Used to gather unique data for the abbreviation folding set.
 146   ///
 147   void Profile(FoldingSetNodeID &ID)const  {
 148     ID.AddInteger(Attribute);
 149     ID.AddInteger(Form);
 150   }
 151 };
 152
 153 //===----------------------------------------------------------------------===//
 154 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
 155 /// information object.
 156 class DIEAbbrev : public FoldingSetNode {
 157 private:
 158   /// Tag - Dwarf tag code.
 159   ///
 160   unsigned Tag;
 161
 162   /// Unique number for node.
 163   ///
 164   unsigned Number;
 165
 166   /// ChildrenFlag - Dwarf children flag.
 167   ///
 168   unsigned ChildrenFlag;
 169
 170   /// Data - Raw data bytes for abbreviation.
 171   ///
 172   SmallVector<DIEAbbrevData, 8> Data;
 173 public:
 174   DIEAbbrev(unsigned T, unsigned C) : Tag(T), ChildrenFlag(C), Data() {}
 175   virtual ~DIEAbbrev() {}
 176
 177   // Accessors.
 178   unsigned getTag()                           const { return Tag; }
 179   unsigned getNumber()                        const { return Number; }
 180   unsigned getChildrenFlag()                  const { return ChildrenFlag; }
 181   const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
 182   void setTag(unsigned T)                           { Tag = T; }
 183   void setChildrenFlag(unsigned CF)                 { ChildrenFlag = CF; }
 184   void setNumber(unsigned N)                        { Number = N; }
 185
 186   /// AddAttribute - Adds another set of attribute information to the
 187   /// abbreviation.
 188   void AddAttribute(unsigned Attribute, unsigned Form) {
 189     Data.push_back(DIEAbbrevData(Attribute, Form));
 190   }
 191
 192   /// AddFirstAttribute - Adds a set of attribute information to the front
 193   /// of the abbreviation.
 194   void AddFirstAttribute(unsigned Attribute, unsigned Form) {
 195     Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
 196   }
 197
 198   /// Profile - Used to gather unique data for the abbreviation folding set.
 199   ///
 200   void Profile(FoldingSetNodeID &ID) {
 201     ID.AddInteger(Tag);
 202     ID.AddInteger(ChildrenFlag);
 203
 204     // For each attribute description.
 205     for (unsigned i = 0, N = Data.size(); i < N; ++i)
 206       Data[i].Profile(ID);
 207   }
 208
 209   /// Emit - Print the abbreviation using the specified Dwarf writer.
 210   ///
 211   void Emit(const DwarfDebug &DD) const;
 212
 213 #ifndef NDEBUG
 214   void print(std::ostream *O) {
 215     if (O) print(*O);
 216   }
 217   void print(std::ostream &O);
 218   void dump();
 219 #endif
 220 };
 221
 222 //===----------------------------------------------------------------------===//
 223 /// DIE - A structured debug information entry.  Has an abbreviation which
 224 /// describes it's organization.
 225 class DIE : public FoldingSetNode {
 226 protected:
 227   /// Abbrev - Buffer for constructing abbreviation.
 228   ///
 229   DIEAbbrev Abbrev;
 230
 231   /// Offset - Offset in debug info section.
 232   ///
 233   unsigned Offset;
 234
 235   /// Size - Size of instance + children.
 236   ///
 237   unsigned Size;
 238
 239   /// Children DIEs.
 240   ///
 241   std::vector<DIE *> Children;
 242
 243   /// Attributes values.
 244   ///
 245   SmallVector<DIEValue*, 32> Values;
 246
 247 public:
 248   explicit DIE(unsigned Tag)
 249     : Abbrev(Tag, DW_CHILDREN_no), Offset(0), Size(0), Children(), Values() {}
 250   virtual ~DIE();
 251
 252   // Accessors.
 253   DIEAbbrev &getAbbrev()                           { return Abbrev; }
 254   unsigned   getAbbrevNumber()               const {
 255     return Abbrev.getNumber();
 256   }
 257   unsigned getTag()                          const { return Abbrev.getTag(); }
 258   unsigned getOffset()                       const { return Offset; }
 259   unsigned getSize()                         const { return Size; }
 260   const std::vector<DIE *> &getChildren()    const { return Children; }
 261   SmallVector<DIEValue*, 32> &getValues()       { return Values; }
 262   void setTag(unsigned Tag)                  { Abbrev.setTag(Tag); }
 263   void setOffset(unsigned O)                 { Offset = O; }
 264   void setSize(unsigned S)                   { Size = S; }
 265
 266   /// AddValue - Add a value and attributes to a DIE.
 267   ///
 268   void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
 269     Abbrev.AddAttribute(Attribute, Form);
 270     Values.push_back(Value);
 271   }
 272
 273   /// SiblingOffset - Return the offset of the debug information entry's
 274   /// sibling.
 275   unsigned SiblingOffset() const { return Offset + Size; }
 276
 277   /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
 278   ///
 279   void AddSiblingOffset();
 280
 281   /// AddChild - Add a child to the DIE.
 282   ///
 283   void AddChild(DIE *Child) {
 284     Abbrev.setChildrenFlag(DW_CHILDREN_yes);
 285     Children.push_back(Child);
 286   }
 287
 288   /// Detach - Detaches objects connected to it after copying.
 289   ///
 290   void Detach() {
 291     Children.clear();
 292   }
 293
 294   /// Profile - Used to gather unique data for the value folding set.
 295   ///
 296   void Profile(FoldingSetNodeID &ID) ;
 297
 298 #ifndef NDEBUG
 299   void print(std::ostream *O, unsigned IncIndent = 0) {
 300     if (O) print(*O, IncIndent);
 301   }
 302   void print(std::ostream &O, unsigned IncIndent = 0);
 303   void dump();
 304 #endif
 305 };
 306
 307 //===----------------------------------------------------------------------===//
 308 /// DIEValue - A debug information entry value.
 309 ///
 310 class DIEValue : public FoldingSetNode {
 311 public:
 312   enum {
 313     isInteger,
 314     isString,
 315     isLabel,
 316     isAsIsLabel,
 317     isSectionOffset,
 318     isDelta,
 319     isEntry,
 320     isBlock
 321   };
 322
 323   /// Type - Type of data stored in the value.
 324   ///
 325   unsigned Type;
 326
 327   explicit DIEValue(unsigned T) : Type(T) {}
 328   virtual ~DIEValue() {}
 329
 330   // Accessors
 331   unsigned getType()  const { return Type; }
 332
 333   // Implement isa/cast/dyncast.
 334   static bool classof(const DIEValue *) { return true; }
 335
 336   /// EmitValue - Emit value via the Dwarf writer.
 337   ///
 338   virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
 339
 340   /// SizeOf - Return the size of a value in bytes.
 341   ///
 342   virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
 343
 344   /// Profile - Used to gather unique data for the value folding set.
 345   ///
 346   virtual void Profile(FoldingSetNodeID &ID) = 0;
 347
 348 #ifndef NDEBUG
 349   void print(std::ostream *O) {
 350     if (O) print(*O);
 351   }
 352   virtual void print(std::ostream &O) = 0;
 353   void dump();
 354 #endif
 355 };
 356
 357 //===----------------------------------------------------------------------===//
 358 /// DWInteger - An integer value DIE.
 359 ///
 360 class DIEInteger : public DIEValue {
 361 private:
 362   uint64_t Integer;
 363
 364 public:
 365   explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
 366
 367   // Implement isa/cast/dyncast.
 368   static bool classof(const DIEInteger *) { return true; }
 369   static bool classof(const DIEValue *I)  { return I->Type == isInteger; }
 370
 371   /// BestForm - Choose the best form for integer.
 372   ///
 373   static unsigned BestForm(bool IsSigned, uint64_t Integer) {
 374     if (IsSigned) {
 375       if ((char)Integer == (signed)Integer)   return DW_FORM_data1;
 376       if ((short)Integer == (signed)Integer)  return DW_FORM_data2;
 377       if ((int)Integer == (signed)Integer)    return DW_FORM_data4;
 378     } else {
 379       if ((unsigned char)Integer == Integer)  return DW_FORM_data1;
 380       if ((unsigned short)Integer == Integer) return DW_FORM_data2;
 381       if ((unsigned int)Integer == Integer)   return DW_FORM_data4;
 382     }
 383     return DW_FORM_data8;
 384   }
 385
 386   /// EmitValue - Emit integer of appropriate size.
 387   ///
 388   virtual void EmitValue(DwarfDebug &DD, unsigned Form);
 389
 390   /// SizeOf - Determine size of integer value in bytes.
 391   ///
 392   virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
 393
 394   /// Profile - Used to gather unique data for the value folding set.
 395   ///
 396   static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
 397     ID.AddInteger(isInteger);
 398     ID.AddInteger(Integer);
 399   }
 400   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
 401
 402 #ifndef NDEBUG
 403   virtual void print(std::ostream &O) {
 404     O << "Int: " << (int64_t)Integer
 405       << "  0x" << std::hex << Integer << std::dec;
 406   }
 407 #endif
 408 };
 409
 410 //===----------------------------------------------------------------------===//
 411 /// DIEString - A string value DIE.
 412 ///
 413 class DIEString : public DIEValue {
 414   const std::string Str;
 415 public:
 416   explicit DIEString(const std::string &S) : DIEValue(isString), Str(S) {}
 417
 418   // Implement isa/cast/dyncast.
 419   static bool classof(const DIEString *) { return true; }
 420   static bool classof(const DIEValue *S) { return S->Type == isString; }
 421
 422   /// EmitValue - Emit string value.
 423   ///
 424   virtual void EmitValue(DwarfDebug &DD, unsigned Form);
 425
 426   /// SizeOf - Determine size of string value in bytes.
 427   ///
 428   virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
 429     return Str.size() + sizeof(char); // sizeof('\0');
 430   }
 431
 432   /// Profile - Used to gather unique data for the value folding set.
 433   ///
 434   static void Profile(FoldingSetNodeID &ID, const std::string &Str) {
 435     ID.AddInteger(isString);
 436     ID.AddString(Str);
 437   }
 438   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Str); }
 439
 440 #ifndef NDEBUG
 441   virtual void print(std::ostream &O) {
 442     O << "Str: \"" << Str << "\"";
 443   }
 444 #endif
 445 };
 446
 447 //===----------------------------------------------------------------------===//
 448 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
 449 //
 450 class DIEDwarfLabel : public DIEValue {
 451   const DWLabel Label;
 452 public:
 453   explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
 454
 455   // Implement isa/cast/dyncast.
 456   static bool classof(const DIEDwarfLabel *)  { return true; }
 457   static bool classof(const DIEValue *L) { return L->Type == isLabel; }
 458
 459   /// EmitValue - Emit label value.
 460   ///
 461   virtual void EmitValue(DwarfDebug &DD, unsigned Form);
 462
 463   /// SizeOf - Determine size of label value in bytes.
 464   ///
 465   virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
 466
 467   /// Profile - Used to gather unique data for the value folding set.
 468   ///
 469   static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
 470     ID.AddInteger(isLabel);
 471     Label.Profile(ID);
 472   }
 473   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
 474
 475 #ifndef NDEBUG
 476   virtual void print(std::ostream &O) {
 477     O << "Lbl: ";
 478     Label.print(O);
 479   }
 480 #endif
 481 };
 482
 483 //===----------------------------------------------------------------------===//
 484 /// DIEObjectLabel - A label to an object in code or data.
 485 //
 486 class DIEObjectLabel : public DIEValue {
 487   const std::string Label;
 488 public:
 489   explicit DIEObjectLabel(const std::string &L)
 490   : DIEValue(isAsIsLabel), Label(L) {}
 491
 492   // Implement isa/cast/dyncast.
 493   static bool classof(const DIEObjectLabel *) { return true; }
 494   static bool classof(const DIEValue *L)    { return L->Type == isAsIsLabel; }
 495
 496   /// EmitValue - Emit label value.
 497   ///
 498   virtual void EmitValue(DwarfDebug &DD, unsigned Form);
 499
 500   /// SizeOf - Determine size of label value in bytes.
 501   ///
 502   virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
 503
 504   /// Profile - Used to gather unique data for the value folding set.
 505   ///
 506   static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
 507     ID.AddInteger(isAsIsLabel);
 508     ID.AddString(Label);
 509   }
 510   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label.c_str()); }
 511
 512 #ifndef NDEBUG
 513   virtual void print(std::ostream &O) {
 514     O << "Obj: " << Label;
 515   }
 516 #endif
 517 };
 518
 519 //===----------------------------------------------------------------------===//
 520 /// DIESectionOffset - A section offset DIE.
 521 //
 522 class DIESectionOffset : public DIEValue {
 523   const DWLabel Label;
 524   const DWLabel Section;
 525   bool IsEH : 1;
 526   bool UseSet : 1;
 527 public:
 528   DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
 529                    bool isEH = false, bool useSet = true)
 530     : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
 531       IsEH(isEH), UseSet(useSet) {}
 532
 533   // Implement isa/cast/dyncast.
 534   static bool classof(const DIESectionOffset *)  { return true; }
 535   static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
 536
 537   /// EmitValue - Emit section offset.
 538   ///
 539   virtual void EmitValue(DwarfDebug &DD, unsigned Form);
 540
 541   /// SizeOf - Determine size of section offset value in bytes.
 542   ///
 543   virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
 544
 545   /// Profile - Used to gather unique data for the value folding set.
 546   ///
 547   static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
 548                                             const DWLabel &Section) {
 549     ID.AddInteger(isSectionOffset);
 550     Label.Profile(ID);
 551     Section.Profile(ID);
 552     // IsEH and UseSet are specific to the Label/Section that we will emit
 553     // the offset for; so Label/Section are enough for uniqueness.
 554   }
 555   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
 556
 557 #ifndef NDEBUG
 558   virtual void print(std::ostream &O) {
 559     O << "Off: ";
 560     Label.print(O);
 561     O << "-";
 562     Section.print(O);
 563     O << "-" << IsEH << "-" << UseSet;
 564   }
 565 #endif
 566 };
 567
 568 //===----------------------------------------------------------------------===//
 569 /// DIEDelta - A simple label difference DIE.
 570 ///
 571 class DIEDelta : public DIEValue {
 572   const DWLabel LabelHi;
 573   const DWLabel LabelLo;
 574 public:
 575   DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
 576     : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
 577
 578   // Implement isa/cast/dyncast.
 579   static bool classof(const DIEDelta *)  { return true; }
 580   static bool classof(const DIEValue *D) { return D->Type == isDelta; }
 581
 582   /// EmitValue - Emit delta value.
 583   ///
 584   virtual void EmitValue(DwarfDebug &DD, unsigned Form);
 585
 586   /// SizeOf - Determine size of delta value in bytes.
 587   ///
 588   virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
 589
 590   /// Profile - Used to gather unique data for the value folding set.
 591   ///
 592   static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
 593                                             const DWLabel &LabelLo) {
 594     ID.AddInteger(isDelta);
 595     LabelHi.Profile(ID);
 596     LabelLo.Profile(ID);
 597   }
 598   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
 599
 600 #ifndef NDEBUG
 601   virtual void print(std::ostream &O) {
 602     O << "Del: ";
 603     LabelHi.print(O);
 604     O << "-";
 605     LabelLo.print(O);
 606   }
 607 #endif
 608 };
 609
 610 //===----------------------------------------------------------------------===//
 611 /// DIEntry - A pointer to another debug information entry.  An instance of this
 612 /// class can also be used as a proxy for a debug information entry not yet
 613 /// defined (ie. types.)
 614 class DIEntry : public DIEValue {
 615   DIE *Entry;
 616 public:
 617   explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
 618
 619   void setEntry(DIE *E) { Entry = E; }
 620
 621   // Implement isa/cast/dyncast.
 622   static bool classof(const DIEntry *)   { return true; }
 623   static bool classof(const DIEValue *E) { return E->Type == isEntry; }
 624
 625   /// EmitValue - Emit debug information entry offset.
 626   ///
 627   virtual void EmitValue(DwarfDebug &DD, unsigned Form);
 628
 629   /// SizeOf - Determine size of debug information entry in bytes.
 630   ///
 631   virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
 632     return sizeof(int32_t);
 633   }
 634
 635   /// Profile - Used to gather unique data for the value folding set.
 636   ///
 637   static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
 638     ID.AddInteger(isEntry);
 639     ID.AddPointer(Entry);
 640   }
 641   virtual void Profile(FoldingSetNodeID &ID) {
 642     ID.AddInteger(isEntry);
 643
 644     if (Entry) {
 645       ID.AddPointer(Entry);
 646     } else {
 647       ID.AddPointer(this);
 648     }
 649   }
 650
 651 #ifndef NDEBUG
 652   virtual void print(std::ostream &O) {
 653     O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
 654   }
 655 #endif
 656 };
 657
 658 //===----------------------------------------------------------------------===//
 659 /// DIEBlock - A block of values.  Primarily used for location expressions.
 660 //
 661 class DIEBlock : public DIEValue, public DIE {
 662   unsigned Size;                // Size in bytes excluding size header.
 663 public:
 664   DIEBlock()
 665     : DIEValue(isBlock), DIE(0), Size(0) {}
 666   virtual ~DIEBlock() {}
 667
 668   // Implement isa/cast/dyncast.
 669   static bool classof(const DIEBlock *)  { return true; }
 670   static bool classof(const DIEValue *E) { return E->Type == isBlock; }
 671
 672   /// ComputeSize - calculate the size of the block.
 673   ///
 674   unsigned ComputeSize(DwarfDebug &DD);
 675
 676   /// BestForm - Choose the best form for data.
 677   ///
 678   unsigned BestForm() const {
 679     if ((unsigned char)Size == Size)  return DW_FORM_block1;
 680     if ((unsigned short)Size == Size) return DW_FORM_block2;
 681     if ((unsigned int)Size == Size)   return DW_FORM_block4;
 682     return DW_FORM_block;
 683   }
 684
 685   /// EmitValue - Emit block data.
 686   ///
 687   virtual void EmitValue(DwarfDebug &DD, unsigned Form);
 688
 689   /// SizeOf - Determine size of block data in bytes.
 690   ///
 691   virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
 692
 693   /// Profile - Used to gather unique data for the value folding set.
 694   ///
 695   virtual void Profile(FoldingSetNodeID &ID) {
 696     ID.AddInteger(isBlock);
 697     DIE::Profile(ID);
 698   }
 699
 700 #ifndef NDEBUG
 701   virtual void print(std::ostream &O) {
 702     O << "Blk: ";
 703     DIE::print(O, 5);
 704   }
 705 #endif
 706 };
 707
 708 //===----------------------------------------------------------------------===//
 709 /// CompileUnit - This dwarf writer support class manages information associate
 710 /// with a source file.
 711 class CompileUnit {
 712   /// ID - File identifier for source.
 713   ///
 714   unsigned ID;
 715
 716   /// Die - Compile unit debug information entry.
 717   ///
 718   DIE *Die;
 719
 720   /// GVToDieMap - Tracks the mapping of unit level debug informaton
 721   /// variables to debug information entries.
 722   std::map<GlobalVariable *, DIE *> GVToDieMap;
 723
 724   /// GVToDIEntryMap - Tracks the mapping of unit level debug informaton
 725   /// descriptors to debug information entries using a DIEntry proxy.
 726   std::map<GlobalVariable *, DIEntry *> GVToDIEntryMap;
 727
 728   /// Globals - A map of globally visible named entities for this unit.
 729   ///
 730   std::map<std::string, DIE *> Globals;
 731
 732   /// DiesSet - Used to uniquely define dies within the compile unit.
 733   ///
 734   FoldingSet<DIE> DiesSet;
 735 public:
 736   CompileUnit(unsigned I, DIE *D)
 737     : ID(I), Die(D), GVToDieMap(),
 738       GVToDIEntryMap(), Globals(), DiesSet(InitDiesSetSize)
 739   {}
 740
 741   ~CompileUnit() {
 742     delete Die;
 743   }
 744
 745   // Accessors.
 746   unsigned getID()           const { return ID; }
 747   DIE* getDie()              const { return Die; }
 748   std::map<std::string, DIE *> &getGlobals() { return Globals; }
 749
 750   /// hasContent - Return true if this compile unit has something to write out.
 751   ///
 752   bool hasContent() const {
 753     return !Die->getChildren().empty();
 754   }
 755
 756   /// AddGlobal - Add a new global entity to the compile unit.
 757   ///
 758   void AddGlobal(const std::string &Name, DIE *Die) {
 759     Globals[Name] = Die;
 760   }
 761
 762   /// getDieMapSlotFor - Returns the debug information entry map slot for the
 763   /// specified debug variable.
 764   DIE *&getDieMapSlotFor(GlobalVariable *GV) {
 765     return GVToDieMap[GV];
 766   }
 767
 768   /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
 769   /// specified debug variable.
 770   DIEntry *&getDIEntrySlotFor(GlobalVariable *GV) {
 771     return GVToDIEntryMap[GV];
 772   }
 773
 774   /// AddDie - Adds or interns the DIE to the compile unit.
 775   ///
 776   DIE *AddDie(DIE &Buffer) {
 777     FoldingSetNodeID ID;
 778     Buffer.Profile(ID);
 779     void *Where;
 780     DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
 781
 782     if (!Die) {
 783       Die = new DIE(Buffer);
 784       DiesSet.InsertNode(Die, Where);
 785       this->Die->AddChild(Die);
 786       Buffer.Detach();
 787     }
 788
 789     return Die;
 790   }
 791 };
 792
 793 //===----------------------------------------------------------------------===//
 794 /// Dwarf - Emits general Dwarf directives.
 795 ///
 796 class Dwarf {
 797 protected:
 798   //===--------------------------------------------------------------------===//
 799   // Core attributes used by the Dwarf writer.
 800   //
 801
 802   //
 803   /// O - Stream to .s file.
 804   ///
 805   raw_ostream &O;
 806
 807   /// Asm - Target of Dwarf emission.
 808   ///
 809   AsmPrinter *Asm;
 810
 811   /// TAI - Target asm information.
 812   const TargetAsmInfo *TAI;
 813
 814   /// TD - Target data.
 815   const TargetData *TD;
 816
 817   /// RI - Register Information.
 818   const TargetRegisterInfo *RI;
 819
 820   /// M - Current module.
 821   ///
 822   Module *M;
 823
 824   /// MF - Current machine function.
 825   ///
 826   MachineFunction *MF;
 827
 828   /// MMI - Collected machine module information.
 829   ///
 830   MachineModuleInfo *MMI;
 831
 832   /// SubprogramCount - The running count of functions being compiled.
 833   ///
 834   unsigned SubprogramCount;
 835
 836   /// Flavor - A unique string indicating what dwarf producer this is, used to
 837   /// unique labels.
 838   const char * const Flavor;
 839
 840   unsigned SetCounter;
 841   Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
 842         const char *flavor)
 843   : O(OS)
 844   , Asm(A)
 845   , TAI(T)
 846   , TD(Asm->TM.getTargetData())
 847   , RI(Asm->TM.getRegisterInfo())
 848   , M(NULL)
 849   , MF(NULL)
 850   , MMI(NULL)
 851   , SubprogramCount(0)
 852   , Flavor(flavor)
 853   , SetCounter(1)
 854   {
 855   }
 856
 857 public:
 858   //===--------------------------------------------------------------------===//
 859   // Accessors.
 860   //
 861   AsmPrinter *getAsm() const { return Asm; }
 862   MachineModuleInfo *getMMI() const { return MMI; }
 863   const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
 864   const TargetData *getTargetData() const { return TD; }
 865
 866   void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
 867                                                                          const {
 868     if (isInSection && TAI->getDwarfSectionOffsetDirective())
 869       O << TAI->getDwarfSectionOffsetDirective();
 870     else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
 871       O << TAI->getData32bitsDirective();
 872     else
 873       O << TAI->getData64bitsDirective();
 874   }
 875
 876   /// PrintLabelName - Print label name in form used by Dwarf writer.
 877   ///
 878   void PrintLabelName(DWLabel Label) const {
 879     PrintLabelName(Label.Tag, Label.Number);
 880   }
 881   void PrintLabelName(const char *Tag, unsigned Number) const {
 882     O << TAI->getPrivateGlobalPrefix() << Tag;
 883     if (Number) O << Number;
 884   }
 885
 886   void PrintLabelName(const char *Tag, unsigned Number,
 887                       const char *Suffix) const {
 888     O << TAI->getPrivateGlobalPrefix() << Tag;
 889     if (Number) O << Number;
 890     O << Suffix;
 891   }
 892
 893   /// EmitLabel - Emit location label for internal use by Dwarf.
 894   ///
 895   void EmitLabel(DWLabel Label) const {
 896     EmitLabel(Label.Tag, Label.Number);
 897   }
 898   void EmitLabel(const char *Tag, unsigned Number) const {
 899     PrintLabelName(Tag, Number);
 900     O << ":\n";
 901   }
 902
 903   /// EmitReference - Emit a reference to a label.
 904   ///
 905   void EmitReference(DWLabel Label, bool IsPCRelative = false,
 906                      bool Force32Bit = false) const {
 907     EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
 908   }
 909   void EmitReference(const char *Tag, unsigned Number,
 910                      bool IsPCRelative = false, bool Force32Bit = false) const {
 911     PrintRelDirective(Force32Bit);
 912     PrintLabelName(Tag, Number);
 913
 914     if (IsPCRelative) O << "-" << TAI->getPCSymbol();
 915   }
 916   void EmitReference(const std::string &Name, bool IsPCRelative = false,
 917                      bool Force32Bit = false) const {
 918     PrintRelDirective(Force32Bit);
 919
 920     O << Name;
 921
 922     if (IsPCRelative) O << "-" << TAI->getPCSymbol();
 923   }
 924
 925   /// EmitDifference - Emit the difference between two labels.  Some
 926   /// assemblers do not behave with absolute expressions with data directives,
 927   /// so there is an option (needsSet) to use an intermediary set expression.
 928   void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
 929                       bool IsSmall = false) {
 930     EmitDifference(LabelHi.Tag, LabelHi.Number,
 931                    LabelLo.Tag, LabelLo.Number,
 932                    IsSmall);
 933   }
 934   void EmitDifference(const char *TagHi, unsigned NumberHi,
 935                       const char *TagLo, unsigned NumberLo,
 936                       bool IsSmall = false) {
 937     if (TAI->needsSet()) {
 938       O << "\t.set\t";
 939       PrintLabelName("set", SetCounter, Flavor);
 940       O << ",";
 941       PrintLabelName(TagHi, NumberHi);
 942       O << "-";
 943       PrintLabelName(TagLo, NumberLo);
 944       O << "\n";
 945
 946       PrintRelDirective(IsSmall);
 947       PrintLabelName("set", SetCounter, Flavor);
 948       ++SetCounter;
 949     } else {
 950       PrintRelDirective(IsSmall);
 951
 952       PrintLabelName(TagHi, NumberHi);
 953       O << "-";
 954       PrintLabelName(TagLo, NumberLo);
 955     }
 956   }
 957
 958   void EmitSectionOffset(const char* Label, const char* Section,
 959                          unsigned LabelNumber, unsigned SectionNumber,
 960                          bool IsSmall = false, bool isEH = false,
 961                          bool useSet = true) {
 962     bool printAbsolute = false;
 963     if (isEH)
 964       printAbsolute = TAI->isAbsoluteEHSectionOffsets();
 965     else
 966       printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
 967
 968     if (TAI->needsSet() && useSet) {
 969       O << "\t.set\t";
 970       PrintLabelName("set", SetCounter, Flavor);
 971       O << ",";
 972       PrintLabelName(Label, LabelNumber);
 973
 974       if (!printAbsolute) {
 975         O << "-";
 976         PrintLabelName(Section, SectionNumber);
 977       }
 978       O << "\n";
 979
 980       PrintRelDirective(IsSmall);
 981
 982       PrintLabelName("set", SetCounter, Flavor);
 983       ++SetCounter;
 984     } else {
 985       PrintRelDirective(IsSmall, true);
 986
 987       PrintLabelName(Label, LabelNumber);
 988
 989       if (!printAbsolute) {
 990         O << "-";
 991         PrintLabelName(Section, SectionNumber);
 992       }
 993     }
 994   }
 995
 996   /// EmitFrameMoves - Emit frame instructions to describe the layout of the
 997   /// frame.
 998   void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
 999                       const std::vector<MachineMove> &Moves, bool isEH) {
1000     int stackGrowth =
1001         Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1002           TargetFrameInfo::StackGrowsUp ?
1003             TD->getPointerSize() : -TD->getPointerSize();
1004     bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1005
1006     for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1007       const MachineMove &Move = Moves[i];
1008       unsigned LabelID = Move.getLabelID();
1009
1010       if (LabelID) {
1011         LabelID = MMI->MappedLabel(LabelID);
1012
1013         // Throw out move if the label is invalid.
1014         if (!LabelID) continue;
1015       }
1016
1017       const MachineLocation &Dst = Move.getDestination();
1018       const MachineLocation &Src = Move.getSource();
1019
1020       // Advance row if new location.
1021       if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1022         Asm->EmitInt8(DW_CFA_advance_loc4);
1023         Asm->EOL("DW_CFA_advance_loc4");
1024         EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1025         Asm->EOL();
1026
1027         BaseLabelID = LabelID;
1028         BaseLabel = "label";
1029         IsLocal = true;
1030       }
1031
1032       // If advancing cfa.
1033       if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1034         if (!Src.isReg()) {
1035           if (Src.getReg() == MachineLocation::VirtualFP) {
1036             Asm->EmitInt8(DW_CFA_def_cfa_offset);
1037             Asm->EOL("DW_CFA_def_cfa_offset");
1038           } else {
1039             Asm->EmitInt8(DW_CFA_def_cfa);
1040             Asm->EOL("DW_CFA_def_cfa");
1041             Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
1042             Asm->EOL("Register");
1043           }
1044
1045           int Offset = -Src.getOffset();
1046
1047           Asm->EmitULEB128Bytes(Offset);
1048           Asm->EOL("Offset");
1049         } else {
1050           assert(0 && "Machine move no supported yet.");
1051         }
1052       } else if (Src.isReg() &&
1053         Src.getReg() == MachineLocation::VirtualFP) {
1054         if (Dst.isReg()) {
1055           Asm->EmitInt8(DW_CFA_def_cfa_register);
1056           Asm->EOL("DW_CFA_def_cfa_register");
1057           Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
1058           Asm->EOL("Register");
1059         } else {
1060           assert(0 && "Machine move no supported yet.");
1061         }
1062       } else {
1063         unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
1064         int Offset = Dst.getOffset() / stackGrowth;
1065
1066         if (Offset < 0) {
1067           Asm->EmitInt8(DW_CFA_offset_extended_sf);
1068           Asm->EOL("DW_CFA_offset_extended_sf");
1069           Asm->EmitULEB128Bytes(Reg);
1070           Asm->EOL("Reg");
1071           Asm->EmitSLEB128Bytes(Offset);
1072           Asm->EOL("Offset");
1073         } else if (Reg < 64) {
1074           Asm->EmitInt8(DW_CFA_offset + Reg);
1075           if (VerboseAsm)
1076             Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1077           else
1078             Asm->EOL();
1079           Asm->EmitULEB128Bytes(Offset);
1080           Asm->EOL("Offset");
1081         } else {
1082           Asm->EmitInt8(DW_CFA_offset_extended);
1083           Asm->EOL("DW_CFA_offset_extended");
1084           Asm->EmitULEB128Bytes(Reg);
1085           Asm->EOL("Reg");
1086           Asm->EmitULEB128Bytes(Offset);
1087           Asm->EOL("Offset");
1088         }
1089       }
1090     }
1091   }
1092
1093 };
1094
1095 //===----------------------------------------------------------------------===//
1096 /// SrcLineInfo - This class is used to record source line correspondence.
1097 ///
1098 class SrcLineInfo {
1099   unsigned Line;                        // Source line number.
1100   unsigned Column;                      // Source column.
1101   unsigned SourceID;                    // Source ID number.
1102   unsigned LabelID;                     // Label in code ID number.
1103 public:
1104   SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
1105     : Line(L), Column(C), SourceID(S), LabelID(I) {}
1106
1107   // Accessors
1108   unsigned getLine()     const { return Line; }
1109   unsigned getColumn()   const { return Column; }
1110   unsigned getSourceID() const { return SourceID; }
1111   unsigned getLabelID()  const { return LabelID; }
1112 };
1113
1114 //===----------------------------------------------------------------------===//
1115 /// DbgVariable - This class is used to track local variable information.
1116 ///
1117 class DbgVariable {
1118   DIVariable Var;                   // Variable Descriptor.
1119   unsigned FrameIndex;               // Variable frame index.
1120 public:
1121   DbgVariable(DIVariable V, unsigned I) : Var(V), FrameIndex(I)  {}
1122
1123   // Accessors.
1124   DIVariable getVariable()  const { return Var; }
1125   unsigned getFrameIndex() const { return FrameIndex; }
1126 };
1127
1128 //===----------------------------------------------------------------------===//
1129 /// DbgScope - This class is used to track scope information.
1130 ///
1131 class DbgScope {
1132   DbgScope *Parent;                   // Parent to this scope.
1133   DIDescriptor Desc;                  // Debug info descriptor for scope.
1134                                       // Either subprogram or block.
1135   unsigned StartLabelID;              // Label ID of the beginning of scope.
1136   unsigned EndLabelID;                // Label ID of the end of scope.
1137   SmallVector<DbgScope *, 4> Scopes;  // Scopes defined in scope.
1138   SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
1139 public:
1140   DbgScope(DbgScope *P, DIDescriptor D)
1141   : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), Scopes(), Variables()
1142   {}
1143   ~DbgScope() {
1144     for (unsigned i = 0, N = Scopes.size(); i < N; ++i) delete Scopes[i];
1145     for (unsigned j = 0, M = Variables.size(); j < M; ++j) delete Variables[j];
1146   }
1147
1148   // Accessors.
1149   DbgScope *getParent()          const { return Parent; }
1150   DIDescriptor getDesc()         const { return Desc; }
1151   unsigned getStartLabelID()     const { return StartLabelID; }
1152   unsigned getEndLabelID()       const { return EndLabelID; }
1153   SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
1154   SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
1155   void setStartLabelID(unsigned S) { StartLabelID = S; }
1156   void setEndLabelID(unsigned E)   { EndLabelID = E; }
1157
1158   /// AddScope - Add a scope to the scope.
1159   ///
1160   void AddScope(DbgScope *S) { Scopes.push_back(S); }
1161
1162   /// AddVariable - Add a variable to the scope.
1163   ///
1164   void AddVariable(DbgVariable *V) { Variables.push_back(V); }
1165 };
1166
1167 //===----------------------------------------------------------------------===//
1168 /// DwarfDebug - Emits Dwarf debug directives.
1169 ///
1170 class DwarfDebug : public Dwarf {
1171   //===--------------------------------------------------------------------===//
1172   // Attributes used to construct specific Dwarf sections.
1173   //
1174
1175   /// CompileUnitMap - A map of global variables representing compile units to
1176   /// compile units.
1177   DenseMap<Value *, CompileUnit *> CompileUnitMap;
1178
1179   /// CompileUnits - All the compile units in this module.
1180   ///
1181   SmallVector<CompileUnit *, 8> CompileUnits;
1182
1183   /// MainCU - Some platform prefers one compile unit per .o file. In such
1184   /// cases, all dies are inserted in MainCU.
1185   CompileUnit *MainCU;
1186
1187   /// AbbreviationsSet - Used to uniquely define abbreviations.
1188   ///
1189   FoldingSet<DIEAbbrev> AbbreviationsSet;
1190
1191   /// Abbreviations - A list of all the unique abbreviations in use.
1192   ///
1193   std::vector<DIEAbbrev *> Abbreviations;
1194
1195   /// DirectoryIdMap - Directory name to directory id map.
1196   ///
1197   StringMap<unsigned> DirectoryIdMap;
1198
1199   /// DirectoryNames - A list of directory names.
1200   SmallVector<std::string, 8> DirectoryNames;
1201
1202   /// SourceFileIdMap - Source file name to source file id map.
1203   ///
1204   StringMap<unsigned> SourceFileIdMap;
1205
1206   /// SourceFileNames - A list of source file names.
1207   SmallVector<std::string, 8> SourceFileNames;
1208
1209   /// SourceIdMap - Source id map, i.e. pair of directory id and source file
1210   /// id mapped to a unique id.
1211   DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap;
1212
1213   /// SourceIds - Reverse map from source id to directory id + file id pair.
1214   ///
1215   SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds;
1216
1217   /// Lines - List of of source line correspondence.
1218   std::vector<SrcLineInfo> Lines;
1219
1220   /// ValuesSet - Used to uniquely define values.
1221   ///
1222   FoldingSet<DIEValue> ValuesSet;
1223
1224   /// Values - A list of all the unique values in use.
1225   ///
1226   std::vector<DIEValue *> Values;
1227
1228   /// StringPool - A UniqueVector of strings used by indirect references.
1229   ///
1230   UniqueVector<std::string> StringPool;
1231
1232   /// SectionMap - Provides a unique id per text section.
1233   ///
1234   UniqueVector<const Section*> SectionMap;
1235
1236   /// SectionSourceLines - Tracks line numbers per text section.
1237   ///
1238   std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
1239
1240   /// didInitial - Flag to indicate if initial emission has been done.
1241   ///
1242   bool didInitial;
1243
1244   /// shouldEmit - Flag to indicate if debug information should be emitted.
1245   ///
1246   bool shouldEmit;
1247
1248   // RootDbgScope - Top level scope for the current function.
1249   //
1250   DbgScope *RootDbgScope;
1251
1252   /// DbgScopeMap - Tracks the scopes in the current function.
1253   DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
1254
1255   /// DebugTimer - Timer for the Dwarf debug writer.
1256   Timer *DebugTimer;
1257
1258   struct FunctionDebugFrameInfo {
1259     unsigned Number;
1260     std::vector<MachineMove> Moves;
1261
1262     FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
1263       Number(Num), Moves(M) { }
1264   };
1265
1266   std::vector<FunctionDebugFrameInfo> DebugFrames;
1267
1268 private:
1269   /// getSourceDirectoryAndFileIds - Return the directory and file ids that
1270   /// maps to the source id. Source id starts at 1.
1271   std::pair<unsigned, unsigned>
1272   getSourceDirectoryAndFileIds(unsigned SId) const {
1273     return SourceIds[SId-1];
1274   }
1275
1276   /// getNumSourceDirectories - Return the number of source directories in the
1277   /// debug info.
1278   unsigned getNumSourceDirectories() const {
1279     return DirectoryNames.size();
1280   }
1281
1282   /// getSourceDirectoryName - Return the name of the directory corresponding
1283   /// to the id.
1284   const std::string &getSourceDirectoryName(unsigned Id) const {
1285     return DirectoryNames[Id - 1];
1286   }
1287
1288   /// getSourceFileName - Return the name of the source file corresponding
1289   /// to the id.
1290   const std::string &getSourceFileName(unsigned Id) const {
1291     return SourceFileNames[Id - 1];
1292   }
1293
1294   /// getNumSourceIds - Return the number of unique source ids.
1295   unsigned getNumSourceIds() const {
1296     return SourceIds.size();
1297   }
1298
1299   /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1300   ///
1301   void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1302     // Profile the node so that we can make it unique.
1303     FoldingSetNodeID ID;
1304     Abbrev.Profile(ID);
1305
1306     // Check the set for priors.
1307     DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1308
1309     // If it's newly added.
1310     if (InSet == &Abbrev) {
1311       // Add to abbreviation list.
1312       Abbreviations.push_back(&Abbrev);
1313       // Assign the vector position + 1 as its number.
1314       Abbrev.setNumber(Abbreviations.size());
1315     } else {
1316       // Assign existing abbreviation number.
1317       Abbrev.setNumber(InSet->getNumber());
1318     }
1319   }
1320
1321   /// NewString - Add a string to the constant pool and returns a label.
1322   ///
1323   DWLabel NewString(const std::string &String) {
1324     unsigned StringID = StringPool.insert(String);
1325     return DWLabel("string", StringID);
1326   }
1327
1328   /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1329   /// entry.
1330   DIEntry *NewDIEntry(DIE *Entry = NULL) {
1331     DIEntry *Value;
1332
1333     if (Entry) {
1334       FoldingSetNodeID ID;
1335       DIEntry::Profile(ID, Entry);
1336       void *Where;
1337       Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1338
1339       if (Value) return Value;
1340
1341       Value = new DIEntry(Entry);
1342       ValuesSet.InsertNode(Value, Where);
1343     } else {
1344       Value = new DIEntry(Entry);
1345     }
1346
1347     Values.push_back(Value);
1348     return Value;
1349   }
1350
1351   /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1352   ///
1353   void SetDIEntry(DIEntry *Value, DIE *Entry) {
1354     Value->setEntry(Entry);
1355     // Add to values set if not already there.  If it is, we merely have a
1356     // duplicate in the values list (no harm.)
1357     ValuesSet.GetOrInsertNode(Value);
1358   }
1359
1360   /// AddUInt - Add an unsigned integer attribute data and value.
1361   ///
1362   void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1363     if (!Form) Form = DIEInteger::BestForm(false, Integer);
1364
1365     FoldingSetNodeID ID;
1366     DIEInteger::Profile(ID, Integer);
1367     void *Where;
1368     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1369     if (!Value) {
1370       Value = new DIEInteger(Integer);
1371       ValuesSet.InsertNode(Value, Where);
1372       Values.push_back(Value);
1373     }
1374
1375     Die->AddValue(Attribute, Form, Value);
1376   }
1377
1378   /// AddSInt - Add an signed integer attribute data and value.
1379   ///
1380   void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1381     if (!Form) Form = DIEInteger::BestForm(true, Integer);
1382
1383     FoldingSetNodeID ID;
1384     DIEInteger::Profile(ID, (uint64_t)Integer);
1385     void *Where;
1386     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1387     if (!Value) {
1388       Value = new DIEInteger(Integer);
1389       ValuesSet.InsertNode(Value, Where);
1390       Values.push_back(Value);
1391     }
1392
1393     Die->AddValue(Attribute, Form, Value);
1394   }
1395
1396   /// AddString - Add a string attribute data and value.
1397   ///
1398   void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1399                  const std::string &String) {
1400     FoldingSetNodeID ID;
1401     DIEString::Profile(ID, String);
1402     void *Where;
1403     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1404     if (!Value) {
1405       Value = new DIEString(String);
1406       ValuesSet.InsertNode(Value, Where);
1407       Values.push_back(Value);
1408     }
1409
1410     Die->AddValue(Attribute, Form, Value);
1411   }
1412
1413   /// AddLabel - Add a Dwarf label attribute data and value.
1414   ///
1415   void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1416                      const DWLabel &Label) {
1417     FoldingSetNodeID ID;
1418     DIEDwarfLabel::Profile(ID, Label);
1419     void *Where;
1420     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1421     if (!Value) {
1422       Value = new DIEDwarfLabel(Label);
1423       ValuesSet.InsertNode(Value, Where);
1424       Values.push_back(Value);
1425     }
1426
1427     Die->AddValue(Attribute, Form, Value);
1428   }
1429
1430   /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1431   ///
1432   void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1433                       const std::string &Label) {
1434     FoldingSetNodeID ID;
1435     DIEObjectLabel::Profile(ID, Label);
1436     void *Where;
1437     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1438     if (!Value) {
1439       Value = new DIEObjectLabel(Label);
1440       ValuesSet.InsertNode(Value, Where);
1441       Values.push_back(Value);
1442     }
1443
1444     Die->AddValue(Attribute, Form, Value);
1445   }
1446
1447   /// AddSectionOffset - Add a section offset label attribute data and value.
1448   ///
1449   void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1450                         const DWLabel &Label, const DWLabel &Section,
1451                         bool isEH = false, bool useSet = true) {
1452     FoldingSetNodeID ID;
1453     DIESectionOffset::Profile(ID, Label, Section);
1454     void *Where;
1455     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1456     if (!Value) {
1457       Value = new DIESectionOffset(Label, Section, isEH, useSet);
1458       ValuesSet.InsertNode(Value, Where);
1459       Values.push_back(Value);
1460     }
1461
1462     Die->AddValue(Attribute, Form, Value);
1463   }
1464
1465   /// AddDelta - Add a label delta attribute data and value.
1466   ///
1467   void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1468                           const DWLabel &Hi, const DWLabel &Lo) {
1469     FoldingSetNodeID ID;
1470     DIEDelta::Profile(ID, Hi, Lo);
1471     void *Where;
1472     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1473     if (!Value) {
1474       Value = new DIEDelta(Hi, Lo);
1475       ValuesSet.InsertNode(Value, Where);
1476       Values.push_back(Value);
1477     }
1478
1479     Die->AddValue(Attribute, Form, Value);
1480   }
1481
1482   /// AddDIEntry - Add a DIE attribute data and value.
1483   ///
1484   void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1485     Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1486   }
1487
1488   /// AddBlock - Add block data.
1489   ///
1490   void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1491     Block->ComputeSize(*this);
1492     FoldingSetNodeID ID;
1493     Block->Profile(ID);
1494     void *Where;
1495     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1496     if (!Value) {
1497       Value = Block;
1498       ValuesSet.InsertNode(Value, Where);
1499       Values.push_back(Value);
1500     } else {
1501       // Already exists, reuse the previous one.
1502       delete Block;
1503       Block = cast<DIEBlock>(Value);
1504     }
1505
1506     Die->AddValue(Attribute, Block->BestForm(), Value);
1507   }
1508
1509   /// AddSourceLine - Add location information to specified debug information
1510   /// entry.
1511   void AddSourceLine(DIE *Die, const DIVariable *V) {
1512     unsigned FileID = 0;
1513     unsigned Line = V->getLineNumber();
1514     CompileUnit *Unit = FindCompileUnit(V->getCompileUnit());
1515     FileID = Unit->getID();
1516     assert (FileID && "Invalid file id");
1517     AddUInt(Die, DW_AT_decl_file, 0, FileID);
1518     AddUInt(Die, DW_AT_decl_line, 0, Line);
1519   }
1520
1521   /// AddSourceLine - Add location information to specified debug information
1522   /// entry.
1523   void AddSourceLine(DIE *Die, const DIGlobal *G) {
1524     unsigned FileID = 0;
1525     unsigned Line = G->getLineNumber();
1526     CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1527     FileID = Unit->getID();
1528     assert (FileID && "Invalid file id");
1529     AddUInt(Die, DW_AT_decl_file, 0, FileID);
1530     AddUInt(Die, DW_AT_decl_line, 0, Line);
1531   }
1532
1533   void AddSourceLine(DIE *Die, const DIType *Ty) {
1534     unsigned FileID = 0;
1535     unsigned Line = Ty->getLineNumber();
1536     DICompileUnit CU = Ty->getCompileUnit();
1537     if (CU.isNull())
1538       return;
1539     CompileUnit *Unit = FindCompileUnit(CU);
1540     FileID = Unit->getID();
1541     assert (FileID && "Invalid file id");
1542     AddUInt(Die, DW_AT_decl_file, 0, FileID);
1543     AddUInt(Die, DW_AT_decl_line, 0, Line);
1544   }
1545
1546   /// AddAddress - Add an address attribute to a die based on the location
1547   /// provided.
1548   void AddAddress(DIE *Die, unsigned Attribute,
1549                             const MachineLocation &Location) {
1550     unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
1551     DIEBlock *Block = new DIEBlock();
1552
1553     if (Location.isReg()) {
1554       if (Reg < 32) {
1555         AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1556       } else {
1557         AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1558         AddUInt(Block, 0, DW_FORM_udata, Reg);
1559       }
1560     } else {
1561       if (Reg < 32) {
1562         AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1563       } else {
1564         AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1565         AddUInt(Block, 0, DW_FORM_udata, Reg);
1566       }
1567       AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1568     }
1569
1570     AddBlock(Die, Attribute, 0, Block);
1571   }
1572
1573   /// AddType - Add a new type attribute to the specified entity.
1574   void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
1575     if (Ty.isNull())
1576       return;
1577
1578     // Check for pre-existence.
1579     DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1580     // If it exists then use the existing value.
1581     if (Slot) {
1582       Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1583       return;
1584     }
1585
1586     // Set up proxy.
1587     Slot = NewDIEntry();
1588
1589     // Construct type.
1590     DIE Buffer(DW_TAG_base_type);
1591     if (Ty.isBasicType(Ty.getTag()))
1592       ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getGV()));
1593     else if (Ty.isDerivedType(Ty.getTag()))
1594       ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getGV()));
1595     else {
1596       assert(Ty.isCompositeType(Ty.getTag()) && "Unknown kind of DIType");
1597       ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getGV()));
1598     }
1599
1600     // Add debug information entry to entity and appropriate context.
1601     DIE *Die = NULL;
1602     DIDescriptor Context = Ty.getContext();
1603     if (!Context.isNull())
1604       Die = DW_Unit->getDieMapSlotFor(Context.getGV());
1605
1606     if (Die) {
1607       DIE *Child = new DIE(Buffer);
1608       Die->AddChild(Child);
1609       Buffer.Detach();
1610       SetDIEntry(Slot, Child);
1611     } else {
1612       Die = DW_Unit->AddDie(Buffer);
1613       SetDIEntry(Slot, Die);
1614     }
1615
1616     Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1617   }
1618
1619   /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1620   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1621                         DIBasicType BTy) {
1622     // Get core information.
1623     const char *Name = BTy.getName();
1624     Buffer.setTag(DW_TAG_base_type);
1625     AddUInt(&Buffer, DW_AT_encoding,  DW_FORM_data1, BTy.getEncoding());
1626     // Add name if not anonymous or intermediate type.
1627     if (Name)
1628       AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1629     uint64_t Size = BTy.getSizeInBits() >> 3;
1630     AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1631   }
1632
1633   /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1634   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1635                         DIDerivedType DTy) {
1636     // Get core information.
1637     const char *Name = DTy.getName();
1638     uint64_t Size = DTy.getSizeInBits() >> 3;
1639     unsigned Tag = DTy.getTag();
1640
1641     // FIXME - Workaround for templates.
1642     if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1643
1644     Buffer.setTag(Tag);
1645
1646     // Map to main type, void will not have a type.
1647     DIType FromTy = DTy.getTypeDerivedFrom();
1648     AddType(DW_Unit, &Buffer, FromTy);
1649
1650     // Add name if not anonymous or intermediate type.
1651     if (Name)
1652       AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1653
1654     // Add size if non-zero (derived types might be zero-sized.)
1655     if (Size)
1656       AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1657
1658     // Add source line info if available and TyDesc is not a forward
1659     // declaration.
1660     if (!DTy.isForwardDecl())
1661       AddSourceLine(&Buffer, &DTy);
1662   }
1663
1664   /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1665   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1666                         DICompositeType CTy) {
1667     // Get core information.
1668     const char *Name = CTy.getName();
1669
1670     uint64_t Size = CTy.getSizeInBits() >> 3;
1671     unsigned Tag = CTy.getTag();
1672     Buffer.setTag(Tag);
1673
1674     switch (Tag) {
1675     case DW_TAG_vector_type:
1676     case DW_TAG_array_type:
1677       ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
1678       break;
1679     case DW_TAG_enumeration_type:
1680       {
1681         DIArray Elements = CTy.getTypeArray();
1682         // Add enumerators to enumeration type.
1683         for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1684           DIE *ElemDie = NULL;
1685           DIEnumerator Enum(Elements.getElement(i).getGV());
1686           ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
1687           Buffer.AddChild(ElemDie);
1688         }
1689       }
1690       break;
1691     case DW_TAG_subroutine_type:
1692       {
1693         // Add prototype flag.
1694         AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1695         DIArray Elements = CTy.getTypeArray();
1696         // Add return type.
1697         DIDescriptor RTy = Elements.getElement(0);
1698         AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
1699
1700         // Add arguments.
1701         for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1702           DIE *Arg = new DIE(DW_TAG_formal_parameter);
1703           DIDescriptor Ty = Elements.getElement(i);
1704           AddType(DW_Unit, Arg, DIType(Ty.getGV()));
1705           Buffer.AddChild(Arg);
1706         }
1707       }
1708       break;
1709     case DW_TAG_structure_type:
1710     case DW_TAG_union_type:
1711       {
1712         // Add elements to structure type.
1713         DIArray Elements = CTy.getTypeArray();
1714
1715         // A forward struct declared type may not have elements available.
1716         if (Elements.isNull())
1717           break;
1718
1719         // Add elements to structure type.
1720         for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1721           DIDescriptor Element = Elements.getElement(i);
1722           DIE *ElemDie = NULL;
1723           if (Element.getTag() == dwarf::DW_TAG_subprogram)
1724             ElemDie = CreateSubprogramDIE(DW_Unit,
1725                                           DISubprogram(Element.getGV()));
1726           else if (Element.getTag() == dwarf::DW_TAG_variable) // ???
1727             ElemDie = CreateGlobalVariableDIE(DW_Unit,
1728                                               DIGlobalVariable(Element.getGV()));
1729           else
1730             ElemDie = CreateMemberDIE(DW_Unit,
1731                                       DIDerivedType(Element.getGV()));
1732           Buffer.AddChild(ElemDie);
1733         }
1734         unsigned RLang = CTy.getRunTimeLang();
1735         if (RLang)
1736           AddUInt(&Buffer, DW_AT_APPLE_runtime_class, DW_FORM_data1, RLang);
1737       }
1738       break;
1739     default:
1740       break;
1741     }
1742
1743     // Add name if not anonymous or intermediate type.
1744     if (Name)
1745       AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1746
1747     if (Tag == DW_TAG_enumeration_type || Tag == DW_TAG_structure_type
1748         || Tag == DW_TAG_union_type) {
1749       // Add size if non-zero (derived types might be zero-sized.)
1750       if (Size)
1751         AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1752       else {
1753         // Add zero size if it is not a forward declaration.
1754         if (CTy.isForwardDecl())
1755           AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1756         else
1757           AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1758       }
1759
1760       // Add source line info if available.
1761       if (!CTy.isForwardDecl())
1762         AddSourceLine(&Buffer, &CTy);
1763     }
1764   }
1765
1766   /// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1767   void ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy) {
1768     int64_t L = SR.getLo();
1769     int64_t H = SR.getHi();
1770     DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1771     if (L != H) {
1772       AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1773       if (L)
1774         AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1775       AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1776     }
1777     Buffer.AddChild(DW_Subrange);
1778   }
1779
1780   /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1781   void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1782                              DICompositeType *CTy) {
1783     Buffer.setTag(DW_TAG_array_type);
1784     if (CTy->getTag() == DW_TAG_vector_type)
1785       AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1786
1787     // Emit derived type.
1788     AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1789     DIArray Elements = CTy->getTypeArray();
1790
1791     // Construct an anonymous type for index type.
1792     DIE IdxBuffer(DW_TAG_base_type);
1793     AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1794     AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1795     DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1796
1797     // Add subranges to array type.
1798     for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1799       DIDescriptor Element = Elements.getElement(i);
1800       if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1801         ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
1802     }
1803   }
1804
1805   /// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
1806   DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
1807
1808     DIE *Enumerator = new DIE(DW_TAG_enumerator);
1809     const char *Name = ETy->getName();
1810     AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1811     int64_t Value = ETy->getEnumValue();
1812     AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1813     return Enumerator;
1814   }
1815
1816   /// CreateGlobalVariableDIE - Create new DIE using GV.
1817   DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit, const DIGlobalVariable &GV)
1818   {
1819     DIE *GVDie = new DIE(DW_TAG_variable);
1820     const char *Name = GV.getDisplayName();
1821     AddString(GVDie, DW_AT_name, DW_FORM_string, Name);
1822     const char *LinkageName = GV.getLinkageName();
1823     if (LinkageName)
1824       AddString(GVDie, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1825     AddType(DW_Unit, GVDie, GV.getType());
1826     if (!GV.isLocalToUnit())
1827       AddUInt(GVDie, DW_AT_external, DW_FORM_flag, 1);
1828     AddSourceLine(GVDie, &GV);
1829     return GVDie;
1830   }
1831
1832   /// CreateMemberDIE - Create new member DIE.
1833   DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT) {
1834     DIE *MemberDie = new DIE(DT.getTag());
1835     const char *Name = DT.getName();
1836     if (Name)
1837       AddString(MemberDie, DW_AT_name, DW_FORM_string, Name);
1838
1839     AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom());
1840
1841     AddSourceLine(MemberDie, &DT);
1842
1843     uint64_t Size = DT.getSizeInBits();
1844     uint64_t FieldSize = DT.getOriginalTypeSize();
1845
1846     if (Size != FieldSize) {
1847       // Handle bitfield.
1848       AddUInt(MemberDie, DW_AT_byte_size, 0, DT.getOriginalTypeSize() >> 3);
1849       AddUInt(MemberDie, DW_AT_bit_size, 0, DT.getSizeInBits());
1850
1851       uint64_t Offset = DT.getOffsetInBits();
1852       uint64_t FieldOffset = Offset;
1853       uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1854       uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1855       FieldOffset = (HiMark - FieldSize);
1856       Offset -= FieldOffset;
1857       // Maybe we need to work from the other end.
1858       if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1859       AddUInt(MemberDie, DW_AT_bit_offset, 0, Offset);
1860     }
1861     DIEBlock *Block = new DIEBlock();
1862     AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1863     AddUInt(Block, 0, DW_FORM_udata, DT.getOffsetInBits() >> 3);
1864     AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1865
1866     if (DT.isProtected())
1867       AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_protected);
1868     else if (DT.isPrivate())
1869       AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_private);
1870
1871     return MemberDie;
1872   }
1873
1874   /// CreateSubprogramDIE - Create new DIE using SP.
1875   DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
1876                            const  DISubprogram &SP,
1877                            bool IsConstructor = false) {
1878     DIE *SPDie = new DIE(DW_TAG_subprogram);
1879     const char *Name = SP.getName();
1880     AddString(SPDie, DW_AT_name, DW_FORM_string, Name);
1881     const char *LinkageName = SP.getLinkageName();
1882     if (LinkageName)
1883       AddString(SPDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1884                 LinkageName);
1885     AddSourceLine(SPDie, &SP);
1886
1887     DICompositeType SPTy = SP.getType();
1888     DIArray Args = SPTy.getTypeArray();
1889
1890     // Add Return Type.
1891     if (!IsConstructor) {
1892       if (Args.isNull())
1893         AddType(DW_Unit, SPDie, SPTy);
1894       else
1895         AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getGV()));
1896     }
1897
1898     if (!SP.isDefinition()) {
1899       AddUInt(SPDie, DW_AT_declaration, DW_FORM_flag, 1);
1900       // Add arguments.
1901       // Do not add arguments for subprogram definition. They will be
1902       // handled through RecordVariable.
1903       if (!Args.isNull())
1904         for (unsigned i = 1, N =  Args.getNumElements(); i < N; ++i) {
1905           DIE *Arg = new DIE(DW_TAG_formal_parameter);
1906           AddType(DW_Unit, Arg, DIType(Args.getElement(i).getGV()));
1907           AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1908           SPDie->AddChild(Arg);
1909         }
1910     }
1911
1912     unsigned Lang = SP.getCompileUnit().getLanguage();
1913     if (Lang == DW_LANG_C99 || Lang == DW_LANG_C89
1914         || Lang == DW_LANG_ObjC)
1915       AddUInt(SPDie, DW_AT_prototyped, DW_FORM_flag, 1);
1916
1917     if (!SP.isLocalToUnit())
1918       AddUInt(SPDie, DW_AT_external, DW_FORM_flag, 1);
1919     return SPDie;
1920   }
1921
1922   /// FindCompileUnit - Get the compile unit for the given descriptor.
1923   ///
1924   CompileUnit *FindCompileUnit(DICompileUnit Unit) {
1925     CompileUnit *DW_Unit = CompileUnitMap[Unit.getGV()];
1926     assert(DW_Unit && "Missing compile unit.");
1927     return DW_Unit;
1928   }
1929
1930   /// NewDbgScopeVariable - Create a new scope variable.
1931   ///
1932   DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
1933     // Get the descriptor.
1934     const DIVariable &VD = DV->getVariable();
1935
1936     // Translate tag to proper Dwarf tag.  The result variable is dropped for
1937     // now.
1938     unsigned Tag;
1939     switch (VD.getTag()) {
1940     case DW_TAG_return_variable:  return NULL;
1941     case DW_TAG_arg_variable:     Tag = DW_TAG_formal_parameter; break;
1942     case DW_TAG_auto_variable:    // fall thru
1943     default:                      Tag = DW_TAG_variable; break;
1944     }
1945
1946     // Define variable debug information entry.
1947     DIE *VariableDie = new DIE(Tag);
1948     const char *Name = VD.getName();
1949     AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
1950
1951     // Add source line info if available.
1952     AddSourceLine(VariableDie, &VD);
1953
1954     // Add variable type.
1955     AddType(Unit, VariableDie, VD.getType());
1956
1957     // Add variable address.
1958     MachineLocation Location;
1959     Location.set(RI->getFrameRegister(*MF),
1960                  RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1961     AddAddress(VariableDie, DW_AT_location, Location);
1962
1963     return VariableDie;
1964   }
1965
1966   /// getOrCreateScope - Returns the scope associated with the given descriptor.
1967   ///
1968   DbgScope *getOrCreateScope(GlobalVariable *V) {
1969     DbgScope *&Slot = DbgScopeMap[V];
1970     if (Slot) return Slot;
1971
1972     // FIXME - breaks down when the context is an inlined function.
1973     DIDescriptor ParentDesc;
1974     DIDescriptor Desc(V);
1975
1976     if (Desc.getTag() == dwarf::DW_TAG_lexical_block) {
1977       DIBlock Block(V);
1978       ParentDesc = Block.getContext();
1979     }
1980
1981     DbgScope *Parent = ParentDesc.isNull() ?
1982       NULL : getOrCreateScope(ParentDesc.getGV());
1983     Slot = new DbgScope(Parent, Desc);
1984
1985     if (Parent) {
1986       Parent->AddScope(Slot);
1987     } else if (RootDbgScope) {
1988       // FIXME - Add inlined function scopes to the root so we can delete them
1989       // later.  Long term, handle inlined functions properly.
1990       RootDbgScope->AddScope(Slot);
1991     } else {
1992       // First function is top level function.
1993       RootDbgScope = Slot;
1994     }
1995
1996     return Slot;
1997   }
1998
1999   /// ConstructDbgScope - Construct the components of a scope.
2000   ///
2001   void ConstructDbgScope(DbgScope *ParentScope,
2002                          unsigned ParentStartID, unsigned ParentEndID,
2003                          DIE *ParentDie, CompileUnit *Unit) {
2004     // Add variables to scope.
2005     SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
2006     for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2007       DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2008       if (VariableDie) ParentDie->AddChild(VariableDie);
2009     }
2010
2011     // Add nested scopes.
2012     SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
2013     for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2014       // Define the Scope debug information entry.
2015       DbgScope *Scope = Scopes[j];
2016       // FIXME - Ignore inlined functions for the time being.
2017       if (!Scope->getParent()) continue;
2018
2019       unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2020       unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2021
2022       // Ignore empty scopes.
2023       if (StartID == EndID && StartID != 0) continue;
2024       if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2025
2026       if (StartID == ParentStartID && EndID == ParentEndID) {
2027         // Just add stuff to the parent scope.
2028         ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2029       } else {
2030         DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2031
2032         // Add the scope bounds.
2033         if (StartID) {
2034           AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2035                              DWLabel("label", StartID));
2036         } else {
2037           AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2038                              DWLabel("func_begin", SubprogramCount));
2039         }
2040         if (EndID) {
2041           AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2042                              DWLabel("label", EndID));
2043         } else {
2044           AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2045                              DWLabel("func_end", SubprogramCount));
2046         }
2047
2048         // Add the scope contents.
2049         ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2050         ParentDie->AddChild(ScopeDie);
2051       }
2052     }
2053   }
2054
2055   /// ConstructRootDbgScope - Construct the scope for the subprogram.
2056   ///
2057   void ConstructRootDbgScope(DbgScope *RootScope) {
2058     // Exit if there is no root scope.
2059     if (!RootScope) return;
2060     DIDescriptor Desc = RootScope->getDesc();
2061     if (Desc.isNull())
2062       return;
2063
2064     // Get the subprogram debug information entry.
2065     DISubprogram SPD(Desc.getGV());
2066
2067     // Get the compile unit context.
2068     CompileUnit *Unit = MainCU;
2069     if (!Unit)
2070       Unit = FindCompileUnit(SPD.getCompileUnit());
2071
2072     // Get the subprogram die.
2073     DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2074     assert(SPDie && "Missing subprogram descriptor");
2075
2076     // Add the function bounds.
2077     AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2078                     DWLabel("func_begin", SubprogramCount));
2079     AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2080                     DWLabel("func_end", SubprogramCount));
2081     MachineLocation Location(RI->getFrameRegister(*MF));
2082     AddAddress(SPDie, DW_AT_frame_base, Location);
2083
2084     ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2085   }
2086
2087   /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2088   ///
2089   void ConstructDefaultDbgScope(MachineFunction *MF) {
2090     const char *FnName = MF->getFunction()->getNameStart();
2091     if (MainCU) {
2092       std::map<std::string, DIE*> &Globals = MainCU->getGlobals();
2093       std::map<std::string, DIE*>::iterator GI = Globals.find(FnName);
2094       if (GI != Globals.end()) {
2095         DIE *SPDie = GI->second;
2096
2097         // Add the function bounds.
2098         AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2099                  DWLabel("func_begin", SubprogramCount));
2100         AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2101                  DWLabel("func_end", SubprogramCount));
2102
2103         MachineLocation Location(RI->getFrameRegister(*MF));
2104         AddAddress(SPDie, DW_AT_frame_base, Location);
2105         return;
2106       }
2107     } else {
2108       for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i) {
2109         CompileUnit *Unit = CompileUnits[i];
2110         std::map<std::string, DIE*> &Globals = Unit->getGlobals();
2111         std::map<std::string, DIE*>::iterator GI = Globals.find(FnName);
2112         if (GI != Globals.end()) {
2113           DIE *SPDie = GI->second;
2114
2115           // Add the function bounds.
2116           AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2117                    DWLabel("func_begin", SubprogramCount));
2118           AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2119                    DWLabel("func_end", SubprogramCount));
2120
2121           MachineLocation Location(RI->getFrameRegister(*MF));
2122           AddAddress(SPDie, DW_AT_frame_base, Location);
2123           return;
2124         }
2125       }
2126     }
2127
2128 #if 0
2129     // FIXME: This is causing an abort because C++ mangled names are compared
2130     // with their unmangled counterparts. See PR2885. Don't do this assert.
2131     assert(0 && "Couldn't find DIE for machine function!");
2132 #endif
2133     return;
2134   }
2135
2136   /// EmitInitial - Emit initial Dwarf declarations.  This is necessary for cc
2137   /// tools to recognize the object file contains Dwarf information.
2138   void EmitInitial() {
2139     // Check to see if we already emitted intial headers.
2140     if (didInitial) return;
2141     didInitial = true;
2142
2143     // Dwarf sections base addresses.
2144     if (TAI->doesDwarfRequireFrameSection()) {
2145       Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2146       EmitLabel("section_debug_frame", 0);
2147     }
2148     Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2149     EmitLabel("section_info", 0);
2150     Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2151     EmitLabel("section_abbrev", 0);
2152     Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2153     EmitLabel("section_aranges", 0);
2154     if (TAI->doesSupportMacInfoSection()) {
2155       Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2156       EmitLabel("section_macinfo", 0);
2157     }
2158     Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2159     EmitLabel("section_line", 0);
2160     Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2161     EmitLabel("section_loc", 0);
2162     Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2163     EmitLabel("section_pubnames", 0);
2164     Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2165     EmitLabel("section_str", 0);
2166     Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2167     EmitLabel("section_ranges", 0);
2168
2169     Asm->SwitchToSection(TAI->getTextSection());
2170     EmitLabel("text_begin", 0);
2171     Asm->SwitchToSection(TAI->getDataSection());
2172     EmitLabel("data_begin", 0);
2173   }
2174
2175   /// EmitDIE - Recusively Emits a debug information entry.
2176   ///
2177   void EmitDIE(DIE *Die) {
2178     // Get the abbreviation for this DIE.
2179     unsigned AbbrevNumber = Die->getAbbrevNumber();
2180     const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2181
2182     Asm->EOL();
2183
2184     // Emit the code (index) for the abbreviation.
2185     Asm->EmitULEB128Bytes(AbbrevNumber);
2186
2187     if (VerboseAsm)
2188       Asm->EOL(std::string("Abbrev [" +
2189                            utostr(AbbrevNumber) +
2190                            "] 0x" + utohexstr(Die->getOffset()) +
2191                            ":0x" + utohexstr(Die->getSize()) + " " +
2192                            TagString(Abbrev->getTag())));
2193     else
2194       Asm->EOL();
2195
2196     SmallVector<DIEValue*, 32> &Values = Die->getValues();
2197     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2198
2199     // Emit the DIE attribute values.
2200     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2201       unsigned Attr = AbbrevData[i].getAttribute();
2202       unsigned Form = AbbrevData[i].getForm();
2203       assert(Form && "Too many attributes for DIE (check abbreviation)");
2204
2205       switch (Attr) {
2206       case DW_AT_sibling: {
2207         Asm->EmitInt32(Die->SiblingOffset());
2208         break;
2209       }
2210       default: {
2211         // Emit an attribute using the defined form.
2212         Values[i]->EmitValue(*this, Form);
2213         break;
2214       }
2215       }
2216
2217       Asm->EOL(AttributeString(Attr));
2218     }
2219
2220     // Emit the DIE children if any.
2221     if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2222       const std::vector<DIE *> &Children = Die->getChildren();
2223
2224       for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2225         EmitDIE(Children[j]);
2226       }
2227
2228       Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2229     }
2230   }
2231
2232   /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2233   ///
2234   unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2235     // Get the children.
2236     const std::vector<DIE *> &Children = Die->getChildren();
2237
2238     // If not last sibling and has children then add sibling offset attribute.
2239     if (!Last && !Children.empty()) Die->AddSiblingOffset();
2240
2241     // Record the abbreviation.
2242     AssignAbbrevNumber(Die->getAbbrev());
2243
2244     // Get the abbreviation for this DIE.
2245     unsigned AbbrevNumber = Die->getAbbrevNumber();
2246     const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2247
2248     // Set DIE offset
2249     Die->setOffset(Offset);
2250
2251     // Start the size with the size of abbreviation code.
2252     Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2253
2254     const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2255     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2256
2257     // Size the DIE attribute values.
2258     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2259       // Size attribute value.
2260       Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2261     }
2262
2263     // Size the DIE children if any.
2264     if (!Children.empty()) {
2265       assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2266              "Children flag not set");
2267
2268       for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2269         Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2270       }
2271
2272       // End of children marker.
2273       Offset += sizeof(int8_t);
2274     }
2275
2276     Die->setSize(Offset - Die->getOffset());
2277     return Offset;
2278   }
2279
2280   /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2281   ///
2282   void SizeAndOffsets() {
2283     // Process base compile unit.
2284     if (MainCU) {
2285       // Compute size of compile unit header
2286       unsigned Offset = 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       SizeAndOffsetDie(MainCU->getDie(), Offset, true);
2291       return;
2292     }
2293     for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i) {
2294       CompileUnit *Unit = CompileUnits[i];
2295       // Compute size of compile unit header
2296       unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2297         sizeof(int16_t) + // DWARF version number
2298         sizeof(int32_t) + // Offset Into Abbrev. Section
2299         sizeof(int8_t);   // Pointer Size (in bytes)
2300       SizeAndOffsetDie(Unit->getDie(), Offset, true);
2301     }
2302   }
2303
2304   /// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
2305   ///
2306   void EmitDebugInfoPerCU(CompileUnit *Unit) {
2307     DIE *Die = Unit->getDie();
2308     // Emit the compile units header.
2309     EmitLabel("info_begin", Unit->getID());
2310     // Emit size of content not including length itself
2311     unsigned ContentSize = Die->getSize() +
2312       sizeof(int16_t) + // DWARF version number
2313       sizeof(int32_t) + // Offset Into Abbrev. Section
2314       sizeof(int8_t) +  // Pointer Size (in bytes)
2315       sizeof(int32_t);  // FIXME - extra pad for gdb bug.
2316
2317     Asm->EmitInt32(ContentSize);  Asm->EOL("Length of Compilation Unit Info");
2318     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2319     EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2320     Asm->EOL("Offset Into Abbrev. Section");
2321     Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2322
2323     EmitDIE(Die);
2324     // FIXME - extra padding for gdb bug.
2325     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2326     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2327     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2328     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2329     EmitLabel("info_end", Unit->getID());
2330
2331     Asm->EOL();
2332   }
2333
2334   void EmitDebugInfo() {
2335     // Start debug info section.
2336     Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2337
2338     if (MainCU) {
2339       EmitDebugInfoPerCU(MainCU);
2340       return;
2341     }
2342
2343     for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i)
2344       EmitDebugInfoPerCU(CompileUnits[i]);
2345   }
2346
2347   /// EmitAbbreviations - Emit the abbreviation section.
2348   ///
2349   void EmitAbbreviations() const {
2350     // Check to see if it is worth the effort.
2351     if (!Abbreviations.empty()) {
2352       // Start the debug abbrev section.
2353       Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2354
2355       EmitLabel("abbrev_begin", 0);
2356
2357       // For each abbrevation.
2358       for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2359         // Get abbreviation data
2360         const DIEAbbrev *Abbrev = Abbreviations[i];
2361
2362         // Emit the abbrevations code (base 1 index.)
2363         Asm->EmitULEB128Bytes(Abbrev->getNumber());
2364         Asm->EOL("Abbreviation Code");
2365
2366         // Emit the abbreviations data.
2367         Abbrev->Emit(*this);
2368
2369         Asm->EOL();
2370       }
2371
2372       // Mark end of abbreviations.
2373       Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2374
2375       EmitLabel("abbrev_end", 0);
2376
2377       Asm->EOL();
2378     }
2379   }
2380
2381   /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2382   /// the line matrix.
2383   ///
2384   void EmitEndOfLineMatrix(unsigned SectionEnd) {
2385     // Define last address of section.
2386     Asm->EmitInt8(0); Asm->EOL("Extended Op");
2387     Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2388     Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2389     EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2390
2391     // Mark end of matrix.
2392     Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2393     Asm->EmitULEB128Bytes(1); Asm->EOL();
2394     Asm->EmitInt8(1); Asm->EOL();
2395   }
2396
2397   /// EmitDebugLines - Emit source line information.
2398   ///
2399   void EmitDebugLines() {
2400     // If the target is using .loc/.file, the assembler will be emitting the
2401     // .debug_line table automatically.
2402     if (TAI->hasDotLocAndDotFile())
2403       return;
2404
2405     // Minimum line delta, thus ranging from -10..(255-10).
2406     const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2407     // Maximum line delta, thus ranging from -10..(255-10).
2408     const int MaxLineDelta = 255 + MinLineDelta;
2409
2410     // Start the dwarf line section.
2411     Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2412
2413     // Construct the section header.
2414
2415     EmitDifference("line_end", 0, "line_begin", 0, true);
2416     Asm->EOL("Length of Source Line Info");
2417     EmitLabel("line_begin", 0);
2418
2419     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2420
2421     EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2422     Asm->EOL("Prolog Length");
2423     EmitLabel("line_prolog_begin", 0);
2424
2425     Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2426
2427     Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2428
2429     Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2430
2431     Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2432
2433     Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2434
2435     // Line number standard opcode encodings argument count
2436     Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2437     Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2438     Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2439     Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2440     Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2441     Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2442     Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2443     Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2444     Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2445
2446     // Emit directories.
2447     for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2448       Asm->EmitString(getSourceDirectoryName(DI));
2449       Asm->EOL("Directory");
2450     }
2451     Asm->EmitInt8(0); Asm->EOL("End of directories");
2452
2453     // Emit files.
2454     for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2455       // Remember source id starts at 1.
2456       std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2457       Asm->EmitString(getSourceFileName(Id.second));
2458       Asm->EOL("Source");
2459       Asm->EmitULEB128Bytes(Id.first);
2460       Asm->EOL("Directory #");
2461       Asm->EmitULEB128Bytes(0);
2462       Asm->EOL("Mod date");
2463       Asm->EmitULEB128Bytes(0);
2464       Asm->EOL("File size");
2465     }
2466     Asm->EmitInt8(0); Asm->EOL("End of files");
2467
2468     EmitLabel("line_prolog_end", 0);
2469
2470     // A sequence for each text section.
2471     unsigned SecSrcLinesSize = SectionSourceLines.size();
2472
2473     for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2474       // Isolate current sections line info.
2475       const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2476
2477       if (VerboseAsm) {
2478         const Section* S = SectionMap[j + 1];
2479         O << '\t' << TAI->getCommentString() << " Section"
2480           << S->getName() << '\n';
2481       } else
2482         Asm->EOL();
2483
2484       // Dwarf assumes we start with first line of first source file.
2485       unsigned Source = 1;
2486       unsigned Line = 1;
2487
2488       // Construct rows of the address, source, line, column matrix.
2489       for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2490         const SrcLineInfo &LineInfo = LineInfos[i];
2491         unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2492         if (!LabelID) continue;
2493
2494         if (!VerboseAsm)
2495           Asm->EOL();
2496         else {
2497           std::pair<unsigned, unsigned> SourceID =
2498             getSourceDirectoryAndFileIds(LineInfo.getSourceID());
2499           O << '\t' << TAI->getCommentString() << ' '
2500             << getSourceDirectoryName(SourceID.first) << ' '
2501             << getSourceFileName(SourceID.second)
2502             <<" :" << utostr_32(LineInfo.getLine()) << '\n';
2503         }
2504
2505         // Define the line address.
2506         Asm->EmitInt8(0); Asm->EOL("Extended Op");
2507         Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2508         Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2509         EmitReference("label",  LabelID); Asm->EOL("Location label");
2510
2511         // If change of source, then switch to the new source.
2512         if (Source != LineInfo.getSourceID()) {
2513           Source = LineInfo.getSourceID();
2514           Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2515           Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2516         }
2517
2518         // If change of line.
2519         if (Line != LineInfo.getLine()) {
2520           // Determine offset.
2521           int Offset = LineInfo.getLine() - Line;
2522           int Delta = Offset - MinLineDelta;
2523
2524           // Update line.
2525           Line = LineInfo.getLine();
2526
2527           // If delta is small enough and in range...
2528           if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2529             // ... then use fast opcode.
2530             Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2531           } else {
2532             // ... otherwise use long hand.
2533             Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2534             Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2535             Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2536           }
2537         } else {
2538           // Copy the previous row (different address or source)
2539           Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2540         }
2541       }
2542
2543       EmitEndOfLineMatrix(j + 1);
2544     }
2545
2546     if (SecSrcLinesSize == 0)
2547       // Because we're emitting a debug_line section, we still need a line
2548       // table. The linker and friends expect it to exist. If there's nothing to
2549       // put into it, emit an empty table.
2550       EmitEndOfLineMatrix(1);
2551
2552     EmitLabel("line_end", 0);
2553
2554     Asm->EOL();
2555   }
2556
2557   /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2558   ///
2559   void EmitCommonDebugFrame() {
2560     if (!TAI->doesDwarfRequireFrameSection())
2561       return;
2562
2563     int stackGrowth =
2564         Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2565           TargetFrameInfo::StackGrowsUp ?
2566         TD->getPointerSize() : -TD->getPointerSize();
2567
2568     // Start the dwarf frame section.
2569     Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2570
2571     EmitLabel("debug_frame_common", 0);
2572     EmitDifference("debug_frame_common_end", 0,
2573                    "debug_frame_common_begin", 0, true);
2574     Asm->EOL("Length of Common Information Entry");
2575
2576     EmitLabel("debug_frame_common_begin", 0);
2577     Asm->EmitInt32((int)DW_CIE_ID);
2578     Asm->EOL("CIE Identifier Tag");
2579     Asm->EmitInt8(DW_CIE_VERSION);
2580     Asm->EOL("CIE Version");
2581     Asm->EmitString("");
2582     Asm->EOL("CIE Augmentation");
2583     Asm->EmitULEB128Bytes(1);
2584     Asm->EOL("CIE Code Alignment Factor");
2585     Asm->EmitSLEB128Bytes(stackGrowth);
2586     Asm->EOL("CIE Data Alignment Factor");
2587     Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2588     Asm->EOL("CIE RA Column");
2589
2590     std::vector<MachineMove> Moves;
2591     RI->getInitialFrameState(Moves);
2592
2593     EmitFrameMoves(NULL, 0, Moves, false);
2594
2595     Asm->EmitAlignment(2, 0, 0, false);
2596     EmitLabel("debug_frame_common_end", 0);
2597
2598     Asm->EOL();
2599   }
2600
2601   /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2602   /// section.
2603   void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2604     if (!TAI->doesDwarfRequireFrameSection())
2605       return;
2606
2607     // Start the dwarf frame section.
2608     Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2609
2610     EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2611                    "debug_frame_begin", DebugFrameInfo.Number, true);
2612     Asm->EOL("Length of Frame Information Entry");
2613
2614     EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2615
2616     EmitSectionOffset("debug_frame_common", "section_debug_frame",
2617                       0, 0, true, false);
2618     Asm->EOL("FDE CIE offset");
2619
2620     EmitReference("func_begin", DebugFrameInfo.Number);
2621     Asm->EOL("FDE initial location");
2622     EmitDifference("func_end", DebugFrameInfo.Number,
2623                    "func_begin", DebugFrameInfo.Number);
2624     Asm->EOL("FDE address range");
2625
2626     EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2627                    false);
2628
2629     Asm->EmitAlignment(2, 0, 0, false);
2630     EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2631
2632     Asm->EOL();
2633   }
2634
2635   void EmitDebugPubNamesPerCU(CompileUnit *Unit) {
2636     EmitDifference("pubnames_end", Unit->getID(),
2637                    "pubnames_begin", Unit->getID(), true);
2638     Asm->EOL("Length of Public Names Info");
2639
2640     EmitLabel("pubnames_begin", Unit->getID());
2641
2642     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2643
2644     EmitSectionOffset("info_begin", "section_info",
2645                       Unit->getID(), 0, true, false);
2646     Asm->EOL("Offset of Compilation Unit Info");
2647
2648     EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
2649                    true);
2650     Asm->EOL("Compilation Unit Length");
2651
2652     std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2653     for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2654            GE = Globals.end(); GI != GE; ++GI) {
2655       const std::string &Name = GI->first;
2656       DIE * Entity = GI->second;
2657
2658       Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2659       Asm->EmitString(Name); Asm->EOL("External Name");
2660     }
2661
2662     Asm->EmitInt32(0); Asm->EOL("End Mark");
2663     EmitLabel("pubnames_end", Unit->getID());
2664
2665     Asm->EOL();
2666   }
2667
2668   /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2669   ///
2670   void EmitDebugPubNames() {
2671     // Start the dwarf pubnames section.
2672     Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2673
2674     if (MainCU) {
2675       EmitDebugPubNamesPerCU(MainCU);
2676       return;
2677     }
2678
2679     for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i)
2680       EmitDebugPubNamesPerCU(CompileUnits[i]);
2681   }
2682
2683   /// EmitDebugStr - Emit visible names into a debug str section.
2684   ///
2685   void EmitDebugStr() {
2686     // Check to see if it is worth the effort.
2687     if (!StringPool.empty()) {
2688       // Start the dwarf str section.
2689       Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2690
2691       // For each of strings in the string pool.
2692       for (unsigned StringID = 1, N = StringPool.size();
2693            StringID <= N; ++StringID) {
2694         // Emit a label for reference from debug information entries.
2695         EmitLabel("string", StringID);
2696         // Emit the string itself.
2697         const std::string &String = StringPool[StringID];
2698         Asm->EmitString(String); Asm->EOL();
2699       }
2700
2701       Asm->EOL();
2702     }
2703   }
2704
2705   /// EmitDebugLoc - Emit visible names into a debug loc section.
2706   ///
2707   void EmitDebugLoc() {
2708     // Start the dwarf loc section.
2709     Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2710
2711     Asm->EOL();
2712   }
2713
2714   /// EmitDebugARanges - Emit visible names into a debug aranges section.
2715   ///
2716   void EmitDebugARanges() {
2717     // Start the dwarf aranges section.
2718     Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2719
2720     // FIXME - Mock up
2721 #if 0
2722     CompileUnit *Unit = GetBaseCompileUnit();
2723
2724     // Don't include size of length
2725     Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2726
2727     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2728
2729     EmitReference("info_begin", Unit->getID());
2730     Asm->EOL("Offset of Compilation Unit Info");
2731
2732     Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2733
2734     Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2735
2736     Asm->EmitInt16(0);  Asm->EOL("Pad (1)");
2737     Asm->EmitInt16(0);  Asm->EOL("Pad (2)");
2738
2739     // Range 1
2740     EmitReference("text_begin", 0); Asm->EOL("Address");
2741     EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2742
2743     Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2744     Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2745 #endif
2746
2747     Asm->EOL();
2748   }
2749
2750   /// EmitDebugRanges - Emit visible names into a debug ranges section.
2751   ///
2752   void EmitDebugRanges() {
2753     // Start the dwarf ranges section.
2754     Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2755
2756     Asm->EOL();
2757   }
2758
2759   /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2760   ///
2761   void EmitDebugMacInfo() {
2762     if (TAI->doesSupportMacInfoSection()) {
2763       // Start the dwarf macinfo section.
2764       Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2765
2766       Asm->EOL();
2767     }
2768   }
2769
2770   /// GetOrCreateSourceID - Look up the source id with the given directory and
2771   /// source file names. If none currently exists, create a new id and insert it
2772   /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
2773   /// as well.
2774   unsigned GetOrCreateSourceID(const std::string &DirName,
2775                                const std::string &FileName) {
2776     unsigned DId;
2777     StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
2778     if (DI != DirectoryIdMap.end()) {
2779       DId = DI->getValue();
2780     } else {
2781       DId = DirectoryNames.size() + 1;
2782       DirectoryIdMap[DirName] = DId;
2783       DirectoryNames.push_back(DirName);
2784     }
2785
2786     unsigned FId;
2787     StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
2788     if (FI != SourceFileIdMap.end()) {
2789       FId = FI->getValue();
2790     } else {
2791       FId = SourceFileNames.size() + 1;
2792       SourceFileIdMap[FileName] = FId;
2793       SourceFileNames.push_back(FileName);
2794     }
2795
2796     DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
2797       SourceIdMap.find(std::make_pair(DId, FId));
2798     if (SI != SourceIdMap.end())
2799       return SI->second;
2800
2801     unsigned SrcId = SourceIds.size() + 1;  // DW_AT_decl_file cannot be 0.
2802     SourceIdMap[std::make_pair(DId, FId)] = SrcId;
2803     SourceIds.push_back(std::make_pair(DId, FId));
2804
2805     return SrcId;
2806   }
2807
2808   void ConstructCompileUnit(GlobalVariable *GV) {
2809     DICompileUnit DIUnit(GV);
2810     const char *Dir = DIUnit.getDirectory();
2811     const char *FN = DIUnit.getFilename();
2812     unsigned ID = GetOrCreateSourceID(Dir, FN);
2813
2814     DIE *Die = new DIE(DW_TAG_compile_unit);
2815     AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2816                      DWLabel("section_line", 0), DWLabel("section_line", 0),
2817                      false);
2818     AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit.getProducer());
2819     AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit.getLanguage());
2820     AddString(Die, DW_AT_name, DW_FORM_string, FN);
2821     if (Dir)
2822       AddString(Die, DW_AT_comp_dir, DW_FORM_string, Dir);
2823     if (DIUnit.isOptimized())
2824       AddUInt(Die, DW_AT_APPLE_optimized, DW_FORM_flag, 1);
2825     const char *Flags = DIUnit.getFlags();
2826     if (Flags)
2827       AddString(Die, DW_AT_APPLE_flags, DW_FORM_string, Flags);
2828     unsigned RVer = DIUnit.getRunTimeVersion();
2829     if (RVer)
2830       AddUInt(Die, DW_AT_APPLE_major_runtime_vers, DW_FORM_data1, RVer);
2831
2832     CompileUnit *Unit = new CompileUnit(ID, Die);
2833     if (DIUnit.isMain()) {
2834       assert(!MainCU && "Multiple main compile units are found!");
2835       MainCU = Unit;
2836     }
2837     CompileUnitMap[DIUnit.getGV()] = Unit;
2838     CompileUnits.push_back(Unit);
2839   }
2840
2841   /// ConstructCompileUnits - Create a compile unit DIEs.
2842   void ConstructCompileUnits() {
2843     GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.compile_units");
2844     if (!Root)
2845       return;
2846     assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2847            "Malformed compile unit descriptor anchor type");
2848     Constant *RootC = cast<Constant>(*Root->use_begin());
2849     assert(RootC->hasNUsesOrMore(1) &&
2850            "Malformed compile unit descriptor anchor type");
2851     for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2852          UI != UE; ++UI)
2853       for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2854            UUI != UUE; ++UUI) {
2855         GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2856         ConstructCompileUnit(GV);
2857       }
2858   }
2859
2860   bool ConstructGlobalVariableDIE(GlobalVariable *GV) {
2861     DIGlobalVariable DI_GV(GV);
2862     CompileUnit *DW_Unit = MainCU;
2863     if (!DW_Unit)
2864       DW_Unit = FindCompileUnit(DI_GV.getCompileUnit());
2865
2866     // Check for pre-existence.
2867     DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV.getGV());
2868     if (Slot)
2869       return false;
2870
2871     DIE *VariableDie = CreateGlobalVariableDIE(DW_Unit, DI_GV);
2872
2873     // Add address.
2874     DIEBlock *Block = new DIEBlock();
2875     AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2876     AddObjectLabel(Block, 0, DW_FORM_udata,
2877                    Asm->getGlobalLinkName(DI_GV.getGlobal()));
2878     AddBlock(VariableDie, DW_AT_location, 0, Block);
2879
2880     // Add to map.
2881     Slot = VariableDie;
2882     // Add to context owner.
2883     DW_Unit->getDie()->AddChild(VariableDie);
2884     // Expose as global. FIXME - need to check external flag.
2885     DW_Unit->AddGlobal(DI_GV.getName(), VariableDie);
2886     return true;
2887   }
2888
2889   /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
2890   /// visible global variables. Return true if at least one global DIE is
2891   /// created.
2892   bool ConstructGlobalVariableDIEs() {
2893     GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.global_variables");
2894     if (!Root)
2895       return false;
2896
2897     assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2898            "Malformed global variable descriptor anchor type");
2899     Constant *RootC = cast<Constant>(*Root->use_begin());
2900     assert(RootC->hasNUsesOrMore(1) &&
2901            "Malformed global variable descriptor anchor type");
2902
2903     bool Result = false;
2904     for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2905          UI != UE; ++UI)
2906       for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2907            UUI != UUE; ++UUI) {
2908         GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2909         Result |= ConstructGlobalVariableDIE(GV);
2910       }
2911     return Result;
2912   }
2913
2914   bool ConstructSubprogram(GlobalVariable *GV) {
2915     DISubprogram SP(GV);
2916     CompileUnit *Unit = MainCU;
2917     if (!Unit)
2918       Unit = FindCompileUnit(SP.getCompileUnit());
2919
2920     // Check for pre-existence.
2921     DIE *&Slot = Unit->getDieMapSlotFor(GV);
2922     if (Slot)
2923       return false;
2924
2925     if (!SP.isDefinition())
2926       // This is a method declaration which will be handled while
2927       // constructing class type.
2928       return false;
2929
2930     DIE *SubprogramDie = CreateSubprogramDIE(Unit, SP);
2931
2932     // Add to map.
2933     Slot = SubprogramDie;
2934     // Add to context owner.
2935     Unit->getDie()->AddChild(SubprogramDie);
2936     // Expose as global.
2937     Unit->AddGlobal(SP.getName(), SubprogramDie);
2938     return true;
2939   }
2940
2941   /// ConstructSubprograms - Create DIEs for each of the externally visible
2942   /// subprograms. Return true if at least one subprogram DIE is created.
2943   bool ConstructSubprograms() {
2944     GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.subprograms");
2945     if (!Root)
2946       return false;
2947
2948     assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2949            "Malformed subprogram descriptor anchor type");
2950     Constant *RootC = cast<Constant>(*Root->use_begin());
2951     assert(RootC->hasNUsesOrMore(1) &&
2952            "Malformed subprogram descriptor anchor type");
2953
2954     bool Result = false;
2955     for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2956          UI != UE; ++UI)
2957       for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2958            UUI != UUE; ++UUI) {
2959         GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2960         Result |= ConstructSubprogram(GV);
2961       }
2962     return Result;
2963   }
2964
2965 public:
2966   //===--------------------------------------------------------------------===//
2967   // Main entry points.
2968   //
2969   DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2970     : Dwarf(OS, A, T, "dbg"), MainCU(0),
2971       AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
2972       ValuesSet(InitValuesSetSize), Values(), StringPool(), SectionMap(),
2973       SectionSourceLines(), didInitial(false), shouldEmit(false),
2974       RootDbgScope(0), DebugTimer(0) {
2975     if (TimePassesIsEnabled)
2976       DebugTimer = new Timer("Dwarf Debug Writer",
2977                              getDwarfTimerGroup());
2978   }
2979   virtual ~DwarfDebug() {
2980     for (unsigned j = 0, M = Values.size(); j < M; ++j)
2981       delete Values[j];
2982
2983     delete DebugTimer;
2984   }
2985
2986   /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
2987   /// be emitted.
2988   bool ShouldEmitDwarfDebug() const { return shouldEmit; }
2989
2990   /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
2991   /// This is inovked by the target AsmPrinter.
2992   void SetDebugInfo(MachineModuleInfo *mmi) {
2993     if (TimePassesIsEnabled)
2994       DebugTimer->startTimer();
2995
2996     // Create all the compile unit DIEs.
2997     ConstructCompileUnits();
2998
2999     if (CompileUnits.empty()) {
3000       if (TimePassesIsEnabled)
3001         DebugTimer->stopTimer();
3002
3003       return;
3004     }
3005
3006     // Create DIEs for each of the externally visible global variables.
3007     bool globalDIEs = ConstructGlobalVariableDIEs();
3008
3009     // Create DIEs for each of the externally visible subprograms.
3010     bool subprogramDIEs = ConstructSubprograms();
3011
3012     // If there is not any debug info available for any global variables
3013     // and any subprograms then there is not any debug info to emit.
3014     if (!globalDIEs && !subprogramDIEs) {
3015       if (TimePassesIsEnabled)
3016         DebugTimer->stopTimer();
3017
3018       return;
3019     }
3020
3021     MMI = mmi;
3022     shouldEmit = true;
3023     MMI->setDebugInfoAvailability(true);
3024
3025     // Prime section data.
3026     SectionMap.insert(TAI->getTextSection());
3027
3028     // Print out .file directives to specify files for .loc directives. These
3029     // are printed out early so that they precede any .loc directives.
3030     if (TAI->hasDotLocAndDotFile()) {
3031       for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
3032         // Remember source id starts at 1.
3033         std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
3034         sys::Path FullPath(getSourceDirectoryName(Id.first));
3035         bool AppendOk =
3036           FullPath.appendComponent(getSourceFileName(Id.second));
3037         assert(AppendOk && "Could not append filename to directory!");
3038         AppendOk = false;
3039         Asm->EmitFile(i, FullPath.toString());
3040         Asm->EOL();
3041       }
3042     }
3043
3044     // Emit initial sections
3045     EmitInitial();
3046
3047     if (TimePassesIsEnabled)
3048       DebugTimer->stopTimer();
3049   }
3050
3051   /// BeginModule - Emit all Dwarf sections that should come prior to the
3052   /// content.
3053   void BeginModule(Module *M) {
3054     this->M = M;
3055   }
3056
3057   /// EndModule - Emit all Dwarf sections that should come after the content.
3058   ///
3059   void EndModule() {
3060     if (!ShouldEmitDwarfDebug())
3061       return;
3062
3063     if (TimePassesIsEnabled)
3064       DebugTimer->startTimer();
3065
3066     // Standard sections final addresses.
3067     Asm->SwitchToSection(TAI->getTextSection());
3068     EmitLabel("text_end", 0);
3069     Asm->SwitchToSection(TAI->getDataSection());
3070     EmitLabel("data_end", 0);
3071
3072     // End text sections.
3073     for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
3074       Asm->SwitchToSection(SectionMap[i]);
3075       EmitLabel("section_end", i);
3076     }
3077
3078     // Emit common frame information.
3079     EmitCommonDebugFrame();
3080
3081     // Emit function debug frame information
3082     for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
3083            E = DebugFrames.end(); I != E; ++I)
3084       EmitFunctionDebugFrame(*I);
3085
3086     // Compute DIE offsets and sizes.
3087     SizeAndOffsets();
3088
3089     // Emit all the DIEs into a debug info section
3090     EmitDebugInfo();
3091
3092     // Corresponding abbreviations into a abbrev section.
3093     EmitAbbreviations();
3094
3095     // Emit source line correspondence into a debug line section.
3096     EmitDebugLines();
3097
3098     // Emit info into a debug pubnames section.
3099     EmitDebugPubNames();
3100
3101     // Emit info into a debug str section.
3102     EmitDebugStr();
3103
3104     // Emit info into a debug loc section.
3105     EmitDebugLoc();
3106
3107     // Emit info into a debug aranges section.
3108     EmitDebugARanges();
3109
3110     // Emit info into a debug ranges section.
3111     EmitDebugRanges();
3112
3113     // Emit info into a debug macinfo section.
3114     EmitDebugMacInfo();
3115
3116     if (TimePassesIsEnabled)
3117       DebugTimer->stopTimer();
3118   }
3119
3120   /// BeginFunction - Gather pre-function debug information.  Assumes being
3121   /// emitted immediately after the function entry point.
3122   void BeginFunction(MachineFunction *MF) {
3123     this->MF = MF;
3124
3125     if (!ShouldEmitDwarfDebug()) return;
3126
3127     if (TimePassesIsEnabled)
3128       DebugTimer->startTimer();
3129
3130     // Begin accumulating function debug information.
3131     MMI->BeginFunction(MF);
3132
3133     // Assumes in correct section after the entry point.
3134     EmitLabel("func_begin", ++SubprogramCount);
3135
3136     // Emit label for the implicitly defined dbg.stoppoint at the start of
3137     // the function.
3138     if (!Lines.empty()) {
3139       const SrcLineInfo &LineInfo = Lines[0];
3140       Asm->printLabel(LineInfo.getLabelID());
3141     }
3142
3143     if (TimePassesIsEnabled)
3144       DebugTimer->stopTimer();
3145   }
3146
3147   /// EndFunction - Gather and emit post-function debug information.
3148   ///
3149   void EndFunction(MachineFunction *MF) {
3150     if (!ShouldEmitDwarfDebug()) return;
3151
3152     if (TimePassesIsEnabled)
3153       DebugTimer->startTimer();
3154
3155     // Define end label for subprogram.
3156     EmitLabel("func_end", SubprogramCount);
3157
3158     // Get function line info.
3159     if (!Lines.empty()) {
3160       // Get section line info.
3161       unsigned ID = SectionMap.insert(Asm->CurrentSection_);
3162       if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3163       std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3164       // Append the function info to section info.
3165       SectionLineInfos.insert(SectionLineInfos.end(),
3166                               Lines.begin(), Lines.end());
3167     }
3168
3169     // Construct scopes for subprogram.
3170     if (RootDbgScope)
3171       ConstructRootDbgScope(RootDbgScope);
3172     else
3173       // FIXME: This is wrong. We are essentially getting past a problem with
3174       // debug information not being able to handle unreachable blocks that have
3175       // debug information in them. In particular, those unreachable blocks that
3176       // have "region end" info in them. That situation results in the "root
3177       // scope" not being created. If that's the case, then emit a "default"
3178       // scope, i.e., one that encompasses the whole function. This isn't
3179       // desirable. And a better way of handling this (and all of the debugging
3180       // information) needs to be explored.
3181       ConstructDefaultDbgScope(MF);
3182
3183     DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3184                                                  MMI->getFrameMoves()));
3185
3186     // Clear debug info
3187     if (RootDbgScope) {
3188       delete RootDbgScope;
3189       DbgScopeMap.clear();
3190       RootDbgScope = NULL;
3191     }
3192
3193     Lines.clear();
3194
3195     if (TimePassesIsEnabled)
3196       DebugTimer->stopTimer();
3197   }
3198
3199   /// ValidDebugInfo - Return true if V represents valid debug info value.
3200   bool ValidDebugInfo(Value *V) {
3201     if (!V)
3202       return false;
3203
3204     if (!shouldEmit)
3205       return false;
3206
3207     GlobalVariable *GV = getGlobalVariable(V);
3208     if (!GV)
3209       return false;
3210
3211     if (!GV->hasInternalLinkage () && !GV->hasLinkOnceLinkage())
3212       return false;
3213
3214     if (TimePassesIsEnabled)
3215       DebugTimer->startTimer();
3216
3217     DIDescriptor DI(GV);
3218
3219     // Check current version. Allow Version6 for now.
3220     unsigned Version = DI.getVersion();
3221     if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6) {
3222       if (TimePassesIsEnabled)
3223         DebugTimer->stopTimer();
3224
3225       return false;
3226     }
3227
3228     unsigned Tag = DI.getTag();
3229     switch (Tag) {
3230     case DW_TAG_variable:
3231       assert(DIVariable(GV).Verify() && "Invalid DebugInfo value");
3232       break;
3233     case DW_TAG_compile_unit:
3234       assert(DICompileUnit(GV).Verify() && "Invalid DebugInfo value");
3235       break;
3236     case DW_TAG_subprogram:
3237       assert(DISubprogram(GV).Verify() && "Invalid DebugInfo value");
3238       break;
3239     default:
3240       break;
3241     }
3242
3243     if (TimePassesIsEnabled)
3244       DebugTimer->stopTimer();
3245
3246     return true;
3247   }
3248
3249   /// RecordSourceLine - Records location information and associates it with a
3250   /// label. Returns a unique label ID used to generate a label and provide
3251   /// correspondence to the source line list.
3252   unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3253     if (TimePassesIsEnabled)
3254       DebugTimer->startTimer();
3255
3256     CompileUnit *Unit = CompileUnitMap[V];
3257     assert(Unit && "Unable to find CompileUnit");
3258     unsigned ID = MMI->NextLabelID();
3259     Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3260
3261     if (TimePassesIsEnabled)
3262       DebugTimer->stopTimer();
3263
3264     return ID;
3265   }
3266
3267   /// RecordSourceLine - Records location information and associates it with a
3268   /// label. Returns a unique label ID used to generate a label and provide
3269   /// correspondence to the source line list.
3270   unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3271     if (TimePassesIsEnabled)
3272       DebugTimer->startTimer();
3273
3274     unsigned ID = MMI->NextLabelID();
3275     Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3276
3277     if (TimePassesIsEnabled)
3278       DebugTimer->stopTimer();
3279
3280     return ID;
3281   }
3282
3283   /// getRecordSourceLineCount - Return the number of source lines in the debug
3284   /// info.
3285   unsigned getRecordSourceLineCount() const {
3286     return Lines.size();
3287   }
3288
3289   /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
3290   /// timed. Look up the source id with the given directory and source file
3291   /// names. If none currently exists, create a new id and insert it in the
3292   /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
3293   /// well.
3294   unsigned getOrCreateSourceID(const std::string &DirName,
3295                                const std::string &FileName) {
3296     if (TimePassesIsEnabled)
3297       DebugTimer->startTimer();
3298
3299     unsigned SrcId = GetOrCreateSourceID(DirName, FileName);
3300
3301     if (TimePassesIsEnabled)
3302       DebugTimer->stopTimer();
3303
3304     return SrcId;
3305   }
3306
3307   /// RecordRegionStart - Indicate the start of a region.
3308   unsigned RecordRegionStart(GlobalVariable *V) {
3309     if (TimePassesIsEnabled)
3310       DebugTimer->startTimer();
3311
3312     DbgScope *Scope = getOrCreateScope(V);
3313     unsigned ID = MMI->NextLabelID();
3314     if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3315
3316     if (TimePassesIsEnabled)
3317       DebugTimer->stopTimer();
3318
3319     return ID;
3320   }
3321
3322   /// RecordRegionEnd - Indicate the end of a region.
3323   unsigned RecordRegionEnd(GlobalVariable *V) {
3324     if (TimePassesIsEnabled)
3325       DebugTimer->startTimer();
3326
3327     DbgScope *Scope = getOrCreateScope(V);
3328     unsigned ID = MMI->NextLabelID();
3329     Scope->setEndLabelID(ID);
3330
3331     if (TimePassesIsEnabled)
3332       DebugTimer->stopTimer();
3333
3334     return ID;
3335   }
3336
3337   /// RecordVariable - Indicate the declaration of  a local variable.
3338   void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
3339     if (TimePassesIsEnabled)
3340       DebugTimer->startTimer();
3341
3342     DIDescriptor Desc(GV);
3343     DbgScope *Scope = NULL;
3344
3345     if (Desc.getTag() == DW_TAG_variable) {
3346       // GV is a global variable.
3347       DIGlobalVariable DG(GV);
3348       Scope = getOrCreateScope(DG.getContext().getGV());
3349     } else {
3350       // or GV is a local variable.
3351       DIVariable DV(GV);
3352       Scope = getOrCreateScope(DV.getContext().getGV());
3353     }
3354
3355     assert(Scope && "Unable to find variable' scope");
3356     DbgVariable *DV = new DbgVariable(DIVariable(GV), FrameIndex);
3357     Scope->AddVariable(DV);
3358
3359     if (TimePassesIsEnabled)
3360       DebugTimer->stopTimer();
3361   }
3362 };
3363
3364 //===----------------------------------------------------------------------===//
3365 /// DwarfException - Emits Dwarf exception handling directives.
3366 ///
3367 class DwarfException : public Dwarf  {
3368   struct FunctionEHFrameInfo {
3369     std::string FnName;
3370     unsigned Number;
3371     unsigned PersonalityIndex;
3372     bool hasCalls;
3373     bool hasLandingPads;
3374     std::vector<MachineMove> Moves;
3375     const Function * function;
3376
3377     FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3378                         bool hC, bool hL,
3379                         const std::vector<MachineMove> &M,
3380                         const Function *f):
3381       FnName(FN), Number(Num), PersonalityIndex(P),
3382       hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
3383   };
3384
3385   std::vector<FunctionEHFrameInfo> EHFrames;
3386
3387   /// shouldEmitTable - Per-function flag to indicate if EH tables should
3388   /// be emitted.
3389   bool shouldEmitTable;
3390
3391   /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3392   /// should be emitted.
3393   bool shouldEmitMoves;
3394
3395   /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3396   /// should be emitted.
3397   bool shouldEmitTableModule;
3398
3399   /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
3400   /// should be emitted.
3401   bool shouldEmitMovesModule;
3402
3403   /// ExceptionTimer - Timer for the Dwarf exception writer.
3404   Timer *ExceptionTimer;
3405
3406   /// EmitCommonEHFrame - Emit the common eh unwind frame.
3407   ///
3408   void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3409     // Size and sign of stack growth.
3410     int stackGrowth =
3411         Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3412           TargetFrameInfo::StackGrowsUp ?
3413         TD->getPointerSize() : -TD->getPointerSize();
3414
3415     // Begin eh frame section.
3416     Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3417
3418     if (!TAI->doesRequireNonLocalEHFrameLabel())
3419       O << TAI->getEHGlobalPrefix();
3420     O << "EH_frame" << Index << ":\n";
3421     EmitLabel("section_eh_frame", Index);
3422
3423     // Define base labels.
3424     EmitLabel("eh_frame_common", Index);
3425
3426     // Define the eh frame length.
3427     EmitDifference("eh_frame_common_end", Index,
3428                    "eh_frame_common_begin", Index, true);
3429     Asm->EOL("Length of Common Information Entry");
3430
3431     // EH frame header.
3432     EmitLabel("eh_frame_common_begin", Index);
3433     Asm->EmitInt32((int)0);
3434     Asm->EOL("CIE Identifier Tag");
3435     Asm->EmitInt8(DW_CIE_VERSION);
3436     Asm->EOL("CIE Version");
3437
3438     // The personality presence indicates that language specific information
3439     // will show up in the eh frame.
3440     Asm->EmitString(Personality ? "zPLR" : "zR");
3441     Asm->EOL("CIE Augmentation");
3442
3443     // Round out reader.
3444     Asm->EmitULEB128Bytes(1);
3445     Asm->EOL("CIE Code Alignment Factor");
3446     Asm->EmitSLEB128Bytes(stackGrowth);
3447     Asm->EOL("CIE Data Alignment Factor");
3448     Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
3449     Asm->EOL("CIE Return Address Column");
3450
3451     // If there is a personality, we need to indicate the functions location.
3452     if (Personality) {
3453       Asm->EmitULEB128Bytes(7);
3454       Asm->EOL("Augmentation Size");
3455
3456       if (TAI->getNeedsIndirectEncoding()) {
3457         Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
3458         Asm->EOL("Personality (pcrel sdata4 indirect)");
3459       } else {
3460         Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3461         Asm->EOL("Personality (pcrel sdata4)");
3462       }
3463
3464       PrintRelDirective(true);
3465       O << TAI->getPersonalityPrefix();
3466       Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3467       O << TAI->getPersonalitySuffix();
3468       if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3469         O << "-" << TAI->getPCSymbol();
3470       Asm->EOL("Personality");
3471
3472       Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3473       Asm->EOL("LSDA Encoding (pcrel sdata4)");
3474
3475       Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3476       Asm->EOL("FDE Encoding (pcrel sdata4)");
3477    } else {
3478       Asm->EmitULEB128Bytes(1);
3479       Asm->EOL("Augmentation Size");
3480
3481       Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3482       Asm->EOL("FDE Encoding (pcrel sdata4)");
3483     }
3484
3485     // Indicate locations of general callee saved registers in frame.
3486     std::vector<MachineMove> Moves;
3487     RI->getInitialFrameState(Moves);
3488     EmitFrameMoves(NULL, 0, Moves, true);
3489
3490     // On Darwin the linker honors the alignment of eh_frame, which means it
3491     // must be 8-byte on 64-bit targets to match what gcc does.  Otherwise
3492     // you get holes which confuse readers of eh_frame.
3493     Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3494                        0, 0, false);
3495     EmitLabel("eh_frame_common_end", Index);
3496
3497     Asm->EOL();
3498   }
3499
3500   /// EmitEHFrame - Emit function exception frame information.
3501   ///
3502   void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
3503     Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3504
3505     Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3506
3507     // Externally visible entry into the functions eh frame info.
3508     // If the corresponding function is static, this should not be
3509     // externally visible.
3510     if (linkage != Function::InternalLinkage &&
3511         linkage != Function::PrivateLinkage) {
3512       if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3513         O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3514     }
3515
3516     // If corresponding function is weak definition, this should be too.
3517     if ((linkage == Function::WeakAnyLinkage ||
3518          linkage == Function::WeakODRLinkage ||
3519          linkage == Function::LinkOnceAnyLinkage ||
3520          linkage == Function::LinkOnceODRLinkage) &&
3521         TAI->getWeakDefDirective())
3522       O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3523
3524     // If there are no calls then you can't unwind.  This may mean we can
3525     // omit the EH Frame, but some environments do not handle weak absolute
3526     // symbols.
3527     // If UnwindTablesMandatory is set we cannot do this optimization; the
3528     // unwind info is to be available for non-EH uses.
3529     if (!EHFrameInfo.hasCalls &&
3530         !UnwindTablesMandatory &&
3531         ((linkage != Function::WeakAnyLinkage &&
3532           linkage != Function::WeakODRLinkage &&
3533           linkage != Function::LinkOnceAnyLinkage &&
3534           linkage != Function::LinkOnceODRLinkage) ||
3535          !TAI->getWeakDefDirective() ||
3536          TAI->getSupportsWeakOmittedEHFrame()))
3537     {
3538       O << EHFrameInfo.FnName << " = 0\n";
3539       // This name has no connection to the function, so it might get
3540       // dead-stripped when the function is not, erroneously.  Prohibit
3541       // dead-stripping unconditionally.
3542       if (const char *UsedDirective = TAI->getUsedDirective())
3543         O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3544     } else {
3545       O << EHFrameInfo.FnName << ":\n";
3546
3547       // EH frame header.
3548       EmitDifference("eh_frame_end", EHFrameInfo.Number,
3549                      "eh_frame_begin", EHFrameInfo.Number, true);
3550       Asm->EOL("Length of Frame Information Entry");
3551
3552       EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3553
3554       if (TAI->doesRequireNonLocalEHFrameLabel()) {
3555         PrintRelDirective(true, true);
3556         PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3557
3558         if (!TAI->isAbsoluteEHSectionOffsets())
3559           O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3560       } else {
3561         EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3562                           EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3563                           true, true, false);
3564       }
3565
3566       Asm->EOL("FDE CIE offset");
3567
3568       EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3569       Asm->EOL("FDE initial location");
3570       EmitDifference("eh_func_end", EHFrameInfo.Number,
3571                      "eh_func_begin", EHFrameInfo.Number, true);
3572       Asm->EOL("FDE address range");
3573
3574       // If there is a personality and landing pads then point to the language
3575       // specific data area in the exception table.
3576       if (EHFrameInfo.PersonalityIndex) {
3577         Asm->EmitULEB128Bytes(4);
3578         Asm->EOL("Augmentation size");
3579
3580         if (EHFrameInfo.hasLandingPads)
3581           EmitReference("exception", EHFrameInfo.Number, true, true);
3582         else
3583           Asm->EmitInt32((int)0);
3584         Asm->EOL("Language Specific Data Area");
3585       } else {
3586         Asm->EmitULEB128Bytes(0);
3587         Asm->EOL("Augmentation size");
3588       }
3589
3590       // Indicate locations of function specific  callee saved registers in
3591       // frame.
3592       EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves,
3593                      true);
3594
3595       // On Darwin the linker honors the alignment of eh_frame, which means it
3596       // must be 8-byte on 64-bit targets to match what gcc does.  Otherwise
3597       // you get holes which confuse readers of eh_frame.
3598       Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3599                          0, 0, false);
3600       EmitLabel("eh_frame_end", EHFrameInfo.Number);
3601
3602       // If the function is marked used, this table should be also.  We cannot
3603       // make the mark unconditional in this case, since retaining the table
3604       // also retains the function in this case, and there is code around
3605       // that depends on unused functions (calling undefined externals) being
3606       // dead-stripped to link correctly.  Yes, there really is.
3607       if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3608         if (const char *UsedDirective = TAI->getUsedDirective())
3609           O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3610     }
3611   }
3612
3613   /// EmitExceptionTable - Emit landing pads and actions.
3614   ///
3615   /// The general organization of the table is complex, but the basic concepts
3616   /// are easy.  First there is a header which describes the location and
3617   /// organization of the three components that follow.
3618   ///  1. The landing pad site information describes the range of code covered
3619   ///     by the try.  In our case it's an accumulation of the ranges covered
3620   ///     by the invokes in the try.  There is also a reference to the landing
3621   ///     pad that handles the exception once processed.  Finally an index into
3622   ///     the actions table.
3623   ///  2. The action table, in our case, is composed of pairs of type ids
3624   ///     and next action offset.  Starting with the action index from the
3625   ///     landing pad site, each type Id is checked for a match to the current
3626   ///     exception.  If it matches then the exception and type id are passed
3627   ///     on to the landing pad.  Otherwise the next action is looked up.  This
3628   ///     chain is terminated with a next action of zero.  If no type id is
3629   ///     found the the frame is unwound and handling continues.
3630   ///  3. Type id table contains references to all the C++ typeinfo for all
3631   ///     catches in the function.  This tables is reversed indexed base 1.
3632
3633   /// SharedTypeIds - How many leading type ids two landing pads have in common.
3634   static unsigned SharedTypeIds(const LandingPadInfo *L,
3635                                 const LandingPadInfo *R) {
3636     const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3637     unsigned LSize = LIds.size(), RSize = RIds.size();
3638     unsigned MinSize = LSize < RSize ? LSize : RSize;
3639     unsigned Count = 0;
3640
3641     for (; Count != MinSize; ++Count)
3642       if (LIds[Count] != RIds[Count])
3643         return Count;
3644
3645     return Count;
3646   }
3647
3648   /// PadLT - Order landing pads lexicographically by type id.
3649   static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3650     const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3651     unsigned LSize = LIds.size(), RSize = RIds.size();
3652     unsigned MinSize = LSize < RSize ? LSize : RSize;
3653
3654     for (unsigned i = 0; i != MinSize; ++i)
3655       if (LIds[i] != RIds[i])
3656         return LIds[i] < RIds[i];
3657
3658     return LSize < RSize;
3659   }
3660
3661   struct KeyInfo {
3662     static inline unsigned getEmptyKey() { return -1U; }
3663     static inline unsigned getTombstoneKey() { return -2U; }
3664     static unsigned getHashValue(const unsigned &Key) { return Key; }
3665     static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3666     static bool isPod() { return true; }
3667   };
3668
3669   /// ActionEntry - Structure describing an entry in the actions table.
3670   struct ActionEntry {
3671     int ValueForTypeID; // The value to write - may not be equal to the type id.
3672     int NextAction;
3673     struct ActionEntry *Previous;
3674   };
3675
3676   /// PadRange - Structure holding a try-range and the associated landing pad.
3677   struct PadRange {
3678     // The index of the landing pad.
3679     unsigned PadIndex;
3680     // The index of the begin and end labels in the landing pad's label lists.
3681     unsigned RangeIndex;
3682   };
3683
3684   typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3685
3686   /// CallSiteEntry - Structure describing an entry in the call-site table.
3687   struct CallSiteEntry {
3688     // The 'try-range' is BeginLabel .. EndLabel.
3689     unsigned BeginLabel; // zero indicates the start of the function.
3690     unsigned EndLabel;   // zero indicates the end of the function.
3691     // The landing pad starts at PadLabel.
3692     unsigned PadLabel;   // zero indicates that there is no landing pad.
3693     unsigned Action;
3694   };
3695
3696   void EmitExceptionTable() {
3697     const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3698     const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3699     const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3700     if (PadInfos.empty()) return;
3701
3702     // Sort the landing pads in order of their type ids.  This is used to fold
3703     // duplicate actions.
3704     SmallVector<const LandingPadInfo *, 64> LandingPads;
3705     LandingPads.reserve(PadInfos.size());
3706     for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3707       LandingPads.push_back(&PadInfos[i]);
3708     std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3709
3710     // Negative type ids index into FilterIds, positive type ids index into
3711     // TypeInfos.  The value written for a positive type id is just the type
3712     // id itself.  For a negative type id, however, the value written is the
3713     // (negative) byte offset of the corresponding FilterIds entry.  The byte
3714     // offset is usually equal to the type id, because the FilterIds entries
3715     // are written using a variable width encoding which outputs one byte per
3716     // entry as long as the value written is not too large, but can differ.
3717     // This kind of complication does not occur for positive type ids because
3718     // type infos are output using a fixed width encoding.
3719     // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3720     SmallVector<int, 16> FilterOffsets;
3721     FilterOffsets.reserve(FilterIds.size());
3722     int Offset = -1;
3723     for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3724         E = FilterIds.end(); I != E; ++I) {
3725       FilterOffsets.push_back(Offset);
3726       Offset -= TargetAsmInfo::getULEB128Size(*I);
3727     }
3728
3729     // Compute the actions table and gather the first action index for each
3730     // landing pad site.
3731     SmallVector<ActionEntry, 32> Actions;
3732     SmallVector<unsigned, 64> FirstActions;
3733     FirstActions.reserve(LandingPads.size());
3734
3735     int FirstAction = 0;
3736     unsigned SizeActions = 0;
3737     for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3738       const LandingPadInfo *LP = LandingPads[i];
3739       const std::vector<int> &TypeIds = LP->TypeIds;
3740       const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3741       unsigned SizeSiteActions = 0;
3742
3743       if (NumShared < TypeIds.size()) {
3744         unsigned SizeAction = 0;
3745         ActionEntry *PrevAction = 0;
3746
3747         if (NumShared) {
3748           const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3749           assert(Actions.size());
3750           PrevAction = &Actions.back();
3751           SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3752             TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3753           for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3754             SizeAction -=
3755               TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3756             SizeAction += -PrevAction->NextAction;
3757             PrevAction = PrevAction->Previous;
3758           }
3759         }
3760
3761         // Compute the actions.
3762         for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3763           int TypeID = TypeIds[I];
3764           assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3765           int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3766           unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
3767
3768           int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3769           SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
3770           SizeSiteActions += SizeAction;
3771
3772           ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3773           Actions.push_back(Action);
3774
3775           PrevAction = &Actions.back();
3776         }
3777
3778         // Record the first action of the landing pad site.
3779         FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3780       } // else identical - re-use previous FirstAction
3781
3782       FirstActions.push_back(FirstAction);
3783
3784       // Compute this sites contribution to size.
3785       SizeActions += SizeSiteActions;
3786     }
3787
3788     // Compute the call-site table.  The entry for an invoke has a try-range
3789     // containing the call, a non-zero landing pad and an appropriate action.
3790     // The entry for an ordinary call has a try-range containing the call and
3791     // zero for the landing pad and the action.  Calls marked 'nounwind' have
3792     // no entry and must not be contained in the try-range of any entry - they
3793     // form gaps in the table.  Entries must be ordered by try-range address.
3794     SmallVector<CallSiteEntry, 64> CallSites;
3795
3796     RangeMapType PadMap;
3797     // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3798     // by try-range labels when lowered).  Ordinary calls do not, so appropriate
3799     // try-ranges for them need be deduced.
3800     for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3801       const LandingPadInfo *LandingPad = LandingPads[i];
3802       for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3803         unsigned BeginLabel = LandingPad->BeginLabels[j];
3804         assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3805         PadRange P = { i, j };
3806         PadMap[BeginLabel] = P;
3807       }
3808     }
3809
3810     // The end label of the previous invoke or nounwind try-range.
3811     unsigned LastLabel = 0;
3812
3813     // Whether there is a potentially throwing instruction (currently this means
3814     // an ordinary call) between the end of the previous try-range and now.
3815     bool SawPotentiallyThrowing = false;
3816
3817     // Whether the last callsite entry was for an invoke.
3818     bool PreviousIsInvoke = false;
3819
3820     // Visit all instructions in order of address.
3821     for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3822          I != E; ++I) {
3823       for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3824            MI != E; ++MI) {
3825         if (!MI->isLabel()) {
3826           SawPotentiallyThrowing |= MI->getDesc().isCall();
3827           continue;
3828         }
3829
3830         unsigned BeginLabel = MI->getOperand(0).getImm();
3831         assert(BeginLabel && "Invalid label!");
3832
3833         // End of the previous try-range?
3834         if (BeginLabel == LastLabel)
3835           SawPotentiallyThrowing = false;
3836
3837         // Beginning of a new try-range?
3838         RangeMapType::iterator L = PadMap.find(BeginLabel);
3839         if (L == PadMap.end())
3840           // Nope, it was just some random label.
3841           continue;
3842
3843         PadRange P = L->second;
3844         const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3845
3846         assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3847                "Inconsistent landing pad map!");
3848
3849         // If some instruction between the previous try-range and this one may
3850         // throw, create a call-site entry with no landing pad for the region
3851         // between the try-ranges.
3852         if (SawPotentiallyThrowing) {
3853           CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3854           CallSites.push_back(Site);
3855           PreviousIsInvoke = false;
3856         }
3857
3858         LastLabel = LandingPad->EndLabels[P.RangeIndex];
3859         assert(BeginLabel && LastLabel && "Invalid landing pad!");
3860
3861         if (LandingPad->LandingPadLabel) {
3862           // This try-range is for an invoke.
3863           CallSiteEntry Site = {BeginLabel, LastLabel,
3864             LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3865
3866           // Try to merge with the previous call-site.
3867           if (PreviousIsInvoke) {
3868             CallSiteEntry &Prev = CallSites.back();
3869             if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3870               // Extend the range of the previous entry.
3871               Prev.EndLabel = Site.EndLabel;
3872               continue;
3873             }
3874           }
3875
3876           // Otherwise, create a new call-site.
3877           CallSites.push_back(Site);
3878           PreviousIsInvoke = true;
3879         } else {
3880           // Create a gap.
3881           PreviousIsInvoke = false;
3882         }
3883       }
3884     }
3885     // If some instruction between the previous try-range and the end of the
3886     // function may throw, create a call-site entry with no landing pad for the
3887     // region following the try-range.
3888     if (SawPotentiallyThrowing) {
3889       CallSiteEntry Site = {LastLabel, 0, 0, 0};
3890       CallSites.push_back(Site);
3891     }
3892
3893     // Final tallies.
3894
3895     // Call sites.
3896     const unsigned SiteStartSize  = sizeof(int32_t); // DW_EH_PE_udata4
3897     const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3898     const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3899     unsigned SizeSites = CallSites.size() * (SiteStartSize +
3900                                              SiteLengthSize +
3901                                              LandingPadSize);
3902     for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3903       SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
3904
3905     // Type infos.
3906     const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3907     unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
3908
3909     unsigned TypeOffset = sizeof(int8_t) + // Call site format
3910            TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
3911                           SizeSites + SizeActions + SizeTypes;
3912
3913     unsigned TotalSize = sizeof(int8_t) + // LPStart format
3914                          sizeof(int8_t) + // TType format
3915            TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
3916                          TypeOffset;
3917
3918     unsigned SizeAlign = (4 - TotalSize) & 3;
3919
3920     // Begin the exception table.
3921     Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3922     Asm->EmitAlignment(2, 0, 0, false);
3923     O << "GCC_except_table" << SubprogramCount << ":\n";
3924     for (unsigned i = 0; i != SizeAlign; ++i) {
3925       Asm->EmitInt8(0);
3926       Asm->EOL("Padding");
3927     }
3928     EmitLabel("exception", SubprogramCount);
3929
3930     // Emit the header.
3931     Asm->EmitInt8(DW_EH_PE_omit);
3932     Asm->EOL("LPStart format (DW_EH_PE_omit)");
3933     Asm->EmitInt8(DW_EH_PE_absptr);
3934     Asm->EOL("TType format (DW_EH_PE_absptr)");
3935     Asm->EmitULEB128Bytes(TypeOffset);
3936     Asm->EOL("TType base offset");
3937     Asm->EmitInt8(DW_EH_PE_udata4);
3938     Asm->EOL("Call site format (DW_EH_PE_udata4)");
3939     Asm->EmitULEB128Bytes(SizeSites);
3940     Asm->EOL("Call-site table length");
3941
3942     // Emit the landing pad site information.
3943     for (unsigned i = 0; i < CallSites.size(); ++i) {
3944       CallSiteEntry &S = CallSites[i];
3945       const char *BeginTag;
3946       unsigned BeginNumber;
3947
3948       if (!S.BeginLabel) {
3949         BeginTag = "eh_func_begin";
3950         BeginNumber = SubprogramCount;
3951       } else {
3952         BeginTag = "label";
3953         BeginNumber = S.BeginLabel;
3954       }
3955
3956       EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
3957                         true, true);
3958       Asm->EOL("Region start");
3959
3960       if (!S.EndLabel) {
3961         EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3962                        true);
3963       } else {
3964         EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
3965       }
3966       Asm->EOL("Region length");
3967
3968       if (!S.PadLabel)
3969         Asm->EmitInt32(0);
3970       else
3971         EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
3972                           true, true);
3973       Asm->EOL("Landing pad");
3974
3975       Asm->EmitULEB128Bytes(S.Action);
3976       Asm->EOL("Action");
3977     }
3978
3979     // Emit the actions.
3980     for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3981       ActionEntry &Action = Actions[I];
3982
3983       Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3984       Asm->EOL("TypeInfo index");
3985       Asm->EmitSLEB128Bytes(Action.NextAction);
3986       Asm->EOL("Next action");
3987     }
3988
3989     // Emit the type ids.
3990     for (unsigned M = TypeInfos.size(); M; --M) {
3991       GlobalVariable *GV = TypeInfos[M - 1];
3992
3993       PrintRelDirective();
3994
3995       if (GV)
3996         O << Asm->getGlobalLinkName(GV);
3997       else
3998         O << "0";
3999
4000       Asm->EOL("TypeInfo");
4001     }
4002
4003     // Emit the filter typeids.
4004     for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
4005       unsigned TypeID = FilterIds[j];
4006       Asm->EmitULEB128Bytes(TypeID);
4007       Asm->EOL("Filter TypeInfo index");
4008     }
4009
4010     Asm->EmitAlignment(2, 0, 0, false);
4011   }
4012
4013 public:
4014   //===--------------------------------------------------------------------===//
4015   // Main entry points.
4016   //
4017   DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
4018   : Dwarf(OS, A, T, "eh"), shouldEmitTable(false), shouldEmitMoves(false),
4019     shouldEmitTableModule(false), shouldEmitMovesModule(false),
4020     ExceptionTimer(0) {
4021     if (TimePassesIsEnabled)
4022       ExceptionTimer = new Timer("Dwarf Exception Writer",
4023                                  getDwarfTimerGroup());
4024   }
4025
4026   virtual ~DwarfException() {
4027     delete ExceptionTimer;
4028   }
4029
4030   /// SetModuleInfo - Set machine module information when it's known that pass
4031   /// manager has created it.  Set by the target AsmPrinter.
4032   void SetModuleInfo(MachineModuleInfo *mmi) {
4033     MMI = mmi;
4034   }
4035
4036   /// BeginModule - Emit all exception information that should come prior to the
4037   /// content.
4038   void BeginModule(Module *M) {
4039     this->M = M;
4040   }
4041
4042   /// EndModule - Emit all exception information that should come after the
4043   /// content.
4044   void EndModule() {
4045     if (TimePassesIsEnabled)
4046       ExceptionTimer->startTimer();
4047
4048     if (shouldEmitMovesModule || shouldEmitTableModule) {
4049       const std::vector<Function *> Personalities = MMI->getPersonalities();
4050       for (unsigned i = 0; i < Personalities.size(); ++i)
4051         EmitCommonEHFrame(Personalities[i], i);
4052
4053       for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
4054              E = EHFrames.end(); I != E; ++I)
4055         EmitEHFrame(*I);
4056     }
4057
4058     if (TimePassesIsEnabled)
4059       ExceptionTimer->stopTimer();
4060   }
4061
4062   /// BeginFunction - Gather pre-function exception information.  Assumes being
4063   /// emitted immediately after the function entry point.
4064   void BeginFunction(MachineFunction *MF) {
4065     if (TimePassesIsEnabled)
4066       ExceptionTimer->startTimer();
4067
4068     this->MF = MF;
4069     shouldEmitTable = shouldEmitMoves = false;
4070
4071     if (MMI && TAI->doesSupportExceptionHandling()) {
4072       // Map all labels and get rid of any dead landing pads.
4073       MMI->TidyLandingPads();
4074
4075       // If any landing pads survive, we need an EH table.
4076       if (MMI->getLandingPads().size())
4077         shouldEmitTable = true;
4078
4079       // See if we need frame move info.
4080       if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
4081         shouldEmitMoves = true;
4082
4083       if (shouldEmitMoves || shouldEmitTable)
4084         // Assumes in correct section after the entry point.
4085         EmitLabel("eh_func_begin", ++SubprogramCount);
4086     }
4087
4088     shouldEmitTableModule |= shouldEmitTable;
4089     shouldEmitMovesModule |= shouldEmitMoves;
4090
4091     if (TimePassesIsEnabled)
4092       ExceptionTimer->stopTimer();
4093   }
4094
4095   /// EndFunction - Gather and emit post-function exception information.
4096   ///
4097   void EndFunction() {
4098     if (TimePassesIsEnabled)
4099       ExceptionTimer->startTimer();
4100
4101     if (shouldEmitMoves || shouldEmitTable) {
4102       EmitLabel("eh_func_end", SubprogramCount);
4103       EmitExceptionTable();
4104
4105       // Save EH frame information
4106       EHFrames.
4107         push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
4108                                       SubprogramCount,
4109                                       MMI->getPersonalityIndex(),
4110                                       MF->getFrameInfo()->hasCalls(),
4111                                       !MMI->getLandingPads().empty(),
4112                                       MMI->getFrameMoves(),
4113                                       MF->getFunction()));
4114     }
4115
4116     if (TimePassesIsEnabled)
4117       ExceptionTimer->stopTimer();
4118   }
4119 };
4120
4121 } // End of namespace llvm
4122
4123 //===----------------------------------------------------------------------===//
4124
4125 /// Emit - Print the abbreviation using the specified Dwarf writer.
4126 ///
4127 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
4128   // Emit its Dwarf tag type.
4129   DD.getAsm()->EmitULEB128Bytes(Tag);
4130   DD.getAsm()->EOL(TagString(Tag));
4131
4132   // Emit whether it has children DIEs.
4133   DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
4134   DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
4135
4136   // For each attribute description.
4137   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4138     const DIEAbbrevData &AttrData = Data[i];
4139
4140     // Emit attribute type.
4141     DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
4142     DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
4143
4144     // Emit form type.
4145     DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
4146     DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
4147   }
4148
4149   // Mark end of abbreviation.
4150   DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
4151   DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
4152 }
4153
4154 #ifndef NDEBUG
4155 void DIEAbbrev::print(std::ostream &O) {
4156   O << "Abbreviation @"
4157     << std::hex << (intptr_t)this << std::dec
4158     << "  "
4159     << TagString(Tag)
4160     << " "
4161     << ChildrenString(ChildrenFlag)
4162     << "\n";
4163
4164   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4165     O << "  "
4166       << AttributeString(Data[i].getAttribute())
4167       << "  "
4168       << FormEncodingString(Data[i].getForm())
4169       << "\n";
4170   }
4171 }
4172 void DIEAbbrev::dump() { print(cerr); }
4173 #endif
4174
4175 //===----------------------------------------------------------------------===//
4176
4177 #ifndef NDEBUG
4178 void DIEValue::dump() {
4179   print(cerr);
4180 }
4181 #endif
4182
4183 //===----------------------------------------------------------------------===//
4184
4185 /// EmitValue - Emit integer of appropriate size.
4186 ///
4187 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
4188   switch (Form) {
4189   case DW_FORM_flag:  // Fall thru
4190   case DW_FORM_ref1:  // Fall thru
4191   case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer);         break;
4192   case DW_FORM_ref2:  // Fall thru
4193   case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer);        break;
4194   case DW_FORM_ref4:  // Fall thru
4195   case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer);        break;
4196   case DW_FORM_ref8:  // Fall thru
4197   case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer);        break;
4198   case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
4199   case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
4200   default: assert(0 && "DIE Value form not supported yet");   break;
4201   }
4202 }
4203
4204 /// SizeOf - Determine size of integer value in bytes.
4205 ///
4206 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4207   switch (Form) {
4208   case DW_FORM_flag:  // Fall thru
4209   case DW_FORM_ref1:  // Fall thru
4210   case DW_FORM_data1: return sizeof(int8_t);
4211   case DW_FORM_ref2:  // Fall thru
4212   case DW_FORM_data2: return sizeof(int16_t);
4213   case DW_FORM_ref4:  // Fall thru
4214   case DW_FORM_data4: return sizeof(int32_t);
4215   case DW_FORM_ref8:  // Fall thru
4216   case DW_FORM_data8: return sizeof(int64_t);
4217   case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
4218   case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
4219   default: assert(0 && "DIE Value form not supported yet"); break;
4220   }
4221   return 0;
4222 }
4223
4224 //===----------------------------------------------------------------------===//
4225
4226 /// EmitValue - Emit string value.
4227 ///
4228 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
4229   DD.getAsm()->EmitString(Str);
4230 }
4231
4232 //===----------------------------------------------------------------------===//
4233
4234 /// EmitValue - Emit label value.
4235 ///
4236 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4237   bool IsSmall = Form == DW_FORM_data4;
4238   DD.EmitReference(Label, false, IsSmall);
4239 }
4240
4241 /// SizeOf - Determine size of label value in bytes.
4242 ///
4243 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4244   if (Form == DW_FORM_data4) return 4;
4245   return DD.getTargetData()->getPointerSize();
4246 }
4247
4248 //===----------------------------------------------------------------------===//
4249
4250 /// EmitValue - Emit label value.
4251 ///
4252 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4253   bool IsSmall = Form == DW_FORM_data4;
4254   DD.EmitReference(Label, false, IsSmall);
4255 }
4256
4257 /// SizeOf - Determine size of label value in bytes.
4258 ///
4259 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4260   if (Form == DW_FORM_data4) return 4;
4261   return DD.getTargetData()->getPointerSize();
4262 }
4263
4264 //===----------------------------------------------------------------------===//
4265
4266 /// EmitValue - Emit delta value.
4267 ///
4268 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4269   bool IsSmall = Form == DW_FORM_data4;
4270   DD.EmitSectionOffset(Label.Tag, Section.Tag,
4271                        Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4272 }
4273
4274 /// SizeOf - Determine size of delta value in bytes.
4275 ///
4276 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4277   if (Form == DW_FORM_data4) return 4;
4278   return DD.getTargetData()->getPointerSize();
4279 }
4280
4281 //===----------------------------------------------------------------------===//
4282
4283 /// EmitValue - Emit delta value.
4284 ///
4285 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4286   bool IsSmall = Form == DW_FORM_data4;
4287   DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4288 }
4289
4290 /// SizeOf - Determine size of delta value in bytes.
4291 ///
4292 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4293   if (Form == DW_FORM_data4) return 4;
4294   return DD.getTargetData()->getPointerSize();
4295 }
4296
4297 //===----------------------------------------------------------------------===//
4298
4299 /// EmitValue - Emit debug information entry offset.
4300 ///
4301 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4302   DD.getAsm()->EmitInt32(Entry->getOffset());
4303 }
4304
4305 //===----------------------------------------------------------------------===//
4306
4307 /// ComputeSize - calculate the size of the block.
4308 ///
4309 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4310   if (!Size) {
4311     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4312
4313     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4314       Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4315     }
4316   }
4317   return Size;
4318 }
4319
4320 /// EmitValue - Emit block data.
4321 ///
4322 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4323   switch (Form) {
4324   case DW_FORM_block1: DD.getAsm()->EmitInt8(Size);         break;
4325   case DW_FORM_block2: DD.getAsm()->EmitInt16(Size);        break;
4326   case DW_FORM_block4: DD.getAsm()->EmitInt32(Size);        break;
4327   case DW_FORM_block:  DD.getAsm()->EmitULEB128Bytes(Size); break;
4328   default: assert(0 && "Improper form for block");          break;
4329   }
4330
4331   const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4332
4333   for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4334     DD.getAsm()->EOL();
4335     Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4336   }
4337 }
4338
4339 /// SizeOf - Determine size of block data in bytes.
4340 ///
4341 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4342   switch (Form) {
4343   case DW_FORM_block1: return Size + sizeof(int8_t);
4344   case DW_FORM_block2: return Size + sizeof(int16_t);
4345   case DW_FORM_block4: return Size + sizeof(int32_t);
4346   case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
4347   default: assert(0 && "Improper form for block"); break;
4348   }
4349   return 0;
4350 }
4351
4352 //===----------------------------------------------------------------------===//
4353 /// DIE Implementation
4354
4355 DIE::~DIE() {
4356   for (unsigned i = 0, N = Children.size(); i < N; ++i)
4357     delete Children[i];
4358 }
4359
4360 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4361 ///
4362 void DIE::AddSiblingOffset() {
4363   DIEInteger *DI = new DIEInteger(0);
4364   Values.insert(Values.begin(), DI);
4365   Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4366 }
4367
4368 /// Profile - Used to gather unique data for the value folding set.
4369 ///
4370 void DIE::Profile(FoldingSetNodeID &ID) {
4371   Abbrev.Profile(ID);
4372
4373   for (unsigned i = 0, N = Children.size(); i < N; ++i)
4374     ID.AddPointer(Children[i]);
4375
4376   for (unsigned j = 0, M = Values.size(); j < M; ++j)
4377     ID.AddPointer(Values[j]);
4378 }
4379
4380 #ifndef NDEBUG
4381 void DIE::print(std::ostream &O, unsigned IncIndent) {
4382   static unsigned IndentCount = 0;
4383   IndentCount += IncIndent;
4384   const std::string Indent(IndentCount, ' ');
4385   bool isBlock = Abbrev.getTag() == 0;
4386
4387   if (!isBlock) {
4388     O << Indent
4389       << "Die: "
4390       << "0x" << std::hex << (intptr_t)this << std::dec
4391       << ", Offset: " << Offset
4392       << ", Size: " << Size
4393       << "\n";
4394
4395     O << Indent
4396       << TagString(Abbrev.getTag())
4397       << " "
4398       << ChildrenString(Abbrev.getChildrenFlag());
4399   } else {
4400     O << "Size: " << Size;
4401   }
4402   O << "\n";
4403
4404   const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
4405
4406   IndentCount += 2;
4407   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4408     O << Indent;
4409
4410     if (!isBlock)
4411       O << AttributeString(Data[i].getAttribute());
4412     else
4413       O << "Blk[" << i << "]";
4414
4415     O <<  "  "
4416       << FormEncodingString(Data[i].getForm())
4417       << " ";
4418     Values[i]->print(O);
4419     O << "\n";
4420   }
4421   IndentCount -= 2;
4422
4423   for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4424     Children[j]->print(O, 4);
4425   }
4426
4427   if (!isBlock) O << "\n";
4428   IndentCount -= IncIndent;
4429 }
4430
4431 void DIE::dump() {
4432   print(cerr);
4433 }
4434 #endif
4435
4436 //===----------------------------------------------------------------------===//
4437 /// DwarfWriter Implementation
4438 ///
4439
4440 DwarfWriter::DwarfWriter()
4441   : ImmutablePass(&ID), DD(0), DE(0) {}
4442
4443 DwarfWriter::~DwarfWriter() {
4444   delete DE;
4445   delete DD;
4446 }
4447
4448 /// BeginModule - Emit all Dwarf sections that should come prior to the
4449 /// content.
4450 void DwarfWriter::BeginModule(Module *M,
4451                               MachineModuleInfo *MMI,
4452                               raw_ostream &OS, AsmPrinter *A,
4453                               const TargetAsmInfo *T) {
4454   DE = new DwarfException(OS, A, T);
4455   DD = new DwarfDebug(OS, A, T);
4456   DE->BeginModule(M);
4457   DD->BeginModule(M);
4458   DD->SetDebugInfo(MMI);
4459   DE->SetModuleInfo(MMI);
4460 }
4461
4462 /// EndModule - Emit all Dwarf sections that should come after the content.
4463 ///
4464 void DwarfWriter::EndModule() {
4465   DE->EndModule();
4466   DD->EndModule();
4467 }
4468
4469 /// BeginFunction - Gather pre-function debug information.  Assumes being
4470 /// emitted immediately after the function entry point.
4471 void DwarfWriter::BeginFunction(MachineFunction *MF) {
4472   DE->BeginFunction(MF);
4473   DD->BeginFunction(MF);
4474 }
4475
4476 /// EndFunction - Gather and emit post-function debug information.
4477 ///
4478 void DwarfWriter::EndFunction(MachineFunction *MF) {
4479   DD->EndFunction(MF);
4480   DE->EndFunction();
4481
4482   if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
4483     // Clear function debug information.
4484     MMI->EndFunction();
4485 }
4486
4487 /// ValidDebugInfo - Return true if V represents valid debug info value.
4488 bool DwarfWriter::ValidDebugInfo(Value *V) {
4489   return DD && DD->ValidDebugInfo(V);
4490 }
4491
4492 /// RecordSourceLine - Records location information and associates it with a
4493 /// label. Returns a unique label ID used to generate a label and provide
4494 /// correspondence to the source line list.
4495 unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4496                                        unsigned Src) {
4497   return DD->RecordSourceLine(Line, Col, Src);
4498 }
4499
4500 /// getOrCreateSourceID - Look up the source id with the given directory and
4501 /// source file names. If none currently exists, create a new id and insert it
4502 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
4503 /// as well.
4504 unsigned DwarfWriter::getOrCreateSourceID(const std::string &DirName,
4505                                           const std::string &FileName) {
4506   return DD->getOrCreateSourceID(DirName, FileName);
4507 }
4508
4509 /// RecordRegionStart - Indicate the start of a region.
4510 unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4511   return DD->RecordRegionStart(V);
4512 }
4513
4514 /// RecordRegionEnd - Indicate the end of a region.
4515 unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4516   return DD->RecordRegionEnd(V);
4517 }
4518
4519 /// getRecordSourceLineCount - Count source lines.
4520 unsigned DwarfWriter::getRecordSourceLineCount() {
4521   return DD->getRecordSourceLineCount();
4522 }
4523
4524 /// RecordVariable - Indicate the declaration of  a local variable.
4525 ///
4526 void DwarfWriter::RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
4527   DD->RecordVariable(GV, FrameIndex);
4528 }
4529
4530 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
4531 /// be emitted.
4532 bool DwarfWriter::ShouldEmitDwarfDebug() const {
4533   return DD->ShouldEmitDwarfDebug();
4534 }