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