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