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