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     const std::string &Name = BTy.getName();
1626     Buffer.setTag(DW_TAG_base_type);
1627     AddUInt(&Buffer, DW_AT_encoding,  DW_FORM_data1, BTy.getEncoding());
1628     // Add name if not anonymous or intermediate type.
1629     if (!Name.empty())
1630       AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1631     uint64_t Size = BTy.getSizeInBits() >> 3;
1632     AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1633   }
1634
1635   /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1636   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1637                         DIDerivedType DTy) {
1638
1639     // Get core information.
1640     const std::string &Name = DTy.getName();
1641     uint64_t Size = DTy.getSizeInBits() >> 3;
1642     unsigned Tag = DTy.getTag();
1643     // FIXME - Workaround for templates.
1644     if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1645
1646     Buffer.setTag(Tag);
1647     // Map to main type, void will not have a type.
1648     DIType FromTy = DTy.getTypeDerivedFrom();
1649     AddType(DW_Unit, &Buffer, FromTy);
1650
1651     // Add name if not anonymous or intermediate type.
1652     if (!Name.empty())
1653       AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1654
1655     // Add size if non-zero (derived types might be zero-sized.)
1656     if (Size)
1657       AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1658
1659     // Add source line info if available and TyDesc is not a forward
1660     // declaration.
1661     if (!DTy.isForwardDecl())
1662       AddSourceLine(&Buffer, &DTy);
1663   }
1664
1665   /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1666   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1667                         DICompositeType CTy) {
1668
1669     // Get core information.
1670     const std::string &Name = CTy.getName();
1671     uint64_t Size = CTy.getSizeInBits() >> 3;
1672     unsigned Tag = CTy.getTag();
1673     Buffer.setTag(Tag);
1674     switch (Tag) {
1675     case DW_TAG_vector_type:
1676     case DW_TAG_array_type:
1677       ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
1678       break;
1679     case DW_TAG_enumeration_type:
1680       {
1681         DIArray Elements = CTy.getTypeArray();
1682         // Add enumerators to enumeration type.
1683         for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1684           DIE *ElemDie = NULL;
1685           DIEnumerator Enum(Elements.getElement(i).getGV());
1686           ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
1687           Buffer.AddChild(ElemDie);
1688         }
1689       }
1690       break;
1691     case DW_TAG_subroutine_type:
1692       {
1693         // Add prototype flag.
1694         AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1695         DIArray Elements = CTy.getTypeArray();
1696         // Add return type.
1697         DIDescriptor RTy = Elements.getElement(0);
1698         AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
1699
1700         // Add arguments.
1701         for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1702           DIE *Arg = new DIE(DW_TAG_formal_parameter);
1703           DIDescriptor Ty = Elements.getElement(i);
1704           AddType(DW_Unit, Arg, DIType(Ty.getGV()));
1705           Buffer.AddChild(Arg);
1706         }
1707       }
1708       break;
1709     case DW_TAG_structure_type:
1710     case DW_TAG_union_type:
1711       {
1712         // Add elements to structure type.
1713         DIArray Elements = CTy.getTypeArray();
1714
1715         // A forward struct declared type may not have elements available.
1716         if (Elements.isNull())
1717           break;
1718
1719         // Add elements to structure type.
1720         for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1721           DIDescriptor Element = Elements.getElement(i);
1722           DIE *ElemDie = NULL;
1723           if (Element.getTag() == dwarf::DW_TAG_subprogram)
1724             ElemDie = CreateSubprogramDIE(DW_Unit,
1725                                           DISubprogram(Element.getGV()));
1726           else if (Element.getTag() == dwarf::DW_TAG_variable) // ???
1727             ElemDie = CreateGlobalVariableDIE(DW_Unit,
1728                                               DIGlobalVariable(Element.getGV()));
1729           else
1730             ElemDie = CreateMemberDIE(DW_Unit,
1731                                       DIDerivedType(Element.getGV()));
1732           Buffer.AddChild(ElemDie);
1733         }
1734         unsigned RLang = CTy.getRunTimeLang();
1735         if (RLang)
1736           AddUInt(&Buffer, DW_AT_APPLE_runtime_class, DW_FORM_data1, RLang);
1737       }
1738       break;
1739     default:
1740       break;
1741     }
1742
1743     // Add name if not anonymous or intermediate type.
1744     if (!Name.empty())
1745       AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1746
1747     if (Tag == DW_TAG_enumeration_type || Tag == DW_TAG_structure_type
1748         || Tag == DW_TAG_union_type) {
1749       // Add size if non-zero (derived types might be zero-sized.)
1750       if (Size)
1751         AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1752       else {
1753         // Add zero size if it is not a forward declaration.
1754         if (CTy.isForwardDecl())
1755           AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1756         else
1757           AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1758       }
1759
1760       // Add source line info if available.
1761       if (!CTy.isForwardDecl())
1762         AddSourceLine(&Buffer, &CTy);
1763     }
1764   }
1765
1766   /// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1767   void ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy) {
1768     int64_t L = SR.getLo();
1769     int64_t H = SR.getHi();
1770     DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1771     if (L != H) {
1772       AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1773       if (L)
1774         AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1775       AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1776     }
1777     Buffer.AddChild(DW_Subrange);
1778   }
1779
1780   /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1781   void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1782                              DICompositeType *CTy) {
1783     Buffer.setTag(DW_TAG_array_type);
1784     if (CTy->getTag() == DW_TAG_vector_type)
1785       AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1786
1787     // Emit derived type.
1788     AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1789     DIArray Elements = CTy->getTypeArray();
1790
1791     // Construct an anonymous type for index type.
1792     DIE IdxBuffer(DW_TAG_base_type);
1793     AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1794     AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1795     DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1796
1797     // Add subranges to array type.
1798     for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1799       DIDescriptor Element = Elements.getElement(i);
1800       if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1801         ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
1802     }
1803   }
1804
1805   /// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
1806   DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
1807
1808     DIE *Enumerator = new DIE(DW_TAG_enumerator);
1809     const std::string &Name = ETy->getName();
1810     AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1811     int64_t Value = ETy->getEnumValue();
1812     AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1813     return Enumerator;
1814   }
1815
1816   /// CreateGlobalVariableDIE - Create new DIE using GV.
1817   DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit, const DIGlobalVariable &GV)
1818   {
1819     DIE *GVDie = new DIE(DW_TAG_variable);
1820     const std::string &Name = GV.getDisplayName();
1821     AddString(GVDie, DW_AT_name, DW_FORM_string, Name);
1822     const std::string &LinkageName = GV.getLinkageName();
1823     if (!LinkageName.empty())
1824       AddString(GVDie, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1825     AddType(DW_Unit, GVDie, GV.getType());
1826     if (!GV.isLocalToUnit())
1827       AddUInt(GVDie, DW_AT_external, DW_FORM_flag, 1);
1828     AddSourceLine(GVDie, &GV);
1829     return GVDie;
1830   }
1831
1832   /// CreateMemberDIE - Create new member DIE.
1833   DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT) {
1834     DIE *MemberDie = new DIE(DT.getTag());
1835     const std::string &Name = DT.getName();
1836     if (!Name.empty())
1837       AddString(MemberDie, DW_AT_name, DW_FORM_string, Name);
1838
1839     AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom());
1840
1841     AddSourceLine(MemberDie, &DT);
1842
1843     uint64_t Size = DT.getSizeInBits();
1844     uint64_t FieldSize = DT.getOriginalTypeSize();
1845
1846     if (Size != FieldSize) {
1847       // Handle bitfield.
1848       AddUInt(MemberDie, DW_AT_byte_size, 0, DT.getOriginalTypeSize() >> 3);
1849       AddUInt(MemberDie, DW_AT_bit_size, 0, DT.getSizeInBits());
1850
1851       uint64_t Offset = DT.getOffsetInBits();
1852       uint64_t FieldOffset = Offset;
1853       uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1854       uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1855       FieldOffset = (HiMark - FieldSize);
1856       Offset -= FieldOffset;
1857       // Maybe we need to work from the other end.
1858       if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1859       AddUInt(MemberDie, DW_AT_bit_offset, 0, Offset);
1860     }
1861     DIEBlock *Block = new DIEBlock();
1862     AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1863     AddUInt(Block, 0, DW_FORM_udata, DT.getOffsetInBits() >> 3);
1864     AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1865
1866     if (DT.isProtected())
1867       AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_protected);
1868     else if (DT.isPrivate())
1869       AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_private);
1870
1871     return MemberDie;
1872   }
1873
1874   /// CreateSubprogramDIE - Create new DIE using SP.
1875   DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
1876                            const  DISubprogram &SP,
1877                            bool IsConstructor = false) {
1878     DIE *SPDie = new DIE(DW_TAG_subprogram);
1879     const std::string &Name = SP.getName();
1880     AddString(SPDie, DW_AT_name, DW_FORM_string, Name);
1881     const std::string &LinkageName = SP.getLinkageName();
1882     if (!LinkageName.empty())
1883       AddString(SPDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1884                 LinkageName);
1885     AddSourceLine(SPDie, &SP);
1886
1887     DICompositeType SPTy = SP.getType();
1888     DIArray Args = SPTy.getTypeArray();
1889
1890     // Add Return Type.
1891     if (!IsConstructor) {
1892       if (Args.isNull())
1893         AddType(DW_Unit, SPDie, SPTy);
1894       else
1895         AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getGV()));
1896     }
1897
1898     if (!SP.isDefinition()) {
1899       AddUInt(SPDie, DW_AT_declaration, DW_FORM_flag, 1);
1900       // Add arguments.
1901       // Do not add arguments for subprogram definition. They will be
1902       // handled through RecordVariable.
1903       if (!Args.isNull())
1904         for (unsigned i = 1, N =  Args.getNumElements(); i < N; ++i) {
1905           DIE *Arg = new DIE(DW_TAG_formal_parameter);
1906           AddType(DW_Unit, Arg, DIType(Args.getElement(i).getGV()));
1907           AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1908           SPDie->AddChild(Arg);
1909         }
1910     }
1911
1912     unsigned Lang = SP.getCompileUnit().getLanguage();
1913     if (Lang == DW_LANG_C99 || Lang == DW_LANG_C89
1914         || Lang == DW_LANG_ObjC)
1915       AddUInt(SPDie, DW_AT_prototyped, DW_FORM_flag, 1);
1916
1917     if (!SP.isLocalToUnit())
1918       AddUInt(SPDie, DW_AT_external, DW_FORM_flag, 1);
1919     return SPDie;
1920   }
1921
1922   /// FindCompileUnit - Get the compile unit for the given descriptor.
1923   ///
1924   CompileUnit *FindCompileUnit(DICompileUnit Unit) {
1925     CompileUnit *DW_Unit = CompileUnitMap[Unit.getGV()];
1926     assert(DW_Unit && "Missing compile unit.");
1927     return DW_Unit;
1928   }
1929
1930   /// NewDbgScopeVariable - Create a new scope variable.
1931   ///
1932   DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
1933     // Get the descriptor.
1934     const DIVariable &VD = DV->getVariable();
1935
1936     // Translate tag to proper Dwarf tag.  The result variable is dropped for
1937     // now.
1938     unsigned Tag;
1939     switch (VD.getTag()) {
1940     case DW_TAG_return_variable:  return NULL;
1941     case DW_TAG_arg_variable:     Tag = DW_TAG_formal_parameter; break;
1942     case DW_TAG_auto_variable:    // fall thru
1943     default:                      Tag = DW_TAG_variable; break;
1944     }
1945
1946     // Define variable debug information entry.
1947     DIE *VariableDie = new DIE(Tag);
1948     const std::string &Name = VD.getName();
1949     AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
1950
1951     // Add source line info if available.
1952     AddSourceLine(VariableDie, &VD);
1953
1954     // Add variable type.
1955     AddType(Unit, VariableDie, VD.getType());
1956
1957     // Add variable address.
1958     MachineLocation Location;
1959     Location.set(RI->getFrameRegister(*MF),
1960                  RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1961     AddAddress(VariableDie, DW_AT_location, Location);
1962
1963     return VariableDie;
1964   }
1965
1966   /// getOrCreateScope - Returns the scope associated with the given descriptor.
1967   ///
1968   DbgScope *getOrCreateScope(GlobalVariable *V) {
1969     DbgScope *&Slot = DbgScopeMap[V];
1970     if (Slot) return Slot;
1971
1972     // FIXME - breaks down when the context is an inlined function.
1973     DIDescriptor ParentDesc;
1974     DIDescriptor Desc(V);
1975
1976     if (Desc.getTag() == dwarf::DW_TAG_lexical_block) {
1977       DIBlock Block(V);
1978       ParentDesc = Block.getContext();
1979     }
1980
1981     DbgScope *Parent = ParentDesc.isNull() ?
1982       NULL : getOrCreateScope(ParentDesc.getGV());
1983     Slot = new DbgScope(Parent, Desc);
1984
1985     if (Parent) {
1986       Parent->AddScope(Slot);
1987     } else if (RootDbgScope) {
1988       // FIXME - Add inlined function scopes to the root so we can delete them
1989       // later.  Long term, handle inlined functions properly.
1990       RootDbgScope->AddScope(Slot);
1991     } else {
1992       // First function is top level function.
1993       RootDbgScope = Slot;
1994     }
1995
1996     return Slot;
1997   }
1998
1999   /// ConstructDbgScope - Construct the components of a scope.
2000   ///
2001   void ConstructDbgScope(DbgScope *ParentScope,
2002                          unsigned ParentStartID, unsigned ParentEndID,
2003                          DIE *ParentDie, CompileUnit *Unit) {
2004     // Add variables to scope.
2005     SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
2006     for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2007       DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2008       if (VariableDie) ParentDie->AddChild(VariableDie);
2009     }
2010
2011     // Add nested scopes.
2012     SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
2013     for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2014       // Define the Scope debug information entry.
2015       DbgScope *Scope = Scopes[j];
2016       // FIXME - Ignore inlined functions for the time being.
2017       if (!Scope->getParent()) continue;
2018
2019       unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2020       unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2021
2022       // Ignore empty scopes.
2023       if (StartID == EndID && StartID != 0) continue;
2024       if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2025
2026       if (StartID == ParentStartID && EndID == ParentEndID) {
2027         // Just add stuff to the parent scope.
2028         ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2029       } else {
2030         DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2031
2032         // Add the scope bounds.
2033         if (StartID) {
2034           AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2035                              DWLabel("label", StartID));
2036         } else {
2037           AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2038                              DWLabel("func_begin", SubprogramCount));
2039         }
2040         if (EndID) {
2041           AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2042                              DWLabel("label", EndID));
2043         } else {
2044           AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2045                              DWLabel("func_end", SubprogramCount));
2046         }
2047
2048         // Add the scope contents.
2049         ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2050         ParentDie->AddChild(ScopeDie);
2051       }
2052     }
2053   }
2054
2055   /// ConstructRootDbgScope - Construct the scope for the subprogram.
2056   ///
2057   void ConstructRootDbgScope(DbgScope *RootScope) {
2058     // Exit if there is no root scope.
2059     if (!RootScope) return;
2060     DIDescriptor Desc = RootScope->getDesc();
2061     if (Desc.isNull())
2062       return;
2063
2064     // Get the subprogram debug information entry.
2065     DISubprogram SPD(Desc.getGV());
2066
2067     // Get the compile unit context.
2068     CompileUnit *Unit = MainCU;
2069     if (!Unit)
2070       Unit = FindCompileUnit(SPD.getCompileUnit());
2071
2072     // Get the subprogram die.
2073     DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2074     assert(SPDie && "Missing subprogram descriptor");
2075
2076     // Add the function bounds.
2077     AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2078                     DWLabel("func_begin", SubprogramCount));
2079     AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2080                     DWLabel("func_end", SubprogramCount));
2081     MachineLocation Location(RI->getFrameRegister(*MF));
2082     AddAddress(SPDie, DW_AT_frame_base, Location);
2083
2084     ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2085   }
2086
2087   /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2088   ///
2089   void ConstructDefaultDbgScope(MachineFunction *MF) {
2090     const char *FnName = MF->getFunction()->getNameStart();
2091     if (MainCU) {
2092       std::map<std::string, DIE*> &Globals = MainCU->getGlobals();
2093       std::map<std::string, DIE*>::iterator GI = Globals.find(FnName);
2094       if (GI != Globals.end()) {
2095         DIE *SPDie = GI->second;
2096
2097         // Add the function bounds.
2098         AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2099                  DWLabel("func_begin", SubprogramCount));
2100         AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2101                  DWLabel("func_end", SubprogramCount));
2102
2103         MachineLocation Location(RI->getFrameRegister(*MF));
2104         AddAddress(SPDie, DW_AT_frame_base, Location);
2105         return;
2106       }
2107     } else {
2108       for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i) {
2109         CompileUnit *Unit = CompileUnits[i];
2110         std::map<std::string, DIE*> &Globals = Unit->getGlobals();
2111         std::map<std::string, DIE*>::iterator GI = Globals.find(FnName);
2112         if (GI != Globals.end()) {
2113           DIE *SPDie = GI->second;
2114
2115           // Add the function bounds.
2116           AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2117                    DWLabel("func_begin", SubprogramCount));
2118           AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2119                    DWLabel("func_end", SubprogramCount));
2120
2121           MachineLocation Location(RI->getFrameRegister(*MF));
2122           AddAddress(SPDie, DW_AT_frame_base, Location);
2123           return;
2124         }
2125       }
2126     }
2127
2128 #if 0
2129     // FIXME: This is causing an abort because C++ mangled names are compared
2130     // with their unmangled counterparts. See PR2885. Don't do this assert.
2131     assert(0 && "Couldn't find DIE for machine function!");
2132 #endif
2133     return;
2134   }
2135
2136   /// EmitInitial - Emit initial Dwarf declarations.  This is necessary for cc
2137   /// tools to recognize the object file contains Dwarf information.
2138   void EmitInitial() {
2139     // Check to see if we already emitted intial headers.
2140     if (didInitial) return;
2141     didInitial = true;
2142
2143     // Dwarf sections base addresses.
2144     if (TAI->doesDwarfRequireFrameSection()) {
2145       Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2146       EmitLabel("section_debug_frame", 0);
2147     }
2148     Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2149     EmitLabel("section_info", 0);
2150     Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2151     EmitLabel("section_abbrev", 0);
2152     Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2153     EmitLabel("section_aranges", 0);
2154     if (TAI->doesSupportMacInfoSection()) {
2155       Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2156       EmitLabel("section_macinfo", 0);
2157     }
2158     Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2159     EmitLabel("section_line", 0);
2160     Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2161     EmitLabel("section_loc", 0);
2162     Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2163     EmitLabel("section_pubnames", 0);
2164     Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2165     EmitLabel("section_str", 0);
2166     Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2167     EmitLabel("section_ranges", 0);
2168
2169     Asm->SwitchToSection(TAI->getTextSection());
2170     EmitLabel("text_begin", 0);
2171     Asm->SwitchToSection(TAI->getDataSection());
2172     EmitLabel("data_begin", 0);
2173   }
2174
2175   /// EmitDIE - Recusively Emits a debug information entry.
2176   ///
2177   void EmitDIE(DIE *Die) {
2178     // Get the abbreviation for this DIE.
2179     unsigned AbbrevNumber = Die->getAbbrevNumber();
2180     const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2181
2182     Asm->EOL();
2183
2184     // Emit the code (index) for the abbreviation.
2185     Asm->EmitULEB128Bytes(AbbrevNumber);
2186
2187     if (VerboseAsm)
2188       Asm->EOL(std::string("Abbrev [" +
2189                            utostr(AbbrevNumber) +
2190                            "] 0x" + utohexstr(Die->getOffset()) +
2191                            ":0x" + utohexstr(Die->getSize()) + " " +
2192                            TagString(Abbrev->getTag())));
2193     else
2194       Asm->EOL();
2195
2196     SmallVector<DIEValue*, 32> &Values = Die->getValues();
2197     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2198
2199     // Emit the DIE attribute values.
2200     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2201       unsigned Attr = AbbrevData[i].getAttribute();
2202       unsigned Form = AbbrevData[i].getForm();
2203       assert(Form && "Too many attributes for DIE (check abbreviation)");
2204
2205       switch (Attr) {
2206       case DW_AT_sibling: {
2207         Asm->EmitInt32(Die->SiblingOffset());
2208         break;
2209       }
2210       default: {
2211         // Emit an attribute using the defined form.
2212         Values[i]->EmitValue(*this, Form);
2213         break;
2214       }
2215       }
2216
2217       Asm->EOL(AttributeString(Attr));
2218     }
2219
2220     // Emit the DIE children if any.
2221     if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2222       const std::vector<DIE *> &Children = Die->getChildren();
2223
2224       for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2225         EmitDIE(Children[j]);
2226       }
2227
2228       Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2229     }
2230   }
2231
2232   /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2233   ///
2234   unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2235     // Get the children.
2236     const std::vector<DIE *> &Children = Die->getChildren();
2237
2238     // If not last sibling and has children then add sibling offset attribute.
2239     if (!Last && !Children.empty()) Die->AddSiblingOffset();
2240
2241     // Record the abbreviation.
2242     AssignAbbrevNumber(Die->getAbbrev());
2243
2244     // Get the abbreviation for this DIE.
2245     unsigned AbbrevNumber = Die->getAbbrevNumber();
2246     const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2247
2248     // Set DIE offset
2249     Die->setOffset(Offset);
2250
2251     // Start the size with the size of abbreviation code.
2252     Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2253
2254     const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2255     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2256
2257     // Size the DIE attribute values.
2258     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2259       // Size attribute value.
2260       Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2261     }
2262
2263     // Size the DIE children if any.
2264     if (!Children.empty()) {
2265       assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2266              "Children flag not set");
2267
2268       for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2269         Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2270       }
2271
2272       // End of children marker.
2273       Offset += sizeof(int8_t);
2274     }
2275
2276     Die->setSize(Offset - Die->getOffset());
2277     return Offset;
2278   }
2279
2280   /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2281   ///
2282   void SizeAndOffsets() {
2283     // Process base compile unit.
2284     if (MainCU) {
2285       // Compute size of compile unit header
2286       unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2287         sizeof(int16_t) + // DWARF version number
2288         sizeof(int32_t) + // Offset Into Abbrev. Section
2289         sizeof(int8_t);   // Pointer Size (in bytes)
2290       SizeAndOffsetDie(MainCU->getDie(), Offset, true);
2291       return;
2292     }
2293     for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i) {
2294       CompileUnit *Unit = CompileUnits[i];
2295       // Compute size of compile unit header
2296       unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2297         sizeof(int16_t) + // DWARF version number
2298         sizeof(int32_t) + // Offset Into Abbrev. Section
2299         sizeof(int8_t);   // Pointer Size (in bytes)
2300       SizeAndOffsetDie(Unit->getDie(), Offset, true);
2301     }
2302   }
2303
2304   /// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
2305   ///
2306   void EmitDebugInfoPerCU(CompileUnit *Unit) {
2307     DIE *Die = Unit->getDie();
2308     // Emit the compile units header.
2309     EmitLabel("info_begin", Unit->getID());
2310     // Emit size of content not including length itself
2311     unsigned ContentSize = Die->getSize() +
2312       sizeof(int16_t) + // DWARF version number
2313       sizeof(int32_t) + // Offset Into Abbrev. Section
2314       sizeof(int8_t) +  // Pointer Size (in bytes)
2315       sizeof(int32_t);  // FIXME - extra pad for gdb bug.
2316
2317     Asm->EmitInt32(ContentSize);  Asm->EOL("Length of Compilation Unit Info");
2318     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2319     EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2320     Asm->EOL("Offset Into Abbrev. Section");
2321     Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2322
2323     EmitDIE(Die);
2324     // FIXME - extra padding for gdb bug.
2325     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2326     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2327     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2328     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2329     EmitLabel("info_end", Unit->getID());
2330
2331     Asm->EOL();
2332   }
2333
2334   void EmitDebugInfo() {
2335     // Start debug info section.
2336     Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2337
2338     if (MainCU) {
2339       EmitDebugInfoPerCU(MainCU);
2340       return;
2341     }
2342
2343     for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i)
2344       EmitDebugInfoPerCU(CompileUnits[i]);
2345   }
2346
2347   /// EmitAbbreviations - Emit the abbreviation section.
2348   ///
2349   void EmitAbbreviations() const {
2350     // Check to see if it is worth the effort.
2351     if (!Abbreviations.empty()) {
2352       // Start the debug abbrev section.
2353       Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2354
2355       EmitLabel("abbrev_begin", 0);
2356
2357       // For each abbrevation.
2358       for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2359         // Get abbreviation data
2360         const DIEAbbrev *Abbrev = Abbreviations[i];
2361
2362         // Emit the abbrevations code (base 1 index.)
2363         Asm->EmitULEB128Bytes(Abbrev->getNumber());
2364         Asm->EOL("Abbreviation Code");
2365
2366         // Emit the abbreviations data.
2367         Abbrev->Emit(*this);
2368
2369         Asm->EOL();
2370       }
2371
2372       // Mark end of abbreviations.
2373       Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2374
2375       EmitLabel("abbrev_end", 0);
2376
2377       Asm->EOL();
2378     }
2379   }
2380
2381   /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2382   /// the line matrix.
2383   ///
2384   void EmitEndOfLineMatrix(unsigned SectionEnd) {
2385     // Define last address of section.
2386     Asm->EmitInt8(0); Asm->EOL("Extended Op");
2387     Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2388     Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2389     EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2390
2391     // Mark end of matrix.
2392     Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2393     Asm->EmitULEB128Bytes(1); Asm->EOL();
2394     Asm->EmitInt8(1); Asm->EOL();
2395   }
2396
2397   /// EmitDebugLines - Emit source line information.
2398   ///
2399   void EmitDebugLines() {
2400     // If the target is using .loc/.file, the assembler will be emitting the
2401     // .debug_line table automatically.
2402     if (TAI->hasDotLocAndDotFile())
2403       return;
2404
2405     // Minimum line delta, thus ranging from -10..(255-10).
2406     const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2407     // Maximum line delta, thus ranging from -10..(255-10).
2408     const int MaxLineDelta = 255 + MinLineDelta;
2409
2410     // Start the dwarf line section.
2411     Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2412
2413     // Construct the section header.
2414
2415     EmitDifference("line_end", 0, "line_begin", 0, true);
2416     Asm->EOL("Length of Source Line Info");
2417     EmitLabel("line_begin", 0);
2418
2419     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2420
2421     EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2422     Asm->EOL("Prolog Length");
2423     EmitLabel("line_prolog_begin", 0);
2424
2425     Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2426
2427     Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2428
2429     Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2430
2431     Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2432
2433     Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2434
2435     // Line number standard opcode encodings argument count
2436     Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2437     Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2438     Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2439     Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2440     Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2441     Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2442     Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2443     Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2444     Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2445
2446     // Emit directories.
2447     for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2448       Asm->EmitString(getSourceDirectoryName(DI));
2449       Asm->EOL("Directory");
2450     }
2451     Asm->EmitInt8(0); Asm->EOL("End of directories");
2452
2453     // Emit files.
2454     for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2455       // Remember source id starts at 1.
2456       std::pair<unsigned, unsigned> Id = getSourceDirsectoryAndFileIds(SI);
2457       Asm->EmitString(getSourceFileName(Id.second));
2458       Asm->EOL("Source");
2459       Asm->EmitULEB128Bytes(Id.first);
2460       Asm->EOL("Directory #");
2461       Asm->EmitULEB128Bytes(0);
2462       Asm->EOL("Mod date");
2463       Asm->EmitULEB128Bytes(0);
2464       Asm->EOL("File size");
2465     }
2466     Asm->EmitInt8(0); Asm->EOL("End of files");
2467
2468     EmitLabel("line_prolog_end", 0);
2469
2470     // A sequence for each text section.
2471     unsigned SecSrcLinesSize = SectionSourceLines.size();
2472
2473     for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2474       // Isolate current sections line info.
2475       const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2476
2477       if (VerboseAsm) {
2478         const Section* S = SectionMap[j + 1];
2479         O << '\t' << TAI->getCommentString() << " Section"
2480           << S->getName() << '\n';
2481       } else
2482         Asm->EOL();
2483
2484       // Dwarf assumes we start with first line of first source file.
2485       unsigned Source = 1;
2486       unsigned Line = 1;
2487
2488       // Construct rows of the address, source, line, column matrix.
2489       for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2490         const SrcLineInfo &LineInfo = LineInfos[i];
2491         unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2492         if (!LabelID) continue;
2493
2494         if (!VerboseAsm)
2495           Asm->EOL();
2496         else {
2497           std::pair<unsigned, unsigned> SourceID =
2498             getSourceDirsectoryAndFileIds(LineInfo.getSourceID());
2499           O << '\t' << TAI->getCommentString() << ' '
2500             << getSourceDirectoryName(SourceID.first) << ' '
2501             << getSourceFileName(SourceID.second)
2502             <<" :" << utostr_32(LineInfo.getLine()) << '\n';
2503         }
2504
2505         // Define the line address.
2506         Asm->EmitInt8(0); Asm->EOL("Extended Op");
2507         Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2508         Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2509         EmitReference("label",  LabelID); Asm->EOL("Location label");
2510
2511         // If change of source, then switch to the new source.
2512         if (Source != LineInfo.getSourceID()) {
2513           Source = LineInfo.getSourceID();
2514           Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2515           Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2516         }
2517
2518         // If change of line.
2519         if (Line != LineInfo.getLine()) {
2520           // Determine offset.
2521           int Offset = LineInfo.getLine() - Line;
2522           int Delta = Offset - MinLineDelta;
2523
2524           // Update line.
2525           Line = LineInfo.getLine();
2526
2527           // If delta is small enough and in range...
2528           if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2529             // ... then use fast opcode.
2530             Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2531           } else {
2532             // ... otherwise use long hand.
2533             Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2534             Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2535             Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2536           }
2537         } else {
2538           // Copy the previous row (different address or source)
2539           Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2540         }
2541       }
2542
2543       EmitEndOfLineMatrix(j + 1);
2544     }
2545
2546     if (SecSrcLinesSize == 0)
2547       // Because we're emitting a debug_line section, we still need a line
2548       // table. The linker and friends expect it to exist. If there's nothing to
2549       // put into it, emit an empty table.
2550       EmitEndOfLineMatrix(1);
2551
2552     EmitLabel("line_end", 0);
2553
2554     Asm->EOL();
2555   }
2556
2557   /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2558   ///
2559   void EmitCommonDebugFrame() {
2560     if (!TAI->doesDwarfRequireFrameSection())
2561       return;
2562
2563     int stackGrowth =
2564         Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2565           TargetFrameInfo::StackGrowsUp ?
2566         TD->getPointerSize() : -TD->getPointerSize();
2567
2568     // Start the dwarf frame section.
2569     Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2570
2571     EmitLabel("debug_frame_common", 0);
2572     EmitDifference("debug_frame_common_end", 0,
2573                    "debug_frame_common_begin", 0, true);
2574     Asm->EOL("Length of Common Information Entry");
2575
2576     EmitLabel("debug_frame_common_begin", 0);
2577     Asm->EmitInt32((int)DW_CIE_ID);
2578     Asm->EOL("CIE Identifier Tag");
2579     Asm->EmitInt8(DW_CIE_VERSION);
2580     Asm->EOL("CIE Version");
2581     Asm->EmitString("");
2582     Asm->EOL("CIE Augmentation");
2583     Asm->EmitULEB128Bytes(1);
2584     Asm->EOL("CIE Code Alignment Factor");
2585     Asm->EmitSLEB128Bytes(stackGrowth);
2586     Asm->EOL("CIE Data Alignment Factor");
2587     Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2588     Asm->EOL("CIE RA Column");
2589
2590     std::vector<MachineMove> Moves;
2591     RI->getInitialFrameState(Moves);
2592
2593     EmitFrameMoves(NULL, 0, Moves, false);
2594
2595     Asm->EmitAlignment(2, 0, 0, false);
2596     EmitLabel("debug_frame_common_end", 0);
2597
2598     Asm->EOL();
2599   }
2600
2601   /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2602   /// section.
2603   void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2604     if (!TAI->doesDwarfRequireFrameSection())
2605       return;
2606
2607     // Start the dwarf frame section.
2608     Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2609
2610     EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2611                    "debug_frame_begin", DebugFrameInfo.Number, true);
2612     Asm->EOL("Length of Frame Information Entry");
2613
2614     EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2615
2616     EmitSectionOffset("debug_frame_common", "section_debug_frame",
2617                       0, 0, true, false);
2618     Asm->EOL("FDE CIE offset");
2619
2620     EmitReference("func_begin", DebugFrameInfo.Number);
2621     Asm->EOL("FDE initial location");
2622     EmitDifference("func_end", DebugFrameInfo.Number,
2623                    "func_begin", DebugFrameInfo.Number);
2624     Asm->EOL("FDE address range");
2625
2626     EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2627                    false);
2628
2629     Asm->EmitAlignment(2, 0, 0, false);
2630     EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2631
2632     Asm->EOL();
2633   }
2634
2635   void EmitDebugPubNamesPerCU(CompileUnit *Unit) {
2636     EmitDifference("pubnames_end", Unit->getID(),
2637                    "pubnames_begin", Unit->getID(), true);
2638     Asm->EOL("Length of Public Names Info");
2639
2640     EmitLabel("pubnames_begin", Unit->getID());
2641
2642     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2643
2644     EmitSectionOffset("info_begin", "section_info",
2645                       Unit->getID(), 0, true, false);
2646     Asm->EOL("Offset of Compilation Unit Info");
2647
2648     EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
2649                    true);
2650     Asm->EOL("Compilation Unit Length");
2651
2652     std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2653     for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2654            GE = Globals.end(); GI != GE; ++GI) {
2655       const std::string &Name = GI->first;
2656       DIE * Entity = GI->second;
2657
2658       Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2659       Asm->EmitString(Name); Asm->EOL("External Name");
2660     }
2661
2662     Asm->EmitInt32(0); Asm->EOL("End Mark");
2663     EmitLabel("pubnames_end", Unit->getID());
2664
2665     Asm->EOL();
2666   }
2667
2668   /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2669   ///
2670   void EmitDebugPubNames() {
2671     // Start the dwarf pubnames section.
2672     Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2673
2674     if (MainCU) {
2675       EmitDebugPubNamesPerCU(MainCU);
2676       return;
2677     }
2678
2679     for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i)
2680       EmitDebugPubNamesPerCU(CompileUnits[i]);
2681   }
2682
2683   /// EmitDebugStr - Emit visible names into a debug str section.
2684   ///
2685   void EmitDebugStr() {
2686     // Check to see if it is worth the effort.
2687     if (!StringPool.empty()) {
2688       // Start the dwarf str section.
2689       Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2690
2691       // For each of strings in the string pool.
2692       for (unsigned StringID = 1, N = StringPool.size();
2693            StringID <= N; ++StringID) {
2694         // Emit a label for reference from debug information entries.
2695         EmitLabel("string", StringID);
2696         // Emit the string itself.
2697         const std::string &String = StringPool[StringID];
2698         Asm->EmitString(String); Asm->EOL();
2699       }
2700
2701       Asm->EOL();
2702     }
2703   }
2704
2705   /// EmitDebugLoc - Emit visible names into a debug loc section.
2706   ///
2707   void EmitDebugLoc() {
2708     // Start the dwarf loc section.
2709     Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2710
2711     Asm->EOL();
2712   }
2713
2714   /// EmitDebugARanges - Emit visible names into a debug aranges section.
2715   ///
2716   void EmitDebugARanges() {
2717     // Start the dwarf aranges section.
2718     Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2719
2720     // FIXME - Mock up
2721 #if 0
2722     CompileUnit *Unit = GetBaseCompileUnit();
2723
2724     // Don't include size of length
2725     Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2726
2727     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2728
2729     EmitReference("info_begin", Unit->getID());
2730     Asm->EOL("Offset of Compilation Unit Info");
2731
2732     Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2733
2734     Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2735
2736     Asm->EmitInt16(0);  Asm->EOL("Pad (1)");
2737     Asm->EmitInt16(0);  Asm->EOL("Pad (2)");
2738
2739     // Range 1
2740     EmitReference("text_begin", 0); Asm->EOL("Address");
2741     EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2742
2743     Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2744     Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2745 #endif
2746
2747     Asm->EOL();
2748   }
2749
2750   /// EmitDebugRanges - Emit visible names into a debug ranges section.
2751   ///
2752   void EmitDebugRanges() {
2753     // Start the dwarf ranges section.
2754     Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2755
2756     Asm->EOL();
2757   }
2758
2759   /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2760   ///
2761   void EmitDebugMacInfo() {
2762     if (TAI->doesSupportMacInfoSection()) {
2763       // Start the dwarf macinfo section.
2764       Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2765
2766       Asm->EOL();
2767     }
2768   }
2769
2770   void ConstructCompileUnit(GlobalVariable *GV) {
2771     DICompileUnit DIUnit(GV);
2772     unsigned ID = getOrCreateSourceID(DIUnit.getDirectory(),
2773                                       DIUnit.getFilename());
2774
2775     DIE *Die = new DIE(DW_TAG_compile_unit);
2776     AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2777                      DWLabel("section_line", 0), DWLabel("section_line", 0),
2778                      false);
2779     AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit.getProducer());
2780     AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit.getLanguage());
2781     AddString(Die, DW_AT_name, DW_FORM_string, DIUnit.getFilename());
2782     if (!DIUnit.getDirectory().empty())
2783       AddString(Die, DW_AT_comp_dir, DW_FORM_string, DIUnit.getDirectory());
2784     if (DIUnit.isOptimized())
2785       AddUInt(Die, DW_AT_APPLE_optimized, DW_FORM_flag, 1);
2786     const std::string &Flags = DIUnit.getFlags();
2787     if (!Flags.empty())
2788       AddString(Die, DW_AT_APPLE_flags, DW_FORM_string, Flags);
2789     unsigned RVer = DIUnit.getRunTimeVersion();
2790     if (RVer)
2791       AddUInt(Die, DW_AT_APPLE_major_runtime_vers, DW_FORM_data1, RVer);
2792
2793     CompileUnit *Unit = new CompileUnit(ID, Die);
2794     if (DIUnit.isMain()) {
2795       assert(!MainCU && "Multiple main compile units are found!");
2796       MainCU = Unit;
2797     }
2798     CompileUnitMap[DIUnit.getGV()] = Unit;
2799     CompileUnits.push_back(Unit);
2800   }
2801
2802   /// ConstructCompileUnits - Create a compile unit DIEs.
2803   void ConstructCompileUnits() {
2804     GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.compile_units");
2805     if (!Root)
2806       return;
2807     assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2808            "Malformed compile unit descriptor anchor type");
2809     Constant *RootC = cast<Constant>(*Root->use_begin());
2810     assert(RootC->hasNUsesOrMore(1) &&
2811            "Malformed compile unit descriptor anchor type");
2812     for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2813          UI != UE; ++UI)
2814       for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2815            UUI != UUE; ++UUI) {
2816         GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2817         ConstructCompileUnit(GV);
2818       }
2819   }
2820
2821   bool ConstructGlobalVariableDIE(GlobalVariable *GV) {
2822     DIGlobalVariable DI_GV(GV);
2823     CompileUnit *DW_Unit = MainCU;
2824     if (!DW_Unit)
2825       DW_Unit = FindCompileUnit(DI_GV.getCompileUnit());
2826
2827     // Check for pre-existence.
2828     DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV.getGV());
2829     if (Slot)
2830       return false;
2831
2832     DIE *VariableDie = CreateGlobalVariableDIE(DW_Unit, DI_GV);
2833
2834     // Add address.
2835     DIEBlock *Block = new DIEBlock();
2836     AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2837     AddObjectLabel(Block, 0, DW_FORM_udata,
2838                    Asm->getGlobalLinkName(DI_GV.getGlobal()));
2839     AddBlock(VariableDie, DW_AT_location, 0, Block);
2840
2841     // Add to map.
2842     Slot = VariableDie;
2843     // Add to context owner.
2844     DW_Unit->getDie()->AddChild(VariableDie);
2845     // Expose as global. FIXME - need to check external flag.
2846     DW_Unit->AddGlobal(DI_GV.getName(), VariableDie);
2847     return true;
2848   }
2849
2850   /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
2851   /// visible global variables. Return true if at least one global DIE is
2852   /// created.
2853   bool ConstructGlobalVariableDIEs() {
2854     GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.global_variables");
2855     if (!Root)
2856       return false;
2857
2858     assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2859            "Malformed global variable descriptor anchor type");
2860     Constant *RootC = cast<Constant>(*Root->use_begin());
2861     assert(RootC->hasNUsesOrMore(1) &&
2862            "Malformed global variable descriptor anchor type");
2863
2864     bool Result = false;
2865     for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2866          UI != UE; ++UI)
2867       for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2868            UUI != UUE; ++UUI) {
2869         GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2870         Result |= ConstructGlobalVariableDIE(GV);
2871       }
2872     return Result;
2873   }
2874
2875   bool ConstructSubprogram(GlobalVariable *GV) {
2876     DISubprogram SP(GV);
2877     CompileUnit *Unit = MainCU;
2878     if (!Unit)
2879       Unit = FindCompileUnit(SP.getCompileUnit());
2880
2881     // Check for pre-existence.
2882     DIE *&Slot = Unit->getDieMapSlotFor(GV);
2883     if (Slot)
2884       return false;
2885
2886     if (!SP.isDefinition())
2887       // This is a method declaration which will be handled while
2888       // constructing class type.
2889       return false;
2890
2891     DIE *SubprogramDie = CreateSubprogramDIE(Unit, SP);
2892
2893     // Add to map.
2894     Slot = SubprogramDie;
2895     // Add to context owner.
2896     Unit->getDie()->AddChild(SubprogramDie);
2897     // Expose as global.
2898     Unit->AddGlobal(SP.getName(), SubprogramDie);
2899     return true;
2900   }
2901
2902   /// ConstructSubprograms - Create DIEs for each of the externally visible
2903   /// subprograms. Return true if at least one subprogram DIE is created.
2904   bool ConstructSubprograms() {
2905     GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.subprograms");
2906     if (!Root)
2907       return false;
2908
2909     assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2910            "Malformed subprogram descriptor anchor type");
2911     Constant *RootC = cast<Constant>(*Root->use_begin());
2912     assert(RootC->hasNUsesOrMore(1) &&
2913            "Malformed subprogram descriptor anchor type");
2914
2915     bool Result = false;
2916     for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2917          UI != UE; ++UI)
2918       for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2919            UUI != UUE; ++UUI) {
2920         GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2921         Result |= ConstructSubprogram(GV);
2922       }
2923     return Result;
2924   }
2925
2926 public:
2927   //===--------------------------------------------------------------------===//
2928   // Main entry points.
2929   //
2930   DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2931   : Dwarf(OS, A, T, "dbg")
2932   , MainCU(NULL)
2933   , AbbreviationsSet(InitAbbreviationsSetSize)
2934   , Abbreviations()
2935   , ValuesSet(InitValuesSetSize)
2936   , Values()
2937   , StringPool()
2938   , SectionMap()
2939   , SectionSourceLines()
2940   , didInitial(false)
2941   , shouldEmit(false)
2942   , RootDbgScope(NULL)
2943   {
2944   }
2945   virtual ~DwarfDebug() {
2946     for (unsigned j = 0, M = Values.size(); j < M; ++j)
2947       delete Values[j];
2948   }
2949
2950   /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
2951   /// This is inovked by the target AsmPrinter.
2952   void SetDebugInfo(MachineModuleInfo *mmi) {
2953     // Create all the compile unit DIEs.
2954     ConstructCompileUnits();
2955
2956     if (CompileUnits.empty())
2957       return;
2958
2959     // Create DIEs for each of the externally visible global variables.
2960     bool globalDIEs = ConstructGlobalVariableDIEs();
2961
2962     // Create DIEs for each of the externally visible subprograms.
2963     bool subprogramDIEs = ConstructSubprograms();
2964
2965     // If there is not any debug info available for any global variables
2966     // and any subprograms then there is not any debug info to emit.
2967     if (!globalDIEs && !subprogramDIEs)
2968       return;
2969
2970     MMI = mmi;
2971     shouldEmit = true;
2972     MMI->setDebugInfoAvailability(true);
2973
2974     // Prime section data.
2975     SectionMap.insert(TAI->getTextSection());
2976
2977     // Print out .file directives to specify files for .loc directives. These
2978     // are printed out early so that they precede any .loc directives.
2979     if (TAI->hasDotLocAndDotFile()) {
2980       for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
2981         // Remember source id starts at 1.
2982         std::pair<unsigned, unsigned> Id = getSourceDirsectoryAndFileIds(i);
2983         sys::Path FullPath(getSourceDirectoryName(Id.first));
2984         bool AppendOk =
2985           FullPath.appendComponent(getSourceFileName(Id.second));
2986         assert(AppendOk && "Could not append filename to directory!");
2987         AppendOk = false;
2988         Asm->EmitFile(i, FullPath.toString());
2989         Asm->EOL();
2990       }
2991     }
2992
2993     // Emit initial sections
2994     EmitInitial();
2995   }
2996
2997   /// BeginModule - Emit all Dwarf sections that should come prior to the
2998   /// content.
2999   void BeginModule(Module *M) {
3000     this->M = M;
3001   }
3002
3003   /// EndModule - Emit all Dwarf sections that should come after the content.
3004   ///
3005   void EndModule() {
3006     if (!ShouldEmitDwarfDebug()) return;
3007
3008     // Standard sections final addresses.
3009     Asm->SwitchToSection(TAI->getTextSection());
3010     EmitLabel("text_end", 0);
3011     Asm->SwitchToSection(TAI->getDataSection());
3012     EmitLabel("data_end", 0);
3013
3014     // End text sections.
3015     for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
3016       Asm->SwitchToSection(SectionMap[i]);
3017       EmitLabel("section_end", i);
3018     }
3019
3020     // Emit common frame information.
3021     EmitCommonDebugFrame();
3022
3023     // Emit function debug frame information
3024     for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
3025            E = DebugFrames.end(); I != E; ++I)
3026       EmitFunctionDebugFrame(*I);
3027
3028     // Compute DIE offsets and sizes.
3029     SizeAndOffsets();
3030
3031     // Emit all the DIEs into a debug info section
3032     EmitDebugInfo();
3033
3034     // Corresponding abbreviations into a abbrev section.
3035     EmitAbbreviations();
3036
3037     // Emit source line correspondence into a debug line section.
3038     EmitDebugLines();
3039
3040     // Emit info into a debug pubnames section.
3041     EmitDebugPubNames();
3042
3043     // Emit info into a debug str section.
3044     EmitDebugStr();
3045
3046     // Emit info into a debug loc section.
3047     EmitDebugLoc();
3048
3049     // Emit info into a debug aranges section.
3050     EmitDebugARanges();
3051
3052     // Emit info into a debug ranges section.
3053     EmitDebugRanges();
3054
3055     // Emit info into a debug macinfo section.
3056     EmitDebugMacInfo();
3057   }
3058
3059   /// BeginFunction - Gather pre-function debug information.  Assumes being
3060   /// emitted immediately after the function entry point.
3061   void BeginFunction(MachineFunction *MF) {
3062     this->MF = MF;
3063
3064     if (!ShouldEmitDwarfDebug()) return;
3065
3066     // Begin accumulating function debug information.
3067     MMI->BeginFunction(MF);
3068
3069     // Assumes in correct section after the entry point.
3070     EmitLabel("func_begin", ++SubprogramCount);
3071
3072     // Emit label for the implicitly defined dbg.stoppoint at the start of
3073     // the function.
3074     if (!Lines.empty()) {
3075       const SrcLineInfo &LineInfo = Lines[0];
3076       Asm->printLabel(LineInfo.getLabelID());
3077     }
3078   }
3079
3080   /// EndFunction - Gather and emit post-function debug information.
3081   ///
3082   void EndFunction(MachineFunction *MF) {
3083     if (!ShouldEmitDwarfDebug()) return;
3084
3085     // Define end label for subprogram.
3086     EmitLabel("func_end", SubprogramCount);
3087
3088     // Get function line info.
3089     if (!Lines.empty()) {
3090       // Get section line info.
3091       unsigned ID = SectionMap.insert(Asm->CurrentSection_);
3092       if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3093       std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3094       // Append the function info to section info.
3095       SectionLineInfos.insert(SectionLineInfos.end(),
3096                               Lines.begin(), Lines.end());
3097     }
3098
3099     // Construct scopes for subprogram.
3100     if (RootDbgScope)
3101       ConstructRootDbgScope(RootDbgScope);
3102     else
3103       // FIXME: This is wrong. We are essentially getting past a problem with
3104       // debug information not being able to handle unreachable blocks that have
3105       // debug information in them. In particular, those unreachable blocks that
3106       // have "region end" info in them. That situation results in the "root
3107       // scope" not being created. If that's the case, then emit a "default"
3108       // scope, i.e., one that encompasses the whole function. This isn't
3109       // desirable. And a better way of handling this (and all of the debugging
3110       // information) needs to be explored.
3111       ConstructDefaultDbgScope(MF);
3112
3113     DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3114                                                  MMI->getFrameMoves()));
3115
3116     // Clear debug info
3117     if (RootDbgScope) {
3118       delete RootDbgScope;
3119       DbgScopeMap.clear();
3120       RootDbgScope = NULL;
3121     }
3122     Lines.clear();
3123   }
3124
3125 public:
3126
3127   /// ValidDebugInfo - Return true if V represents valid debug info value.
3128   bool ValidDebugInfo(Value *V) {
3129     if (!V)
3130       return false;
3131
3132     if (!shouldEmit)
3133       return false;
3134
3135     GlobalVariable *GV = getGlobalVariable(V);
3136     if (!GV)
3137       return false;
3138
3139     if (!GV->hasInternalLinkage () && !GV->hasLinkOnceLinkage())
3140       return false;
3141
3142     DIDescriptor DI(GV);
3143     // Check current version. Allow Version6 for now.
3144     unsigned Version = DI.getVersion();
3145     if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6)
3146       return false;
3147
3148     unsigned Tag = DI.getTag();
3149     switch (Tag) {
3150     case DW_TAG_variable:
3151       assert(DIVariable(GV).Verify() && "Invalid DebugInfo value");
3152       break;
3153     case DW_TAG_compile_unit:
3154       assert(DICompileUnit(GV).Verify() && "Invalid DebugInfo value");
3155       break;
3156     case DW_TAG_subprogram:
3157       assert(DISubprogram(GV).Verify() && "Invalid DebugInfo value");
3158       break;
3159     default:
3160       break;
3161     }
3162
3163     return true;
3164   }
3165
3166   /// RecordSourceLine - Records location information and associates it with a
3167   /// label. Returns a unique label ID used to generate a label and provide
3168   /// correspondence to the source line list.
3169   unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3170     CompileUnit *Unit = CompileUnitMap[V];
3171     assert(Unit && "Unable to find CompileUnit");
3172     unsigned ID = MMI->NextLabelID();
3173     Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3174     return ID;
3175   }
3176
3177   /// RecordSourceLine - Records location information and associates it with a
3178   /// label. Returns a unique label ID used to generate a label and provide
3179   /// correspondence to the source line list.
3180   unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3181     unsigned ID = MMI->NextLabelID();
3182     Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3183     return ID;
3184   }
3185
3186   unsigned getRecordSourceLineCount() {
3187     return Lines.size();
3188   }
3189
3190   /// getNumSourceDirectories - Return the number of source directories in the
3191   /// debug info.
3192   unsigned getNumSourceDirectories() const {
3193     return DirectoryNames.size();
3194   }
3195
3196   /// getSourceDirectoryName - Return the name of the directory corresponding
3197   /// to the id.
3198   const std::string &getSourceDirectoryName(unsigned Id) const {
3199     return DirectoryNames[Id - 1];
3200   }
3201
3202   /// getNumSourceFiles - Return the number of source files in the debug info.
3203   ///
3204   unsigned getNumSourceFiles() const {
3205     return SourceFileNames.size();
3206   }
3207
3208   /// getSourceFileName - Return the name of the source file corresponding
3209   /// to the id.
3210   const std::string &getSourceFileName(unsigned Id) const {
3211     return SourceFileNames[Id - 1];
3212   }
3213
3214   /// getNumSourceIds - Return the number of unique source ids.
3215   ///
3216   unsigned getNumSourceIds() const {
3217     return SourceIds.size();
3218   }
3219
3220   /// getSourceDirsectoryAndFileIds - Return the directory and file ids that
3221   /// maps to the source id. Source id starts at 1.
3222   std::pair<unsigned, unsigned>
3223   getSourceDirsectoryAndFileIds(unsigned SId) const {
3224     return SourceIds[SId-1];
3225   }
3226
3227   /// getOrCreateSourceID - Look up the source id with the given directory and
3228   /// source file names. If none currently exists, create a new id and insert it
3229   /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
3230   /// as well.
3231   unsigned getOrCreateSourceID(const std::string &DirName,
3232                                const std::string &FileName) {
3233     unsigned DId;
3234     StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
3235     if (DI != DirectoryIdMap.end())
3236       DId = DI->getValue();
3237     else {
3238       DId = DirectoryNames.size() + 1;
3239       DirectoryIdMap[DirName] = DId;
3240       DirectoryNames.push_back(DirName);
3241     }
3242
3243     unsigned FId;
3244     StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
3245     if (FI != SourceFileIdMap.end())
3246       FId = FI->getValue();
3247     else {
3248       FId = SourceFileNames.size() + 1;
3249       SourceFileIdMap[FileName] = FId;
3250       SourceFileNames.push_back(FileName);
3251     }
3252
3253     DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
3254       SourceIdMap.find(std::make_pair(DId, FId));
3255     if (SI != SourceIdMap.end())
3256       return SI->second;
3257     unsigned SrcId = SourceIds.size() + 1;  // DW_AT_decl_file cannot be 0.
3258     SourceIdMap[std::make_pair(DId, FId)] = SrcId;
3259     SourceIds.push_back(std::make_pair(DId, FId));
3260     return SrcId;
3261   }
3262
3263   /// RecordRegionStart - Indicate the start of a region.
3264   ///
3265   unsigned RecordRegionStart(GlobalVariable *V) {
3266     DbgScope *Scope = getOrCreateScope(V);
3267     unsigned ID = MMI->NextLabelID();
3268     if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3269     return ID;
3270   }
3271
3272   /// RecordRegionEnd - Indicate the end of a region.
3273   ///
3274   unsigned RecordRegionEnd(GlobalVariable *V) {
3275     DbgScope *Scope = getOrCreateScope(V);
3276     unsigned ID = MMI->NextLabelID();
3277     Scope->setEndLabelID(ID);
3278     return ID;
3279   }
3280
3281   /// RecordVariable - Indicate the declaration of  a local variable.
3282   ///
3283   void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
3284     DIDescriptor Desc(GV);
3285     DbgScope *Scope = NULL;
3286     if (Desc.getTag() == DW_TAG_variable) {
3287       // GV is a global variable.
3288       DIGlobalVariable DG(GV);
3289       Scope = getOrCreateScope(DG.getContext().getGV());
3290     } else {
3291       // or GV is a local variable.
3292       DIVariable DV(GV);
3293       Scope = getOrCreateScope(DV.getContext().getGV());
3294     }
3295     assert(Scope && "Unable to find variable' scope");
3296     DbgVariable *DV = new DbgVariable(DIVariable(GV), FrameIndex);
3297     Scope->AddVariable(DV);
3298   }
3299 };
3300
3301 //===----------------------------------------------------------------------===//
3302 /// DwarfException - Emits Dwarf exception handling directives.
3303 ///
3304 class DwarfException : public Dwarf  {
3305   struct FunctionEHFrameInfo {
3306     std::string FnName;
3307     unsigned Number;
3308     unsigned PersonalityIndex;
3309     bool hasCalls;
3310     bool hasLandingPads;
3311     std::vector<MachineMove> Moves;
3312     const Function * function;
3313
3314     FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3315                         bool hC, bool hL,
3316                         const std::vector<MachineMove> &M,
3317                         const Function *f):
3318       FnName(FN), Number(Num), PersonalityIndex(P),
3319       hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
3320   };
3321
3322   std::vector<FunctionEHFrameInfo> EHFrames;
3323
3324   /// shouldEmitTable - Per-function flag to indicate if EH tables should
3325   /// be emitted.
3326   bool shouldEmitTable;
3327
3328   /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3329   /// should be emitted.
3330   bool shouldEmitMoves;
3331
3332   /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3333   /// should be emitted.
3334   bool shouldEmitTableModule;
3335
3336   /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
3337   /// should be emitted.
3338   bool shouldEmitMovesModule;
3339
3340   /// EmitCommonEHFrame - Emit the common eh unwind frame.
3341   ///
3342   void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3343     // Size and sign of stack growth.
3344     int stackGrowth =
3345         Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3346           TargetFrameInfo::StackGrowsUp ?
3347         TD->getPointerSize() : -TD->getPointerSize();
3348
3349     // Begin eh frame section.
3350     Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3351
3352     if (!TAI->doesRequireNonLocalEHFrameLabel())
3353       O << TAI->getEHGlobalPrefix();
3354     O << "EH_frame" << Index << ":\n";
3355     EmitLabel("section_eh_frame", Index);
3356
3357     // Define base labels.
3358     EmitLabel("eh_frame_common", Index);
3359
3360     // Define the eh frame length.
3361     EmitDifference("eh_frame_common_end", Index,
3362                    "eh_frame_common_begin", Index, true);
3363     Asm->EOL("Length of Common Information Entry");
3364
3365     // EH frame header.
3366     EmitLabel("eh_frame_common_begin", Index);
3367     Asm->EmitInt32((int)0);
3368     Asm->EOL("CIE Identifier Tag");
3369     Asm->EmitInt8(DW_CIE_VERSION);
3370     Asm->EOL("CIE Version");
3371
3372     // The personality presence indicates that language specific information
3373     // will show up in the eh frame.
3374     Asm->EmitString(Personality ? "zPLR" : "zR");
3375     Asm->EOL("CIE Augmentation");
3376
3377     // Round out reader.
3378     Asm->EmitULEB128Bytes(1);
3379     Asm->EOL("CIE Code Alignment Factor");
3380     Asm->EmitSLEB128Bytes(stackGrowth);
3381     Asm->EOL("CIE Data Alignment Factor");
3382     Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
3383     Asm->EOL("CIE Return Address Column");
3384
3385     // If there is a personality, we need to indicate the functions location.
3386     if (Personality) {
3387       Asm->EmitULEB128Bytes(7);
3388       Asm->EOL("Augmentation Size");
3389
3390       if (TAI->getNeedsIndirectEncoding()) {
3391         Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
3392         Asm->EOL("Personality (pcrel sdata4 indirect)");
3393       } else {
3394         Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3395         Asm->EOL("Personality (pcrel sdata4)");
3396       }
3397
3398       PrintRelDirective(true);
3399       O << TAI->getPersonalityPrefix();
3400       Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3401       O << TAI->getPersonalitySuffix();
3402       if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3403         O << "-" << TAI->getPCSymbol();
3404       Asm->EOL("Personality");
3405
3406       Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3407       Asm->EOL("LSDA Encoding (pcrel sdata4)");
3408
3409       Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3410       Asm->EOL("FDE Encoding (pcrel sdata4)");
3411    } else {
3412       Asm->EmitULEB128Bytes(1);
3413       Asm->EOL("Augmentation Size");
3414
3415       Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3416       Asm->EOL("FDE Encoding (pcrel sdata4)");
3417     }
3418
3419     // Indicate locations of general callee saved registers in frame.
3420     std::vector<MachineMove> Moves;
3421     RI->getInitialFrameState(Moves);
3422     EmitFrameMoves(NULL, 0, Moves, true);
3423
3424     // On Darwin the linker honors the alignment of eh_frame, which means it
3425     // must be 8-byte on 64-bit targets to match what gcc does.  Otherwise
3426     // you get holes which confuse readers of eh_frame.
3427     Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3428                        0, 0, false);
3429     EmitLabel("eh_frame_common_end", Index);
3430
3431     Asm->EOL();
3432   }
3433
3434   /// EmitEHFrame - Emit function exception frame information.
3435   ///
3436   void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
3437     Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3438
3439     Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3440
3441     // Externally visible entry into the functions eh frame info.
3442     // If the corresponding function is static, this should not be
3443     // externally visible.
3444     if (linkage != Function::InternalLinkage &&
3445         linkage != Function::PrivateLinkage) {
3446       if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3447         O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3448     }
3449
3450     // If corresponding function is weak definition, this should be too.
3451     if ((linkage == Function::WeakAnyLinkage ||
3452          linkage == Function::WeakODRLinkage ||
3453          linkage == Function::LinkOnceAnyLinkage ||
3454          linkage == Function::LinkOnceODRLinkage) &&
3455         TAI->getWeakDefDirective())
3456       O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3457
3458     // If there are no calls then you can't unwind.  This may mean we can
3459     // omit the EH Frame, but some environments do not handle weak absolute
3460     // symbols.
3461     // If UnwindTablesMandatory is set we cannot do this optimization; the
3462     // unwind info is to be available for non-EH uses.
3463     if (!EHFrameInfo.hasCalls &&
3464         !UnwindTablesMandatory &&
3465         ((linkage != Function::WeakAnyLinkage &&
3466           linkage != Function::WeakODRLinkage &&
3467           linkage != Function::LinkOnceAnyLinkage &&
3468           linkage != Function::LinkOnceODRLinkage) ||
3469          !TAI->getWeakDefDirective() ||
3470          TAI->getSupportsWeakOmittedEHFrame()))
3471     {
3472       O << EHFrameInfo.FnName << " = 0\n";
3473       // This name has no connection to the function, so it might get
3474       // dead-stripped when the function is not, erroneously.  Prohibit
3475       // dead-stripping unconditionally.
3476       if (const char *UsedDirective = TAI->getUsedDirective())
3477         O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3478     } else {
3479       O << EHFrameInfo.FnName << ":\n";
3480
3481       // EH frame header.
3482       EmitDifference("eh_frame_end", EHFrameInfo.Number,
3483                      "eh_frame_begin", EHFrameInfo.Number, true);
3484       Asm->EOL("Length of Frame Information Entry");
3485
3486       EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3487
3488       if (TAI->doesRequireNonLocalEHFrameLabel()) {
3489         PrintRelDirective(true, true);
3490         PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3491
3492         if (!TAI->isAbsoluteEHSectionOffsets())
3493           O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3494       } else {
3495         EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3496                           EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3497                           true, true, false);
3498       }
3499
3500       Asm->EOL("FDE CIE offset");
3501
3502       EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3503       Asm->EOL("FDE initial location");
3504       EmitDifference("eh_func_end", EHFrameInfo.Number,
3505                      "eh_func_begin", EHFrameInfo.Number, true);
3506       Asm->EOL("FDE address range");
3507
3508       // If there is a personality and landing pads then point to the language
3509       // specific data area in the exception table.
3510       if (EHFrameInfo.PersonalityIndex) {
3511         Asm->EmitULEB128Bytes(4);
3512         Asm->EOL("Augmentation size");
3513
3514         if (EHFrameInfo.hasLandingPads)
3515           EmitReference("exception", EHFrameInfo.Number, true, true);
3516         else
3517           Asm->EmitInt32((int)0);
3518         Asm->EOL("Language Specific Data Area");
3519       } else {
3520         Asm->EmitULEB128Bytes(0);
3521         Asm->EOL("Augmentation size");
3522       }
3523
3524       // Indicate locations of function specific  callee saved registers in
3525       // frame.
3526       EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves,
3527                      true);
3528
3529       // On Darwin the linker honors the alignment of eh_frame, which means it
3530       // must be 8-byte on 64-bit targets to match what gcc does.  Otherwise
3531       // you get holes which confuse readers of eh_frame.
3532       Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3533                          0, 0, false);
3534       EmitLabel("eh_frame_end", EHFrameInfo.Number);
3535
3536       // If the function is marked used, this table should be also.  We cannot
3537       // make the mark unconditional in this case, since retaining the table
3538       // also retains the function in this case, and there is code around
3539       // that depends on unused functions (calling undefined externals) being
3540       // dead-stripped to link correctly.  Yes, there really is.
3541       if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3542         if (const char *UsedDirective = TAI->getUsedDirective())
3543           O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3544     }
3545   }
3546
3547   /// EmitExceptionTable - Emit landing pads and actions.
3548   ///
3549   /// The general organization of the table is complex, but the basic concepts
3550   /// are easy.  First there is a header which describes the location and
3551   /// organization of the three components that follow.
3552   ///  1. The landing pad site information describes the range of code covered
3553   ///     by the try.  In our case it's an accumulation of the ranges covered
3554   ///     by the invokes in the try.  There is also a reference to the landing
3555   ///     pad that handles the exception once processed.  Finally an index into
3556   ///     the actions table.
3557   ///  2. The action table, in our case, is composed of pairs of type ids
3558   ///     and next action offset.  Starting with the action index from the
3559   ///     landing pad site, each type Id is checked for a match to the current
3560   ///     exception.  If it matches then the exception and type id are passed
3561   ///     on to the landing pad.  Otherwise the next action is looked up.  This
3562   ///     chain is terminated with a next action of zero.  If no type id is
3563   ///     found the the frame is unwound and handling continues.
3564   ///  3. Type id table contains references to all the C++ typeinfo for all
3565   ///     catches in the function.  This tables is reversed indexed base 1.
3566
3567   /// SharedTypeIds - How many leading type ids two landing pads have in common.
3568   static unsigned SharedTypeIds(const LandingPadInfo *L,
3569                                 const LandingPadInfo *R) {
3570     const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3571     unsigned LSize = LIds.size(), RSize = RIds.size();
3572     unsigned MinSize = LSize < RSize ? LSize : RSize;
3573     unsigned Count = 0;
3574
3575     for (; Count != MinSize; ++Count)
3576       if (LIds[Count] != RIds[Count])
3577         return Count;
3578
3579     return Count;
3580   }
3581
3582   /// PadLT - Order landing pads lexicographically by type id.
3583   static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3584     const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3585     unsigned LSize = LIds.size(), RSize = RIds.size();
3586     unsigned MinSize = LSize < RSize ? LSize : RSize;
3587
3588     for (unsigned i = 0; i != MinSize; ++i)
3589       if (LIds[i] != RIds[i])
3590         return LIds[i] < RIds[i];
3591
3592     return LSize < RSize;
3593   }
3594
3595   struct KeyInfo {
3596     static inline unsigned getEmptyKey() { return -1U; }
3597     static inline unsigned getTombstoneKey() { return -2U; }
3598     static unsigned getHashValue(const unsigned &Key) { return Key; }
3599     static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3600     static bool isPod() { return true; }
3601   };
3602
3603   /// ActionEntry - Structure describing an entry in the actions table.
3604   struct ActionEntry {
3605     int ValueForTypeID; // The value to write - may not be equal to the type id.
3606     int NextAction;
3607     struct ActionEntry *Previous;
3608   };
3609
3610   /// PadRange - Structure holding a try-range and the associated landing pad.
3611   struct PadRange {
3612     // The index of the landing pad.
3613     unsigned PadIndex;
3614     // The index of the begin and end labels in the landing pad's label lists.
3615     unsigned RangeIndex;
3616   };
3617
3618   typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3619
3620   /// CallSiteEntry - Structure describing an entry in the call-site table.
3621   struct CallSiteEntry {
3622     // The 'try-range' is BeginLabel .. EndLabel.
3623     unsigned BeginLabel; // zero indicates the start of the function.
3624     unsigned EndLabel;   // zero indicates the end of the function.
3625     // The landing pad starts at PadLabel.
3626     unsigned PadLabel;   // zero indicates that there is no landing pad.
3627     unsigned Action;
3628   };
3629
3630   void EmitExceptionTable() {
3631     const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3632     const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3633     const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3634     if (PadInfos.empty()) return;
3635
3636     // Sort the landing pads in order of their type ids.  This is used to fold
3637     // duplicate actions.
3638     SmallVector<const LandingPadInfo *, 64> LandingPads;
3639     LandingPads.reserve(PadInfos.size());
3640     for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3641       LandingPads.push_back(&PadInfos[i]);
3642     std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3643
3644     // Negative type ids index into FilterIds, positive type ids index into
3645     // TypeInfos.  The value written for a positive type id is just the type
3646     // id itself.  For a negative type id, however, the value written is the
3647     // (negative) byte offset of the corresponding FilterIds entry.  The byte
3648     // offset is usually equal to the type id, because the FilterIds entries
3649     // are written using a variable width encoding which outputs one byte per
3650     // entry as long as the value written is not too large, but can differ.
3651     // This kind of complication does not occur for positive type ids because
3652     // type infos are output using a fixed width encoding.
3653     // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3654     SmallVector<int, 16> FilterOffsets;
3655     FilterOffsets.reserve(FilterIds.size());
3656     int Offset = -1;
3657     for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3658         E = FilterIds.end(); I != E; ++I) {
3659       FilterOffsets.push_back(Offset);
3660       Offset -= TargetAsmInfo::getULEB128Size(*I);
3661     }
3662
3663     // Compute the actions table and gather the first action index for each
3664     // landing pad site.
3665     SmallVector<ActionEntry, 32> Actions;
3666     SmallVector<unsigned, 64> FirstActions;
3667     FirstActions.reserve(LandingPads.size());
3668
3669     int FirstAction = 0;
3670     unsigned SizeActions = 0;
3671     for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3672       const LandingPadInfo *LP = LandingPads[i];
3673       const std::vector<int> &TypeIds = LP->TypeIds;
3674       const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3675       unsigned SizeSiteActions = 0;
3676
3677       if (NumShared < TypeIds.size()) {
3678         unsigned SizeAction = 0;
3679         ActionEntry *PrevAction = 0;
3680
3681         if (NumShared) {
3682           const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3683           assert(Actions.size());
3684           PrevAction = &Actions.back();
3685           SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3686             TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3687           for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3688             SizeAction -=
3689               TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3690             SizeAction += -PrevAction->NextAction;
3691             PrevAction = PrevAction->Previous;
3692           }
3693         }
3694
3695         // Compute the actions.
3696         for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3697           int TypeID = TypeIds[I];
3698           assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3699           int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3700           unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
3701
3702           int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3703           SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
3704           SizeSiteActions += SizeAction;
3705
3706           ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3707           Actions.push_back(Action);
3708
3709           PrevAction = &Actions.back();
3710         }
3711
3712         // Record the first action of the landing pad site.
3713         FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3714       } // else identical - re-use previous FirstAction
3715
3716       FirstActions.push_back(FirstAction);
3717
3718       // Compute this sites contribution to size.
3719       SizeActions += SizeSiteActions;
3720     }
3721
3722     // Compute the call-site table.  The entry for an invoke has a try-range
3723     // containing the call, a non-zero landing pad and an appropriate action.
3724     // The entry for an ordinary call has a try-range containing the call and
3725     // zero for the landing pad and the action.  Calls marked 'nounwind' have
3726     // no entry and must not be contained in the try-range of any entry - they
3727     // form gaps in the table.  Entries must be ordered by try-range address.
3728     SmallVector<CallSiteEntry, 64> CallSites;
3729
3730     RangeMapType PadMap;
3731     // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3732     // by try-range labels when lowered).  Ordinary calls do not, so appropriate
3733     // try-ranges for them need be deduced.
3734     for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3735       const LandingPadInfo *LandingPad = LandingPads[i];
3736       for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3737         unsigned BeginLabel = LandingPad->BeginLabels[j];
3738         assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3739         PadRange P = { i, j };
3740         PadMap[BeginLabel] = P;
3741       }
3742     }
3743
3744     // The end label of the previous invoke or nounwind try-range.
3745     unsigned LastLabel = 0;
3746
3747     // Whether there is a potentially throwing instruction (currently this means
3748     // an ordinary call) between the end of the previous try-range and now.
3749     bool SawPotentiallyThrowing = false;
3750
3751     // Whether the last callsite entry was for an invoke.
3752     bool PreviousIsInvoke = false;
3753
3754     // Visit all instructions in order of address.
3755     for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3756          I != E; ++I) {
3757       for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3758            MI != E; ++MI) {
3759         if (!MI->isLabel()) {
3760           SawPotentiallyThrowing |= MI->getDesc().isCall();
3761           continue;
3762         }
3763
3764         unsigned BeginLabel = MI->getOperand(0).getImm();
3765         assert(BeginLabel && "Invalid label!");
3766
3767         // End of the previous try-range?
3768         if (BeginLabel == LastLabel)
3769           SawPotentiallyThrowing = false;
3770
3771         // Beginning of a new try-range?
3772         RangeMapType::iterator L = PadMap.find(BeginLabel);
3773         if (L == PadMap.end())
3774           // Nope, it was just some random label.
3775           continue;
3776
3777         PadRange P = L->second;
3778         const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3779
3780         assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3781                "Inconsistent landing pad map!");
3782
3783         // If some instruction between the previous try-range and this one may
3784         // throw, create a call-site entry with no landing pad for the region
3785         // between the try-ranges.
3786         if (SawPotentiallyThrowing) {
3787           CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3788           CallSites.push_back(Site);
3789           PreviousIsInvoke = false;
3790         }
3791
3792         LastLabel = LandingPad->EndLabels[P.RangeIndex];
3793         assert(BeginLabel && LastLabel && "Invalid landing pad!");
3794
3795         if (LandingPad->LandingPadLabel) {
3796           // This try-range is for an invoke.
3797           CallSiteEntry Site = {BeginLabel, LastLabel,
3798             LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3799
3800           // Try to merge with the previous call-site.
3801           if (PreviousIsInvoke) {
3802             CallSiteEntry &Prev = CallSites.back();
3803             if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3804               // Extend the range of the previous entry.
3805               Prev.EndLabel = Site.EndLabel;
3806               continue;
3807             }
3808           }
3809
3810           // Otherwise, create a new call-site.
3811           CallSites.push_back(Site);
3812           PreviousIsInvoke = true;
3813         } else {
3814           // Create a gap.
3815           PreviousIsInvoke = false;
3816         }
3817       }
3818     }
3819     // If some instruction between the previous try-range and the end of the
3820     // function may throw, create a call-site entry with no landing pad for the
3821     // region following the try-range.
3822     if (SawPotentiallyThrowing) {
3823       CallSiteEntry Site = {LastLabel, 0, 0, 0};
3824       CallSites.push_back(Site);
3825     }
3826
3827     // Final tallies.
3828
3829     // Call sites.
3830     const unsigned SiteStartSize  = sizeof(int32_t); // DW_EH_PE_udata4
3831     const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3832     const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3833     unsigned SizeSites = CallSites.size() * (SiteStartSize +
3834                                              SiteLengthSize +
3835                                              LandingPadSize);
3836     for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3837       SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
3838
3839     // Type infos.
3840     const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3841     unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
3842
3843     unsigned TypeOffset = sizeof(int8_t) + // Call site format
3844            TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
3845                           SizeSites + SizeActions + SizeTypes;
3846
3847     unsigned TotalSize = sizeof(int8_t) + // LPStart format
3848                          sizeof(int8_t) + // TType format
3849            TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
3850                          TypeOffset;
3851
3852     unsigned SizeAlign = (4 - TotalSize) & 3;
3853
3854     // Begin the exception table.
3855     Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3856     Asm->EmitAlignment(2, 0, 0, false);
3857     O << "GCC_except_table" << SubprogramCount << ":\n";
3858     for (unsigned i = 0; i != SizeAlign; ++i) {
3859       Asm->EmitInt8(0);
3860       Asm->EOL("Padding");
3861     }
3862     EmitLabel("exception", SubprogramCount);
3863
3864     // Emit the header.
3865     Asm->EmitInt8(DW_EH_PE_omit);
3866     Asm->EOL("LPStart format (DW_EH_PE_omit)");
3867     Asm->EmitInt8(DW_EH_PE_absptr);
3868     Asm->EOL("TType format (DW_EH_PE_absptr)");
3869     Asm->EmitULEB128Bytes(TypeOffset);
3870     Asm->EOL("TType base offset");
3871     Asm->EmitInt8(DW_EH_PE_udata4);
3872     Asm->EOL("Call site format (DW_EH_PE_udata4)");
3873     Asm->EmitULEB128Bytes(SizeSites);
3874     Asm->EOL("Call-site table length");
3875
3876     // Emit the landing pad site information.
3877     for (unsigned i = 0; i < CallSites.size(); ++i) {
3878       CallSiteEntry &S = CallSites[i];
3879       const char *BeginTag;
3880       unsigned BeginNumber;
3881
3882       if (!S.BeginLabel) {
3883         BeginTag = "eh_func_begin";
3884         BeginNumber = SubprogramCount;
3885       } else {
3886         BeginTag = "label";
3887         BeginNumber = S.BeginLabel;
3888       }
3889
3890       EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
3891                         true, true);
3892       Asm->EOL("Region start");
3893
3894       if (!S.EndLabel) {
3895         EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3896                        true);
3897       } else {
3898         EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
3899       }
3900       Asm->EOL("Region length");
3901
3902       if (!S.PadLabel)
3903         Asm->EmitInt32(0);
3904       else
3905         EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
3906                           true, true);
3907       Asm->EOL("Landing pad");
3908
3909       Asm->EmitULEB128Bytes(S.Action);
3910       Asm->EOL("Action");
3911     }
3912
3913     // Emit the actions.
3914     for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3915       ActionEntry &Action = Actions[I];
3916
3917       Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3918       Asm->EOL("TypeInfo index");
3919       Asm->EmitSLEB128Bytes(Action.NextAction);
3920       Asm->EOL("Next action");
3921     }
3922
3923     // Emit the type ids.
3924     for (unsigned M = TypeInfos.size(); M; --M) {
3925       GlobalVariable *GV = TypeInfos[M - 1];
3926
3927       PrintRelDirective();
3928
3929       if (GV)
3930         O << Asm->getGlobalLinkName(GV);
3931       else
3932         O << "0";
3933
3934       Asm->EOL("TypeInfo");
3935     }
3936
3937     // Emit the filter typeids.
3938     for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3939       unsigned TypeID = FilterIds[j];
3940       Asm->EmitULEB128Bytes(TypeID);
3941       Asm->EOL("Filter TypeInfo index");
3942     }
3943
3944     Asm->EmitAlignment(2, 0, 0, false);
3945   }
3946
3947 public:
3948   //===--------------------------------------------------------------------===//
3949   // Main entry points.
3950   //
3951   DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
3952   : Dwarf(OS, A, T, "eh")
3953   , shouldEmitTable(false)
3954   , shouldEmitMoves(false)
3955   , shouldEmitTableModule(false)
3956   , shouldEmitMovesModule(false)
3957   {}
3958
3959   virtual ~DwarfException() {}
3960
3961   /// SetModuleInfo - Set machine module information when it's known that pass
3962   /// manager has created it.  Set by the target AsmPrinter.
3963   void SetModuleInfo(MachineModuleInfo *mmi) {
3964     MMI = mmi;
3965   }
3966
3967   /// BeginModule - Emit all exception information that should come prior to the
3968   /// content.
3969   void BeginModule(Module *M) {
3970     this->M = M;
3971   }
3972
3973   /// EndModule - Emit all exception information that should come after the
3974   /// content.
3975   void EndModule() {
3976     if (shouldEmitMovesModule || shouldEmitTableModule) {
3977       const std::vector<Function *> Personalities = MMI->getPersonalities();
3978       for (unsigned i = 0; i < Personalities.size(); ++i)
3979         EmitCommonEHFrame(Personalities[i], i);
3980
3981       for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3982              E = EHFrames.end(); I != E; ++I)
3983         EmitEHFrame(*I);
3984     }
3985   }
3986
3987   /// BeginFunction - Gather pre-function exception information.  Assumes being
3988   /// emitted immediately after the function entry point.
3989   void BeginFunction(MachineFunction *MF) {
3990     this->MF = MF;
3991     shouldEmitTable = shouldEmitMoves = false;
3992     if (MMI && TAI->doesSupportExceptionHandling()) {
3993
3994       // Map all labels and get rid of any dead landing pads.
3995       MMI->TidyLandingPads();
3996       // If any landing pads survive, we need an EH table.
3997       if (MMI->getLandingPads().size())
3998         shouldEmitTable = true;
3999
4000       // See if we need frame move info.
4001       if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
4002         shouldEmitMoves = true;
4003
4004       if (shouldEmitMoves || shouldEmitTable)
4005         // Assumes in correct section after the entry point.
4006         EmitLabel("eh_func_begin", ++SubprogramCount);
4007     }
4008     shouldEmitTableModule |= shouldEmitTable;
4009     shouldEmitMovesModule |= shouldEmitMoves;
4010   }
4011
4012   /// EndFunction - Gather and emit post-function exception information.
4013   ///
4014   void EndFunction() {
4015     if (shouldEmitMoves || shouldEmitTable) {
4016       EmitLabel("eh_func_end", SubprogramCount);
4017       EmitExceptionTable();
4018
4019       // Save EH frame information
4020       EHFrames.
4021         push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
4022                                     SubprogramCount,
4023                                     MMI->getPersonalityIndex(),
4024                                     MF->getFrameInfo()->hasCalls(),
4025                                     !MMI->getLandingPads().empty(),
4026                                     MMI->getFrameMoves(),
4027                                     MF->getFunction()));
4028       }
4029   }
4030 };
4031
4032 } // End of namespace llvm
4033
4034 //===----------------------------------------------------------------------===//
4035
4036 /// Emit - Print the abbreviation using the specified Dwarf writer.
4037 ///
4038 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
4039   // Emit its Dwarf tag type.
4040   DD.getAsm()->EmitULEB128Bytes(Tag);
4041   DD.getAsm()->EOL(TagString(Tag));
4042
4043   // Emit whether it has children DIEs.
4044   DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
4045   DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
4046
4047   // For each attribute description.
4048   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4049     const DIEAbbrevData &AttrData = Data[i];
4050
4051     // Emit attribute type.
4052     DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
4053     DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
4054
4055     // Emit form type.
4056     DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
4057     DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
4058   }
4059
4060   // Mark end of abbreviation.
4061   DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
4062   DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
4063 }
4064
4065 #ifndef NDEBUG
4066 void DIEAbbrev::print(std::ostream &O) {
4067   O << "Abbreviation @"
4068     << std::hex << (intptr_t)this << std::dec
4069     << "  "
4070     << TagString(Tag)
4071     << " "
4072     << ChildrenString(ChildrenFlag)
4073     << "\n";
4074
4075   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4076     O << "  "
4077       << AttributeString(Data[i].getAttribute())
4078       << "  "
4079       << FormEncodingString(Data[i].getForm())
4080       << "\n";
4081   }
4082 }
4083 void DIEAbbrev::dump() { print(cerr); }
4084 #endif
4085
4086 //===----------------------------------------------------------------------===//
4087
4088 #ifndef NDEBUG
4089 void DIEValue::dump() {
4090   print(cerr);
4091 }
4092 #endif
4093
4094 //===----------------------------------------------------------------------===//
4095
4096 /// EmitValue - Emit integer of appropriate size.
4097 ///
4098 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
4099   switch (Form) {
4100   case DW_FORM_flag:  // Fall thru
4101   case DW_FORM_ref1:  // Fall thru
4102   case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer);         break;
4103   case DW_FORM_ref2:  // Fall thru
4104   case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer);        break;
4105   case DW_FORM_ref4:  // Fall thru
4106   case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer);        break;
4107   case DW_FORM_ref8:  // Fall thru
4108   case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer);        break;
4109   case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
4110   case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
4111   default: assert(0 && "DIE Value form not supported yet");   break;
4112   }
4113 }
4114
4115 /// SizeOf - Determine size of integer value in bytes.
4116 ///
4117 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4118   switch (Form) {
4119   case DW_FORM_flag:  // Fall thru
4120   case DW_FORM_ref1:  // Fall thru
4121   case DW_FORM_data1: return sizeof(int8_t);
4122   case DW_FORM_ref2:  // Fall thru
4123   case DW_FORM_data2: return sizeof(int16_t);
4124   case DW_FORM_ref4:  // Fall thru
4125   case DW_FORM_data4: return sizeof(int32_t);
4126   case DW_FORM_ref8:  // Fall thru
4127   case DW_FORM_data8: return sizeof(int64_t);
4128   case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
4129   case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
4130   default: assert(0 && "DIE Value form not supported yet"); break;
4131   }
4132   return 0;
4133 }
4134
4135 //===----------------------------------------------------------------------===//
4136
4137 /// EmitValue - Emit string value.
4138 ///
4139 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
4140   DD.getAsm()->EmitString(String);
4141 }
4142
4143 //===----------------------------------------------------------------------===//
4144
4145 /// EmitValue - Emit label value.
4146 ///
4147 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4148   bool IsSmall = Form == DW_FORM_data4;
4149   DD.EmitReference(Label, false, IsSmall);
4150 }
4151
4152 /// SizeOf - Determine size of label value in bytes.
4153 ///
4154 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4155   if (Form == DW_FORM_data4) return 4;
4156   return DD.getTargetData()->getPointerSize();
4157 }
4158
4159 //===----------------------------------------------------------------------===//
4160
4161 /// EmitValue - Emit label value.
4162 ///
4163 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4164   bool IsSmall = Form == DW_FORM_data4;
4165   DD.EmitReference(Label, false, IsSmall);
4166 }
4167
4168 /// SizeOf - Determine size of label value in bytes.
4169 ///
4170 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4171   if (Form == DW_FORM_data4) return 4;
4172   return DD.getTargetData()->getPointerSize();
4173 }
4174
4175 //===----------------------------------------------------------------------===//
4176
4177 /// EmitValue - Emit delta value.
4178 ///
4179 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4180   bool IsSmall = Form == DW_FORM_data4;
4181   DD.EmitSectionOffset(Label.Tag, Section.Tag,
4182                        Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4183 }
4184
4185 /// SizeOf - Determine size of delta value in bytes.
4186 ///
4187 unsigned DIESectionOffset::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 DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4197   bool IsSmall = Form == DW_FORM_data4;
4198   DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4199 }
4200
4201 /// SizeOf - Determine size of delta value in bytes.
4202 ///
4203 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4204   if (Form == DW_FORM_data4) return 4;
4205   return DD.getTargetData()->getPointerSize();
4206 }
4207
4208 //===----------------------------------------------------------------------===//
4209
4210 /// EmitValue - Emit debug information entry offset.
4211 ///
4212 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4213   DD.getAsm()->EmitInt32(Entry->getOffset());
4214 }
4215
4216 //===----------------------------------------------------------------------===//
4217
4218 /// ComputeSize - calculate the size of the block.
4219 ///
4220 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4221   if (!Size) {
4222     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4223
4224     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4225       Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4226     }
4227   }
4228   return Size;
4229 }
4230
4231 /// EmitValue - Emit block data.
4232 ///
4233 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4234   switch (Form) {
4235   case DW_FORM_block1: DD.getAsm()->EmitInt8(Size);         break;
4236   case DW_FORM_block2: DD.getAsm()->EmitInt16(Size);        break;
4237   case DW_FORM_block4: DD.getAsm()->EmitInt32(Size);        break;
4238   case DW_FORM_block:  DD.getAsm()->EmitULEB128Bytes(Size); break;
4239   default: assert(0 && "Improper form for block");          break;
4240   }
4241
4242   const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4243
4244   for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4245     DD.getAsm()->EOL();
4246     Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4247   }
4248 }
4249
4250 /// SizeOf - Determine size of block data in bytes.
4251 ///
4252 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4253   switch (Form) {
4254   case DW_FORM_block1: return Size + sizeof(int8_t);
4255   case DW_FORM_block2: return Size + sizeof(int16_t);
4256   case DW_FORM_block4: return Size + sizeof(int32_t);
4257   case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
4258   default: assert(0 && "Improper form for block"); break;
4259   }
4260   return 0;
4261 }
4262
4263 //===----------------------------------------------------------------------===//
4264 /// DIE Implementation
4265
4266 DIE::~DIE() {
4267   for (unsigned i = 0, N = Children.size(); i < N; ++i)
4268     delete Children[i];
4269 }
4270
4271 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4272 ///
4273 void DIE::AddSiblingOffset() {
4274   DIEInteger *DI = new DIEInteger(0);
4275   Values.insert(Values.begin(), DI);
4276   Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4277 }
4278
4279 /// Profile - Used to gather unique data for the value folding set.
4280 ///
4281 void DIE::Profile(FoldingSetNodeID &ID) {
4282   Abbrev.Profile(ID);
4283
4284   for (unsigned i = 0, N = Children.size(); i < N; ++i)
4285     ID.AddPointer(Children[i]);
4286
4287   for (unsigned j = 0, M = Values.size(); j < M; ++j)
4288     ID.AddPointer(Values[j]);
4289 }
4290
4291 #ifndef NDEBUG
4292 void DIE::print(std::ostream &O, unsigned IncIndent) {
4293   static unsigned IndentCount = 0;
4294   IndentCount += IncIndent;
4295   const std::string Indent(IndentCount, ' ');
4296   bool isBlock = Abbrev.getTag() == 0;
4297
4298   if (!isBlock) {
4299     O << Indent
4300       << "Die: "
4301       << "0x" << std::hex << (intptr_t)this << std::dec
4302       << ", Offset: " << Offset
4303       << ", Size: " << Size
4304       << "\n";
4305
4306     O << Indent
4307       << TagString(Abbrev.getTag())
4308       << " "
4309       << ChildrenString(Abbrev.getChildrenFlag());
4310   } else {
4311     O << "Size: " << Size;
4312   }
4313   O << "\n";
4314
4315   const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
4316
4317   IndentCount += 2;
4318   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4319     O << Indent;
4320
4321     if (!isBlock)
4322       O << AttributeString(Data[i].getAttribute());
4323     else
4324       O << "Blk[" << i << "]";
4325
4326     O <<  "  "
4327       << FormEncodingString(Data[i].getForm())
4328       << " ";
4329     Values[i]->print(O);
4330     O << "\n";
4331   }
4332   IndentCount -= 2;
4333
4334   for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4335     Children[j]->print(O, 4);
4336   }
4337
4338   if (!isBlock) O << "\n";
4339   IndentCount -= IncIndent;
4340 }
4341
4342 void DIE::dump() {
4343   print(cerr);
4344 }
4345 #endif
4346
4347 //===----------------------------------------------------------------------===//
4348 /// DwarfWriter Implementation
4349 ///
4350
4351 DwarfWriter::DwarfWriter() : ImmutablePass(&ID), DD(NULL), DE(NULL) {
4352 }
4353
4354 DwarfWriter::~DwarfWriter() {
4355   delete DE;
4356   delete DD;
4357 }
4358
4359 /// BeginModule - Emit all Dwarf sections that should come prior to the
4360 /// content.
4361 void DwarfWriter::BeginModule(Module *M,
4362                               MachineModuleInfo *MMI,
4363                               raw_ostream &OS, AsmPrinter *A,
4364                               const TargetAsmInfo *T) {
4365   DE = new DwarfException(OS, A, T);
4366   DD = new DwarfDebug(OS, A, T);
4367   DE->BeginModule(M);
4368   DD->BeginModule(M);
4369   DD->SetDebugInfo(MMI);
4370   DE->SetModuleInfo(MMI);
4371 }
4372
4373 /// EndModule - Emit all Dwarf sections that should come after the content.
4374 ///
4375 void DwarfWriter::EndModule() {
4376   DE->EndModule();
4377   DD->EndModule();
4378 }
4379
4380 /// BeginFunction - Gather pre-function debug information.  Assumes being
4381 /// emitted immediately after the function entry point.
4382 void DwarfWriter::BeginFunction(MachineFunction *MF) {
4383   DE->BeginFunction(MF);
4384   DD->BeginFunction(MF);
4385 }
4386
4387 /// EndFunction - Gather and emit post-function debug information.
4388 ///
4389 void DwarfWriter::EndFunction(MachineFunction *MF) {
4390   DD->EndFunction(MF);
4391   DE->EndFunction();
4392
4393   if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
4394     // Clear function debug information.
4395     MMI->EndFunction();
4396 }
4397
4398 /// ValidDebugInfo - Return true if V represents valid debug info value.
4399 bool DwarfWriter::ValidDebugInfo(Value *V) {
4400   return DD && DD->ValidDebugInfo(V);
4401 }
4402
4403 /// RecordSourceLine - Records location information and associates it with a
4404 /// label. Returns a unique label ID used to generate a label and provide
4405 /// correspondence to the source line list.
4406 unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4407                                        unsigned Src) {
4408   return DD->RecordSourceLine(Line, Col, Src);
4409 }
4410
4411 /// getOrCreateSourceID - Look up the source id with the given directory and
4412 /// source file names. If none currently exists, create a new id and insert it
4413 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
4414 /// as well.
4415 unsigned DwarfWriter::getOrCreateSourceID(const std::string &DirName,
4416                                           const std::string &FileName) {
4417   return DD->getOrCreateSourceID(DirName, FileName);
4418 }
4419
4420 /// RecordRegionStart - Indicate the start of a region.
4421 unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4422   return DD->RecordRegionStart(V);
4423 }
4424
4425 /// RecordRegionEnd - Indicate the end of a region.
4426 unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4427   return DD->RecordRegionEnd(V);
4428 }
4429
4430 /// getRecordSourceLineCount - Count source lines.
4431 unsigned DwarfWriter::getRecordSourceLineCount() {
4432   return DD->getRecordSourceLineCount();
4433 }
4434
4435 /// RecordVariable - Indicate the declaration of  a local variable.
4436 ///
4437 void DwarfWriter::RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
4438   DD->RecordVariable(GV, FrameIndex);
4439 }
4440
4441 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
4442 /// be emitted.
4443 bool DwarfWriter::ShouldEmitDwarfDebug() const {
4444   return DD->ShouldEmitDwarfDebug();
4445 }