Change the MachineDebugInfo to MachineModuleInfo to better reflect usage
[oota-llvm.git] / lib / CodeGen / DwarfWriter.cpp
1 //===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by James M. Laskey and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains support for writing dwarf debug info into asm files.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/CodeGen/DwarfWriter.h"
15
16 #include "llvm/ADT/FoldingSet.h"
17 #include "llvm/ADT/StringExtras.h"
18 #include "llvm/ADT/UniqueVector.h"
19 #include "llvm/Module.h"
20 #include "llvm/Type.h"
21 #include "llvm/CodeGen/AsmPrinter.h"
22 #include "llvm/CodeGen/MachineModuleInfo.h"
23 #include "llvm/CodeGen/MachineFrameInfo.h"
24 #include "llvm/CodeGen/MachineLocation.h"
25 #include "llvm/Support/Dwarf.h"
26 #include "llvm/Support/CommandLine.h"
27 #include "llvm/Support/DataTypes.h"
28 #include "llvm/Support/Mangler.h"
29 #include "llvm/Target/TargetAsmInfo.h"
30 #include "llvm/Target/MRegisterInfo.h"
31 #include "llvm/Target/TargetData.h"
32 #include "llvm/Target/TargetMachine.h"
33 #include "llvm/Target/TargetFrameInfo.h"
34 #include <ostream>
35 #include <string>
36 using namespace llvm;
37 using namespace llvm::dwarf;
38
39 namespace llvm {
40   
41 //===----------------------------------------------------------------------===//
42
43 /// Configuration values for initial hash set sizes (log2).
44 ///
45 static const unsigned InitDiesSetSize          = 9; // 512
46 static const unsigned InitAbbreviationsSetSize = 9; // 512
47 static const unsigned InitValuesSetSize        = 9; // 512
48
49 //===----------------------------------------------------------------------===//
50 /// Forward declarations.
51 ///
52 class DIE;
53 class DIEValue;
54
55 //===----------------------------------------------------------------------===//
56 /// DWLabel - Labels are used to track locations in the assembler file.
57 /// Labels appear in the form <prefix>debug_<Tag><Number>, where the tag is a
58 /// category of label (Ex. location) and number is a value unique in that
59 /// category.
60 class DWLabel {
61 public:
62   /// Tag - Label category tag. Should always be a staticly declared C string.
63   ///
64   const char *Tag;
65   
66   /// Number - Value to make label unique.
67   ///
68   unsigned    Number;
69
70   DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
71   
72   void Profile(FoldingSetNodeID &ID) const {
73     ID.AddString(std::string(Tag));
74     ID.AddInteger(Number);
75   }
76   
77 #ifndef NDEBUG
78   void print(std::ostream *O) const {
79     if (O) print(*O);
80   }
81   void print(std::ostream &O) const {
82     O << ".debug_" << Tag;
83     if (Number) O << Number;
84   }
85 #endif
86 };
87
88 //===----------------------------------------------------------------------===//
89 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
90 /// Dwarf abbreviation.
91 class DIEAbbrevData {
92 private:
93   /// Attribute - Dwarf attribute code.
94   ///
95   unsigned Attribute;
96   
97   /// Form - Dwarf form code.
98   ///              
99   unsigned Form;                      
100   
101 public:
102   DIEAbbrevData(unsigned A, unsigned F)
103   : Attribute(A)
104   , Form(F)
105   {}
106   
107   // Accessors.
108   unsigned getAttribute() const { return Attribute; }
109   unsigned getForm()      const { return Form; }
110
111   /// Profile - Used to gather unique data for the abbreviation folding set.
112   ///
113   void Profile(FoldingSetNodeID &ID)const  {
114     ID.AddInteger(Attribute);
115     ID.AddInteger(Form);
116   }
117 };
118
119 //===----------------------------------------------------------------------===//
120 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
121 /// information object.
122 class DIEAbbrev : public FoldingSetNode {
123 private:
124   /// Tag - Dwarf tag code.
125   ///
126   unsigned Tag;
127   
128   /// Unique number for node.
129   ///
130   unsigned Number;
131
132   /// ChildrenFlag - Dwarf children flag.
133   ///
134   unsigned ChildrenFlag;
135
136   /// Data - Raw data bytes for abbreviation.
137   ///
138   std::vector<DIEAbbrevData> Data;
139
140 public:
141
142   DIEAbbrev(unsigned T, unsigned C)
143   : Tag(T)
144   , ChildrenFlag(C)
145   , Data()
146   {}
147   ~DIEAbbrev() {}
148   
149   // Accessors.
150   unsigned getTag()                           const { return Tag; }
151   unsigned getNumber()                        const { return Number; }
152   unsigned getChildrenFlag()                  const { return ChildrenFlag; }
153   const std::vector<DIEAbbrevData> &getData() const { return Data; }
154   void setTag(unsigned T)                           { Tag = T; }
155   void setChildrenFlag(unsigned CF)                 { ChildrenFlag = CF; }
156   void setNumber(unsigned N)                        { Number = N; }
157   
158   /// AddAttribute - Adds another set of attribute information to the
159   /// abbreviation.
160   void AddAttribute(unsigned Attribute, unsigned Form) {
161     Data.push_back(DIEAbbrevData(Attribute, Form));
162   }
163   
164   /// AddFirstAttribute - Adds a set of attribute information to the front
165   /// of the abbreviation.
166   void AddFirstAttribute(unsigned Attribute, unsigned Form) {
167     Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
168   }
169   
170   /// Profile - Used to gather unique data for the abbreviation folding set.
171   ///
172   void Profile(FoldingSetNodeID &ID) {
173     ID.AddInteger(Tag);
174     ID.AddInteger(ChildrenFlag);
175     
176     // For each attribute description.
177     for (unsigned i = 0, N = Data.size(); i < N; ++i)
178       Data[i].Profile(ID);
179   }
180   
181   /// Emit - Print the abbreviation using the specified Dwarf writer.
182   ///
183   void Emit(const Dwarf &DW) const; 
184       
185 #ifndef NDEBUG
186   void print(std::ostream *O) {
187     if (O) print(*O);
188   }
189   void print(std::ostream &O);
190   void dump();
191 #endif
192 };
193
194 //===----------------------------------------------------------------------===//
195 /// DIE - A structured debug information entry.  Has an abbreviation which
196 /// describes it's organization.
197 class DIE : public FoldingSetNode {
198 protected:
199   /// Abbrev - Buffer for constructing abbreviation.
200   ///
201   DIEAbbrev Abbrev;
202   
203   /// Offset - Offset in debug info section.
204   ///
205   unsigned Offset;
206   
207   /// Size - Size of instance + children.
208   ///
209   unsigned Size;
210   
211   /// Children DIEs.
212   ///
213   std::vector<DIE *> Children;
214   
215   /// Attributes values.
216   ///
217   std::vector<DIEValue *> Values;
218   
219 public:
220   DIE(unsigned Tag)
221   : Abbrev(Tag, DW_CHILDREN_no)
222   , Offset(0)
223   , Size(0)
224   , Children()
225   , Values()
226   {}
227   virtual ~DIE();
228   
229   // Accessors.
230   DIEAbbrev &getAbbrev()                           { return Abbrev; }
231   unsigned   getAbbrevNumber()               const {
232     return Abbrev.getNumber();
233   }
234   unsigned getTag()                          const { return Abbrev.getTag(); }
235   unsigned getOffset()                       const { return Offset; }
236   unsigned getSize()                         const { return Size; }
237   const std::vector<DIE *> &getChildren()    const { return Children; }
238   const std::vector<DIEValue *> &getValues() const { return Values; }
239   void setTag(unsigned Tag)                  { Abbrev.setTag(Tag); }
240   void setOffset(unsigned O)                 { Offset = O; }
241   void setSize(unsigned S)                   { Size = S; }
242   
243   /// AddValue - Add a value and attributes to a DIE.
244   ///
245   void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
246     Abbrev.AddAttribute(Attribute, Form);
247     Values.push_back(Value);
248   }
249   
250   /// SiblingOffset - Return the offset of the debug information entry's
251   /// sibling.
252   unsigned SiblingOffset() const { return Offset + Size; }
253   
254   /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
255   ///
256   void AddSiblingOffset();
257
258   /// AddChild - Add a child to the DIE.
259   ///
260   void AddChild(DIE *Child) {
261     Abbrev.setChildrenFlag(DW_CHILDREN_yes);
262     Children.push_back(Child);
263   }
264   
265   /// Detach - Detaches objects connected to it after copying.
266   ///
267   void Detach() {
268     Children.clear();
269   }
270   
271   /// Profile - Used to gather unique data for the value folding set.
272   ///
273   void Profile(FoldingSetNodeID &ID) ;
274       
275 #ifndef NDEBUG
276   void print(std::ostream *O, unsigned IncIndent = 0) {
277     if (O) print(*O, IncIndent);
278   }
279   void print(std::ostream &O, unsigned IncIndent = 0);
280   void dump();
281 #endif
282 };
283
284 //===----------------------------------------------------------------------===//
285 /// DIEValue - A debug information entry value.
286 ///
287 class DIEValue : public FoldingSetNode {
288 public:
289   enum {
290     isInteger,
291     isString,
292     isLabel,
293     isAsIsLabel,
294     isDelta,
295     isEntry,
296     isBlock
297   };
298   
299   /// Type - Type of data stored in the value.
300   ///
301   unsigned Type;
302   
303   DIEValue(unsigned T)
304   : Type(T)
305   {}
306   virtual ~DIEValue() {}
307   
308   // Accessors
309   unsigned getType()  const { return Type; }
310   
311   // Implement isa/cast/dyncast.
312   static bool classof(const DIEValue *) { return true; }
313   
314   /// EmitValue - Emit value via the Dwarf writer.
315   ///
316   virtual void EmitValue(const Dwarf &DW, unsigned Form) const = 0;
317   
318   /// SizeOf - Return the size of a value in bytes.
319   ///
320   virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const = 0;
321   
322   /// Profile - Used to gather unique data for the value folding set.
323   ///
324   virtual void Profile(FoldingSetNodeID &ID) = 0;
325       
326 #ifndef NDEBUG
327   void print(std::ostream *O) {
328     if (O) print(*O);
329   }
330   virtual void print(std::ostream &O) = 0;
331   void dump();
332 #endif
333 };
334
335 //===----------------------------------------------------------------------===//
336 /// DWInteger - An integer value DIE.
337 /// 
338 class DIEInteger : public DIEValue {
339 private:
340   uint64_t Integer;
341   
342 public:
343   DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
344
345   // Implement isa/cast/dyncast.
346   static bool classof(const DIEInteger *) { return true; }
347   static bool classof(const DIEValue *I)  { return I->Type == isInteger; }
348   
349   /// BestForm - Choose the best form for integer.
350   ///
351   static unsigned BestForm(bool IsSigned, uint64_t Integer) {
352     if (IsSigned) {
353       if ((char)Integer == (signed)Integer)   return DW_FORM_data1;
354       if ((short)Integer == (signed)Integer)  return DW_FORM_data2;
355       if ((int)Integer == (signed)Integer)    return DW_FORM_data4;
356     } else {
357       if ((unsigned char)Integer == Integer)  return DW_FORM_data1;
358       if ((unsigned short)Integer == Integer) return DW_FORM_data2;
359       if ((unsigned int)Integer == Integer)   return DW_FORM_data4;
360     }
361     return DW_FORM_data8;
362   }
363     
364   /// EmitValue - Emit integer of appropriate size.
365   ///
366   virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
367   
368   /// SizeOf - Determine size of integer value in bytes.
369   ///
370   virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const;
371   
372   /// Profile - Used to gather unique data for the value folding set.
373   ///
374   static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
375     ID.AddInteger(isInteger);
376     ID.AddInteger(Integer);
377   }
378   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
379   
380 #ifndef NDEBUG
381   virtual void print(std::ostream &O) {
382     O << "Int: " << (int64_t)Integer
383       << "  0x" << std::hex << Integer << std::dec;
384   }
385 #endif
386 };
387
388 //===----------------------------------------------------------------------===//
389 /// DIEString - A string value DIE.
390 /// 
391 class DIEString : public DIEValue {
392 public:
393   const std::string String;
394   
395   DIEString(const std::string &S) : DIEValue(isString), String(S) {}
396
397   // Implement isa/cast/dyncast.
398   static bool classof(const DIEString *) { return true; }
399   static bool classof(const DIEValue *S) { return S->Type == isString; }
400   
401   /// EmitValue - Emit string value.
402   ///
403   virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
404   
405   /// SizeOf - Determine size of string value in bytes.
406   ///
407   virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const {
408     return String.size() + sizeof(char); // sizeof('\0');
409   }
410   
411   /// Profile - Used to gather unique data for the value folding set.
412   ///
413   static void Profile(FoldingSetNodeID &ID, const std::string &String) {
414     ID.AddInteger(isString);
415     ID.AddString(String);
416   }
417   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
418   
419 #ifndef NDEBUG
420   virtual void print(std::ostream &O) {
421     O << "Str: \"" << String << "\"";
422   }
423 #endif
424 };
425
426 //===----------------------------------------------------------------------===//
427 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
428 //
429 class DIEDwarfLabel : public DIEValue {
430 public:
431
432   const DWLabel Label;
433   
434   DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
435
436   // Implement isa/cast/dyncast.
437   static bool classof(const DIEDwarfLabel *)  { return true; }
438   static bool classof(const DIEValue *L) { return L->Type == isLabel; }
439   
440   /// EmitValue - Emit label value.
441   ///
442   virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
443   
444   /// SizeOf - Determine size of label value in bytes.
445   ///
446   virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const;
447   
448   /// Profile - Used to gather unique data for the value folding set.
449   ///
450   static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
451     ID.AddInteger(isLabel);
452     Label.Profile(ID);
453   }
454   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
455   
456 #ifndef NDEBUG
457   virtual void print(std::ostream &O) {
458     O << "Lbl: ";
459     Label.print(O);
460   }
461 #endif
462 };
463
464
465 //===----------------------------------------------------------------------===//
466 /// DIEObjectLabel - A label to an object in code or data.
467 //
468 class DIEObjectLabel : public DIEValue {
469 public:
470   const std::string Label;
471   
472   DIEObjectLabel(const std::string &L) : DIEValue(isAsIsLabel), Label(L) {}
473
474   // Implement isa/cast/dyncast.
475   static bool classof(const DIEObjectLabel *) { return true; }
476   static bool classof(const DIEValue *L)    { return L->Type == isAsIsLabel; }
477   
478   /// EmitValue - Emit label value.
479   ///
480   virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
481   
482   /// SizeOf - Determine size of label value in bytes.
483   ///
484   virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const;
485   
486   /// Profile - Used to gather unique data for the value folding set.
487   ///
488   static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
489     ID.AddInteger(isAsIsLabel);
490     ID.AddString(Label);
491   }
492   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
493
494 #ifndef NDEBUG
495   virtual void print(std::ostream &O) {
496     O << "Obj: " << Label;
497   }
498 #endif
499 };
500
501 //===----------------------------------------------------------------------===//
502 /// DIEDelta - A simple label difference DIE.
503 /// 
504 class DIEDelta : public DIEValue {
505 public:
506   const DWLabel LabelHi;
507   const DWLabel LabelLo;
508   
509   DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
510   : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
511
512   // Implement isa/cast/dyncast.
513   static bool classof(const DIEDelta *)  { return true; }
514   static bool classof(const DIEValue *D) { return D->Type == isDelta; }
515   
516   /// EmitValue - Emit delta value.
517   ///
518   virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
519   
520   /// SizeOf - Determine size of delta value in bytes.
521   ///
522   virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const;
523   
524   /// Profile - Used to gather unique data for the value folding set.
525   ///
526   static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
527                                             const DWLabel &LabelLo) {
528     ID.AddInteger(isDelta);
529     LabelHi.Profile(ID);
530     LabelLo.Profile(ID);
531   }
532   virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
533
534 #ifndef NDEBUG
535   virtual void print(std::ostream &O) {
536     O << "Del: ";
537     LabelHi.print(O);
538     O << "-";
539     LabelLo.print(O);
540   }
541 #endif
542 };
543
544 //===----------------------------------------------------------------------===//
545 /// DIEntry - A pointer to another debug information entry.  An instance of this
546 /// class can also be used as a proxy for a debug information entry not yet
547 /// defined (ie. types.)
548 class DIEntry : public DIEValue {
549 public:
550   DIE *Entry;
551   
552   DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
553   
554   // Implement isa/cast/dyncast.
555   static bool classof(const DIEntry *)   { return true; }
556   static bool classof(const DIEValue *E) { return E->Type == isEntry; }
557   
558   /// EmitValue - Emit debug information entry offset.
559   ///
560   virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
561   
562   /// SizeOf - Determine size of debug information entry in bytes.
563   ///
564   virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const {
565     return sizeof(int32_t);
566   }
567   
568   /// Profile - Used to gather unique data for the value folding set.
569   ///
570   static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
571     ID.AddInteger(isEntry);
572     ID.AddPointer(Entry);
573   }
574   virtual void Profile(FoldingSetNodeID &ID) {
575     ID.AddInteger(isEntry);
576     
577     if (Entry) {
578       ID.AddPointer(Entry);
579     } else {
580       ID.AddPointer(this);
581     }
582   }
583   
584 #ifndef NDEBUG
585   virtual void print(std::ostream &O) {
586     O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
587   }
588 #endif
589 };
590
591 //===----------------------------------------------------------------------===//
592 /// DIEBlock - A block of values.  Primarily used for location expressions.
593 //
594 class DIEBlock : public DIEValue, public DIE {
595 public:
596   unsigned Size;                        // Size in bytes excluding size header.
597   
598   DIEBlock()
599   : DIEValue(isBlock)
600   , DIE(0)
601   , Size(0)
602   {}
603   ~DIEBlock()  {
604   }
605   
606   // Implement isa/cast/dyncast.
607   static bool classof(const DIEBlock *)  { return true; }
608   static bool classof(const DIEValue *E) { return E->Type == isBlock; }
609   
610   /// ComputeSize - calculate the size of the block.
611   ///
612   unsigned ComputeSize(Dwarf &DW);
613   
614   /// BestForm - Choose the best form for data.
615   ///
616   unsigned BestForm() const {
617     if ((unsigned char)Size == Size)  return DW_FORM_block1;
618     if ((unsigned short)Size == Size) return DW_FORM_block2;
619     if ((unsigned int)Size == Size)   return DW_FORM_block4;
620     return DW_FORM_block;
621   }
622
623   /// EmitValue - Emit block data.
624   ///
625   virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
626   
627   /// SizeOf - Determine size of block data in bytes.
628   ///
629   virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const;
630   
631
632   /// Profile - Used to gather unique data for the value folding set.
633   ///
634   virtual void Profile(FoldingSetNodeID &ID) {
635     ID.AddInteger(isBlock);
636     DIE::Profile(ID);
637   }
638   
639 #ifndef NDEBUG
640   virtual void print(std::ostream &O) {
641     O << "Blk: ";
642     DIE::print(O, 5);
643   }
644 #endif
645 };
646
647 //===----------------------------------------------------------------------===//
648 /// CompileUnit - This dwarf writer support class manages information associate
649 /// with a source file.
650 class CompileUnit {
651 private:
652   /// Desc - Compile unit debug descriptor.
653   ///
654   CompileUnitDesc *Desc;
655   
656   /// ID - File identifier for source.
657   ///
658   unsigned ID;
659   
660   /// Die - Compile unit debug information entry.
661   ///
662   DIE *Die;
663   
664   /// DescToDieMap - Tracks the mapping of unit level debug informaton
665   /// descriptors to debug information entries.
666   std::map<DebugInfoDesc *, DIE *> DescToDieMap;
667
668   /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
669   /// descriptors to debug information entries using a DIEntry proxy.
670   std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
671
672   /// Globals - A map of globally visible named entities for this unit.
673   ///
674   std::map<std::string, DIE *> Globals;
675
676   /// DiesSet - Used to uniquely define dies within the compile unit.
677   ///
678   FoldingSet<DIE> DiesSet;
679   
680   /// Dies - List of all dies in the compile unit.
681   ///
682   std::vector<DIE *> Dies;
683   
684 public:
685   CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
686   : Desc(CUD)
687   , ID(I)
688   , Die(D)
689   , DescToDieMap()
690   , DescToDIEntryMap()
691   , Globals()
692   , DiesSet(InitDiesSetSize)
693   , Dies()
694   {}
695   
696   ~CompileUnit() {
697     delete Die;
698     
699     for (unsigned i = 0, N = Dies.size(); i < N; ++i)
700       delete Dies[i];
701   }
702   
703   // Accessors.
704   CompileUnitDesc *getDesc() const { return Desc; }
705   unsigned getID()           const { return ID; }
706   DIE* getDie()              const { return Die; }
707   std::map<std::string, DIE *> &getGlobals() { return Globals; }
708
709   /// hasContent - Return true if this compile unit has something to write out.
710   ///
711   bool hasContent() const {
712     return !Die->getChildren().empty();
713   }
714
715   /// AddGlobal - Add a new global entity to the compile unit.
716   ///
717   void AddGlobal(const std::string &Name, DIE *Die) {
718     Globals[Name] = Die;
719   }
720   
721   /// getDieMapSlotFor - Returns the debug information entry map slot for the
722   /// specified debug descriptor.
723   DIE *&getDieMapSlotFor(DebugInfoDesc *DD) {
724     return DescToDieMap[DD];
725   }
726   
727   /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
728   /// specified debug descriptor.
729   DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DD) {
730     return DescToDIEntryMap[DD];
731   }
732   
733   /// AddDie - Adds or interns the DIE to the compile unit.
734   ///
735   DIE *AddDie(DIE &Buffer) {
736     FoldingSetNodeID ID;
737     Buffer.Profile(ID);
738     void *Where;
739     DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
740     
741     if (!Die) {
742       Die = new DIE(Buffer);
743       DiesSet.InsertNode(Die, Where);
744       this->Die->AddChild(Die);
745       Buffer.Detach();
746     }
747     
748     return Die;
749   }
750 };
751
752 //===----------------------------------------------------------------------===//
753 /// Dwarf - Emits Dwarf debug and exception handling directives. 
754 ///
755 class Dwarf {
756
757 private:
758
759   //===--------------------------------------------------------------------===//
760   // Core attributes used by the Dwarf  writer.
761   //
762   
763   //
764   /// O - Stream to .s file.
765   ///
766   std::ostream &O;
767
768   /// Asm - Target of Dwarf emission.
769   ///
770   AsmPrinter *Asm;
771   
772   /// TAI - Target Asm Printer.
773   const TargetAsmInfo *TAI;
774   
775   /// TD - Target data.
776   const TargetData *TD;
777   
778   /// RI - Register Information.
779   const MRegisterInfo *RI;
780   
781   /// M - Current module.
782   ///
783   Module *M;
784   
785   /// MF - Current machine function.
786   ///
787   MachineFunction *MF;
788   
789   /// MMI - Collected machine module information.
790   ///
791   MachineModuleInfo *MMI;
792   
793   /// didInitial - Flag to indicate if initial emission has been done.
794   ///
795   bool didInitial;
796   
797   /// shouldEmit - Flag to indicate if debug information should be emitted.
798   ///
799   bool shouldEmit;
800   
801   /// SubprogramCount - The running count of functions being compiled.
802   ///
803   unsigned SubprogramCount;
804   
805   //===--------------------------------------------------------------------===//
806   // Attributes used to construct specific Dwarf sections.
807   //
808   
809   /// CompileUnits - All the compile units involved in this build.  The index
810   /// of each entry in this vector corresponds to the sources in MMI.
811   std::vector<CompileUnit *> CompileUnits;
812   
813   /// AbbreviationsSet - Used to uniquely define abbreviations.
814   ///
815   FoldingSet<DIEAbbrev> AbbreviationsSet;
816
817   /// Abbreviations - A list of all the unique abbreviations in use.
818   ///
819   std::vector<DIEAbbrev *> Abbreviations;
820   
821   /// ValuesSet - Used to uniquely define values.
822   ///
823   FoldingSet<DIEValue> ValuesSet;
824   
825   /// Values - A list of all the unique values in use.
826   ///
827   std::vector<DIEValue *> Values;
828   
829   /// StringPool - A UniqueVector of strings used by indirect references.
830   ///
831   UniqueVector<std::string> StringPool;
832
833   /// UnitMap - Map debug information descriptor to compile unit.
834   ///
835   std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
836   
837   /// SectionMap - Provides a unique id per text section.
838   ///
839   UniqueVector<std::string> SectionMap;
840   
841   /// SectionSourceLines - Tracks line numbers per text section.
842   ///
843   std::vector<std::vector<SourceLineInfo> > SectionSourceLines;
844
845
846 public:
847
848   //===--------------------------------------------------------------------===//
849   // Accessors.
850   //
851   AsmPrinter *getAsm() const { return Asm; }
852
853   /// PrintLabelName - Print label name in form used by Dwarf writer.
854   ///
855   void PrintLabelName(DWLabel Label) const {
856     PrintLabelName(Label.Tag, Label.Number);
857   }
858   void PrintLabelName(const char *Tag, unsigned Number) const {
859     O << TAI->getPrivateGlobalPrefix()
860       << "debug_"
861       << Tag;
862     if (Number) O << Number;
863   }
864   
865   /// EmitLabel - Emit location label for internal use by Dwarf.
866   ///
867   void EmitLabel(DWLabel Label) const {
868     EmitLabel(Label.Tag, Label.Number);
869   }
870   void EmitLabel(const char *Tag, unsigned Number) const {
871     PrintLabelName(Tag, Number);
872     O << ":\n";
873   }
874   
875   /// EmitReference - Emit a reference to a label.
876   ///
877   void EmitReference(DWLabel Label) const {
878     EmitReference(Label.Tag, Label.Number);
879   }
880   void EmitReference(const char *Tag, unsigned Number) const {
881     if (TAI->getAddressSize() == sizeof(int32_t))
882       O << TAI->getData32bitsDirective();
883     else
884       O << TAI->getData64bitsDirective();
885       
886     PrintLabelName(Tag, Number);
887   }
888   void EmitReference(const std::string &Name) const {
889     if (TAI->getAddressSize() == sizeof(int32_t))
890       O << TAI->getData32bitsDirective();
891     else
892       O << TAI->getData64bitsDirective();
893       
894     O << Name;
895   }
896
897   /// EmitDifference - Emit the difference between two labels.  Some
898   /// assemblers do not behave with absolute expressions with data directives,
899   /// so there is an option (needsSet) to use an intermediary set expression.
900   void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
901                       bool IsSmall = false) const {
902     EmitDifference(LabelHi.Tag, LabelHi.Number,
903                    LabelLo.Tag, LabelLo.Number,
904                    IsSmall);
905   }
906   void EmitDifference(const char *TagHi, unsigned NumberHi,
907                       const char *TagLo, unsigned NumberLo,
908                       bool IsSmall = false) const {
909     if (TAI->needsSet()) {
910       static unsigned SetCounter = 0;
911       
912       O << "\t.set\t";
913       PrintLabelName("set", SetCounter);
914       O << ",";
915       PrintLabelName(TagHi, NumberHi);
916       O << "-";
917       PrintLabelName(TagLo, NumberLo);
918       O << "\n";
919       
920       if (IsSmall || TAI->getAddressSize() == sizeof(int32_t))
921         O << TAI->getData32bitsDirective();
922       else
923         O << TAI->getData64bitsDirective();
924         
925       PrintLabelName("set", SetCounter);
926       
927       ++SetCounter;
928     } else {
929       if (IsSmall || TAI->getAddressSize() == sizeof(int32_t))
930         O << TAI->getData32bitsDirective();
931       else
932         O << TAI->getData64bitsDirective();
933         
934       PrintLabelName(TagHi, NumberHi);
935       O << "-";
936       PrintLabelName(TagLo, NumberLo);
937     }
938   }
939                       
940   /// AssignAbbrevNumber - Define a unique number for the abbreviation.
941   ///  
942   void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
943     // Profile the node so that we can make it unique.
944     FoldingSetNodeID ID;
945     Abbrev.Profile(ID);
946     
947     // Check the set for priors.
948     DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
949     
950     // If it's newly added.
951     if (InSet == &Abbrev) {
952       // Add to abbreviation list. 
953       Abbreviations.push_back(&Abbrev);
954       // Assign the vector position + 1 as its number.
955       Abbrev.setNumber(Abbreviations.size());
956     } else {
957       // Assign existing abbreviation number.
958       Abbrev.setNumber(InSet->getNumber());
959     }
960   }
961
962   /// NewString - Add a string to the constant pool and returns a label.
963   ///
964   DWLabel NewString(const std::string &String) {
965     unsigned StringID = StringPool.insert(String);
966     return DWLabel("string", StringID);
967   }
968   
969   /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
970   /// entry.
971   DIEntry *NewDIEntry(DIE *Entry = NULL) {
972     DIEntry *Value;
973     
974     if (Entry) {
975       FoldingSetNodeID ID;
976       DIEntry::Profile(ID, Entry);
977       void *Where;
978       Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
979       
980       if (Value) return Value;
981       
982       Value = new DIEntry(Entry);
983       ValuesSet.InsertNode(Value, Where);
984     } else {
985       Value = new DIEntry(Entry);
986     }
987     
988     Values.push_back(Value);
989     return Value;
990   }
991   
992   /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
993   ///
994   void SetDIEntry(DIEntry *Value, DIE *Entry) {
995     Value->Entry = Entry;
996     // Add to values set if not already there.  If it is, we merely have a
997     // duplicate in the values list (no harm.)
998     ValuesSet.GetOrInsertNode(Value);
999   }
1000
1001   /// AddUInt - Add an unsigned integer attribute data and value.
1002   ///
1003   void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1004     if (!Form) Form = DIEInteger::BestForm(false, Integer);
1005
1006     FoldingSetNodeID ID;
1007     DIEInteger::Profile(ID, Integer);
1008     void *Where;
1009     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1010     if (!Value) {
1011       Value = new DIEInteger(Integer);
1012       ValuesSet.InsertNode(Value, Where);
1013       Values.push_back(Value);
1014     }
1015   
1016     Die->AddValue(Attribute, Form, Value);
1017   }
1018       
1019   /// AddSInt - Add an signed integer attribute data and value.
1020   ///
1021   void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1022     if (!Form) Form = DIEInteger::BestForm(true, Integer);
1023
1024     FoldingSetNodeID ID;
1025     DIEInteger::Profile(ID, (uint64_t)Integer);
1026     void *Where;
1027     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1028     if (!Value) {
1029       Value = new DIEInteger(Integer);
1030       ValuesSet.InsertNode(Value, Where);
1031       Values.push_back(Value);
1032     }
1033   
1034     Die->AddValue(Attribute, Form, Value);
1035   }
1036       
1037   /// AddString - Add a std::string attribute data and value.
1038   ///
1039   void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1040                  const std::string &String) {
1041     FoldingSetNodeID ID;
1042     DIEString::Profile(ID, String);
1043     void *Where;
1044     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1045     if (!Value) {
1046       Value = new DIEString(String);
1047       ValuesSet.InsertNode(Value, Where);
1048       Values.push_back(Value);
1049     }
1050   
1051     Die->AddValue(Attribute, Form, Value);
1052   }
1053       
1054   /// AddLabel - Add a Dwarf label attribute data and value.
1055   ///
1056   void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1057                      const DWLabel &Label) {
1058     FoldingSetNodeID ID;
1059     DIEDwarfLabel::Profile(ID, Label);
1060     void *Where;
1061     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1062     if (!Value) {
1063       Value = new DIEDwarfLabel(Label);
1064       ValuesSet.InsertNode(Value, Where);
1065       Values.push_back(Value);
1066     }
1067   
1068     Die->AddValue(Attribute, Form, Value);
1069   }
1070       
1071   /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1072   ///
1073   void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1074                       const std::string &Label) {
1075     FoldingSetNodeID ID;
1076     DIEObjectLabel::Profile(ID, Label);
1077     void *Where;
1078     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1079     if (!Value) {
1080       Value = new DIEObjectLabel(Label);
1081       ValuesSet.InsertNode(Value, Where);
1082       Values.push_back(Value);
1083     }
1084   
1085     Die->AddValue(Attribute, Form, Value);
1086   }
1087       
1088   /// AddDelta - Add a label delta attribute data and value.
1089   ///
1090   void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1091                           const DWLabel &Hi, const DWLabel &Lo) {
1092     FoldingSetNodeID ID;
1093     DIEDelta::Profile(ID, Hi, Lo);
1094     void *Where;
1095     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1096     if (!Value) {
1097       Value = new DIEDelta(Hi, Lo);
1098       ValuesSet.InsertNode(Value, Where);
1099       Values.push_back(Value);
1100     }
1101   
1102     Die->AddValue(Attribute, Form, Value);
1103   }
1104       
1105   /// AddDIEntry - Add a DIE attribute data and value.
1106   ///
1107   void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1108     Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1109   }
1110
1111   /// AddBlock - Add block data.
1112   ///
1113   void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1114     Block->ComputeSize(*this);
1115     FoldingSetNodeID ID;
1116     Block->Profile(ID);
1117     void *Where;
1118     DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1119     if (!Value) {
1120       Value = Block;
1121       ValuesSet.InsertNode(Value, Where);
1122       Values.push_back(Value);
1123     } else {
1124       delete Block;
1125     }
1126   
1127     Die->AddValue(Attribute, Block->BestForm(), Value);
1128   }
1129
1130 private:
1131
1132   /// AddSourceLine - Add location information to specified debug information
1133   /// entry.
1134   void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1135     if (File && Line) {
1136       CompileUnit *FileUnit = FindCompileUnit(File);
1137       unsigned FileID = FileUnit->getID();
1138       AddUInt(Die, DW_AT_decl_file, 0, FileID);
1139       AddUInt(Die, DW_AT_decl_line, 0, Line);
1140     }
1141   }
1142
1143   /// AddAddress - Add an address attribute to a die based on the location
1144   /// provided.
1145   void AddAddress(DIE *Die, unsigned Attribute,
1146                             const MachineLocation &Location) {
1147     unsigned Reg = RI->getDwarfRegNum(Location.getRegister());
1148     DIEBlock *Block = new DIEBlock();
1149     
1150     if (Location.isRegister()) {
1151       if (Reg < 32) {
1152         AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1153       } else {
1154         AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1155         AddUInt(Block, 0, DW_FORM_udata, Reg);
1156       }
1157     } else {
1158       if (Reg < 32) {
1159         AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1160       } else {
1161         AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1162         AddUInt(Block, 0, DW_FORM_udata, Reg);
1163       }
1164       AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1165     }
1166     
1167     AddBlock(Die, Attribute, 0, Block);
1168   }
1169   
1170   /// AddBasicType - Add a new basic type attribute to the specified entity.
1171   ///
1172   void AddBasicType(DIE *Entity, CompileUnit *Unit,
1173                     const std::string &Name,
1174                     unsigned Encoding, unsigned Size) {
1175     DIE *Die = ConstructBasicType(Unit, Name, Encoding, Size);
1176     AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1177   }
1178   
1179   /// ConstructBasicType - Construct a new basic type.
1180   ///
1181   DIE *ConstructBasicType(CompileUnit *Unit,
1182                           const std::string &Name,
1183                           unsigned Encoding, unsigned Size) {
1184     DIE Buffer(DW_TAG_base_type);
1185     AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1186     AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1187     if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1188     return Unit->AddDie(Buffer);
1189   }
1190   
1191   /// AddPointerType - Add a new pointer type attribute to the specified entity.
1192   ///
1193   void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1194     DIE *Die = ConstructPointerType(Unit, Name);
1195     AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1196   }
1197   
1198   /// ConstructPointerType - Construct a new pointer type.
1199   ///
1200   DIE *ConstructPointerType(CompileUnit *Unit, const std::string &Name) {
1201     DIE Buffer(DW_TAG_pointer_type);
1202     AddUInt(&Buffer, DW_AT_byte_size, 0, TAI->getAddressSize());
1203     if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1204     return Unit->AddDie(Buffer);
1205   }
1206   
1207   /// AddType - Add a new type attribute to the specified entity.
1208   ///
1209   void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1210     if (!TyDesc) {
1211       AddBasicType(Entity, Unit, "", DW_ATE_signed, sizeof(int32_t));
1212     } else {
1213       // Check for pre-existence.
1214       DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
1215       
1216       // If it exists then use the existing value.
1217       if (Slot) {
1218         Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1219         return;
1220       }
1221       
1222       if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1223         // FIXME - Not sure why programs and variables are coming through here.
1224         // Short cut for handling subprogram types (not really a TyDesc.)
1225         AddPointerType(Entity, Unit, SubprogramTy->getName());
1226       } else if (GlobalVariableDesc *GlobalTy =
1227                                          dyn_cast<GlobalVariableDesc>(TyDesc)) {
1228         // FIXME - Not sure why programs and variables are coming through here.
1229         // Short cut for handling global variable types (not really a TyDesc.)
1230         AddPointerType(Entity, Unit, GlobalTy->getName());
1231       } else {  
1232         // Set up proxy.
1233         Slot = NewDIEntry();
1234         
1235         // Construct type.
1236         DIE Buffer(DW_TAG_base_type);
1237         ConstructType(Buffer, TyDesc, Unit);
1238         
1239         // Add debug information entry to entity and unit.
1240         DIE *Die = Unit->AddDie(Buffer);
1241         SetDIEntry(Slot, Die);
1242         Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1243       }
1244     }
1245   }
1246   
1247   /// ConstructType - Adds all the required attributes to the type.
1248   ///
1249   void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
1250     // Get core information.
1251     const std::string &Name = TyDesc->getName();
1252     uint64_t Size = TyDesc->getSize() >> 3;
1253     
1254     if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
1255       // Fundamental types like int, float, bool
1256       Buffer.setTag(DW_TAG_base_type);
1257       AddUInt(&Buffer, DW_AT_encoding,  DW_FORM_data1, BasicTy->getEncoding());
1258     } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
1259       // Fetch tag.
1260       unsigned Tag = DerivedTy->getTag();
1261       // FIXME - Workaround for templates.
1262       if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1263       // Pointers, typedefs et al. 
1264       Buffer.setTag(Tag);
1265       // Map to main type, void will not have a type.
1266       if (TypeDesc *FromTy = DerivedTy->getFromType())
1267         AddType(&Buffer, FromTy, Unit);
1268     } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
1269       // Fetch tag.
1270       unsigned Tag = CompTy->getTag();
1271       
1272       // Set tag accordingly.
1273       if (Tag == DW_TAG_vector_type)
1274         Buffer.setTag(DW_TAG_array_type);
1275       else 
1276         Buffer.setTag(Tag);
1277
1278       std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
1279       
1280       switch (Tag) {
1281       case DW_TAG_vector_type:
1282         AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1283         // Fall thru
1284       case DW_TAG_array_type: {
1285         // Add element type.
1286         if (TypeDesc *FromTy = CompTy->getFromType())
1287           AddType(&Buffer, FromTy, Unit);
1288         
1289         // Don't emit size attribute.
1290         Size = 0;
1291         
1292         // Construct an anonymous type for index type.
1293         DIE *IndexTy = ConstructBasicType(Unit, "", DW_ATE_signed,
1294                                           sizeof(int32_t));
1295       
1296         // Add subranges to array type.
1297         for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1298           SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1299           int64_t Lo = SRD->getLo();
1300           int64_t Hi = SRD->getHi();
1301           DIE *Subrange = new DIE(DW_TAG_subrange_type);
1302           
1303           // If a range is available.
1304           if (Lo != Hi) {
1305             AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1306             // Only add low if non-zero.
1307             if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
1308             AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
1309           }
1310           
1311           Buffer.AddChild(Subrange);
1312         }
1313         break;
1314       }
1315       case DW_TAG_structure_type:
1316       case DW_TAG_union_type: {
1317         // Add elements to structure type.
1318         for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1319           DebugInfoDesc *Element = Elements[i];
1320           
1321           if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
1322             // Add field or base class.
1323             
1324             unsigned Tag = MemberDesc->getTag();
1325           
1326             // Extract the basic information.
1327             const std::string &Name = MemberDesc->getName();
1328             uint64_t Size = MemberDesc->getSize();
1329             uint64_t Align = MemberDesc->getAlign();
1330             uint64_t Offset = MemberDesc->getOffset();
1331        
1332             // Construct member debug information entry.
1333             DIE *Member = new DIE(Tag);
1334             
1335             // Add name if not "".
1336             if (!Name.empty())
1337               AddString(Member, DW_AT_name, DW_FORM_string, Name);
1338             // Add location if available.
1339             AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
1340             
1341             // Most of the time the field info is the same as the members.
1342             uint64_t FieldSize = Size;
1343             uint64_t FieldAlign = Align;
1344             uint64_t FieldOffset = Offset;
1345             
1346             // Set the member type.
1347             TypeDesc *FromTy = MemberDesc->getFromType();
1348             AddType(Member, FromTy, Unit);
1349             
1350             // Walk up typedefs until a real size is found.
1351             while (FromTy) {
1352               if (FromTy->getTag() != DW_TAG_typedef) {
1353                 FieldSize = FromTy->getSize();
1354                 FieldAlign = FromTy->getSize();
1355                 break;
1356               }
1357               
1358               FromTy = dyn_cast<DerivedTypeDesc>(FromTy)->getFromType();
1359             }
1360             
1361             // Unless we have a bit field.
1362             if (Tag == DW_TAG_member && FieldSize != Size) {
1363               // Construct the alignment mask.
1364               uint64_t AlignMask = ~(FieldAlign - 1);
1365               // Determine the high bit + 1 of the declared size.
1366               uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1367               // Work backwards to determine the base offset of the field.
1368               FieldOffset = HiMark - FieldSize;
1369               // Now normalize offset to the field.
1370               Offset -= FieldOffset;
1371               
1372               // Maybe we need to work from the other end.
1373               if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1374               
1375               // Add size and offset.
1376               AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
1377               AddUInt(Member, DW_AT_bit_size, 0, Size);
1378               AddUInt(Member, DW_AT_bit_offset, 0, Offset);
1379             }
1380             
1381             // Add computation for offset.
1382             DIEBlock *Block = new DIEBlock();
1383             AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1384             AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
1385             AddBlock(Member, DW_AT_data_member_location, 0, Block);
1386
1387             // Add accessibility (public default unless is base class.
1388             if (MemberDesc->isProtected()) {
1389               AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
1390             } else if (MemberDesc->isPrivate()) {
1391               AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
1392             } else if (Tag == DW_TAG_inheritance) {
1393               AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
1394             }
1395             
1396             Buffer.AddChild(Member);
1397           } else if (GlobalVariableDesc *StaticDesc =
1398                                         dyn_cast<GlobalVariableDesc>(Element)) {
1399             // Add static member.
1400             
1401             // Construct member debug information entry.
1402             DIE *Static = new DIE(DW_TAG_variable);
1403             
1404             // Add name and mangled name.
1405             const std::string &Name = StaticDesc->getName();
1406             const std::string &LinkageName = StaticDesc->getLinkageName();
1407             AddString(Static, DW_AT_name, DW_FORM_string, Name);
1408             if (!LinkageName.empty()) {
1409               AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
1410                                 LinkageName);
1411             }
1412             
1413             // Add location.
1414             AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
1415            
1416             // Add type.
1417             if (TypeDesc *StaticTy = StaticDesc->getType())
1418               AddType(Static, StaticTy, Unit);
1419             
1420             // Add flags.
1421             if (!StaticDesc->isStatic())
1422               AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
1423             AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
1424             
1425             Buffer.AddChild(Static);
1426           } else if (SubprogramDesc *MethodDesc =
1427                                             dyn_cast<SubprogramDesc>(Element)) {
1428             // Add member function.
1429             
1430             // Construct member debug information entry.
1431             DIE *Method = new DIE(DW_TAG_subprogram);
1432            
1433             // Add name and mangled name.
1434             const std::string &Name = MethodDesc->getName();
1435             const std::string &LinkageName = MethodDesc->getLinkageName();
1436             
1437             AddString(Method, DW_AT_name, DW_FORM_string, Name);            
1438             bool IsCTor = TyDesc->getName() == Name;
1439             
1440             if (!LinkageName.empty()) {
1441               AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
1442                                 LinkageName);
1443             }
1444             
1445             // Add location.
1446             AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
1447            
1448             // Add type.
1449             if (CompositeTypeDesc *MethodTy =
1450                    dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
1451               // Get argument information.
1452               std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
1453              
1454               // If not a ctor.
1455               if (!IsCTor) {
1456                 // Add return type.
1457                 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
1458               }
1459               
1460               // Add arguments.
1461               for(unsigned i = 1, N = Args.size(); i < N; ++i) {
1462                 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1463                 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
1464                 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
1465                 Method->AddChild(Arg);
1466               }
1467             }
1468
1469             // Add flags.
1470             if (!MethodDesc->isStatic())
1471               AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
1472             AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
1473               
1474             Buffer.AddChild(Method);
1475           }
1476         }
1477         break;
1478       }
1479       case DW_TAG_enumeration_type: {
1480         // Add enumerators to enumeration type.
1481         for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1482           EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
1483           const std::string &Name = ED->getName();
1484           int64_t Value = ED->getValue();
1485           DIE *Enumerator = new DIE(DW_TAG_enumerator);
1486           AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1487           AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1488           Buffer.AddChild(Enumerator);
1489         }
1490
1491         break;
1492       }
1493       case DW_TAG_subroutine_type: {
1494         // Add prototype flag.
1495         AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1496         // Add return type.
1497         AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
1498         
1499         // Add arguments.
1500         for(unsigned i = 1, N = Elements.size(); i < N; ++i) {
1501           DIE *Arg = new DIE(DW_TAG_formal_parameter);
1502           AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
1503           Buffer.AddChild(Arg);
1504         }
1505         
1506         break;
1507       }
1508       default: break;
1509       }
1510     }
1511    
1512     // Add size if non-zero (derived types don't have a size.)
1513     if (Size) AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1514     // Add name if not anonymous or intermediate type.
1515     if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1516     // Add source line info if available.
1517     AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
1518   }
1519
1520   /// NewCompileUnit - Create new compile unit and it's debug information entry.
1521   ///
1522   CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
1523     // Construct debug information entry.
1524     DIE *Die = new DIE(DW_TAG_compile_unit);
1525     AddDelta(Die, DW_AT_stmt_list, DW_FORM_data4, DWLabel("section_line", 0),
1526                                                   DWLabel("section_line", 0));
1527     AddString(Die, DW_AT_producer,  DW_FORM_string, UnitDesc->getProducer());
1528     AddUInt  (Die, DW_AT_language,  DW_FORM_data1,  UnitDesc->getLanguage());
1529     AddString(Die, DW_AT_name,      DW_FORM_string, UnitDesc->getFileName());
1530     AddString(Die, DW_AT_comp_dir,  DW_FORM_string, UnitDesc->getDirectory());
1531     
1532     // Construct compile unit.
1533     CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
1534     
1535     // Add Unit to compile unit map.
1536     DescToUnitMap[UnitDesc] = Unit;
1537     
1538     return Unit;
1539   }
1540
1541   /// GetBaseCompileUnit - Get the main compile unit.
1542   ///
1543   CompileUnit *GetBaseCompileUnit() const {
1544     CompileUnit *Unit = CompileUnits[0];
1545     assert(Unit && "Missing compile unit.");
1546     return Unit;
1547   }
1548
1549   /// FindCompileUnit - Get the compile unit for the given descriptor.
1550   ///
1551   CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
1552     CompileUnit *Unit = DescToUnitMap[UnitDesc];
1553     assert(Unit && "Missing compile unit.");
1554     return Unit;
1555   }
1556
1557   /// NewGlobalVariable - Add a new global variable DIE.
1558   ///
1559   DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
1560     // Get the compile unit context.
1561     CompileUnitDesc *UnitDesc =
1562       static_cast<CompileUnitDesc *>(GVD->getContext());
1563     CompileUnit *Unit = GetBaseCompileUnit();
1564
1565     // Check for pre-existence.
1566     DIE *&Slot = Unit->getDieMapSlotFor(GVD);
1567     if (Slot) return Slot;
1568     
1569     // Get the global variable itself.
1570     GlobalVariable *GV = GVD->getGlobalVariable();
1571
1572     const std::string &Name = GVD->getName();
1573     const std::string &FullName = GVD->getFullName();
1574     const std::string &LinkageName = GVD->getLinkageName();
1575     // Create the global's variable DIE.
1576     DIE *VariableDie = new DIE(DW_TAG_variable);
1577     AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
1578     if (!LinkageName.empty()) {
1579       AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1580                              LinkageName);
1581     }
1582     AddType(VariableDie, GVD->getType(), Unit);
1583     if (!GVD->isStatic())
1584       AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
1585     
1586     // Add source line info if available.
1587     AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
1588     
1589     // Add address.
1590     DIEBlock *Block = new DIEBlock();
1591     AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
1592     AddObjectLabel(Block, 0, DW_FORM_udata, Asm->getGlobalLinkName(GV));
1593     AddBlock(VariableDie, DW_AT_location, 0, Block);
1594     
1595     // Add to map.
1596     Slot = VariableDie;
1597    
1598     // Add to context owner.
1599     Unit->getDie()->AddChild(VariableDie);
1600     
1601     // Expose as global.
1602     // FIXME - need to check external flag.
1603     Unit->AddGlobal(FullName, VariableDie);
1604     
1605     return VariableDie;
1606   }
1607
1608   /// NewSubprogram - Add a new subprogram DIE.
1609   ///
1610   DIE *NewSubprogram(SubprogramDesc *SPD) {
1611     // Get the compile unit context.
1612     CompileUnitDesc *UnitDesc =
1613       static_cast<CompileUnitDesc *>(SPD->getContext());
1614     CompileUnit *Unit = GetBaseCompileUnit();
1615
1616     // Check for pre-existence.
1617     DIE *&Slot = Unit->getDieMapSlotFor(SPD);
1618     if (Slot) return Slot;
1619     
1620     // Gather the details (simplify add attribute code.)
1621     const std::string &Name = SPD->getName();
1622     const std::string &FullName = SPD->getFullName();
1623     const std::string &LinkageName = SPD->getLinkageName();
1624                                       
1625     DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
1626     AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
1627     if (!LinkageName.empty()) {
1628       AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1629                                LinkageName);
1630     }
1631     if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
1632     if (!SPD->isStatic())
1633       AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
1634     AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
1635     
1636     // Add source line info if available.
1637     AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
1638
1639     // Add to map.
1640     Slot = SubprogramDie;
1641    
1642     // Add to context owner.
1643     Unit->getDie()->AddChild(SubprogramDie);
1644     
1645     // Expose as global.
1646     Unit->AddGlobal(FullName, SubprogramDie);
1647     
1648     return SubprogramDie;
1649   }
1650
1651   /// NewScopeVariable - Create a new scope variable.
1652   ///
1653   DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
1654     // Get the descriptor.
1655     VariableDesc *VD = DV->getDesc();
1656
1657     // Translate tag to proper Dwarf tag.  The result variable is dropped for
1658     // now.
1659     unsigned Tag;
1660     switch (VD->getTag()) {
1661     case DW_TAG_return_variable:  return NULL;
1662     case DW_TAG_arg_variable:     Tag = DW_TAG_formal_parameter; break;
1663     case DW_TAG_auto_variable:    // fall thru
1664     default:                      Tag = DW_TAG_variable; break;
1665     }
1666
1667     // Define variable debug information entry.
1668     DIE *VariableDie = new DIE(Tag);
1669     AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
1670
1671     // Add source line info if available.
1672     AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
1673     
1674     // Add variable type.
1675     AddType(VariableDie, VD->getType(), Unit); 
1676     
1677     // Add variable address.
1678     MachineLocation Location;
1679     RI->getLocation(*MF, DV->getFrameIndex(), Location);
1680     AddAddress(VariableDie, DW_AT_location, Location);
1681
1682     return VariableDie;
1683   }
1684
1685   /// ConstructScope - Construct the components of a scope.
1686   ///
1687   void ConstructScope(DebugScope *ParentScope,
1688                       unsigned ParentStartID, unsigned ParentEndID,
1689                       DIE *ParentDie, CompileUnit *Unit) {
1690     // Add variables to scope.
1691     std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
1692     for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1693       DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
1694       if (VariableDie) ParentDie->AddChild(VariableDie);
1695     }
1696     
1697     // Add nested scopes.
1698     std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
1699     for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1700       // Define the Scope debug information entry.
1701       DebugScope *Scope = Scopes[j];
1702       // FIXME - Ignore inlined functions for the time being.
1703       if (!Scope->getParent()) continue;
1704       
1705       unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1706       unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1707
1708       // Ignore empty scopes.
1709       if (StartID == EndID && StartID != 0) continue;
1710       if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
1711       
1712       if (StartID == ParentStartID && EndID == ParentEndID) {
1713         // Just add stuff to the parent scope.
1714         ConstructScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
1715       } else {
1716         DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
1717         
1718         // Add the scope bounds.
1719         if (StartID) {
1720           AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1721                              DWLabel("loc", StartID));
1722         } else {
1723           AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1724                              DWLabel("func_begin", SubprogramCount));
1725         }
1726         if (EndID) {
1727           AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1728                              DWLabel("loc", EndID));
1729         } else {
1730           AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1731                              DWLabel("func_end", SubprogramCount));
1732         }
1733                            
1734         // Add the scope contents.
1735         ConstructScope(Scope, StartID, EndID, ScopeDie, Unit);
1736         ParentDie->AddChild(ScopeDie);
1737       }
1738     }
1739   }
1740
1741   /// ConstructRootScope - Construct the scope for the subprogram.
1742   ///
1743   void ConstructRootScope(DebugScope *RootScope) {
1744     // Exit if there is no root scope.
1745     if (!RootScope) return;
1746     
1747     // Get the subprogram debug information entry. 
1748     SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
1749     
1750     // Get the compile unit context.
1751     CompileUnit *Unit = GetBaseCompileUnit();
1752     
1753     // Get the subprogram die.
1754     DIE *SPDie = Unit->getDieMapSlotFor(SPD);
1755     assert(SPDie && "Missing subprogram descriptor");
1756     
1757     // Add the function bounds.
1758     AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
1759                     DWLabel("func_begin", SubprogramCount));
1760     AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
1761                     DWLabel("func_end", SubprogramCount));
1762     MachineLocation Location(RI->getFrameRegister(*MF));
1763     AddAddress(SPDie, DW_AT_frame_base, Location);
1764
1765     ConstructScope(RootScope, 0, 0, SPDie, Unit);
1766   }
1767
1768   /// EmitInitial - Emit initial Dwarf declarations.  This is necessary for cc
1769   /// tools to recognize the object file contains Dwarf information.
1770   void EmitInitial() {
1771     // Check to see if we already emitted intial headers.
1772     if (didInitial) return;
1773     didInitial = true;
1774     
1775     // Dwarf sections base addresses.
1776     if (TAI->getDwarfRequiresFrameSection()) {
1777       Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
1778       EmitLabel("section_frame", 0);
1779     }
1780     Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
1781     EmitLabel("section_info", 0);
1782     Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
1783     EmitLabel("section_abbrev", 0);
1784     Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
1785     EmitLabel("section_aranges", 0);
1786     Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
1787     EmitLabel("section_macinfo", 0);
1788     Asm->SwitchToDataSection(TAI->getDwarfLineSection());
1789     EmitLabel("section_line", 0);
1790     Asm->SwitchToDataSection(TAI->getDwarfLocSection());
1791     EmitLabel("section_loc", 0);
1792     Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
1793     EmitLabel("section_pubnames", 0);
1794     Asm->SwitchToDataSection(TAI->getDwarfStrSection());
1795     EmitLabel("section_str", 0);
1796     Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
1797     EmitLabel("section_ranges", 0);
1798
1799     Asm->SwitchToTextSection(TAI->getTextSection());
1800     EmitLabel("text_begin", 0);
1801     Asm->SwitchToDataSection(TAI->getDataSection());
1802     EmitLabel("data_begin", 0);
1803
1804     // Emit common frame information.
1805     EmitInitialDebugFrame();
1806   }
1807
1808   /// EmitDIE - Recusively Emits a debug information entry.
1809   ///
1810   void EmitDIE(DIE *Die) const {
1811     // Get the abbreviation for this DIE.
1812     unsigned AbbrevNumber = Die->getAbbrevNumber();
1813     const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1814     
1815     Asm->EOL("");
1816
1817     // Emit the code (index) for the abbreviation.
1818     Asm->EmitULEB128Bytes(AbbrevNumber);
1819     Asm->EOL(std::string("Abbrev [" +
1820              utostr(AbbrevNumber) +
1821              "] 0x" + utohexstr(Die->getOffset()) +
1822              ":0x" + utohexstr(Die->getSize()) + " " +
1823              TagString(Abbrev->getTag())));
1824     
1825     const std::vector<DIEValue *> &Values = Die->getValues();
1826     const std::vector<DIEAbbrevData> &AbbrevData = Abbrev->getData();
1827     
1828     // Emit the DIE attribute values.
1829     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1830       unsigned Attr = AbbrevData[i].getAttribute();
1831       unsigned Form = AbbrevData[i].getForm();
1832       assert(Form && "Too many attributes for DIE (check abbreviation)");
1833       
1834       switch (Attr) {
1835       case DW_AT_sibling: {
1836         Asm->EmitInt32(Die->SiblingOffset());
1837         break;
1838       }
1839       default: {
1840         // Emit an attribute using the defined form.
1841         Values[i]->EmitValue(*this, Form);
1842         break;
1843       }
1844       }
1845       
1846       Asm->EOL(AttributeString(Attr));
1847     }
1848     
1849     // Emit the DIE children if any.
1850     if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
1851       const std::vector<DIE *> &Children = Die->getChildren();
1852       
1853       for (unsigned j = 0, M = Children.size(); j < M; ++j) {
1854         EmitDIE(Children[j]);
1855       }
1856       
1857       Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
1858     }
1859   }
1860
1861   /// SizeAndOffsetDie - Compute the size and offset of a DIE.
1862   ///
1863   unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
1864     // Get the children.
1865     const std::vector<DIE *> &Children = Die->getChildren();
1866     
1867     // If not last sibling and has children then add sibling offset attribute.
1868     if (!Last && !Children.empty()) Die->AddSiblingOffset();
1869
1870     // Record the abbreviation.
1871     AssignAbbrevNumber(Die->getAbbrev());
1872    
1873     // Get the abbreviation for this DIE.
1874     unsigned AbbrevNumber = Die->getAbbrevNumber();
1875     const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1876
1877     // Set DIE offset
1878     Die->setOffset(Offset);
1879     
1880     // Start the size with the size of abbreviation code.
1881     Offset += Asm->SizeULEB128(AbbrevNumber);
1882     
1883     const std::vector<DIEValue *> &Values = Die->getValues();
1884     const std::vector<DIEAbbrevData> &AbbrevData = Abbrev->getData();
1885
1886     // Size the DIE attribute values.
1887     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1888       // Size attribute value.
1889       Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
1890     }
1891     
1892     // Size the DIE children if any.
1893     if (!Children.empty()) {
1894       assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
1895              "Children flag not set");
1896       
1897       for (unsigned j = 0, M = Children.size(); j < M; ++j) {
1898         Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
1899       }
1900       
1901       // End of children marker.
1902       Offset += sizeof(int8_t);
1903     }
1904
1905     Die->setSize(Offset - Die->getOffset());
1906     return Offset;
1907   }
1908
1909   /// SizeAndOffsets - Compute the size and offset of all the DIEs.
1910   ///
1911   void SizeAndOffsets() {
1912     // Process base compile unit.
1913     CompileUnit *Unit = GetBaseCompileUnit();
1914     // Compute size of compile unit header
1915     unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
1916                       sizeof(int16_t) + // DWARF version number
1917                       sizeof(int32_t) + // Offset Into Abbrev. Section
1918                       sizeof(int8_t);   // Pointer Size (in bytes)
1919     SizeAndOffsetDie(Unit->getDie(), Offset, true);
1920   }
1921
1922   /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1923   /// frame.
1924   void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
1925                                    std::vector<MachineMove> &Moves) {
1926     int stackGrowth =
1927         Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1928           TargetFrameInfo::StackGrowsUp ?
1929             TAI->getAddressSize() : -TAI->getAddressSize();
1930
1931     for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1932       MachineMove &Move = Moves[i];
1933       unsigned LabelID = Move.getLabelID();
1934       
1935       if (LabelID) {
1936         LabelID = MMI->MappedLabel(LabelID);
1937       
1938         // Throw out move if the label is invalid.
1939         if (!LabelID) continue;
1940       }
1941       
1942       const MachineLocation &Dst = Move.getDestination();
1943       const MachineLocation &Src = Move.getSource();
1944       
1945       // Advance row if new location.
1946       if (BaseLabel && LabelID && BaseLabelID != LabelID) {
1947         Asm->EmitInt8(DW_CFA_advance_loc4);
1948         Asm->EOL("DW_CFA_advance_loc4");
1949         EmitDifference("loc", LabelID, BaseLabel, BaseLabelID, true);
1950         Asm->EOL("");
1951         
1952         BaseLabelID = LabelID;
1953         BaseLabel = "loc";
1954       }
1955       
1956       // If advancing cfa.
1957       if (Dst.isRegister() && Dst.getRegister() == MachineLocation::VirtualFP) {
1958         if (!Src.isRegister()) {
1959           if (Src.getRegister() == MachineLocation::VirtualFP) {
1960             Asm->EmitInt8(DW_CFA_def_cfa_offset);
1961             Asm->EOL("DW_CFA_def_cfa_offset");
1962           } else {
1963             Asm->EmitInt8(DW_CFA_def_cfa);
1964             Asm->EOL("DW_CFA_def_cfa");
1965             Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getRegister()));
1966             Asm->EOL("Register");
1967           }
1968           
1969           int Offset = Src.getOffset() / stackGrowth;
1970           
1971           Asm->EmitULEB128Bytes(Offset);
1972           Asm->EOL("Offset");
1973         } else {
1974           assert(0 && "Machine move no supported yet.");
1975         }
1976       } else if (Src.isRegister() &&
1977         Src.getRegister() == MachineLocation::VirtualFP) {
1978         if (Dst.isRegister()) {
1979           Asm->EmitInt8(DW_CFA_def_cfa_register);
1980           Asm->EOL("DW_CFA_def_cfa_register");
1981           Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getRegister()));
1982           Asm->EOL("Register");
1983         } else {
1984           assert(0 && "Machine move no supported yet.");
1985         }
1986       } else {
1987         unsigned Reg = RI->getDwarfRegNum(Src.getRegister());
1988         int Offset = Dst.getOffset() / stackGrowth;
1989         
1990         if (Offset < 0) {
1991           Asm->EmitInt8(DW_CFA_offset_extended_sf);
1992           Asm->EOL("DW_CFA_offset_extended_sf");
1993           Asm->EmitULEB128Bytes(Reg);
1994           Asm->EOL("Reg");
1995           Asm->EmitSLEB128Bytes(Offset);
1996           Asm->EOL("Offset");
1997         } else if (Reg < 64) {
1998           Asm->EmitInt8(DW_CFA_offset + Reg);
1999           Asm->EOL("DW_CFA_offset + Reg");
2000           Asm->EmitULEB128Bytes(Offset);
2001           Asm->EOL("Offset");
2002         } else {
2003           Asm->EmitInt8(DW_CFA_offset_extended);
2004           Asm->EOL("DW_CFA_offset_extended");
2005           Asm->EmitULEB128Bytes(Reg);
2006           Asm->EOL("Reg");
2007           Asm->EmitULEB128Bytes(Offset);
2008           Asm->EOL("Offset");
2009         }
2010       }
2011     }
2012   }
2013
2014   /// EmitDebugInfo - Emit the debug info section.
2015   ///
2016   void EmitDebugInfo() const {
2017     // Start debug info section.
2018     Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2019     
2020     CompileUnit *Unit = GetBaseCompileUnit();
2021     DIE *Die = Unit->getDie();
2022     // Emit the compile units header.
2023     EmitLabel("info_begin", Unit->getID());
2024     // Emit size of content not including length itself
2025     unsigned ContentSize = Die->getSize() +
2026                            sizeof(int16_t) + // DWARF version number
2027                            sizeof(int32_t) + // Offset Into Abbrev. Section
2028                            sizeof(int8_t) +  // Pointer Size (in bytes)
2029                            sizeof(int32_t);  // FIXME - extra pad for gdb bug.
2030                            
2031     Asm->EmitInt32(ContentSize);  Asm->EOL("Length of Compilation Unit Info");
2032     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2033     EmitDifference("abbrev_begin", 0, "section_abbrev", 0, true);
2034     Asm->EOL("Offset Into Abbrev. Section");
2035     Asm->EmitInt8(TAI->getAddressSize()); Asm->EOL("Address Size (in bytes)");
2036   
2037     EmitDIE(Die);
2038     // FIXME - extra padding for gdb bug.
2039     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2040     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2041     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2042     Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2043     EmitLabel("info_end", Unit->getID());
2044     
2045     Asm->EOL("");
2046   }
2047
2048   /// EmitAbbreviations - Emit the abbreviation section.
2049   ///
2050   void EmitAbbreviations() const {
2051     // Check to see if it is worth the effort.
2052     if (!Abbreviations.empty()) {
2053       // Start the debug abbrev section.
2054       Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2055       
2056       EmitLabel("abbrev_begin", 0);
2057       
2058       // For each abbrevation.
2059       for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2060         // Get abbreviation data
2061         const DIEAbbrev *Abbrev = Abbreviations[i];
2062         
2063         // Emit the abbrevations code (base 1 index.)
2064         Asm->EmitULEB128Bytes(Abbrev->getNumber());
2065         Asm->EOL("Abbreviation Code");
2066         
2067         // Emit the abbreviations data.
2068         Abbrev->Emit(*this);
2069     
2070         Asm->EOL("");
2071       }
2072       
2073       EmitLabel("abbrev_end", 0);
2074     
2075       Asm->EOL("");
2076     }
2077   }
2078
2079   /// EmitDebugLines - Emit source line information.
2080   ///
2081   void EmitDebugLines() const {
2082     // Minimum line delta, thus ranging from -10..(255-10).
2083     const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2084     // Maximum line delta, thus ranging from -10..(255-10).
2085     const int MaxLineDelta = 255 + MinLineDelta;
2086
2087     // Start the dwarf line section.
2088     Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2089     
2090     // Construct the section header.
2091     
2092     EmitDifference("line_end", 0, "line_begin", 0, true);
2093     Asm->EOL("Length of Source Line Info");
2094     EmitLabel("line_begin", 0);
2095     
2096     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2097     
2098     EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2099     Asm->EOL("Prolog Length");
2100     EmitLabel("line_prolog_begin", 0);
2101     
2102     Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2103
2104     Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2105
2106     Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2107     
2108     Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2109
2110     Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2111     
2112     // Line number standard opcode encodings argument count
2113     Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2114     Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2115     Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2116     Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2117     Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2118     Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2119     Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2120     Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2121     Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2122
2123     const UniqueVector<std::string> &Directories = MMI->getDirectories();
2124     const UniqueVector<SourceFileInfo>
2125       &SourceFiles = MMI->getSourceFiles();
2126
2127     // Emit directories.
2128     for (unsigned DirectoryID = 1, NDID = Directories.size();
2129                   DirectoryID <= NDID; ++DirectoryID) {
2130       Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2131     }
2132     Asm->EmitInt8(0); Asm->EOL("End of directories");
2133     
2134     // Emit files.
2135     for (unsigned SourceID = 1, NSID = SourceFiles.size();
2136                  SourceID <= NSID; ++SourceID) {
2137       const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2138       Asm->EmitString(SourceFile.getName());
2139       Asm->EOL("Source");
2140       Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2141       Asm->EOL("Directory #");
2142       Asm->EmitULEB128Bytes(0);
2143       Asm->EOL("Mod date");
2144       Asm->EmitULEB128Bytes(0);
2145       Asm->EOL("File size");
2146     }
2147     Asm->EmitInt8(0); Asm->EOL("End of files");
2148     
2149     EmitLabel("line_prolog_end", 0);
2150     
2151     // A sequence for each text section.
2152     for (unsigned j = 0, M = SectionSourceLines.size(); j < M; ++j) {
2153       // Isolate current sections line info.
2154       const std::vector<SourceLineInfo> &LineInfos = SectionSourceLines[j];
2155       
2156       Asm->EOL(std::string("Section ") + SectionMap[j + 1]);
2157
2158       // Dwarf assumes we start with first line of first source file.
2159       unsigned Source = 1;
2160       unsigned Line = 1;
2161       
2162       // Construct rows of the address, source, line, column matrix.
2163       for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2164         const SourceLineInfo &LineInfo = LineInfos[i];
2165         unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2166         if (!LabelID) continue;
2167         
2168         unsigned SourceID = LineInfo.getSourceID();
2169         const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2170         unsigned DirectoryID = SourceFile.getDirectoryID();
2171         Asm->EOL(Directories[DirectoryID]
2172           + SourceFile.getName()
2173           + ":"
2174           + utostr_32(LineInfo.getLine()));
2175
2176         // Define the line address.
2177         Asm->EmitInt8(0); Asm->EOL("Extended Op");
2178         Asm->EmitInt8(TAI->getAddressSize() + 1); Asm->EOL("Op size");
2179         Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2180         EmitReference("loc",  LabelID); Asm->EOL("Location label");
2181         
2182         // If change of source, then switch to the new source.
2183         if (Source != LineInfo.getSourceID()) {
2184           Source = LineInfo.getSourceID();
2185           Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2186           Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2187         }
2188         
2189         // If change of line.
2190         if (Line != LineInfo.getLine()) {
2191           // Determine offset.
2192           int Offset = LineInfo.getLine() - Line;
2193           int Delta = Offset - MinLineDelta;
2194           
2195           // Update line.
2196           Line = LineInfo.getLine();
2197           
2198           // If delta is small enough and in range...
2199           if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2200             // ... then use fast opcode.
2201             Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2202           } else {
2203             // ... otherwise use long hand.
2204             Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2205             Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2206             Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2207           }
2208         } else {
2209           // Copy the previous row (different address or source)
2210           Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2211         }
2212       }
2213
2214       // Define last address of section.
2215       Asm->EmitInt8(0); Asm->EOL("Extended Op");
2216       Asm->EmitInt8(TAI->getAddressSize() + 1); Asm->EOL("Op size");
2217       Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2218       EmitReference("section_end", j + 1); Asm->EOL("Section end label");
2219
2220       // Mark end of matrix.
2221       Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2222       Asm->EmitULEB128Bytes(1); Asm->EOL("");
2223       Asm->EmitInt8(1); Asm->EOL("");
2224     }
2225     
2226     EmitLabel("line_end", 0);
2227     
2228     Asm->EOL("");
2229   }
2230     
2231   /// EmitInitialDebugFrame - Emit common frame info into a debug frame section.
2232   ///
2233   void EmitInitialDebugFrame() {
2234     if (!TAI->getDwarfRequiresFrameSection())
2235       return;
2236
2237     int stackGrowth =
2238         Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2239           TargetFrameInfo::StackGrowsUp ?
2240         TAI->getAddressSize() : -TAI->getAddressSize();
2241
2242     // Start the dwarf frame section.
2243     Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2244
2245     EmitLabel("frame_common", 0);
2246     EmitDifference("frame_common_end", 0,
2247                    "frame_common_begin", 0, true);
2248     Asm->EOL("Length of Common Information Entry");
2249
2250     EmitLabel("frame_common_begin", 0);
2251     Asm->EmitInt32((int)DW_CIE_ID);
2252     Asm->EOL("CIE Identifier Tag");
2253     Asm->EmitInt8(DW_CIE_VERSION);
2254     Asm->EOL("CIE Version");
2255     Asm->EmitString("");
2256     Asm->EOL("CIE Augmentation");
2257     Asm->EmitULEB128Bytes(1);
2258     Asm->EOL("CIE Code Alignment Factor");
2259     Asm->EmitSLEB128Bytes(stackGrowth);
2260     Asm->EOL("CIE Data Alignment Factor");   
2261     Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister()));
2262     Asm->EOL("CIE RA Column");
2263     
2264     std::vector<MachineMove> Moves;
2265     RI->getInitialFrameState(Moves);
2266     EmitFrameMoves(NULL, 0, Moves);
2267
2268     Asm->EmitAlignment(2);
2269     EmitLabel("frame_common_end", 0);
2270     
2271     Asm->EOL("");
2272   }
2273
2274   /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2275   /// section.
2276   void EmitFunctionDebugFrame() {
2277     if (!TAI->getDwarfRequiresFrameSection())
2278       return;
2279        
2280     // Start the dwarf frame section.
2281     Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2282     
2283     EmitDifference("frame_end", SubprogramCount,
2284                    "frame_begin", SubprogramCount, true);
2285     Asm->EOL("Length of Frame Information Entry");
2286     
2287     EmitLabel("frame_begin", SubprogramCount);
2288     
2289     EmitDifference("frame_common", 0, "section_frame", 0, true);
2290     Asm->EOL("FDE CIE offset");
2291
2292     EmitReference("func_begin", SubprogramCount);
2293     Asm->EOL("FDE initial location");
2294     EmitDifference("func_end", SubprogramCount,
2295                    "func_begin", SubprogramCount);
2296     Asm->EOL("FDE address range");
2297     
2298     std::vector<MachineMove> &Moves = MMI->getFrameMoves();
2299     
2300     EmitFrameMoves("func_begin", SubprogramCount, Moves);
2301     
2302     Asm->EmitAlignment(2);
2303     EmitLabel("frame_end", SubprogramCount);
2304
2305     Asm->EOL("");
2306   }
2307
2308   /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2309   ///
2310   void EmitDebugPubNames() {
2311     // Start the dwarf pubnames section.
2312     Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2313       
2314     CompileUnit *Unit = GetBaseCompileUnit(); 
2315  
2316     EmitDifference("pubnames_end", Unit->getID(),
2317                    "pubnames_begin", Unit->getID(), true);
2318     Asm->EOL("Length of Public Names Info");
2319     
2320     EmitLabel("pubnames_begin", Unit->getID());
2321     
2322     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2323     
2324     EmitDifference("info_begin", Unit->getID(), "section_info", 0, true);
2325     Asm->EOL("Offset of Compilation Unit Info");
2326
2327     EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
2328     Asm->EOL("Compilation Unit Length");
2329     
2330     std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2331     
2332     for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2333                                                 GE = Globals.end();
2334          GI != GE; ++GI) {
2335       const std::string &Name = GI->first;
2336       DIE * Entity = GI->second;
2337       
2338       Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2339       Asm->EmitString(Name); Asm->EOL("External Name");
2340     }
2341   
2342     Asm->EmitInt32(0); Asm->EOL("End Mark");
2343     EmitLabel("pubnames_end", Unit->getID());
2344   
2345     Asm->EOL("");
2346   }
2347
2348   /// EmitDebugStr - Emit visible names into a debug str section.
2349   ///
2350   void EmitDebugStr() {
2351     // Check to see if it is worth the effort.
2352     if (!StringPool.empty()) {
2353       // Start the dwarf str section.
2354       Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2355       
2356       // For each of strings in the string pool.
2357       for (unsigned StringID = 1, N = StringPool.size();
2358            StringID <= N; ++StringID) {
2359         // Emit a label for reference from debug information entries.
2360         EmitLabel("string", StringID);
2361         // Emit the string itself.
2362         const std::string &String = StringPool[StringID];
2363         Asm->EmitString(String); Asm->EOL("");
2364       }
2365     
2366       Asm->EOL("");
2367     }
2368   }
2369
2370   /// EmitDebugLoc - Emit visible names into a debug loc section.
2371   ///
2372   void EmitDebugLoc() {
2373     // Start the dwarf loc section.
2374     Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2375     
2376     Asm->EOL("");
2377   }
2378
2379   /// EmitDebugARanges - Emit visible names into a debug aranges section.
2380   ///
2381   void EmitDebugARanges() {
2382     // Start the dwarf aranges section.
2383     Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2384     
2385     // FIXME - Mock up
2386   #if 0
2387     CompileUnit *Unit = GetBaseCompileUnit(); 
2388       
2389     // Don't include size of length
2390     Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2391     
2392     Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2393     
2394     EmitReference("info_begin", Unit->getID());
2395     Asm->EOL("Offset of Compilation Unit Info");
2396
2397     Asm->EmitInt8(TAI->getAddressSize()); Asm->EOL("Size of Address");
2398
2399     Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2400
2401     Asm->EmitInt16(0);  Asm->EOL("Pad (1)");
2402     Asm->EmitInt16(0);  Asm->EOL("Pad (2)");
2403
2404     // Range 1
2405     EmitReference("text_begin", 0); Asm->EOL("Address");
2406     EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2407
2408     Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2409     Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2410     
2411     Asm->EOL("");
2412   #endif
2413   }
2414
2415   /// EmitDebugRanges - Emit visible names into a debug ranges section.
2416   ///
2417   void EmitDebugRanges() {
2418     // Start the dwarf ranges section.
2419     Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2420     
2421     Asm->EOL("");
2422   }
2423
2424   /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2425   ///
2426   void EmitDebugMacInfo() {
2427     // Start the dwarf macinfo section.
2428     Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2429     
2430     Asm->EOL("");
2431   }
2432
2433   /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
2434   /// header file.
2435   void ConstructCompileUnitDIEs() {
2436     const UniqueVector<CompileUnitDesc *> CUW = MMI->getCompileUnits();
2437     
2438     for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
2439       unsigned ID = MMI->RecordSource(CUW[i]);
2440       CompileUnit *Unit = NewCompileUnit(CUW[i], ID);
2441       CompileUnits.push_back(Unit);
2442     }
2443   }
2444
2445   /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
2446   /// global variables.
2447   void ConstructGlobalDIEs() {
2448     std::vector<GlobalVariableDesc *> GlobalVariables =
2449         MMI->getAnchoredDescriptors<GlobalVariableDesc>(*M);
2450     
2451     for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
2452       GlobalVariableDesc *GVD = GlobalVariables[i];
2453       NewGlobalVariable(GVD);
2454     }
2455   }
2456
2457   /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
2458   /// subprograms.
2459   void ConstructSubprogramDIEs() {
2460     std::vector<SubprogramDesc *> Subprograms =
2461         MMI->getAnchoredDescriptors<SubprogramDesc>(*M);
2462     
2463     for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2464       SubprogramDesc *SPD = Subprograms[i];
2465       NewSubprogram(SPD);
2466     }
2467   }
2468
2469   /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
2470   ///
2471   bool ShouldEmitDwarf() const { return shouldEmit; }
2472
2473 public:
2474   //===--------------------------------------------------------------------===//
2475   // Main entry points.
2476   //
2477   Dwarf(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2478   : O(OS)
2479   , Asm(A)
2480   , TAI(T)
2481   , TD(Asm->TM.getTargetData())
2482   , RI(Asm->TM.getRegisterInfo())
2483   , M(NULL)
2484   , MF(NULL)
2485   , MMI(NULL)
2486   , didInitial(false)
2487   , shouldEmit(false)
2488   , SubprogramCount(0)
2489   , CompileUnits()
2490   , AbbreviationsSet(InitAbbreviationsSetSize)
2491   , Abbreviations()
2492   , ValuesSet(InitValuesSetSize)
2493   , Values()
2494   , StringPool()
2495   , DescToUnitMap()
2496   , SectionMap()
2497   , SectionSourceLines()
2498   {
2499   }
2500   virtual ~Dwarf() {
2501     for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
2502       delete CompileUnits[i];
2503     for (unsigned j = 0, M = Values.size(); j < M; ++j)
2504       delete Values[j];
2505   }
2506
2507   // Accessors.
2508   //
2509   const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
2510   
2511   /// SetModuleInfo - Set machine module information when it's known that pass
2512   /// manager has created it.  Set by the target AsmPrinter.
2513   void SetModuleInfo(MachineModuleInfo *mmi) {
2514     // Make sure initial declarations are made.
2515     if (!MMI && mmi->hasDebugInfo()) {
2516       MMI = mmi;
2517       shouldEmit = true;
2518       
2519       // Emit initial sections
2520       EmitInitial();
2521     
2522       // Create all the compile unit DIEs.
2523       ConstructCompileUnitDIEs();
2524       
2525       // Create DIEs for each of the externally visible global variables.
2526       ConstructGlobalDIEs();
2527
2528       // Create DIEs for each of the externally visible subprograms.
2529       ConstructSubprogramDIEs();
2530       
2531       // Prime section data.
2532       SectionMap.insert(TAI->getTextSection());
2533     }
2534   }
2535
2536   /// BeginModule - Emit all Dwarf sections that should come prior to the
2537   /// content.
2538   void BeginModule(Module *M) {
2539     this->M = M;
2540     
2541     if (!ShouldEmitDwarf()) return;
2542     Asm->EOL("Dwarf Begin Module");
2543   }
2544
2545   /// EndModule - Emit all Dwarf sections that should come after the content.
2546   ///
2547   void EndModule() {
2548     if (!ShouldEmitDwarf()) return;
2549     Asm->EOL("Dwarf End Module");
2550     
2551     // Standard sections final addresses.
2552     Asm->SwitchToTextSection(TAI->getTextSection());
2553     EmitLabel("text_end", 0);
2554     Asm->SwitchToDataSection(TAI->getDataSection());
2555     EmitLabel("data_end", 0);
2556     
2557     // End text sections.
2558     for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2559       Asm->SwitchToTextSection(SectionMap[i].c_str());
2560       EmitLabel("section_end", i);
2561     }
2562     
2563     // Compute DIE offsets and sizes.
2564     SizeAndOffsets();
2565     
2566     // Emit all the DIEs into a debug info section
2567     EmitDebugInfo();
2568     
2569     // Corresponding abbreviations into a abbrev section.
2570     EmitAbbreviations();
2571     
2572     // Emit source line correspondence into a debug line section.
2573     EmitDebugLines();
2574     
2575     // Emit info into a debug pubnames section.
2576     EmitDebugPubNames();
2577     
2578     // Emit info into a debug str section.
2579     EmitDebugStr();
2580     
2581     // Emit info into a debug loc section.
2582     EmitDebugLoc();
2583     
2584     // Emit info into a debug aranges section.
2585     EmitDebugARanges();
2586     
2587     // Emit info into a debug ranges section.
2588     EmitDebugRanges();
2589     
2590     // Emit info into a debug macinfo section.
2591     EmitDebugMacInfo();
2592   }
2593
2594   /// BeginFunction - Gather pre-function debug information.  Assumes being 
2595   /// emitted immediately after the function entry point.
2596   void BeginFunction(MachineFunction *MF) {
2597     this->MF = MF;
2598     
2599     if (!ShouldEmitDwarf()) return;
2600     Asm->EOL("Dwarf Begin Function");
2601
2602     // Begin accumulating function debug information.
2603     MMI->BeginFunction(MF);
2604     
2605     // Assumes in correct section after the entry point.
2606     EmitLabel("func_begin", ++SubprogramCount);
2607   }
2608
2609   /// EndFunction - Gather and emit post-function debug information.
2610   ///
2611   void EndFunction() {
2612     if (!ShouldEmitDwarf()) return;
2613     Asm->EOL("Dwarf End Function");
2614     
2615     // Define end label for subprogram.
2616     EmitLabel("func_end", SubprogramCount);
2617       
2618     // Get function line info.
2619     const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
2620
2621     if (!LineInfos.empty()) {
2622       // Get section line info.
2623       unsigned ID = SectionMap.insert(Asm->CurrentSection);
2624       if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2625       std::vector<SourceLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2626       // Append the function info to section info.
2627       SectionLineInfos.insert(SectionLineInfos.end(),
2628                               LineInfos.begin(), LineInfos.end());
2629     }
2630     
2631     // Construct scopes for subprogram.
2632     ConstructRootScope(MMI->getRootScope());
2633     
2634     // Emit function frame information.
2635     EmitFunctionDebugFrame();
2636     
2637     // Reset the line numbers for the next function.
2638     MMI->ClearLineInfo();
2639
2640     // Clear function debug information.
2641     MMI->EndFunction();
2642   }
2643 };
2644
2645 } // End of namespace llvm
2646
2647 //===----------------------------------------------------------------------===//
2648
2649 /// Emit - Print the abbreviation using the specified Dwarf writer.
2650 ///
2651 void DIEAbbrev::Emit(const Dwarf &DW) const {
2652   // Emit its Dwarf tag type.
2653   DW.getAsm()->EmitULEB128Bytes(Tag);
2654   DW.getAsm()->EOL(TagString(Tag));
2655   
2656   // Emit whether it has children DIEs.
2657   DW.getAsm()->EmitULEB128Bytes(ChildrenFlag);
2658   DW.getAsm()->EOL(ChildrenString(ChildrenFlag));
2659   
2660   // For each attribute description.
2661   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
2662     const DIEAbbrevData &AttrData = Data[i];
2663     
2664     // Emit attribute type.
2665     DW.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
2666     DW.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
2667     
2668     // Emit form type.
2669     DW.getAsm()->EmitULEB128Bytes(AttrData.getForm());
2670     DW.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
2671   }
2672
2673   // Mark end of abbreviation.
2674   DW.getAsm()->EmitULEB128Bytes(0); DW.getAsm()->EOL("EOM(1)");
2675   DW.getAsm()->EmitULEB128Bytes(0); DW.getAsm()->EOL("EOM(2)");
2676 }
2677
2678 #ifndef NDEBUG
2679 void DIEAbbrev::print(std::ostream &O) {
2680   O << "Abbreviation @"
2681     << std::hex << (intptr_t)this << std::dec
2682     << "  "
2683     << TagString(Tag)
2684     << " "
2685     << ChildrenString(ChildrenFlag)
2686     << "\n";
2687   
2688   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
2689     O << "  "
2690       << AttributeString(Data[i].getAttribute())
2691       << "  "
2692       << FormEncodingString(Data[i].getForm())
2693       << "\n";
2694   }
2695 }
2696 void DIEAbbrev::dump() { print(cerr); }
2697 #endif
2698
2699 //===----------------------------------------------------------------------===//
2700
2701 #ifndef NDEBUG
2702 void DIEValue::dump() {
2703   print(cerr);
2704 }
2705 #endif
2706
2707 //===----------------------------------------------------------------------===//
2708
2709 /// EmitValue - Emit integer of appropriate size.
2710 ///
2711 void DIEInteger::EmitValue(const Dwarf &DW, unsigned Form) const {
2712   switch (Form) {
2713   case DW_FORM_flag:  // Fall thru
2714   case DW_FORM_ref1:  // Fall thru
2715   case DW_FORM_data1: DW.getAsm()->EmitInt8(Integer);         break;
2716   case DW_FORM_ref2:  // Fall thru
2717   case DW_FORM_data2: DW.getAsm()->EmitInt16(Integer);        break;
2718   case DW_FORM_ref4:  // Fall thru
2719   case DW_FORM_data4: DW.getAsm()->EmitInt32(Integer);        break;
2720   case DW_FORM_ref8:  // Fall thru
2721   case DW_FORM_data8: DW.getAsm()->EmitInt64(Integer);        break;
2722   case DW_FORM_udata: DW.getAsm()->EmitULEB128Bytes(Integer); break;
2723   case DW_FORM_sdata: DW.getAsm()->EmitSLEB128Bytes(Integer); break;
2724   default: assert(0 && "DIE Value form not supported yet");   break;
2725   }
2726 }
2727
2728 /// SizeOf - Determine size of integer value in bytes.
2729 ///
2730 unsigned DIEInteger::SizeOf(const Dwarf &DW, unsigned Form) const {
2731   switch (Form) {
2732   case DW_FORM_flag:  // Fall thru
2733   case DW_FORM_ref1:  // Fall thru
2734   case DW_FORM_data1: return sizeof(int8_t);
2735   case DW_FORM_ref2:  // Fall thru
2736   case DW_FORM_data2: return sizeof(int16_t);
2737   case DW_FORM_ref4:  // Fall thru
2738   case DW_FORM_data4: return sizeof(int32_t);
2739   case DW_FORM_ref8:  // Fall thru
2740   case DW_FORM_data8: return sizeof(int64_t);
2741   case DW_FORM_udata: return DW.getAsm()->SizeULEB128(Integer);
2742   case DW_FORM_sdata: return DW.getAsm()->SizeSLEB128(Integer);
2743   default: assert(0 && "DIE Value form not supported yet"); break;
2744   }
2745   return 0;
2746 }
2747
2748 //===----------------------------------------------------------------------===//
2749
2750 /// EmitValue - Emit string value.
2751 ///
2752 void DIEString::EmitValue(const Dwarf &DW, unsigned Form) const {
2753   DW.getAsm()->EmitString(String);
2754 }
2755
2756 //===----------------------------------------------------------------------===//
2757
2758 /// EmitValue - Emit label value.
2759 ///
2760 void DIEDwarfLabel::EmitValue(const Dwarf &DW, unsigned Form) const {
2761   DW.EmitReference(Label);
2762 }
2763
2764 /// SizeOf - Determine size of label value in bytes.
2765 ///
2766 unsigned DIEDwarfLabel::SizeOf(const Dwarf &DW, unsigned Form) const {
2767   return DW.getTargetAsmInfo()->getAddressSize();
2768 }
2769
2770 //===----------------------------------------------------------------------===//
2771
2772 /// EmitValue - Emit label value.
2773 ///
2774 void DIEObjectLabel::EmitValue(const Dwarf &DW, unsigned Form) const {
2775   DW.EmitReference(Label);
2776 }
2777
2778 /// SizeOf - Determine size of label value in bytes.
2779 ///
2780 unsigned DIEObjectLabel::SizeOf(const Dwarf &DW, unsigned Form) const {
2781   return DW.getTargetAsmInfo()->getAddressSize();
2782 }
2783     
2784 //===----------------------------------------------------------------------===//
2785
2786 /// EmitValue - Emit delta value.
2787 ///
2788 void DIEDelta::EmitValue(const Dwarf &DW, unsigned Form) const {
2789   bool IsSmall = Form == DW_FORM_data4;
2790   DW.EmitDifference(LabelHi, LabelLo, IsSmall);
2791 }
2792
2793 /// SizeOf - Determine size of delta value in bytes.
2794 ///
2795 unsigned DIEDelta::SizeOf(const Dwarf &DW, unsigned Form) const {
2796   if (Form == DW_FORM_data4) return 4;
2797   return DW.getTargetAsmInfo()->getAddressSize();
2798 }
2799
2800 //===----------------------------------------------------------------------===//
2801
2802 /// EmitValue - Emit debug information entry offset.
2803 ///
2804 void DIEntry::EmitValue(const Dwarf &DW, unsigned Form) const {
2805   DW.getAsm()->EmitInt32(Entry->getOffset());
2806 }
2807     
2808 //===----------------------------------------------------------------------===//
2809
2810 /// ComputeSize - calculate the size of the block.
2811 ///
2812 unsigned DIEBlock::ComputeSize(Dwarf &DW) {
2813   if (!Size) {
2814     const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
2815     
2816     for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2817       Size += Values[i]->SizeOf(DW, AbbrevData[i].getForm());
2818     }
2819   }
2820   return Size;
2821 }
2822
2823 /// EmitValue - Emit block data.
2824 ///
2825 void DIEBlock::EmitValue(const Dwarf &DW, unsigned Form) const {
2826   switch (Form) {
2827   case DW_FORM_block1: DW.getAsm()->EmitInt8(Size);         break;
2828   case DW_FORM_block2: DW.getAsm()->EmitInt16(Size);        break;
2829   case DW_FORM_block4: DW.getAsm()->EmitInt32(Size);        break;
2830   case DW_FORM_block:  DW.getAsm()->EmitULEB128Bytes(Size); break;
2831   default: assert(0 && "Improper form for block");          break;
2832   }
2833   
2834   const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
2835
2836   for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2837     DW.getAsm()->EOL("");
2838     Values[i]->EmitValue(DW, AbbrevData[i].getForm());
2839   }
2840 }
2841
2842 /// SizeOf - Determine size of block data in bytes.
2843 ///
2844 unsigned DIEBlock::SizeOf(const Dwarf &DW, unsigned Form) const {
2845   switch (Form) {
2846   case DW_FORM_block1: return Size + sizeof(int8_t);
2847   case DW_FORM_block2: return Size + sizeof(int16_t);
2848   case DW_FORM_block4: return Size + sizeof(int32_t);
2849   case DW_FORM_block: return Size + DW.getAsm()->SizeULEB128(Size);
2850   default: assert(0 && "Improper form for block"); break;
2851   }
2852   return 0;
2853 }
2854
2855 //===----------------------------------------------------------------------===//
2856 /// DIE Implementation
2857
2858 DIE::~DIE() {
2859   for (unsigned i = 0, N = Children.size(); i < N; ++i)
2860     delete Children[i];
2861 }
2862   
2863 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
2864 ///
2865 void DIE::AddSiblingOffset() {
2866   DIEInteger *DI = new DIEInteger(0);
2867   Values.insert(Values.begin(), DI);
2868   Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
2869 }
2870
2871 /// Profile - Used to gather unique data for the value folding set.
2872 ///
2873 void DIE::Profile(FoldingSetNodeID &ID) {
2874   Abbrev.Profile(ID);
2875   
2876   for (unsigned i = 0, N = Children.size(); i < N; ++i)
2877     ID.AddPointer(Children[i]);
2878
2879   for (unsigned j = 0, M = Values.size(); j < M; ++j)
2880     ID.AddPointer(Values[j]);
2881 }
2882
2883 #ifndef NDEBUG
2884 void DIE::print(std::ostream &O, unsigned IncIndent) {
2885   static unsigned IndentCount = 0;
2886   IndentCount += IncIndent;
2887   const std::string Indent(IndentCount, ' ');
2888   bool isBlock = Abbrev.getTag() == 0;
2889   
2890   if (!isBlock) {
2891     O << Indent
2892       << "Die: "
2893       << "0x" << std::hex << (intptr_t)this << std::dec
2894       << ", Offset: " << Offset
2895       << ", Size: " << Size
2896       << "\n"; 
2897     
2898     O << Indent
2899       << TagString(Abbrev.getTag())
2900       << " "
2901       << ChildrenString(Abbrev.getChildrenFlag());
2902   } else {
2903     O << "Size: " << Size;
2904   }
2905   O << "\n";
2906
2907   const std::vector<DIEAbbrevData> &Data = Abbrev.getData();
2908   
2909   IndentCount += 2;
2910   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
2911     O << Indent;
2912     if (!isBlock) {
2913       O << AttributeString(Data[i].getAttribute());
2914     } else {
2915       O << "Blk[" << i << "]";
2916     }
2917     O <<  "  "
2918       << FormEncodingString(Data[i].getForm())
2919       << " ";
2920     Values[i]->print(O);
2921     O << "\n";
2922   }
2923   IndentCount -= 2;
2924
2925   for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2926     Children[j]->print(O, 4);
2927   }
2928   
2929   if (!isBlock) O << "\n";
2930   IndentCount -= IncIndent;
2931 }
2932
2933 void DIE::dump() {
2934   print(cerr);
2935 }
2936 #endif
2937
2938 //===----------------------------------------------------------------------===//
2939 /// DwarfWriter Implementation
2940 ///
2941
2942 DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A,
2943                          const TargetAsmInfo *T) {
2944   DW = new Dwarf(OS, A, T);
2945 }
2946
2947 DwarfWriter::~DwarfWriter() {
2948   delete DW;
2949 }
2950
2951 /// SetModuleInfo - Set machine module info when it's known that pass manager
2952 /// has created it.  Set by the target AsmPrinter.
2953 void DwarfWriter::SetModuleInfo(MachineModuleInfo *MMI) {
2954   DW->SetModuleInfo(MMI);
2955 }
2956
2957 /// BeginModule - Emit all Dwarf sections that should come prior to the
2958 /// content.
2959 void DwarfWriter::BeginModule(Module *M) {
2960   DW->BeginModule(M);
2961 }
2962
2963 /// EndModule - Emit all Dwarf sections that should come after the content.
2964 ///
2965 void DwarfWriter::EndModule() {
2966   DW->EndModule();
2967 }
2968
2969 /// BeginFunction - Gather pre-function debug information.  Assumes being 
2970 /// emitted immediately after the function entry point.
2971 void DwarfWriter::BeginFunction(MachineFunction *MF) {
2972   DW->BeginFunction(MF);
2973 }
2974
2975 /// EndFunction - Gather and emit post-function debug information.
2976 ///
2977 void DwarfWriter::EndFunction() {
2978   DW->EndFunction();
2979 }