Fix up a few minor performance problems spotted in code review.
[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 constructing a dwarf compile unit.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "dwarfdebug"
15
16 #include "DwarfCompileUnit.h"
17 #include "DwarfAccelTable.h"
18 #include "DwarfDebug.h"
19 #include "llvm/ADT/APFloat.h"
20 #include "llvm/DIBuilder.h"
21 #include "llvm/IR/Constants.h"
22 #include "llvm/IR/DataLayout.h"
23 #include "llvm/IR/GlobalVariable.h"
24 #include "llvm/IR/Instructions.h"
25 #include "llvm/Target/Mangler.h"
26 #include "llvm/Target/TargetFrameLowering.h"
27 #include "llvm/Target/TargetMachine.h"
28 #include "llvm/Target/TargetLoweringObjectFile.h"
29 #include "llvm/Target/TargetRegisterInfo.h"
30
31 using namespace llvm;
32
33 /// CompileUnit - Compile unit constructor.
34 CompileUnit::CompileUnit(unsigned UID, DIE *D, const MDNode *N, AsmPrinter *A,
35                          DwarfDebug *DW, DwarfUnits *DWU)
36     : UniqueID(UID), Node(N), CUDie(D), Asm(A), DD(DW), DU(DWU), IndexTyDie(0) {
37   DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
38   insertDIE(N, D);
39 }
40
41 /// ~CompileUnit - Destructor for compile unit.
42 CompileUnit::~CompileUnit() {
43   for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
44     DIEBlocks[j]->~DIEBlock();
45 }
46
47 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
48 /// information entry.
49 DIEEntry *CompileUnit::createDIEEntry(DIE *Entry) {
50   DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
51   return Value;
52 }
53
54 /// getDefaultLowerBound - Return the default lower bound for an array. If the
55 /// DWARF version doesn't handle the language, return -1.
56 int64_t CompileUnit::getDefaultLowerBound() const {
57   switch (DICompileUnit(Node).getLanguage()) {
58   default:
59     break;
60
61   case dwarf::DW_LANG_C89:
62   case dwarf::DW_LANG_C99:
63   case dwarf::DW_LANG_C:
64   case dwarf::DW_LANG_C_plus_plus:
65   case dwarf::DW_LANG_ObjC:
66   case dwarf::DW_LANG_ObjC_plus_plus:
67     return 0;
68
69   case dwarf::DW_LANG_Fortran77:
70   case dwarf::DW_LANG_Fortran90:
71   case dwarf::DW_LANG_Fortran95:
72     return 1;
73
74   // The languages below have valid values only if the DWARF version >= 4.
75   case dwarf::DW_LANG_Java:
76   case dwarf::DW_LANG_Python:
77   case dwarf::DW_LANG_UPC:
78   case dwarf::DW_LANG_D:
79     if (dwarf::DWARF_VERSION >= 4)
80       return 0;
81     break;
82
83   case dwarf::DW_LANG_Ada83:
84   case dwarf::DW_LANG_Ada95:
85   case dwarf::DW_LANG_Cobol74:
86   case dwarf::DW_LANG_Cobol85:
87   case dwarf::DW_LANG_Modula2:
88   case dwarf::DW_LANG_Pascal83:
89   case dwarf::DW_LANG_PLI:
90     if (dwarf::DWARF_VERSION >= 4)
91       return 1;
92     break;
93   }
94
95   return -1;
96 }
97
98 /// addFlag - Add a flag that is true.
99 void CompileUnit::addFlag(DIE *Die, uint16_t Attribute) {
100   if (DD->getDwarfVersion() >= 4)
101     Die->addValue(Attribute, dwarf::DW_FORM_flag_present, DIEIntegerOne);
102   else
103     Die->addValue(Attribute, dwarf::DW_FORM_flag, DIEIntegerOne);
104 }
105
106 /// addUInt - Add an unsigned integer attribute data and value.
107 ///
108 void CompileUnit::addUInt(DIE *Die, uint16_t Attribute,
109                           uint16_t Form, uint64_t Integer) {
110   if (!Form) Form = DIEInteger::BestForm(false, Integer);
111   DIEValue *Value = Integer == 1 ?
112     DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
113   Die->addValue(Attribute, Form, Value);
114 }
115
116 /// addSInt - Add an signed integer attribute data and value.
117 ///
118 void CompileUnit::addSInt(DIE *Die, uint16_t Attribute,
119                           uint16_t Form, int64_t Integer) {
120   if (!Form) Form = DIEInteger::BestForm(true, Integer);
121   DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
122   Die->addValue(Attribute, Form, Value);
123 }
124
125 /// addString - Add a string attribute data and value. We always emit a
126 /// reference to the string pool instead of immediate strings so that DIEs have
127 /// more predictable sizes. In the case of split dwarf we emit an index
128 /// into another table which gets us the static offset into the string
129 /// table.
130 void CompileUnit::addString(DIE *Die, uint16_t Attribute, StringRef String) {
131   DIEValue *Value;
132   uint16_t Form;
133   if (!DD->useSplitDwarf()) {
134     MCSymbol *Symb = DU->getStringPoolEntry(String);
135     if (Asm->needsRelocationsForDwarfStringPool())
136       Value = new (DIEValueAllocator) DIELabel(Symb);
137     else {
138       MCSymbol *StringPool = DU->getStringPoolSym();
139       Value = new (DIEValueAllocator) DIEDelta(Symb, StringPool);
140     }
141     Form = dwarf::DW_FORM_strp;
142   } else {
143     unsigned idx = DU->getStringPoolIndex(String);
144     Value = new (DIEValueAllocator) DIEInteger(idx);
145     Form = dwarf::DW_FORM_GNU_str_index;
146   }
147   DIEValue *Str = new (DIEValueAllocator) DIEString(Value, String);
148   Die->addValue(Attribute, Form, Str);
149 }
150
151 /// addLocalString - Add a string attribute data and value. This is guaranteed
152 /// to be in the local string pool instead of indirected.
153 void CompileUnit::addLocalString(DIE *Die, uint16_t Attribute,
154                                  StringRef String) {
155   MCSymbol *Symb = DU->getStringPoolEntry(String);
156   DIEValue *Value;
157   if (Asm->needsRelocationsForDwarfStringPool())
158     Value = new (DIEValueAllocator) DIELabel(Symb);
159   else {
160     MCSymbol *StringPool = DU->getStringPoolSym();
161     Value = new (DIEValueAllocator) DIEDelta(Symb, StringPool);
162   }
163   Die->addValue(Attribute, dwarf::DW_FORM_strp, Value);
164 }
165
166 /// addExpr - Add a Dwarf expression attribute data and value.
167 ///
168 void CompileUnit::addExpr(DIE *Die, uint16_t Attribute, uint16_t Form,
169                           const MCExpr *Expr) {
170   DIEValue *Value = new (DIEValueAllocator) DIEExpr(Expr);
171   Die->addValue(Attribute, Form, Value);
172 }
173
174 /// addLabel - Add a Dwarf label attribute data and value.
175 ///
176 void CompileUnit::addLabel(DIE *Die, uint16_t Attribute, uint16_t Form,
177                            const MCSymbol *Label) {
178   DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
179   Die->addValue(Attribute, Form, Value);
180 }
181
182 /// addLabelAddress - Add a dwarf label attribute data and value using
183 /// DW_FORM_addr or DW_FORM_GNU_addr_index.
184 ///
185 void CompileUnit::addLabelAddress(DIE *Die, uint16_t Attribute,
186                                   MCSymbol *Label) {
187   if (Label)
188     DD->addArangeLabel(SymbolCU(this, Label));
189
190   if (!DD->useSplitDwarf()) {
191     if (Label != NULL) {
192       DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
193       Die->addValue(Attribute, dwarf::DW_FORM_addr, Value);
194     } else {
195       DIEValue *Value = new (DIEValueAllocator) DIEInteger(0);
196       Die->addValue(Attribute, dwarf::DW_FORM_addr, Value);
197     }
198   } else {
199     unsigned idx = DU->getAddrPoolIndex(Label);
200     DIEValue *Value = new (DIEValueAllocator) DIEInteger(idx);
201     Die->addValue(Attribute, dwarf::DW_FORM_GNU_addr_index, Value);
202   }
203 }
204
205 /// addOpAddress - Add a dwarf op address data and value using the
206 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
207 ///
208 void CompileUnit::addOpAddress(DIE *Die, const MCSymbol *Sym) {
209   DD->addArangeLabel(SymbolCU(this, Sym));
210   if (!DD->useSplitDwarf()) {
211     addUInt(Die, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
212     addLabel(Die, 0, dwarf::DW_FORM_udata, Sym);
213   } else {
214     addUInt(Die, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_addr_index);
215     addUInt(Die, 0, dwarf::DW_FORM_GNU_addr_index, DU->getAddrPoolIndex(Sym));
216   }
217 }
218
219 /// addDelta - Add a label delta attribute data and value.
220 ///
221 void CompileUnit::addDelta(DIE *Die, uint16_t Attribute, uint16_t Form,
222                            const MCSymbol *Hi, const MCSymbol *Lo) {
223   DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
224   Die->addValue(Attribute, Form, Value);
225 }
226
227 /// addDIEEntry - Add a DIE attribute data and value.
228 ///
229 void CompileUnit::addDIEEntry(DIE *Die, uint16_t Attribute, DIE *Entry) {
230   // We currently only use ref4.
231   Die->addValue(Attribute, dwarf::DW_FORM_ref4, createDIEEntry(Entry));
232 }
233
234 /// addBlock - Add block data.
235 ///
236 void CompileUnit::addBlock(DIE *Die, uint16_t Attribute, uint16_t Form,
237                            DIEBlock *Block) {
238   Block->ComputeSize(Asm);
239   DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
240   Die->addValue(Attribute, Block->BestForm(), Block);
241 }
242
243 /// addSourceLine - Add location information to specified debug information
244 /// entry.
245 void CompileUnit::addSourceLine(DIE *Die, DIVariable V) {
246   // Verify variable.
247   if (!V.isVariable())
248     return;
249
250   unsigned Line = V.getLineNumber();
251   if (Line == 0)
252     return;
253   unsigned FileID = DD->getOrCreateSourceID(V.getContext().getFilename(),
254                                             V.getContext().getDirectory(),
255                                             getUniqueID());
256   assert(FileID && "Invalid file id");
257   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
258   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
259 }
260
261 /// addSourceLine - Add location information to specified debug information
262 /// entry.
263 void CompileUnit::addSourceLine(DIE *Die, DIGlobalVariable G) {
264   // Verify global variable.
265   if (!G.isGlobalVariable())
266     return;
267
268   unsigned Line = G.getLineNumber();
269   if (Line == 0)
270     return;
271   unsigned FileID = DD->getOrCreateSourceID(G.getFilename(), G.getDirectory(),
272                                             getUniqueID());
273   assert(FileID && "Invalid file id");
274   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
275   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
276 }
277
278 /// addSourceLine - Add location information to specified debug information
279 /// entry.
280 void CompileUnit::addSourceLine(DIE *Die, DISubprogram SP) {
281   // Verify subprogram.
282   if (!SP.isSubprogram())
283     return;
284
285   // If the line number is 0, don't add it.
286   unsigned Line = SP.getLineNumber();
287   if (Line == 0)
288     return;
289
290   unsigned FileID = DD->getOrCreateSourceID(SP.getFilename(),
291                                             SP.getDirectory(), getUniqueID());
292   assert(FileID && "Invalid file id");
293   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
294   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
295 }
296
297 /// addSourceLine - Add location information to specified debug information
298 /// entry.
299 void CompileUnit::addSourceLine(DIE *Die, DIType Ty) {
300   // Verify type.
301   if (!Ty.isType())
302     return;
303
304   unsigned Line = Ty.getLineNumber();
305   if (Line == 0)
306     return;
307   unsigned FileID = DD->getOrCreateSourceID(Ty.getFilename(),
308                                             Ty.getDirectory(), getUniqueID());
309   assert(FileID && "Invalid file id");
310   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
311   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
312 }
313
314 /// addSourceLine - Add location information to specified debug information
315 /// entry.
316 void CompileUnit::addSourceLine(DIE *Die, DIObjCProperty Ty) {
317   // Verify type.
318   if (!Ty.isObjCProperty())
319     return;
320
321   unsigned Line = Ty.getLineNumber();
322   if (Line == 0)
323     return;
324   DIFile File = Ty.getFile();
325   unsigned FileID = DD->getOrCreateSourceID(File.getFilename(),
326                                             File.getDirectory(), getUniqueID());
327   assert(FileID && "Invalid file id");
328   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
329   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
330 }
331
332 /// addSourceLine - Add location information to specified debug information
333 /// entry.
334 void CompileUnit::addSourceLine(DIE *Die, DINameSpace NS) {
335   // Verify namespace.
336   if (!NS.Verify())
337     return;
338
339   unsigned Line = NS.getLineNumber();
340   if (Line == 0)
341     return;
342   StringRef FN = NS.getFilename();
343
344   unsigned FileID = DD->getOrCreateSourceID(FN, NS.getDirectory(),
345                                             getUniqueID());
346   assert(FileID && "Invalid file id");
347   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
348   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
349 }
350
351 /// addVariableAddress - Add DW_AT_location attribute for a
352 /// DbgVariable based on provided MachineLocation.
353 void CompileUnit::addVariableAddress(const DbgVariable &DV, DIE *Die,
354                                      MachineLocation Location) {
355   if (DV.variableHasComplexAddress())
356     addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
357   else if (DV.isBlockByrefVariable())
358     addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
359   else
360     addAddress(Die, dwarf::DW_AT_location, Location,
361                DV.getVariable().isIndirect());
362 }
363
364 /// addRegisterOp - Add register operand.
365 void CompileUnit::addRegisterOp(DIE *TheDie, unsigned Reg) {
366   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
367   unsigned DWReg = RI->getDwarfRegNum(Reg, false);
368   if (DWReg < 32)
369     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + DWReg);
370   else {
371     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
372     addUInt(TheDie, 0, dwarf::DW_FORM_udata, DWReg);
373   }
374 }
375
376 /// addRegisterOffset - Add register offset.
377 void CompileUnit::addRegisterOffset(DIE *TheDie, unsigned Reg,
378                                     int64_t Offset) {
379   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
380   unsigned DWReg = RI->getDwarfRegNum(Reg, false);
381   const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
382   if (Reg == TRI->getFrameRegister(*Asm->MF))
383     // If variable offset is based in frame register then use fbreg.
384     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
385   else if (DWReg < 32)
386     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + DWReg);
387   else {
388     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
389     addUInt(TheDie, 0, dwarf::DW_FORM_udata, DWReg);
390   }
391   addSInt(TheDie, 0, dwarf::DW_FORM_sdata, Offset);
392 }
393
394 /// addAddress - Add an address attribute to a die based on the location
395 /// provided.
396 void CompileUnit::addAddress(DIE *Die, uint16_t Attribute,
397                              const MachineLocation &Location, bool Indirect) {
398   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
399
400   if (Location.isReg() && !Indirect)
401     addRegisterOp(Block, Location.getReg());
402   else {
403     addRegisterOffset(Block, Location.getReg(), Location.getOffset());
404     if (Indirect && !Location.isReg()) {
405       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
406     }
407   }
408
409   // Now attach the location information to the DIE.
410   addBlock(Die, Attribute, 0, Block);
411 }
412
413 /// addComplexAddress - Start with the address based on the location provided,
414 /// and generate the DWARF information necessary to find the actual variable
415 /// given the extra address information encoded in the DIVariable, starting from
416 /// the starting location.  Add the DWARF information to the die.
417 ///
418 void CompileUnit::addComplexAddress(const DbgVariable &DV, DIE *Die,
419                                     uint16_t Attribute,
420                                     const MachineLocation &Location) {
421   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
422   unsigned N = DV.getNumAddrElements();
423   unsigned i = 0;
424   if (Location.isReg()) {
425     if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
426       // If first address element is OpPlus then emit
427       // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
428       addRegisterOffset(Block, Location.getReg(), DV.getAddrElement(1));
429       i = 2;
430     } else
431       addRegisterOp(Block, Location.getReg());
432   }
433   else
434     addRegisterOffset(Block, Location.getReg(), Location.getOffset());
435
436   for (;i < N; ++i) {
437     uint64_t Element = DV.getAddrElement(i);
438     if (Element == DIBuilder::OpPlus) {
439       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
440       addUInt(Block, 0, dwarf::DW_FORM_udata, DV.getAddrElement(++i));
441     } else if (Element == DIBuilder::OpDeref) {
442       if (!Location.isReg())
443         addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
444     } else llvm_unreachable("unknown DIBuilder Opcode");
445   }
446
447   // Now attach the location information to the DIE.
448   addBlock(Die, Attribute, 0, Block);
449 }
450
451 /* Byref variables, in Blocks, are declared by the programmer as "SomeType
452    VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
453    gives the variable VarName either the struct, or a pointer to the struct, as
454    its type.  This is necessary for various behind-the-scenes things the
455    compiler needs to do with by-reference variables in Blocks.
456
457    However, as far as the original *programmer* is concerned, the variable
458    should still have type 'SomeType', as originally declared.
459
460    The function getBlockByrefType dives into the __Block_byref_x_VarName
461    struct to find the original type of the variable, which is then assigned to
462    the variable's Debug Information Entry as its real type.  So far, so good.
463    However now the debugger will expect the variable VarName to have the type
464    SomeType.  So we need the location attribute for the variable to be an
465    expression that explains to the debugger how to navigate through the
466    pointers and struct to find the actual variable of type SomeType.
467
468    The following function does just that.  We start by getting
469    the "normal" location for the variable. This will be the location
470    of either the struct __Block_byref_x_VarName or the pointer to the
471    struct __Block_byref_x_VarName.
472
473    The struct will look something like:
474
475    struct __Block_byref_x_VarName {
476      ... <various fields>
477      struct __Block_byref_x_VarName *forwarding;
478      ... <various other fields>
479      SomeType VarName;
480      ... <maybe more fields>
481    };
482
483    If we are given the struct directly (as our starting point) we
484    need to tell the debugger to:
485
486    1).  Add the offset of the forwarding field.
487
488    2).  Follow that pointer to get the real __Block_byref_x_VarName
489    struct to use (the real one may have been copied onto the heap).
490
491    3).  Add the offset for the field VarName, to find the actual variable.
492
493    If we started with a pointer to the struct, then we need to
494    dereference that pointer first, before the other steps.
495    Translating this into DWARF ops, we will need to append the following
496    to the current location description for the variable:
497
498    DW_OP_deref                    -- optional, if we start with a pointer
499    DW_OP_plus_uconst <forward_fld_offset>
500    DW_OP_deref
501    DW_OP_plus_uconst <varName_fld_offset>
502
503    That is what this function does.  */
504
505 /// addBlockByrefAddress - Start with the address based on the location
506 /// provided, and generate the DWARF information necessary to find the
507 /// actual Block variable (navigating the Block struct) based on the
508 /// starting location.  Add the DWARF information to the die.  For
509 /// more information, read large comment just above here.
510 ///
511 void CompileUnit::addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
512                                        uint16_t Attribute,
513                                        const MachineLocation &Location) {
514   DIType Ty = DV.getType();
515   DIType TmpTy = Ty;
516   uint16_t Tag = Ty.getTag();
517   bool isPointer = false;
518
519   StringRef varName = DV.getName();
520
521   if (Tag == dwarf::DW_TAG_pointer_type) {
522     DIDerivedType DTy = DIDerivedType(Ty);
523     TmpTy = resolve(DTy.getTypeDerivedFrom());
524     isPointer = true;
525   }
526
527   DICompositeType blockStruct = DICompositeType(TmpTy);
528
529   // Find the __forwarding field and the variable field in the __Block_byref
530   // struct.
531   DIArray Fields = blockStruct.getTypeArray();
532   DIDescriptor varField = DIDescriptor();
533   DIDescriptor forwardingField = DIDescriptor();
534
535   for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
536     DIDescriptor Element = Fields.getElement(i);
537     DIDerivedType DT = DIDerivedType(Element);
538     StringRef fieldName = DT.getName();
539     if (fieldName == "__forwarding")
540       forwardingField = Element;
541     else if (fieldName == varName)
542       varField = Element;
543   }
544
545   // Get the offsets for the forwarding field and the variable field.
546   unsigned forwardingFieldOffset =
547     DIDerivedType(forwardingField).getOffsetInBits() >> 3;
548   unsigned varFieldOffset =
549     DIDerivedType(varField).getOffsetInBits() >> 3;
550
551   // Decode the original location, and use that as the start of the byref
552   // variable's location.
553   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
554
555   if (Location.isReg())
556     addRegisterOp(Block, Location.getReg());
557   else
558     addRegisterOffset(Block, Location.getReg(), Location.getOffset());
559
560   // If we started with a pointer to the __Block_byref... struct, then
561   // the first thing we need to do is dereference the pointer (DW_OP_deref).
562   if (isPointer)
563     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
564
565   // Next add the offset for the '__forwarding' field:
566   // DW_OP_plus_uconst ForwardingFieldOffset.  Note there's no point in
567   // adding the offset if it's 0.
568   if (forwardingFieldOffset > 0) {
569     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
570     addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
571   }
572
573   // Now dereference the __forwarding field to get to the real __Block_byref
574   // struct:  DW_OP_deref.
575   addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
576
577   // Now that we've got the real __Block_byref... struct, add the offset
578   // for the variable's field to get to the location of the actual variable:
579   // DW_OP_plus_uconst varFieldOffset.  Again, don't add if it's 0.
580   if (varFieldOffset > 0) {
581     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
582     addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
583   }
584
585   // Now attach the location information to the DIE.
586   addBlock(Die, Attribute, 0, Block);
587 }
588
589 /// isTypeSigned - Return true if the type is signed.
590 static bool isTypeSigned(DwarfDebug *DD, DIType Ty, int *SizeInBits) {
591   if (Ty.isDerivedType())
592     return isTypeSigned(DD, DD->resolve(DIDerivedType(Ty).getTypeDerivedFrom()),
593                         SizeInBits);
594   if (Ty.isBasicType())
595     if (DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed
596         || DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed_char) {
597       *SizeInBits = Ty.getSizeInBits();
598       return true;
599     }
600   return false;
601 }
602
603 /// Return true if type encoding is unsigned.
604 static bool isUnsignedDIType(DwarfDebug *DD, DIType Ty) {
605   DIDerivedType DTy(Ty);
606   if (DTy.isDerivedType())
607     return isUnsignedDIType(DD, DD->resolve(DTy.getTypeDerivedFrom()));
608
609   DIBasicType BTy(Ty);
610   if (BTy.isBasicType()) {
611     unsigned Encoding = BTy.getEncoding();
612     if (Encoding == dwarf::DW_ATE_unsigned ||
613         Encoding == dwarf::DW_ATE_unsigned_char ||
614         Encoding == dwarf::DW_ATE_boolean)
615       return true;
616   }
617   return false;
618 }
619
620 /// If this type is derived from a base type then return base type size.
621 static uint64_t getBaseTypeSize(DwarfDebug *DD, DIDerivedType Ty) {
622   unsigned Tag = Ty.getTag();
623
624   if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
625       Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
626       Tag != dwarf::DW_TAG_restrict_type)
627     return Ty.getSizeInBits();
628
629   DIType BaseType = DD->resolve(Ty.getTypeDerivedFrom());
630
631   // If this type is not derived from any type then take conservative approach.
632   if (!BaseType.isValid())
633     return Ty.getSizeInBits();
634
635   // If this is a derived type, go ahead and get the base type, unless it's a
636   // reference then it's just the size of the field. Pointer types have no need
637   // of this since they're a different type of qualification on the type.
638   if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
639       BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
640     return Ty.getSizeInBits();
641
642   if (BaseType.isDerivedType())
643     return getBaseTypeSize(DD, DIDerivedType(BaseType));
644
645   return BaseType.getSizeInBits();
646 }
647
648 /// addConstantValue - Add constant value entry in variable DIE.
649 void CompileUnit::addConstantValue(DIE *Die, const MachineOperand &MO,
650                                    DIType Ty) {
651   // FIXME: This is a bit conservative/simple - it emits negative values at
652   // their maximum bit width which is a bit unfortunate (& doesn't prefer
653   // udata/sdata over dataN as suggested by the DWARF spec)
654   assert(MO.isImm() && "Invalid machine operand!");
655   int SizeInBits = -1;
656   bool SignedConstant = isTypeSigned(DD, Ty, &SizeInBits);
657   uint16_t Form;
658
659   // If we're a signed constant definitely use sdata.
660   if (SignedConstant) {
661     addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, MO.getImm());
662     return;
663   }
664
665   // Else use data for now unless it's larger than we can deal with.
666   switch (SizeInBits) {
667   case 8:
668     Form = dwarf::DW_FORM_data1;
669     break;
670   case 16:
671     Form = dwarf::DW_FORM_data2;
672     break;
673   case 32:
674     Form = dwarf::DW_FORM_data4;
675     break;
676   case 64:
677     Form = dwarf::DW_FORM_data8;
678     break;
679   default:
680     Form = dwarf::DW_FORM_udata;
681     addUInt(Die, dwarf::DW_AT_const_value, Form, MO.getImm());
682     return;
683   }
684   addUInt(Die, dwarf::DW_AT_const_value, Form, MO.getImm());
685 }
686
687 /// addConstantFPValue - Add constant value entry in variable DIE.
688 void CompileUnit::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
689   assert (MO.isFPImm() && "Invalid machine operand!");
690   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
691   APFloat FPImm = MO.getFPImm()->getValueAPF();
692
693   // Get the raw data form of the floating point.
694   const APInt FltVal = FPImm.bitcastToAPInt();
695   const char *FltPtr = (const char*)FltVal.getRawData();
696
697   int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
698   bool LittleEndian = Asm->getDataLayout().isLittleEndian();
699   int Incr = (LittleEndian ? 1 : -1);
700   int Start = (LittleEndian ? 0 : NumBytes - 1);
701   int Stop = (LittleEndian ? NumBytes : -1);
702
703   // Output the constant to DWARF one byte at a time.
704   for (; Start != Stop; Start += Incr)
705     addUInt(Block, 0, dwarf::DW_FORM_data1,
706             (unsigned char)0xFF & FltPtr[Start]);
707
708   addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
709 }
710
711 /// addConstantFPValue - Add constant value entry in variable DIE.
712 void CompileUnit::addConstantFPValue(DIE *Die, const ConstantFP *CFP) {
713   // Pass this down to addConstantValue as an unsigned bag of bits.
714   addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), true);
715 }
716
717 /// addConstantValue - Add constant value entry in variable DIE.
718 void CompileUnit::addConstantValue(DIE *Die, const ConstantInt *CI,
719                                    bool Unsigned) {
720   addConstantValue(Die, CI->getValue(), Unsigned);
721 }
722
723 // addConstantValue - Add constant value entry in variable DIE.
724 void CompileUnit::addConstantValue(DIE *Die, const APInt &Val, bool Unsigned) {
725   unsigned CIBitWidth = Val.getBitWidth();
726   if (CIBitWidth <= 64) {
727     // If we're a signed constant definitely use sdata.
728     if (!Unsigned) {
729       addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
730               Val.getSExtValue());
731       return;
732     }
733
734     // Else use data for now unless it's larger than we can deal with.
735     uint16_t Form;
736     switch (CIBitWidth) {
737     case 8:
738       Form = dwarf::DW_FORM_data1;
739       break;
740     case 16:
741       Form = dwarf::DW_FORM_data2;
742       break;
743     case 32:
744       Form = dwarf::DW_FORM_data4;
745       break;
746     case 64:
747       Form = dwarf::DW_FORM_data8;
748       break;
749     default:
750       addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
751               Val.getZExtValue());
752       return;
753     }
754     addUInt(Die, dwarf::DW_AT_const_value, Form, Val.getZExtValue());
755     return;
756   }
757
758   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
759
760   // Get the raw data form of the large APInt.
761   const uint64_t *Ptr64 = Val.getRawData();
762
763   int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
764   bool LittleEndian = Asm->getDataLayout().isLittleEndian();
765
766   // Output the constant to DWARF one byte at a time.
767   for (int i = 0; i < NumBytes; i++) {
768     uint8_t c;
769     if (LittleEndian)
770       c = Ptr64[i / 8] >> (8 * (i & 7));
771     else
772       c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7));
773     addUInt(Block, 0, dwarf::DW_FORM_data1, c);
774   }
775
776   addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
777 }
778
779 /// addTemplateParams - Add template parameters into buffer.
780 void CompileUnit::addTemplateParams(DIE &Buffer, DIArray TParams) {
781   // Add template parameters.
782   for (unsigned i = 0, e = TParams.getNumElements(); i != e; ++i) {
783     DIDescriptor Element = TParams.getElement(i);
784     if (Element.isTemplateTypeParameter())
785       getOrCreateTemplateTypeParameterDIE(
786                         DITemplateTypeParameter(Element), Buffer);
787     else if (Element.isTemplateValueParameter())
788       getOrCreateTemplateValueParameterDIE(
789                         DITemplateValueParameter(Element), Buffer);
790   }
791 }
792
793 /// getOrCreateContextDIE - Get context owner's DIE.
794 DIE *CompileUnit::getOrCreateContextDIE(DIScope Context) {
795   if (Context.isType())
796     return getOrCreateTypeDIE(DIType(Context));
797   else if (Context.isNameSpace())
798     return getOrCreateNameSpace(DINameSpace(Context));
799   else if (Context.isSubprogram())
800     return getOrCreateSubprogramDIE(DISubprogram(Context));
801   else
802     return getDIE(Context);
803 }
804
805 /// addToContextOwner - Add Die into the list of its context owner's children.
806 void CompileUnit::addToContextOwner(DIE *Die, DIScope Context) {
807   assert(!Die->getParent());
808   if (DIE *ContextDIE = getOrCreateContextDIE(Context)) {
809     if (Die->getParent()) {
810       // While creating the context, if this is a type member, we will have
811       // added the child to the context already.
812       assert(Die->getParent() == ContextDIE);
813       return;
814     }
815     ContextDIE->addChild(Die);
816   } else
817     addDie(Die);
818 }
819
820 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
821 /// given DIType.
822 DIE *CompileUnit::getOrCreateTypeDIE(const MDNode *TyNode) {
823   DIType Ty(TyNode);
824   if (!Ty.isType())
825     return NULL;
826   DIE *TyDIE = getDIE(Ty);
827   if (TyDIE)
828     return TyDIE;
829
830   // Create new type.
831   TyDIE = new DIE(Ty.getTag());
832   insertDIE(Ty, TyDIE);
833   if (Ty.isBasicType())
834     constructTypeDIE(*TyDIE, DIBasicType(Ty));
835   else if (Ty.isCompositeType())
836     constructTypeDIE(*TyDIE, DICompositeType(Ty));
837   else {
838     assert(Ty.isDerivedType() && "Unknown kind of DIType");
839     constructTypeDIE(*TyDIE, DIDerivedType(Ty));
840   }
841   // If this is a named finished type then include it in the list of types
842   // for the accelerator tables.
843   if (!Ty.getName().empty() && !Ty.isForwardDecl()) {
844     bool IsImplementation = 0;
845     if (Ty.isCompositeType()) {
846       DICompositeType CT(Ty);
847       // A runtime language of 0 actually means C/C++ and that any
848       // non-negative value is some version of Objective-C/C++.
849       IsImplementation = (CT.getRunTimeLang() == 0) ||
850         CT.isObjcClassComplete();
851     }
852     unsigned Flags = IsImplementation ? dwarf::DW_FLAG_type_implementation : 0;
853     addAccelType(Ty.getName(), std::make_pair(TyDIE, Flags));
854   }
855
856   addToContextOwner(TyDIE, resolve(Ty.getContext()));
857   return TyDIE;
858 }
859
860 /// addType - Add a new type attribute to the specified entity.
861 void CompileUnit::addType(DIE *Entity, DIType Ty, uint16_t Attribute) {
862   assert(Ty && "Trying to add a type that doesn't exist?");
863
864   // Check for pre-existence.
865   DIEEntry *Entry = getDIEEntry(Ty);
866   // If it exists then use the existing value.
867   if (Entry) {
868     Entity->addValue(Attribute, dwarf::DW_FORM_ref4, Entry);
869     return;
870   }
871
872   // Construct type.
873   DIE *Buffer = getOrCreateTypeDIE(Ty);
874
875   // Set up proxy.
876   Entry = createDIEEntry(Buffer);
877   insertDIEEntry(Ty, Entry);
878   Entity->addValue(Attribute, dwarf::DW_FORM_ref4, Entry);
879
880   // If this is a complete composite type then include it in the
881   // list of global types.
882   addGlobalType(Ty);
883 }
884
885 // Accelerator table mutators - add each name along with its companion
886 // DIE to the proper table while ensuring that the name that we're going
887 // to reference is in the string table. We do this since the names we
888 // add may not only be identical to the names in the DIE.
889 void CompileUnit::addAccelName(StringRef Name, DIE *Die) {
890   DU->getStringPoolEntry(Name);
891   std::vector<DIE *> &DIEs = AccelNames[Name];
892   DIEs.push_back(Die);
893 }
894
895 void CompileUnit::addAccelObjC(StringRef Name, DIE *Die) {
896   DU->getStringPoolEntry(Name);
897   std::vector<DIE *> &DIEs = AccelObjC[Name];
898   DIEs.push_back(Die);
899 }
900
901 void CompileUnit::addAccelNamespace(StringRef Name, DIE *Die) {
902   DU->getStringPoolEntry(Name);
903   std::vector<DIE *> &DIEs = AccelNamespace[Name];
904   DIEs.push_back(Die);
905 }
906
907 void CompileUnit::addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die) {
908   DU->getStringPoolEntry(Name);
909   std::vector<std::pair<DIE *, unsigned> > &DIEs = AccelTypes[Name];
910   DIEs.push_back(Die);
911 }
912
913 /// addGlobalName - Add a new global name to the compile unit.
914 void CompileUnit::addGlobalName(StringRef Name, DIE *Die, DIScope Context) {
915   std::string FullName = getParentContextString(Context) + Name.str();
916   GlobalNames[FullName] = Die;
917 }
918
919 /// addGlobalType - Add a new global type to the compile unit.
920 ///
921 void CompileUnit::addGlobalType(DIType Ty) {
922   DIScope Context = resolve(Ty.getContext());
923   if (!Ty.getName().empty() && !Ty.isForwardDecl() &&
924       (!Context || Context.isCompileUnit() || Context.isFile() ||
925        Context.isNameSpace()))
926     if (DIEEntry *Entry = getDIEEntry(Ty)) {
927       std::string FullName =
928           getParentContextString(Context) + Ty.getName().str();
929        GlobalTypes[FullName] = Entry->getEntry();
930     }
931 }
932
933 /// getParentContextString - Walks the metadata parent chain in a language
934 /// specific manner (using the compile unit language) and returns
935 /// it as a string. This is done at the metadata level because DIEs may
936 /// not currently have been added to the parent context and walking the
937 /// DIEs looking for names is more expensive than walking the metadata.
938 std::string CompileUnit::getParentContextString(DIScope Context) const {
939   if (!Context)
940     return "";
941
942   // FIXME: Decide whether to implement this for non-C++ languages.
943   if (getLanguage() != dwarf::DW_LANG_C_plus_plus)
944     return "";
945
946   std::string CS;
947   SmallVector<DIScope, 1> Parents;
948   while (!Context.isCompileUnit()) {
949     Parents.push_back(Context);
950     if (Context.getContext())
951       Context = resolve(Context.getContext());
952     else
953       // Structure, etc types will have a NULL context if they're at the top
954       // level.
955       break;
956   }
957
958   // Reverse iterate over our list to go from the outermost construct to the
959   // innermost.
960   for (SmallVectorImpl<DIScope>::reverse_iterator I = Parents.rbegin(),
961                                                   E = Parents.rend();
962        I != E; ++I) {
963     DIScope Ctx = *I;
964     StringRef Name = Ctx.getName();
965     if (!Name.empty()) {
966       CS += Name;
967       CS += "::";
968     }
969   }
970   return CS;
971 }
972
973 /// addPubTypes - Add subprogram argument types for pubtypes section.
974 void CompileUnit::addPubTypes(DISubprogram SP) {
975   DICompositeType SPTy = SP.getType();
976   uint16_t SPTag = SPTy.getTag();
977   if (SPTag != dwarf::DW_TAG_subroutine_type)
978     return;
979
980   DIArray Args = SPTy.getTypeArray();
981   for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
982     DIType ATy(Args.getElement(i));
983     if (!ATy.isType())
984       continue;
985     addGlobalType(ATy);
986   }
987 }
988
989 /// constructTypeDIE - Construct basic type die from DIBasicType.
990 void CompileUnit::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
991   // Get core information.
992   StringRef Name = BTy.getName();
993   // Add name if not anonymous or intermediate type.
994   if (!Name.empty())
995     addString(&Buffer, dwarf::DW_AT_name, Name);
996
997   // An unspecified type only has a name attribute.
998   if (BTy.getTag() == dwarf::DW_TAG_unspecified_type)
999     return;
1000
1001   addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1002           BTy.getEncoding());
1003
1004   uint64_t Size = BTy.getSizeInBits() >> 3;
1005   addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
1006 }
1007
1008 /// constructTypeDIE - Construct derived type die from DIDerivedType.
1009 void CompileUnit::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
1010   // Get core information.
1011   StringRef Name = DTy.getName();
1012   uint64_t Size = DTy.getSizeInBits() >> 3;
1013   uint16_t Tag = Buffer.getTag();
1014
1015   // Map to main type, void will not have a type.
1016   DIType FromTy = resolve(DTy.getTypeDerivedFrom());
1017   if (FromTy)
1018     addType(&Buffer, FromTy);
1019
1020   // Add name if not anonymous or intermediate type.
1021   if (!Name.empty())
1022     addString(&Buffer, dwarf::DW_AT_name, Name);
1023
1024   // Add size if non-zero (derived types might be zero-sized.)
1025   if (Size && Tag != dwarf::DW_TAG_pointer_type)
1026     addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
1027
1028   if (Tag == dwarf::DW_TAG_ptr_to_member_type)
1029       addDIEEntry(&Buffer, dwarf::DW_AT_containing_type,
1030                   getOrCreateTypeDIE(resolve(DTy.getClassType())));
1031   // Add source line info if available and TyDesc is not a forward declaration.
1032   if (!DTy.isForwardDecl())
1033     addSourceLine(&Buffer, DTy);
1034 }
1035
1036 /// Return true if the type is appropriately scoped to be contained inside
1037 /// its own type unit.
1038 static bool isTypeUnitScoped(DIType Ty, const DwarfDebug *DD) {
1039   DIScope Parent = DD->resolve(Ty.getContext());
1040   while (Parent) {
1041     // Don't generate a hash for anything scoped inside a function.
1042     if (Parent.isSubprogram())
1043       return false;
1044     Parent = DD->resolve(Parent.getContext());
1045   }
1046   return true;
1047 }
1048
1049 /// Return true if the type should be split out into a type unit.
1050 static bool shouldCreateTypeUnit(DICompositeType CTy, const DwarfDebug *DD) {
1051   uint16_t Tag = CTy.getTag();
1052
1053   switch (Tag) {
1054   case dwarf::DW_TAG_structure_type:
1055   case dwarf::DW_TAG_union_type:
1056   case dwarf::DW_TAG_enumeration_type:
1057   case dwarf::DW_TAG_class_type:
1058     // If this is a class, structure, union, or enumeration type
1059     // that is a definition (not a declaration), and not scoped
1060     // inside a function then separate this out as a type unit.
1061     return !CTy.isForwardDecl() && isTypeUnitScoped(CTy, DD);
1062   default:
1063     return false;
1064   }
1065 }
1066
1067 /// constructTypeDIE - Construct type DIE from DICompositeType.
1068 void CompileUnit::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
1069   // Get core information.
1070   StringRef Name = CTy.getName();
1071
1072   uint64_t Size = CTy.getSizeInBits() >> 3;
1073   uint16_t Tag = Buffer.getTag();
1074
1075   switch (Tag) {
1076   case dwarf::DW_TAG_array_type:
1077     constructArrayTypeDIE(Buffer, &CTy);
1078     break;
1079   case dwarf::DW_TAG_enumeration_type: {
1080     DIArray Elements = CTy.getTypeArray();
1081
1082     // Add enumerators to enumeration type.
1083     for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1084       DIE *ElemDie = NULL;
1085       DIDescriptor Enum(Elements.getElement(i));
1086       if (Enum.isEnumerator())
1087         ElemDie = constructEnumTypeDIE(DIEnumerator(Enum), Buffer);
1088     }
1089     DIType DTy = resolve(CTy.getTypeDerivedFrom());
1090     if (DTy) {
1091       addType(&Buffer, DTy);
1092       addFlag(&Buffer, dwarf::DW_AT_enum_class);
1093     }
1094   }
1095     break;
1096   case dwarf::DW_TAG_subroutine_type: {
1097     // Add return type. A void return won't have a type.
1098     DIArray Elements = CTy.getTypeArray();
1099     DIDescriptor RTy = Elements.getElement(0);
1100     if (RTy)
1101       addType(&Buffer, DIType(RTy));
1102
1103     bool isPrototyped = true;
1104     // Add arguments.
1105     for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1106       DIDescriptor Ty = Elements.getElement(i);
1107       if (Ty.isUnspecifiedParameter()) {
1108         DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1109         Buffer.addChild(Arg);
1110         isPrototyped = false;
1111       } else {
1112         DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1113         addType(Arg, DIType(Ty));
1114         if (DIType(Ty).isArtificial())
1115           addFlag(Arg, dwarf::DW_AT_artificial);
1116         Buffer.addChild(Arg);
1117       }
1118     }
1119     // Add prototype flag if we're dealing with a C language and the
1120     // function has been prototyped.
1121     uint16_t Language = DICompileUnit(Node).getLanguage();
1122     if (isPrototyped &&
1123         (Language == dwarf::DW_LANG_C89 ||
1124          Language == dwarf::DW_LANG_C99 ||
1125          Language == dwarf::DW_LANG_ObjC))
1126       addFlag(&Buffer, dwarf::DW_AT_prototyped);
1127   }
1128     break;
1129   case dwarf::DW_TAG_structure_type:
1130   case dwarf::DW_TAG_union_type:
1131   case dwarf::DW_TAG_class_type: {
1132     // Add elements to structure type.
1133     DIArray Elements = CTy.getTypeArray();
1134     for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1135       DIDescriptor Element = Elements.getElement(i);
1136       DIE *ElemDie = NULL;
1137       if (Element.isSubprogram()) {
1138         DISubprogram SP(Element);
1139         ElemDie = getOrCreateSubprogramDIE(DISubprogram(Element));
1140         if (SP.isProtected())
1141           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1142                   dwarf::DW_ACCESS_protected);
1143         else if (SP.isPrivate())
1144           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1145                   dwarf::DW_ACCESS_private);
1146         else
1147           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1148             dwarf::DW_ACCESS_public);
1149         if (SP.isExplicit())
1150           addFlag(ElemDie, dwarf::DW_AT_explicit);
1151       } else if (Element.isDerivedType()) {
1152         DIDerivedType DDTy(Element);
1153         if (DDTy.getTag() == dwarf::DW_TAG_friend) {
1154           ElemDie = new DIE(dwarf::DW_TAG_friend);
1155           addType(ElemDie, resolve(DDTy.getTypeDerivedFrom()),
1156                   dwarf::DW_AT_friend);
1157           Buffer.addChild(ElemDie);
1158         } else if (DDTy.isStaticMember()) {
1159           ElemDie = getOrCreateStaticMemberDIE(DDTy);
1160         } else {
1161           ElemDie = createMemberDIE(DDTy, Buffer);
1162         }
1163       } else if (Element.isObjCProperty()) {
1164         DIObjCProperty Property(Element);
1165         ElemDie = new DIE(Property.getTag());
1166         StringRef PropertyName = Property.getObjCPropertyName();
1167         addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
1168         addType(ElemDie, Property.getType());
1169         addSourceLine(ElemDie, Property);
1170         StringRef GetterName = Property.getObjCPropertyGetterName();
1171         if (!GetterName.empty())
1172           addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
1173         StringRef SetterName = Property.getObjCPropertySetterName();
1174         if (!SetterName.empty())
1175           addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
1176         unsigned PropertyAttributes = 0;
1177         if (Property.isReadOnlyObjCProperty())
1178           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readonly;
1179         if (Property.isReadWriteObjCProperty())
1180           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readwrite;
1181         if (Property.isAssignObjCProperty())
1182           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_assign;
1183         if (Property.isRetainObjCProperty())
1184           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_retain;
1185         if (Property.isCopyObjCProperty())
1186           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_copy;
1187         if (Property.isNonAtomicObjCProperty())
1188           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_nonatomic;
1189         if (PropertyAttributes)
1190           addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, 0,
1191                  PropertyAttributes);
1192
1193         DIEEntry *Entry = getDIEEntry(Element);
1194         if (!Entry) {
1195           Entry = createDIEEntry(ElemDie);
1196           insertDIEEntry(Element, Entry);
1197         }
1198         Buffer.addChild(ElemDie);
1199       } else
1200         continue;
1201     }
1202
1203     if (CTy.isAppleBlockExtension())
1204       addFlag(&Buffer, dwarf::DW_AT_APPLE_block);
1205
1206     DICompositeType ContainingType(resolve(CTy.getContainingType()));
1207     if (DIDescriptor(ContainingType).isCompositeType())
1208       addDIEEntry(&Buffer, dwarf::DW_AT_containing_type,
1209                   getOrCreateTypeDIE(DIType(ContainingType)));
1210
1211     if (CTy.isObjcClassComplete())
1212       addFlag(&Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
1213
1214     // Add template parameters to a class, structure or union types.
1215     // FIXME: The support isn't in the metadata for this yet.
1216     if (Tag == dwarf::DW_TAG_class_type ||
1217         Tag == dwarf::DW_TAG_structure_type ||
1218         Tag == dwarf::DW_TAG_union_type)
1219       addTemplateParams(Buffer, CTy.getTemplateParams());
1220
1221     break;
1222   }
1223   default:
1224     break;
1225   }
1226
1227   // Add name if not anonymous or intermediate type.
1228   if (!Name.empty())
1229     addString(&Buffer, dwarf::DW_AT_name, Name);
1230
1231   if (Tag == dwarf::DW_TAG_enumeration_type ||
1232       Tag == dwarf::DW_TAG_class_type ||
1233       Tag == dwarf::DW_TAG_structure_type ||
1234       Tag == dwarf::DW_TAG_union_type) {
1235     // Add size if non-zero (derived types might be zero-sized.)
1236     // TODO: Do we care about size for enum forward declarations?
1237     if (Size)
1238       addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
1239     else if (!CTy.isForwardDecl())
1240       // Add zero size if it is not a forward declaration.
1241       addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
1242
1243     // If we're a forward decl, say so.
1244     if (CTy.isForwardDecl())
1245       addFlag(&Buffer, dwarf::DW_AT_declaration);
1246
1247     // Add source line info if available.
1248     if (!CTy.isForwardDecl())
1249       addSourceLine(&Buffer, CTy);
1250
1251     // No harm in adding the runtime language to the declaration.
1252     unsigned RLang = CTy.getRunTimeLang();
1253     if (RLang)
1254       addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
1255               dwarf::DW_FORM_data1, RLang);
1256   }
1257   // If this is a type applicable to a type unit it then add it to the
1258   // list of types we'll compute a hash for later.
1259   if (shouldCreateTypeUnit(CTy, DD))
1260     DD->addTypeUnitType(&Buffer);
1261 }
1262
1263 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
1264 /// for the given DITemplateTypeParameter.
1265 DIE *
1266 CompileUnit::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP,
1267                                                  DIE &Buffer) {
1268   DIE *ParamDIE = getDIE(TP);
1269   if (ParamDIE)
1270     return ParamDIE;
1271
1272   ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
1273   Buffer.addChild(ParamDIE);
1274   // Add the type if it exists, it could be void and therefore no type.
1275   if (TP.getType())
1276     addType(ParamDIE, resolve(TP.getType()));
1277   if (!TP.getName().empty())
1278     addString(ParamDIE, dwarf::DW_AT_name, TP.getName());
1279   return ParamDIE;
1280 }
1281
1282 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
1283 /// for the given DITemplateValueParameter.
1284 DIE *
1285 CompileUnit::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter VP,
1286                                                   DIE &Buffer) {
1287   DIE *ParamDIE = getDIE(VP);
1288   if (ParamDIE)
1289     return ParamDIE;
1290
1291   ParamDIE = new DIE(VP.getTag());
1292   Buffer.addChild(ParamDIE);
1293
1294   // Add the type if there is one, template template and template parameter
1295   // packs will not have a type.
1296   if (VP.getType())
1297     addType(ParamDIE, resolve(VP.getType()));
1298   if (!VP.getName().empty())
1299     addString(ParamDIE, dwarf::DW_AT_name, VP.getName());
1300   if (Value *Val = VP.getValue()) {
1301     if (ConstantInt *CI = dyn_cast<ConstantInt>(Val))
1302       addConstantValue(ParamDIE, CI,
1303                        isUnsignedDIType(DD, resolve(VP.getType())));
1304     else if (GlobalValue *GV = dyn_cast<GlobalValue>(Val)) {
1305       // For declaration non-type template parameters (such as global values and
1306       // functions)
1307       DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1308       addOpAddress(Block, Asm->Mang->getSymbol(GV));
1309       // Emit DW_OP_stack_value to use the address as the immediate value of the
1310       // parameter, rather than a pointer to it.
1311       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1312       addBlock(ParamDIE, dwarf::DW_AT_location, 0, Block);
1313     } else if (VP.getTag() == dwarf::DW_TAG_GNU_template_template_param) {
1314       assert(isa<MDString>(Val));
1315       addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1316                 cast<MDString>(Val)->getString());
1317     } else if (VP.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
1318       assert(isa<MDNode>(Val));
1319       DIArray A(cast<MDNode>(Val));
1320       addTemplateParams(*ParamDIE, A);
1321     }
1322   }
1323
1324   return ParamDIE;
1325 }
1326
1327 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
1328 DIE *CompileUnit::getOrCreateNameSpace(DINameSpace NS) {
1329   DIE *NDie = getDIE(NS);
1330   if (NDie)
1331     return NDie;
1332   NDie = new DIE(dwarf::DW_TAG_namespace);
1333   insertDIE(NS, NDie);
1334   if (!NS.getName().empty()) {
1335     addString(NDie, dwarf::DW_AT_name, NS.getName());
1336     addAccelNamespace(NS.getName(), NDie);
1337     addGlobalName(NS.getName(), NDie, NS.getContext());
1338   } else
1339     addAccelNamespace("(anonymous namespace)", NDie);
1340   addSourceLine(NDie, NS);
1341   addToContextOwner(NDie, NS.getContext());
1342   return NDie;
1343 }
1344
1345 /// getOrCreateSubprogramDIE - Create new DIE using SP.
1346 DIE *CompileUnit::getOrCreateSubprogramDIE(DISubprogram SP) {
1347   // Construct the context before querying for the existence of the DIE in case
1348   // such construction creates the DIE (as is the case for member function
1349   // declarations).
1350   DIE *ContextDIE = getOrCreateContextDIE(resolve(SP.getContext()));
1351   if (!ContextDIE)
1352     ContextDIE = CUDie.get();
1353
1354   DIE *SPDie = getDIE(SP);
1355   if (SPDie)
1356     return SPDie;
1357
1358   SPDie = new DIE(dwarf::DW_TAG_subprogram);
1359
1360   // DW_TAG_inlined_subroutine may refer to this DIE.
1361   insertDIE(SP, SPDie);
1362
1363   DISubprogram SPDecl = SP.getFunctionDeclaration();
1364   DIE *DeclDie = NULL;
1365   if (SPDecl.isSubprogram()) {
1366     DeclDie = getOrCreateSubprogramDIE(SPDecl);
1367   }
1368
1369   // Add function template parameters.
1370   addTemplateParams(*SPDie, SP.getTemplateParams());
1371
1372   // If this DIE is going to refer declaration info using AT_specification
1373   // then there is no need to add other attributes.
1374   if (DeclDie) {
1375     // Refer function declaration directly.
1376     addDIEEntry(SPDie, dwarf::DW_AT_specification, DeclDie);
1377
1378     // Add subprogram definitions to the CU die directly.
1379     addDie(SPDie);
1380
1381     return SPDie;
1382   }
1383
1384   // Add to context owner.
1385   ContextDIE->addChild(SPDie);
1386
1387   // Add the linkage name if we have one.
1388   StringRef LinkageName = SP.getLinkageName();
1389   if (!LinkageName.empty())
1390     addString(SPDie, dwarf::DW_AT_MIPS_linkage_name,
1391               GlobalValue::getRealLinkageName(LinkageName));
1392
1393   // Constructors and operators for anonymous aggregates do not have names.
1394   if (!SP.getName().empty())
1395     addString(SPDie, dwarf::DW_AT_name, SP.getName());
1396
1397   addSourceLine(SPDie, SP);
1398
1399   // Add the prototype if we have a prototype and we have a C like
1400   // language.
1401   uint16_t Language = DICompileUnit(Node).getLanguage();
1402   if (SP.isPrototyped() &&
1403       (Language == dwarf::DW_LANG_C89 ||
1404        Language == dwarf::DW_LANG_C99 ||
1405        Language == dwarf::DW_LANG_ObjC))
1406     addFlag(SPDie, dwarf::DW_AT_prototyped);
1407
1408   // Add Return Type. A void return type will not have a type.
1409   DICompositeType SPTy = SP.getType();
1410   assert(SPTy.getTag() == dwarf::DW_TAG_subroutine_type &&
1411          "the type of a subprogram should be a subroutine");
1412
1413   DIArray Args = SPTy.getTypeArray();
1414   if (Args.getElement(0))
1415     addType(SPDie, DIType(Args.getElement(0)));
1416
1417   unsigned VK = SP.getVirtuality();
1418   if (VK) {
1419     addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
1420     DIEBlock *Block = getDIEBlock();
1421     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1422     addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
1423     addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
1424     ContainingTypeMap.insert(std::make_pair(SPDie,
1425                                             resolve(SP.getContainingType())));
1426   }
1427
1428   if (!SP.isDefinition()) {
1429     addFlag(SPDie, dwarf::DW_AT_declaration);
1430
1431     // Add arguments. Do not add arguments for subprogram definition. They will
1432     // be handled while processing variables.
1433     for (unsigned i = 1, N =  Args.getNumElements(); i < N; ++i) {
1434       DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1435       DIType ATy = DIType(Args.getElement(i));
1436       addType(Arg, ATy);
1437       if (ATy.isArtificial())
1438         addFlag(Arg, dwarf::DW_AT_artificial);
1439       SPDie->addChild(Arg);
1440     }
1441   }
1442
1443   if (SP.isArtificial())
1444     addFlag(SPDie, dwarf::DW_AT_artificial);
1445
1446   if (!SP.isLocalToUnit())
1447     addFlag(SPDie, dwarf::DW_AT_external);
1448
1449   if (SP.isOptimized())
1450     addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
1451
1452   if (unsigned isa = Asm->getISAEncoding()) {
1453     addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1454   }
1455
1456   return SPDie;
1457 }
1458
1459 // Return const expression if value is a GEP to access merged global
1460 // constant. e.g.
1461 // i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
1462 static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
1463   const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
1464   if (!CE || CE->getNumOperands() != 3 ||
1465       CE->getOpcode() != Instruction::GetElementPtr)
1466     return NULL;
1467
1468   // First operand points to a global struct.
1469   Value *Ptr = CE->getOperand(0);
1470   if (!isa<GlobalValue>(Ptr) ||
1471       !isa<StructType>(cast<PointerType>(Ptr->getType())->getElementType()))
1472     return NULL;
1473
1474   // Second operand is zero.
1475   const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
1476   if (!CI || !CI->isZero())
1477     return NULL;
1478
1479   // Third operand is offset.
1480   if (!isa<ConstantInt>(CE->getOperand(2)))
1481     return NULL;
1482
1483   return CE;
1484 }
1485
1486 /// createGlobalVariableDIE - create global variable DIE.
1487 void CompileUnit::createGlobalVariableDIE(const MDNode *N) {
1488   // Check for pre-existence.
1489   if (getDIE(N))
1490     return;
1491
1492   DIGlobalVariable GV(N);
1493   if (!GV.isGlobalVariable())
1494     return;
1495
1496   DIScope GVContext = GV.getContext();
1497   DIType GTy = GV.getType();
1498
1499   // If this is a static data member definition, some attributes belong
1500   // to the declaration DIE.
1501   DIE *VariableDIE = NULL;
1502   bool IsStaticMember = false;
1503   DIDerivedType SDMDecl = GV.getStaticDataMemberDeclaration();
1504   if (SDMDecl.Verify()) {
1505     assert(SDMDecl.isStaticMember() && "Expected static member decl");
1506     // We need the declaration DIE that is in the static member's class.
1507     VariableDIE = getOrCreateStaticMemberDIE(SDMDecl);
1508     IsStaticMember = true;
1509   }
1510
1511   // If this is not a static data member definition, create the variable
1512   // DIE and add the initial set of attributes to it.
1513   if (!VariableDIE) {
1514     VariableDIE = new DIE(GV.getTag());
1515     // Add to map.
1516     insertDIE(N, VariableDIE);
1517
1518     // Add name and type.
1519     addString(VariableDIE, dwarf::DW_AT_name, GV.getDisplayName());
1520     addType(VariableDIE, GTy);
1521
1522     // Add scoping info.
1523     if (!GV.isLocalToUnit())
1524       addFlag(VariableDIE, dwarf::DW_AT_external);
1525
1526     // Add line number info.
1527     addSourceLine(VariableDIE, GV);
1528     // Add to context owner.
1529     addToContextOwner(VariableDIE, GVContext);
1530   }
1531
1532   // Add location.
1533   bool addToAccelTable = false;
1534   DIE *VariableSpecDIE = NULL;
1535   bool isGlobalVariable = GV.getGlobal() != NULL;
1536   if (isGlobalVariable) {
1537     addToAccelTable = true;
1538     DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1539     const MCSymbol *Sym = Asm->Mang->getSymbol(GV.getGlobal());
1540     if (GV.getGlobal()->isThreadLocal()) {
1541       // FIXME: Make this work with -gsplit-dwarf.
1542       unsigned PointerSize = Asm->getDataLayout().getPointerSize();
1543       assert((PointerSize == 4 || PointerSize == 8) &&
1544              "Add support for other sizes if necessary");
1545       const MCExpr *Expr =
1546           Asm->getObjFileLowering().getDebugThreadLocalSymbol(Sym);
1547       // Based on GCC's support for TLS:
1548       if (!DD->useSplitDwarf()) {
1549         // 1) Start with a constNu of the appropriate pointer size
1550         addUInt(Block, 0, dwarf::DW_FORM_data1,
1551                 PointerSize == 4 ? dwarf::DW_OP_const4u : dwarf::DW_OP_const8u);
1552         // 2) containing the (relocated) offset of the TLS variable
1553         //    within the module's TLS block.
1554         addExpr(Block, 0, dwarf::DW_FORM_udata, Expr);
1555       } else {
1556         addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_const_index);
1557         addUInt(Block, 0, dwarf::DW_FORM_udata, DU->getAddrPoolIndex(Expr));
1558       }
1559       // 3) followed by a custom OP to make the debugger do a TLS lookup.
1560       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_push_tls_address);
1561     } else
1562       addOpAddress(Block, Sym);
1563     // Do not create specification DIE if context is either compile unit
1564     // or a subprogram.
1565     if (GVContext && GV.isDefinition() && !GVContext.isCompileUnit() &&
1566         !GVContext.isFile() && !DD->isSubprogramContext(GVContext)) {
1567       // Create specification DIE.
1568       VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1569       addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification, VariableDIE);
1570       addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1571       // A static member's declaration is already flagged as such.
1572       if (!SDMDecl.Verify())
1573         addFlag(VariableDIE, dwarf::DW_AT_declaration);
1574       addDie(VariableSpecDIE);
1575     } else {
1576       addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1577     }
1578     // Add the linkage name.
1579     StringRef LinkageName = GV.getLinkageName();
1580     if (!LinkageName.empty())
1581       // From DWARF4: DIEs to which DW_AT_linkage_name may apply include:
1582       // TAG_common_block, TAG_constant, TAG_entry_point, TAG_subprogram and
1583       // TAG_variable.
1584       addString(IsStaticMember && VariableSpecDIE ?
1585                 VariableSpecDIE : VariableDIE, dwarf::DW_AT_MIPS_linkage_name,
1586                 GlobalValue::getRealLinkageName(LinkageName));
1587   } else if (const ConstantInt *CI =
1588              dyn_cast_or_null<ConstantInt>(GV.getConstant())) {
1589     // AT_const_value was added when the static member was created. To avoid
1590     // emitting AT_const_value multiple times, we only add AT_const_value when
1591     // it is not a static member.
1592     if (!IsStaticMember)
1593       addConstantValue(VariableDIE, CI, isUnsignedDIType(DD, GTy));
1594   } else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
1595     addToAccelTable = true;
1596     // GV is a merged global.
1597     DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1598     Value *Ptr = CE->getOperand(0);
1599     addOpAddress(Block, Asm->Mang->getSymbol(cast<GlobalValue>(Ptr)));
1600     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1601     SmallVector<Value*, 3> Idx(CE->op_begin()+1, CE->op_end());
1602     addUInt(Block, 0, dwarf::DW_FORM_udata,
1603                    Asm->getDataLayout().getIndexedOffset(Ptr->getType(), Idx));
1604     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1605     addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1606   }
1607
1608   if (addToAccelTable) {
1609     DIE *AddrDIE = VariableSpecDIE ? VariableSpecDIE : VariableDIE;
1610     addAccelName(GV.getName(), AddrDIE);
1611
1612     // If the linkage name is different than the name, go ahead and output
1613     // that as well into the name table.
1614     if (GV.getLinkageName() != "" && GV.getName() != GV.getLinkageName())
1615       addAccelName(GV.getLinkageName(), AddrDIE);
1616   }
1617
1618   if (!GV.isLocalToUnit())
1619     addGlobalName(GV.getName(), VariableSpecDIE ? VariableSpecDIE : VariableDIE,
1620                   GV.getContext());
1621 }
1622
1623 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1624 void CompileUnit::constructSubrangeDIE(DIE &Buffer, DISubrange SR,
1625                                        DIE *IndexTy) {
1626   DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1627   addDIEEntry(DW_Subrange, dwarf::DW_AT_type, IndexTy);
1628
1629   // The LowerBound value defines the lower bounds which is typically zero for
1630   // C/C++. The Count value is the number of elements.  Values are 64 bit. If
1631   // Count == -1 then the array is unbounded and we do not emit
1632   // DW_AT_lower_bound and DW_AT_upper_bound attributes. If LowerBound == 0 and
1633   // Count == 0, then the array has zero elements in which case we do not emit
1634   // an upper bound.
1635   int64_t LowerBound = SR.getLo();
1636   int64_t DefaultLowerBound = getDefaultLowerBound();
1637   int64_t Count = SR.getCount();
1638
1639   if (DefaultLowerBound == -1 || LowerBound != DefaultLowerBound)
1640     addUInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, LowerBound);
1641
1642   if (Count != -1 && Count != 0)
1643     // FIXME: An unbounded array should reference the expression that defines
1644     // the array.
1645     addUInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, LowerBound + Count - 1);
1646
1647   Buffer.addChild(DW_Subrange);
1648 }
1649
1650 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
1651 void CompileUnit::constructArrayTypeDIE(DIE &Buffer,
1652                                         DICompositeType *CTy) {
1653   if (CTy->isVector())
1654     addFlag(&Buffer, dwarf::DW_AT_GNU_vector);
1655
1656   // Emit the element type.
1657   addType(&Buffer, resolve(CTy->getTypeDerivedFrom()));
1658
1659   // Get an anonymous type for index type.
1660   // FIXME: This type should be passed down from the front end
1661   // as different languages may have different sizes for indexes.
1662   DIE *IdxTy = getIndexTyDie();
1663   if (!IdxTy) {
1664     // Construct an anonymous type for index type.
1665     IdxTy = new DIE(dwarf::DW_TAG_base_type);
1666     addString(IdxTy, dwarf::DW_AT_name, "int");
1667     addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1668     addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1669             dwarf::DW_ATE_signed);
1670     addDie(IdxTy);
1671     setIndexTyDie(IdxTy);
1672   }
1673
1674   // Add subranges to array type.
1675   DIArray Elements = CTy->getTypeArray();
1676   for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1677     DIDescriptor Element = Elements.getElement(i);
1678     if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1679       constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
1680   }
1681 }
1682
1683 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
1684 DIE *CompileUnit::constructEnumTypeDIE(DIEnumerator ETy, DIE &Buffer) {
1685   DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
1686   Buffer.addChild(Enumerator);
1687   StringRef Name = ETy.getName();
1688   addString(Enumerator, dwarf::DW_AT_name, Name);
1689   int64_t Value = ETy.getEnumValue();
1690   addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
1691   return Enumerator;
1692 }
1693
1694 /// constructContainingTypeDIEs - Construct DIEs for types that contain
1695 /// vtables.
1696 void CompileUnit::constructContainingTypeDIEs() {
1697   for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
1698          CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1699     DIE *SPDie = CI->first;
1700     const MDNode *N = CI->second;
1701     if (!N) continue;
1702     DIE *NDie = getDIE(N);
1703     if (!NDie) continue;
1704     addDIEEntry(SPDie, dwarf::DW_AT_containing_type, NDie);
1705   }
1706 }
1707
1708 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
1709 DIE *CompileUnit::constructVariableDIE(DbgVariable *DV,
1710                                        bool isScopeAbstract) {
1711   StringRef Name = DV->getName();
1712
1713   // Define variable debug information entry.
1714   DIE *VariableDie = new DIE(DV->getTag());
1715   DbgVariable *AbsVar = DV->getAbstractVariable();
1716   DIE *AbsDIE = AbsVar ? AbsVar->getDIE() : NULL;
1717   if (AbsDIE)
1718     addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin, AbsDIE);
1719   else {
1720     if (!Name.empty())
1721       addString(VariableDie, dwarf::DW_AT_name, Name);
1722     addSourceLine(VariableDie, DV->getVariable());
1723     addType(VariableDie, DV->getType());
1724   }
1725
1726   if (DV->isArtificial())
1727     addFlag(VariableDie, dwarf::DW_AT_artificial);
1728
1729   if (isScopeAbstract) {
1730     DV->setDIE(VariableDie);
1731     return VariableDie;
1732   }
1733
1734   // Add variable address.
1735
1736   unsigned Offset = DV->getDotDebugLocOffset();
1737   if (Offset != ~0U) {
1738     addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1739              Asm->GetTempSymbol("debug_loc", Offset));
1740     DV->setDIE(VariableDie);
1741     return VariableDie;
1742   }
1743
1744   // Check if variable is described by a DBG_VALUE instruction.
1745   if (const MachineInstr *DVInsn = DV->getMInsn()) {
1746     assert(DVInsn->getNumOperands() == 3);
1747     if (DVInsn->getOperand(0).isReg()) {
1748       const MachineOperand RegOp = DVInsn->getOperand(0);
1749       // If the second operand is an immediate, this is an indirect value.
1750       if (DVInsn->getOperand(1).isImm()) {
1751         MachineLocation Location(RegOp.getReg(), DVInsn->getOperand(1).getImm());
1752         addVariableAddress(*DV, VariableDie, Location);
1753       } else if (RegOp.getReg())
1754         addVariableAddress(*DV, VariableDie, MachineLocation(RegOp.getReg()));
1755     } else if (DVInsn->getOperand(0).isImm())
1756       addConstantValue(VariableDie, DVInsn->getOperand(0), DV->getType());
1757     else if (DVInsn->getOperand(0).isFPImm())
1758       addConstantFPValue(VariableDie, DVInsn->getOperand(0));
1759     else if (DVInsn->getOperand(0).isCImm())
1760       addConstantValue(VariableDie, DVInsn->getOperand(0).getCImm(),
1761                        isUnsignedDIType(DD, DV->getType()));
1762
1763     DV->setDIE(VariableDie);
1764     return VariableDie;
1765   } else {
1766     // .. else use frame index.
1767     int FI = DV->getFrameIndex();
1768     if (FI != ~0) {
1769       unsigned FrameReg = 0;
1770       const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
1771       int Offset =
1772         TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1773       MachineLocation Location(FrameReg, Offset);
1774       addVariableAddress(*DV, VariableDie, Location);
1775     }
1776   }
1777
1778   DV->setDIE(VariableDie);
1779   return VariableDie;
1780 }
1781
1782 /// createMemberDIE - Create new member DIE.
1783 DIE *CompileUnit::createMemberDIE(DIDerivedType DT, DIE &Buffer) {
1784   DIE *MemberDie = new DIE(DT.getTag());
1785   Buffer.addChild(MemberDie);
1786   StringRef Name = DT.getName();
1787   if (!Name.empty())
1788     addString(MemberDie, dwarf::DW_AT_name, Name);
1789
1790   addType(MemberDie, resolve(DT.getTypeDerivedFrom()));
1791
1792   addSourceLine(MemberDie, DT);
1793
1794   DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
1795   addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1796
1797   uint64_t Size = DT.getSizeInBits();
1798   uint64_t FieldSize = getBaseTypeSize(DD, DT);
1799
1800   if (Size != FieldSize) {
1801     // Handle bitfield.
1802     addUInt(MemberDie, dwarf::DW_AT_byte_size, 0,
1803             getBaseTypeSize(DD, DT)>>3);
1804     addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
1805
1806     uint64_t Offset = DT.getOffsetInBits();
1807     uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1808     uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1809     uint64_t FieldOffset = (HiMark - FieldSize);
1810     Offset -= FieldOffset;
1811
1812     // Maybe we need to work from the other end.
1813     if (Asm->getDataLayout().isLittleEndian())
1814       Offset = FieldSize - (Offset + Size);
1815     addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
1816
1817     // Here WD_AT_data_member_location points to the anonymous
1818     // field that includes this bit field.
1819     addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
1820
1821   } else
1822     // This is not a bitfield.
1823     addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
1824
1825   if (DT.getTag() == dwarf::DW_TAG_inheritance
1826       && DT.isVirtual()) {
1827
1828     // For C++, virtual base classes are not at fixed offset. Use following
1829     // expression to extract appropriate offset from vtable.
1830     // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1831
1832     DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
1833     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1834     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1835     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1836     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1837     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1838     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1839     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1840
1841     addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
1842              VBaseLocationDie);
1843   } else
1844     addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
1845
1846   if (DT.isProtected())
1847     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1848             dwarf::DW_ACCESS_protected);
1849   else if (DT.isPrivate())
1850     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1851             dwarf::DW_ACCESS_private);
1852   // Otherwise C++ member and base classes are considered public.
1853   else
1854     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1855             dwarf::DW_ACCESS_public);
1856   if (DT.isVirtual())
1857     addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
1858             dwarf::DW_VIRTUALITY_virtual);
1859
1860   // Objective-C properties.
1861   if (MDNode *PNode = DT.getObjCProperty())
1862     if (DIEEntry *PropertyDie = getDIEEntry(PNode))
1863       MemberDie->addValue(dwarf::DW_AT_APPLE_property, dwarf::DW_FORM_ref4,
1864                           PropertyDie);
1865
1866   if (DT.isArtificial())
1867     addFlag(MemberDie, dwarf::DW_AT_artificial);
1868
1869   return MemberDie;
1870 }
1871
1872 /// getOrCreateStaticMemberDIE - Create new DIE for C++ static member.
1873 DIE *CompileUnit::getOrCreateStaticMemberDIE(const DIDerivedType DT) {
1874   if (!DT.Verify())
1875     return NULL;
1876
1877   // Construct the context before querying for the existence of the DIE in case
1878   // such construction creates the DIE.
1879   DIE *ContextDIE = getOrCreateContextDIE(resolve(DT.getContext()));
1880   assert(ContextDIE && "Static member should belong to a non-CU context.");
1881
1882   DIE *StaticMemberDIE = getDIE(DT);
1883   if (StaticMemberDIE)
1884     return StaticMemberDIE;
1885
1886   StaticMemberDIE = new DIE(DT.getTag());
1887   // Add to context owner.
1888   ContextDIE->addChild(StaticMemberDIE);
1889
1890   DIType Ty = resolve(DT.getTypeDerivedFrom());
1891
1892   addString(StaticMemberDIE, dwarf::DW_AT_name, DT.getName());
1893   addType(StaticMemberDIE, Ty);
1894   addSourceLine(StaticMemberDIE, DT);
1895   addFlag(StaticMemberDIE, dwarf::DW_AT_external);
1896   addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
1897
1898   // FIXME: We could omit private if the parent is a class_type, and
1899   // public if the parent is something else.
1900   if (DT.isProtected())
1901     addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1902             dwarf::DW_ACCESS_protected);
1903   else if (DT.isPrivate())
1904     addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1905             dwarf::DW_ACCESS_private);
1906   else
1907     addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1908             dwarf::DW_ACCESS_public);
1909
1910   if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT.getConstant()))
1911     addConstantValue(StaticMemberDIE, CI, isUnsignedDIType(DD, Ty));
1912   if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT.getConstant()))
1913     addConstantFPValue(StaticMemberDIE, CFP);
1914
1915   insertDIE(DT, StaticMemberDIE);
1916   return StaticMemberDIE;
1917 }