lib/CodeGen/AsmPrinter/DwarfWriter.cpp

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