lib/CodeGen/AsmPrinter/DwarfWriter.cpp

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