1 //===-- llvm/CodeGen/DwarfCompileUnit.cpp - Dwarf Compile Unit ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for constructing a dwarf compile unit.
12 //===----------------------------------------------------------------------===//
14 #define DEBUG_TYPE "dwarfdebug"
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/Support/Debug.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Target/Mangler.h"
28 #include "llvm/Target/TargetFrameLowering.h"
29 #include "llvm/Target/TargetMachine.h"
30 #include "llvm/Target/TargetLoweringObjectFile.h"
31 #include "llvm/Target/TargetRegisterInfo.h"
35 /// CompileUnit - Compile unit constructor.
36 CompileUnit::CompileUnit(unsigned UID, unsigned L, DIE *D, const MDNode *N,
37 AsmPrinter *A, DwarfDebug *DW, DwarfUnits *DWU)
38 : UniqueID(UID), Language(L), CUDie(D), Asm(A), DD(DW), DU(DWU),
39 IndexTyDie(0), DebugInfoOffset(0) {
40 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
44 /// ~CompileUnit - Destructor for compile unit.
45 CompileUnit::~CompileUnit() {
46 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
47 DIEBlocks[j]->~DIEBlock();
50 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
51 /// information entry.
52 DIEEntry *CompileUnit::createDIEEntry(DIE *Entry) {
53 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
57 /// getDefaultLowerBound - Return the default lower bound for an array. If the
58 /// DWARF version doesn't handle the language, return -1.
59 int64_t CompileUnit::getDefaultLowerBound() const {
64 case dwarf::DW_LANG_C89:
65 case dwarf::DW_LANG_C99:
66 case dwarf::DW_LANG_C:
67 case dwarf::DW_LANG_C_plus_plus:
68 case dwarf::DW_LANG_ObjC:
69 case dwarf::DW_LANG_ObjC_plus_plus:
72 case dwarf::DW_LANG_Fortran77:
73 case dwarf::DW_LANG_Fortran90:
74 case dwarf::DW_LANG_Fortran95:
77 // The languages below have valid values only if the DWARF version >= 4.
78 case dwarf::DW_LANG_Java:
79 case dwarf::DW_LANG_Python:
80 case dwarf::DW_LANG_UPC:
81 case dwarf::DW_LANG_D:
82 if (dwarf::DWARF_VERSION >= 4)
86 case dwarf::DW_LANG_Ada83:
87 case dwarf::DW_LANG_Ada95:
88 case dwarf::DW_LANG_Cobol74:
89 case dwarf::DW_LANG_Cobol85:
90 case dwarf::DW_LANG_Modula2:
91 case dwarf::DW_LANG_Pascal83:
92 case dwarf::DW_LANG_PLI:
93 if (dwarf::DWARF_VERSION >= 4)
101 /// addFlag - Add a flag that is true.
102 void CompileUnit::addFlag(DIE *Die, unsigned Attribute) {
103 if (!DD->useDarwinGDBCompat())
104 Die->addValue(Attribute, dwarf::DW_FORM_flag_present,
107 addUInt(Die, Attribute, dwarf::DW_FORM_flag, 1);
110 /// addUInt - Add an unsigned integer attribute data and value.
112 void CompileUnit::addUInt(DIE *Die, unsigned Attribute,
113 unsigned Form, uint64_t Integer) {
114 if (!Form) Form = DIEInteger::BestForm(false, Integer);
115 DIEValue *Value = Integer == 1 ?
116 DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
117 Die->addValue(Attribute, Form, Value);
120 /// addSInt - Add an signed integer attribute data and value.
122 void CompileUnit::addSInt(DIE *Die, unsigned Attribute,
123 unsigned Form, int64_t Integer) {
124 if (!Form) Form = DIEInteger::BestForm(true, Integer);
125 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
126 Die->addValue(Attribute, Form, Value);
129 /// addString - Add a string attribute data and value. We always emit a
130 /// reference to the string pool instead of immediate strings so that DIEs have
131 /// more predictable sizes. In the case of split dwarf we emit an index
132 /// into another table which gets us the static offset into the string
134 void CompileUnit::addString(DIE *Die, unsigned Attribute, StringRef String) {
137 if (!DD->useSplitDwarf()) {
138 MCSymbol *Symb = DU->getStringPoolEntry(String);
139 if (Asm->needsRelocationsForDwarfStringPool())
140 Value = new (DIEValueAllocator) DIELabel(Symb);
142 MCSymbol *StringPool = DU->getStringPoolSym();
143 Value = new (DIEValueAllocator) DIEDelta(Symb, StringPool);
145 Form = dwarf::DW_FORM_strp;
147 unsigned idx = DU->getStringPoolIndex(String);
148 Value = new (DIEValueAllocator) DIEInteger(idx);
149 Form = dwarf::DW_FORM_GNU_str_index;
151 DIEValue *Str = new (DIEValueAllocator) DIEString(Value, String);
152 Die->addValue(Attribute, Form, Str);
155 /// addLocalString - Add a string attribute data and value. This is guaranteed
156 /// to be in the local string pool instead of indirected.
157 void CompileUnit::addLocalString(DIE *Die, unsigned Attribute,
159 MCSymbol *Symb = DU->getStringPoolEntry(String);
161 if (Asm->needsRelocationsForDwarfStringPool())
162 Value = new (DIEValueAllocator) DIELabel(Symb);
164 MCSymbol *StringPool = DU->getStringPoolSym();
165 Value = new (DIEValueAllocator) DIEDelta(Symb, StringPool);
167 Die->addValue(Attribute, dwarf::DW_FORM_strp, Value);
170 /// addExpr - Add a Dwarf expression attribute data and value.
172 void CompileUnit::addExpr(DIE *Die, unsigned Attribute, unsigned Form,
173 const MCExpr *Expr) {
174 DIEValue *Value = new (DIEValueAllocator) DIEExpr(Expr);
175 Die->addValue(Attribute, Form, Value);
178 /// addLabel - Add a Dwarf label attribute data and value.
180 void CompileUnit::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
181 const MCSymbol *Label) {
182 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
183 Die->addValue(Attribute, Form, Value);
186 /// addLabelAddress - Add a dwarf label attribute data and value using
187 /// DW_FORM_addr or DW_FORM_GNU_addr_index.
189 void CompileUnit::addLabelAddress(DIE *Die, unsigned Attribute,
191 if (!DD->useSplitDwarf()) {
193 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
194 Die->addValue(Attribute, dwarf::DW_FORM_addr, Value);
196 DIEValue *Value = new (DIEValueAllocator) DIEInteger(0);
197 Die->addValue(Attribute, dwarf::DW_FORM_addr, Value);
200 unsigned idx = DU->getAddrPoolIndex(Label);
201 DIEValue *Value = new (DIEValueAllocator) DIEInteger(idx);
202 Die->addValue(Attribute, dwarf::DW_FORM_GNU_addr_index, Value);
206 /// addOpAddress - Add a dwarf op address data and value using the
207 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
209 void CompileUnit::addOpAddress(DIE *Die, const MCSymbol *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);
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));
219 /// addDelta - Add a label delta attribute data and value.
221 void CompileUnit::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
222 const MCSymbol *Hi, const MCSymbol *Lo) {
223 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
224 Die->addValue(Attribute, Form, Value);
227 /// addDIEEntry - Add a DIE attribute data and value.
229 void CompileUnit::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
231 Die->addValue(Attribute, Form, createDIEEntry(Entry));
234 /// addBlock - Add block data.
236 void CompileUnit::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
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);
243 /// addSourceLine - Add location information to specified debug information
245 void CompileUnit::addSourceLine(DIE *Die, DIVariable V) {
250 unsigned Line = V.getLineNumber();
253 unsigned FileID = DD->getOrCreateSourceID(V.getContext().getFilename(),
254 V.getContext().getDirectory(),
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);
261 /// addSourceLine - Add location information to specified debug information
263 void CompileUnit::addSourceLine(DIE *Die, DIGlobalVariable G) {
264 // Verify global variable.
265 if (!G.isGlobalVariable())
268 unsigned Line = G.getLineNumber();
271 unsigned FileID = DD->getOrCreateSourceID(G.getFilename(), G.getDirectory(),
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);
278 /// addSourceLine - Add location information to specified debug information
280 void CompileUnit::addSourceLine(DIE *Die, DISubprogram SP) {
281 // Verify subprogram.
282 if (!SP.isSubprogram())
285 // If the line number is 0, don't add it.
286 unsigned Line = SP.getLineNumber();
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);
297 /// addSourceLine - Add location information to specified debug information
299 void CompileUnit::addSourceLine(DIE *Die, DIType Ty) {
304 unsigned Line = Ty.getLineNumber();
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);
314 /// addSourceLine - Add location information to specified debug information
316 void CompileUnit::addSourceLine(DIE *Die, DIObjCProperty Ty) {
318 if (!Ty.isObjCProperty())
321 unsigned Line = Ty.getLineNumber();
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);
332 /// addSourceLine - Add location information to specified debug information
334 void CompileUnit::addSourceLine(DIE *Die, DINameSpace NS) {
339 unsigned Line = NS.getLineNumber();
342 StringRef FN = NS.getFilename();
344 unsigned FileID = DD->getOrCreateSourceID(FN, NS.getDirectory(),
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);
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);
360 addAddress(Die, dwarf::DW_AT_location, Location,
361 DV.getVariable().isIndirect());
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);
369 addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + DWReg);
371 addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
372 addUInt(TheDie, 0, dwarf::DW_FORM_udata, DWReg);
376 /// addRegisterOffset - Add register offset.
377 void CompileUnit::addRegisterOffset(DIE *TheDie, unsigned Reg,
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);
386 addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + DWReg);
388 addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
389 addUInt(TheDie, 0, dwarf::DW_FORM_udata, DWReg);
391 addSInt(TheDie, 0, dwarf::DW_FORM_sdata, Offset);
394 /// addAddress - Add an address attribute to a die based on the location
396 void CompileUnit::addAddress(DIE *Die, unsigned Attribute,
397 const MachineLocation &Location, bool Indirect) {
398 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
400 if (Location.isReg() && !Indirect)
401 addRegisterOp(Block, Location.getReg());
403 addRegisterOffset(Block, Location.getReg(), Location.getOffset());
404 if (Indirect && !Location.isReg()) {
405 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
409 // Now attach the location information to the DIE.
410 addBlock(Die, Attribute, 0, Block);
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.
418 void CompileUnit::addComplexAddress(const DbgVariable &DV, DIE *Die,
420 const MachineLocation &Location) {
421 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
422 unsigned N = DV.getNumAddrElements();
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));
431 addRegisterOp(Block, Location.getReg());
434 addRegisterOffset(Block, Location.getReg(), Location.getOffset());
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");
447 // Now attach the location information to the DIE.
448 addBlock(Die, Attribute, 0, Block);
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.
457 However, as far as the original *programmer* is concerned, the variable
458 should still have type 'SomeType', as originally declared.
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.
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.
473 The struct will look something like:
475 struct __Block_byref_x_VarName {
477 struct __Block_byref_x_VarName *forwarding;
478 ... <various other fields>
480 ... <maybe more fields>
483 If we are given the struct directly (as our starting point) we
484 need to tell the debugger to:
486 1). Add the offset of the forwarding field.
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).
491 3). Add the offset for the field VarName, to find the actual variable.
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:
498 DW_OP_deref -- optional, if we start with a pointer
499 DW_OP_plus_uconst <forward_fld_offset>
501 DW_OP_plus_uconst <varName_fld_offset>
503 That is what this function does. */
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.
511 void CompileUnit::addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
513 const MachineLocation &Location) {
514 DIType Ty = DV.getType();
516 unsigned Tag = Ty.getTag();
517 bool isPointer = false;
519 StringRef varName = DV.getName();
521 if (Tag == dwarf::DW_TAG_pointer_type) {
522 DIDerivedType DTy = DIDerivedType(Ty);
523 TmpTy = DTy.getTypeDerivedFrom();
527 DICompositeType blockStruct = DICompositeType(TmpTy);
529 // Find the __forwarding field and the variable field in the __Block_byref
531 DIArray Fields = blockStruct.getTypeArray();
532 DIDescriptor varField = DIDescriptor();
533 DIDescriptor forwardingField = DIDescriptor();
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)
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;
551 // Decode the original location, and use that as the start of the byref
552 // variable's location.
553 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
555 if (Location.isReg())
556 addRegisterOp(Block, Location.getReg());
558 addRegisterOffset(Block, Location.getReg(), Location.getOffset());
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).
563 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
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);
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);
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);
585 // Now attach the location information to the DIE.
586 addBlock(Die, Attribute, 0, Block);
589 /// isTypeSigned - Return true if the type is signed.
590 static bool isTypeSigned(DIType Ty, int *SizeInBits) {
591 if (Ty.isDerivedType())
592 return isTypeSigned(DIDerivedType(Ty).getTypeDerivedFrom(), SizeInBits);
593 if (Ty.isBasicType())
594 if (DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed
595 || DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed_char) {
596 *SizeInBits = Ty.getSizeInBits();
602 /// addConstantValue - Add constant value entry in variable DIE.
603 void CompileUnit::addConstantValue(DIE *Die, const MachineOperand &MO,
605 // FIXME: This is a bit conservative/simple - it emits negative values at
606 // their maximum bit width which is a bit unfortunate (& doesn't prefer
607 // udata/sdata over dataN as suggested by the DWARF spec)
608 assert(MO.isImm() && "Invalid machine operand!");
609 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
611 bool SignedConstant = isTypeSigned(Ty, &SizeInBits);
612 unsigned Form = SignedConstant ? dwarf::DW_FORM_sdata : dwarf::DW_FORM_udata;
613 switch (SizeInBits) {
614 case 8: Form = dwarf::DW_FORM_data1; break;
615 case 16: Form = dwarf::DW_FORM_data2; break;
616 case 32: Form = dwarf::DW_FORM_data4; break;
617 case 64: Form = dwarf::DW_FORM_data8; break;
620 SignedConstant ? addSInt(Block, 0, Form, MO.getImm())
621 : addUInt(Block, 0, Form, MO.getImm());
623 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
626 /// addConstantFPValue - Add constant value entry in variable DIE.
627 void CompileUnit::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
628 assert (MO.isFPImm() && "Invalid machine operand!");
629 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
630 APFloat FPImm = MO.getFPImm()->getValueAPF();
632 // Get the raw data form of the floating point.
633 const APInt FltVal = FPImm.bitcastToAPInt();
634 const char *FltPtr = (const char*)FltVal.getRawData();
636 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
637 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
638 int Incr = (LittleEndian ? 1 : -1);
639 int Start = (LittleEndian ? 0 : NumBytes - 1);
640 int Stop = (LittleEndian ? NumBytes : -1);
642 // Output the constant to DWARF one byte at a time.
643 for (; Start != Stop; Start += Incr)
644 addUInt(Block, 0, dwarf::DW_FORM_data1,
645 (unsigned char)0xFF & FltPtr[Start]);
647 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
650 /// addConstantFPValue - Add constant value entry in variable DIE.
651 void CompileUnit::addConstantFPValue(DIE *Die, const ConstantFP *CFP) {
652 addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), false);
655 /// addConstantValue - Add constant value entry in variable DIE.
656 void CompileUnit::addConstantValue(DIE *Die, const ConstantInt *CI,
658 addConstantValue(Die, CI->getValue(), Unsigned);
661 // addConstantValue - Add constant value entry in variable DIE.
662 void CompileUnit::addConstantValue(DIE *Die, const APInt &Val, bool Unsigned) {
663 unsigned CIBitWidth = Val.getBitWidth();
664 if (CIBitWidth <= 64) {
666 switch (CIBitWidth) {
667 case 8: form = dwarf::DW_FORM_data1; break;
668 case 16: form = dwarf::DW_FORM_data2; break;
669 case 32: form = dwarf::DW_FORM_data4; break;
670 case 64: form = dwarf::DW_FORM_data8; break;
672 form = Unsigned ? dwarf::DW_FORM_udata : dwarf::DW_FORM_sdata;
675 addUInt(Die, dwarf::DW_AT_const_value, form, Val.getZExtValue());
677 addSInt(Die, dwarf::DW_AT_const_value, form, Val.getSExtValue());
681 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
683 // Get the raw data form of the large APInt.
684 const uint64_t *Ptr64 = Val.getRawData();
686 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
687 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
689 // Output the constant to DWARF one byte at a time.
690 for (int i = 0; i < NumBytes; i++) {
693 c = Ptr64[i / 8] >> (8 * (i & 7));
695 c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7));
696 addUInt(Block, 0, dwarf::DW_FORM_data1, c);
699 addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
702 /// addTemplateParams - Add template parameters into buffer.
703 void CompileUnit::addTemplateParams(DIE &Buffer, DIArray TParams) {
704 // Add template parameters.
705 for (unsigned i = 0, e = TParams.getNumElements(); i != e; ++i) {
706 DIDescriptor Element = TParams.getElement(i);
707 if (Element.isTemplateTypeParameter())
708 Buffer.addChild(getOrCreateTemplateTypeParameterDIE(
709 DITemplateTypeParameter(Element)));
710 else if (Element.isTemplateValueParameter())
711 Buffer.addChild(getOrCreateTemplateValueParameterDIE(
712 DITemplateValueParameter(Element)));
716 /// getOrCreateContextDIE - Get context owner's DIE.
717 DIE *CompileUnit::getOrCreateContextDIE(DIDescriptor Context) {
718 if (Context.isType())
719 return getOrCreateTypeDIE(DIType(Context));
720 else if (Context.isNameSpace())
721 return getOrCreateNameSpace(DINameSpace(Context));
722 else if (Context.isSubprogram())
723 return getOrCreateSubprogramDIE(DISubprogram(Context));
725 return getDIE(Context);
728 /// addToContextOwner - Add Die into the list of its context owner's children.
729 void CompileUnit::addToContextOwner(DIE *Die, DIDescriptor Context) {
730 if (DIE *ContextDIE = getOrCreateContextDIE(Context))
731 ContextDIE->addChild(Die);
736 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
738 DIE *CompileUnit::getOrCreateTypeDIE(const MDNode *TyNode) {
742 DIE *TyDIE = getDIE(Ty);
747 TyDIE = new DIE(dwarf::DW_TAG_base_type);
748 insertDIE(Ty, TyDIE);
749 if (Ty.isBasicType())
750 constructTypeDIE(*TyDIE, DIBasicType(Ty));
751 else if (Ty.isCompositeType())
752 constructTypeDIE(*TyDIE, DICompositeType(Ty));
754 assert(Ty.isDerivedType() && "Unknown kind of DIType");
755 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
757 // If this is a named finished type then include it in the list of types
758 // for the accelerator tables.
759 if (!Ty.getName().empty() && !Ty.isForwardDecl()) {
760 bool IsImplementation = 0;
761 if (Ty.isCompositeType()) {
762 DICompositeType CT(Ty);
763 // A runtime language of 0 actually means C/C++ and that any
764 // non-negative value is some version of Objective-C/C++.
765 IsImplementation = (CT.getRunTimeLang() == 0) ||
766 CT.isObjcClassComplete();
768 unsigned Flags = IsImplementation ?
769 DwarfAccelTable::eTypeFlagClassIsImplementation : 0;
770 addAccelType(Ty.getName(), std::make_pair(TyDIE, Flags));
773 addToContextOwner(TyDIE, Ty.getContext());
777 /// addType - Add a new type attribute to the specified entity.
778 void CompileUnit::addType(DIE *Entity, DIType Ty, unsigned Attribute) {
782 // Check for pre-existence.
783 DIEEntry *Entry = getDIEEntry(Ty);
784 // If it exists then use the existing value.
786 Entity->addValue(Attribute, dwarf::DW_FORM_ref4, Entry);
791 DIE *Buffer = getOrCreateTypeDIE(Ty);
794 Entry = createDIEEntry(Buffer);
795 insertDIEEntry(Ty, Entry);
796 Entity->addValue(Attribute, dwarf::DW_FORM_ref4, Entry);
798 // If this is a complete composite type then include it in the
799 // list of global types.
803 /// addGlobalType - Add a new global type to the compile unit.
805 void CompileUnit::addGlobalType(DIType Ty) {
806 DIDescriptor Context = Ty.getContext();
807 if (Ty.isCompositeType() && !Ty.getName().empty() && !Ty.isForwardDecl()
808 && (!Context || Context.isCompileUnit() || Context.isFile()
809 || Context.isNameSpace()))
810 if (DIEEntry *Entry = getDIEEntry(Ty))
811 GlobalTypes[Ty.getName()] = Entry->getEntry();
814 /// addPubTypes - Add type for pubtypes section.
815 void CompileUnit::addPubTypes(DISubprogram SP) {
816 DICompositeType SPTy = SP.getType();
817 unsigned SPTag = SPTy.getTag();
818 if (SPTag != dwarf::DW_TAG_subroutine_type)
821 DIArray Args = SPTy.getTypeArray();
822 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
823 DIType ATy(Args.getElement(i));
830 /// constructTypeDIE - Construct basic type die from DIBasicType.
831 void CompileUnit::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
832 // Get core information.
833 StringRef Name = BTy.getName();
834 // Add name if not anonymous or intermediate type.
836 addString(&Buffer, dwarf::DW_AT_name, Name);
838 if (BTy.getTag() == dwarf::DW_TAG_unspecified_type) {
839 Buffer.setTag(dwarf::DW_TAG_unspecified_type);
840 // An unspecified type only has a name attribute.
844 Buffer.setTag(dwarf::DW_TAG_base_type);
845 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
848 uint64_t Size = BTy.getSizeInBits() >> 3;
849 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
852 /// constructTypeDIE - Construct derived type die from DIDerivedType.
853 void CompileUnit::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
854 // Get core information.
855 StringRef Name = DTy.getName();
856 uint64_t Size = DTy.getSizeInBits() >> 3;
857 unsigned Tag = DTy.getTag();
859 // FIXME - Workaround for templates.
860 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
864 // Map to main type, void will not have a type.
865 DIType FromTy = DTy.getTypeDerivedFrom();
866 addType(&Buffer, FromTy);
868 // Add name if not anonymous or intermediate type.
870 addString(&Buffer, dwarf::DW_AT_name, Name);
872 // Add size if non-zero (derived types might be zero-sized.)
873 if (Size && Tag != dwarf::DW_TAG_pointer_type)
874 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
876 if (Tag == dwarf::DW_TAG_ptr_to_member_type)
877 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
878 getOrCreateTypeDIE(DTy.getClassType()));
879 // Add source line info if available and TyDesc is not a forward declaration.
880 if (!DTy.isForwardDecl())
881 addSourceLine(&Buffer, DTy);
884 /// Return true if the type is appropriately scoped to be contained inside
885 /// its own type unit.
886 static bool isTypeUnitScoped(DIType Ty) {
887 DIScope Parent = Ty.getContext();
889 // Don't generate a hash for anything scoped inside a function.
890 if (Parent.isSubprogram())
892 Parent = Parent.getContext();
897 /// Return true if the type should be split out into a type unit.
898 static bool shouldCreateTypeUnit(DICompositeType CTy) {
899 unsigned Tag = CTy.getTag();
902 case dwarf::DW_TAG_structure_type:
903 case dwarf::DW_TAG_union_type:
904 case dwarf::DW_TAG_enumeration_type:
905 case dwarf::DW_TAG_class_type:
906 // If this is a class, structure, union, or enumeration type
907 // that is not a declaration, is a type definition, and not scoped
908 // inside a function then separate this out as a type unit.
909 if (CTy.isForwardDecl() || !isTypeUnitScoped(CTy))
917 /// constructTypeDIE - Construct type DIE from DICompositeType.
918 void CompileUnit::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
919 // Get core information.
920 StringRef Name = CTy.getName();
922 uint64_t Size = CTy.getSizeInBits() >> 3;
923 unsigned Tag = CTy.getTag();
927 case dwarf::DW_TAG_array_type:
928 constructArrayTypeDIE(Buffer, &CTy);
930 case dwarf::DW_TAG_enumeration_type: {
931 DIArray Elements = CTy.getTypeArray();
933 // Add enumerators to enumeration type.
934 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
936 DIDescriptor Enum(Elements.getElement(i));
937 if (Enum.isEnumerator()) {
938 ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
939 Buffer.addChild(ElemDie);
942 DIType DTy = CTy.getTypeDerivedFrom();
944 addType(&Buffer, DTy);
945 addUInt(&Buffer, dwarf::DW_AT_enum_class, dwarf::DW_FORM_flag, 1);
949 case dwarf::DW_TAG_subroutine_type: {
951 DIArray Elements = CTy.getTypeArray();
952 DIDescriptor RTy = Elements.getElement(0);
953 addType(&Buffer, DIType(RTy));
955 bool isPrototyped = true;
957 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
958 DIDescriptor Ty = Elements.getElement(i);
959 if (Ty.isUnspecifiedParameter()) {
960 DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
961 Buffer.addChild(Arg);
962 isPrototyped = false;
964 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
965 addType(Arg, DIType(Ty));
966 if (DIType(Ty).isArtificial())
967 addFlag(Arg, dwarf::DW_AT_artificial);
968 Buffer.addChild(Arg);
971 // Add prototype flag if we're dealing with a C language and the
972 // function has been prototyped.
974 (Language == dwarf::DW_LANG_C89 ||
975 Language == dwarf::DW_LANG_C99 ||
976 Language == dwarf::DW_LANG_ObjC))
977 addFlag(&Buffer, dwarf::DW_AT_prototyped);
980 case dwarf::DW_TAG_structure_type:
981 case dwarf::DW_TAG_union_type:
982 case dwarf::DW_TAG_class_type: {
983 // Add elements to structure type.
984 DIArray Elements = CTy.getTypeArray();
986 // A forward struct declared type may not have elements available.
987 unsigned N = Elements.getNumElements();
991 // Add elements to structure type.
992 for (unsigned i = 0; i < N; ++i) {
993 DIDescriptor Element = Elements.getElement(i);
995 if (Element.isSubprogram()) {
996 DISubprogram SP(Element);
997 ElemDie = getOrCreateSubprogramDIE(DISubprogram(Element));
998 if (SP.isProtected())
999 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1000 dwarf::DW_ACCESS_protected);
1001 else if (SP.isPrivate())
1002 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1003 dwarf::DW_ACCESS_private);
1005 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1006 dwarf::DW_ACCESS_public);
1007 if (SP.isExplicit())
1008 addFlag(ElemDie, dwarf::DW_AT_explicit);
1009 } else if (Element.isDerivedType()) {
1010 DIDerivedType DDTy(Element);
1011 if (DDTy.getTag() == dwarf::DW_TAG_friend) {
1012 ElemDie = new DIE(dwarf::DW_TAG_friend);
1013 addType(ElemDie, DDTy.getTypeDerivedFrom(), dwarf::DW_AT_friend);
1014 } else if (DDTy.isStaticMember())
1015 ElemDie = createStaticMemberDIE(DDTy);
1017 ElemDie = createMemberDIE(DDTy);
1018 } else if (Element.isObjCProperty()) {
1019 DIObjCProperty Property(Element);
1020 ElemDie = new DIE(Property.getTag());
1021 StringRef PropertyName = Property.getObjCPropertyName();
1022 addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
1023 addType(ElemDie, Property.getType());
1024 addSourceLine(ElemDie, Property);
1025 StringRef GetterName = Property.getObjCPropertyGetterName();
1026 if (!GetterName.empty())
1027 addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
1028 StringRef SetterName = Property.getObjCPropertySetterName();
1029 if (!SetterName.empty())
1030 addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
1031 unsigned PropertyAttributes = 0;
1032 if (Property.isReadOnlyObjCProperty())
1033 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readonly;
1034 if (Property.isReadWriteObjCProperty())
1035 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readwrite;
1036 if (Property.isAssignObjCProperty())
1037 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_assign;
1038 if (Property.isRetainObjCProperty())
1039 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_retain;
1040 if (Property.isCopyObjCProperty())
1041 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_copy;
1042 if (Property.isNonAtomicObjCProperty())
1043 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_nonatomic;
1044 if (PropertyAttributes)
1045 addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, 0,
1046 PropertyAttributes);
1048 DIEEntry *Entry = getDIEEntry(Element);
1050 Entry = createDIEEntry(ElemDie);
1051 insertDIEEntry(Element, Entry);
1055 Buffer.addChild(ElemDie);
1058 if (CTy.isAppleBlockExtension())
1059 addFlag(&Buffer, dwarf::DW_AT_APPLE_block);
1061 DICompositeType ContainingType = CTy.getContainingType();
1062 if (DIDescriptor(ContainingType).isCompositeType())
1063 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
1064 getOrCreateTypeDIE(DIType(ContainingType)));
1066 addToContextOwner(&Buffer, CTy.getContext());
1068 if (CTy.isObjcClassComplete())
1069 addFlag(&Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
1071 // Add template parameters to a class, structure or union types.
1072 // FIXME: The support isn't in the metadata for this yet.
1073 if (Tag == dwarf::DW_TAG_class_type ||
1074 Tag == dwarf::DW_TAG_structure_type ||
1075 Tag == dwarf::DW_TAG_union_type)
1076 addTemplateParams(Buffer, CTy.getTemplateParams());
1084 // Add name if not anonymous or intermediate type.
1086 addString(&Buffer, dwarf::DW_AT_name, Name);
1088 if (Tag == dwarf::DW_TAG_enumeration_type ||
1089 Tag == dwarf::DW_TAG_class_type ||
1090 Tag == dwarf::DW_TAG_structure_type ||
1091 Tag == dwarf::DW_TAG_union_type) {
1092 // Add size if non-zero (derived types might be zero-sized.)
1093 // TODO: Do we care about size for enum forward declarations?
1095 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
1096 else if (!CTy.isForwardDecl())
1097 // Add zero size if it is not a forward declaration.
1098 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
1100 // If we're a forward decl, say so.
1101 if (CTy.isForwardDecl())
1102 addFlag(&Buffer, dwarf::DW_AT_declaration);
1104 // Add source line info if available.
1105 if (!CTy.isForwardDecl())
1106 addSourceLine(&Buffer, CTy);
1108 // No harm in adding the runtime language to the declaration.
1109 unsigned RLang = CTy.getRunTimeLang();
1111 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
1112 dwarf::DW_FORM_data1, RLang);
1114 // If this is a type applicable to a type unit it then add it to the
1115 // list of types we'll compute a hash for later.
1116 if (shouldCreateTypeUnit(CTy))
1117 DD->addTypeUnitType(&Buffer);
1120 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
1121 /// for the given DITemplateTypeParameter.
1123 CompileUnit::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP) {
1124 DIE *ParamDIE = getDIE(TP);
1128 ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
1129 addType(ParamDIE, TP.getType());
1130 if (!TP.getName().empty())
1131 addString(ParamDIE, dwarf::DW_AT_name, TP.getName());
1135 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
1136 /// for the given DITemplateValueParameter.
1138 CompileUnit::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TPV){
1139 DIE *ParamDIE = getDIE(TPV);
1143 ParamDIE = new DIE(TPV.getTag());
1144 addType(ParamDIE, TPV.getType());
1145 if (!TPV.getName().empty())
1146 addString(ParamDIE, dwarf::DW_AT_name, TPV.getName());
1147 if (Value *Val = TPV.getValue()) {
1148 if (ConstantInt *CI = dyn_cast<ConstantInt>(Val))
1149 addConstantValue(ParamDIE, CI, TPV.getType().isUnsignedDIType());
1150 else if (GlobalValue *GV = dyn_cast<GlobalValue>(Val)) {
1151 // For declaration non-type template parameters (such as global values and
1153 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1154 addOpAddress(Block, Asm->Mang->getSymbol(GV));
1155 // Emit DW_OP_stack_value to use the address as the immediate value of the
1156 // parameter, rather than a pointer to it.
1157 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1158 addBlock(ParamDIE, dwarf::DW_AT_location, 0, Block);
1159 } else if (TPV.getTag() == dwarf::DW_TAG_GNU_template_template_param) {
1160 assert(isa<MDString>(Val));
1161 addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1162 cast<MDString>(Val)->getString());
1163 } else if (TPV.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
1164 assert(isa<MDNode>(Val));
1165 DIArray A(cast<MDNode>(Val));
1166 addTemplateParams(*ParamDIE, A);
1173 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
1174 DIE *CompileUnit::getOrCreateNameSpace(DINameSpace NS) {
1175 DIE *NDie = getDIE(NS);
1178 NDie = new DIE(dwarf::DW_TAG_namespace);
1179 insertDIE(NS, NDie);
1180 if (!NS.getName().empty()) {
1181 addString(NDie, dwarf::DW_AT_name, NS.getName());
1182 addAccelNamespace(NS.getName(), NDie);
1184 addAccelNamespace("(anonymous namespace)", NDie);
1185 addSourceLine(NDie, NS);
1186 addToContextOwner(NDie, NS.getContext());
1190 /// getOrCreateSubprogramDIE - Create new DIE using SP.
1191 DIE *CompileUnit::getOrCreateSubprogramDIE(DISubprogram SP) {
1192 DIE *SPDie = getDIE(SP);
1196 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1198 // DW_TAG_inlined_subroutine may refer to this DIE.
1199 insertDIE(SP, SPDie);
1201 DISubprogram SPDecl = SP.getFunctionDeclaration();
1202 DIE *DeclDie = NULL;
1203 if (SPDecl.isSubprogram()) {
1204 DeclDie = getOrCreateSubprogramDIE(SPDecl);
1207 // Add to context owner.
1208 addToContextOwner(SPDie, SP.getContext());
1210 // Add function template parameters.
1211 addTemplateParams(*SPDie, SP.getTemplateParams());
1213 // Unfortunately this code needs to stay here instead of below the
1214 // AT_specification code in order to work around a bug in older
1215 // gdbs that requires the linkage name to resolve multiple template
1217 // TODO: Remove this set of code when we get rid of the old gdb
1219 StringRef LinkageName = SP.getLinkageName();
1220 if (!LinkageName.empty() && DD->useDarwinGDBCompat())
1221 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name,
1222 GlobalValue::getRealLinkageName(LinkageName));
1224 // If this DIE is going to refer declaration info using AT_specification
1225 // then there is no need to add other attributes.
1227 // Refer function declaration directly.
1228 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1234 // Add the linkage name if we have one.
1235 if (!LinkageName.empty() && !DD->useDarwinGDBCompat())
1236 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name,
1237 GlobalValue::getRealLinkageName(LinkageName));
1239 // Constructors and operators for anonymous aggregates do not have names.
1240 if (!SP.getName().empty())
1241 addString(SPDie, dwarf::DW_AT_name, SP.getName());
1243 addSourceLine(SPDie, SP);
1245 // Add the prototype if we have a prototype and we have a C like
1247 if (SP.isPrototyped() &&
1248 (Language == dwarf::DW_LANG_C89 ||
1249 Language == dwarf::DW_LANG_C99 ||
1250 Language == dwarf::DW_LANG_ObjC))
1251 addFlag(SPDie, dwarf::DW_AT_prototyped);
1254 DICompositeType SPTy = SP.getType();
1255 assert(SPTy.getTag() == dwarf::DW_TAG_subroutine_type &&
1256 "the type of a subprogram should be a subroutine");
1258 DIArray Args = SPTy.getTypeArray();
1259 addType(SPDie, DIType(Args.getElement(0)));
1261 unsigned VK = SP.getVirtuality();
1263 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
1264 DIEBlock *Block = getDIEBlock();
1265 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1266 addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
1267 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
1268 ContainingTypeMap.insert(std::make_pair(SPDie,
1269 SP.getContainingType()));
1272 if (!SP.isDefinition()) {
1273 addFlag(SPDie, dwarf::DW_AT_declaration);
1275 // Add arguments. Do not add arguments for subprogram definition. They will
1276 // be handled while processing variables.
1277 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1278 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1279 DIType ATy = DIType(Args.getElement(i));
1281 if (ATy.isArtificial())
1282 addFlag(Arg, dwarf::DW_AT_artificial);
1283 SPDie->addChild(Arg);
1287 if (SP.isArtificial())
1288 addFlag(SPDie, dwarf::DW_AT_artificial);
1290 if (!SP.isLocalToUnit())
1291 addFlag(SPDie, dwarf::DW_AT_external);
1293 if (SP.isOptimized())
1294 addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
1296 if (unsigned isa = Asm->getISAEncoding()) {
1297 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1303 // Return const expression if value is a GEP to access merged global
1305 // i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
1306 static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
1307 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
1308 if (!CE || CE->getNumOperands() != 3 ||
1309 CE->getOpcode() != Instruction::GetElementPtr)
1312 // First operand points to a global struct.
1313 Value *Ptr = CE->getOperand(0);
1314 if (!isa<GlobalValue>(Ptr) ||
1315 !isa<StructType>(cast<PointerType>(Ptr->getType())->getElementType()))
1318 // Second operand is zero.
1319 const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
1320 if (!CI || !CI->isZero())
1323 // Third operand is offset.
1324 if (!isa<ConstantInt>(CE->getOperand(2)))
1330 /// createGlobalVariableDIE - create global variable DIE.
1331 void CompileUnit::createGlobalVariableDIE(const MDNode *N) {
1332 // Check for pre-existence.
1336 DIGlobalVariable GV(N);
1337 if (!GV.isGlobalVariable())
1340 DIDescriptor GVContext = GV.getContext();
1341 DIType GTy = GV.getType();
1343 // If this is a static data member definition, some attributes belong
1344 // to the declaration DIE.
1345 DIE *VariableDIE = NULL;
1346 bool IsStaticMember = false;
1347 DIDerivedType SDMDecl = GV.getStaticDataMemberDeclaration();
1348 if (SDMDecl.Verify()) {
1349 assert(SDMDecl.isStaticMember() && "Expected static member decl");
1350 // We need the declaration DIE that is in the static member's class.
1351 // But that class might not exist in the DWARF yet.
1352 // Creating the class will create the static member decl DIE.
1353 getOrCreateContextDIE(SDMDecl.getContext());
1354 VariableDIE = getDIE(SDMDecl);
1355 assert(VariableDIE && "Static member decl has no context?");
1356 IsStaticMember = true;
1359 // If this is not a static data member definition, create the variable
1360 // DIE and add the initial set of attributes to it.
1362 VariableDIE = new DIE(GV.getTag());
1364 insertDIE(N, VariableDIE);
1366 // Add name and type.
1367 addString(VariableDIE, dwarf::DW_AT_name, GV.getDisplayName());
1368 addType(VariableDIE, GTy);
1370 // Add scoping info.
1371 if (!GV.isLocalToUnit()) {
1372 addFlag(VariableDIE, dwarf::DW_AT_external);
1373 addGlobalName(GV.getName(), VariableDIE);
1376 // Add line number info.
1377 addSourceLine(VariableDIE, GV);
1378 // Add to context owner.
1379 addToContextOwner(VariableDIE, GVContext);
1383 bool addToAccelTable = false;
1384 DIE *VariableSpecDIE = NULL;
1385 bool isGlobalVariable = GV.getGlobal() != NULL;
1386 if (isGlobalVariable) {
1387 addToAccelTable = true;
1388 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1389 const MCSymbol *Sym = Asm->Mang->getSymbol(GV.getGlobal());
1390 if (GV.getGlobal()->isThreadLocal()) {
1391 // FIXME: Make this work with -gsplit-dwarf.
1392 unsigned PointerSize = Asm->getDataLayout().getPointerSize();
1393 assert((PointerSize == 4 || PointerSize == 8) &&
1394 "Add support for other sizes if necessary");
1395 const MCExpr *Expr =
1396 Asm->getObjFileLowering().getDebugThreadLocalSymbol(Sym);
1397 // Based on GCC's support for TLS:
1398 if (!DD->useSplitDwarf()) {
1399 // 1) Start with a constNu of the appropriate pointer size
1400 addUInt(Block, 0, dwarf::DW_FORM_data1,
1401 PointerSize == 4 ? dwarf::DW_OP_const4u : dwarf::DW_OP_const8u);
1402 // 2) containing the (relocated) address of the TLS variable
1403 addExpr(Block, 0, dwarf::DW_FORM_udata, Expr);
1405 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_const_index);
1406 addUInt(Block, 0, dwarf::DW_FORM_udata, DU->getAddrPoolIndex(Expr));
1408 // 3) followed by a custom OP to tell the debugger about TLS (presumably)
1409 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_lo_user);
1411 addOpAddress(Block, Sym);
1412 // Do not create specification DIE if context is either compile unit
1414 if (GVContext && GV.isDefinition() && !GVContext.isCompileUnit() &&
1415 !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1416 // Create specification DIE.
1417 VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1418 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1419 dwarf::DW_FORM_ref4, VariableDIE);
1420 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1421 // A static member's declaration is already flagged as such.
1422 if (!SDMDecl.Verify())
1423 addFlag(VariableDIE, dwarf::DW_AT_declaration);
1424 addDie(VariableSpecDIE);
1426 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1428 // Add linkage name.
1429 StringRef LinkageName = GV.getLinkageName();
1430 if (!LinkageName.empty()) {
1431 // From DWARF4: DIEs to which DW_AT_linkage_name may apply include:
1432 // TAG_common_block, TAG_constant, TAG_entry_point, TAG_subprogram and
1434 addString(IsStaticMember && VariableSpecDIE ?
1435 VariableSpecDIE : VariableDIE, dwarf::DW_AT_MIPS_linkage_name,
1436 GlobalValue::getRealLinkageName(LinkageName));
1437 // In compatibility mode with older gdbs we put the linkage name on both
1438 // the TAG_variable DIE and on the TAG_member DIE.
1439 if (IsStaticMember && VariableSpecDIE && DD->useDarwinGDBCompat())
1440 addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name,
1441 GlobalValue::getRealLinkageName(LinkageName));
1443 } else if (const ConstantInt *CI =
1444 dyn_cast_or_null<ConstantInt>(GV.getConstant())) {
1445 // AT_const_value was added when the static member was created. To avoid
1446 // emitting AT_const_value multiple times, we only add AT_const_value when
1447 // it is not a static member.
1448 if (!IsStaticMember)
1449 addConstantValue(VariableDIE, CI, GTy.isUnsignedDIType());
1450 } else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
1451 addToAccelTable = true;
1452 // GV is a merged global.
1453 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1454 Value *Ptr = CE->getOperand(0);
1455 addOpAddress(Block, Asm->Mang->getSymbol(cast<GlobalValue>(Ptr)));
1456 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1457 SmallVector<Value*, 3> Idx(CE->op_begin()+1, CE->op_end());
1458 addUInt(Block, 0, dwarf::DW_FORM_udata,
1459 Asm->getDataLayout().getIndexedOffset(Ptr->getType(), Idx));
1460 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1461 addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1464 if (addToAccelTable) {
1465 DIE *AddrDIE = VariableSpecDIE ? VariableSpecDIE : VariableDIE;
1466 addAccelName(GV.getName(), AddrDIE);
1468 // If the linkage name is different than the name, go ahead and output
1469 // that as well into the name table.
1470 if (GV.getLinkageName() != "" && GV.getName() != GV.getLinkageName())
1471 addAccelName(GV.getLinkageName(), AddrDIE);
1475 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1476 void CompileUnit::constructSubrangeDIE(DIE &Buffer, DISubrange SR,
1478 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1479 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
1481 // The LowerBound value defines the lower bounds which is typically zero for
1482 // C/C++. The Count value is the number of elements. Values are 64 bit. If
1483 // Count == -1 then the array is unbounded and we do not emit
1484 // DW_AT_lower_bound and DW_AT_upper_bound attributes. If LowerBound == 0 and
1485 // Count == 0, then the array has zero elements in which case we do not emit
1487 int64_t LowerBound = SR.getLo();
1488 int64_t DefaultLowerBound = getDefaultLowerBound();
1489 int64_t Count = SR.getCount();
1491 if (DefaultLowerBound == -1 || LowerBound != DefaultLowerBound)
1492 addUInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, LowerBound);
1494 if (Count != -1 && Count != 0)
1495 // FIXME: An unbounded array should reference the expression that defines
1497 addUInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, LowerBound + Count - 1);
1499 Buffer.addChild(DW_Subrange);
1502 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
1503 void CompileUnit::constructArrayTypeDIE(DIE &Buffer,
1504 DICompositeType *CTy) {
1505 Buffer.setTag(dwarf::DW_TAG_array_type);
1506 if (CTy->isVector())
1507 addFlag(&Buffer, dwarf::DW_AT_GNU_vector);
1509 // Emit derived type.
1510 addType(&Buffer, CTy->getTypeDerivedFrom());
1511 DIArray Elements = CTy->getTypeArray();
1513 // Get an anonymous type for index type.
1514 // FIXME: This type should be passed down from the front end
1515 // as different languages may have different sizes for indexes.
1516 DIE *IdxTy = getIndexTyDie();
1518 // Construct an anonymous type for index type.
1519 IdxTy = new DIE(dwarf::DW_TAG_base_type);
1520 addString(IdxTy, dwarf::DW_AT_name, "int");
1521 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1522 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1523 dwarf::DW_ATE_signed);
1525 setIndexTyDie(IdxTy);
1528 // Add subranges to array type.
1529 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1530 DIDescriptor Element = Elements.getElement(i);
1531 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1532 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
1536 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
1537 DIE *CompileUnit::constructEnumTypeDIE(DIEnumerator ETy) {
1538 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
1539 StringRef Name = ETy.getName();
1540 addString(Enumerator, dwarf::DW_AT_name, Name);
1541 int64_t Value = ETy.getEnumValue();
1542 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
1546 /// constructContainingTypeDIEs - Construct DIEs for types that contain
1548 void CompileUnit::constructContainingTypeDIEs() {
1549 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
1550 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1551 DIE *SPDie = CI->first;
1552 const MDNode *N = CI->second;
1554 DIE *NDie = getDIE(N);
1555 if (!NDie) continue;
1556 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
1560 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
1561 DIE *CompileUnit::constructVariableDIE(DbgVariable *DV,
1562 bool isScopeAbstract) {
1563 StringRef Name = DV->getName();
1565 // Translate tag to proper Dwarf tag.
1566 unsigned Tag = DV->getTag();
1568 // Define variable debug information entry.
1569 DIE *VariableDie = new DIE(Tag);
1570 DbgVariable *AbsVar = DV->getAbstractVariable();
1571 DIE *AbsDIE = AbsVar ? AbsVar->getDIE() : NULL;
1573 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
1574 dwarf::DW_FORM_ref4, AbsDIE);
1576 addString(VariableDie, dwarf::DW_AT_name, Name);
1577 addSourceLine(VariableDie, DV->getVariable());
1578 addType(VariableDie, DV->getType());
1581 if (DV->isArtificial())
1582 addFlag(VariableDie, dwarf::DW_AT_artificial);
1584 if (isScopeAbstract) {
1585 DV->setDIE(VariableDie);
1589 // Add variable address.
1591 unsigned Offset = DV->getDotDebugLocOffset();
1592 if (Offset != ~0U) {
1593 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1594 Asm->GetTempSymbol("debug_loc", Offset));
1595 DV->setDIE(VariableDie);
1599 // Check if variable is described by a DBG_VALUE instruction.
1600 if (const MachineInstr *DVInsn = DV->getMInsn()) {
1601 assert(DVInsn->getNumOperands() == 3);
1602 if (DVInsn->getOperand(0).isReg()) {
1603 const MachineOperand RegOp = DVInsn->getOperand(0);
1604 // If the second operand is an immediate, this is an indirect value.
1605 if (DVInsn->getOperand(1).isImm()) {
1606 MachineLocation Location(RegOp.getReg(), DVInsn->getOperand(1).getImm());
1607 addVariableAddress(*DV, VariableDie, Location);
1608 } else if (RegOp.getReg())
1609 addVariableAddress(*DV, VariableDie, MachineLocation(RegOp.getReg()));
1610 } else if (DVInsn->getOperand(0).isImm())
1611 addConstantValue(VariableDie, DVInsn->getOperand(0), DV->getType());
1612 else if (DVInsn->getOperand(0).isFPImm())
1613 addConstantFPValue(VariableDie, DVInsn->getOperand(0));
1614 else if (DVInsn->getOperand(0).isCImm())
1615 addConstantValue(VariableDie, DVInsn->getOperand(0).getCImm(),
1616 DV->getType().isUnsignedDIType());
1618 DV->setDIE(VariableDie);
1621 // .. else use frame index.
1622 int FI = DV->getFrameIndex();
1624 unsigned FrameReg = 0;
1625 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
1627 TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1628 MachineLocation Location(FrameReg, Offset);
1629 addVariableAddress(*DV, VariableDie, Location);
1633 DV->setDIE(VariableDie);
1637 /// createMemberDIE - Create new member DIE.
1638 DIE *CompileUnit::createMemberDIE(DIDerivedType DT) {
1639 DIE *MemberDie = new DIE(DT.getTag());
1640 StringRef Name = DT.getName();
1642 addString(MemberDie, dwarf::DW_AT_name, Name);
1644 addType(MemberDie, DT.getTypeDerivedFrom());
1646 addSourceLine(MemberDie, DT);
1648 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
1649 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1651 uint64_t Size = DT.getSizeInBits();
1652 uint64_t FieldSize = DT.getOriginalTypeSize();
1654 if (Size != FieldSize) {
1656 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1657 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
1659 uint64_t Offset = DT.getOffsetInBits();
1660 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1661 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1662 uint64_t FieldOffset = (HiMark - FieldSize);
1663 Offset -= FieldOffset;
1665 // Maybe we need to work from the other end.
1666 if (Asm->getDataLayout().isLittleEndian())
1667 Offset = FieldSize - (Offset + Size);
1668 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
1670 // Here WD_AT_data_member_location points to the anonymous
1671 // field that includes this bit field.
1672 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
1675 // This is not a bitfield.
1676 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
1678 if (DT.getTag() == dwarf::DW_TAG_inheritance
1679 && DT.isVirtual()) {
1681 // For C++, virtual base classes are not at fixed offset. Use following
1682 // expression to extract appropriate offset from vtable.
1683 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1685 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
1686 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1687 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1688 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1689 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1690 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1691 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1692 addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1694 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
1697 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
1699 if (DT.isProtected())
1700 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1701 dwarf::DW_ACCESS_protected);
1702 else if (DT.isPrivate())
1703 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1704 dwarf::DW_ACCESS_private);
1705 // Otherwise C++ member and base classes are considered public.
1707 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1708 dwarf::DW_ACCESS_public);
1710 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
1711 dwarf::DW_VIRTUALITY_virtual);
1713 // Objective-C properties.
1714 if (MDNode *PNode = DT.getObjCProperty())
1715 if (DIEEntry *PropertyDie = getDIEEntry(PNode))
1716 MemberDie->addValue(dwarf::DW_AT_APPLE_property, dwarf::DW_FORM_ref4,
1719 if (DT.isArtificial())
1720 addFlag(MemberDie, dwarf::DW_AT_artificial);
1725 /// createStaticMemberDIE - Create new DIE for C++ static member.
1726 DIE *CompileUnit::createStaticMemberDIE(const DIDerivedType DT) {
1730 DIE *StaticMemberDIE = new DIE(DT.getTag());
1731 DIType Ty = DT.getTypeDerivedFrom();
1733 addString(StaticMemberDIE, dwarf::DW_AT_name, DT.getName());
1734 addType(StaticMemberDIE, Ty);
1735 addSourceLine(StaticMemberDIE, DT);
1736 addFlag(StaticMemberDIE, dwarf::DW_AT_external);
1737 addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
1739 // FIXME: We could omit private if the parent is a class_type, and
1740 // public if the parent is something else.
1741 if (DT.isProtected())
1742 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1743 dwarf::DW_ACCESS_protected);
1744 else if (DT.isPrivate())
1745 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1746 dwarf::DW_ACCESS_private);
1748 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1749 dwarf::DW_ACCESS_public);
1751 if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT.getConstant()))
1752 addConstantValue(StaticMemberDIE, CI, Ty.isUnsignedDIType());
1753 if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT.getConstant()))
1754 addConstantFPValue(StaticMemberDIE, CFP);
1756 insertDIE(DT, StaticMemberDIE);
1757 return StaticMemberDIE;