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