lib/CodeGen/AsmPrinter/DwarfWriter.cpp

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