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