9e4a61d52f65a97a7fe9cca96a8a75c61ef8f00f
[oota-llvm.git] / lib / CodeGen / AsmPrinter / DwarfCompileUnit.cpp
1 //===-- llvm/CodeGen/DwarfCompileUnit.cpp - Dwarf Compile Unit ------------===//
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 compile unit.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "dwarfdebug"
15
16 #include "DwarfCompileUnit.h"
17 #include "DwarfDebug.h"
18 #include "llvm/Constants.h"
19 #include "llvm/Analysis/DIBuilder.h"
20 #include "llvm/Target/TargetData.h"
21 #include "llvm/Target/TargetFrameLowering.h"
22 #include "llvm/Target/TargetMachine.h"
23 #include "llvm/Target/TargetRegisterInfo.h"
24 #include "llvm/ADT/APFloat.h"
25 #include "llvm/Support/ErrorHandling.h"
26
27 using namespace llvm;
28
29 /// CompileUnit - Compile unit constructor.
30 CompileUnit::CompileUnit(unsigned I, DIE *D, AsmPrinter *A, DwarfDebug *DW)
31   : ID(I), CUDie(D), Asm(A), DD(DW), IndexTyDie(0) {
32   DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
33 }
34
35 /// ~CompileUnit - Destructor for compile unit.
36 CompileUnit::~CompileUnit() {
37   for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
38     DIEBlocks[j]->~DIEBlock();
39 }
40
41 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
42 /// information entry.
43 DIEEntry *CompileUnit::createDIEEntry(DIE *Entry) {
44   DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
45   return Value;
46 }
47
48 /// addUInt - Add an unsigned integer attribute data and value.
49 ///
50 void CompileUnit::addUInt(DIE *Die, unsigned Attribute,
51                           unsigned Form, uint64_t Integer) {
52   if (!Form) Form = DIEInteger::BestForm(false, Integer);
53   DIEValue *Value = Integer == 1 ?
54     DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
55   Die->addValue(Attribute, Form, Value);
56 }
57
58 /// addSInt - Add an signed integer attribute data and value.
59 ///
60 void CompileUnit::addSInt(DIE *Die, unsigned Attribute,
61                           unsigned Form, int64_t Integer) {
62   if (!Form) Form = DIEInteger::BestForm(true, Integer);
63   DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
64   Die->addValue(Attribute, Form, Value);
65 }
66
67 /// addString - Add a string attribute data and value. DIEString only
68 /// keeps string reference.
69 void CompileUnit::addString(DIE *Die, unsigned Attribute, unsigned Form,
70                             StringRef String) {
71   DIEValue *Value = new (DIEValueAllocator) DIEString(String);
72   Die->addValue(Attribute, Form, Value);
73 }
74
75 /// addLabel - Add a Dwarf label attribute data and value.
76 ///
77 void CompileUnit::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
78                            const MCSymbol *Label) {
79   DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
80   Die->addValue(Attribute, Form, Value);
81 }
82
83 /// addDelta - Add a label delta attribute data and value.
84 ///
85 void CompileUnit::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
86                            const MCSymbol *Hi, const MCSymbol *Lo) {
87   DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
88   Die->addValue(Attribute, Form, Value);
89 }
90
91 /// addDIEEntry - Add a DIE attribute data and value.
92 ///
93 void CompileUnit::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
94                               DIE *Entry) {
95   Die->addValue(Attribute, Form, createDIEEntry(Entry));
96 }
97
98
99 /// addBlock - Add block data.
100 ///
101 void CompileUnit::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
102                            DIEBlock *Block) {
103   Block->ComputeSize(Asm);
104   DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
105   Die->addValue(Attribute, Block->BestForm(), Block);
106 }
107
108 /// addSourceLine - Add location information to specified debug information
109 /// entry.
110 void CompileUnit::addSourceLine(DIE *Die, DIVariable V) {
111   // Verify variable.
112   if (!V.Verify())
113     return;
114   
115   unsigned Line = V.getLineNumber();
116   if (Line == 0)
117     return;
118   unsigned FileID = DD->GetOrCreateSourceID(V.getContext().getFilename(),
119                                             V.getContext().getDirectory());
120   assert(FileID && "Invalid file id");
121   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
122   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
123 }
124
125 /// addSourceLine - Add location information to specified debug information
126 /// entry.
127 void CompileUnit::addSourceLine(DIE *Die, DIGlobalVariable G) {
128   // Verify global variable.
129   if (!G.Verify())
130     return;
131
132   unsigned Line = G.getLineNumber();
133   if (Line == 0)
134     return;
135   unsigned FileID = DD->GetOrCreateSourceID(G.getContext().getFilename(),
136                                             G.getContext().getDirectory());
137   assert(FileID && "Invalid file id");
138   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
139   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
140 }
141
142 /// addSourceLine - Add location information to specified debug information
143 /// entry.
144 void CompileUnit::addSourceLine(DIE *Die, DISubprogram SP) {
145   // Verify subprogram.
146   if (!SP.Verify())
147     return;
148   // If the line number is 0, don't add it.
149   if (SP.getLineNumber() == 0)
150     return;
151
152   unsigned Line = SP.getLineNumber();
153   if (!SP.getContext().Verify())
154     return;
155   unsigned FileID = DD->GetOrCreateSourceID(SP.getFilename(), SP.getDirectory());
156   assert(FileID && "Invalid file id");
157   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
158   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
159 }
160
161 /// addSourceLine - Add location information to specified debug information
162 /// entry.
163 void CompileUnit::addSourceLine(DIE *Die, DIType Ty) {
164   // Verify type.
165   if (!Ty.Verify())
166     return;
167
168   unsigned Line = Ty.getLineNumber();
169   if (Line == 0 || !Ty.getContext().Verify())
170     return;
171   unsigned FileID = DD->GetOrCreateSourceID(Ty.getFilename(), Ty.getDirectory());
172   assert(FileID && "Invalid file id");
173   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
174   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
175 }
176
177 /// addSourceLine - Add location information to specified debug information
178 /// entry.
179 void CompileUnit::addSourceLine(DIE *Die, DINameSpace NS) {
180   // Verify namespace.
181   if (!NS.Verify())
182     return;
183
184   unsigned Line = NS.getLineNumber();
185   if (Line == 0)
186     return;
187   StringRef FN = NS.getFilename();
188
189   unsigned FileID = DD->GetOrCreateSourceID(FN, NS.getDirectory());
190   assert(FileID && "Invalid file id");
191   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
192   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
193 }
194
195 /// addVariableAddress - Add DW_AT_location attribute for a 
196 /// DbgVariable based on provided MachineLocation.
197 void CompileUnit::addVariableAddress(DbgVariable *&DV, DIE *Die, 
198                                      MachineLocation Location) {
199   if (DV->variableHasComplexAddress())
200     addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
201   else if (DV->isBlockByrefVariable())
202     addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
203   else
204     addAddress(Die, dwarf::DW_AT_location, Location);
205 }
206
207 /// addRegisterOp - Add register operand.
208 void CompileUnit::addRegisterOp(DIE *TheDie, unsigned Reg) {
209   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
210   unsigned DWReg = RI->getDwarfRegNum(Reg, false);
211   if (DWReg < 32)
212     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + DWReg);
213   else {
214     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
215     addUInt(TheDie, 0, dwarf::DW_FORM_udata, DWReg);
216   }
217 }
218
219 /// addRegisterOffset - Add register offset.
220 void CompileUnit::addRegisterOffset(DIE *TheDie, unsigned Reg,
221                                     int64_t Offset) {
222   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
223   unsigned DWReg = RI->getDwarfRegNum(Reg, false);
224   const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
225   if (Reg == TRI->getFrameRegister(*Asm->MF))
226     // If variable offset is based in frame register then use fbreg.
227     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
228   else if (DWReg < 32)
229     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + DWReg);
230   else {
231     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
232     addUInt(TheDie, 0, dwarf::DW_FORM_udata, DWReg);
233   }
234   addSInt(TheDie, 0, dwarf::DW_FORM_sdata, Offset);
235 }
236
237 /// addAddress - Add an address attribute to a die based on the location
238 /// provided.
239 void CompileUnit::addAddress(DIE *Die, unsigned Attribute,
240                              const MachineLocation &Location) {
241   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
242
243   if (Location.isReg())
244     addRegisterOp(Block, Location.getReg());
245   else
246     addRegisterOffset(Block, Location.getReg(), Location.getOffset());
247
248   // Now attach the location information to the DIE.
249   addBlock(Die, Attribute, 0, Block);
250 }
251
252 /// addComplexAddress - Start with the address based on the location provided,
253 /// and generate the DWARF information necessary to find the actual variable
254 /// given the extra address information encoded in the DIVariable, starting from
255 /// the starting location.  Add the DWARF information to the die.
256 ///
257 void CompileUnit::addComplexAddress(DbgVariable *&DV, DIE *Die,
258                                     unsigned Attribute,
259                                     const MachineLocation &Location) {
260   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
261   unsigned N = DV->getNumAddrElements();
262   unsigned i = 0;
263   if (Location.isReg()) {
264     if (N >= 2 && DV->getAddrElement(0) == DIBuilder::OpPlus) {
265       // If first address element is OpPlus then emit
266       // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
267       addRegisterOffset(Block, Location.getReg(), DV->getAddrElement(1));
268       i = 2;
269     } else
270       addRegisterOp(Block, Location.getReg());
271   }
272   else
273     addRegisterOffset(Block, Location.getReg(), Location.getOffset());
274
275   for (;i < N; ++i) {
276     uint64_t Element = DV->getAddrElement(i);
277     if (Element == DIBuilder::OpPlus) {
278       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
279       addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
280     } else if (Element == DIBuilder::OpDeref) {
281       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
282     } else llvm_unreachable("unknown DIBuilder Opcode");
283   }
284
285   // Now attach the location information to the DIE.
286   addBlock(Die, Attribute, 0, Block);
287 }
288
289 /* Byref variables, in Blocks, are declared by the programmer as "SomeType
290    VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
291    gives the variable VarName either the struct, or a pointer to the struct, as
292    its type.  This is necessary for various behind-the-scenes things the
293    compiler needs to do with by-reference variables in Blocks.
294
295    However, as far as the original *programmer* is concerned, the variable
296    should still have type 'SomeType', as originally declared.
297
298    The function getBlockByrefType dives into the __Block_byref_x_VarName
299    struct to find the original type of the variable, which is then assigned to
300    the variable's Debug Information Entry as its real type.  So far, so good.
301    However now the debugger will expect the variable VarName to have the type
302    SomeType.  So we need the location attribute for the variable to be an
303    expression that explains to the debugger how to navigate through the
304    pointers and struct to find the actual variable of type SomeType.
305
306    The following function does just that.  We start by getting
307    the "normal" location for the variable. This will be the location
308    of either the struct __Block_byref_x_VarName or the pointer to the
309    struct __Block_byref_x_VarName.
310
311    The struct will look something like:
312
313    struct __Block_byref_x_VarName {
314      ... <various fields>
315      struct __Block_byref_x_VarName *forwarding;
316      ... <various other fields>
317      SomeType VarName;
318      ... <maybe more fields>
319    };
320
321    If we are given the struct directly (as our starting point) we
322    need to tell the debugger to:
323
324    1).  Add the offset of the forwarding field.
325
326    2).  Follow that pointer to get the real __Block_byref_x_VarName
327    struct to use (the real one may have been copied onto the heap).
328
329    3).  Add the offset for the field VarName, to find the actual variable.
330
331    If we started with a pointer to the struct, then we need to
332    dereference that pointer first, before the other steps.
333    Translating this into DWARF ops, we will need to append the following
334    to the current location description for the variable:
335
336    DW_OP_deref                    -- optional, if we start with a pointer
337    DW_OP_plus_uconst <forward_fld_offset>
338    DW_OP_deref
339    DW_OP_plus_uconst <varName_fld_offset>
340
341    That is what this function does.  */
342
343 /// addBlockByrefAddress - Start with the address based on the location
344 /// provided, and generate the DWARF information necessary to find the
345 /// actual Block variable (navigating the Block struct) based on the
346 /// starting location.  Add the DWARF information to the die.  For
347 /// more information, read large comment just above here.
348 ///
349 void CompileUnit::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
350                                        unsigned Attribute,
351                                        const MachineLocation &Location) {
352   DIType Ty = DV->getType();
353   DIType TmpTy = Ty;
354   unsigned Tag = Ty.getTag();
355   bool isPointer = false;
356
357   StringRef varName = DV->getName();
358
359   if (Tag == dwarf::DW_TAG_pointer_type) {
360     DIDerivedType DTy = DIDerivedType(Ty);
361     TmpTy = DTy.getTypeDerivedFrom();
362     isPointer = true;
363   }
364
365   DICompositeType blockStruct = DICompositeType(TmpTy);
366
367   // Find the __forwarding field and the variable field in the __Block_byref
368   // struct.
369   DIArray Fields = blockStruct.getTypeArray();
370   DIDescriptor varField = DIDescriptor();
371   DIDescriptor forwardingField = DIDescriptor();
372
373   for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
374     DIDescriptor Element = Fields.getElement(i);
375     DIDerivedType DT = DIDerivedType(Element);
376     StringRef fieldName = DT.getName();
377     if (fieldName == "__forwarding")
378       forwardingField = Element;
379     else if (fieldName == varName)
380       varField = Element;
381   }
382
383   // Get the offsets for the forwarding field and the variable field.
384   unsigned forwardingFieldOffset =
385     DIDerivedType(forwardingField).getOffsetInBits() >> 3;
386   unsigned varFieldOffset =
387     DIDerivedType(varField).getOffsetInBits() >> 3;
388
389   // Decode the original location, and use that as the start of the byref
390   // variable's location.
391   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
392   unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
393   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
394
395   if (Location.isReg()) {
396     if (Reg < 32)
397       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
398     else {
399       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
400       addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
401     }
402   } else {
403     if (Reg < 32)
404       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
405     else {
406       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
407       addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
408     }
409
410     addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
411   }
412
413   // If we started with a pointer to the __Block_byref... struct, then
414   // the first thing we need to do is dereference the pointer (DW_OP_deref).
415   if (isPointer)
416     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
417
418   // Next add the offset for the '__forwarding' field:
419   // DW_OP_plus_uconst ForwardingFieldOffset.  Note there's no point in
420   // adding the offset if it's 0.
421   if (forwardingFieldOffset > 0) {
422     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
423     addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
424   }
425
426   // Now dereference the __forwarding field to get to the real __Block_byref
427   // struct:  DW_OP_deref.
428   addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
429
430   // Now that we've got the real __Block_byref... struct, add the offset
431   // for the variable's field to get to the location of the actual variable:
432   // DW_OP_plus_uconst varFieldOffset.  Again, don't add if it's 0.
433   if (varFieldOffset > 0) {
434     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
435     addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
436   }
437
438   // Now attach the location information to the DIE.
439   addBlock(Die, Attribute, 0, Block);
440 }
441
442 /// addConstantValue - Add constant value entry in variable DIE.
443 bool CompileUnit::addConstantValue(DIE *Die, const MachineOperand &MO,
444                                    DIType Ty) {
445   assert (MO.isImm() && "Invalid machine operand!");
446   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
447   unsigned form = dwarf::DW_FORM_udata;
448   switch (Ty.getSizeInBits()) {
449     case 8: form = dwarf::DW_FORM_data1; break;
450     case 16: form = dwarf::DW_FORM_data2; break;
451     case 32: form = dwarf::DW_FORM_data4; break;
452     case 64: form = dwarf::DW_FORM_data8; break;
453     default: break;
454   }
455
456   DIBasicType BTy(Ty);
457   if (BTy.Verify() &&
458       (BTy.getEncoding()  == dwarf::DW_ATE_signed 
459        || BTy.getEncoding() == dwarf::DW_ATE_signed_char))
460     addSInt(Block, 0, form, MO.getImm());
461   else
462     addUInt(Block, 0, form, MO.getImm());
463
464   addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
465   return true;
466 }
467
468 /// addConstantFPValue - Add constant value entry in variable DIE.
469 bool CompileUnit::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
470   assert (MO.isFPImm() && "Invalid machine operand!");
471   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
472   APFloat FPImm = MO.getFPImm()->getValueAPF();
473
474   // Get the raw data form of the floating point.
475   const APInt FltVal = FPImm.bitcastToAPInt();
476   const char *FltPtr = (const char*)FltVal.getRawData();
477
478   int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
479   bool LittleEndian = Asm->getTargetData().isLittleEndian();
480   int Incr = (LittleEndian ? 1 : -1);
481   int Start = (LittleEndian ? 0 : NumBytes - 1);
482   int Stop = (LittleEndian ? NumBytes : -1);
483
484   // Output the constant to DWARF one byte at a time.
485   for (; Start != Stop; Start += Incr)
486     addUInt(Block, 0, dwarf::DW_FORM_data1,
487             (unsigned char)0xFF & FltPtr[Start]);
488
489   addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
490   return true;
491 }
492
493 /// addConstantValue - Add constant value entry in variable DIE.
494 bool CompileUnit::addConstantValue(DIE *Die, ConstantInt *CI,
495                                    bool Unsigned) {
496   unsigned CIBitWidth = CI->getBitWidth();
497   if (CIBitWidth <= 64) {
498     unsigned form = 0;
499     switch (CIBitWidth) {
500     case 8: form = dwarf::DW_FORM_data1; break;
501     case 16: form = dwarf::DW_FORM_data2; break;
502     case 32: form = dwarf::DW_FORM_data4; break;
503     case 64: form = dwarf::DW_FORM_data8; break;
504     default: 
505       form = Unsigned ? dwarf::DW_FORM_udata : dwarf::DW_FORM_sdata;
506     }
507     if (Unsigned)
508       addUInt(Die, dwarf::DW_AT_const_value, form, CI->getZExtValue());
509     else
510       addSInt(Die, dwarf::DW_AT_const_value, form, CI->getSExtValue());
511     return true;
512   }
513
514   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
515
516   // Get the raw data form of the large APInt.
517   const APInt Val = CI->getValue();
518   const char *Ptr = (const char*)Val.getRawData();
519
520   int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
521   bool LittleEndian = Asm->getTargetData().isLittleEndian();
522   int Incr = (LittleEndian ? 1 : -1);
523   int Start = (LittleEndian ? 0 : NumBytes - 1);
524   int Stop = (LittleEndian ? NumBytes : -1);
525
526   // Output the constant to DWARF one byte at a time.
527   for (; Start != Stop; Start += Incr)
528     addUInt(Block, 0, dwarf::DW_FORM_data1,
529             (unsigned char)0xFF & Ptr[Start]);
530
531   addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
532   return true;
533 }
534
535 /// addTemplateParams - Add template parameters in buffer.
536 void CompileUnit::addTemplateParams(DIE &Buffer, DIArray TParams) {
537   // Add template parameters.
538   for (unsigned i = 0, e = TParams.getNumElements(); i != e; ++i) {
539     DIDescriptor Element = TParams.getElement(i);
540     if (Element.isTemplateTypeParameter())
541       Buffer.addChild(getOrCreateTemplateTypeParameterDIE(
542                         DITemplateTypeParameter(Element)));
543     else if (Element.isTemplateValueParameter())
544       Buffer.addChild(getOrCreateTemplateValueParameterDIE(
545                         DITemplateValueParameter(Element)));
546   }
547
548 }
549 /// addToContextOwner - Add Die into the list of its context owner's children.
550 void CompileUnit::addToContextOwner(DIE *Die, DIDescriptor Context) {
551   if (Context.isType()) {
552     DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
553     ContextDIE->addChild(Die);
554   } else if (Context.isNameSpace()) {
555     DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
556     ContextDIE->addChild(Die);
557   } else if (Context.isSubprogram()) {
558     DIE *ContextDIE = DD->createSubprogramDIE(DISubprogram(Context));
559     ContextDIE->addChild(Die);
560   } else if (DIE *ContextDIE = getDIE(Context))
561     ContextDIE->addChild(Die);
562   else
563     addDie(Die);
564 }
565
566 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
567 /// given DIType.
568 DIE *CompileUnit::getOrCreateTypeDIE(DIType Ty) {
569   DIE *TyDIE = getDIE(Ty);
570   if (TyDIE)
571     return TyDIE;
572
573   // Create new type.
574   TyDIE = new DIE(dwarf::DW_TAG_base_type);
575   insertDIE(Ty, TyDIE);
576   if (Ty.isBasicType())
577     constructTypeDIE(*TyDIE, DIBasicType(Ty));
578   else if (Ty.isCompositeType())
579     constructTypeDIE(*TyDIE, DICompositeType(Ty));
580   else {
581     assert(Ty.isDerivedType() && "Unknown kind of DIType");
582     constructTypeDIE(*TyDIE, DIDerivedType(Ty));
583   }
584
585   addToContextOwner(TyDIE, Ty.getContext());
586   return TyDIE;
587 }
588
589 /// addType - Add a new type attribute to the specified entity.
590 void CompileUnit::addType(DIE *Entity, DIType Ty) {
591   if (!Ty.Verify())
592     return;
593
594   // Check for pre-existence.
595   DIEEntry *Entry = getDIEEntry(Ty);
596   // If it exists then use the existing value.
597   if (Entry) {
598     Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
599     return;
600   }
601
602   // Construct type.
603   DIE *Buffer = getOrCreateTypeDIE(Ty);
604
605   // Set up proxy.
606   Entry = createDIEEntry(Buffer);
607   insertDIEEntry(Ty, Entry);
608
609   Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
610 }
611
612 /// addPubTypes - Add type for pubtypes section.
613 void CompileUnit::addPubTypes(DISubprogram SP) {
614   DICompositeType SPTy = SP.getType();
615   unsigned SPTag = SPTy.getTag();
616   if (SPTag != dwarf::DW_TAG_subroutine_type)
617     return;
618
619   DIArray Args = SPTy.getTypeArray();
620   for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
621     DIType ATy(Args.getElement(i));
622     if (!ATy.Verify())
623       continue;
624     DICompositeType CATy = getDICompositeType(ATy);
625     if (DIDescriptor(CATy).Verify() && !CATy.getName().empty()
626         && !CATy.isForwardDecl()) {
627       if (DIEEntry *Entry = getDIEEntry(CATy))
628         addGlobalType(CATy.getName(), Entry->getEntry());
629     }
630   }
631 }
632
633 /// constructTypeDIE - Construct basic type die from DIBasicType.
634 void CompileUnit::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
635   // Get core information.
636   StringRef Name = BTy.getName();
637   Buffer.setTag(dwarf::DW_TAG_base_type);
638   addUInt(&Buffer, dwarf::DW_AT_encoding,  dwarf::DW_FORM_data1,
639           BTy.getEncoding());
640
641   // Add name if not anonymous or intermediate type.
642   if (!Name.empty())
643     addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
644   uint64_t Size = BTy.getSizeInBits() >> 3;
645   addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
646 }
647
648 /// constructTypeDIE - Construct derived type die from DIDerivedType.
649 void CompileUnit::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
650   // Get core information.
651   StringRef Name = DTy.getName();
652   uint64_t Size = DTy.getSizeInBits() >> 3;
653   unsigned Tag = DTy.getTag();
654
655   // FIXME - Workaround for templates.
656   if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
657
658   Buffer.setTag(Tag);
659
660   // Map to main type, void will not have a type.
661   DIType FromTy = DTy.getTypeDerivedFrom();
662   addType(&Buffer, FromTy);
663
664   // Add name if not anonymous or intermediate type.
665   if (!Name.empty())
666     addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
667
668   // Add size if non-zero (derived types might be zero-sized.)
669   if (Size)
670     addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
671
672   // Add source line info if available and TyDesc is not a forward declaration.
673   if (!DTy.isForwardDecl())
674     addSourceLine(&Buffer, DTy);
675 }
676
677 /// constructTypeDIE - Construct type DIE from DICompositeType.
678 void CompileUnit::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
679   // Get core information.
680   StringRef Name = CTy.getName();
681
682   uint64_t Size = CTy.getSizeInBits() >> 3;
683   unsigned Tag = CTy.getTag();
684   Buffer.setTag(Tag);
685
686   switch (Tag) {
687   case dwarf::DW_TAG_vector_type:
688   case dwarf::DW_TAG_array_type:
689     constructArrayTypeDIE(Buffer, &CTy);
690     break;
691   case dwarf::DW_TAG_enumeration_type: {
692     DIArray Elements = CTy.getTypeArray();
693
694     // Add enumerators to enumeration type.
695     for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
696       DIE *ElemDie = NULL;
697       DIDescriptor Enum(Elements.getElement(i));
698       if (Enum.isEnumerator()) {
699         ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
700         Buffer.addChild(ElemDie);
701       }
702     }
703   }
704     break;
705   case dwarf::DW_TAG_subroutine_type: {
706     // Add return type.
707     DIArray Elements = CTy.getTypeArray();
708     DIDescriptor RTy = Elements.getElement(0);
709     addType(&Buffer, DIType(RTy));
710
711     bool isPrototyped = true;
712     // Add arguments.
713     for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
714       DIDescriptor Ty = Elements.getElement(i);
715       if (Ty.isUnspecifiedParameter()) {
716         DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
717         Buffer.addChild(Arg);
718         isPrototyped = false;
719       } else {
720         DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
721         addType(Arg, DIType(Ty));
722         Buffer.addChild(Arg);
723       }
724     }
725     // Add prototype flag.
726     if (isPrototyped)
727       addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
728   }
729     break;
730   case dwarf::DW_TAG_structure_type:
731   case dwarf::DW_TAG_union_type:
732   case dwarf::DW_TAG_class_type: {
733     // Add elements to structure type.
734     DIArray Elements = CTy.getTypeArray();
735
736     // A forward struct declared type may not have elements available.
737     unsigned N = Elements.getNumElements();
738     if (N == 0)
739       break;
740
741     // Add elements to structure type.
742     for (unsigned i = 0; i < N; ++i) {
743       DIDescriptor Element = Elements.getElement(i);
744       DIE *ElemDie = NULL;
745       if (Element.isSubprogram()) {
746         DISubprogram SP(Element);
747         ElemDie = DD->createSubprogramDIE(DISubprogram(Element));
748         if (SP.isProtected())
749           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
750                   dwarf::DW_ACCESS_protected);
751         else if (SP.isPrivate())
752           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
753                   dwarf::DW_ACCESS_private);
754         else 
755           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
756             dwarf::DW_ACCESS_public);
757         if (SP.isExplicit())
758           addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
759       }
760       else if (Element.isVariable()) {
761         DIVariable DV(Element);
762         ElemDie = new DIE(dwarf::DW_TAG_variable);
763         addString(ElemDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
764                   DV.getName());
765         addType(ElemDie, DV.getType());
766         addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
767         addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
768         addSourceLine(ElemDie, DV);
769       } else if (Element.isDerivedType())
770         ElemDie = createMemberDIE(DIDerivedType(Element));
771       else
772         continue;
773       Buffer.addChild(ElemDie);
774     }
775
776     if (CTy.isAppleBlockExtension())
777       addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
778
779     unsigned RLang = CTy.getRunTimeLang();
780     if (RLang)
781       addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
782               dwarf::DW_FORM_data1, RLang);
783
784     DICompositeType ContainingType = CTy.getContainingType();
785     if (DIDescriptor(ContainingType).isCompositeType())
786       addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
787                   getOrCreateTypeDIE(DIType(ContainingType)));
788     else {
789       DIDescriptor Context = CTy.getContext();
790       addToContextOwner(&Buffer, Context);
791     }
792
793     if (CTy.isObjcClassComplete())
794       addUInt(&Buffer, dwarf::DW_AT_APPLE_objc_complete_type,
795               dwarf::DW_FORM_flag, 1);
796
797     if (Tag == dwarf::DW_TAG_class_type) 
798       addTemplateParams(Buffer, CTy.getTemplateParams());
799
800     break;
801   }
802   default:
803     break;
804   }
805
806   // Add name if not anonymous or intermediate type.
807   if (!Name.empty())
808     addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
809
810   if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
811       || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
812     {
813     // Add size if non-zero (derived types might be zero-sized.)
814     if (Size)
815       addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
816     else {
817       // Add zero size if it is not a forward declaration.
818       if (CTy.isForwardDecl())
819         addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
820       else
821         addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
822     }
823
824     // Add source line info if available.
825     if (!CTy.isForwardDecl())
826       addSourceLine(&Buffer, CTy);
827   }
828 }
829
830 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE 
831 /// for the given DITemplateTypeParameter.
832 DIE *
833 CompileUnit::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP) {
834   DIE *ParamDIE = getDIE(TP);
835   if (ParamDIE)
836     return ParamDIE;
837
838   ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
839   addType(ParamDIE, TP.getType());
840   addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TP.getName());
841   return ParamDIE;
842 }
843
844 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE 
845 /// for the given DITemplateValueParameter.
846 DIE *
847 CompileUnit::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TPV) {
848   DIE *ParamDIE = getDIE(TPV);
849   if (ParamDIE)
850     return ParamDIE;
851
852   ParamDIE = new DIE(dwarf::DW_TAG_template_value_parameter);
853   addType(ParamDIE, TPV.getType());
854   if (!TPV.getName().empty())
855     addString(ParamDIE, dwarf::DW_AT_name, dwarf::DW_FORM_string, TPV.getName());
856   addUInt(ParamDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata, 
857           TPV.getValue());
858   return ParamDIE;
859 }
860
861 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
862 DIE *CompileUnit::getOrCreateNameSpace(DINameSpace NS) {
863   DIE *NDie = getDIE(NS);
864   if (NDie)
865     return NDie;
866   NDie = new DIE(dwarf::DW_TAG_namespace);
867   insertDIE(NS, NDie);
868   if (!NS.getName().empty())
869     addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
870   addSourceLine(NDie, NS);
871   addToContextOwner(NDie, NS.getContext());
872   return NDie;
873 }
874
875 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
876 void CompileUnit::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
877   DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
878   addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
879   int64_t L = SR.getLo();
880   int64_t H = SR.getHi();
881
882   // The L value defines the lower bounds which is typically zero for C/C++. The
883   // H value is the upper bounds.  Values are 64 bit.  H - L + 1 is the size
884   // of the array. If L > H then do not emit DW_AT_lower_bound and 
885   // DW_AT_upper_bound attributes. If L is zero and H is also zero then the
886   // array has one element and in such case do not emit lower bound.
887
888   if (L > H) {
889     Buffer.addChild(DW_Subrange);
890     return;
891   }
892   if (L)
893     addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
894   addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
895   Buffer.addChild(DW_Subrange);
896 }
897
898 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
899 void CompileUnit::constructArrayTypeDIE(DIE &Buffer,
900                                         DICompositeType *CTy) {
901   Buffer.setTag(dwarf::DW_TAG_array_type);
902   if (CTy->getTag() == dwarf::DW_TAG_vector_type)
903     addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
904
905   // Emit derived type.
906   addType(&Buffer, CTy->getTypeDerivedFrom());
907   DIArray Elements = CTy->getTypeArray();
908
909   // Get an anonymous type for index type.
910   DIE *IdxTy = getIndexTyDie();
911   if (!IdxTy) {
912     // Construct an anonymous type for index type.
913     IdxTy = new DIE(dwarf::DW_TAG_base_type);
914     addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
915     addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
916             dwarf::DW_ATE_signed);
917     addDie(IdxTy);
918     setIndexTyDie(IdxTy);
919   }
920
921   // Add subranges to array type.
922   for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
923     DIDescriptor Element = Elements.getElement(i);
924     if (Element.getTag() == dwarf::DW_TAG_subrange_type)
925       constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
926   }
927 }
928
929 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
930 DIE *CompileUnit::constructEnumTypeDIE(DIEnumerator ETy) {
931   DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
932   StringRef Name = ETy.getName();
933   addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
934   int64_t Value = ETy.getEnumValue();
935   addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
936   return Enumerator;
937 }
938
939 /// createMemberDIE - Create new member DIE.
940 DIE *CompileUnit::createMemberDIE(DIDerivedType DT) {
941   DIE *MemberDie = new DIE(DT.getTag());
942   StringRef Name = DT.getName();
943   if (!Name.empty())
944     addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
945
946   addType(MemberDie, DT.getTypeDerivedFrom());
947
948   addSourceLine(MemberDie, DT);
949
950   DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
951   addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
952
953   uint64_t Size = DT.getSizeInBits();
954   uint64_t FieldSize = DT.getOriginalTypeSize();
955
956   if (Size != FieldSize) {
957     // Handle bitfield.
958     addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
959     addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
960
961     uint64_t Offset = DT.getOffsetInBits();
962     uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
963     uint64_t HiMark = (Offset + FieldSize) & AlignMask;
964     uint64_t FieldOffset = (HiMark - FieldSize);
965     Offset -= FieldOffset;
966
967     // Maybe we need to work from the other end.
968     if (Asm->getTargetData().isLittleEndian())
969       Offset = FieldSize - (Offset + Size);
970     addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
971
972     // Here WD_AT_data_member_location points to the anonymous
973     // field that includes this bit field.
974     addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
975
976   } else
977     // This is not a bitfield.
978     addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
979
980   if (DT.getTag() == dwarf::DW_TAG_inheritance
981       && DT.isVirtual()) {
982
983     // For C++, virtual base classes are not at fixed offset. Use following
984     // expression to extract appropriate offset from vtable.
985     // BaseAddr = ObAddr + *((*ObAddr) - Offset)
986
987     DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
988     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
989     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
990     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
991     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
992     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
993     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
994     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
995
996     addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
997              VBaseLocationDie);
998   } else
999     addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
1000
1001   if (DT.isProtected())
1002     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1003             dwarf::DW_ACCESS_protected);
1004   else if (DT.isPrivate())
1005     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1006             dwarf::DW_ACCESS_private);
1007   // Otherwise C++ member and base classes are considered public.
1008   else if (DT.getCompileUnit().getLanguage() == dwarf::DW_LANG_C_plus_plus)
1009     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1010             dwarf::DW_ACCESS_public);
1011   if (DT.isVirtual())
1012     addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1013             dwarf::DW_VIRTUALITY_virtual);
1014
1015   // Objective-C properties.
1016   StringRef PropertyName = DT.getObjCPropertyName();
1017   if (!PropertyName.empty()) {
1018     addString(MemberDie, dwarf::DW_AT_APPLE_property_name, dwarf::DW_FORM_string,
1019               PropertyName);
1020     StringRef GetterName = DT.getObjCPropertyGetterName();
1021     if (!GetterName.empty())
1022       addString(MemberDie, dwarf::DW_AT_APPLE_property_getter,
1023                 dwarf::DW_FORM_string, GetterName);
1024     StringRef SetterName = DT.getObjCPropertySetterName();
1025     if (!SetterName.empty())
1026       addString(MemberDie, dwarf::DW_AT_APPLE_property_setter,
1027                 dwarf::DW_FORM_string, SetterName);
1028     unsigned PropertyAttributes = 0;
1029     if (DT.isReadOnlyObjCProperty())
1030       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readonly;
1031     if (DT.isReadWriteObjCProperty())
1032       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readwrite;
1033     if (DT.isAssignObjCProperty())
1034       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_assign;
1035     if (DT.isRetainObjCProperty())
1036       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_retain;
1037     if (DT.isCopyObjCProperty())
1038       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_copy;
1039     if (DT.isNonAtomicObjCProperty())
1040       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_nonatomic;
1041     if (PropertyAttributes)
1042       addUInt(MemberDie, dwarf::DW_AT_APPLE_property_attribute, 0, 
1043               PropertyAttributes);
1044   }
1045   return MemberDie;
1046 }