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