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