lib/CodeGen/AsmPrinter/DwarfWriter.cpp

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