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/MC/MCSection.h"
26 #include "llvm/MC/MCStreamer.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, DIE *D, const MDNode *N, AsmPrinter *A,
37 DwarfDebug *DW, DwarfUnits *DWU)
38 : UniqueID(UID), Node(N), CUDie(D), Asm(A), DD(DW), DU(DWU), IndexTyDie(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 {
60 switch (DICompileUnit(Node).getLanguage()) {
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 /// Check whether the DIE for this MDNode can be shared across CUs.
102 static bool isShareableAcrossCUs(const MDNode *N) {
103 // When the MDNode can be part of the type system, the DIE can be
104 // shared across CUs.
105 return DIDescriptor(N).isType() ||
106 (DIDescriptor(N).isSubprogram() && !DISubprogram(N).isDefinition());
109 /// getDIE - Returns the debug information entry map slot for the
110 /// specified debug variable. We delegate the request to DwarfDebug
111 /// when the DIE for this MDNode can be shared across CUs. The mappings
112 /// will be kept in DwarfDebug for shareable DIEs.
113 DIE *CompileUnit::getDIE(const MDNode *N) const {
114 if (isShareableAcrossCUs(N))
115 return DD->getDIE(N);
116 return MDNodeToDieMap.lookup(N);
119 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
120 /// when the DIE for this MDNode can be shared across CUs. The mappings
121 /// will be kept in DwarfDebug for shareable DIEs.
122 void CompileUnit::insertDIE(const MDNode *N, DIE *D) {
123 if (isShareableAcrossCUs(N)) {
127 MDNodeToDieMap.insert(std::make_pair(N, D));
130 /// addFlag - Add a flag that is true.
131 void CompileUnit::addFlag(DIE *Die, dwarf::Attribute Attribute) {
132 if (DD->getDwarfVersion() >= 4)
133 Die->addValue(Attribute, dwarf::DW_FORM_flag_present, DIEIntegerOne);
135 Die->addValue(Attribute, dwarf::DW_FORM_flag, DIEIntegerOne);
138 /// addUInt - Add an unsigned integer attribute data and value.
140 void CompileUnit::addUInt(DIE *Die, dwarf::Attribute Attribute,
141 Optional<dwarf::Form> Form, uint64_t Integer) {
143 Form = DIEInteger::BestForm(false, Integer);
144 DIEValue *Value = Integer == 1 ? DIEIntegerOne : new (DIEValueAllocator)
146 Die->addValue(Attribute, *Form, Value);
149 void CompileUnit::addUInt(DIEBlock *Block, dwarf::Form Form, uint64_t Integer) {
150 addUInt(Block, (dwarf::Attribute)0, Form, Integer);
153 /// addSInt - Add an signed integer attribute data and value.
155 void CompileUnit::addSInt(DIE *Die, dwarf::Attribute Attribute,
156 Optional<dwarf::Form> Form, int64_t Integer) {
158 Form = DIEInteger::BestForm(true, Integer);
159 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
160 Die->addValue(Attribute, *Form, Value);
163 void CompileUnit::addSInt(DIEBlock *Die, Optional<dwarf::Form> Form,
165 addSInt(Die, (dwarf::Attribute)0, Form, Integer);
168 /// addString - Add a string attribute data and value. We always emit a
169 /// reference to the string pool instead of immediate strings so that DIEs have
170 /// more predictable sizes. In the case of split dwarf we emit an index
171 /// into another table which gets us the static offset into the string
173 void CompileUnit::addString(DIE *Die, dwarf::Attribute Attribute,
177 if (!DD->useSplitDwarf()) {
178 MCSymbol *Symb = DU->getStringPoolEntry(String);
179 if (Asm->needsRelocationsForDwarfStringPool())
180 Value = new (DIEValueAllocator) DIELabel(Symb);
182 MCSymbol *StringPool = DU->getStringPoolSym();
183 Value = new (DIEValueAllocator) DIEDelta(Symb, StringPool);
185 Form = dwarf::DW_FORM_strp;
187 unsigned idx = DU->getStringPoolIndex(String);
188 Value = new (DIEValueAllocator) DIEInteger(idx);
189 Form = dwarf::DW_FORM_GNU_str_index;
191 DIEValue *Str = new (DIEValueAllocator) DIEString(Value, String);
192 Die->addValue(Attribute, Form, Str);
195 /// addLocalString - Add a string attribute data and value. This is guaranteed
196 /// to be in the local string pool instead of indirected.
197 void CompileUnit::addLocalString(DIE *Die, dwarf::Attribute Attribute,
199 MCSymbol *Symb = DU->getStringPoolEntry(String);
201 if (Asm->needsRelocationsForDwarfStringPool())
202 Value = new (DIEValueAllocator) DIELabel(Symb);
204 MCSymbol *StringPool = DU->getStringPoolSym();
205 Value = new (DIEValueAllocator) DIEDelta(Symb, StringPool);
207 Die->addValue(Attribute, dwarf::DW_FORM_strp, Value);
210 /// addExpr - Add a Dwarf expression attribute data and value.
212 void CompileUnit::addExpr(DIEBlock *Die, dwarf::Form Form, const MCExpr *Expr) {
213 DIEValue *Value = new (DIEValueAllocator) DIEExpr(Expr);
214 Die->addValue((dwarf::Attribute)0, Form, Value);
217 /// addLabel - Add a Dwarf label attribute data and value.
219 void CompileUnit::addLabel(DIE *Die, dwarf::Attribute Attribute,
220 dwarf::Form Form, const MCSymbol *Label) {
221 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
222 Die->addValue(Attribute, Form, Value);
225 void CompileUnit::addLabel(DIEBlock *Die, dwarf::Form Form,
226 const MCSymbol *Label) {
227 addLabel(Die, (dwarf::Attribute)0, Form, Label);
230 /// addLabelAddress - Add a dwarf label attribute data and value using
231 /// DW_FORM_addr or DW_FORM_GNU_addr_index.
233 void CompileUnit::addLabelAddress(DIE *Die, dwarf::Attribute Attribute,
236 DD->addArangeLabel(SymbolCU(this, Label));
238 if (!DD->useSplitDwarf()) {
240 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
241 Die->addValue(Attribute, dwarf::DW_FORM_addr, Value);
243 DIEValue *Value = new (DIEValueAllocator) DIEInteger(0);
244 Die->addValue(Attribute, dwarf::DW_FORM_addr, Value);
247 unsigned idx = DU->getAddrPoolIndex(Label);
248 DIEValue *Value = new (DIEValueAllocator) DIEInteger(idx);
249 Die->addValue(Attribute, dwarf::DW_FORM_GNU_addr_index, Value);
253 /// addOpAddress - Add a dwarf op address data and value using the
254 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
256 void CompileUnit::addOpAddress(DIEBlock *Die, const MCSymbol *Sym) {
257 DD->addArangeLabel(SymbolCU(this, Sym));
258 if (!DD->useSplitDwarf()) {
259 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
260 addLabel(Die, dwarf::DW_FORM_udata, Sym);
262 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_addr_index);
263 addUInt(Die, dwarf::DW_FORM_GNU_addr_index, DU->getAddrPoolIndex(Sym));
267 /// addDelta - Add a label delta attribute data and value.
269 void CompileUnit::addDelta(DIE *Die, dwarf::Attribute Attribute,
270 dwarf::Form Form, const MCSymbol *Hi,
271 const MCSymbol *Lo) {
272 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
273 Die->addValue(Attribute, Form, Value);
276 /// addDIEEntry - Add a DIE attribute data and value.
278 void CompileUnit::addDIEEntry(DIE *Die, dwarf::Attribute Attribute,
280 addDIEEntry(Die, Attribute, createDIEEntry(Entry));
283 void CompileUnit::addDIEEntry(DIE *Die, dwarf::Attribute Attribute,
285 const DIE *DieCU = Die->getCompileUnitOrNull();
286 const DIE *EntryCU = Entry->getEntry()->getCompileUnitOrNull();
288 // We assume that Die belongs to this CU, if it is not linked to any CU yet.
291 EntryCU = getCUDie();
292 Die->addValue(Attribute, EntryCU == DieCU ? dwarf::DW_FORM_ref4
293 : dwarf::DW_FORM_ref_addr,
297 /// Create a DIE with the given Tag, add the DIE to its parent, and
298 /// call insertDIE if MD is not null.
299 DIE *CompileUnit::createAndAddDIE(unsigned Tag, DIE &Parent, const MDNode *MD) {
300 DIE *Die = new DIE(Tag);
301 Parent.addChild(Die);
307 /// addBlock - Add block data.
309 void CompileUnit::addBlock(DIE *Die, dwarf::Attribute Attribute,
311 Block->ComputeSize(Asm);
312 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
313 Die->addValue(Attribute, Block->BestForm(), Block);
316 /// addSourceLine - Add location information to specified debug information
318 void CompileUnit::addSourceLine(DIE *Die, DIVariable V) {
323 unsigned Line = V.getLineNumber();
327 DD->getOrCreateSourceID(V.getContext().getFilename(),
328 V.getContext().getDirectory(), getUniqueID());
329 assert(FileID && "Invalid file id");
330 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
331 addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
334 /// addSourceLine - Add location information to specified debug information
336 void CompileUnit::addSourceLine(DIE *Die, DIGlobalVariable G) {
337 // Verify global variable.
338 if (!G.isGlobalVariable())
341 unsigned Line = G.getLineNumber();
345 DD->getOrCreateSourceID(G.getFilename(), G.getDirectory(), getUniqueID());
346 assert(FileID && "Invalid file id");
347 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
348 addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
351 /// addSourceLine - Add location information to specified debug information
353 void CompileUnit::addSourceLine(DIE *Die, DISubprogram SP) {
354 // Verify subprogram.
355 if (!SP.isSubprogram())
358 // If the line number is 0, don't add it.
359 unsigned Line = SP.getLineNumber();
363 unsigned FileID = DD->getOrCreateSourceID(SP.getFilename(), SP.getDirectory(),
365 assert(FileID && "Invalid file id");
366 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
367 addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
370 /// addSourceLine - Add location information to specified debug information
372 void CompileUnit::addSourceLine(DIE *Die, DIType Ty) {
377 unsigned Line = Ty.getLineNumber();
380 unsigned FileID = DD->getOrCreateSourceID(Ty.getFilename(), Ty.getDirectory(),
382 assert(FileID && "Invalid file id");
383 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
384 addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
387 /// addSourceLine - Add location information to specified debug information
389 void CompileUnit::addSourceLine(DIE *Die, DIObjCProperty Ty) {
391 if (!Ty.isObjCProperty())
394 unsigned Line = Ty.getLineNumber();
397 DIFile File = Ty.getFile();
398 unsigned FileID = DD->getOrCreateSourceID(File.getFilename(),
399 File.getDirectory(), getUniqueID());
400 assert(FileID && "Invalid file id");
401 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
402 addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
405 /// addSourceLine - Add location information to specified debug information
407 void CompileUnit::addSourceLine(DIE *Die, DINameSpace NS) {
412 unsigned Line = NS.getLineNumber();
415 StringRef FN = NS.getFilename();
418 DD->getOrCreateSourceID(FN, NS.getDirectory(), getUniqueID());
419 assert(FileID && "Invalid file id");
420 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
421 addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
424 /// addVariableAddress - Add DW_AT_location attribute for a
425 /// DbgVariable based on provided MachineLocation.
426 void CompileUnit::addVariableAddress(const DbgVariable &DV, DIE *Die,
427 MachineLocation Location) {
428 if (DV.variableHasComplexAddress())
429 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
430 else if (DV.isBlockByrefVariable())
431 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
433 addAddress(Die, dwarf::DW_AT_location, Location,
434 DV.getVariable().isIndirect());
437 /// addRegisterOp - Add register operand.
438 void CompileUnit::addRegisterOp(DIEBlock *TheDie, unsigned Reg) {
439 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
440 unsigned DWReg = RI->getDwarfRegNum(Reg, false);
442 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + DWReg);
444 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
445 addUInt(TheDie, dwarf::DW_FORM_udata, DWReg);
449 /// addRegisterOffset - Add register offset.
450 void CompileUnit::addRegisterOffset(DIEBlock *TheDie, unsigned Reg,
452 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
453 unsigned DWReg = RI->getDwarfRegNum(Reg, false);
454 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
455 if (Reg == TRI->getFrameRegister(*Asm->MF))
456 // If variable offset is based in frame register then use fbreg.
457 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
459 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + DWReg);
461 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
462 addUInt(TheDie, dwarf::DW_FORM_udata, DWReg);
464 addSInt(TheDie, dwarf::DW_FORM_sdata, Offset);
467 /// addAddress - Add an address attribute to a die based on the location
469 void CompileUnit::addAddress(DIE *Die, dwarf::Attribute Attribute,
470 const MachineLocation &Location, bool Indirect) {
471 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
473 if (Location.isReg() && !Indirect)
474 addRegisterOp(Block, Location.getReg());
476 addRegisterOffset(Block, Location.getReg(), Location.getOffset());
477 if (Indirect && !Location.isReg()) {
478 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
482 // Now attach the location information to the DIE.
483 addBlock(Die, Attribute, Block);
486 /// addComplexAddress - Start with the address based on the location provided,
487 /// and generate the DWARF information necessary to find the actual variable
488 /// given the extra address information encoded in the DIVariable, starting from
489 /// the starting location. Add the DWARF information to the die.
491 void CompileUnit::addComplexAddress(const DbgVariable &DV, DIE *Die,
492 dwarf::Attribute Attribute,
493 const MachineLocation &Location) {
494 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
495 unsigned N = DV.getNumAddrElements();
497 if (Location.isReg()) {
498 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
499 // If first address element is OpPlus then emit
500 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
501 addRegisterOffset(Block, Location.getReg(), DV.getAddrElement(1));
504 addRegisterOp(Block, Location.getReg());
506 addRegisterOffset(Block, Location.getReg(), Location.getOffset());
509 uint64_t Element = DV.getAddrElement(i);
510 if (Element == DIBuilder::OpPlus) {
511 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
512 addUInt(Block, dwarf::DW_FORM_udata, DV.getAddrElement(++i));
513 } else if (Element == DIBuilder::OpDeref) {
514 if (!Location.isReg())
515 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
517 llvm_unreachable("unknown DIBuilder Opcode");
520 // Now attach the location information to the DIE.
521 addBlock(Die, Attribute, Block);
524 /* Byref variables, in Blocks, are declared by the programmer as "SomeType
525 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
526 gives the variable VarName either the struct, or a pointer to the struct, as
527 its type. This is necessary for various behind-the-scenes things the
528 compiler needs to do with by-reference variables in Blocks.
530 However, as far as the original *programmer* is concerned, the variable
531 should still have type 'SomeType', as originally declared.
533 The function getBlockByrefType dives into the __Block_byref_x_VarName
534 struct to find the original type of the variable, which is then assigned to
535 the variable's Debug Information Entry as its real type. So far, so good.
536 However now the debugger will expect the variable VarName to have the type
537 SomeType. So we need the location attribute for the variable to be an
538 expression that explains to the debugger how to navigate through the
539 pointers and struct to find the actual variable of type SomeType.
541 The following function does just that. We start by getting
542 the "normal" location for the variable. This will be the location
543 of either the struct __Block_byref_x_VarName or the pointer to the
544 struct __Block_byref_x_VarName.
546 The struct will look something like:
548 struct __Block_byref_x_VarName {
550 struct __Block_byref_x_VarName *forwarding;
551 ... <various other fields>
553 ... <maybe more fields>
556 If we are given the struct directly (as our starting point) we
557 need to tell the debugger to:
559 1). Add the offset of the forwarding field.
561 2). Follow that pointer to get the real __Block_byref_x_VarName
562 struct to use (the real one may have been copied onto the heap).
564 3). Add the offset for the field VarName, to find the actual variable.
566 If we started with a pointer to the struct, then we need to
567 dereference that pointer first, before the other steps.
568 Translating this into DWARF ops, we will need to append the following
569 to the current location description for the variable:
571 DW_OP_deref -- optional, if we start with a pointer
572 DW_OP_plus_uconst <forward_fld_offset>
574 DW_OP_plus_uconst <varName_fld_offset>
576 That is what this function does. */
578 /// addBlockByrefAddress - Start with the address based on the location
579 /// provided, and generate the DWARF information necessary to find the
580 /// actual Block variable (navigating the Block struct) based on the
581 /// starting location. Add the DWARF information to the die. For
582 /// more information, read large comment just above here.
584 void CompileUnit::addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
585 dwarf::Attribute Attribute,
586 const MachineLocation &Location) {
587 DIType Ty = DV.getType();
589 uint16_t Tag = Ty.getTag();
590 bool isPointer = false;
592 StringRef varName = DV.getName();
594 if (Tag == dwarf::DW_TAG_pointer_type) {
595 DIDerivedType DTy = DIDerivedType(Ty);
596 TmpTy = resolve(DTy.getTypeDerivedFrom());
600 DICompositeType blockStruct = DICompositeType(TmpTy);
602 // Find the __forwarding field and the variable field in the __Block_byref
604 DIArray Fields = blockStruct.getTypeArray();
605 DIDescriptor varField = DIDescriptor();
606 DIDescriptor forwardingField = DIDescriptor();
608 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
609 DIDescriptor Element = Fields.getElement(i);
610 DIDerivedType DT = DIDerivedType(Element);
611 StringRef fieldName = DT.getName();
612 if (fieldName == "__forwarding")
613 forwardingField = Element;
614 else if (fieldName == varName)
618 // Get the offsets for the forwarding field and the variable field.
619 unsigned forwardingFieldOffset =
620 DIDerivedType(forwardingField).getOffsetInBits() >> 3;
621 unsigned varFieldOffset = DIDerivedType(varField).getOffsetInBits() >> 3;
623 // Decode the original location, and use that as the start of the byref
624 // variable's location.
625 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
627 if (Location.isReg())
628 addRegisterOp(Block, Location.getReg());
630 addRegisterOffset(Block, Location.getReg(), Location.getOffset());
632 // If we started with a pointer to the __Block_byref... struct, then
633 // the first thing we need to do is dereference the pointer (DW_OP_deref).
635 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
637 // Next add the offset for the '__forwarding' field:
638 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
639 // adding the offset if it's 0.
640 if (forwardingFieldOffset > 0) {
641 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
642 addUInt(Block, dwarf::DW_FORM_udata, forwardingFieldOffset);
645 // Now dereference the __forwarding field to get to the real __Block_byref
646 // struct: DW_OP_deref.
647 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
649 // Now that we've got the real __Block_byref... struct, add the offset
650 // for the variable's field to get to the location of the actual variable:
651 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
652 if (varFieldOffset > 0) {
653 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
654 addUInt(Block, dwarf::DW_FORM_udata, varFieldOffset);
657 // Now attach the location information to the DIE.
658 addBlock(Die, Attribute, Block);
661 /// isTypeSigned - Return true if the type is signed.
662 static bool isTypeSigned(DwarfDebug *DD, DIType Ty, int *SizeInBits) {
663 if (Ty.isDerivedType())
664 return isTypeSigned(DD, DD->resolve(DIDerivedType(Ty).getTypeDerivedFrom()),
666 if (Ty.isBasicType())
667 if (DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed ||
668 DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed_char) {
669 *SizeInBits = Ty.getSizeInBits();
675 /// Return true if type encoding is unsigned.
676 static bool isUnsignedDIType(DwarfDebug *DD, DIType Ty) {
677 DIDerivedType DTy(Ty);
678 if (DTy.isDerivedType())
679 return isUnsignedDIType(DD, DD->resolve(DTy.getTypeDerivedFrom()));
682 if (BTy.isBasicType()) {
683 unsigned Encoding = BTy.getEncoding();
684 if (Encoding == dwarf::DW_ATE_unsigned ||
685 Encoding == dwarf::DW_ATE_unsigned_char ||
686 Encoding == dwarf::DW_ATE_boolean)
692 /// If this type is derived from a base type then return base type size.
693 static uint64_t getBaseTypeSize(DwarfDebug *DD, DIDerivedType Ty) {
694 unsigned Tag = Ty.getTag();
696 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
697 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
698 Tag != dwarf::DW_TAG_restrict_type)
699 return Ty.getSizeInBits();
701 DIType BaseType = DD->resolve(Ty.getTypeDerivedFrom());
703 // If this type is not derived from any type then take conservative approach.
704 if (!BaseType.isValid())
705 return Ty.getSizeInBits();
707 // If this is a derived type, go ahead and get the base type, unless it's a
708 // reference then it's just the size of the field. Pointer types have no need
709 // of this since they're a different type of qualification on the type.
710 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
711 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
712 return Ty.getSizeInBits();
714 if (BaseType.isDerivedType())
715 return getBaseTypeSize(DD, DIDerivedType(BaseType));
717 return BaseType.getSizeInBits();
720 /// addConstantValue - Add constant value entry in variable DIE.
721 void CompileUnit::addConstantValue(DIE *Die, const MachineOperand &MO,
723 // FIXME: This is a bit conservative/simple - it emits negative values at
724 // their maximum bit width which is a bit unfortunate (& doesn't prefer
725 // udata/sdata over dataN as suggested by the DWARF spec)
726 assert(MO.isImm() && "Invalid machine operand!");
728 bool SignedConstant = isTypeSigned(DD, Ty, &SizeInBits);
731 // If we're a signed constant definitely use sdata.
732 if (SignedConstant) {
733 addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, MO.getImm());
737 // Else use data for now unless it's larger than we can deal with.
738 switch (SizeInBits) {
740 Form = dwarf::DW_FORM_data1;
743 Form = dwarf::DW_FORM_data2;
746 Form = dwarf::DW_FORM_data4;
749 Form = dwarf::DW_FORM_data8;
752 Form = dwarf::DW_FORM_udata;
753 addUInt(Die, dwarf::DW_AT_const_value, Form, MO.getImm());
756 addUInt(Die, dwarf::DW_AT_const_value, Form, MO.getImm());
759 /// addConstantFPValue - Add constant value entry in variable DIE.
760 void CompileUnit::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
761 assert(MO.isFPImm() && "Invalid machine operand!");
762 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
763 APFloat FPImm = MO.getFPImm()->getValueAPF();
765 // Get the raw data form of the floating point.
766 const APInt FltVal = FPImm.bitcastToAPInt();
767 const char *FltPtr = (const char *)FltVal.getRawData();
769 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
770 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
771 int Incr = (LittleEndian ? 1 : -1);
772 int Start = (LittleEndian ? 0 : NumBytes - 1);
773 int Stop = (LittleEndian ? NumBytes : -1);
775 // Output the constant to DWARF one byte at a time.
776 for (; Start != Stop; Start += Incr)
777 addUInt(Block, dwarf::DW_FORM_data1, (unsigned char)0xFF & FltPtr[Start]);
779 addBlock(Die, dwarf::DW_AT_const_value, Block);
782 /// addConstantFPValue - Add constant value entry in variable DIE.
783 void CompileUnit::addConstantFPValue(DIE *Die, const ConstantFP *CFP) {
784 // Pass this down to addConstantValue as an unsigned bag of bits.
785 addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), true);
788 /// addConstantValue - Add constant value entry in variable DIE.
789 void CompileUnit::addConstantValue(DIE *Die, const ConstantInt *CI,
791 addConstantValue(Die, CI->getValue(), Unsigned);
794 // addConstantValue - Add constant value entry in variable DIE.
795 void CompileUnit::addConstantValue(DIE *Die, const APInt &Val, bool Unsigned) {
796 unsigned CIBitWidth = Val.getBitWidth();
797 if (CIBitWidth <= 64) {
798 // If we're a signed constant definitely use sdata.
800 addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
805 // Else use data for now unless it's larger than we can deal with.
807 switch (CIBitWidth) {
809 Form = dwarf::DW_FORM_data1;
812 Form = dwarf::DW_FORM_data2;
815 Form = dwarf::DW_FORM_data4;
818 Form = dwarf::DW_FORM_data8;
821 addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
825 addUInt(Die, dwarf::DW_AT_const_value, Form, Val.getZExtValue());
829 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
831 // Get the raw data form of the large APInt.
832 const uint64_t *Ptr64 = Val.getRawData();
834 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
835 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
837 // Output the constant to DWARF one byte at a time.
838 for (int i = 0; i < NumBytes; i++) {
841 c = Ptr64[i / 8] >> (8 * (i & 7));
843 c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7));
844 addUInt(Block, dwarf::DW_FORM_data1, c);
847 addBlock(Die, dwarf::DW_AT_const_value, Block);
850 /// addTemplateParams - Add template parameters into buffer.
851 void CompileUnit::addTemplateParams(DIE &Buffer, DIArray TParams) {
852 // Add template parameters.
853 for (unsigned i = 0, e = TParams.getNumElements(); i != e; ++i) {
854 DIDescriptor Element = TParams.getElement(i);
855 if (Element.isTemplateTypeParameter())
856 constructTemplateTypeParameterDIE(Buffer,
857 DITemplateTypeParameter(Element));
858 else if (Element.isTemplateValueParameter())
859 constructTemplateValueParameterDIE(Buffer,
860 DITemplateValueParameter(Element));
864 /// getOrCreateContextDIE - Get context owner's DIE.
865 DIE *CompileUnit::getOrCreateContextDIE(DIScope Context) {
866 if (!Context || Context.isFile())
868 if (Context.isType())
869 return getOrCreateTypeDIE(DIType(Context));
870 if (Context.isNameSpace())
871 return getOrCreateNameSpace(DINameSpace(Context));
872 if (Context.isSubprogram())
873 return getOrCreateSubprogramDIE(DISubprogram(Context));
874 if (DIE *ContextDIE = getDIE(Context))
879 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
881 DIE *CompileUnit::getOrCreateTypeDIE(const MDNode *TyNode) {
888 // Construct the context before querying for the existence of the DIE in case
889 // such construction creates the DIE.
890 DIE *ContextDIE = getOrCreateContextDIE(resolve(Ty.getContext()));
892 DIE *TyDIE = getDIE(Ty);
897 TyDIE = createAndAddDIE(Ty.getTag(), *ContextDIE, Ty);
899 if (Ty.isBasicType())
900 constructTypeDIE(*TyDIE, DIBasicType(Ty));
901 else if (Ty.isCompositeType())
902 constructTypeDIE(*TyDIE, DICompositeType(Ty));
904 assert(Ty.isDerivedType() && "Unknown kind of DIType");
905 constructTypeDIE(*TyDIE, DIDerivedType(Ty));
907 // If this is a named finished type then include it in the list of types
908 // for the accelerator tables.
909 if (!Ty.getName().empty() && !Ty.isForwardDecl()) {
910 bool IsImplementation = 0;
911 if (Ty.isCompositeType()) {
912 DICompositeType CT(Ty);
913 // A runtime language of 0 actually means C/C++ and that any
914 // non-negative value is some version of Objective-C/C++.
915 IsImplementation = (CT.getRunTimeLang() == 0) || CT.isObjcClassComplete();
917 unsigned Flags = IsImplementation ? dwarf::DW_FLAG_type_implementation : 0;
918 addAccelType(Ty.getName(), std::make_pair(TyDIE, Flags));
924 /// addType - Add a new type attribute to the specified entity.
925 void CompileUnit::addType(DIE *Entity, DIType Ty, dwarf::Attribute Attribute) {
926 assert(Ty && "Trying to add a type that doesn't exist?");
928 // Check for pre-existence.
929 DIEEntry *Entry = getDIEEntry(Ty);
930 // If it exists then use the existing value.
932 addDIEEntry(Entity, Attribute, Entry);
937 DIE *Buffer = getOrCreateTypeDIE(Ty);
940 Entry = createDIEEntry(Buffer);
941 insertDIEEntry(Ty, Entry);
942 addDIEEntry(Entity, Attribute, Entry);
944 // If this is a complete composite type then include it in the
945 // list of global types.
949 // Accelerator table mutators - add each name along with its companion
950 // DIE to the proper table while ensuring that the name that we're going
951 // to reference is in the string table. We do this since the names we
952 // add may not only be identical to the names in the DIE.
953 void CompileUnit::addAccelName(StringRef Name, DIE *Die) {
954 DU->getStringPoolEntry(Name);
955 std::vector<DIE *> &DIEs = AccelNames[Name];
959 void CompileUnit::addAccelObjC(StringRef Name, DIE *Die) {
960 DU->getStringPoolEntry(Name);
961 std::vector<DIE *> &DIEs = AccelObjC[Name];
965 void CompileUnit::addAccelNamespace(StringRef Name, DIE *Die) {
966 DU->getStringPoolEntry(Name);
967 std::vector<DIE *> &DIEs = AccelNamespace[Name];
971 void CompileUnit::addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die) {
972 DU->getStringPoolEntry(Name);
973 std::vector<std::pair<DIE *, unsigned> > &DIEs = AccelTypes[Name];
977 /// addGlobalName - Add a new global name to the compile unit.
978 void CompileUnit::addGlobalName(StringRef Name, DIE *Die, DIScope Context) {
979 std::string FullName = getParentContextString(Context) + Name.str();
980 GlobalNames[FullName] = Die;
983 /// addGlobalType - Add a new global type to the compile unit.
985 void CompileUnit::addGlobalType(DIType Ty) {
986 DIScope Context = resolve(Ty.getContext());
987 if (!Ty.getName().empty() && !Ty.isForwardDecl() &&
988 (!Context || Context.isCompileUnit() || Context.isFile() ||
989 Context.isNameSpace()))
990 if (DIEEntry *Entry = getDIEEntry(Ty)) {
991 std::string FullName =
992 getParentContextString(Context) + Ty.getName().str();
993 GlobalTypes[FullName] = Entry->getEntry();
997 /// getParentContextString - Walks the metadata parent chain in a language
998 /// specific manner (using the compile unit language) and returns
999 /// it as a string. This is done at the metadata level because DIEs may
1000 /// not currently have been added to the parent context and walking the
1001 /// DIEs looking for names is more expensive than walking the metadata.
1002 std::string CompileUnit::getParentContextString(DIScope Context) const {
1006 // FIXME: Decide whether to implement this for non-C++ languages.
1007 if (getLanguage() != dwarf::DW_LANG_C_plus_plus)
1011 SmallVector<DIScope, 1> Parents;
1012 while (!Context.isCompileUnit()) {
1013 Parents.push_back(Context);
1014 if (Context.getContext())
1015 Context = resolve(Context.getContext());
1017 // Structure, etc types will have a NULL context if they're at the top
1022 // Reverse iterate over our list to go from the outermost construct to the
1024 for (SmallVectorImpl<DIScope>::reverse_iterator I = Parents.rbegin(),
1028 StringRef Name = Ctx.getName();
1029 if (!Name.empty()) {
1037 /// addPubTypes - Add subprogram argument types for pubtypes section.
1038 void CompileUnit::addPubTypes(DISubprogram SP) {
1039 DICompositeType SPTy = SP.getType();
1040 uint16_t SPTag = SPTy.getTag();
1041 if (SPTag != dwarf::DW_TAG_subroutine_type)
1044 DIArray Args = SPTy.getTypeArray();
1045 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
1046 DIType ATy(Args.getElement(i));
1053 /// constructTypeDIE - Construct basic type die from DIBasicType.
1054 void CompileUnit::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
1055 // Get core information.
1056 StringRef Name = BTy.getName();
1057 // Add name if not anonymous or intermediate type.
1059 addString(&Buffer, dwarf::DW_AT_name, Name);
1061 // An unspecified type only has a name attribute.
1062 if (BTy.getTag() == dwarf::DW_TAG_unspecified_type)
1065 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1068 uint64_t Size = BTy.getSizeInBits() >> 3;
1069 addUInt(&Buffer, dwarf::DW_AT_byte_size, None, Size);
1072 /// constructTypeDIE - Construct derived type die from DIDerivedType.
1073 void CompileUnit::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
1074 // Get core information.
1075 StringRef Name = DTy.getName();
1076 uint64_t Size = DTy.getSizeInBits() >> 3;
1077 uint16_t Tag = Buffer.getTag();
1079 // Map to main type, void will not have a type.
1080 DIType FromTy = resolve(DTy.getTypeDerivedFrom());
1082 addType(&Buffer, FromTy);
1084 // Add name if not anonymous or intermediate type.
1086 addString(&Buffer, dwarf::DW_AT_name, Name);
1088 // Add size if non-zero (derived types might be zero-sized.)
1089 if (Size && Tag != dwarf::DW_TAG_pointer_type)
1090 addUInt(&Buffer, dwarf::DW_AT_byte_size, None, Size);
1092 if (Tag == dwarf::DW_TAG_ptr_to_member_type)
1093 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type,
1094 getOrCreateTypeDIE(resolve(DTy.getClassType())));
1095 // Add source line info if available and TyDesc is not a forward declaration.
1096 if (!DTy.isForwardDecl())
1097 addSourceLine(&Buffer, DTy);
1100 /// Return true if the type is appropriately scoped to be contained inside
1101 /// its own type unit.
1102 static bool isTypeUnitScoped(DIType Ty, const DwarfDebug *DD) {
1103 DIScope Parent = DD->resolve(Ty.getContext());
1105 // Don't generate a hash for anything scoped inside a function.
1106 if (Parent.isSubprogram())
1108 Parent = DD->resolve(Parent.getContext());
1113 /// Return true if the type should be split out into a type unit.
1114 static bool shouldCreateTypeUnit(DICompositeType CTy, const DwarfDebug *DD) {
1115 uint16_t Tag = CTy.getTag();
1118 case dwarf::DW_TAG_structure_type:
1119 case dwarf::DW_TAG_union_type:
1120 case dwarf::DW_TAG_enumeration_type:
1121 case dwarf::DW_TAG_class_type:
1122 // If this is a class, structure, union, or enumeration type
1123 // that is a definition (not a declaration), and not scoped
1124 // inside a function then separate this out as a type unit.
1125 return !CTy.isForwardDecl() && isTypeUnitScoped(CTy, DD);
1131 /// constructTypeDIE - Construct type DIE from DICompositeType.
1132 void CompileUnit::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
1133 // Get core information.
1134 StringRef Name = CTy.getName();
1136 uint64_t Size = CTy.getSizeInBits() >> 3;
1137 uint16_t Tag = Buffer.getTag();
1140 case dwarf::DW_TAG_array_type:
1141 constructArrayTypeDIE(Buffer, CTy);
1143 case dwarf::DW_TAG_enumeration_type:
1144 constructEnumTypeDIE(Buffer, CTy);
1146 case dwarf::DW_TAG_subroutine_type: {
1147 // Add return type. A void return won't have a type.
1148 DIArray Elements = CTy.getTypeArray();
1149 DIDescriptor RTy = Elements.getElement(0);
1151 addType(&Buffer, DIType(RTy));
1153 bool isPrototyped = true;
1155 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1156 DIDescriptor Ty = Elements.getElement(i);
1157 if (Ty.isUnspecifiedParameter()) {
1158 createAndAddDIE(dwarf::DW_TAG_unspecified_parameters, Buffer);
1159 isPrototyped = false;
1161 DIE *Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, Buffer);
1162 addType(Arg, DIType(Ty));
1163 if (DIType(Ty).isArtificial())
1164 addFlag(Arg, dwarf::DW_AT_artificial);
1167 // Add prototype flag if we're dealing with a C language and the
1168 // function has been prototyped.
1169 uint16_t Language = DICompileUnit(Node).getLanguage();
1171 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
1172 Language == dwarf::DW_LANG_ObjC))
1173 addFlag(&Buffer, dwarf::DW_AT_prototyped);
1175 case dwarf::DW_TAG_structure_type:
1176 case dwarf::DW_TAG_union_type:
1177 case dwarf::DW_TAG_class_type: {
1178 // Add elements to structure type.
1179 DIArray Elements = CTy.getTypeArray();
1180 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1181 DIDescriptor Element = Elements.getElement(i);
1182 DIE *ElemDie = NULL;
1183 if (Element.isSubprogram()) {
1184 DISubprogram SP(Element);
1185 ElemDie = getOrCreateSubprogramDIE(DISubprogram(Element));
1186 if (SP.isProtected())
1187 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1188 dwarf::DW_ACCESS_protected);
1189 else if (SP.isPrivate())
1190 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1191 dwarf::DW_ACCESS_private);
1193 addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1194 dwarf::DW_ACCESS_public);
1195 if (SP.isExplicit())
1196 addFlag(ElemDie, dwarf::DW_AT_explicit);
1197 } else if (Element.isDerivedType()) {
1198 DIDerivedType DDTy(Element);
1199 if (DDTy.getTag() == dwarf::DW_TAG_friend) {
1200 ElemDie = createAndAddDIE(dwarf::DW_TAG_friend, Buffer);
1201 addType(ElemDie, resolve(DDTy.getTypeDerivedFrom()),
1202 dwarf::DW_AT_friend);
1203 } else if (DDTy.isStaticMember()) {
1204 getOrCreateStaticMemberDIE(DDTy);
1206 constructMemberDIE(Buffer, DDTy);
1208 } else if (Element.isObjCProperty()) {
1209 DIObjCProperty Property(Element);
1210 ElemDie = createAndAddDIE(Property.getTag(), Buffer);
1211 StringRef PropertyName = Property.getObjCPropertyName();
1212 addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
1213 addType(ElemDie, Property.getType());
1214 addSourceLine(ElemDie, Property);
1215 StringRef GetterName = Property.getObjCPropertyGetterName();
1216 if (!GetterName.empty())
1217 addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
1218 StringRef SetterName = Property.getObjCPropertySetterName();
1219 if (!SetterName.empty())
1220 addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
1221 unsigned PropertyAttributes = 0;
1222 if (Property.isReadOnlyObjCProperty())
1223 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readonly;
1224 if (Property.isReadWriteObjCProperty())
1225 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readwrite;
1226 if (Property.isAssignObjCProperty())
1227 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_assign;
1228 if (Property.isRetainObjCProperty())
1229 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_retain;
1230 if (Property.isCopyObjCProperty())
1231 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_copy;
1232 if (Property.isNonAtomicObjCProperty())
1233 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_nonatomic;
1234 if (PropertyAttributes)
1235 addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, None,
1236 PropertyAttributes);
1238 DIEEntry *Entry = getDIEEntry(Element);
1240 Entry = createDIEEntry(ElemDie);
1241 insertDIEEntry(Element, Entry);
1247 if (CTy.isAppleBlockExtension())
1248 addFlag(&Buffer, dwarf::DW_AT_APPLE_block);
1250 DICompositeType ContainingType(resolve(CTy.getContainingType()));
1251 if (DIDescriptor(ContainingType).isCompositeType())
1252 addDIEEntry(&Buffer, dwarf::DW_AT_containing_type,
1253 getOrCreateTypeDIE(DIType(ContainingType)));
1255 if (CTy.isObjcClassComplete())
1256 addFlag(&Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
1258 // Add template parameters to a class, structure or union types.
1259 // FIXME: The support isn't in the metadata for this yet.
1260 if (Tag == dwarf::DW_TAG_class_type ||
1261 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1262 addTemplateParams(Buffer, CTy.getTemplateParams());
1270 // Add name if not anonymous or intermediate type.
1272 addString(&Buffer, dwarf::DW_AT_name, Name);
1274 if (Tag == dwarf::DW_TAG_enumeration_type ||
1275 Tag == dwarf::DW_TAG_class_type || Tag == dwarf::DW_TAG_structure_type ||
1276 Tag == dwarf::DW_TAG_union_type) {
1277 // Add size if non-zero (derived types might be zero-sized.)
1278 // TODO: Do we care about size for enum forward declarations?
1280 addUInt(&Buffer, dwarf::DW_AT_byte_size, None, Size);
1281 else if (!CTy.isForwardDecl())
1282 // Add zero size if it is not a forward declaration.
1283 addUInt(&Buffer, dwarf::DW_AT_byte_size, None, 0);
1285 // If we're a forward decl, say so.
1286 if (CTy.isForwardDecl())
1287 addFlag(&Buffer, dwarf::DW_AT_declaration);
1289 // Add source line info if available.
1290 if (!CTy.isForwardDecl())
1291 addSourceLine(&Buffer, CTy);
1293 // No harm in adding the runtime language to the declaration.
1294 unsigned RLang = CTy.getRunTimeLang();
1296 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class, dwarf::DW_FORM_data1,
1299 // If this is a type applicable to a type unit it then add it to the
1300 // list of types we'll compute a hash for later.
1301 if (shouldCreateTypeUnit(CTy, DD))
1302 DD->addTypeUnitType(&Buffer);
1305 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
1306 /// DITemplateTypeParameter.
1308 CompileUnit::constructTemplateTypeParameterDIE(DIE &Buffer,
1309 DITemplateTypeParameter TP) {
1311 createAndAddDIE(dwarf::DW_TAG_template_type_parameter, Buffer);
1312 // Add the type if it exists, it could be void and therefore no type.
1314 addType(ParamDIE, resolve(TP.getType()));
1315 if (!TP.getName().empty())
1316 addString(ParamDIE, dwarf::DW_AT_name, TP.getName());
1319 /// constructTemplateValueParameterDIE - Construct new DIE for the given
1320 /// DITemplateValueParameter.
1322 CompileUnit::constructTemplateValueParameterDIE(DIE &Buffer,
1323 DITemplateValueParameter VP) {
1324 DIE *ParamDIE = createAndAddDIE(VP.getTag(), Buffer);
1326 // Add the type if there is one, template template and template parameter
1327 // packs will not have a type.
1328 if (VP.getTag() == dwarf::DW_TAG_template_value_parameter)
1329 addType(ParamDIE, resolve(VP.getType()));
1330 if (!VP.getName().empty())
1331 addString(ParamDIE, dwarf::DW_AT_name, VP.getName());
1332 if (Value *Val = VP.getValue()) {
1333 if (ConstantInt *CI = dyn_cast<ConstantInt>(Val))
1334 addConstantValue(ParamDIE, CI,
1335 isUnsignedDIType(DD, resolve(VP.getType())));
1336 else if (GlobalValue *GV = dyn_cast<GlobalValue>(Val)) {
1337 // For declaration non-type template parameters (such as global values and
1339 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1340 addOpAddress(Block, Asm->getSymbol(GV));
1341 // Emit DW_OP_stack_value to use the address as the immediate value of the
1342 // parameter, rather than a pointer to it.
1343 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1344 addBlock(ParamDIE, dwarf::DW_AT_location, Block);
1345 } else if (VP.getTag() == dwarf::DW_TAG_GNU_template_template_param) {
1346 assert(isa<MDString>(Val));
1347 addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1348 cast<MDString>(Val)->getString());
1349 } else if (VP.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
1350 assert(isa<MDNode>(Val));
1351 DIArray A(cast<MDNode>(Val));
1352 addTemplateParams(*ParamDIE, A);
1357 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
1358 DIE *CompileUnit::getOrCreateNameSpace(DINameSpace NS) {
1359 // Construct the context before querying for the existence of the DIE in case
1360 // such construction creates the DIE.
1361 DIE *ContextDIE = getOrCreateContextDIE(NS.getContext());
1363 DIE *NDie = getDIE(NS);
1366 NDie = createAndAddDIE(dwarf::DW_TAG_namespace, *ContextDIE, NS);
1368 if (!NS.getName().empty()) {
1369 addString(NDie, dwarf::DW_AT_name, NS.getName());
1370 addAccelNamespace(NS.getName(), NDie);
1371 addGlobalName(NS.getName(), NDie, NS.getContext());
1373 addAccelNamespace("(anonymous namespace)", NDie);
1374 addSourceLine(NDie, NS);
1378 /// getOrCreateSubprogramDIE - Create new DIE using SP.
1379 DIE *CompileUnit::getOrCreateSubprogramDIE(DISubprogram SP) {
1380 // Construct the context before querying for the existence of the DIE in case
1381 // such construction creates the DIE (as is the case for member function
1383 DIE *ContextDIE = getOrCreateContextDIE(resolve(SP.getContext()));
1385 DIE *SPDie = getDIE(SP);
1389 DISubprogram SPDecl = SP.getFunctionDeclaration();
1390 if (SPDecl.isSubprogram())
1391 // Add subprogram definitions to the CU die directly.
1392 ContextDIE = CUDie.get();
1394 // DW_TAG_inlined_subroutine may refer to this DIE.
1395 SPDie = createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, SP);
1397 DIE *DeclDie = NULL;
1398 if (SPDecl.isSubprogram())
1399 DeclDie = getOrCreateSubprogramDIE(SPDecl);
1401 // Add function template parameters.
1402 addTemplateParams(*SPDie, SP.getTemplateParams());
1404 // If this DIE is going to refer declaration info using AT_specification
1405 // then there is no need to add other attributes.
1407 // Refer function declaration directly.
1408 addDIEEntry(SPDie, dwarf::DW_AT_specification, DeclDie);
1413 // Add the linkage name if we have one.
1414 StringRef LinkageName = SP.getLinkageName();
1415 if (!LinkageName.empty())
1416 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name,
1417 GlobalValue::getRealLinkageName(LinkageName));
1419 // Constructors and operators for anonymous aggregates do not have names.
1420 if (!SP.getName().empty())
1421 addString(SPDie, dwarf::DW_AT_name, SP.getName());
1423 addSourceLine(SPDie, SP);
1425 // Add the prototype if we have a prototype and we have a C like
1427 uint16_t Language = DICompileUnit(Node).getLanguage();
1428 if (SP.isPrototyped() &&
1429 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
1430 Language == dwarf::DW_LANG_ObjC))
1431 addFlag(SPDie, dwarf::DW_AT_prototyped);
1433 DICompositeType SPTy = SP.getType();
1434 assert(SPTy.getTag() == dwarf::DW_TAG_subroutine_type &&
1435 "the type of a subprogram should be a subroutine");
1437 DIArray Args = SPTy.getTypeArray();
1438 // Add a return type. If this is a type like a C/C++ void type we don't add a
1440 if (Args.getElement(0))
1441 addType(SPDie, DIType(Args.getElement(0)));
1443 unsigned VK = SP.getVirtuality();
1445 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
1446 DIEBlock *Block = getDIEBlock();
1447 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1448 addUInt(Block, dwarf::DW_FORM_udata, SP.getVirtualIndex());
1449 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, Block);
1450 ContainingTypeMap.insert(
1451 std::make_pair(SPDie, resolve(SP.getContainingType())));
1454 if (!SP.isDefinition()) {
1455 addFlag(SPDie, dwarf::DW_AT_declaration);
1457 // Add arguments. Do not add arguments for subprogram definition. They will
1458 // be handled while processing variables.
1459 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1460 DIE *Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, *SPDie);
1461 DIType ATy = DIType(Args.getElement(i));
1463 if (ATy.isArtificial())
1464 addFlag(Arg, dwarf::DW_AT_artificial);
1468 if (SP.isArtificial())
1469 addFlag(SPDie, dwarf::DW_AT_artificial);
1471 if (!SP.isLocalToUnit())
1472 addFlag(SPDie, dwarf::DW_AT_external);
1474 if (SP.isOptimized())
1475 addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
1477 if (unsigned isa = Asm->getISAEncoding()) {
1478 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1484 // Return const expression if value is a GEP to access merged global
1486 // i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
1487 static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
1488 const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
1489 if (!CE || CE->getNumOperands() != 3 ||
1490 CE->getOpcode() != Instruction::GetElementPtr)
1493 // First operand points to a global struct.
1494 Value *Ptr = CE->getOperand(0);
1495 if (!isa<GlobalValue>(Ptr) ||
1496 !isa<StructType>(cast<PointerType>(Ptr->getType())->getElementType()))
1499 // Second operand is zero.
1500 const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
1501 if (!CI || !CI->isZero())
1504 // Third operand is offset.
1505 if (!isa<ConstantInt>(CE->getOperand(2)))
1511 /// createGlobalVariableDIE - create global variable DIE.
1512 void CompileUnit::createGlobalVariableDIE(const MDNode *N) {
1513 // Check for pre-existence.
1517 DIGlobalVariable GV(N);
1518 if (!GV.isGlobalVariable())
1521 DIScope GVContext = GV.getContext();
1522 DIType GTy = GV.getType();
1524 // If this is a static data member definition, some attributes belong
1525 // to the declaration DIE.
1526 DIE *VariableDIE = NULL;
1527 bool IsStaticMember = false;
1528 DIDerivedType SDMDecl = GV.getStaticDataMemberDeclaration();
1529 if (SDMDecl.Verify()) {
1530 assert(SDMDecl.isStaticMember() && "Expected static member decl");
1531 // We need the declaration DIE that is in the static member's class.
1532 VariableDIE = getOrCreateStaticMemberDIE(SDMDecl);
1533 IsStaticMember = true;
1536 // If this is not a static data member definition, create the variable
1537 // DIE and add the initial set of attributes to it.
1539 // Construct the context before querying for the existence of the DIE in
1540 // case such construction creates the DIE.
1541 DIE *ContextDIE = getOrCreateContextDIE(GVContext);
1544 VariableDIE = createAndAddDIE(GV.getTag(), *ContextDIE, N);
1546 // Add name and type.
1547 addString(VariableDIE, dwarf::DW_AT_name, GV.getDisplayName());
1548 addType(VariableDIE, GTy);
1550 // Add scoping info.
1551 if (!GV.isLocalToUnit())
1552 addFlag(VariableDIE, dwarf::DW_AT_external);
1554 // Add line number info.
1555 addSourceLine(VariableDIE, GV);
1559 bool addToAccelTable = false;
1560 DIE *VariableSpecDIE = NULL;
1561 bool isGlobalVariable = GV.getGlobal() != NULL;
1562 if (isGlobalVariable) {
1563 addToAccelTable = true;
1564 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1565 const MCSymbol *Sym = Asm->getSymbol(GV.getGlobal());
1566 if (GV.getGlobal()->isThreadLocal()) {
1567 // FIXME: Make this work with -gsplit-dwarf.
1568 unsigned PointerSize = Asm->getDataLayout().getPointerSize();
1569 assert((PointerSize == 4 || PointerSize == 8) &&
1570 "Add support for other sizes if necessary");
1571 const MCExpr *Expr =
1572 Asm->getObjFileLowering().getDebugThreadLocalSymbol(Sym);
1573 // Based on GCC's support for TLS:
1574 if (!DD->useSplitDwarf()) {
1575 // 1) Start with a constNu of the appropriate pointer size
1576 addUInt(Block, dwarf::DW_FORM_data1,
1577 PointerSize == 4 ? dwarf::DW_OP_const4u : dwarf::DW_OP_const8u);
1578 // 2) containing the (relocated) offset of the TLS variable
1579 // within the module's TLS block.
1580 addExpr(Block, dwarf::DW_FORM_udata, Expr);
1582 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_const_index);
1583 addUInt(Block, dwarf::DW_FORM_udata, DU->getAddrPoolIndex(Expr));
1585 // 3) followed by a custom OP to make the debugger do a TLS lookup.
1586 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_push_tls_address);
1588 addOpAddress(Block, Sym);
1589 // Do not create specification DIE if context is either compile unit
1591 if (GVContext && GV.isDefinition() && !GVContext.isCompileUnit() &&
1592 !GVContext.isFile() && !DD->isSubprogramContext(GVContext)) {
1593 // Create specification DIE.
1594 VariableSpecDIE = createAndAddDIE(dwarf::DW_TAG_variable, *CUDie.get());
1595 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification, VariableDIE);
1596 addBlock(VariableSpecDIE, dwarf::DW_AT_location, Block);
1597 // A static member's declaration is already flagged as such.
1598 if (!SDMDecl.Verify())
1599 addFlag(VariableDIE, dwarf::DW_AT_declaration);
1601 addBlock(VariableDIE, dwarf::DW_AT_location, Block);
1603 // Add the linkage name.
1604 StringRef LinkageName = GV.getLinkageName();
1605 if (!LinkageName.empty())
1606 // From DWARF4: DIEs to which DW_AT_linkage_name may apply include:
1607 // TAG_common_block, TAG_constant, TAG_entry_point, TAG_subprogram and
1609 addString(IsStaticMember && VariableSpecDIE ? VariableSpecDIE
1611 dwarf::DW_AT_MIPS_linkage_name,
1612 GlobalValue::getRealLinkageName(LinkageName));
1613 } else if (const ConstantInt *CI =
1614 dyn_cast_or_null<ConstantInt>(GV.getConstant())) {
1615 // AT_const_value was added when the static member was created. To avoid
1616 // emitting AT_const_value multiple times, we only add AT_const_value when
1617 // it is not a static member.
1618 if (!IsStaticMember)
1619 addConstantValue(VariableDIE, CI, isUnsignedDIType(DD, GTy));
1620 } else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
1621 addToAccelTable = true;
1622 // GV is a merged global.
1623 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1624 Value *Ptr = CE->getOperand(0);
1625 addOpAddress(Block, Asm->getSymbol(cast<GlobalValue>(Ptr)));
1626 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1627 SmallVector<Value *, 3> Idx(CE->op_begin() + 1, CE->op_end());
1628 addUInt(Block, dwarf::DW_FORM_udata,
1629 Asm->getDataLayout().getIndexedOffset(Ptr->getType(), Idx));
1630 addUInt(Block, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1631 addBlock(VariableDIE, dwarf::DW_AT_location, Block);
1634 if (addToAccelTable) {
1635 DIE *AddrDIE = VariableSpecDIE ? VariableSpecDIE : VariableDIE;
1636 addAccelName(GV.getName(), AddrDIE);
1638 // If the linkage name is different than the name, go ahead and output
1639 // that as well into the name table.
1640 if (GV.getLinkageName() != "" && GV.getName() != GV.getLinkageName())
1641 addAccelName(GV.getLinkageName(), AddrDIE);
1644 if (!GV.isLocalToUnit())
1645 addGlobalName(GV.getName(), VariableSpecDIE ? VariableSpecDIE : VariableDIE,
1649 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1650 void CompileUnit::constructSubrangeDIE(DIE &Buffer, DISubrange SR,
1652 DIE *DW_Subrange = createAndAddDIE(dwarf::DW_TAG_subrange_type, Buffer);
1653 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, IndexTy);
1655 // The LowerBound value defines the lower bounds which is typically zero for
1656 // C/C++. The Count value is the number of elements. Values are 64 bit. If
1657 // Count == -1 then the array is unbounded and we do not emit
1658 // DW_AT_lower_bound and DW_AT_upper_bound attributes. If LowerBound == 0 and
1659 // Count == 0, then the array has zero elements in which case we do not emit
1661 int64_t LowerBound = SR.getLo();
1662 int64_t DefaultLowerBound = getDefaultLowerBound();
1663 int64_t Count = SR.getCount();
1665 if (DefaultLowerBound == -1 || LowerBound != DefaultLowerBound)
1666 addUInt(DW_Subrange, dwarf::DW_AT_lower_bound, None, LowerBound);
1668 if (Count != -1 && Count != 0)
1669 // FIXME: An unbounded array should reference the expression that defines
1671 addUInt(DW_Subrange, dwarf::DW_AT_upper_bound, None,
1672 LowerBound + Count - 1);
1675 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
1676 void CompileUnit::constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy) {
1678 addFlag(&Buffer, dwarf::DW_AT_GNU_vector);
1680 // Emit the element type.
1681 addType(&Buffer, resolve(CTy.getTypeDerivedFrom()));
1683 // Get an anonymous type for index type.
1684 // FIXME: This type should be passed down from the front end
1685 // as different languages may have different sizes for indexes.
1686 DIE *IdxTy = getIndexTyDie();
1688 // Construct an anonymous type for index type.
1689 IdxTy = createAndAddDIE(dwarf::DW_TAG_base_type, *CUDie.get());
1690 addString(IdxTy, dwarf::DW_AT_name, "int");
1691 addUInt(IdxTy, dwarf::DW_AT_byte_size, None, sizeof(int32_t));
1692 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1693 dwarf::DW_ATE_signed);
1694 setIndexTyDie(IdxTy);
1697 // Add subranges to array type.
1698 DIArray Elements = CTy.getTypeArray();
1699 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1700 DIDescriptor Element = Elements.getElement(i);
1701 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1702 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
1706 /// constructEnumTypeDIE - Construct an enum type DIE from DICompositeType.
1707 void CompileUnit::constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy) {
1708 DIArray Elements = CTy.getTypeArray();
1710 // Add enumerators to enumeration type.
1711 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1712 DIDescriptor Enum(Elements.getElement(i));
1713 DIEnumerator ETy = DIEnumerator(Enum);
1714 if (Enum.isEnumerator()) {
1715 DIE *Enumerator = createAndAddDIE(dwarf::DW_TAG_enumerator, Buffer);
1716 StringRef Name = ETy.getName();
1717 addString(Enumerator, dwarf::DW_AT_name, Name);
1718 int64_t Value = ETy.getEnumValue();
1719 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
1722 DIType DTy = resolve(CTy.getTypeDerivedFrom());
1724 addType(&Buffer, DTy);
1725 addFlag(&Buffer, dwarf::DW_AT_enum_class);
1729 /// constructContainingTypeDIEs - Construct DIEs for types that contain
1731 void CompileUnit::constructContainingTypeDIEs() {
1732 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
1733 CE = ContainingTypeMap.end();
1735 DIE *SPDie = CI->first;
1736 const MDNode *N = CI->second;
1739 DIE *NDie = getDIE(N);
1742 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, NDie);
1746 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
1747 DIE *CompileUnit::constructVariableDIE(DbgVariable &DV, bool isScopeAbstract) {
1748 StringRef Name = DV.getName();
1750 // Define variable debug information entry.
1751 DIE *VariableDie = new DIE(DV.getTag());
1752 DbgVariable *AbsVar = DV.getAbstractVariable();
1753 DIE *AbsDIE = AbsVar ? AbsVar->getDIE() : NULL;
1755 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin, AbsDIE);
1758 addString(VariableDie, dwarf::DW_AT_name, Name);
1759 addSourceLine(VariableDie, DV.getVariable());
1760 addType(VariableDie, DV.getType());
1763 if (DV.isArtificial())
1764 addFlag(VariableDie, dwarf::DW_AT_artificial);
1766 if (isScopeAbstract) {
1767 DV.setDIE(VariableDie);
1771 // Add variable address.
1773 unsigned Offset = DV.getDotDebugLocOffset();
1774 if (Offset != ~0U) {
1775 addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1776 Asm->GetTempSymbol("debug_loc", Offset));
1777 DV.setDIE(VariableDie);
1781 // Check if variable is described by a DBG_VALUE instruction.
1782 if (const MachineInstr *DVInsn = DV.getMInsn()) {
1783 assert(DVInsn->getNumOperands() == 3);
1784 if (DVInsn->getOperand(0).isReg()) {
1785 const MachineOperand RegOp = DVInsn->getOperand(0);
1786 // If the second operand is an immediate, this is an indirect value.
1787 if (DVInsn->getOperand(1).isImm()) {
1788 MachineLocation Location(RegOp.getReg(),
1789 DVInsn->getOperand(1).getImm());
1790 addVariableAddress(DV, VariableDie, Location);
1791 } else if (RegOp.getReg())
1792 addVariableAddress(DV, VariableDie, MachineLocation(RegOp.getReg()));
1793 } else if (DVInsn->getOperand(0).isImm())
1794 addConstantValue(VariableDie, DVInsn->getOperand(0), DV.getType());
1795 else if (DVInsn->getOperand(0).isFPImm())
1796 addConstantFPValue(VariableDie, DVInsn->getOperand(0));
1797 else if (DVInsn->getOperand(0).isCImm())
1798 addConstantValue(VariableDie, DVInsn->getOperand(0).getCImm(),
1799 isUnsignedDIType(DD, DV.getType()));
1801 DV.setDIE(VariableDie);
1804 // .. else use frame index.
1805 int FI = DV.getFrameIndex();
1807 unsigned FrameReg = 0;
1808 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
1809 int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1810 MachineLocation Location(FrameReg, Offset);
1811 addVariableAddress(DV, VariableDie, Location);
1815 DV.setDIE(VariableDie);
1819 /// constructMemberDIE - Construct member DIE from DIDerivedType.
1820 void CompileUnit::constructMemberDIE(DIE &Buffer, DIDerivedType DT) {
1821 DIE *MemberDie = createAndAddDIE(DT.getTag(), Buffer);
1822 StringRef Name = DT.getName();
1824 addString(MemberDie, dwarf::DW_AT_name, Name);
1826 addType(MemberDie, resolve(DT.getTypeDerivedFrom()));
1828 addSourceLine(MemberDie, DT);
1830 DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
1831 addUInt(MemLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1833 if (DT.getTag() == dwarf::DW_TAG_inheritance && DT.isVirtual()) {
1835 // For C++, virtual base classes are not at fixed offset. Use following
1836 // expression to extract appropriate offset from vtable.
1837 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1839 DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
1840 addUInt(VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1841 addUInt(VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1842 addUInt(VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1843 addUInt(VBaseLocationDie, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1844 addUInt(VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1845 addUInt(VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1846 addUInt(VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1848 addBlock(MemberDie, dwarf::DW_AT_data_member_location, VBaseLocationDie);
1850 uint64_t Size = DT.getSizeInBits();
1851 uint64_t FieldSize = getBaseTypeSize(DD, DT);
1852 uint64_t OffsetInBytes;
1854 if (Size != FieldSize) {
1856 addUInt(MemberDie, dwarf::DW_AT_byte_size, None,
1857 getBaseTypeSize(DD, DT) >> 3);
1858 addUInt(MemberDie, dwarf::DW_AT_bit_size, None, DT.getSizeInBits());
1860 uint64_t Offset = DT.getOffsetInBits();
1861 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1862 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1863 uint64_t FieldOffset = (HiMark - FieldSize);
1864 Offset -= FieldOffset;
1866 // Maybe we need to work from the other end.
1867 if (Asm->getDataLayout().isLittleEndian())
1868 Offset = FieldSize - (Offset + Size);
1869 addUInt(MemberDie, dwarf::DW_AT_bit_offset, None, Offset);
1871 // Here WD_AT_data_member_location points to the anonymous
1872 // field that includes this bit field.
1873 OffsetInBytes = FieldOffset >> 3;
1875 // This is not a bitfield.
1876 OffsetInBytes = DT.getOffsetInBits() >> 3;
1877 addUInt(MemberDie, dwarf::DW_AT_data_member_location, None, OffsetInBytes);
1880 if (DT.isProtected())
1881 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1882 dwarf::DW_ACCESS_protected);
1883 else if (DT.isPrivate())
1884 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1885 dwarf::DW_ACCESS_private);
1886 // Otherwise C++ member and base classes are considered public.
1888 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1889 dwarf::DW_ACCESS_public);
1891 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
1892 dwarf::DW_VIRTUALITY_virtual);
1894 // Objective-C properties.
1895 if (MDNode *PNode = DT.getObjCProperty())
1896 if (DIEEntry *PropertyDie = getDIEEntry(PNode))
1897 MemberDie->addValue(dwarf::DW_AT_APPLE_property, dwarf::DW_FORM_ref4,
1900 if (DT.isArtificial())
1901 addFlag(MemberDie, dwarf::DW_AT_artificial);
1904 /// getOrCreateStaticMemberDIE - Create new DIE for C++ static member.
1905 DIE *CompileUnit::getOrCreateStaticMemberDIE(const DIDerivedType DT) {
1909 // Construct the context before querying for the existence of the DIE in case
1910 // such construction creates the DIE.
1911 DIE *ContextDIE = getOrCreateContextDIE(resolve(DT.getContext()));
1912 assert(dwarf::isType(ContextDIE->getTag()) &&
1913 "Static member should belong to a type.");
1915 DIE *StaticMemberDIE = getDIE(DT);
1916 if (StaticMemberDIE)
1917 return StaticMemberDIE;
1919 StaticMemberDIE = createAndAddDIE(DT.getTag(), *ContextDIE, DT);
1921 DIType Ty = resolve(DT.getTypeDerivedFrom());
1923 addString(StaticMemberDIE, dwarf::DW_AT_name, DT.getName());
1924 addType(StaticMemberDIE, Ty);
1925 addSourceLine(StaticMemberDIE, DT);
1926 addFlag(StaticMemberDIE, dwarf::DW_AT_external);
1927 addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
1929 // FIXME: We could omit private if the parent is a class_type, and
1930 // public if the parent is something else.
1931 if (DT.isProtected())
1932 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1933 dwarf::DW_ACCESS_protected);
1934 else if (DT.isPrivate())
1935 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1936 dwarf::DW_ACCESS_private);
1938 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1939 dwarf::DW_ACCESS_public);
1941 if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT.getConstant()))
1942 addConstantValue(StaticMemberDIE, CI, isUnsignedDIType(DD, Ty));
1943 if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT.getConstant()))
1944 addConstantFPValue(StaticMemberDIE, CFP);
1946 return StaticMemberDIE;
1949 void CompileUnit::emitHeader(const MCSection *ASection,
1950 const MCSymbol *ASectionSym) {
1951 Asm->OutStreamer.AddComment("DWARF version number");
1952 Asm->EmitInt16(DD->getDwarfVersion());
1953 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
1954 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
1956 Asm->OutStreamer.AddComment("Address Size (in bytes)");
1957 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());