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   /// AbbreviationsSet - Used to uniquely define abbreviations.
1278   ///
1279   FoldingSet<DIEAbbrev> AbbreviationsSet;
1280
1281   /// Abbreviations - A list of all the unique abbreviations in use.
1282   ///
1283   std::vector<DIEAbbrev *> Abbreviations;
1284
1285   /// Directories - Uniquing vector for directories.
1286   UniqueVector<std::string> Directories;
1287
1288   /// SourceFiles - Uniquing vector for source files.
1289   UniqueVector<SrcFileInfo> SrcFiles;
1290
1291   /// Lines - List of of source line correspondence.
1292   std::vector<SrcLineInfo> Lines;
1293
1294   /// ValuesSet - Used to uniquely define values.
1295   ///
1296   FoldingSet<DIEValue> ValuesSet;
1297
1298   /// Values - A list of all the unique values in use.
1299   ///
1300   std::vector<DIEValue *> Values;
1301
1302   /// StringPool - A UniqueVector of strings used by indirect references.
1303   ///
1304   UniqueVector<std::string> StringPool;
1305
1306   /// SectionMap - Provides a unique id per text section.
1307   ///
1308   UniqueVector<const Section*> SectionMap;
1309
1310   /// SectionSourceLines - Tracks line numbers per text section.
1311   ///
1312   std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
1313
1314   /// didInitial - Flag to indicate if initial emission has been done.
1315   ///
1316   bool didInitial;
1317
1318   /// shouldEmit - Flag to indicate if debug information should be emitted.
1319   ///
1320   bool shouldEmit;
1321
1322   // RootDbgScope - Top level scope for the current function.
1323   //
1324   DbgScope *RootDbgScope;
1325
1326   // DbgScopeMap - Tracks the scopes in the current function.
1327   DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
1328
1329   struct FunctionDebugFrameInfo {
1330     unsigned Number;
1331     std::vector<MachineMove> Moves;
1332
1333     FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
1334       Number(Num), Moves(M) { }
1335   };
1336
1337   std::vector<FunctionDebugFrameInfo> DebugFrames;
1338
1339 public:
1340
1341   /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1342   ///
1343   bool ShouldEmitDwarf() const { return shouldEmit; }
1344
1345   /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1346   ///
1347   void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1348     // Profile the node so that we can make it unique.
1349     FoldingSetNodeID ID;
1350     Abbrev.Profile(ID);
1351
1352     // Check the set for priors.
1353     DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1354
1355     // If it's newly added.
1356     if (InSet == &Abbrev) {
1357       // Add to abbreviation list.
1358       Abbreviations.push_back(&Abbrev);
1359       // Assign the vector position + 1 as its number.
1360       Abbrev.setNumber(Abbreviations.size());
1361     } else {
1362       // Assign existing abbreviation number.
1363       Abbrev.setNumber(InSet->getNumber());
1364     }
1365   }
1366
1367   /// NewString - Add a string to the constant pool and returns a label.
1368   ///
1369   DWLabel NewString(const std::string &String) {
1370     unsigned StringID = StringPool.insert(String);
1371     return DWLabel("string", StringID);
1372   }
1373
1374   /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1375   /// entry.
1376   DIEntry *NewDIEntry(DIE *Entry = NULL) {
1377     DIEntry *Value;
1378
1379     if (Entry) {
1380       FoldingSetNodeID ID;
1381       DIEntry::Profile(ID, Entry);
1382       void *Where;
1383       Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1384
1385       if (Value) return Value;
1386
1387       Value = new DIEntry(Entry);
1388       ValuesSet.InsertNode(Value, Where);
1389     } else {
1390       Value = new DIEntry(Entry);
1391     }
1392
1393     Values.push_back(Value);
1394     return Value;
1395   }
1396
1397   /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1398   ///
1399   void SetDIEntry(DIEntry *Value, DIE *Entry) {
1400     Value->Entry = Entry;
1401     // Add to values set if not already there.  If it is, we merely have a
1402     // duplicate in the values list (no harm.)
1403     ValuesSet.GetOrInsertNode(Value);
1404   }
1405
1406   /// AddUInt - Add an unsigned integer attribute data and value.
1407   ///
1408   void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1409     if (!Form) Form = DIEInteger::BestForm(false, Integer);
1410
1411     FoldingSetNodeID ID;
1412     DIEInteger::Profile(ID, Integer);
1413     void *Where;
1414     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1415     if (!Value) {
1416       Value = new DIEInteger(Integer);
1417       ValuesSet.InsertNode(Value, Where);
1418       Values.push_back(Value);
1419     }
1420
1421     Die->AddValue(Attribute, Form, Value);
1422   }
1423
1424   /// AddSInt - Add an signed integer attribute data and value.
1425   ///
1426   void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1427     if (!Form) Form = DIEInteger::BestForm(true, Integer);
1428
1429     FoldingSetNodeID ID;
1430     DIEInteger::Profile(ID, (uint64_t)Integer);
1431     void *Where;
1432     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1433     if (!Value) {
1434       Value = new DIEInteger(Integer);
1435       ValuesSet.InsertNode(Value, Where);
1436       Values.push_back(Value);
1437     }
1438
1439     Die->AddValue(Attribute, Form, Value);
1440   }
1441
1442   /// AddString - Add a std::string attribute data and value.
1443   ///
1444   void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1445                  const std::string &String) {
1446     FoldingSetNodeID ID;
1447     DIEString::Profile(ID, String);
1448     void *Where;
1449     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1450     if (!Value) {
1451       Value = new DIEString(String);
1452       ValuesSet.InsertNode(Value, Where);
1453       Values.push_back(Value);
1454     }
1455
1456     Die->AddValue(Attribute, Form, Value);
1457   }
1458
1459   /// AddLabel - Add a Dwarf label attribute data and value.
1460   ///
1461   void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1462                      const DWLabel &Label) {
1463     FoldingSetNodeID ID;
1464     DIEDwarfLabel::Profile(ID, Label);
1465     void *Where;
1466     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1467     if (!Value) {
1468       Value = new DIEDwarfLabel(Label);
1469       ValuesSet.InsertNode(Value, Where);
1470       Values.push_back(Value);
1471     }
1472
1473     Die->AddValue(Attribute, Form, Value);
1474   }
1475
1476   /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1477   ///
1478   void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1479                       const std::string &Label) {
1480     FoldingSetNodeID ID;
1481     DIEObjectLabel::Profile(ID, Label);
1482     void *Where;
1483     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1484     if (!Value) {
1485       Value = new DIEObjectLabel(Label);
1486       ValuesSet.InsertNode(Value, Where);
1487       Values.push_back(Value);
1488     }
1489
1490     Die->AddValue(Attribute, Form, Value);
1491   }
1492
1493   /// AddSectionOffset - Add a section offset label attribute data and value.
1494   ///
1495   void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1496                         const DWLabel &Label, const DWLabel &Section,
1497                         bool isEH = false, bool useSet = true) {
1498     FoldingSetNodeID ID;
1499     DIESectionOffset::Profile(ID, Label, Section);
1500     void *Where;
1501     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1502     if (!Value) {
1503       Value = new DIESectionOffset(Label, Section, isEH, useSet);
1504       ValuesSet.InsertNode(Value, Where);
1505       Values.push_back(Value);
1506     }
1507
1508     Die->AddValue(Attribute, Form, Value);
1509   }
1510
1511   /// AddDelta - Add a label delta attribute data and value.
1512   ///
1513   void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1514                           const DWLabel &Hi, const DWLabel &Lo) {
1515     FoldingSetNodeID ID;
1516     DIEDelta::Profile(ID, Hi, Lo);
1517     void *Where;
1518     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1519     if (!Value) {
1520       Value = new DIEDelta(Hi, Lo);
1521       ValuesSet.InsertNode(Value, Where);
1522       Values.push_back(Value);
1523     }
1524
1525     Die->AddValue(Attribute, Form, Value);
1526   }
1527
1528   /// AddDIEntry - Add a DIE attribute data and value.
1529   ///
1530   void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1531     Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1532   }
1533
1534   /// AddBlock - Add block data.
1535   ///
1536   void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1537     Block->ComputeSize(*this);
1538     FoldingSetNodeID ID;
1539     Block->Profile(ID);
1540     void *Where;
1541     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1542     if (!Value) {
1543       Value = Block;
1544       ValuesSet.InsertNode(Value, Where);
1545       Values.push_back(Value);
1546     } else {
1547       // Already exists, reuse the previous one.
1548       delete Block;
1549       Block = cast<DIEBlock>(Value);
1550     }
1551
1552     Die->AddValue(Attribute, Block->BestForm(), Value);
1553   }
1554
1555 private:
1556
1557   /// AddSourceLine - Add location information to specified debug information
1558   /// entry.
1559   void AddSourceLine(DIE *Die, const DIVariable *V) {
1560     unsigned FileID = 0;
1561     unsigned Line = V->getLineNumber();
1562     if (V->getVersion() <= LLVMDebugVersion6) {
1563       // Version6 or earlier. Use compile unit info to get file id.
1564       CompileUnit *Unit = FindCompileUnit(V->getCompileUnit());
1565       FileID = Unit->getID();
1566     } else {
1567       // Version7 or newer, use filename and directory info from DIVariable
1568       // directly.
1569       unsigned DID = Directories.idFor(V->getDirectory());
1570       FileID = SrcFiles.idFor(SrcFileInfo(DID, V->getFilename()));
1571     }
1572     AddUInt(Die, DW_AT_decl_file, 0, FileID);
1573     AddUInt(Die, DW_AT_decl_line, 0, Line);
1574   }
1575
1576   /// AddSourceLine - Add location information to specified debug information
1577   /// entry.
1578   void AddSourceLine(DIE *Die, const DIGlobal *G) {
1579     unsigned FileID = 0;
1580     unsigned Line = G->getLineNumber();
1581     if (G->getVersion() < LLVMDebugVersion6) {
1582       // Version6 or earlier. Use compile unit info to get file id.
1583       CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1584       FileID = Unit->getID();
1585     } else {
1586       // Version7 or newer, use filename and directory info from DIGlobal
1587       // directly.
1588       unsigned DID = Directories.idFor(G->getDirectory());
1589       FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1590     }
1591     AddUInt(Die, DW_AT_decl_file, 0, FileID);
1592     AddUInt(Die, DW_AT_decl_line, 0, Line);
1593   }
1594
1595   void AddSourceLine(DIE *Die, const DIType *Ty) {
1596     unsigned FileID = 0;
1597     unsigned Line = Ty->getLineNumber();
1598     if (Ty->getVersion() <= LLVMDebugVersion6) {
1599       // Version6 or earlier. Use compile unit info to get file id.
1600       CompileUnit *Unit = FindCompileUnit(Ty->getCompileUnit());
1601       FileID = Unit->getID();
1602     } else {
1603       // Version7 or newer, use filename and directory info from DIType
1604       // directly.
1605       unsigned DID = Directories.idFor(Ty->getDirectory());
1606       FileID = SrcFiles.idFor(SrcFileInfo(DID, Ty->getFilename()));
1607     }
1608     AddUInt(Die, DW_AT_decl_file, 0, FileID);
1609     AddUInt(Die, DW_AT_decl_line, 0, Line);
1610   }
1611
1612   /// AddAddress - Add an address attribute to a die based on the location
1613   /// provided.
1614   void AddAddress(DIE *Die, unsigned Attribute,
1615                             const MachineLocation &Location) {
1616     unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
1617     DIEBlock *Block = new DIEBlock();
1618
1619     if (Location.isReg()) {
1620       if (Reg < 32) {
1621         AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1622       } else {
1623         AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1624         AddUInt(Block, 0, DW_FORM_udata, Reg);
1625       }
1626     } else {
1627       if (Reg < 32) {
1628         AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1629       } else {
1630         AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1631         AddUInt(Block, 0, DW_FORM_udata, Reg);
1632       }
1633       AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1634     }
1635
1636     AddBlock(Die, Attribute, 0, Block);
1637   }
1638
1639   /// AddBasicType - Add a new basic type attribute to the specified entity.
1640   ///
1641   void AddBasicType(DIE *Entity, CompileUnit *Unit,
1642                     const std::string &Name,
1643                     unsigned Encoding, unsigned Size) {
1644
1645     DIE Buffer(DW_TAG_base_type);
1646     AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1647     AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1648     if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1649     DIE *BasicTypeDie = Unit->AddDie(Buffer);
1650     AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, BasicTypeDie);
1651   }
1652
1653   /// AddPointerType - Add a new pointer type attribute to the specified entity.
1654   ///
1655   void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1656     DIE Buffer(DW_TAG_pointer_type);
1657     AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
1658     if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1659     DIE *PointerTypeDie =  Unit->AddDie(Buffer);
1660     AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, PointerTypeDie);
1661   }
1662
1663   /// AddType - Add a new type attribute to the specified entity.
1664   void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
1665     if (Ty.isNull()) {
1666       AddBasicType(Entity, DW_Unit, "", DW_ATE_signed, sizeof(int32_t));
1667       return;
1668     }
1669
1670     // Check for pre-existence.
1671     DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1672     // If it exists then use the existing value.
1673     if (Slot) {
1674       Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1675       return;
1676     }
1677
1678     // Set up proxy.
1679     Slot = NewDIEntry();
1680
1681     // Construct type.
1682     DIE Buffer(DW_TAG_base_type);
1683     if (Ty.isBasicType(Ty.getTag()))
1684       ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getGV()));
1685     else if (Ty.isDerivedType(Ty.getTag()))
1686       ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getGV()));
1687     else {
1688       assert (Ty.isCompositeType(Ty.getTag()) && "Unknown kind of DIType");
1689       ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getGV()));
1690     }
1691
1692     // Add debug information entry to entity and unit.
1693     DIE *Die = DW_Unit->AddDie(Buffer);
1694     SetDIEntry(Slot, Die);
1695     Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1696   }
1697
1698   /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1699   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1700                         DIBasicType BTy) {
1701
1702     // Get core information.
1703     const std::string &Name = BTy.getName();
1704     Buffer.setTag(DW_TAG_base_type);
1705     AddUInt(&Buffer, DW_AT_encoding,  DW_FORM_data1, BTy.getEncoding());
1706     // Add name if not anonymous or intermediate type.
1707     if (!Name.empty())
1708       AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1709     uint64_t Size = BTy.getSizeInBits() >> 3;
1710     AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1711   }
1712
1713   /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1714   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1715                         DIDerivedType DTy) {
1716
1717     // Get core information.
1718     const std::string &Name = DTy.getName();
1719     uint64_t Size = DTy.getSizeInBits() >> 3;
1720     unsigned Tag = DTy.getTag();
1721     // FIXME - Workaround for templates.
1722     if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1723
1724     Buffer.setTag(Tag);
1725     // Map to main type, void will not have a type.
1726     DIType FromTy = DTy.getTypeDerivedFrom();
1727     AddType(DW_Unit, &Buffer, FromTy);
1728
1729     // Add name if not anonymous or intermediate type.
1730     if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1731
1732     // Add size if non-zero (derived types might be zero-sized.)
1733     if (Size)
1734       AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1735
1736     // Add source line info if available and TyDesc is not a forward
1737     // declaration.
1738     // FIXME - Enable this. if (!DTy.isForwardDecl())
1739     // FIXME - Enable this.     AddSourceLine(&Buffer, *DTy);
1740   }
1741
1742   /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1743   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1744                         DICompositeType CTy) {
1745
1746     // Get core information.
1747     const std::string &Name = CTy.getName();
1748     uint64_t Size = CTy.getSizeInBits() >> 3;
1749     unsigned Tag = CTy.getTag();
1750     Buffer.setTag(Tag);
1751     switch (Tag) {
1752     case DW_TAG_vector_type:
1753     case DW_TAG_array_type:
1754       ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
1755       break;
1756     case DW_TAG_enumeration_type:
1757       {
1758         DIArray Elements = CTy.getTypeArray();
1759         // Add enumerators to enumeration type.
1760         for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1761           DIE *ElemDie = NULL;
1762           DIEnumerator Enum(Elements.getElement(i).getGV());
1763           ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
1764           Buffer.AddChild(ElemDie);
1765         }
1766       }
1767       break;
1768     case DW_TAG_subroutine_type:
1769       {
1770         // Add prototype flag.
1771         AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1772         DIArray Elements = CTy.getTypeArray();
1773         // Add return type.
1774         DIDescriptor RTy = Elements.getElement(0);
1775         AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
1776
1777         // Add arguments.
1778         for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1779           DIE *Arg = new DIE(DW_TAG_formal_parameter);
1780           DIDescriptor Ty = Elements.getElement(i);
1781           AddType(DW_Unit, Arg, DIType(Ty.getGV()));
1782           Buffer.AddChild(Arg);
1783         }
1784       }
1785       break;
1786     case DW_TAG_structure_type:
1787     case DW_TAG_union_type:
1788       {
1789         // Add elements to structure type.
1790         DIArray Elements = CTy.getTypeArray();
1791
1792         // A forward struct declared type may not have elements available.
1793         if (Elements.isNull())
1794           break;
1795
1796         // Add elements to structure type.
1797         for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1798           DIDescriptor Element = Elements.getElement(i);
1799           DIE *ElemDie = NULL;
1800           if (Element.getTag() == dwarf::DW_TAG_subprogram)
1801             ElemDie = CreateSubprogramDIE(DW_Unit,
1802                                           DISubprogram(Element.getGV()));
1803           else if (Element.getTag() == dwarf::DW_TAG_variable) // ???
1804             ElemDie = CreateGlobalVariableDIE(DW_Unit,
1805                                               DIGlobalVariable(Element.getGV()));
1806           else
1807             ElemDie = CreateMemberDIE(DW_Unit,
1808                                       DIDerivedType(Element.getGV()));
1809           Buffer.AddChild(ElemDie);
1810         }
1811       }
1812       break;
1813     default:
1814       break;
1815     }
1816
1817     // Add name if not anonymous or intermediate type.
1818     if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1819
1820     // Add size if non-zero (derived types might be zero-sized.)
1821     if (Size)
1822       AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1823     else {
1824       // Add zero size if it is not a forward declaration.
1825       if (CTy.isForwardDecl())
1826         AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1827       else
1828         AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1829     }
1830
1831     // Add source line info if available.
1832     if (!CTy.isForwardDecl())
1833       AddSourceLine(&Buffer, &CTy);
1834   }
1835
1836   // ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1837   void ConstructSubrangeDIE (DIE &Buffer, DISubrange SR, DIE *IndexTy) {
1838     int64_t L = SR.getLo();
1839     int64_t H = SR.getHi();
1840     DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1841     if (L != H) {
1842       AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1843       if (L)
1844         AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1845       AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1846     }
1847     Buffer.AddChild(DW_Subrange);
1848   }
1849
1850   /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1851   void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1852                              DICompositeType *CTy) {
1853     Buffer.setTag(DW_TAG_array_type);
1854     if (CTy->getTag() == DW_TAG_vector_type)
1855       AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1856
1857     DIArray Elements = CTy->getTypeArray();
1858     AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1859
1860     // Construct an anonymous type for index type.
1861     DIE IdxBuffer(DW_TAG_base_type);
1862     AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1863     AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1864     DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1865
1866     // Add subranges to array type.
1867     for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1868       DIDescriptor Element = Elements.getElement(i);
1869       if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1870         ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
1871     }
1872   }
1873
1874   /// ConstructEnumTypeDIE - Construct enum type DIE from
1875   /// DIEnumerator.
1876   DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
1877
1878     DIE *Enumerator = new DIE(DW_TAG_enumerator);
1879     AddString(Enumerator, DW_AT_name, DW_FORM_string, ETy->getName());
1880     int64_t Value = ETy->getEnumValue();
1881     AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1882     return Enumerator;
1883   }
1884
1885   /// CreateGlobalVariableDIE - Create new DIE using GV.
1886   DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit, const DIGlobalVariable &GV)
1887   {
1888     DIE *GVDie = new DIE(DW_TAG_variable);
1889     AddString(GVDie, DW_AT_name, DW_FORM_string, GV.getName());
1890     const std::string &LinkageName = GV.getLinkageName();
1891     if (!LinkageName.empty())
1892       AddString(GVDie, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1893     AddType(DW_Unit, GVDie, GV.getType());
1894     if (!GV.isLocalToUnit())
1895       AddUInt(GVDie, DW_AT_external, DW_FORM_flag, 1);
1896     AddSourceLine(GVDie, &GV);
1897     return GVDie;
1898   }
1899
1900   /// CreateMemberDIE - Create new member DIE.
1901   DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT) {
1902     DIE *MemberDie = new DIE(DT.getTag());
1903     std::string Name = DT.getName();
1904     if (!Name.empty())
1905       AddString(MemberDie, DW_AT_name, DW_FORM_string, Name);
1906
1907     AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom());
1908
1909     AddSourceLine(MemberDie, &DT);
1910
1911     AddUInt(MemberDie, DW_AT_bit_size, 0, DT.getSizeInBits());
1912     DIEBlock *Block = new DIEBlock();
1913     AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1914     AddUInt(Block, 0, DW_FORM_udata, DT.getOffsetInBits() >> 3);
1915     AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1916
1917     if (DT.isProtected())
1918       AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_protected);
1919     else if (DT.isPrivate())
1920       AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_private);
1921
1922     return MemberDie;
1923   }
1924
1925   /// CreateSubprogramDIE - Create new DIE using SP.
1926   DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
1927                            const  DISubprogram &SP,
1928                            bool IsConstructor = false) {
1929     DIE *SPDie = new DIE(DW_TAG_subprogram);
1930     AddString(SPDie, DW_AT_name, DW_FORM_string, SP.getName());
1931     const std::string &LinkageName = SP.getLinkageName();
1932     if (!LinkageName.empty())
1933       AddString(SPDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1934                 LinkageName);
1935     AddSourceLine(SPDie, &SP);
1936
1937     DICompositeType SPTy = SP.getType();
1938     DIArray Args = SPTy.getTypeArray();
1939
1940     // Add Return Type.
1941     if (!IsConstructor)
1942       AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getGV()));
1943
1944     // Add arguments.
1945     if (!Args.isNull())
1946       for (unsigned i = 1, N =  Args.getNumElements(); i < N; ++i) {
1947         DIE *Arg = new DIE(DW_TAG_formal_parameter);
1948         AddType(DW_Unit, Arg, DIType(Args.getElement(i).getGV()));
1949         AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1950         SPDie->AddChild(Arg);
1951       }
1952
1953     if (!SP.isLocalToUnit())
1954       AddUInt(SPDie, DW_AT_external, DW_FORM_flag, 1);
1955     return SPDie;
1956   }
1957
1958   /// FindCompileUnit - Get the compile unit for the given descriptor.
1959   ///
1960   CompileUnit *FindCompileUnit(DICompileUnit Unit) {
1961     CompileUnit *DW_Unit = DW_CUs[Unit.getGV()];
1962     assert(DW_Unit && "Missing compile unit.");
1963     return DW_Unit;
1964   }
1965
1966   /// NewDbgScopeVariable - Create a new scope variable.
1967   ///
1968   DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
1969     // Get the descriptor.
1970     const DIVariable &VD = DV->getVariable();
1971
1972     // Translate tag to proper Dwarf tag.  The result variable is dropped for
1973     // now.
1974     unsigned Tag;
1975     switch (VD.getTag()) {
1976     case DW_TAG_return_variable:  return NULL;
1977     case DW_TAG_arg_variable:     Tag = DW_TAG_formal_parameter; break;
1978     case DW_TAG_auto_variable:    // fall thru
1979     default:                      Tag = DW_TAG_variable; break;
1980     }
1981
1982     // Define variable debug information entry.
1983     DIE *VariableDie = new DIE(Tag);
1984     AddString(VariableDie, DW_AT_name, DW_FORM_string, VD.getName());
1985
1986     // Add source line info if available.
1987     AddSourceLine(VariableDie, &VD);
1988
1989     // Add variable type.
1990     AddType(Unit, VariableDie, VD.getType());
1991
1992     // Add variable address.
1993     MachineLocation Location;
1994     Location.set(RI->getFrameRegister(*MF),
1995                  RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1996     AddAddress(VariableDie, DW_AT_location, Location);
1997
1998     return VariableDie;
1999   }
2000
2001   /// getOrCreateScope - Returns the scope associated with the given descriptor.
2002   ///
2003   DbgScope *getOrCreateScope(GlobalVariable *V) {
2004     DbgScope *&Slot = DbgScopeMap[V];
2005     if (!Slot) {
2006       // FIXME - breaks down when the context is an inlined function.
2007       DIDescriptor ParentDesc;
2008       DIDescriptor Desc(V);
2009       if (Desc.getTag() == dwarf::DW_TAG_lexical_block) {
2010         DIBlock Block(V);
2011         ParentDesc = Block.getContext();
2012       }
2013       DbgScope *Parent = ParentDesc.isNull() ?
2014         NULL : getOrCreateScope(ParentDesc.getGV());
2015       Slot = new DbgScope(Parent, Desc);
2016       if (Parent) {
2017         Parent->AddScope(Slot);
2018       } else if (RootDbgScope) {
2019         // FIXME - Add inlined function scopes to the root so we can delete
2020         // them later.  Long term, handle inlined functions properly.
2021         RootDbgScope->AddScope(Slot);
2022       } else {
2023         // First function is top level function.
2024         RootDbgScope = Slot;
2025       }
2026     }
2027     return Slot;
2028   }
2029
2030   /// ConstructDbgScope - Construct the components of a scope.
2031   ///
2032   void ConstructDbgScope(DbgScope *ParentScope,
2033                          unsigned ParentStartID, unsigned ParentEndID,
2034                          DIE *ParentDie, CompileUnit *Unit) {
2035     // Add variables to scope.
2036     SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
2037     for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2038       DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2039       if (VariableDie) ParentDie->AddChild(VariableDie);
2040     }
2041
2042     // Add nested scopes.
2043     SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
2044     for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2045       // Define the Scope debug information entry.
2046       DbgScope *Scope = Scopes[j];
2047       // FIXME - Ignore inlined functions for the time being.
2048       if (!Scope->getParent()) continue;
2049
2050       unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2051       unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2052
2053       // Ignore empty scopes.
2054       if (StartID == EndID && StartID != 0) continue;
2055       if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2056
2057       if (StartID == ParentStartID && EndID == ParentEndID) {
2058         // Just add stuff to the parent scope.
2059         ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2060       } else {
2061         DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2062
2063         // Add the scope bounds.
2064         if (StartID) {
2065           AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2066                              DWLabel("label", StartID));
2067         } else {
2068           AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2069                              DWLabel("func_begin", SubprogramCount));
2070         }
2071         if (EndID) {
2072           AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2073                              DWLabel("label", EndID));
2074         } else {
2075           AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2076                              DWLabel("func_end", SubprogramCount));
2077         }
2078
2079         // Add the scope contents.
2080         ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2081         ParentDie->AddChild(ScopeDie);
2082       }
2083     }
2084   }
2085
2086   /// ConstructRootDbgScope - Construct the scope for the subprogram.
2087   ///
2088   void ConstructRootDbgScope(DbgScope *RootScope) {
2089     // Exit if there is no root scope.
2090     if (!RootScope) return;
2091     DIDescriptor Desc = RootScope->getDesc();
2092     if (Desc.isNull())
2093       return;
2094
2095     // Get the subprogram debug information entry.
2096     DISubprogram SPD(Desc.getGV());
2097
2098     // Get the compile unit context.
2099     CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
2100
2101     // Get the subprogram die.
2102     DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2103     assert(SPDie && "Missing subprogram descriptor");
2104
2105     // Add the function bounds.
2106     AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2107                     DWLabel("func_begin", SubprogramCount));
2108     AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2109                     DWLabel("func_end", SubprogramCount));
2110     MachineLocation Location(RI->getFrameRegister(*MF));
2111     AddAddress(SPDie, DW_AT_frame_base, Location);
2112
2113     ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2114   }
2115
2116   /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2117   ///
2118   void ConstructDefaultDbgScope(MachineFunction *MF) {
2119     // Find the correct subprogram descriptor.
2120     std::string SPName = "llvm.dbg.subprograms";
2121     std::vector<GlobalVariable*> Result;
2122     getGlobalVariablesUsing(*M, SPName, Result);
2123     for (std::vector<GlobalVariable *>::iterator I = Result.begin(),
2124            E = Result.end(); I != E; ++I) {
2125
2126       DISubprogram SPD(*I);
2127
2128       if (SPD.getName() == MF->getFunction()->getName()) {
2129         // Get the compile unit context.
2130         CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
2131
2132         // Get the subprogram die.
2133         DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2134         assert(SPDie && "Missing subprogram descriptor");
2135
2136         // Add the function bounds.
2137         AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2138                  DWLabel("func_begin", SubprogramCount));
2139         AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2140                  DWLabel("func_end", SubprogramCount));
2141
2142         MachineLocation Location(RI->getFrameRegister(*MF));
2143         AddAddress(SPDie, DW_AT_frame_base, Location);
2144         return;
2145       }
2146     }
2147 #if 0
2148     // FIXME: This is causing an abort because C++ mangled names are compared
2149     // with their unmangled counterparts. See PR2885. Don't do this assert.
2150     assert(0 && "Couldn't find DIE for machine function!");
2151 #endif
2152   }
2153
2154   /// EmitInitial - Emit initial Dwarf declarations.  This is necessary for cc
2155   /// tools to recognize the object file contains Dwarf information.
2156   void EmitInitial() {
2157     // Check to see if we already emitted intial headers.
2158     if (didInitial) return;
2159     didInitial = true;
2160
2161     // Dwarf sections base addresses.
2162     if (TAI->doesDwarfRequireFrameSection()) {
2163       Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2164       EmitLabel("section_debug_frame", 0);
2165     }
2166     Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2167     EmitLabel("section_info", 0);
2168     Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2169     EmitLabel("section_abbrev", 0);
2170     Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2171     EmitLabel("section_aranges", 0);
2172     Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2173     EmitLabel("section_macinfo", 0);
2174     Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2175     EmitLabel("section_line", 0);
2176     Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2177     EmitLabel("section_loc", 0);
2178     Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2179     EmitLabel("section_pubnames", 0);
2180     Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2181     EmitLabel("section_str", 0);
2182     Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2183     EmitLabel("section_ranges", 0);
2184
2185     Asm->SwitchToSection(TAI->getTextSection());
2186     EmitLabel("text_begin", 0);
2187     Asm->SwitchToSection(TAI->getDataSection());
2188     EmitLabel("data_begin", 0);
2189   }
2190
2191   /// EmitDIE - Recusively Emits a debug information entry.
2192   ///
2193   void EmitDIE(DIE *Die) {
2194     // Get the abbreviation for this DIE.
2195     unsigned AbbrevNumber = Die->getAbbrevNumber();
2196     const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2197
2198     Asm->EOL();
2199
2200     // Emit the code (index) for the abbreviation.
2201     Asm->EmitULEB128Bytes(AbbrevNumber);
2202
2203     if (VerboseAsm)
2204       Asm->EOL(std::string("Abbrev [" +
2205                            utostr(AbbrevNumber) +
2206                            "] 0x" + utohexstr(Die->getOffset()) +
2207                            ":0x" + utohexstr(Die->getSize()) + " " +
2208                            TagString(Abbrev->getTag())));
2209     else
2210       Asm->EOL();
2211
2212     SmallVector<DIEValue*, 32> &Values = Die->getValues();
2213     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2214
2215     // Emit the DIE attribute values.
2216     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2217       unsigned Attr = AbbrevData[i].getAttribute();
2218       unsigned Form = AbbrevData[i].getForm();
2219       assert(Form && "Too many attributes for DIE (check abbreviation)");
2220
2221       switch (Attr) {
2222       case DW_AT_sibling: {
2223         Asm->EmitInt32(Die->SiblingOffset());
2224         break;
2225       }
2226       default: {
2227         // Emit an attribute using the defined form.
2228         Values[i]->EmitValue(*this, Form);
2229         break;
2230       }
2231       }
2232
2233       Asm->EOL(AttributeString(Attr));
2234     }
2235
2236     // Emit the DIE children if any.
2237     if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2238       const std::vector<DIE *> &Children = Die->getChildren();
2239
2240       for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2241         EmitDIE(Children[j]);
2242       }
2243
2244       Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2245     }
2246   }
2247
2248   /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2249   ///
2250   unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2251     // Get the children.
2252     const std::vector<DIE *> &Children = Die->getChildren();
2253
2254     // If not last sibling and has children then add sibling offset attribute.
2255     if (!Last && !Children.empty()) Die->AddSiblingOffset();
2256
2257     // Record the abbreviation.
2258     AssignAbbrevNumber(Die->getAbbrev());
2259
2260     // Get the abbreviation for this DIE.
2261     unsigned AbbrevNumber = Die->getAbbrevNumber();
2262     const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2263
2264     // Set DIE offset
2265     Die->setOffset(Offset);
2266
2267     // Start the size with the size of abbreviation code.
2268     Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2269
2270     const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2271     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2272
2273     // Size the DIE attribute values.
2274     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2275       // Size attribute value.
2276       Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2277     }
2278
2279     // Size the DIE children if any.
2280     if (!Children.empty()) {
2281       assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2282              "Children flag not set");
2283
2284       for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2285         Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2286       }
2287
2288       // End of children marker.
2289       Offset += sizeof(int8_t);
2290     }
2291
2292     Die->setSize(Offset - Die->getOffset());
2293     return Offset;
2294   }
2295
2296   /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2297   ///
2298   void SizeAndOffsets() {
2299     // Process base compile unit.
2300     for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2301            CE = DW_CUs.end(); CI != CE; ++CI) {
2302       CompileUnit *Unit = CI->second;
2303       // Compute size of compile unit header
2304       unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2305         sizeof(int16_t) + // DWARF version number
2306         sizeof(int32_t) + // Offset Into Abbrev. Section
2307         sizeof(int8_t);   // Pointer Size (in bytes)
2308       SizeAndOffsetDie(Unit->getDie(), Offset, true);
2309     }
2310   }
2311
2312   /// EmitDebugInfo - Emit the debug info section.
2313   ///
2314   void EmitDebugInfo() {
2315     // Start debug info section.
2316     Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2317
2318     for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2319            CE = DW_CUs.end(); CI != CE; ++CI) {
2320       CompileUnit *Unit = CI->second;
2321       DIE *Die = Unit->getDie();
2322       // Emit the compile units header.
2323       EmitLabel("info_begin", Unit->getID());
2324       // Emit size of content not including length itself
2325       unsigned ContentSize = Die->getSize() +
2326         sizeof(int16_t) + // DWARF version number
2327         sizeof(int32_t) + // Offset Into Abbrev. Section
2328         sizeof(int8_t) +  // Pointer Size (in bytes)
2329         sizeof(int32_t);  // FIXME - extra pad for gdb bug.
2330
2331       Asm->EmitInt32(ContentSize);  Asm->EOL("Length of Compilation Unit Info");
2332       Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2333       EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2334       Asm->EOL("Offset Into Abbrev. Section");
2335       Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2336
2337       EmitDIE(Die);
2338       // FIXME - extra padding for gdb bug.
2339       Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2340       Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2341       Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2342       Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2343       EmitLabel("info_end", Unit->getID());
2344
2345       Asm->EOL();
2346     }
2347   }
2348
2349   /// EmitAbbreviations - Emit the abbreviation section.
2350   ///
2351   void EmitAbbreviations() const {
2352     // Check to see if it is worth the effort.
2353     if (!Abbreviations.empty()) {
2354       // Start the debug abbrev section.
2355       Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2356
2357       EmitLabel("abbrev_begin", 0);
2358
2359       // For each abbrevation.
2360       for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2361         // Get abbreviation data
2362         const DIEAbbrev *Abbrev = Abbreviations[i];
2363
2364         // Emit the abbrevations code (base 1 index.)
2365         Asm->EmitULEB128Bytes(Abbrev->getNumber());
2366         Asm->EOL("Abbreviation Code");
2367
2368         // Emit the abbreviations data.
2369         Abbrev->Emit(*this);
2370
2371         Asm->EOL();
2372       }
2373
2374       // Mark end of abbreviations.
2375       Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2376
2377       EmitLabel("abbrev_end", 0);
2378
2379       Asm->EOL();
2380     }
2381   }
2382
2383   /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2384   /// the line matrix.
2385   ///
2386   void EmitEndOfLineMatrix(unsigned SectionEnd) {
2387     // Define last address of section.
2388     Asm->EmitInt8(0); Asm->EOL("Extended Op");
2389     Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2390     Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2391     EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2392
2393     // Mark end of matrix.
2394     Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2395     Asm->EmitULEB128Bytes(1); Asm->EOL();
2396     Asm->EmitInt8(1); Asm->EOL();
2397   }
2398
2399   /// EmitDebugLines - Emit source line information.
2400   ///
2401   void EmitDebugLines() {
2402     // If the target is using .loc/.file, the assembler will be emitting the
2403     // .debug_line table automatically.
2404     if (TAI->hasDotLocAndDotFile())
2405       return;
2406
2407     // Minimum line delta, thus ranging from -10..(255-10).
2408     const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2409     // Maximum line delta, thus ranging from -10..(255-10).
2410     const int MaxLineDelta = 255 + MinLineDelta;
2411
2412     // Start the dwarf line section.
2413     Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2414
2415     // Construct the section header.
2416
2417     EmitDifference("line_end", 0, "line_begin", 0, true);
2418     Asm->EOL("Length of Source Line Info");
2419     EmitLabel("line_begin", 0);
2420
2421     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2422
2423     EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2424     Asm->EOL("Prolog Length");
2425     EmitLabel("line_prolog_begin", 0);
2426
2427     Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2428
2429     Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2430
2431     Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2432
2433     Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2434
2435     Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2436
2437     // Line number standard opcode encodings argument count
2438     Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2439     Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2440     Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2441     Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2442     Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2443     Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2444     Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2445     Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2446     Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2447
2448     // Emit directories.
2449     for (unsigned DirectoryID = 1, NDID = Directories.size();
2450                   DirectoryID <= NDID; ++DirectoryID) {
2451       Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2452     }
2453     Asm->EmitInt8(0); Asm->EOL("End of directories");
2454
2455     // Emit files.
2456     for (unsigned SourceID = 1, NSID = SrcFiles.size();
2457                  SourceID <= NSID; ++SourceID) {
2458       const SrcFileInfo &SourceFile = SrcFiles[SourceID];
2459       Asm->EmitString(SourceFile.getName());
2460       Asm->EOL("Source");
2461       Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2462       Asm->EOL("Directory #");
2463       Asm->EmitULEB128Bytes(0);
2464       Asm->EOL("Mod date");
2465       Asm->EmitULEB128Bytes(0);
2466       Asm->EOL("File size");
2467     }
2468     Asm->EmitInt8(0); Asm->EOL("End of files");
2469
2470     EmitLabel("line_prolog_end", 0);
2471
2472     // A sequence for each text section.
2473     unsigned SecSrcLinesSize = SectionSourceLines.size();
2474
2475     for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2476       // Isolate current sections line info.
2477       const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2478
2479       if (VerboseAsm) {
2480         const Section* S = SectionMap[j + 1];
2481         Asm->EOL(std::string("Section ") + S->getName());
2482       } else
2483         Asm->EOL();
2484
2485       // Dwarf assumes we start with first line of first source file.
2486       unsigned Source = 1;
2487       unsigned Line = 1;
2488
2489       // Construct rows of the address, source, line, column matrix.
2490       for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2491         const SrcLineInfo &LineInfo = LineInfos[i];
2492         unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2493         if (!LabelID) continue;
2494
2495         unsigned SourceID = LineInfo.getSourceID();
2496         const SrcFileInfo &SourceFile = SrcFiles[SourceID];
2497         unsigned DirectoryID = SourceFile.getDirectoryID();
2498         if (VerboseAsm)
2499           Asm->EOL(Directories[DirectoryID]
2500                    + SourceFile.getName()
2501                    + ":"
2502                    + utostr_32(LineInfo.getLine()));
2503         else
2504           Asm->EOL();
2505
2506         // Define the line address.
2507         Asm->EmitInt8(0); Asm->EOL("Extended Op");
2508         Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2509         Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2510         EmitReference("label",  LabelID); Asm->EOL("Location label");
2511
2512         // If change of source, then switch to the new source.
2513         if (Source != LineInfo.getSourceID()) {
2514           Source = LineInfo.getSourceID();
2515           Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2516           Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2517         }
2518
2519         // If change of line.
2520         if (Line != LineInfo.getLine()) {
2521           // Determine offset.
2522           int Offset = LineInfo.getLine() - Line;
2523           int Delta = Offset - MinLineDelta;
2524
2525           // Update line.
2526           Line = LineInfo.getLine();
2527
2528           // If delta is small enough and in range...
2529           if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2530             // ... then use fast opcode.
2531             Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2532           } else {
2533             // ... otherwise use long hand.
2534             Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2535             Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2536             Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2537           }
2538         } else {
2539           // Copy the previous row (different address or source)
2540           Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2541         }
2542       }
2543
2544       EmitEndOfLineMatrix(j + 1);
2545     }
2546
2547     if (SecSrcLinesSize == 0)
2548       // Because we're emitting a debug_line section, we still need a line
2549       // table. The linker and friends expect it to exist. If there's nothing to
2550       // put into it, emit an empty table.
2551       EmitEndOfLineMatrix(1);
2552
2553     EmitLabel("line_end", 0);
2554
2555     Asm->EOL();
2556   }
2557
2558   /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2559   ///
2560   void EmitCommonDebugFrame() {
2561     if (!TAI->doesDwarfRequireFrameSection())
2562       return;
2563
2564     int stackGrowth =
2565         Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2566           TargetFrameInfo::StackGrowsUp ?
2567         TD->getPointerSize() : -TD->getPointerSize();
2568
2569     // Start the dwarf frame section.
2570     Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2571
2572     EmitLabel("debug_frame_common", 0);
2573     EmitDifference("debug_frame_common_end", 0,
2574                    "debug_frame_common_begin", 0, true);
2575     Asm->EOL("Length of Common Information Entry");
2576
2577     EmitLabel("debug_frame_common_begin", 0);
2578     Asm->EmitInt32((int)DW_CIE_ID);
2579     Asm->EOL("CIE Identifier Tag");
2580     Asm->EmitInt8(DW_CIE_VERSION);
2581     Asm->EOL("CIE Version");
2582     Asm->EmitString("");
2583     Asm->EOL("CIE Augmentation");
2584     Asm->EmitULEB128Bytes(1);
2585     Asm->EOL("CIE Code Alignment Factor");
2586     Asm->EmitSLEB128Bytes(stackGrowth);
2587     Asm->EOL("CIE Data Alignment Factor");
2588     Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2589     Asm->EOL("CIE RA Column");
2590
2591     std::vector<MachineMove> Moves;
2592     RI->getInitialFrameState(Moves);
2593
2594     EmitFrameMoves(NULL, 0, Moves, false);
2595
2596     Asm->EmitAlignment(2, 0, 0, false);
2597     EmitLabel("debug_frame_common_end", 0);
2598
2599     Asm->EOL();
2600   }
2601
2602   /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2603   /// section.
2604   void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2605     if (!TAI->doesDwarfRequireFrameSection())
2606       return;
2607
2608     // Start the dwarf frame section.
2609     Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2610
2611     EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2612                    "debug_frame_begin", DebugFrameInfo.Number, true);
2613     Asm->EOL("Length of Frame Information Entry");
2614
2615     EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2616
2617     EmitSectionOffset("debug_frame_common", "section_debug_frame",
2618                       0, 0, true, false);
2619     Asm->EOL("FDE CIE offset");
2620
2621     EmitReference("func_begin", DebugFrameInfo.Number);
2622     Asm->EOL("FDE initial location");
2623     EmitDifference("func_end", DebugFrameInfo.Number,
2624                    "func_begin", DebugFrameInfo.Number);
2625     Asm->EOL("FDE address range");
2626
2627     EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2628                    false);
2629
2630     Asm->EmitAlignment(2, 0, 0, false);
2631     EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2632
2633     Asm->EOL();
2634   }
2635
2636   /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2637   ///
2638   void EmitDebugPubNames() {
2639     // Start the dwarf pubnames section.
2640     Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2641
2642     for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2643            CE = DW_CUs.end(); CI != CE; ++CI) {
2644       CompileUnit *Unit = CI->second;
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     }
2679   }
2680
2681   /// EmitDebugStr - Emit visible names into a debug str section.
2682   ///
2683   void EmitDebugStr() {
2684     // Check to see if it is worth the effort.
2685     if (!StringPool.empty()) {
2686       // Start the dwarf str section.
2687       Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2688
2689       // For each of strings in the string pool.
2690       for (unsigned StringID = 1, N = StringPool.size();
2691            StringID <= N; ++StringID) {
2692         // Emit a label for reference from debug information entries.
2693         EmitLabel("string", StringID);
2694         // Emit the string itself.
2695         const std::string &String = StringPool[StringID];
2696         Asm->EmitString(String); Asm->EOL();
2697       }
2698
2699       Asm->EOL();
2700     }
2701   }
2702
2703   /// EmitDebugLoc - Emit visible names into a debug loc section.
2704   ///
2705   void EmitDebugLoc() {
2706     // Start the dwarf loc section.
2707     Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2708
2709     Asm->EOL();
2710   }
2711
2712   /// EmitDebugARanges - Emit visible names into a debug aranges section.
2713   ///
2714   void EmitDebugARanges() {
2715     // Start the dwarf aranges section.
2716     Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2717
2718     // FIXME - Mock up
2719 #if 0
2720     CompileUnit *Unit = GetBaseCompileUnit();
2721
2722     // Don't include size of length
2723     Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2724
2725     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2726
2727     EmitReference("info_begin", Unit->getID());
2728     Asm->EOL("Offset of Compilation Unit Info");
2729
2730     Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2731
2732     Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2733
2734     Asm->EmitInt16(0);  Asm->EOL("Pad (1)");
2735     Asm->EmitInt16(0);  Asm->EOL("Pad (2)");
2736
2737     // Range 1
2738     EmitReference("text_begin", 0); Asm->EOL("Address");
2739     EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2740
2741     Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2742     Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2743 #endif
2744
2745     Asm->EOL();
2746   }
2747
2748   /// EmitDebugRanges - Emit visible names into a debug ranges section.
2749   ///
2750   void EmitDebugRanges() {
2751     // Start the dwarf ranges section.
2752     Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2753
2754     Asm->EOL();
2755   }
2756
2757   /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2758   ///
2759   void EmitDebugMacInfo() {
2760     // Start the dwarf macinfo section.
2761     Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2762
2763     Asm->EOL();
2764   }
2765
2766   /// ConstructCompileUnits - Create a compile unit DIEs.
2767   void ConstructCompileUnits() {
2768     std::string CUName = "llvm.dbg.compile_units";
2769     std::vector<GlobalVariable*> Result;
2770     getGlobalVariablesUsing(*M, CUName, Result);
2771     for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2772            RE = Result.end(); RI != RE; ++RI) {
2773       DICompileUnit DIUnit(*RI);
2774       unsigned ID = RecordSource(DIUnit.getDirectory(),
2775                                  DIUnit.getFilename());
2776
2777       DIE *Die = new DIE(DW_TAG_compile_unit);
2778       AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2779                        DWLabel("section_line", 0), DWLabel("section_line", 0),
2780                        false);
2781       AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit.getProducer());
2782       AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit.getLanguage());
2783       AddString(Die, DW_AT_name, DW_FORM_string, DIUnit.getFilename());
2784       if (!DIUnit.getDirectory().empty())
2785         AddString(Die, DW_AT_comp_dir, DW_FORM_string, DIUnit.getDirectory());
2786
2787       CompileUnit *Unit = new CompileUnit(ID, Die);
2788       DW_CUs[DIUnit.getGV()] = Unit;
2789     }
2790   }
2791
2792   /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
2793   /// visible global variables.
2794   void ConstructGlobalVariableDIEs() {
2795     std::string GVName = "llvm.dbg.global_variables";
2796     std::vector<GlobalVariable*> Result;
2797     getGlobalVariablesUsing(*M, GVName, Result);
2798     for (std::vector<GlobalVariable *>::iterator GVI = Result.begin(),
2799            GVE = Result.end(); GVI != GVE; ++GVI) {
2800       DIGlobalVariable DI_GV(*GVI);
2801       CompileUnit *DW_Unit = FindCompileUnit(DI_GV.getCompileUnit());
2802
2803       // Check for pre-existence.
2804       DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV.getGV());
2805       if (Slot) continue;
2806
2807       DIE *VariableDie = CreateGlobalVariableDIE(DW_Unit, DI_GV);
2808
2809       // Add address.
2810       DIEBlock *Block = new DIEBlock();
2811       AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2812       AddObjectLabel(Block, 0, DW_FORM_udata,
2813                      Asm->getGlobalLinkName(DI_GV.getGlobal()));
2814       AddBlock(VariableDie, DW_AT_location, 0, Block);
2815
2816       //Add to map.
2817       Slot = VariableDie;
2818
2819       //Add to context owner.
2820       DW_Unit->getDie()->AddChild(VariableDie);
2821
2822       //Expose as global. FIXME - need to check external flag.
2823       DW_Unit->AddGlobal(DI_GV.getName(), VariableDie);
2824     }
2825   }
2826
2827   /// ConstructSubprograms - Create DIEs for each of the externally visible
2828   /// subprograms.
2829   void ConstructSubprograms() {
2830
2831     std::string SPName = "llvm.dbg.subprograms";
2832     std::vector<GlobalVariable*> Result;
2833     getGlobalVariablesUsing(*M, SPName, Result);
2834     for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2835            RE = Result.end(); RI != RE; ++RI) {
2836
2837       DISubprogram SP(*RI);
2838       CompileUnit *Unit = FindCompileUnit(SP.getCompileUnit());
2839
2840       // Check for pre-existence.
2841       DIE *&Slot = Unit->getDieMapSlotFor(SP.getGV());
2842       if (Slot) continue;
2843
2844       DIE *SubprogramDie = CreateSubprogramDIE(Unit, SP);
2845
2846       //Add to map.
2847       Slot = SubprogramDie;
2848       //Add to context owner.
2849       Unit->getDie()->AddChild(SubprogramDie);
2850       //Expose as global.
2851       Unit->AddGlobal(SP.getName(), SubprogramDie);
2852     }
2853   }
2854
2855 public:
2856   //===--------------------------------------------------------------------===//
2857   // Main entry points.
2858   //
2859   DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2860   : Dwarf(OS, A, T, "dbg")
2861   , AbbreviationsSet(InitAbbreviationsSetSize)
2862   , Abbreviations()
2863   , ValuesSet(InitValuesSetSize)
2864   , Values()
2865   , StringPool()
2866   , SectionMap()
2867   , SectionSourceLines()
2868   , didInitial(false)
2869   , shouldEmit(false)
2870   , RootDbgScope(NULL)
2871   {
2872   }
2873   virtual ~DwarfDebug() {
2874     for (unsigned j = 0, M = Values.size(); j < M; ++j)
2875       delete Values[j];
2876   }
2877
2878   /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
2879   /// This is inovked by the target AsmPrinter.
2880   void SetDebugInfo(MachineModuleInfo *mmi) {
2881
2882       // Create all the compile unit DIEs.
2883       ConstructCompileUnits();
2884
2885       if (DW_CUs.empty())
2886         return;
2887
2888       MMI = mmi;
2889       shouldEmit = true;
2890       MMI->setDebugInfoAvailability(true);
2891
2892       // Create DIEs for each of the externally visible global variables.
2893       ConstructGlobalVariableDIEs();
2894
2895       // Create DIEs for each of the externally visible subprograms.
2896       ConstructSubprograms();
2897
2898       // Prime section data.
2899       SectionMap.insert(TAI->getTextSection());
2900
2901       // Print out .file directives to specify files for .loc directives. These
2902       // are printed out early so that they precede any .loc directives.
2903       if (TAI->hasDotLocAndDotFile()) {
2904         for (unsigned i = 1, e = SrcFiles.size(); i <= e; ++i) {
2905           sys::Path FullPath(Directories[SrcFiles[i].getDirectoryID()]);
2906           bool AppendOk = FullPath.appendComponent(SrcFiles[i].getName());
2907           assert(AppendOk && "Could not append filename to directory!");
2908           AppendOk = false;
2909           Asm->EmitFile(i, FullPath.toString());
2910           Asm->EOL();
2911         }
2912       }
2913
2914       // Emit initial sections
2915       EmitInitial();
2916   }
2917
2918   /// BeginModule - Emit all Dwarf sections that should come prior to the
2919   /// content.
2920   void BeginModule(Module *M) {
2921     this->M = M;
2922   }
2923
2924   /// EndModule - Emit all Dwarf sections that should come after the content.
2925   ///
2926   void EndModule() {
2927     if (!ShouldEmitDwarf()) return;
2928
2929     // Standard sections final addresses.
2930     Asm->SwitchToSection(TAI->getTextSection());
2931     EmitLabel("text_end", 0);
2932     Asm->SwitchToSection(TAI->getDataSection());
2933     EmitLabel("data_end", 0);
2934
2935     // End text sections.
2936     for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2937       Asm->SwitchToSection(SectionMap[i]);
2938       EmitLabel("section_end", i);
2939     }
2940
2941     // Emit common frame information.
2942     EmitCommonDebugFrame();
2943
2944     // Emit function debug frame information
2945     for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2946            E = DebugFrames.end(); I != E; ++I)
2947       EmitFunctionDebugFrame(*I);
2948
2949     // Compute DIE offsets and sizes.
2950     SizeAndOffsets();
2951
2952     // Emit all the DIEs into a debug info section
2953     EmitDebugInfo();
2954
2955     // Corresponding abbreviations into a abbrev section.
2956     EmitAbbreviations();
2957
2958     // Emit source line correspondence into a debug line section.
2959     EmitDebugLines();
2960
2961     // Emit info into a debug pubnames section.
2962     EmitDebugPubNames();
2963
2964     // Emit info into a debug str section.
2965     EmitDebugStr();
2966
2967     // Emit info into a debug loc section.
2968     EmitDebugLoc();
2969
2970     // Emit info into a debug aranges section.
2971     EmitDebugARanges();
2972
2973     // Emit info into a debug ranges section.
2974     EmitDebugRanges();
2975
2976     // Emit info into a debug macinfo section.
2977     EmitDebugMacInfo();
2978   }
2979
2980   /// BeginFunction - Gather pre-function debug information.  Assumes being
2981   /// emitted immediately after the function entry point.
2982   void BeginFunction(MachineFunction *MF) {
2983     this->MF = MF;
2984
2985     if (!ShouldEmitDwarf()) return;
2986
2987     // Begin accumulating function debug information.
2988     MMI->BeginFunction(MF);
2989
2990     // Assumes in correct section after the entry point.
2991     EmitLabel("func_begin", ++SubprogramCount);
2992
2993     // Emit label for the implicitly defined dbg.stoppoint at the start of
2994     // the function.
2995     if (!Lines.empty()) {
2996       const SrcLineInfo &LineInfo = Lines[0];
2997       Asm->printLabel(LineInfo.getLabelID());
2998     }
2999   }
3000
3001   /// EndFunction - Gather and emit post-function debug information.
3002   ///
3003   void EndFunction(MachineFunction *MF) {
3004     if (!ShouldEmitDwarf()) return;
3005
3006     // Define end label for subprogram.
3007     EmitLabel("func_end", SubprogramCount);
3008
3009     // Get function line info.
3010     if (!Lines.empty()) {
3011       // Get section line info.
3012       unsigned ID = SectionMap.insert(Asm->CurrentSection_);
3013       if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3014       std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3015       // Append the function info to section info.
3016       SectionLineInfos.insert(SectionLineInfos.end(),
3017                               Lines.begin(), Lines.end());
3018     }
3019
3020     // Construct scopes for subprogram.
3021     if (RootDbgScope)
3022       ConstructRootDbgScope(RootDbgScope);
3023     else
3024       // FIXME: This is wrong. We are essentially getting past a problem with
3025       // debug information not being able to handle unreachable blocks that have
3026       // debug information in them. In particular, those unreachable blocks that
3027       // have "region end" info in them. That situation results in the "root
3028       // scope" not being created. If that's the case, then emit a "default"
3029       // scope, i.e., one that encompasses the whole function. This isn't
3030       // desirable. And a better way of handling this (and all of the debugging
3031       // information) needs to be explored.
3032       ConstructDefaultDbgScope(MF);
3033
3034     DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3035                                                  MMI->getFrameMoves()));
3036
3037     // Clear debug info
3038     if (RootDbgScope) {
3039       delete RootDbgScope;
3040       DbgScopeMap.clear();
3041       RootDbgScope = NULL;
3042     }
3043     Lines.clear();
3044   }
3045
3046 public:
3047
3048   /// ValidDebugInfo - Return true if V represents valid debug info value.
3049   bool ValidDebugInfo(Value *V) {
3050
3051     if (!V)
3052       return false;
3053
3054     if (!shouldEmit)
3055       return false;
3056
3057     GlobalVariable *GV = getGlobalVariable(V);
3058     if (!GV)
3059       return false;
3060
3061     if (GV->getLinkage() != GlobalValue::InternalLinkage
3062         && GV->getLinkage() != GlobalValue::LinkOnceLinkage)
3063       return false;
3064
3065     DIDescriptor DI(GV);
3066     // Check current version. Allow Version6 for now.
3067     unsigned Version = DI.getVersion();
3068     if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6)
3069       return false;
3070
3071     unsigned Tag = DI.getTag();
3072     switch (Tag) {
3073     case DW_TAG_variable:
3074       assert (DIVariable(GV).Verify() && "Invalid DebugInfo value");
3075       break;
3076     case DW_TAG_compile_unit:
3077       assert (DICompileUnit(GV).Verify() && "Invalid DebugInfo value");
3078       break;
3079     case DW_TAG_subprogram:
3080       assert (DISubprogram(GV).Verify() && "Invalid DebugInfo value");
3081       break;
3082     default:
3083       break;
3084     }
3085
3086     return true;
3087   }
3088
3089   /// RecordSourceLine - Records location information and associates it with a
3090   /// label. Returns a unique label ID used to generate a label and provide
3091   /// correspondence to the source line list.
3092   unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3093     CompileUnit *Unit = DW_CUs[V];
3094     assert (Unit && "Unable to find CompileUnit");
3095     unsigned ID = MMI->NextLabelID();
3096     Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3097     return ID;
3098   }
3099
3100   /// RecordSourceLine - Records location information and associates it with a
3101   /// label. Returns a unique label ID used to generate a label and provide
3102   /// correspondence to the source line list.
3103   unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3104     unsigned ID = MMI->NextLabelID();
3105     Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3106     return ID;
3107   }
3108
3109   unsigned getRecordSourceLineCount() {
3110     return Lines.size();
3111   }
3112
3113   /// RecordSource - Register a source file with debug info. Returns an source
3114   /// ID.
3115   unsigned RecordSource(const std::string &Directory,
3116                         const std::string &File) {
3117     unsigned DID = Directories.insert(Directory);
3118     return SrcFiles.insert(SrcFileInfo(DID,File));
3119   }
3120
3121   /// RecordRegionStart - Indicate the start of a region.
3122   ///
3123   unsigned RecordRegionStart(GlobalVariable *V) {
3124     DbgScope *Scope = getOrCreateScope(V);
3125     unsigned ID = MMI->NextLabelID();
3126     if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3127     return ID;
3128   }
3129
3130   /// RecordRegionEnd - Indicate the end of a region.
3131   ///
3132   unsigned RecordRegionEnd(GlobalVariable *V) {
3133     DbgScope *Scope = getOrCreateScope(V);
3134     unsigned ID = MMI->NextLabelID();
3135     Scope->setEndLabelID(ID);
3136     return ID;
3137   }
3138
3139   /// RecordVariable - Indicate the declaration of  a local variable.
3140   ///
3141   void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
3142     DIDescriptor Desc(GV);
3143     DbgScope *Scope = NULL;
3144     if (Desc.getTag() == DW_TAG_variable) {
3145       // GV is a global variable.
3146       DIGlobalVariable DG(GV);
3147       Scope = getOrCreateScope(DG.getContext().getGV());
3148     } else {
3149       // or GV is a local variable.
3150       DIVariable DV(GV);
3151       Scope = getOrCreateScope(DV.getContext().getGV());
3152     }
3153     assert (Scope && "Unable to find variable' scope");
3154     DbgVariable *DV = new DbgVariable(DIVariable(GV), FrameIndex);
3155     Scope->AddVariable(DV);
3156   }
3157 };
3158
3159 //===----------------------------------------------------------------------===//
3160 /// DwarfException - Emits Dwarf exception handling directives.
3161 ///
3162 class DwarfException : public Dwarf  {
3163
3164 private:
3165   struct FunctionEHFrameInfo {
3166     std::string FnName;
3167     unsigned Number;
3168     unsigned PersonalityIndex;
3169     bool hasCalls;
3170     bool hasLandingPads;
3171     std::vector<MachineMove> Moves;
3172     const Function * function;
3173
3174     FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3175                         bool hC, bool hL,
3176                         const std::vector<MachineMove> &M,
3177                         const Function *f):
3178       FnName(FN), Number(Num), PersonalityIndex(P),
3179       hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
3180   };
3181
3182   std::vector<FunctionEHFrameInfo> EHFrames;
3183
3184   /// shouldEmitTable - Per-function flag to indicate if EH tables should
3185   /// be emitted.
3186   bool shouldEmitTable;
3187
3188   /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3189   /// should be emitted.
3190   bool shouldEmitMoves;
3191
3192   /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3193   /// should be emitted.
3194   bool shouldEmitTableModule;
3195
3196   /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
3197   /// should be emitted.
3198   bool shouldEmitMovesModule;
3199
3200   /// EmitCommonEHFrame - Emit the common eh unwind frame.
3201   ///
3202   void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3203     // Size and sign of stack growth.
3204     int stackGrowth =
3205         Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3206           TargetFrameInfo::StackGrowsUp ?
3207         TD->getPointerSize() : -TD->getPointerSize();
3208
3209     // Begin eh frame section.
3210     Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3211
3212     if (!TAI->doesRequireNonLocalEHFrameLabel())
3213       O << TAI->getEHGlobalPrefix();
3214     O << "EH_frame" << Index << ":\n";
3215     EmitLabel("section_eh_frame", Index);
3216
3217     // Define base labels.
3218     EmitLabel("eh_frame_common", Index);
3219
3220     // Define the eh frame length.
3221     EmitDifference("eh_frame_common_end", Index,
3222                    "eh_frame_common_begin", Index, true);
3223     Asm->EOL("Length of Common Information Entry");
3224
3225     // EH frame header.
3226     EmitLabel("eh_frame_common_begin", Index);
3227     Asm->EmitInt32((int)0);
3228     Asm->EOL("CIE Identifier Tag");
3229     Asm->EmitInt8(DW_CIE_VERSION);
3230     Asm->EOL("CIE Version");
3231
3232     // The personality presence indicates that language specific information
3233     // will show up in the eh frame.
3234     Asm->EmitString(Personality ? "zPLR" : "zR");
3235     Asm->EOL("CIE Augmentation");
3236
3237     // Round out reader.
3238     Asm->EmitULEB128Bytes(1);
3239     Asm->EOL("CIE Code Alignment Factor");
3240     Asm->EmitSLEB128Bytes(stackGrowth);
3241     Asm->EOL("CIE Data Alignment Factor");
3242     Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
3243     Asm->EOL("CIE Return Address Column");
3244
3245     // If there is a personality, we need to indicate the functions location.
3246     if (Personality) {
3247       Asm->EmitULEB128Bytes(7);
3248       Asm->EOL("Augmentation Size");
3249
3250       if (TAI->getNeedsIndirectEncoding()) {
3251         Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
3252         Asm->EOL("Personality (pcrel sdata4 indirect)");
3253       } else {
3254         Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3255         Asm->EOL("Personality (pcrel sdata4)");
3256       }
3257
3258       PrintRelDirective(true);
3259       O << TAI->getPersonalityPrefix();
3260       Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3261       O << TAI->getPersonalitySuffix();
3262       if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3263         O << "-" << TAI->getPCSymbol();
3264       Asm->EOL("Personality");
3265
3266       Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3267       Asm->EOL("LSDA Encoding (pcrel sdata4)");
3268
3269       Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3270       Asm->EOL("FDE Encoding (pcrel sdata4)");
3271    } else {
3272       Asm->EmitULEB128Bytes(1);
3273       Asm->EOL("Augmentation Size");
3274
3275       Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3276       Asm->EOL("FDE Encoding (pcrel sdata4)");
3277     }
3278
3279     // Indicate locations of general callee saved registers in frame.
3280     std::vector<MachineMove> Moves;
3281     RI->getInitialFrameState(Moves);
3282     EmitFrameMoves(NULL, 0, Moves, true);
3283
3284     // On Darwin the linker honors the alignment of eh_frame, which means it
3285     // must be 8-byte on 64-bit targets to match what gcc does.  Otherwise
3286     // you get holes which confuse readers of eh_frame.
3287     Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3288                        0, 0, false);
3289     EmitLabel("eh_frame_common_end", Index);
3290
3291     Asm->EOL();
3292   }
3293
3294   /// EmitEHFrame - Emit function exception frame information.
3295   ///
3296   void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
3297     Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3298
3299     Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3300
3301     // Externally visible entry into the functions eh frame info.
3302     // If the corresponding function is static, this should not be
3303     // externally visible.
3304     if (linkage != Function::InternalLinkage &&
3305         linkage != Function::PrivateLinkage) {
3306       if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3307         O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3308     }
3309
3310     // If corresponding function is weak definition, this should be too.
3311     if ((linkage == Function::WeakLinkage ||
3312          linkage == Function::LinkOnceLinkage) &&
3313         TAI->getWeakDefDirective())
3314       O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3315
3316     // If there are no calls then you can't unwind.  This may mean we can
3317     // omit the EH Frame, but some environments do not handle weak absolute
3318     // symbols.
3319     // If UnwindTablesMandatory is set we cannot do this optimization; the
3320     // unwind info is to be available for non-EH uses.
3321     if (!EHFrameInfo.hasCalls &&
3322         !UnwindTablesMandatory &&
3323         ((linkage != Function::WeakLinkage &&
3324           linkage != Function::LinkOnceLinkage) ||
3325          !TAI->getWeakDefDirective() ||
3326          TAI->getSupportsWeakOmittedEHFrame()))
3327     {
3328       O << EHFrameInfo.FnName << " = 0\n";
3329       // This name has no connection to the function, so it might get
3330       // dead-stripped when the function is not, erroneously.  Prohibit
3331       // dead-stripping unconditionally.
3332       if (const char *UsedDirective = TAI->getUsedDirective())
3333         O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3334     } else {
3335       O << EHFrameInfo.FnName << ":\n";
3336
3337       // EH frame header.
3338       EmitDifference("eh_frame_end", EHFrameInfo.Number,
3339                      "eh_frame_begin", EHFrameInfo.Number, true);
3340       Asm->EOL("Length of Frame Information Entry");
3341
3342       EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3343
3344       if (TAI->doesRequireNonLocalEHFrameLabel()) {
3345         PrintRelDirective(true, true);
3346         PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3347
3348         if (!TAI->isAbsoluteEHSectionOffsets())
3349           O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3350       } else {
3351         EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3352                           EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3353                           true, true, false);
3354       }
3355
3356       Asm->EOL("FDE CIE offset");
3357
3358       EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3359       Asm->EOL("FDE initial location");
3360       EmitDifference("eh_func_end", EHFrameInfo.Number,
3361                      "eh_func_begin", EHFrameInfo.Number, true);
3362       Asm->EOL("FDE address range");
3363
3364       // If there is a personality and landing pads then point to the language
3365       // specific data area in the exception table.
3366       if (EHFrameInfo.PersonalityIndex) {
3367         Asm->EmitULEB128Bytes(4);
3368         Asm->EOL("Augmentation size");
3369
3370         if (EHFrameInfo.hasLandingPads)
3371           EmitReference("exception", EHFrameInfo.Number, true, true);
3372         else
3373           Asm->EmitInt32((int)0);
3374         Asm->EOL("Language Specific Data Area");
3375       } else {
3376         Asm->EmitULEB128Bytes(0);
3377         Asm->EOL("Augmentation size");
3378       }
3379
3380       // Indicate locations of function specific  callee saved registers in
3381       // frame.
3382       EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves,
3383                      true);
3384
3385       // On Darwin the linker honors the alignment of eh_frame, which means it
3386       // must be 8-byte on 64-bit targets to match what gcc does.  Otherwise
3387       // you get holes which confuse readers of eh_frame.
3388       Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3389                          0, 0, false);
3390       EmitLabel("eh_frame_end", EHFrameInfo.Number);
3391
3392       // If the function is marked used, this table should be also.  We cannot
3393       // make the mark unconditional in this case, since retaining the table
3394       // also retains the function in this case, and there is code around
3395       // that depends on unused functions (calling undefined externals) being
3396       // dead-stripped to link correctly.  Yes, there really is.
3397       if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3398         if (const char *UsedDirective = TAI->getUsedDirective())
3399           O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3400     }
3401   }
3402
3403   /// EmitExceptionTable - Emit landing pads and actions.
3404   ///
3405   /// The general organization of the table is complex, but the basic concepts
3406   /// are easy.  First there is a header which describes the location and
3407   /// organization of the three components that follow.
3408   ///  1. The landing pad site information describes the range of code covered
3409   ///     by the try.  In our case it's an accumulation of the ranges covered
3410   ///     by the invokes in the try.  There is also a reference to the landing
3411   ///     pad that handles the exception once processed.  Finally an index into
3412   ///     the actions table.
3413   ///  2. The action table, in our case, is composed of pairs of type ids
3414   ///     and next action offset.  Starting with the action index from the
3415   ///     landing pad site, each type Id is checked for a match to the current
3416   ///     exception.  If it matches then the exception and type id are passed
3417   ///     on to the landing pad.  Otherwise the next action is looked up.  This
3418   ///     chain is terminated with a next action of zero.  If no type id is
3419   ///     found the the frame is unwound and handling continues.
3420   ///  3. Type id table contains references to all the C++ typeinfo for all
3421   ///     catches in the function.  This tables is reversed indexed base 1.
3422
3423   /// SharedTypeIds - How many leading type ids two landing pads have in common.
3424   static unsigned SharedTypeIds(const LandingPadInfo *L,
3425                                 const LandingPadInfo *R) {
3426     const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3427     unsigned LSize = LIds.size(), RSize = RIds.size();
3428     unsigned MinSize = LSize < RSize ? LSize : RSize;
3429     unsigned Count = 0;
3430
3431     for (; Count != MinSize; ++Count)
3432       if (LIds[Count] != RIds[Count])
3433         return Count;
3434
3435     return Count;
3436   }
3437
3438   /// PadLT - Order landing pads lexicographically by type id.
3439   static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3440     const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3441     unsigned LSize = LIds.size(), RSize = RIds.size();
3442     unsigned MinSize = LSize < RSize ? LSize : RSize;
3443
3444     for (unsigned i = 0; i != MinSize; ++i)
3445       if (LIds[i] != RIds[i])
3446         return LIds[i] < RIds[i];
3447
3448     return LSize < RSize;
3449   }
3450
3451   struct KeyInfo {
3452     static inline unsigned getEmptyKey() { return -1U; }
3453     static inline unsigned getTombstoneKey() { return -2U; }
3454     static unsigned getHashValue(const unsigned &Key) { return Key; }
3455     static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3456     static bool isPod() { return true; }
3457   };
3458
3459   /// ActionEntry - Structure describing an entry in the actions table.
3460   struct ActionEntry {
3461     int ValueForTypeID; // The value to write - may not be equal to the type id.
3462     int NextAction;
3463     struct ActionEntry *Previous;
3464   };
3465
3466   /// PadRange - Structure holding a try-range and the associated landing pad.
3467   struct PadRange {
3468     // The index of the landing pad.
3469     unsigned PadIndex;
3470     // The index of the begin and end labels in the landing pad's label lists.
3471     unsigned RangeIndex;
3472   };
3473
3474   typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3475
3476   /// CallSiteEntry - Structure describing an entry in the call-site table.
3477   struct CallSiteEntry {
3478     // The 'try-range' is BeginLabel .. EndLabel.
3479     unsigned BeginLabel; // zero indicates the start of the function.
3480     unsigned EndLabel;   // zero indicates the end of the function.
3481     // The landing pad starts at PadLabel.
3482     unsigned PadLabel;   // zero indicates that there is no landing pad.
3483     unsigned Action;
3484   };
3485
3486   void EmitExceptionTable() {
3487     const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3488     const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3489     const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3490     if (PadInfos.empty()) return;
3491
3492     // Sort the landing pads in order of their type ids.  This is used to fold
3493     // duplicate actions.
3494     SmallVector<const LandingPadInfo *, 64> LandingPads;
3495     LandingPads.reserve(PadInfos.size());
3496     for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3497       LandingPads.push_back(&PadInfos[i]);
3498     std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3499
3500     // Negative type ids index into FilterIds, positive type ids index into
3501     // TypeInfos.  The value written for a positive type id is just the type
3502     // id itself.  For a negative type id, however, the value written is the
3503     // (negative) byte offset of the corresponding FilterIds entry.  The byte
3504     // offset is usually equal to the type id, because the FilterIds entries
3505     // are written using a variable width encoding which outputs one byte per
3506     // entry as long as the value written is not too large, but can differ.
3507     // This kind of complication does not occur for positive type ids because
3508     // type infos are output using a fixed width encoding.
3509     // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3510     SmallVector<int, 16> FilterOffsets;
3511     FilterOffsets.reserve(FilterIds.size());
3512     int Offset = -1;
3513     for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3514         E = FilterIds.end(); I != E; ++I) {
3515       FilterOffsets.push_back(Offset);
3516       Offset -= TargetAsmInfo::getULEB128Size(*I);
3517     }
3518
3519     // Compute the actions table and gather the first action index for each
3520     // landing pad site.
3521     SmallVector<ActionEntry, 32> Actions;
3522     SmallVector<unsigned, 64> FirstActions;
3523     FirstActions.reserve(LandingPads.size());
3524
3525     int FirstAction = 0;
3526     unsigned SizeActions = 0;
3527     for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3528       const LandingPadInfo *LP = LandingPads[i];
3529       const std::vector<int> &TypeIds = LP->TypeIds;
3530       const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3531       unsigned SizeSiteActions = 0;
3532
3533       if (NumShared < TypeIds.size()) {
3534         unsigned SizeAction = 0;
3535         ActionEntry *PrevAction = 0;
3536
3537         if (NumShared) {
3538           const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3539           assert(Actions.size());
3540           PrevAction = &Actions.back();
3541           SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3542             TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3543           for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3544             SizeAction -=
3545               TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3546             SizeAction += -PrevAction->NextAction;
3547             PrevAction = PrevAction->Previous;
3548           }
3549         }
3550
3551         // Compute the actions.
3552         for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3553           int TypeID = TypeIds[I];
3554           assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3555           int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3556           unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
3557
3558           int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3559           SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
3560           SizeSiteActions += SizeAction;
3561
3562           ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3563           Actions.push_back(Action);
3564
3565           PrevAction = &Actions.back();
3566         }
3567
3568         // Record the first action of the landing pad site.
3569         FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3570       } // else identical - re-use previous FirstAction
3571
3572       FirstActions.push_back(FirstAction);
3573
3574       // Compute this sites contribution to size.
3575       SizeActions += SizeSiteActions;
3576     }
3577
3578     // Compute the call-site table.  The entry for an invoke has a try-range
3579     // containing the call, a non-zero landing pad and an appropriate action.
3580     // The entry for an ordinary call has a try-range containing the call and
3581     // zero for the landing pad and the action.  Calls marked 'nounwind' have
3582     // no entry and must not be contained in the try-range of any entry - they
3583     // form gaps in the table.  Entries must be ordered by try-range address.
3584     SmallVector<CallSiteEntry, 64> CallSites;
3585
3586     RangeMapType PadMap;
3587     // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3588     // by try-range labels when lowered).  Ordinary calls do not, so appropriate
3589     // try-ranges for them need be deduced.
3590     for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3591       const LandingPadInfo *LandingPad = LandingPads[i];
3592       for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3593         unsigned BeginLabel = LandingPad->BeginLabels[j];
3594         assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3595         PadRange P = { i, j };
3596         PadMap[BeginLabel] = P;
3597       }
3598     }
3599
3600     // The end label of the previous invoke or nounwind try-range.
3601     unsigned LastLabel = 0;
3602
3603     // Whether there is a potentially throwing instruction (currently this means
3604     // an ordinary call) between the end of the previous try-range and now.
3605     bool SawPotentiallyThrowing = false;
3606
3607     // Whether the last callsite entry was for an invoke.
3608     bool PreviousIsInvoke = false;
3609
3610     // Visit all instructions in order of address.
3611     for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3612          I != E; ++I) {
3613       for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3614            MI != E; ++MI) {
3615         if (!MI->isLabel()) {
3616           SawPotentiallyThrowing |= MI->getDesc().isCall();
3617           continue;
3618         }
3619
3620         unsigned BeginLabel = MI->getOperand(0).getImm();
3621         assert(BeginLabel && "Invalid label!");
3622
3623         // End of the previous try-range?
3624         if (BeginLabel == LastLabel)
3625           SawPotentiallyThrowing = false;
3626
3627         // Beginning of a new try-range?
3628         RangeMapType::iterator L = PadMap.find(BeginLabel);
3629         if (L == PadMap.end())
3630           // Nope, it was just some random label.
3631           continue;
3632
3633         PadRange P = L->second;
3634         const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3635
3636         assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3637                "Inconsistent landing pad map!");
3638
3639         // If some instruction between the previous try-range and this one may
3640         // throw, create a call-site entry with no landing pad for the region
3641         // between the try-ranges.
3642         if (SawPotentiallyThrowing) {
3643           CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3644           CallSites.push_back(Site);
3645           PreviousIsInvoke = false;
3646         }
3647
3648         LastLabel = LandingPad->EndLabels[P.RangeIndex];
3649         assert(BeginLabel && LastLabel && "Invalid landing pad!");
3650
3651         if (LandingPad->LandingPadLabel) {
3652           // This try-range is for an invoke.
3653           CallSiteEntry Site = {BeginLabel, LastLabel,
3654             LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3655
3656           // Try to merge with the previous call-site.
3657           if (PreviousIsInvoke) {
3658             CallSiteEntry &Prev = CallSites.back();
3659             if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3660               // Extend the range of the previous entry.
3661               Prev.EndLabel = Site.EndLabel;
3662               continue;
3663             }
3664           }
3665
3666           // Otherwise, create a new call-site.
3667           CallSites.push_back(Site);
3668           PreviousIsInvoke = true;
3669         } else {
3670           // Create a gap.
3671           PreviousIsInvoke = false;
3672         }
3673       }
3674     }
3675     // If some instruction between the previous try-range and the end of the
3676     // function may throw, create a call-site entry with no landing pad for the
3677     // region following the try-range.
3678     if (SawPotentiallyThrowing) {
3679       CallSiteEntry Site = {LastLabel, 0, 0, 0};
3680       CallSites.push_back(Site);
3681     }
3682
3683     // Final tallies.
3684
3685     // Call sites.
3686     const unsigned SiteStartSize  = sizeof(int32_t); // DW_EH_PE_udata4
3687     const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3688     const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3689     unsigned SizeSites = CallSites.size() * (SiteStartSize +
3690                                              SiteLengthSize +
3691                                              LandingPadSize);
3692     for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3693       SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
3694
3695     // Type infos.
3696     const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3697     unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
3698
3699     unsigned TypeOffset = sizeof(int8_t) + // Call site format
3700            TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
3701                           SizeSites + SizeActions + SizeTypes;
3702
3703     unsigned TotalSize = sizeof(int8_t) + // LPStart format
3704                          sizeof(int8_t) + // TType format
3705            TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
3706                          TypeOffset;
3707
3708     unsigned SizeAlign = (4 - TotalSize) & 3;
3709
3710     // Begin the exception table.
3711     Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3712     Asm->EmitAlignment(2, 0, 0, false);
3713     O << "GCC_except_table" << SubprogramCount << ":\n";
3714     for (unsigned i = 0; i != SizeAlign; ++i) {
3715       Asm->EmitInt8(0);
3716       Asm->EOL("Padding");
3717     }
3718     EmitLabel("exception", SubprogramCount);
3719
3720     // Emit the header.
3721     Asm->EmitInt8(DW_EH_PE_omit);
3722     Asm->EOL("LPStart format (DW_EH_PE_omit)");
3723     Asm->EmitInt8(DW_EH_PE_absptr);
3724     Asm->EOL("TType format (DW_EH_PE_absptr)");
3725     Asm->EmitULEB128Bytes(TypeOffset);
3726     Asm->EOL("TType base offset");
3727     Asm->EmitInt8(DW_EH_PE_udata4);
3728     Asm->EOL("Call site format (DW_EH_PE_udata4)");
3729     Asm->EmitULEB128Bytes(SizeSites);
3730     Asm->EOL("Call-site table length");
3731
3732     // Emit the landing pad site information.
3733     for (unsigned i = 0; i < CallSites.size(); ++i) {
3734       CallSiteEntry &S = CallSites[i];
3735       const char *BeginTag;
3736       unsigned BeginNumber;
3737
3738       if (!S.BeginLabel) {
3739         BeginTag = "eh_func_begin";
3740         BeginNumber = SubprogramCount;
3741       } else {
3742         BeginTag = "label";
3743         BeginNumber = S.BeginLabel;
3744       }
3745
3746       EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
3747                         true, true);
3748       Asm->EOL("Region start");
3749
3750       if (!S.EndLabel) {
3751         EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3752                        true);
3753       } else {
3754         EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
3755       }
3756       Asm->EOL("Region length");
3757
3758       if (!S.PadLabel)
3759         Asm->EmitInt32(0);
3760       else
3761         EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
3762                           true, true);
3763       Asm->EOL("Landing pad");
3764
3765       Asm->EmitULEB128Bytes(S.Action);
3766       Asm->EOL("Action");
3767     }
3768
3769     // Emit the actions.
3770     for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3771       ActionEntry &Action = Actions[I];
3772
3773       Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3774       Asm->EOL("TypeInfo index");
3775       Asm->EmitSLEB128Bytes(Action.NextAction);
3776       Asm->EOL("Next action");
3777     }
3778
3779     // Emit the type ids.
3780     for (unsigned M = TypeInfos.size(); M; --M) {
3781       GlobalVariable *GV = TypeInfos[M - 1];
3782
3783       PrintRelDirective();
3784
3785       if (GV)
3786         O << Asm->getGlobalLinkName(GV);
3787       else
3788         O << "0";
3789
3790       Asm->EOL("TypeInfo");
3791     }
3792
3793     // Emit the filter typeids.
3794     for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3795       unsigned TypeID = FilterIds[j];
3796       Asm->EmitULEB128Bytes(TypeID);
3797       Asm->EOL("Filter TypeInfo index");
3798     }
3799
3800     Asm->EmitAlignment(2, 0, 0, false);
3801   }
3802
3803 public:
3804   //===--------------------------------------------------------------------===//
3805   // Main entry points.
3806   //
3807   DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
3808   : Dwarf(OS, A, T, "eh")
3809   , shouldEmitTable(false)
3810   , shouldEmitMoves(false)
3811   , shouldEmitTableModule(false)
3812   , shouldEmitMovesModule(false)
3813   {}
3814
3815   virtual ~DwarfException() {}
3816
3817   /// SetModuleInfo - Set machine module information when it's known that pass
3818   /// manager has created it.  Set by the target AsmPrinter.
3819   void SetModuleInfo(MachineModuleInfo *mmi) {
3820     MMI = mmi;
3821   }
3822
3823   /// BeginModule - Emit all exception information that should come prior to the
3824   /// content.
3825   void BeginModule(Module *M) {
3826     this->M = M;
3827   }
3828
3829   /// EndModule - Emit all exception information that should come after the
3830   /// content.
3831   void EndModule() {
3832     if (shouldEmitMovesModule || shouldEmitTableModule) {
3833       const std::vector<Function *> Personalities = MMI->getPersonalities();
3834       for (unsigned i =0; i < Personalities.size(); ++i)
3835         EmitCommonEHFrame(Personalities[i], i);
3836
3837       for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3838              E = EHFrames.end(); I != E; ++I)
3839         EmitEHFrame(*I);
3840     }
3841   }
3842
3843   /// BeginFunction - Gather pre-function exception information.  Assumes being
3844   /// emitted immediately after the function entry point.
3845   void BeginFunction(MachineFunction *MF) {
3846     this->MF = MF;
3847     shouldEmitTable = shouldEmitMoves = false;
3848     if (MMI && TAI->doesSupportExceptionHandling()) {
3849
3850       // Map all labels and get rid of any dead landing pads.
3851       MMI->TidyLandingPads();
3852       // If any landing pads survive, we need an EH table.
3853       if (MMI->getLandingPads().size())
3854         shouldEmitTable = true;
3855
3856       // See if we need frame move info.
3857       if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
3858         shouldEmitMoves = true;
3859
3860       if (shouldEmitMoves || shouldEmitTable)
3861         // Assumes in correct section after the entry point.
3862         EmitLabel("eh_func_begin", ++SubprogramCount);
3863     }
3864     shouldEmitTableModule |= shouldEmitTable;
3865     shouldEmitMovesModule |= shouldEmitMoves;
3866   }
3867
3868   /// EndFunction - Gather and emit post-function exception information.
3869   ///
3870   void EndFunction() {
3871     if (shouldEmitMoves || shouldEmitTable) {
3872       EmitLabel("eh_func_end", SubprogramCount);
3873       EmitExceptionTable();
3874
3875       // Save EH frame information
3876       EHFrames.
3877         push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
3878                                     SubprogramCount,
3879                                     MMI->getPersonalityIndex(),
3880                                     MF->getFrameInfo()->hasCalls(),
3881                                     !MMI->getLandingPads().empty(),
3882                                     MMI->getFrameMoves(),
3883                                     MF->getFunction()));
3884       }
3885   }
3886 };
3887
3888 } // End of namespace llvm
3889
3890 //===----------------------------------------------------------------------===//
3891
3892 /// Emit - Print the abbreviation using the specified Dwarf writer.
3893 ///
3894 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
3895   // Emit its Dwarf tag type.
3896   DD.getAsm()->EmitULEB128Bytes(Tag);
3897   DD.getAsm()->EOL(TagString(Tag));
3898
3899   // Emit whether it has children DIEs.
3900   DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3901   DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
3902
3903   // For each attribute description.
3904   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3905     const DIEAbbrevData &AttrData = Data[i];
3906
3907     // Emit attribute type.
3908     DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3909     DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
3910
3911     // Emit form type.
3912     DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3913     DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
3914   }
3915
3916   // Mark end of abbreviation.
3917   DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3918   DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
3919 }
3920
3921 #ifndef NDEBUG
3922 void DIEAbbrev::print(std::ostream &O) {
3923   O << "Abbreviation @"
3924     << std::hex << (intptr_t)this << std::dec
3925     << "  "
3926     << TagString(Tag)
3927     << " "
3928     << ChildrenString(ChildrenFlag)
3929     << "\n";
3930
3931   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3932     O << "  "
3933       << AttributeString(Data[i].getAttribute())
3934       << "  "
3935       << FormEncodingString(Data[i].getForm())
3936       << "\n";
3937   }
3938 }
3939 void DIEAbbrev::dump() { print(cerr); }
3940 #endif
3941
3942 //===----------------------------------------------------------------------===//
3943
3944 #ifndef NDEBUG
3945 void DIEValue::dump() {
3946   print(cerr);
3947 }
3948 #endif
3949
3950 //===----------------------------------------------------------------------===//
3951
3952 /// EmitValue - Emit integer of appropriate size.
3953 ///
3954 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
3955   switch (Form) {
3956   case DW_FORM_flag:  // Fall thru
3957   case DW_FORM_ref1:  // Fall thru
3958   case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer);         break;
3959   case DW_FORM_ref2:  // Fall thru
3960   case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer);        break;
3961   case DW_FORM_ref4:  // Fall thru
3962   case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer);        break;
3963   case DW_FORM_ref8:  // Fall thru
3964   case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer);        break;
3965   case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3966   case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
3967   default: assert(0 && "DIE Value form not supported yet");   break;
3968   }
3969 }
3970
3971 /// SizeOf - Determine size of integer value in bytes.
3972 ///
3973 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3974   switch (Form) {
3975   case DW_FORM_flag:  // Fall thru
3976   case DW_FORM_ref1:  // Fall thru
3977   case DW_FORM_data1: return sizeof(int8_t);
3978   case DW_FORM_ref2:  // Fall thru
3979   case DW_FORM_data2: return sizeof(int16_t);
3980   case DW_FORM_ref4:  // Fall thru
3981   case DW_FORM_data4: return sizeof(int32_t);
3982   case DW_FORM_ref8:  // Fall thru
3983   case DW_FORM_data8: return sizeof(int64_t);
3984   case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
3985   case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
3986   default: assert(0 && "DIE Value form not supported yet"); break;
3987   }
3988   return 0;
3989 }
3990
3991 //===----------------------------------------------------------------------===//
3992
3993 /// EmitValue - Emit string value.
3994 ///
3995 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
3996   DD.getAsm()->EmitString(String);
3997 }
3998
3999 //===----------------------------------------------------------------------===//
4000
4001 /// EmitValue - Emit label value.
4002 ///
4003 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4004   bool IsSmall = Form == DW_FORM_data4;
4005   DD.EmitReference(Label, false, IsSmall);
4006 }
4007
4008 /// SizeOf - Determine size of label value in bytes.
4009 ///
4010 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4011   if (Form == DW_FORM_data4) return 4;
4012   return DD.getTargetData()->getPointerSize();
4013 }
4014
4015 //===----------------------------------------------------------------------===//
4016
4017 /// EmitValue - Emit label value.
4018 ///
4019 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4020   bool IsSmall = Form == DW_FORM_data4;
4021   DD.EmitReference(Label, false, IsSmall);
4022 }
4023
4024 /// SizeOf - Determine size of label value in bytes.
4025 ///
4026 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4027   if (Form == DW_FORM_data4) return 4;
4028   return DD.getTargetData()->getPointerSize();
4029 }
4030
4031 //===----------------------------------------------------------------------===//
4032
4033 /// EmitValue - Emit delta value.
4034 ///
4035 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4036   bool IsSmall = Form == DW_FORM_data4;
4037   DD.EmitSectionOffset(Label.Tag, Section.Tag,
4038                        Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4039 }
4040
4041 /// SizeOf - Determine size of delta value in bytes.
4042 ///
4043 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4044   if (Form == DW_FORM_data4) return 4;
4045   return DD.getTargetData()->getPointerSize();
4046 }
4047
4048 //===----------------------------------------------------------------------===//
4049
4050 /// EmitValue - Emit delta value.
4051 ///
4052 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4053   bool IsSmall = Form == DW_FORM_data4;
4054   DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4055 }
4056
4057 /// SizeOf - Determine size of delta value in bytes.
4058 ///
4059 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4060   if (Form == DW_FORM_data4) return 4;
4061   return DD.getTargetData()->getPointerSize();
4062 }
4063
4064 //===----------------------------------------------------------------------===//
4065
4066 /// EmitValue - Emit debug information entry offset.
4067 ///
4068 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4069   DD.getAsm()->EmitInt32(Entry->getOffset());
4070 }
4071
4072 //===----------------------------------------------------------------------===//
4073
4074 /// ComputeSize - calculate the size of the block.
4075 ///
4076 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4077   if (!Size) {
4078     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4079
4080     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4081       Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4082     }
4083   }
4084   return Size;
4085 }
4086
4087 /// EmitValue - Emit block data.
4088 ///
4089 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4090   switch (Form) {
4091   case DW_FORM_block1: DD.getAsm()->EmitInt8(Size);         break;
4092   case DW_FORM_block2: DD.getAsm()->EmitInt16(Size);        break;
4093   case DW_FORM_block4: DD.getAsm()->EmitInt32(Size);        break;
4094   case DW_FORM_block:  DD.getAsm()->EmitULEB128Bytes(Size); break;
4095   default: assert(0 && "Improper form for block");          break;
4096   }
4097
4098   const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4099
4100   for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4101     DD.getAsm()->EOL();
4102     Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4103   }
4104 }
4105
4106 /// SizeOf - Determine size of block data in bytes.
4107 ///
4108 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4109   switch (Form) {
4110   case DW_FORM_block1: return Size + sizeof(int8_t);
4111   case DW_FORM_block2: return Size + sizeof(int16_t);
4112   case DW_FORM_block4: return Size + sizeof(int32_t);
4113   case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
4114   default: assert(0 && "Improper form for block"); break;
4115   }
4116   return 0;
4117 }
4118
4119 //===----------------------------------------------------------------------===//
4120 /// DIE Implementation
4121
4122 DIE::~DIE() {
4123   for (unsigned i = 0, N = Children.size(); i < N; ++i)
4124     delete Children[i];
4125 }
4126
4127 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4128 ///
4129 void DIE::AddSiblingOffset() {
4130   DIEInteger *DI = new DIEInteger(0);
4131   Values.insert(Values.begin(), DI);
4132   Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4133 }
4134
4135 /// Profile - Used to gather unique data for the value folding set.
4136 ///
4137 void DIE::Profile(FoldingSetNodeID &ID) {
4138   Abbrev.Profile(ID);
4139
4140   for (unsigned i = 0, N = Children.size(); i < N; ++i)
4141     ID.AddPointer(Children[i]);
4142
4143   for (unsigned j = 0, M = Values.size(); j < M; ++j)
4144     ID.AddPointer(Values[j]);
4145 }
4146
4147 #ifndef NDEBUG
4148 void DIE::print(std::ostream &O, unsigned IncIndent) {
4149   static unsigned IndentCount = 0;
4150   IndentCount += IncIndent;
4151   const std::string Indent(IndentCount, ' ');
4152   bool isBlock = Abbrev.getTag() == 0;
4153
4154   if (!isBlock) {
4155     O << Indent
4156       << "Die: "
4157       << "0x" << std::hex << (intptr_t)this << std::dec
4158       << ", Offset: " << Offset
4159       << ", Size: " << Size
4160       << "\n";
4161
4162     O << Indent
4163       << TagString(Abbrev.getTag())
4164       << " "
4165       << ChildrenString(Abbrev.getChildrenFlag());
4166   } else {
4167     O << "Size: " << Size;
4168   }
4169   O << "\n";
4170
4171   const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
4172
4173   IndentCount += 2;
4174   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4175     O << Indent;
4176
4177     if (!isBlock)
4178       O << AttributeString(Data[i].getAttribute());
4179     else
4180       O << "Blk[" << i << "]";
4181
4182     O <<  "  "
4183       << FormEncodingString(Data[i].getForm())
4184       << " ";
4185     Values[i]->print(O);
4186     O << "\n";
4187   }
4188   IndentCount -= 2;
4189
4190   for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4191     Children[j]->print(O, 4);
4192   }
4193
4194   if (!isBlock) O << "\n";
4195   IndentCount -= IncIndent;
4196 }
4197
4198 void DIE::dump() {
4199   print(cerr);
4200 }
4201 #endif
4202
4203 //===----------------------------------------------------------------------===//
4204 /// DwarfWriter Implementation
4205 ///
4206
4207 DwarfWriter::DwarfWriter() : ImmutablePass(&ID), DD(NULL), DE(NULL) {
4208 }
4209
4210 DwarfWriter::~DwarfWriter() {
4211   delete DE;
4212   delete DD;
4213 }
4214
4215 /// BeginModule - Emit all Dwarf sections that should come prior to the
4216 /// content.
4217 void DwarfWriter::BeginModule(Module *M,
4218                               MachineModuleInfo *MMI,
4219                               raw_ostream &OS, AsmPrinter *A,
4220                               const TargetAsmInfo *T) {
4221   DE = new DwarfException(OS, A, T);
4222   DD = new DwarfDebug(OS, A, T);
4223   DE->BeginModule(M);
4224   DD->BeginModule(M);
4225   DD->SetDebugInfo(MMI);
4226   DE->SetModuleInfo(MMI);
4227 }
4228
4229 /// EndModule - Emit all Dwarf sections that should come after the content.
4230 ///
4231 void DwarfWriter::EndModule() {
4232   DE->EndModule();
4233   DD->EndModule();
4234 }
4235
4236 /// BeginFunction - Gather pre-function debug information.  Assumes being
4237 /// emitted immediately after the function entry point.
4238 void DwarfWriter::BeginFunction(MachineFunction *MF) {
4239   DE->BeginFunction(MF);
4240   DD->BeginFunction(MF);
4241 }
4242
4243 /// EndFunction - Gather and emit post-function debug information.
4244 ///
4245 void DwarfWriter::EndFunction(MachineFunction *MF) {
4246   DD->EndFunction(MF);
4247   DE->EndFunction();
4248
4249   if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
4250     // Clear function debug information.
4251     MMI->EndFunction();
4252 }
4253
4254 /// ValidDebugInfo - Return true if V represents valid debug info value.
4255 bool DwarfWriter::ValidDebugInfo(Value *V) {
4256   return DD && DD->ValidDebugInfo(V);
4257 }
4258
4259 /// RecordSourceLine - Records location information and associates it with a
4260 /// label. Returns a unique label ID used to generate a label and provide
4261 /// correspondence to the source line list.
4262 unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4263                                        unsigned Src) {
4264   return DD->RecordSourceLine(Line, Col, Src);
4265 }
4266
4267 /// RecordSource - Register a source file with debug info. Returns an source
4268 /// ID.
4269 unsigned DwarfWriter::RecordSource(const std::string &Dir,
4270                                    const std::string &File) {
4271   return DD->RecordSource(Dir, File);
4272 }
4273
4274 /// RecordRegionStart - Indicate the start of a region.
4275 unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4276   return DD->RecordRegionStart(V);
4277 }
4278
4279 /// RecordRegionEnd - Indicate the end of a region.
4280 unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4281   return DD->RecordRegionEnd(V);
4282 }
4283
4284 /// getRecordSourceLineCount - Count source lines.
4285 unsigned DwarfWriter::getRecordSourceLineCount() {
4286   return DD->getRecordSourceLineCount();
4287 }
4288
4289 /// RecordVariable - Indicate the declaration of  a local variable.
4290 ///
4291 void DwarfWriter::RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
4292   DD->RecordVariable(GV, FrameIndex);
4293 }
4294