1 //===-- llvm/CodeGen/DwarfUnit.cpp - Dwarf Type and Compile Units ---------===//
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 #include "DwarfUnit.h"
15 #include "DwarfAccelTable.h"
16 #include "DwarfDebug.h"
17 #include "llvm/ADT/APFloat.h"
18 #include "llvm/IR/Constants.h"
19 #include "llvm/IR/DIBuilder.h"
20 #include "llvm/IR/DataLayout.h"
21 #include "llvm/IR/GlobalVariable.h"
22 #include "llvm/IR/Instructions.h"
23 #include "llvm/IR/Mangler.h"
24 #include "llvm/MC/MCAsmInfo.h"
25 #include "llvm/MC/MCContext.h"
26 #include "llvm/MC/MCSection.h"
27 #include "llvm/MC/MCStreamer.h"
28 #include "llvm/Support/CommandLine.h"
29 #include "llvm/Target/TargetFrameLowering.h"
30 #include "llvm/Target/TargetLoweringObjectFile.h"
31 #include "llvm/Target/TargetMachine.h"
32 #include "llvm/Target/TargetRegisterInfo.h"
36 #define DEBUG_TYPE "dwarfdebug"
39 GenerateDwarfTypeUnits("generate-type-units", cl::Hidden,
40 cl::desc("Generate DWARF4 type units."),
43 /// Unit - Unit constructor.
44 DwarfUnit::DwarfUnit(unsigned UID, dwarf::Tag UnitTag, DICompileUnit Node,
45 AsmPrinter *A, DwarfDebug *DW, DwarfFile *DWU)
46 : UniqueID(UID), CUNode(Node), UnitDie(UnitTag), DebugInfoOffset(0), Asm(A),
47 DD(DW), DU(DWU), IndexTyDie(nullptr), Section(nullptr),
49 assert(UnitTag == dwarf::DW_TAG_compile_unit ||
50 UnitTag == dwarf::DW_TAG_type_unit);
51 DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
54 DwarfCompileUnit::DwarfCompileUnit(unsigned UID, DICompileUnit Node,
55 AsmPrinter *A, DwarfDebug *DW,
57 : DwarfUnit(UID, dwarf::DW_TAG_compile_unit, Node, A, DW, DWU) {
58 insertDIE(Node, &getUnitDie());
61 DwarfTypeUnit::DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
62 DwarfDebug *DW, DwarfFile *DWU,
63 MCDwarfDwoLineTable *SplitLineTable)
64 : DwarfUnit(UID, dwarf::DW_TAG_type_unit, CU.getCUNode(), A, DW, DWU),
65 CU(CU), SplitLineTable(SplitLineTable) {
67 addSectionOffset(UnitDie, dwarf::DW_AT_stmt_list, 0);
70 /// ~Unit - Destructor for compile unit.
71 DwarfUnit::~DwarfUnit() {
72 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
73 DIEBlocks[j]->~DIEBlock();
74 for (unsigned j = 0, M = DIELocs.size(); j < M; ++j)
75 DIELocs[j]->~DIELoc();
78 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
79 /// information entry.
80 DIEEntry *DwarfUnit::createDIEEntry(DIE &Entry) {
81 DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
85 /// getDefaultLowerBound - Return the default lower bound for an array. If the
86 /// DWARF version doesn't handle the language, return -1.
87 int64_t DwarfUnit::getDefaultLowerBound() const {
88 switch (getLanguage()) {
92 case dwarf::DW_LANG_C89:
93 case dwarf::DW_LANG_C99:
94 case dwarf::DW_LANG_C:
95 case dwarf::DW_LANG_C_plus_plus:
96 case dwarf::DW_LANG_ObjC:
97 case dwarf::DW_LANG_ObjC_plus_plus:
100 case dwarf::DW_LANG_Fortran77:
101 case dwarf::DW_LANG_Fortran90:
102 case dwarf::DW_LANG_Fortran95:
105 // The languages below have valid values only if the DWARF version >= 4.
106 case dwarf::DW_LANG_Java:
107 case dwarf::DW_LANG_Python:
108 case dwarf::DW_LANG_UPC:
109 case dwarf::DW_LANG_D:
110 if (dwarf::DWARF_VERSION >= 4)
114 case dwarf::DW_LANG_Ada83:
115 case dwarf::DW_LANG_Ada95:
116 case dwarf::DW_LANG_Cobol74:
117 case dwarf::DW_LANG_Cobol85:
118 case dwarf::DW_LANG_Modula2:
119 case dwarf::DW_LANG_Pascal83:
120 case dwarf::DW_LANG_PLI:
121 if (dwarf::DWARF_VERSION >= 4)
129 /// Check whether the DIE for this MDNode can be shared across CUs.
130 static bool isShareableAcrossCUs(DIDescriptor D) {
131 // When the MDNode can be part of the type system, the DIE can be shared
133 // Combining type units and cross-CU DIE sharing is lower value (since
134 // cross-CU DIE sharing is used in LTO and removes type redundancy at that
135 // level already) but may be implementable for some value in projects
136 // building multiple independent libraries with LTO and then linking those
138 return (D.isType() ||
139 (D.isSubprogram() && !DISubprogram(D).isDefinition())) &&
140 !GenerateDwarfTypeUnits;
143 /// getDIE - Returns the debug information entry map slot for the
144 /// specified debug variable. We delegate the request to DwarfDebug
145 /// when the DIE for this MDNode can be shared across CUs. The mappings
146 /// will be kept in DwarfDebug for shareable DIEs.
147 DIE *DwarfUnit::getDIE(DIDescriptor D) const {
148 if (isShareableAcrossCUs(D))
149 return DD->getDIE(D);
150 return MDNodeToDieMap.lookup(D);
153 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
154 /// when the DIE for this MDNode can be shared across CUs. The mappings
155 /// will be kept in DwarfDebug for shareable DIEs.
156 void DwarfUnit::insertDIE(DIDescriptor Desc, DIE *D) {
157 if (isShareableAcrossCUs(Desc)) {
158 DD->insertDIE(Desc, D);
161 MDNodeToDieMap.insert(std::make_pair(Desc, D));
164 /// addFlag - Add a flag that is true.
165 void DwarfUnit::addFlag(DIE &Die, dwarf::Attribute Attribute) {
166 if (DD->getDwarfVersion() >= 4)
167 Die.addValue(Attribute, dwarf::DW_FORM_flag_present, DIEIntegerOne);
169 Die.addValue(Attribute, dwarf::DW_FORM_flag, DIEIntegerOne);
172 /// addUInt - Add an unsigned integer attribute data and value.
174 void DwarfUnit::addUInt(DIE &Die, dwarf::Attribute Attribute,
175 Optional<dwarf::Form> Form, uint64_t Integer) {
177 Form = DIEInteger::BestForm(false, Integer);
178 DIEValue *Value = Integer == 1 ? DIEIntegerOne : new (DIEValueAllocator)
180 Die.addValue(Attribute, *Form, Value);
183 void DwarfUnit::addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer) {
184 addUInt(Block, (dwarf::Attribute)0, Form, Integer);
187 /// addSInt - Add an signed integer attribute data and value.
189 void DwarfUnit::addSInt(DIE &Die, dwarf::Attribute Attribute,
190 Optional<dwarf::Form> Form, int64_t Integer) {
192 Form = DIEInteger::BestForm(true, Integer);
193 DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
194 Die.addValue(Attribute, *Form, Value);
197 void DwarfUnit::addSInt(DIELoc &Die, Optional<dwarf::Form> Form,
199 addSInt(Die, (dwarf::Attribute)0, Form, Integer);
202 /// addString - Add a string attribute data and value. We always emit a
203 /// reference to the string pool instead of immediate strings so that DIEs have
204 /// more predictable sizes. In the case of split dwarf we emit an index
205 /// into another table which gets us the static offset into the string
207 void DwarfUnit::addString(DIE &Die, dwarf::Attribute Attribute,
210 if (!DD->useSplitDwarf())
211 return addLocalString(Die, Attribute, String);
213 unsigned idx = DU->getStringPool().getIndex(*Asm, String);
214 DIEValue *Value = new (DIEValueAllocator) DIEInteger(idx);
215 DIEValue *Str = new (DIEValueAllocator) DIEString(Value, String);
216 Die.addValue(Attribute, dwarf::DW_FORM_GNU_str_index, Str);
219 /// addLocalString - Add a string attribute data and value. This is guaranteed
220 /// to be in the local string pool instead of indirected.
221 void DwarfUnit::addLocalString(DIE &Die, dwarf::Attribute Attribute,
223 MCSymbol *Symb = DU->getStringPool().getSymbol(*Asm, String);
225 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
226 Value = new (DIEValueAllocator) DIELabel(Symb);
228 MCSymbol *StringPool = DU->getStringPool().getSectionSymbol();
229 Value = new (DIEValueAllocator) DIEDelta(Symb, StringPool);
231 DIEValue *Str = new (DIEValueAllocator) DIEString(Value, String);
232 Die.addValue(Attribute, dwarf::DW_FORM_strp, Str);
235 /// addExpr - Add a Dwarf expression attribute data and value.
237 void DwarfUnit::addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr) {
238 DIEValue *Value = new (DIEValueAllocator) DIEExpr(Expr);
239 Die.addValue((dwarf::Attribute)0, Form, Value);
242 /// addLocationList - Add a Dwarf loclistptr attribute data and value.
244 void DwarfUnit::addLocationList(DIE &Die, dwarf::Attribute Attribute,
246 DIEValue *Value = new (DIEValueAllocator) DIELocList(Index);
247 dwarf::Form Form = DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
248 : dwarf::DW_FORM_data4;
249 Die.addValue(Attribute, Form, Value);
252 /// addLabel - Add a Dwarf label attribute data and value.
254 void DwarfUnit::addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
255 const MCSymbol *Label) {
256 DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
257 Die.addValue(Attribute, Form, Value);
260 void DwarfUnit::addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label) {
261 addLabel(Die, (dwarf::Attribute)0, Form, Label);
264 /// addSectionLabel - Add a Dwarf section label attribute data and value.
266 void DwarfUnit::addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
267 const MCSymbol *Label) {
268 if (DD->getDwarfVersion() >= 4)
269 addLabel(Die, Attribute, dwarf::DW_FORM_sec_offset, Label);
271 addLabel(Die, Attribute, dwarf::DW_FORM_data4, Label);
274 /// addSectionOffset - Add an offset into a section attribute data and value.
276 void DwarfUnit::addSectionOffset(DIE &Die, dwarf::Attribute Attribute,
278 if (DD->getDwarfVersion() >= 4)
279 addUInt(Die, Attribute, dwarf::DW_FORM_sec_offset, Integer);
281 addUInt(Die, Attribute, dwarf::DW_FORM_data4, Integer);
284 /// addLabelAddress - Add a dwarf label attribute data and value using
285 /// DW_FORM_addr or DW_FORM_GNU_addr_index.
287 void DwarfCompileUnit::addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
288 const MCSymbol *Label) {
290 if (!DD->useSplitDwarf())
291 return addLocalLabelAddress(Die, Attribute, Label);
294 DD->addArangeLabel(SymbolCU(this, Label));
296 unsigned idx = DD->getAddressPool().getIndex(Label);
297 DIEValue *Value = new (DIEValueAllocator) DIEInteger(idx);
298 Die.addValue(Attribute, dwarf::DW_FORM_GNU_addr_index, Value);
301 void DwarfCompileUnit::addLocalLabelAddress(DIE &Die,
302 dwarf::Attribute Attribute,
303 const MCSymbol *Label) {
305 DD->addArangeLabel(SymbolCU(this, Label));
307 Die.addValue(Attribute, dwarf::DW_FORM_addr,
308 Label ? (DIEValue *)new (DIEValueAllocator) DIELabel(Label)
309 : new (DIEValueAllocator) DIEInteger(0));
312 unsigned DwarfCompileUnit::getOrCreateSourceID(StringRef FileName, StringRef DirName) {
313 // If we print assembly, we can't separate .file entries according to
314 // compile units. Thus all files will belong to the default compile unit.
316 // FIXME: add a better feature test than hasRawTextSupport. Even better,
317 // extend .file to support this.
318 return Asm->OutStreamer.EmitDwarfFileDirective(
319 0, DirName, FileName,
320 Asm->OutStreamer.hasRawTextSupport() ? 0 : getUniqueID());
323 unsigned DwarfTypeUnit::getOrCreateSourceID(StringRef FileName, StringRef DirName) {
324 return SplitLineTable ? SplitLineTable->getFile(DirName, FileName)
325 : getCU().getOrCreateSourceID(FileName, DirName);
328 /// addOpAddress - Add a dwarf op address data and value using the
329 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
331 void DwarfUnit::addOpAddress(DIELoc &Die, const MCSymbol *Sym) {
332 if (!DD->useSplitDwarf()) {
333 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
334 addLabel(Die, dwarf::DW_FORM_udata, Sym);
336 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_addr_index);
337 addUInt(Die, dwarf::DW_FORM_GNU_addr_index,
338 DD->getAddressPool().getIndex(Sym));
342 /// addSectionDelta - Add a section label delta attribute data and value.
344 void DwarfUnit::addSectionDelta(DIE &Die, dwarf::Attribute Attribute,
345 const MCSymbol *Hi, const MCSymbol *Lo) {
346 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
347 Die.addValue(Attribute, DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
348 : dwarf::DW_FORM_data4,
352 void DwarfUnit::addLabelDelta(DIE &Die, dwarf::Attribute Attribute,
353 const MCSymbol *Hi, const MCSymbol *Lo) {
354 DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
355 Die.addValue(Attribute, dwarf::DW_FORM_data4, Value);
358 /// addDIEEntry - Add a DIE attribute data and value.
360 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry) {
361 addDIEEntry(Die, Attribute, createDIEEntry(Entry));
364 void DwarfUnit::addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type) {
365 // Flag the type unit reference as a declaration so that if it contains
366 // members (implicit special members, static data member definitions, member
367 // declarations for definitions in this CU, etc) consumers don't get confused
368 // and think this is a full definition.
369 addFlag(Die, dwarf::DW_AT_declaration);
371 Die.addValue(dwarf::DW_AT_signature, dwarf::DW_FORM_ref_sig8,
372 new (DIEValueAllocator) DIETypeSignature(Type));
375 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute,
377 const DIE *DieCU = Die.getUnitOrNull();
378 const DIE *EntryCU = Entry->getEntry().getUnitOrNull();
380 // We assume that Die belongs to this CU, if it is not linked to any CU yet.
381 DieCU = &getUnitDie();
383 EntryCU = &getUnitDie();
384 Die.addValue(Attribute,
385 EntryCU == DieCU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr,
389 /// Create a DIE with the given Tag, add the DIE to its parent, and
390 /// call insertDIE if MD is not null.
391 DIE &DwarfUnit::createAndAddDIE(unsigned Tag, DIE &Parent, DIDescriptor N) {
392 assert(Tag != dwarf::DW_TAG_auto_variable &&
393 Tag != dwarf::DW_TAG_arg_variable);
394 Parent.addChild(make_unique<DIE>((dwarf::Tag)Tag));
395 DIE &Die = *Parent.getChildren().back();
401 /// addBlock - Add block data.
403 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Loc) {
404 Loc->ComputeSize(Asm);
405 DIELocs.push_back(Loc); // Memoize so we can call the destructor later on.
406 Die.addValue(Attribute, Loc->BestForm(DD->getDwarfVersion()), Loc);
409 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute,
411 Block->ComputeSize(Asm);
412 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
413 Die.addValue(Attribute, Block->BestForm(), Block);
416 /// addSourceLine - Add location information to specified debug information
418 void DwarfUnit::addSourceLine(DIE &Die, unsigned Line, StringRef File,
419 StringRef Directory) {
423 unsigned FileID = getOrCreateSourceID(File, Directory);
424 assert(FileID && "Invalid file id");
425 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
426 addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
429 /// addSourceLine - Add location information to specified debug information
431 void DwarfUnit::addSourceLine(DIE &Die, DIVariable V) {
432 assert(V.isVariable());
434 addSourceLine(Die, V.getLineNumber(), V.getContext().getFilename(),
435 V.getContext().getDirectory());
438 /// addSourceLine - Add location information to specified debug information
440 void DwarfUnit::addSourceLine(DIE &Die, DIGlobalVariable G) {
441 assert(G.isGlobalVariable());
443 addSourceLine(Die, G.getLineNumber(), G.getFilename(), G.getDirectory());
446 /// addSourceLine - Add location information to specified debug information
448 void DwarfUnit::addSourceLine(DIE &Die, DISubprogram SP) {
449 assert(SP.isSubprogram());
451 addSourceLine(Die, SP.getLineNumber(), SP.getFilename(), SP.getDirectory());
454 /// addSourceLine - Add location information to specified debug information
456 void DwarfUnit::addSourceLine(DIE &Die, DIType Ty) {
459 addSourceLine(Die, Ty.getLineNumber(), Ty.getFilename(), Ty.getDirectory());
462 /// addSourceLine - Add location information to specified debug information
464 void DwarfUnit::addSourceLine(DIE &Die, DIObjCProperty Ty) {
465 assert(Ty.isObjCProperty());
467 DIFile File = Ty.getFile();
468 addSourceLine(Die, Ty.getLineNumber(), File.getFilename(),
469 File.getDirectory());
472 /// addSourceLine - Add location information to specified debug information
474 void DwarfUnit::addSourceLine(DIE &Die, DINameSpace NS) {
477 addSourceLine(Die, NS.getLineNumber(), NS.getFilename(), NS.getDirectory());
480 /// addVariableAddress - Add DW_AT_location attribute for a
481 /// DbgVariable based on provided MachineLocation.
482 void DwarfUnit::addVariableAddress(const DbgVariable &DV, DIE &Die,
483 MachineLocation Location) {
484 if (DV.variableHasComplexAddress())
485 addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
486 else if (DV.isBlockByrefVariable())
487 addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
489 addAddress(Die, dwarf::DW_AT_location, Location,
490 DV.getVariable().isIndirect());
493 /// addRegisterOp - Add register operand.
494 void DwarfUnit::addRegisterOp(DIELoc &TheDie, unsigned Reg) {
495 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
496 int DWReg = RI->getDwarfRegNum(Reg, false);
497 bool isSubRegister = DWReg < 0;
501 // Go up the super-register chain until we hit a valid dwarf register number.
502 for (MCSuperRegIterator SR(Reg, RI); SR.isValid() && DWReg < 0; ++SR) {
503 DWReg = RI->getDwarfRegNum(*SR, false);
505 Idx = RI->getSubRegIndex(*SR, Reg);
509 DEBUG(dbgs() << "Invalid Dwarf register number.\n");
510 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_nop);
516 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + DWReg);
518 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
519 addUInt(TheDie, dwarf::DW_FORM_udata, DWReg);
524 unsigned Size = RI->getSubRegIdxSize(Idx);
525 unsigned Offset = RI->getSubRegIdxOffset(Idx);
527 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_bit_piece);
528 addUInt(TheDie, dwarf::DW_FORM_data1, Size);
529 addUInt(TheDie, dwarf::DW_FORM_data1, Offset);
531 unsigned ByteSize = Size / 8; // Assuming 8 bits per byte.
532 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_piece);
533 addUInt(TheDie, dwarf::DW_FORM_data1, ByteSize);
538 /// addRegisterOffset - Add register offset.
539 void DwarfUnit::addRegisterOffset(DIELoc &TheDie, unsigned Reg,
541 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
542 unsigned DWReg = RI->getDwarfRegNum(Reg, false);
543 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
544 if (Reg == TRI->getFrameRegister(*Asm->MF))
545 // If variable offset is based in frame register then use fbreg.
546 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
548 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + DWReg);
550 addUInt(TheDie, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
551 addUInt(TheDie, dwarf::DW_FORM_udata, DWReg);
553 addSInt(TheDie, dwarf::DW_FORM_sdata, Offset);
556 /// addAddress - Add an address attribute to a die based on the location
558 void DwarfUnit::addAddress(DIE &Die, dwarf::Attribute Attribute,
559 const MachineLocation &Location, bool Indirect) {
560 DIELoc *Loc = new (DIEValueAllocator) DIELoc();
562 if (Location.isReg() && !Indirect)
563 addRegisterOp(*Loc, Location.getReg());
565 addRegisterOffset(*Loc, Location.getReg(), Location.getOffset());
566 if (Indirect && !Location.isReg()) {
567 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
571 // Now attach the location information to the DIE.
572 addBlock(Die, Attribute, Loc);
575 /// addComplexAddress - Start with the address based on the location provided,
576 /// and generate the DWARF information necessary to find the actual variable
577 /// given the extra address information encoded in the DbgVariable, starting
578 /// from the starting location. Add the DWARF information to the die.
580 void DwarfUnit::addComplexAddress(const DbgVariable &DV, DIE &Die,
581 dwarf::Attribute Attribute,
582 const MachineLocation &Location) {
583 DIELoc *Loc = new (DIEValueAllocator) DIELoc();
584 unsigned N = DV.getNumAddrElements();
586 if (Location.isReg()) {
587 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
588 // If first address element is OpPlus then emit
589 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
590 addRegisterOffset(*Loc, Location.getReg(), DV.getAddrElement(1));
593 addRegisterOp(*Loc, Location.getReg());
595 addRegisterOffset(*Loc, Location.getReg(), Location.getOffset());
598 uint64_t Element = DV.getAddrElement(i);
599 if (Element == DIBuilder::OpPlus) {
600 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
601 addUInt(*Loc, dwarf::DW_FORM_udata, DV.getAddrElement(++i));
602 } else if (Element == DIBuilder::OpDeref) {
603 if (!Location.isReg())
604 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
606 llvm_unreachable("unknown DIBuilder Opcode");
609 // Now attach the location information to the DIE.
610 addBlock(Die, Attribute, Loc);
613 /* Byref variables, in Blocks, are declared by the programmer as "SomeType
614 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
615 gives the variable VarName either the struct, or a pointer to the struct, as
616 its type. This is necessary for various behind-the-scenes things the
617 compiler needs to do with by-reference variables in Blocks.
619 However, as far as the original *programmer* is concerned, the variable
620 should still have type 'SomeType', as originally declared.
622 The function getBlockByrefType dives into the __Block_byref_x_VarName
623 struct to find the original type of the variable, which is then assigned to
624 the variable's Debug Information Entry as its real type. So far, so good.
625 However now the debugger will expect the variable VarName to have the type
626 SomeType. So we need the location attribute for the variable to be an
627 expression that explains to the debugger how to navigate through the
628 pointers and struct to find the actual variable of type SomeType.
630 The following function does just that. We start by getting
631 the "normal" location for the variable. This will be the location
632 of either the struct __Block_byref_x_VarName or the pointer to the
633 struct __Block_byref_x_VarName.
635 The struct will look something like:
637 struct __Block_byref_x_VarName {
639 struct __Block_byref_x_VarName *forwarding;
640 ... <various other fields>
642 ... <maybe more fields>
645 If we are given the struct directly (as our starting point) we
646 need to tell the debugger to:
648 1). Add the offset of the forwarding field.
650 2). Follow that pointer to get the real __Block_byref_x_VarName
651 struct to use (the real one may have been copied onto the heap).
653 3). Add the offset for the field VarName, to find the actual variable.
655 If we started with a pointer to the struct, then we need to
656 dereference that pointer first, before the other steps.
657 Translating this into DWARF ops, we will need to append the following
658 to the current location description for the variable:
660 DW_OP_deref -- optional, if we start with a pointer
661 DW_OP_plus_uconst <forward_fld_offset>
663 DW_OP_plus_uconst <varName_fld_offset>
665 That is what this function does. */
667 /// addBlockByrefAddress - Start with the address based on the location
668 /// provided, and generate the DWARF information necessary to find the
669 /// actual Block variable (navigating the Block struct) based on the
670 /// starting location. Add the DWARF information to the die. For
671 /// more information, read large comment just above here.
673 void DwarfUnit::addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
674 dwarf::Attribute Attribute,
675 const MachineLocation &Location) {
676 DIType Ty = DV.getType();
678 uint16_t Tag = Ty.getTag();
679 bool isPointer = false;
681 StringRef varName = DV.getName();
683 if (Tag == dwarf::DW_TAG_pointer_type) {
684 DIDerivedType DTy(Ty);
685 TmpTy = resolve(DTy.getTypeDerivedFrom());
689 DICompositeType blockStruct(TmpTy);
691 // Find the __forwarding field and the variable field in the __Block_byref
693 DIArray Fields = blockStruct.getTypeArray();
694 DIDerivedType varField;
695 DIDerivedType forwardingField;
697 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
698 DIDerivedType DT(Fields.getElement(i));
699 StringRef fieldName = DT.getName();
700 if (fieldName == "__forwarding")
701 forwardingField = DT;
702 else if (fieldName == varName)
706 // Get the offsets for the forwarding field and the variable field.
707 unsigned forwardingFieldOffset = forwardingField.getOffsetInBits() >> 3;
708 unsigned varFieldOffset = varField.getOffsetInBits() >> 2;
710 // Decode the original location, and use that as the start of the byref
711 // variable's location.
712 DIELoc *Loc = new (DIEValueAllocator) DIELoc();
714 if (Location.isReg())
715 addRegisterOp(*Loc, Location.getReg());
717 addRegisterOffset(*Loc, Location.getReg(), Location.getOffset());
719 // If we started with a pointer to the __Block_byref... struct, then
720 // the first thing we need to do is dereference the pointer (DW_OP_deref).
722 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
724 // Next add the offset for the '__forwarding' field:
725 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
726 // adding the offset if it's 0.
727 if (forwardingFieldOffset > 0) {
728 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
729 addUInt(*Loc, dwarf::DW_FORM_udata, forwardingFieldOffset);
732 // Now dereference the __forwarding field to get to the real __Block_byref
733 // struct: DW_OP_deref.
734 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
736 // Now that we've got the real __Block_byref... struct, add the offset
737 // for the variable's field to get to the location of the actual variable:
738 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
739 if (varFieldOffset > 0) {
740 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
741 addUInt(*Loc, dwarf::DW_FORM_udata, varFieldOffset);
744 // Now attach the location information to the DIE.
745 addBlock(Die, Attribute, Loc);
748 /// isTypeSigned - Return true if the type is signed.
749 static bool isTypeSigned(DwarfDebug *DD, DIType Ty) {
750 if (Ty.isDerivedType())
751 return isTypeSigned(DD,
752 DD->resolve(DIDerivedType(Ty).getTypeDerivedFrom()));
754 return Ty.isBasicType() &&
755 (DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed ||
756 DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed_char);
759 /// Return true if type encoding is unsigned.
760 static bool isUnsignedDIType(DwarfDebug *DD, DIType Ty) {
761 DIDerivedType DTy(Ty);
762 if (DTy.isDerivedType())
763 return isUnsignedDIType(DD, DD->resolve(DTy.getTypeDerivedFrom()));
766 if (BTy.isBasicType()) {
767 unsigned Encoding = BTy.getEncoding();
768 if (Encoding == dwarf::DW_ATE_unsigned ||
769 Encoding == dwarf::DW_ATE_unsigned_char ||
770 Encoding == dwarf::DW_ATE_boolean)
776 /// If this type is derived from a base type then return base type size.
777 static uint64_t getBaseTypeSize(DwarfDebug *DD, DIDerivedType Ty) {
778 unsigned Tag = Ty.getTag();
780 if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
781 Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
782 Tag != dwarf::DW_TAG_restrict_type)
783 return Ty.getSizeInBits();
785 DIType BaseType = DD->resolve(Ty.getTypeDerivedFrom());
787 // If this type is not derived from any type or the type is a declaration then
788 // take conservative approach.
789 if (!BaseType.isValid() || BaseType.isForwardDecl())
790 return Ty.getSizeInBits();
792 // If this is a derived type, go ahead and get the base type, unless it's a
793 // reference then it's just the size of the field. Pointer types have no need
794 // of this since they're a different type of qualification on the type.
795 if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
796 BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
797 return Ty.getSizeInBits();
799 if (BaseType.isDerivedType())
800 return getBaseTypeSize(DD, DIDerivedType(BaseType));
802 return BaseType.getSizeInBits();
805 /// addConstantFPValue - Add constant value entry in variable DIE.
806 void DwarfUnit::addConstantFPValue(DIE &Die, const MachineOperand &MO) {
807 assert(MO.isFPImm() && "Invalid machine operand!");
808 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
809 APFloat FPImm = MO.getFPImm()->getValueAPF();
811 // Get the raw data form of the floating point.
812 const APInt FltVal = FPImm.bitcastToAPInt();
813 const char *FltPtr = (const char *)FltVal.getRawData();
815 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
816 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
817 int Incr = (LittleEndian ? 1 : -1);
818 int Start = (LittleEndian ? 0 : NumBytes - 1);
819 int Stop = (LittleEndian ? NumBytes : -1);
821 // Output the constant to DWARF one byte at a time.
822 for (; Start != Stop; Start += Incr)
823 addUInt(*Block, dwarf::DW_FORM_data1, (unsigned char)0xFF & FltPtr[Start]);
825 addBlock(Die, dwarf::DW_AT_const_value, Block);
828 /// addConstantFPValue - Add constant value entry in variable DIE.
829 void DwarfUnit::addConstantFPValue(DIE &Die, const ConstantFP *CFP) {
830 // Pass this down to addConstantValue as an unsigned bag of bits.
831 addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), true);
834 /// addConstantValue - Add constant value entry in variable DIE.
835 void DwarfUnit::addConstantValue(DIE &Die, const ConstantInt *CI,
837 addConstantValue(Die, CI->getValue(), Unsigned);
840 /// addConstantValue - Add constant value entry in variable DIE.
841 void DwarfUnit::addConstantValue(DIE &Die, const MachineOperand &MO,
843 assert(MO.isImm() && "Invalid machine operand!");
845 addConstantValue(Die, isTypeSigned(DD, Ty), MO.getImm());
848 void DwarfUnit::addConstantValue(DIE &Die, bool Signed, uint64_t Val) {
849 // FIXME: This is a bit conservative/simple - it emits negative values always
850 // sign extended to 64 bits rather than minimizing the number of bytes.
851 addUInt(Die, dwarf::DW_AT_const_value,
852 Signed ? dwarf::DW_FORM_sdata : dwarf::DW_FORM_udata, Val);
855 // addConstantValue - Add constant value entry in variable DIE.
856 void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, bool Unsigned) {
857 unsigned CIBitWidth = Val.getBitWidth();
858 if (CIBitWidth <= 64) {
859 addConstantValue(Die, !Unsigned, Unsigned ? Val.getZExtValue() : Val.getSExtValue());
863 DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
865 // Get the raw data form of the large APInt.
866 const uint64_t *Ptr64 = Val.getRawData();
868 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
869 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
871 // Output the constant to DWARF one byte at a time.
872 for (int i = 0; i < NumBytes; i++) {
875 c = Ptr64[i / 8] >> (8 * (i & 7));
877 c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7));
878 addUInt(*Block, dwarf::DW_FORM_data1, c);
881 addBlock(Die, dwarf::DW_AT_const_value, Block);
884 /// addTemplateParams - Add template parameters into buffer.
885 void DwarfUnit::addTemplateParams(DIE &Buffer, DIArray TParams) {
886 // Add template parameters.
887 for (unsigned i = 0, e = TParams.getNumElements(); i != e; ++i) {
888 DIDescriptor Element = TParams.getElement(i);
889 if (Element.isTemplateTypeParameter())
890 constructTemplateTypeParameterDIE(Buffer,
891 DITemplateTypeParameter(Element));
892 else if (Element.isTemplateValueParameter())
893 constructTemplateValueParameterDIE(Buffer,
894 DITemplateValueParameter(Element));
898 /// getOrCreateContextDIE - Get context owner's DIE.
899 DIE *DwarfUnit::getOrCreateContextDIE(DIScope Context) {
900 if (!Context || Context.isFile())
901 return &getUnitDie();
902 if (Context.isType())
903 return getOrCreateTypeDIE(DIType(Context));
904 if (Context.isNameSpace())
905 return getOrCreateNameSpace(DINameSpace(Context));
906 if (Context.isSubprogram())
907 return getOrCreateSubprogramDIE(DISubprogram(Context));
908 return getDIE(Context);
911 DIE *DwarfUnit::createTypeDIE(DICompositeType Ty) {
912 DIScope Context = resolve(Ty.getContext());
913 DIE *ContextDIE = getOrCreateContextDIE(Context);
915 if (DIE *TyDIE = getDIE(Ty))
919 DIE &TyDIE = createAndAddDIE(Ty.getTag(), *ContextDIE, Ty);
921 constructTypeDIE(TyDIE, Ty);
923 updateAcceleratorTables(Context, Ty, TyDIE);
927 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
929 DIE *DwarfUnit::getOrCreateTypeDIE(const MDNode *TyNode) {
935 assert(Ty == resolve(Ty.getRef()) &&
936 "type was not uniqued, possible ODR violation.");
938 // DW_TAG_restrict_type is not supported in DWARF2
939 if (Ty.getTag() == dwarf::DW_TAG_restrict_type && DD->getDwarfVersion() <= 2)
940 return getOrCreateTypeDIE(resolve(DIDerivedType(Ty).getTypeDerivedFrom()));
942 // Construct the context before querying for the existence of the DIE in case
943 // such construction creates the DIE.
944 DIScope Context = resolve(Ty.getContext());
945 DIE *ContextDIE = getOrCreateContextDIE(Context);
948 if (DIE *TyDIE = getDIE(Ty))
952 DIE &TyDIE = createAndAddDIE(Ty.getTag(), *ContextDIE, Ty);
954 updateAcceleratorTables(Context, Ty, TyDIE);
956 if (Ty.isBasicType())
957 constructTypeDIE(TyDIE, DIBasicType(Ty));
958 else if (Ty.isCompositeType()) {
959 DICompositeType CTy(Ty);
960 if (GenerateDwarfTypeUnits && !Ty.isForwardDecl())
961 if (MDString *TypeId = CTy.getIdentifier()) {
962 DD->addDwarfTypeUnitType(getCU(), TypeId->getString(), TyDIE, CTy);
963 // Skip updating the accelerator tables since this is not the full type.
966 constructTypeDIE(TyDIE, CTy);
968 assert(Ty.isDerivedType() && "Unknown kind of DIType");
969 constructTypeDIE(TyDIE, DIDerivedType(Ty));
975 void DwarfUnit::updateAcceleratorTables(DIScope Context, DIType Ty,
977 if (!Ty.getName().empty() && !Ty.isForwardDecl()) {
978 bool IsImplementation = 0;
979 if (Ty.isCompositeType()) {
980 DICompositeType CT(Ty);
981 // A runtime language of 0 actually means C/C++ and that any
982 // non-negative value is some version of Objective-C/C++.
983 IsImplementation = (CT.getRunTimeLang() == 0) || CT.isObjcClassComplete();
985 unsigned Flags = IsImplementation ? dwarf::DW_FLAG_type_implementation : 0;
986 DD->addAccelType(Ty.getName(), TyDIE, Flags);
988 if ((!Context || Context.isCompileUnit() || Context.isFile() ||
989 Context.isNameSpace()) &&
990 getCUNode().getEmissionKind() != DIBuilder::LineTablesOnly)
991 GlobalTypes[getParentContextString(Context) + Ty.getName().str()] =
996 /// addType - Add a new type attribute to the specified entity.
997 void DwarfUnit::addType(DIE &Entity, DIType Ty, dwarf::Attribute Attribute) {
998 assert(Ty && "Trying to add a type that doesn't exist?");
1000 // Check for pre-existence.
1001 DIEEntry *Entry = getDIEEntry(Ty);
1002 // If it exists then use the existing value.
1004 addDIEEntry(Entity, Attribute, Entry);
1009 DIE *Buffer = getOrCreateTypeDIE(Ty);
1012 Entry = createDIEEntry(*Buffer);
1013 insertDIEEntry(Ty, Entry);
1014 addDIEEntry(Entity, Attribute, Entry);
1017 /// addGlobalName - Add a new global name to the compile unit.
1018 void DwarfUnit::addGlobalName(StringRef Name, DIE &Die, DIScope Context) {
1019 if (getCUNode().getEmissionKind() == DIBuilder::LineTablesOnly)
1021 std::string FullName = getParentContextString(Context) + Name.str();
1022 GlobalNames[FullName] = &Die;
1025 /// getParentContextString - Walks the metadata parent chain in a language
1026 /// specific manner (using the compile unit language) and returns
1027 /// it as a string. This is done at the metadata level because DIEs may
1028 /// not currently have been added to the parent context and walking the
1029 /// DIEs looking for names is more expensive than walking the metadata.
1030 std::string DwarfUnit::getParentContextString(DIScope Context) const {
1034 // FIXME: Decide whether to implement this for non-C++ languages.
1035 if (getLanguage() != dwarf::DW_LANG_C_plus_plus)
1039 SmallVector<DIScope, 1> Parents;
1040 while (!Context.isCompileUnit()) {
1041 Parents.push_back(Context);
1042 if (Context.getContext())
1043 Context = resolve(Context.getContext());
1045 // Structure, etc types will have a NULL context if they're at the top
1050 // Reverse iterate over our list to go from the outermost construct to the
1052 for (SmallVectorImpl<DIScope>::reverse_iterator I = Parents.rbegin(),
1056 StringRef Name = Ctx.getName();
1057 if (!Name.empty()) {
1065 /// constructTypeDIE - Construct basic type die from DIBasicType.
1066 void DwarfUnit::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
1067 // Get core information.
1068 StringRef Name = BTy.getName();
1069 // Add name if not anonymous or intermediate type.
1071 addString(Buffer, dwarf::DW_AT_name, Name);
1073 // An unspecified type only has a name attribute.
1074 if (BTy.getTag() == dwarf::DW_TAG_unspecified_type)
1077 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1080 uint64_t Size = BTy.getSizeInBits() >> 3;
1081 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
1084 /// constructTypeDIE - Construct derived type die from DIDerivedType.
1085 void DwarfUnit::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
1086 // Get core information.
1087 StringRef Name = DTy.getName();
1088 uint64_t Size = DTy.getSizeInBits() >> 3;
1089 uint16_t Tag = Buffer.getTag();
1091 // Map to main type, void will not have a type.
1092 DIType FromTy = resolve(DTy.getTypeDerivedFrom());
1094 addType(Buffer, FromTy);
1096 // Add name if not anonymous or intermediate type.
1098 addString(Buffer, dwarf::DW_AT_name, Name);
1100 // Add size if non-zero (derived types might be zero-sized.)
1101 if (Size && Tag != dwarf::DW_TAG_pointer_type)
1102 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
1104 if (Tag == dwarf::DW_TAG_ptr_to_member_type)
1105 addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
1106 *getOrCreateTypeDIE(resolve(DTy.getClassType())));
1107 // Add source line info if available and TyDesc is not a forward declaration.
1108 if (!DTy.isForwardDecl())
1109 addSourceLine(Buffer, DTy);
1112 /// constructSubprogramArguments - Construct function argument DIEs.
1113 void DwarfUnit::constructSubprogramArguments(DIE &Buffer, DIArray Args) {
1114 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1115 DIDescriptor Ty = Args.getElement(i);
1116 if (Ty.isUnspecifiedParameter()) {
1117 assert(i == N-1 && "Unspecified parameter must be the last argument");
1118 createAndAddDIE(dwarf::DW_TAG_unspecified_parameters, Buffer);
1120 DIE &Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, Buffer);
1121 addType(Arg, DIType(Ty));
1122 if (DIType(Ty).isArtificial())
1123 addFlag(Arg, dwarf::DW_AT_artificial);
1128 /// constructTypeDIE - Construct type DIE from DICompositeType.
1129 void DwarfUnit::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
1130 // Add name if not anonymous or intermediate type.
1131 StringRef Name = CTy.getName();
1133 uint64_t Size = CTy.getSizeInBits() >> 3;
1134 uint16_t Tag = Buffer.getTag();
1137 case dwarf::DW_TAG_array_type:
1138 constructArrayTypeDIE(Buffer, CTy);
1140 case dwarf::DW_TAG_enumeration_type:
1141 constructEnumTypeDIE(Buffer, CTy);
1143 case dwarf::DW_TAG_subroutine_type: {
1144 // Add return type. A void return won't have a type.
1145 DIArray Elements = CTy.getTypeArray();
1146 DIType RTy(Elements.getElement(0));
1148 addType(Buffer, RTy);
1150 bool isPrototyped = true;
1151 if (Elements.getNumElements() == 2 &&
1152 Elements.getElement(1).isUnspecifiedParameter())
1153 isPrototyped = false;
1155 constructSubprogramArguments(Buffer, Elements);
1157 // Add prototype flag if we're dealing with a C language and the
1158 // function has been prototyped.
1159 uint16_t Language = getLanguage();
1161 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
1162 Language == dwarf::DW_LANG_ObjC))
1163 addFlag(Buffer, dwarf::DW_AT_prototyped);
1165 if (CTy.isLValueReference())
1166 addFlag(Buffer, dwarf::DW_AT_reference);
1168 if (CTy.isRValueReference())
1169 addFlag(Buffer, dwarf::DW_AT_rvalue_reference);
1171 case dwarf::DW_TAG_structure_type:
1172 case dwarf::DW_TAG_union_type:
1173 case dwarf::DW_TAG_class_type: {
1174 // Add elements to structure type.
1175 DIArray Elements = CTy.getTypeArray();
1176 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1177 DIDescriptor Element = Elements.getElement(i);
1178 if (Element.isSubprogram())
1179 getOrCreateSubprogramDIE(DISubprogram(Element));
1180 else if (Element.isDerivedType()) {
1181 DIDerivedType DDTy(Element);
1182 if (DDTy.getTag() == dwarf::DW_TAG_friend) {
1183 DIE &ElemDie = createAndAddDIE(dwarf::DW_TAG_friend, Buffer);
1184 addType(ElemDie, resolve(DDTy.getTypeDerivedFrom()),
1185 dwarf::DW_AT_friend);
1186 } else if (DDTy.isStaticMember()) {
1187 getOrCreateStaticMemberDIE(DDTy);
1189 constructMemberDIE(Buffer, DDTy);
1191 } else if (Element.isObjCProperty()) {
1192 DIObjCProperty Property(Element);
1193 DIE &ElemDie = createAndAddDIE(Property.getTag(), Buffer);
1194 StringRef PropertyName = Property.getObjCPropertyName();
1195 addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
1196 if (Property.getType())
1197 addType(ElemDie, Property.getType());
1198 addSourceLine(ElemDie, Property);
1199 StringRef GetterName = Property.getObjCPropertyGetterName();
1200 if (!GetterName.empty())
1201 addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
1202 StringRef SetterName = Property.getObjCPropertySetterName();
1203 if (!SetterName.empty())
1204 addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
1205 unsigned PropertyAttributes = 0;
1206 if (Property.isReadOnlyObjCProperty())
1207 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readonly;
1208 if (Property.isReadWriteObjCProperty())
1209 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readwrite;
1210 if (Property.isAssignObjCProperty())
1211 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_assign;
1212 if (Property.isRetainObjCProperty())
1213 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_retain;
1214 if (Property.isCopyObjCProperty())
1215 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_copy;
1216 if (Property.isNonAtomicObjCProperty())
1217 PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_nonatomic;
1218 if (PropertyAttributes)
1219 addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, None,
1220 PropertyAttributes);
1222 DIEEntry *Entry = getDIEEntry(Element);
1224 Entry = createDIEEntry(ElemDie);
1225 insertDIEEntry(Element, Entry);
1231 if (CTy.isAppleBlockExtension())
1232 addFlag(Buffer, dwarf::DW_AT_APPLE_block);
1234 DICompositeType ContainingType(resolve(CTy.getContainingType()));
1236 addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
1237 *getOrCreateTypeDIE(ContainingType));
1239 if (CTy.isObjcClassComplete())
1240 addFlag(Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
1242 // Add template parameters to a class, structure or union types.
1243 // FIXME: The support isn't in the metadata for this yet.
1244 if (Tag == dwarf::DW_TAG_class_type ||
1245 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
1246 addTemplateParams(Buffer, CTy.getTemplateParams());
1254 // Add name if not anonymous or intermediate type.
1256 addString(Buffer, dwarf::DW_AT_name, Name);
1258 if (Tag == dwarf::DW_TAG_enumeration_type ||
1259 Tag == dwarf::DW_TAG_class_type || Tag == dwarf::DW_TAG_structure_type ||
1260 Tag == dwarf::DW_TAG_union_type) {
1261 // Add size if non-zero (derived types might be zero-sized.)
1262 // TODO: Do we care about size for enum forward declarations?
1264 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
1265 else if (!CTy.isForwardDecl())
1266 // Add zero size if it is not a forward declaration.
1267 addUInt(Buffer, dwarf::DW_AT_byte_size, None, 0);
1269 // If we're a forward decl, say so.
1270 if (CTy.isForwardDecl())
1271 addFlag(Buffer, dwarf::DW_AT_declaration);
1273 // Add source line info if available.
1274 if (!CTy.isForwardDecl())
1275 addSourceLine(Buffer, CTy);
1277 // No harm in adding the runtime language to the declaration.
1278 unsigned RLang = CTy.getRunTimeLang();
1280 addUInt(Buffer, dwarf::DW_AT_APPLE_runtime_class, dwarf::DW_FORM_data1,
1285 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
1286 /// DITemplateTypeParameter.
1287 void DwarfUnit::constructTemplateTypeParameterDIE(DIE &Buffer,
1288 DITemplateTypeParameter TP) {
1290 createAndAddDIE(dwarf::DW_TAG_template_type_parameter, Buffer);
1291 // Add the type if it exists, it could be void and therefore no type.
1293 addType(ParamDIE, resolve(TP.getType()));
1294 if (!TP.getName().empty())
1295 addString(ParamDIE, dwarf::DW_AT_name, TP.getName());
1298 /// constructTemplateValueParameterDIE - Construct new DIE for the given
1299 /// DITemplateValueParameter.
1301 DwarfUnit::constructTemplateValueParameterDIE(DIE &Buffer,
1302 DITemplateValueParameter VP) {
1303 DIE &ParamDIE = createAndAddDIE(VP.getTag(), Buffer);
1305 // Add the type if there is one, template template and template parameter
1306 // packs will not have a type.
1307 if (VP.getTag() == dwarf::DW_TAG_template_value_parameter)
1308 addType(ParamDIE, resolve(VP.getType()));
1309 if (!VP.getName().empty())
1310 addString(ParamDIE, dwarf::DW_AT_name, VP.getName());
1311 if (Value *Val = VP.getValue()) {
1312 if (ConstantInt *CI = dyn_cast<ConstantInt>(Val))
1313 addConstantValue(ParamDIE, CI,
1314 isUnsignedDIType(DD, resolve(VP.getType())));
1315 else if (GlobalValue *GV = dyn_cast<GlobalValue>(Val)) {
1316 // For declaration non-type template parameters (such as global values and
1318 DIELoc *Loc = new (DIEValueAllocator) DIELoc();
1319 addOpAddress(*Loc, Asm->getSymbol(GV));
1320 // Emit DW_OP_stack_value to use the address as the immediate value of the
1321 // parameter, rather than a pointer to it.
1322 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1323 addBlock(ParamDIE, dwarf::DW_AT_location, Loc);
1324 } else if (VP.getTag() == dwarf::DW_TAG_GNU_template_template_param) {
1325 assert(isa<MDString>(Val));
1326 addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1327 cast<MDString>(Val)->getString());
1328 } else if (VP.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
1329 assert(isa<MDNode>(Val));
1330 DIArray A(cast<MDNode>(Val));
1331 addTemplateParams(ParamDIE, A);
1336 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
1337 DIE *DwarfUnit::getOrCreateNameSpace(DINameSpace NS) {
1338 // Construct the context before querying for the existence of the DIE in case
1339 // such construction creates the DIE.
1340 DIE *ContextDIE = getOrCreateContextDIE(NS.getContext());
1342 if (DIE *NDie = getDIE(NS))
1344 DIE &NDie = createAndAddDIE(dwarf::DW_TAG_namespace, *ContextDIE, NS);
1346 if (!NS.getName().empty()) {
1347 addString(NDie, dwarf::DW_AT_name, NS.getName());
1348 DD->addAccelNamespace(NS.getName(), NDie);
1349 addGlobalName(NS.getName(), NDie, NS.getContext());
1351 DD->addAccelNamespace("(anonymous namespace)", NDie);
1352 addSourceLine(NDie, NS);
1356 /// getOrCreateSubprogramDIE - Create new DIE using SP.
1357 DIE *DwarfUnit::getOrCreateSubprogramDIE(DISubprogram SP) {
1358 // Construct the context before querying for the existence of the DIE in case
1359 // such construction creates the DIE (as is the case for member function
1361 DIScope Context = resolve(SP.getContext());
1362 DIE *ContextDIE = getOrCreateContextDIE(Context);
1364 // Unique declarations based on the ODR, where applicable.
1365 SP = DISubprogram(DD->resolve(SP.getRef()));
1366 assert(SP.Verify());
1368 if (DIE *SPDie = getDIE(SP))
1371 DISubprogram SPDecl = SP.getFunctionDeclaration();
1372 if (SPDecl.isSubprogram())
1373 // Add subprogram definitions to the CU die directly.
1374 ContextDIE = &getUnitDie();
1376 // DW_TAG_inlined_subroutine may refer to this DIE.
1377 DIE &SPDie = createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, SP);
1379 DIE *DeclDie = nullptr;
1380 if (SPDecl.isSubprogram())
1381 DeclDie = getOrCreateSubprogramDIE(SPDecl);
1383 // Add function template parameters.
1384 addTemplateParams(SPDie, SP.getTemplateParams());
1387 // Refer function declaration directly.
1388 addDIEEntry(SPDie, dwarf::DW_AT_specification, *DeclDie);
1390 // Add the linkage name if we have one and it isn't in the Decl.
1391 StringRef LinkageName = SP.getLinkageName();
1392 if (!LinkageName.empty()) {
1393 if (SPDecl.isSubprogram() && !SPDecl.getLinkageName().empty())
1394 assert(SPDecl.getLinkageName() == SP.getLinkageName() &&
1395 "decl has a linkage name and it is different");
1397 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name,
1398 GlobalValue::getRealLinkageName(LinkageName));
1401 // If this DIE is going to refer declaration info using AT_specification
1402 // then there is no need to add other attributes.
1406 // Constructors and operators for anonymous aggregates do not have names.
1407 if (!SP.getName().empty())
1408 addString(SPDie, dwarf::DW_AT_name, SP.getName());
1410 addSourceLine(SPDie, SP);
1412 // Add the prototype if we have a prototype and we have a C like
1414 uint16_t Language = getLanguage();
1415 if (SP.isPrototyped() &&
1416 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
1417 Language == dwarf::DW_LANG_ObjC))
1418 addFlag(SPDie, dwarf::DW_AT_prototyped);
1420 DICompositeType SPTy = SP.getType();
1421 assert(SPTy.getTag() == dwarf::DW_TAG_subroutine_type &&
1422 "the type of a subprogram should be a subroutine");
1424 DIArray Args = SPTy.getTypeArray();
1425 // Add a return type. If this is a type like a C/C++ void type we don't add a
1427 if (Args.getElement(0))
1428 addType(SPDie, DIType(Args.getElement(0)));
1430 unsigned VK = SP.getVirtuality();
1432 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
1433 DIELoc *Block = getDIELoc();
1434 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1435 addUInt(*Block, dwarf::DW_FORM_udata, SP.getVirtualIndex());
1436 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, Block);
1437 ContainingTypeMap.insert(
1438 std::make_pair(&SPDie, resolve(SP.getContainingType())));
1441 if (!SP.isDefinition()) {
1442 addFlag(SPDie, dwarf::DW_AT_declaration);
1444 // Add arguments. Do not add arguments for subprogram definition. They will
1445 // be handled while processing variables.
1446 constructSubprogramArguments(SPDie, Args);
1449 if (SP.isArtificial())
1450 addFlag(SPDie, dwarf::DW_AT_artificial);
1452 if (!SP.isLocalToUnit())
1453 addFlag(SPDie, dwarf::DW_AT_external);
1455 if (SP.isOptimized())
1456 addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
1458 if (unsigned isa = Asm->getISAEncoding()) {
1459 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1462 if (SP.isLValueReference())
1463 addFlag(SPDie, dwarf::DW_AT_reference);
1465 if (SP.isRValueReference())
1466 addFlag(SPDie, dwarf::DW_AT_rvalue_reference);
1468 if (SP.isProtected())
1469 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1470 dwarf::DW_ACCESS_protected);
1471 else if (SP.isPrivate())
1472 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1473 dwarf::DW_ACCESS_private);
1475 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1476 dwarf::DW_ACCESS_public);
1478 if (SP.isExplicit())
1479 addFlag(SPDie, dwarf::DW_AT_explicit);
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 DwarfCompileUnit::createGlobalVariableDIE(DIGlobalVariable GV) {
1513 // Check for pre-existence.
1517 assert(GV.isGlobalVariable());
1519 DIScope GVContext = GV.getContext();
1520 DIType GTy = DD->resolve(GV.getType());
1522 // If this is a static data member definition, some attributes belong
1523 // to the declaration DIE.
1524 DIE *VariableDIE = nullptr;
1525 bool IsStaticMember = false;
1526 DIDerivedType SDMDecl = GV.getStaticDataMemberDeclaration();
1527 if (SDMDecl.Verify()) {
1528 assert(SDMDecl.isStaticMember() && "Expected static member decl");
1529 // We need the declaration DIE that is in the static member's class.
1530 VariableDIE = getOrCreateStaticMemberDIE(SDMDecl);
1531 IsStaticMember = true;
1534 // If this is not a static data member definition, create the variable
1535 // DIE and add the initial set of attributes to it.
1537 // Construct the context before querying for the existence of the DIE in
1538 // case such construction creates the DIE.
1539 DIE *ContextDIE = getOrCreateContextDIE(GVContext);
1542 VariableDIE = &createAndAddDIE(GV.getTag(), *ContextDIE, GV);
1544 // Add name and type.
1545 addString(*VariableDIE, dwarf::DW_AT_name, GV.getDisplayName());
1546 addType(*VariableDIE, GTy);
1548 // Add scoping info.
1549 if (!GV.isLocalToUnit())
1550 addFlag(*VariableDIE, dwarf::DW_AT_external);
1552 // Add line number info.
1553 addSourceLine(*VariableDIE, GV);
1557 bool addToAccelTable = false;
1558 DIE *VariableSpecDIE = nullptr;
1559 bool isGlobalVariable = GV.getGlobal() != nullptr;
1560 if (isGlobalVariable) {
1561 addToAccelTable = true;
1562 DIELoc *Loc = new (DIEValueAllocator) DIELoc();
1563 const MCSymbol *Sym = Asm->getSymbol(GV.getGlobal());
1564 if (GV.getGlobal()->isThreadLocal()) {
1565 // FIXME: Make this work with -gsplit-dwarf.
1566 unsigned PointerSize = Asm->getDataLayout().getPointerSize();
1567 assert((PointerSize == 4 || PointerSize == 8) &&
1568 "Add support for other sizes if necessary");
1569 // Based on GCC's support for TLS:
1570 if (!DD->useSplitDwarf()) {
1571 // 1) Start with a constNu of the appropriate pointer size
1572 addUInt(*Loc, dwarf::DW_FORM_data1,
1573 PointerSize == 4 ? dwarf::DW_OP_const4u : dwarf::DW_OP_const8u);
1574 // 2) containing the (relocated) offset of the TLS variable
1575 // within the module's TLS block.
1576 addExpr(*Loc, dwarf::DW_FORM_udata,
1577 Asm->getObjFileLowering().getDebugThreadLocalSymbol(Sym));
1579 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_const_index);
1580 addUInt(*Loc, dwarf::DW_FORM_udata,
1581 DD->getAddressPool().getIndex(Sym, /* TLS */ true));
1583 // 3) followed by a custom OP to make the debugger do a TLS lookup.
1584 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_push_tls_address);
1586 DD->addArangeLabel(SymbolCU(this, Sym));
1587 addOpAddress(*Loc, 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, UnitDie);
1595 addDIEEntry(*VariableSpecDIE, dwarf::DW_AT_specification, *VariableDIE);
1596 addBlock(*VariableSpecDIE, dwarf::DW_AT_location, Loc);
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, Loc);
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 DD->getDwarfVersion() >= 4 ? dwarf::DW_AT_linkage_name
1612 : dwarf::DW_AT_MIPS_linkage_name,
1613 GlobalValue::getRealLinkageName(LinkageName));
1614 } else if (const ConstantInt *CI =
1615 dyn_cast_or_null<ConstantInt>(GV.getConstant())) {
1616 // AT_const_value was added when the static member was created. To avoid
1617 // emitting AT_const_value multiple times, we only add AT_const_value when
1618 // it is not a static member.
1619 if (!IsStaticMember)
1620 addConstantValue(*VariableDIE, CI, isUnsignedDIType(DD, GTy));
1621 } else if (const ConstantExpr *CE = getMergedGlobalExpr(GV->getOperand(11))) {
1622 addToAccelTable = true;
1623 // GV is a merged global.
1624 DIELoc *Loc = new (DIEValueAllocator) DIELoc();
1625 Value *Ptr = CE->getOperand(0);
1626 MCSymbol *Sym = Asm->getSymbol(cast<GlobalValue>(Ptr));
1627 DD->addArangeLabel(SymbolCU(this, Sym));
1628 addOpAddress(*Loc, Sym);
1629 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1630 SmallVector<Value *, 3> Idx(CE->op_begin() + 1, CE->op_end());
1631 addUInt(*Loc, dwarf::DW_FORM_udata,
1632 Asm->getDataLayout().getIndexedOffset(Ptr->getType(), Idx));
1633 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1634 addBlock(*VariableDIE, dwarf::DW_AT_location, Loc);
1637 if (addToAccelTable) {
1638 DIE &AddrDIE = VariableSpecDIE ? *VariableSpecDIE : *VariableDIE;
1639 DD->addAccelName(GV.getName(), AddrDIE);
1641 // If the linkage name is different than the name, go ahead and output
1642 // that as well into the name table.
1643 if (GV.getLinkageName() != "" && GV.getName() != GV.getLinkageName())
1644 DD->addAccelName(GV.getLinkageName(), AddrDIE);
1647 if (!GV.isLocalToUnit())
1648 addGlobalName(GV.getName(),
1649 VariableSpecDIE ? *VariableSpecDIE : *VariableDIE,
1653 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1654 void DwarfUnit::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy) {
1655 DIE &DW_Subrange = createAndAddDIE(dwarf::DW_TAG_subrange_type, Buffer);
1656 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, *IndexTy);
1658 // The LowerBound value defines the lower bounds which is typically zero for
1659 // C/C++. The Count value is the number of elements. Values are 64 bit. If
1660 // Count == -1 then the array is unbounded and we do not emit
1661 // DW_AT_lower_bound and DW_AT_upper_bound attributes. If LowerBound == 0 and
1662 // Count == 0, then the array has zero elements in which case we do not emit
1664 int64_t LowerBound = SR.getLo();
1665 int64_t DefaultLowerBound = getDefaultLowerBound();
1666 int64_t Count = SR.getCount();
1668 if (DefaultLowerBound == -1 || LowerBound != DefaultLowerBound)
1669 addUInt(DW_Subrange, dwarf::DW_AT_lower_bound, None, LowerBound);
1671 if (Count != -1 && Count != 0)
1672 // FIXME: An unbounded array should reference the expression that defines
1674 addUInt(DW_Subrange, dwarf::DW_AT_upper_bound, None,
1675 LowerBound + Count - 1);
1678 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
1679 void DwarfUnit::constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy) {
1681 addFlag(Buffer, dwarf::DW_AT_GNU_vector);
1683 // Emit the element type.
1684 addType(Buffer, resolve(CTy.getTypeDerivedFrom()));
1686 // Get an anonymous type for index type.
1687 // FIXME: This type should be passed down from the front end
1688 // as different languages may have different sizes for indexes.
1689 DIE *IdxTy = getIndexTyDie();
1691 // Construct an integer type to use for indexes.
1692 IdxTy = &createAndAddDIE(dwarf::DW_TAG_base_type, UnitDie);
1693 addString(*IdxTy, dwarf::DW_AT_name, "sizetype");
1694 addUInt(*IdxTy, dwarf::DW_AT_byte_size, None, sizeof(int64_t));
1695 addUInt(*IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1696 dwarf::DW_ATE_unsigned);
1697 setIndexTyDie(IdxTy);
1700 // Add subranges to array type.
1701 DIArray Elements = CTy.getTypeArray();
1702 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1703 DIDescriptor Element = Elements.getElement(i);
1704 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1705 constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
1709 /// constructEnumTypeDIE - Construct an enum type DIE from DICompositeType.
1710 void DwarfUnit::constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy) {
1711 DIArray Elements = CTy.getTypeArray();
1713 // Add enumerators to enumeration type.
1714 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1715 DIEnumerator Enum(Elements.getElement(i));
1716 if (Enum.isEnumerator()) {
1717 DIE &Enumerator = createAndAddDIE(dwarf::DW_TAG_enumerator, Buffer);
1718 StringRef Name = Enum.getName();
1719 addString(Enumerator, dwarf::DW_AT_name, Name);
1720 int64_t Value = Enum.getEnumValue();
1721 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
1725 DIType DTy = resolve(CTy.getTypeDerivedFrom());
1727 addType(Buffer, DTy);
1728 addFlag(Buffer, dwarf::DW_AT_enum_class);
1732 /// constructContainingTypeDIEs - Construct DIEs for types that contain
1734 void DwarfUnit::constructContainingTypeDIEs() {
1735 for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
1736 CE = ContainingTypeMap.end();
1738 DIE &SPDie = *CI->first;
1739 DIDescriptor D(CI->second);
1742 DIE *NDie = getDIE(D);
1745 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, *NDie);
1749 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
1750 std::unique_ptr<DIE> DwarfUnit::constructVariableDIE(DbgVariable &DV,
1751 AbstractOrInlined AbsIn) {
1752 auto D = constructVariableDIEImpl(DV, AbsIn);
1757 std::unique_ptr<DIE>
1758 DwarfUnit::constructVariableDIEImpl(const DbgVariable &DV,
1759 AbstractOrInlined AbsIn) {
1760 StringRef Name = DV.getName();
1762 // Define variable debug information entry.
1763 auto VariableDie = make_unique<DIE>(DV.getTag());
1764 DbgVariable *AbsVar = DV.getAbstractVariable();
1765 DIE *AbsDIE = AbsVar ? AbsVar->getDIE() : nullptr;
1767 addDIEEntry(*VariableDie, dwarf::DW_AT_abstract_origin, *AbsDIE);
1770 addString(*VariableDie, dwarf::DW_AT_name, Name);
1771 addSourceLine(*VariableDie, DV.getVariable());
1772 addType(*VariableDie, DV.getType());
1775 if (AbsIn != AOI_Inlined && DV.isArtificial())
1776 addFlag(*VariableDie, dwarf::DW_AT_artificial);
1778 if (AbsIn == AOI_Abstract)
1781 // Add variable address.
1783 unsigned Offset = DV.getDotDebugLocOffset();
1784 if (Offset != ~0U) {
1785 addLocationList(*VariableDie, dwarf::DW_AT_location, Offset);
1789 // Check if variable is described by a DBG_VALUE instruction.
1790 if (const MachineInstr *DVInsn = DV.getMInsn()) {
1791 assert(DVInsn->getNumOperands() == 3);
1792 if (DVInsn->getOperand(0).isReg()) {
1793 const MachineOperand RegOp = DVInsn->getOperand(0);
1794 // If the second operand is an immediate, this is an indirect value.
1795 if (DVInsn->getOperand(1).isImm()) {
1796 MachineLocation Location(RegOp.getReg(),
1797 DVInsn->getOperand(1).getImm());
1798 addVariableAddress(DV, *VariableDie, Location);
1799 } else if (RegOp.getReg())
1800 addVariableAddress(DV, *VariableDie, MachineLocation(RegOp.getReg()));
1801 } else if (DVInsn->getOperand(0).isImm())
1802 addConstantValue(*VariableDie, DVInsn->getOperand(0), DV.getType());
1803 else if (DVInsn->getOperand(0).isFPImm())
1804 addConstantFPValue(*VariableDie, DVInsn->getOperand(0));
1805 else if (DVInsn->getOperand(0).isCImm())
1806 addConstantValue(*VariableDie, DVInsn->getOperand(0).getCImm(),
1807 isUnsignedDIType(DD, DV.getType()));
1812 // .. else use frame index.
1813 int FI = DV.getFrameIndex();
1815 unsigned FrameReg = 0;
1816 const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
1817 int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1818 MachineLocation Location(FrameReg, Offset);
1819 addVariableAddress(DV, *VariableDie, Location);
1825 /// constructMemberDIE - Construct member DIE from DIDerivedType.
1826 void DwarfUnit::constructMemberDIE(DIE &Buffer, DIDerivedType DT) {
1827 DIE &MemberDie = createAndAddDIE(DT.getTag(), Buffer);
1828 StringRef Name = DT.getName();
1830 addString(MemberDie, dwarf::DW_AT_name, Name);
1832 addType(MemberDie, resolve(DT.getTypeDerivedFrom()));
1834 addSourceLine(MemberDie, DT);
1836 if (DT.getTag() == dwarf::DW_TAG_inheritance && DT.isVirtual()) {
1838 // For C++, virtual base classes are not at fixed offset. Use following
1839 // expression to extract appropriate offset from vtable.
1840 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1842 DIELoc *VBaseLocationDie = new (DIEValueAllocator) DIELoc();
1843 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1844 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1845 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1846 addUInt(*VBaseLocationDie, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1847 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1848 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1849 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1851 addBlock(MemberDie, dwarf::DW_AT_data_member_location, VBaseLocationDie);
1853 uint64_t Size = DT.getSizeInBits();
1854 uint64_t FieldSize = getBaseTypeSize(DD, DT);
1855 uint64_t OffsetInBytes;
1857 if (Size != FieldSize) {
1858 // Handle bitfield, assume bytes are 8 bits.
1859 addUInt(MemberDie, dwarf::DW_AT_byte_size, None, FieldSize/8);
1860 addUInt(MemberDie, dwarf::DW_AT_bit_size, None, Size);
1862 uint64_t Offset = DT.getOffsetInBits();
1863 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1864 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1865 uint64_t FieldOffset = (HiMark - FieldSize);
1866 Offset -= FieldOffset;
1868 // Maybe we need to work from the other end.
1869 if (Asm->getDataLayout().isLittleEndian())
1870 Offset = FieldSize - (Offset + Size);
1871 addUInt(MemberDie, dwarf::DW_AT_bit_offset, None, Offset);
1873 // Here DW_AT_data_member_location points to the anonymous
1874 // field that includes this bit field.
1875 OffsetInBytes = FieldOffset >> 3;
1877 // This is not a bitfield.
1878 OffsetInBytes = DT.getOffsetInBits() >> 3;
1880 if (DD->getDwarfVersion() <= 2) {
1881 DIELoc *MemLocationDie = new (DIEValueAllocator) DIELoc();
1882 addUInt(*MemLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1883 addUInt(*MemLocationDie, dwarf::DW_FORM_udata, OffsetInBytes);
1884 addBlock(MemberDie, dwarf::DW_AT_data_member_location, MemLocationDie);
1886 addUInt(MemberDie, dwarf::DW_AT_data_member_location, None,
1890 if (DT.isProtected())
1891 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1892 dwarf::DW_ACCESS_protected);
1893 else if (DT.isPrivate())
1894 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1895 dwarf::DW_ACCESS_private);
1896 // Otherwise C++ member and base classes are considered public.
1898 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1899 dwarf::DW_ACCESS_public);
1901 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
1902 dwarf::DW_VIRTUALITY_virtual);
1904 // Objective-C properties.
1905 if (MDNode *PNode = DT.getObjCProperty())
1906 if (DIEEntry *PropertyDie = getDIEEntry(PNode))
1907 MemberDie.addValue(dwarf::DW_AT_APPLE_property, dwarf::DW_FORM_ref4,
1910 if (DT.isArtificial())
1911 addFlag(MemberDie, dwarf::DW_AT_artificial);
1914 /// getOrCreateStaticMemberDIE - Create new DIE for C++ static member.
1915 DIE *DwarfUnit::getOrCreateStaticMemberDIE(DIDerivedType DT) {
1919 // Construct the context before querying for the existence of the DIE in case
1920 // such construction creates the DIE.
1921 DIE *ContextDIE = getOrCreateContextDIE(resolve(DT.getContext()));
1922 assert(dwarf::isType(ContextDIE->getTag()) &&
1923 "Static member should belong to a type.");
1925 if (DIE *StaticMemberDIE = getDIE(DT))
1926 return StaticMemberDIE;
1928 DIE &StaticMemberDIE = createAndAddDIE(DT.getTag(), *ContextDIE, DT);
1930 DIType Ty = resolve(DT.getTypeDerivedFrom());
1932 addString(StaticMemberDIE, dwarf::DW_AT_name, DT.getName());
1933 addType(StaticMemberDIE, Ty);
1934 addSourceLine(StaticMemberDIE, DT);
1935 addFlag(StaticMemberDIE, dwarf::DW_AT_external);
1936 addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
1938 // FIXME: We could omit private if the parent is a class_type, and
1939 // public if the parent is something else.
1940 if (DT.isProtected())
1941 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1942 dwarf::DW_ACCESS_protected);
1943 else if (DT.isPrivate())
1944 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1945 dwarf::DW_ACCESS_private);
1947 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1948 dwarf::DW_ACCESS_public);
1950 if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT.getConstant()))
1951 addConstantValue(StaticMemberDIE, CI, isUnsignedDIType(DD, Ty));
1952 if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT.getConstant()))
1953 addConstantFPValue(StaticMemberDIE, CFP);
1955 return &StaticMemberDIE;
1958 void DwarfUnit::emitHeader(const MCSymbol *ASectionSym) const {
1959 Asm->OutStreamer.AddComment("DWARF version number");
1960 Asm->EmitInt16(DD->getDwarfVersion());
1961 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
1962 // We share one abbreviations table across all units so it's always at the
1963 // start of the section. Use a relocatable offset where needed to ensure
1964 // linking doesn't invalidate that offset.
1966 Asm->EmitSectionOffset(ASectionSym, ASectionSym);
1968 // Use a constant value when no symbol is provided.
1970 Asm->OutStreamer.AddComment("Address Size (in bytes)");
1971 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
1974 void DwarfUnit::addRange(RangeSpan Range) {
1975 // Only add a range for this unit if we're emitting full debug.
1976 if (getCUNode().getEmissionKind() == DIBuilder::FullDebug) {
1977 // If we have no current ranges just add the range and return, otherwise,
1978 // check the current section and CU against the previous section and CU we
1979 // emitted into and the subprogram was contained within. If these are the
1980 // same then extend our current range, otherwise add this as a new range.
1981 if (CURanges.size() == 0 ||
1982 this != DD->getPrevCU() ||
1983 Asm->getCurrentSection() != DD->getPrevSection()) {
1984 CURanges.push_back(Range);
1988 assert(&(CURanges.back().getEnd()->getSection()) ==
1989 &(Range.getEnd()->getSection()) &&
1990 "We can only append to a range in the same section!");
1991 CURanges.back().setEnd(Range.getEnd());
1995 void DwarfCompileUnit::initStmtList(MCSymbol *DwarfLineSectionSym) {
1996 // Define start line table label for each Compile Unit.
1997 MCSymbol *LineTableStartSym =
1998 Asm->OutStreamer.getDwarfLineTableSymbol(getUniqueID());
2000 stmtListIndex = UnitDie.getValues().size();
2002 // DW_AT_stmt_list is a offset of line number information for this
2003 // compile unit in debug_line section. For split dwarf this is
2004 // left in the skeleton CU and so not included.
2005 // The line table entries are not always emitted in assembly, so it
2006 // is not okay to use line_table_start here.
2007 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2008 addSectionLabel(UnitDie, dwarf::DW_AT_stmt_list, LineTableStartSym);
2010 addSectionDelta(UnitDie, dwarf::DW_AT_stmt_list, LineTableStartSym,
2011 DwarfLineSectionSym);
2014 void DwarfCompileUnit::applyStmtList(DIE &D) {
2015 D.addValue(dwarf::DW_AT_stmt_list,
2016 UnitDie.getAbbrev().getData()[stmtListIndex].getForm(),
2017 UnitDie.getValues()[stmtListIndex]);
2020 void DwarfTypeUnit::emitHeader(const MCSymbol *ASectionSym) const {
2021 DwarfUnit::emitHeader(ASectionSym);
2022 Asm->OutStreamer.AddComment("Type Signature");
2023 Asm->OutStreamer.EmitIntValue(TypeSignature, sizeof(TypeSignature));
2024 Asm->OutStreamer.AddComment("Type DIE Offset");
2025 // In a skeleton type unit there is no type DIE so emit a zero offset.
2026 Asm->OutStreamer.EmitIntValue(Ty ? Ty->getOffset() : 0,
2027 sizeof(Ty->getOffset()));
2030 void DwarfTypeUnit::initSection(const MCSection *Section) {
2031 assert(!this->Section);
2032 this->Section = Section;
2033 // Since each type unit is contained in its own COMDAT section, the begin
2034 // label and the section label are the same. Using the begin label emission in
2035 // DwarfDebug to emit the section label as well is slightly subtle/sneaky, but
2036 // the only other alternative of lazily constructing start-of-section labels
2037 // and storing a mapping in DwarfDebug (or AsmPrinter).
2038 this->SectionSym = this->LabelBegin =
2039 Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
2041 Asm->GetTempSymbol(Section->getLabelEndName(), getUniqueID());