lib/CodeGen/AsmPrinter/DwarfWriter.cpp

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