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 "AddressPool.h"
16 #include "DwarfCompileUnit.h"
17 #include "DwarfDebug.h"
18 #include "DwarfExpression.h"
19 #include "llvm/ADT/APFloat.h"
20 #include "llvm/ADT/APInt.h"
21 #include "llvm/ADT/None.h"
22 #include "llvm/ADT/StringExtras.h"
23 #include "llvm/ADT/iterator_range.h"
24 #include "llvm/CodeGen/MachineFunction.h"
25 #include "llvm/CodeGen/MachineOperand.h"
26 #include "llvm/CodeGen/TargetRegisterInfo.h"
27 #include "llvm/CodeGen/TargetSubtargetInfo.h"
28 #include "llvm/IR/Constants.h"
29 #include "llvm/IR/DataLayout.h"
30 #include "llvm/IR/GlobalValue.h"
31 #include "llvm/IR/Metadata.h"
32 #include "llvm/MC/MCAsmInfo.h"
33 #include "llvm/MC/MCContext.h"
34 #include "llvm/MC/MCDwarf.h"
35 #include "llvm/MC/MCSection.h"
36 #include "llvm/MC/MCStreamer.h"
37 #include "llvm/MC/MachineLocation.h"
38 #include "llvm/Support/Casting.h"
39 #include "llvm/Support/CommandLine.h"
40 #include "llvm/Target/TargetLoweringObjectFile.h"
48 #define DEBUG_TYPE "dwarfdebug"
50 DIEDwarfExpression::DIEDwarfExpression(const AsmPrinter &AP, DwarfUnit &DU,
52 : DwarfExpression(AP.getDwarfVersion()), AP(AP), DU(DU),
55 void DIEDwarfExpression::emitOp(uint8_t Op, const char* Comment) {
56 DU.addUInt(DIE, dwarf::DW_FORM_data1, Op);
59 void DIEDwarfExpression::emitSigned(int64_t Value) {
60 DU.addSInt(DIE, dwarf::DW_FORM_sdata, Value);
63 void DIEDwarfExpression::emitUnsigned(uint64_t Value) {
64 DU.addUInt(DIE, dwarf::DW_FORM_udata, Value);
67 bool DIEDwarfExpression::isFrameRegister(const TargetRegisterInfo &TRI,
68 unsigned MachineReg) {
69 return MachineReg == TRI.getFrameRegister(*AP.MF);
72 DwarfUnit::DwarfUnit(dwarf::Tag UnitTag, const DICompileUnit *Node,
73 AsmPrinter *A, DwarfDebug *DW, DwarfFile *DWU)
74 : DIEUnit(A->getDwarfVersion(), A->MAI->getCodePointerSize(), UnitTag),
75 CUNode(Node), Asm(A), DD(DW), DU(DWU), IndexTyDie(nullptr) {
78 DwarfTypeUnit::DwarfTypeUnit(DwarfCompileUnit &CU, AsmPrinter *A,
79 DwarfDebug *DW, DwarfFile *DWU,
80 MCDwarfDwoLineTable *SplitLineTable)
81 : DwarfUnit(dwarf::DW_TAG_type_unit, CU.getCUNode(), A, DW, DWU), CU(CU),
82 SplitLineTable(SplitLineTable) {
85 DwarfUnit::~DwarfUnit() {
86 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
87 DIEBlocks[j]->~DIEBlock();
88 for (unsigned j = 0, M = DIELocs.size(); j < M; ++j)
89 DIELocs[j]->~DIELoc();
92 int64_t DwarfUnit::getDefaultLowerBound() const {
93 switch (getLanguage()) {
97 // The languages below have valid values in all DWARF versions.
98 case dwarf::DW_LANG_C:
99 case dwarf::DW_LANG_C89:
100 case dwarf::DW_LANG_C_plus_plus:
103 case dwarf::DW_LANG_Fortran77:
104 case dwarf::DW_LANG_Fortran90:
107 // The languages below have valid values only if the DWARF version >= 3.
108 case dwarf::DW_LANG_C99:
109 case dwarf::DW_LANG_ObjC:
110 case dwarf::DW_LANG_ObjC_plus_plus:
111 if (DD->getDwarfVersion() >= 3)
115 case dwarf::DW_LANG_Fortran95:
116 if (DD->getDwarfVersion() >= 3)
120 // Starting with DWARF v4, all defined languages have valid values.
121 case dwarf::DW_LANG_D:
122 case dwarf::DW_LANG_Java:
123 case dwarf::DW_LANG_Python:
124 case dwarf::DW_LANG_UPC:
125 if (DD->getDwarfVersion() >= 4)
129 case dwarf::DW_LANG_Ada83:
130 case dwarf::DW_LANG_Ada95:
131 case dwarf::DW_LANG_Cobol74:
132 case dwarf::DW_LANG_Cobol85:
133 case dwarf::DW_LANG_Modula2:
134 case dwarf::DW_LANG_Pascal83:
135 case dwarf::DW_LANG_PLI:
136 if (DD->getDwarfVersion() >= 4)
140 // The languages below are new in DWARF v5.
141 case dwarf::DW_LANG_BLISS:
142 case dwarf::DW_LANG_C11:
143 case dwarf::DW_LANG_C_plus_plus_03:
144 case dwarf::DW_LANG_C_plus_plus_11:
145 case dwarf::DW_LANG_C_plus_plus_14:
146 case dwarf::DW_LANG_Dylan:
147 case dwarf::DW_LANG_Go:
148 case dwarf::DW_LANG_Haskell:
149 case dwarf::DW_LANG_OCaml:
150 case dwarf::DW_LANG_OpenCL:
151 case dwarf::DW_LANG_RenderScript:
152 case dwarf::DW_LANG_Rust:
153 case dwarf::DW_LANG_Swift:
154 if (DD->getDwarfVersion() >= 5)
158 case dwarf::DW_LANG_Fortran03:
159 case dwarf::DW_LANG_Fortran08:
160 case dwarf::DW_LANG_Julia:
161 case dwarf::DW_LANG_Modula3:
162 if (DD->getDwarfVersion() >= 5)
170 /// Check whether the DIE for this MDNode can be shared across CUs.
171 bool DwarfUnit::isShareableAcrossCUs(const DINode *D) const {
172 // When the MDNode can be part of the type system, the DIE can be shared
174 // Combining type units and cross-CU DIE sharing is lower value (since
175 // cross-CU DIE sharing is used in LTO and removes type redundancy at that
176 // level already) but may be implementable for some value in projects
177 // building multiple independent libraries with LTO and then linking those
179 if (isDwoUnit() && !DD->shareAcrossDWOCUs())
181 return (isa<DIType>(D) ||
182 (isa<DISubprogram>(D) && !cast<DISubprogram>(D)->isDefinition())) &&
183 !DD->generateTypeUnits();
186 DIE *DwarfUnit::getDIE(const DINode *D) const {
187 if (isShareableAcrossCUs(D))
188 return DU->getDIE(D);
189 return MDNodeToDieMap.lookup(D);
192 void DwarfUnit::insertDIE(const DINode *Desc, DIE *D) {
193 if (isShareableAcrossCUs(Desc)) {
194 DU->insertDIE(Desc, D);
197 MDNodeToDieMap.insert(std::make_pair(Desc, D));
200 void DwarfUnit::addFlag(DIE &Die, dwarf::Attribute Attribute) {
201 if (DD->getDwarfVersion() >= 4)
202 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_flag_present,
205 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_flag,
209 void DwarfUnit::addUInt(DIEValueList &Die, dwarf::Attribute Attribute,
210 Optional<dwarf::Form> Form, uint64_t Integer) {
212 Form = DIEInteger::BestForm(false, Integer);
213 assert(Form != dwarf::DW_FORM_implicit_const &&
214 "DW_FORM_implicit_const is used only for signed integers");
215 Die.addValue(DIEValueAllocator, Attribute, *Form, DIEInteger(Integer));
218 void DwarfUnit::addUInt(DIEValueList &Block, dwarf::Form Form,
220 addUInt(Block, (dwarf::Attribute)0, Form, Integer);
223 void DwarfUnit::addSInt(DIEValueList &Die, dwarf::Attribute Attribute,
224 Optional<dwarf::Form> Form, int64_t Integer) {
226 Form = DIEInteger::BestForm(true, Integer);
227 Die.addValue(DIEValueAllocator, Attribute, *Form, DIEInteger(Integer));
230 void DwarfUnit::addSInt(DIELoc &Die, Optional<dwarf::Form> Form,
232 addSInt(Die, (dwarf::Attribute)0, Form, Integer);
235 void DwarfUnit::addString(DIE &Die, dwarf::Attribute Attribute,
237 if (CUNode->isDebugDirectivesOnly())
240 if (DD->useInlineStrings()) {
241 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_string,
242 new (DIEValueAllocator)
243 DIEInlineString(String, DIEValueAllocator));
247 isDwoUnit() ? dwarf::DW_FORM_GNU_str_index : dwarf::DW_FORM_strp;
249 auto StringPoolEntry =
250 useSegmentedStringOffsetsTable() || IxForm == dwarf::DW_FORM_GNU_str_index
251 ? DU->getStringPool().getIndexedEntry(*Asm, String)
252 : DU->getStringPool().getEntry(*Asm, String);
254 // For DWARF v5 and beyond, use the smallest strx? form possible.
255 if (useSegmentedStringOffsetsTable()) {
256 IxForm = dwarf::DW_FORM_strx1;
257 unsigned Index = StringPoolEntry.getIndex();
258 if (Index > 0xffffff)
259 IxForm = dwarf::DW_FORM_strx4;
260 else if (Index > 0xffff)
261 IxForm = dwarf::DW_FORM_strx3;
262 else if (Index > 0xff)
263 IxForm = dwarf::DW_FORM_strx2;
265 Die.addValue(DIEValueAllocator, Attribute, IxForm,
266 DIEString(StringPoolEntry));
269 DIEValueList::value_iterator DwarfUnit::addLabel(DIEValueList &Die,
270 dwarf::Attribute Attribute,
272 const MCSymbol *Label) {
273 return Die.addValue(DIEValueAllocator, Attribute, Form, DIELabel(Label));
276 void DwarfUnit::addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label) {
277 addLabel(Die, (dwarf::Attribute)0, Form, Label);
280 void DwarfUnit::addSectionOffset(DIE &Die, dwarf::Attribute Attribute,
282 if (DD->getDwarfVersion() >= 4)
283 addUInt(Die, Attribute, dwarf::DW_FORM_sec_offset, Integer);
285 addUInt(Die, Attribute, dwarf::DW_FORM_data4, Integer);
288 MD5::MD5Result *DwarfUnit::getMD5AsBytes(const DIFile *File) const {
290 if (DD->getDwarfVersion() < 5)
292 Optional<DIFile::ChecksumInfo<StringRef>> Checksum = File->getChecksum();
293 if (!Checksum || Checksum->Kind != DIFile::CSK_MD5)
296 // Convert the string checksum to an MD5Result for the streamer.
297 // The verifier validates the checksum so we assume it's okay.
298 // An MD5 checksum is 16 bytes.
299 std::string ChecksumString = fromHex(Checksum->Value);
300 void *CKMem = Asm->OutStreamer->getContext().allocate(16, 1);
301 memcpy(CKMem, ChecksumString.data(), 16);
302 return reinterpret_cast<MD5::MD5Result *>(CKMem);
305 unsigned DwarfTypeUnit::getOrCreateSourceID(const DIFile *File) {
307 return getCU().getOrCreateSourceID(File);
308 if (!UsedLineTable) {
309 UsedLineTable = true;
310 // This is a split type unit that needs a line table.
311 addSectionOffset(getUnitDie(), dwarf::DW_AT_stmt_list, 0);
313 return SplitLineTable->getFile(File->getDirectory(), File->getFilename(),
314 getMD5AsBytes(File), File->getSource());
317 void DwarfUnit::addOpAddress(DIELoc &Die, const MCSymbol *Sym) {
318 if (DD->getDwarfVersion() >= 5) {
319 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addrx);
320 addUInt(Die, dwarf::DW_FORM_addrx, DD->getAddressPool().getIndex(Sym));
324 if (DD->useSplitDwarf()) {
325 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_addr_index);
326 addUInt(Die, dwarf::DW_FORM_GNU_addr_index,
327 DD->getAddressPool().getIndex(Sym));
331 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
332 addLabel(Die, dwarf::DW_FORM_udata, Sym);
335 void DwarfUnit::addLabelDelta(DIE &Die, dwarf::Attribute Attribute,
336 const MCSymbol *Hi, const MCSymbol *Lo) {
337 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_data4,
338 new (DIEValueAllocator) DIEDelta(Hi, Lo));
341 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry) {
342 addDIEEntry(Die, Attribute, DIEEntry(Entry));
345 void DwarfUnit::addDIETypeSignature(DIE &Die, uint64_t Signature) {
346 // Flag the type unit reference as a declaration so that if it contains
347 // members (implicit special members, static data member definitions, member
348 // declarations for definitions in this CU, etc) consumers don't get confused
349 // and think this is a full definition.
350 addFlag(Die, dwarf::DW_AT_declaration);
352 Die.addValue(DIEValueAllocator, dwarf::DW_AT_signature,
353 dwarf::DW_FORM_ref_sig8, DIEInteger(Signature));
356 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute,
358 const DIEUnit *CU = Die.getUnit();
359 const DIEUnit *EntryCU = Entry.getEntry().getUnit();
361 // We assume that Die belongs to this CU, if it is not linked to any CU yet.
362 CU = getUnitDie().getUnit();
364 EntryCU = getUnitDie().getUnit();
365 Die.addValue(DIEValueAllocator, Attribute,
366 EntryCU == CU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr,
370 DIE &DwarfUnit::createAndAddDIE(unsigned Tag, DIE &Parent, const DINode *N) {
371 DIE &Die = Parent.addChild(DIE::get(DIEValueAllocator, (dwarf::Tag)Tag));
377 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Loc) {
378 Loc->ComputeSize(Asm);
379 DIELocs.push_back(Loc); // Memoize so we can call the destructor later on.
380 Die.addValue(DIEValueAllocator, Attribute,
381 Loc->BestForm(DD->getDwarfVersion()), Loc);
384 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute,
386 Block->ComputeSize(Asm);
387 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
388 Die.addValue(DIEValueAllocator, Attribute, Block->BestForm(), Block);
391 void DwarfUnit::addSourceLine(DIE &Die, unsigned Line, const DIFile *File) {
395 unsigned FileID = getOrCreateSourceID(File);
396 assert(FileID && "Invalid file id");
397 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
398 addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
401 void DwarfUnit::addSourceLine(DIE &Die, const DILocalVariable *V) {
404 addSourceLine(Die, V->getLine(), V->getFile());
407 void DwarfUnit::addSourceLine(DIE &Die, const DIGlobalVariable *G) {
410 addSourceLine(Die, G->getLine(), G->getFile());
413 void DwarfUnit::addSourceLine(DIE &Die, const DISubprogram *SP) {
416 addSourceLine(Die, SP->getLine(), SP->getFile());
419 void DwarfUnit::addSourceLine(DIE &Die, const DILabel *L) {
422 addSourceLine(Die, L->getLine(), L->getFile());
425 void DwarfUnit::addSourceLine(DIE &Die, const DIType *Ty) {
428 addSourceLine(Die, Ty->getLine(), Ty->getFile());
431 void DwarfUnit::addSourceLine(DIE &Die, const DIObjCProperty *Ty) {
434 addSourceLine(Die, Ty->getLine(), Ty->getFile());
437 /// Return true if type encoding is unsigned.
438 static bool isUnsignedDIType(DwarfDebug *DD, const DIType *Ty) {
439 if (auto *CTy = dyn_cast<DICompositeType>(Ty)) {
440 // FIXME: Enums without a fixed underlying type have unknown signedness
441 // here, leading to incorrectly emitted constants.
442 if (CTy->getTag() == dwarf::DW_TAG_enumeration_type)
445 // (Pieces of) aggregate types that get hacked apart by SROA may be
446 // represented by a constant. Encode them as unsigned bytes.
450 if (auto *DTy = dyn_cast<DIDerivedType>(Ty)) {
451 dwarf::Tag T = (dwarf::Tag)Ty->getTag();
452 // Encode pointer constants as unsigned bytes. This is used at least for
453 // null pointer constant emission.
454 // FIXME: reference and rvalue_reference /probably/ shouldn't be allowed
455 // here, but accept them for now due to a bug in SROA producing bogus
457 if (T == dwarf::DW_TAG_pointer_type ||
458 T == dwarf::DW_TAG_ptr_to_member_type ||
459 T == dwarf::DW_TAG_reference_type ||
460 T == dwarf::DW_TAG_rvalue_reference_type)
462 assert(T == dwarf::DW_TAG_typedef || T == dwarf::DW_TAG_const_type ||
463 T == dwarf::DW_TAG_volatile_type ||
464 T == dwarf::DW_TAG_restrict_type || T == dwarf::DW_TAG_atomic_type);
465 DITypeRef Deriv = DTy->getBaseType();
466 assert(Deriv && "Expected valid base type");
467 return isUnsignedDIType(DD, DD->resolve(Deriv));
470 auto *BTy = cast<DIBasicType>(Ty);
471 unsigned Encoding = BTy->getEncoding();
472 assert((Encoding == dwarf::DW_ATE_unsigned ||
473 Encoding == dwarf::DW_ATE_unsigned_char ||
474 Encoding == dwarf::DW_ATE_signed ||
475 Encoding == dwarf::DW_ATE_signed_char ||
476 Encoding == dwarf::DW_ATE_float || Encoding == dwarf::DW_ATE_UTF ||
477 Encoding == dwarf::DW_ATE_boolean ||
478 (Ty->getTag() == dwarf::DW_TAG_unspecified_type &&
479 Ty->getName() == "decltype(nullptr)")) &&
480 "Unsupported encoding");
481 return Encoding == dwarf::DW_ATE_unsigned ||
482 Encoding == dwarf::DW_ATE_unsigned_char ||
483 Encoding == dwarf::DW_ATE_UTF || Encoding == dwarf::DW_ATE_boolean ||
484 Ty->getTag() == dwarf::DW_TAG_unspecified_type;
487 void DwarfUnit::addConstantFPValue(DIE &Die, const MachineOperand &MO) {
488 assert(MO.isFPImm() && "Invalid machine operand!");
489 DIEBlock *Block = new (DIEValueAllocator) DIEBlock;
490 APFloat FPImm = MO.getFPImm()->getValueAPF();
492 // Get the raw data form of the floating point.
493 const APInt FltVal = FPImm.bitcastToAPInt();
494 const char *FltPtr = (const char *)FltVal.getRawData();
496 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
497 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
498 int Incr = (LittleEndian ? 1 : -1);
499 int Start = (LittleEndian ? 0 : NumBytes - 1);
500 int Stop = (LittleEndian ? NumBytes : -1);
502 // Output the constant to DWARF one byte at a time.
503 for (; Start != Stop; Start += Incr)
504 addUInt(*Block, dwarf::DW_FORM_data1, (unsigned char)0xFF & FltPtr[Start]);
506 addBlock(Die, dwarf::DW_AT_const_value, Block);
509 void DwarfUnit::addConstantFPValue(DIE &Die, const ConstantFP *CFP) {
510 // Pass this down to addConstantValue as an unsigned bag of bits.
511 addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), true);
514 void DwarfUnit::addConstantValue(DIE &Die, const ConstantInt *CI,
516 addConstantValue(Die, CI->getValue(), Ty);
519 void DwarfUnit::addConstantValue(DIE &Die, const MachineOperand &MO,
521 assert(MO.isImm() && "Invalid machine operand!");
523 addConstantValue(Die, isUnsignedDIType(DD, Ty), MO.getImm());
526 void DwarfUnit::addConstantValue(DIE &Die, bool Unsigned, uint64_t Val) {
527 // FIXME: This is a bit conservative/simple - it emits negative values always
528 // sign extended to 64 bits rather than minimizing the number of bytes.
529 addUInt(Die, dwarf::DW_AT_const_value,
530 Unsigned ? dwarf::DW_FORM_udata : dwarf::DW_FORM_sdata, Val);
533 void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, const DIType *Ty) {
534 addConstantValue(Die, Val, isUnsignedDIType(DD, Ty));
537 void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, bool Unsigned) {
538 unsigned CIBitWidth = Val.getBitWidth();
539 if (CIBitWidth <= 64) {
540 addConstantValue(Die, Unsigned,
541 Unsigned ? Val.getZExtValue() : Val.getSExtValue());
545 DIEBlock *Block = new (DIEValueAllocator) DIEBlock;
547 // Get the raw data form of the large APInt.
548 const uint64_t *Ptr64 = Val.getRawData();
550 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
551 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
553 // Output the constant to DWARF one byte at a time.
554 for (int i = 0; i < NumBytes; i++) {
557 c = Ptr64[i / 8] >> (8 * (i & 7));
559 c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7));
560 addUInt(*Block, dwarf::DW_FORM_data1, c);
563 addBlock(Die, dwarf::DW_AT_const_value, Block);
566 void DwarfUnit::addLinkageName(DIE &Die, StringRef LinkageName) {
567 if (!LinkageName.empty())
569 DD->getDwarfVersion() >= 4 ? dwarf::DW_AT_linkage_name
570 : dwarf::DW_AT_MIPS_linkage_name,
571 GlobalValue::dropLLVMManglingEscape(LinkageName));
574 void DwarfUnit::addTemplateParams(DIE &Buffer, DINodeArray TParams) {
575 // Add template parameters.
576 for (const auto *Element : TParams) {
577 if (auto *TTP = dyn_cast<DITemplateTypeParameter>(Element))
578 constructTemplateTypeParameterDIE(Buffer, TTP);
579 else if (auto *TVP = dyn_cast<DITemplateValueParameter>(Element))
580 constructTemplateValueParameterDIE(Buffer, TVP);
584 /// Add thrown types.
585 void DwarfUnit::addThrownTypes(DIE &Die, DINodeArray ThrownTypes) {
586 for (const auto *Ty : ThrownTypes) {
587 DIE &TT = createAndAddDIE(dwarf::DW_TAG_thrown_type, Die);
588 addType(TT, cast<DIType>(Ty));
592 DIE *DwarfUnit::getOrCreateContextDIE(const DIScope *Context) {
593 if (!Context || isa<DIFile>(Context))
594 return &getUnitDie();
595 if (auto *T = dyn_cast<DIType>(Context))
596 return getOrCreateTypeDIE(T);
597 if (auto *NS = dyn_cast<DINamespace>(Context))
598 return getOrCreateNameSpace(NS);
599 if (auto *SP = dyn_cast<DISubprogram>(Context))
600 return getOrCreateSubprogramDIE(SP);
601 if (auto *M = dyn_cast<DIModule>(Context))
602 return getOrCreateModule(M);
603 return getDIE(Context);
606 DIE *DwarfTypeUnit::createTypeDIE(const DICompositeType *Ty) {
607 auto *Context = resolve(Ty->getScope());
608 DIE *ContextDIE = getOrCreateContextDIE(Context);
610 if (DIE *TyDIE = getDIE(Ty))
614 DIE &TyDIE = createAndAddDIE(Ty->getTag(), *ContextDIE, Ty);
616 constructTypeDIE(TyDIE, cast<DICompositeType>(Ty));
618 updateAcceleratorTables(Context, Ty, TyDIE);
622 DIE *DwarfUnit::getOrCreateTypeDIE(const MDNode *TyNode) {
626 auto *Ty = cast<DIType>(TyNode);
628 // DW_TAG_restrict_type is not supported in DWARF2
629 if (Ty->getTag() == dwarf::DW_TAG_restrict_type && DD->getDwarfVersion() <= 2)
630 return getOrCreateTypeDIE(resolve(cast<DIDerivedType>(Ty)->getBaseType()));
632 // DW_TAG_atomic_type is not supported in DWARF < 5
633 if (Ty->getTag() == dwarf::DW_TAG_atomic_type && DD->getDwarfVersion() < 5)
634 return getOrCreateTypeDIE(resolve(cast<DIDerivedType>(Ty)->getBaseType()));
636 // Construct the context before querying for the existence of the DIE in case
637 // such construction creates the DIE.
638 auto *Context = resolve(Ty->getScope());
639 DIE *ContextDIE = getOrCreateContextDIE(Context);
642 if (DIE *TyDIE = getDIE(Ty))
646 DIE &TyDIE = createAndAddDIE(Ty->getTag(), *ContextDIE, Ty);
648 updateAcceleratorTables(Context, Ty, TyDIE);
650 if (auto *BT = dyn_cast<DIBasicType>(Ty))
651 constructTypeDIE(TyDIE, BT);
652 else if (auto *STy = dyn_cast<DISubroutineType>(Ty))
653 constructTypeDIE(TyDIE, STy);
654 else if (auto *CTy = dyn_cast<DICompositeType>(Ty)) {
655 if (DD->generateTypeUnits() && !Ty->isForwardDecl())
656 if (MDString *TypeId = CTy->getRawIdentifier()) {
657 DD->addDwarfTypeUnitType(getCU(), TypeId->getString(), TyDIE, CTy);
658 // Skip updating the accelerator tables since this is not the full type.
661 constructTypeDIE(TyDIE, CTy);
663 constructTypeDIE(TyDIE, cast<DIDerivedType>(Ty));
669 void DwarfUnit::updateAcceleratorTables(const DIScope *Context,
670 const DIType *Ty, const DIE &TyDIE) {
671 if (!Ty->getName().empty() && !Ty->isForwardDecl()) {
672 bool IsImplementation = false;
673 if (auto *CT = dyn_cast<DICompositeType>(Ty)) {
674 // A runtime language of 0 actually means C/C++ and that any
675 // non-negative value is some version of Objective-C/C++.
676 IsImplementation = CT->getRuntimeLang() == 0 || CT->isObjcClassComplete();
678 unsigned Flags = IsImplementation ? dwarf::DW_FLAG_type_implementation : 0;
679 DD->addAccelType(*CUNode, Ty->getName(), TyDIE, Flags);
681 if (!Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) ||
682 isa<DINamespace>(Context))
683 addGlobalType(Ty, TyDIE, Context);
687 void DwarfUnit::addType(DIE &Entity, const DIType *Ty,
688 dwarf::Attribute Attribute) {
689 assert(Ty && "Trying to add a type that doesn't exist?");
690 addDIEEntry(Entity, Attribute, DIEEntry(*getOrCreateTypeDIE(Ty)));
693 std::string DwarfUnit::getParentContextString(const DIScope *Context) const {
697 // FIXME: Decide whether to implement this for non-C++ languages.
698 if (getLanguage() != dwarf::DW_LANG_C_plus_plus)
702 SmallVector<const DIScope *, 1> Parents;
703 while (!isa<DICompileUnit>(Context)) {
704 Parents.push_back(Context);
705 if (Context->getScope())
706 Context = resolve(Context->getScope());
708 // Structure, etc types will have a NULL context if they're at the top
713 // Reverse iterate over our list to go from the outermost construct to the
715 for (const DIScope *Ctx : make_range(Parents.rbegin(), Parents.rend())) {
716 StringRef Name = Ctx->getName();
717 if (Name.empty() && isa<DINamespace>(Ctx))
718 Name = "(anonymous namespace)";
727 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIBasicType *BTy) {
728 // Get core information.
729 StringRef Name = BTy->getName();
730 // Add name if not anonymous or intermediate type.
732 addString(Buffer, dwarf::DW_AT_name, Name);
734 // An unspecified type only has a name attribute.
735 if (BTy->getTag() == dwarf::DW_TAG_unspecified_type)
738 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
741 uint64_t Size = BTy->getSizeInBits() >> 3;
742 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
744 if (BTy->isBigEndian())
745 addUInt(Buffer, dwarf::DW_AT_endianity, None, dwarf::DW_END_big);
746 else if (BTy->isLittleEndian())
747 addUInt(Buffer, dwarf::DW_AT_endianity, None, dwarf::DW_END_little);
750 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIDerivedType *DTy) {
751 // Get core information.
752 StringRef Name = DTy->getName();
753 uint64_t Size = DTy->getSizeInBits() >> 3;
754 uint16_t Tag = Buffer.getTag();
756 // Map to main type, void will not have a type.
757 const DIType *FromTy = resolve(DTy->getBaseType());
759 addType(Buffer, FromTy);
761 // Add name if not anonymous or intermediate type.
763 addString(Buffer, dwarf::DW_AT_name, Name);
765 // Add size if non-zero (derived types might be zero-sized.)
766 if (Size && Tag != dwarf::DW_TAG_pointer_type
767 && Tag != dwarf::DW_TAG_ptr_to_member_type
768 && Tag != dwarf::DW_TAG_reference_type
769 && Tag != dwarf::DW_TAG_rvalue_reference_type)
770 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
772 if (Tag == dwarf::DW_TAG_ptr_to_member_type)
774 Buffer, dwarf::DW_AT_containing_type,
775 *getOrCreateTypeDIE(resolve(cast<DIDerivedType>(DTy)->getClassType())));
776 // Add source line info if available and TyDesc is not a forward declaration.
777 if (!DTy->isForwardDecl())
778 addSourceLine(Buffer, DTy);
780 // If DWARF address space value is other than None, add it for pointer and
781 // reference types as DW_AT_address_class.
782 if (DTy->getDWARFAddressSpace() && (Tag == dwarf::DW_TAG_pointer_type ||
783 Tag == dwarf::DW_TAG_reference_type))
784 addUInt(Buffer, dwarf::DW_AT_address_class, dwarf::DW_FORM_data4,
785 DTy->getDWARFAddressSpace().getValue());
788 void DwarfUnit::constructSubprogramArguments(DIE &Buffer, DITypeRefArray Args) {
789 for (unsigned i = 1, N = Args.size(); i < N; ++i) {
790 const DIType *Ty = resolve(Args[i]);
792 assert(i == N-1 && "Unspecified parameter must be the last argument");
793 createAndAddDIE(dwarf::DW_TAG_unspecified_parameters, Buffer);
795 DIE &Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, Buffer);
797 if (Ty->isArtificial())
798 addFlag(Arg, dwarf::DW_AT_artificial);
803 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DISubroutineType *CTy) {
804 // Add return type. A void return won't have a type.
805 auto Elements = cast<DISubroutineType>(CTy)->getTypeArray();
807 if (auto RTy = resolve(Elements[0]))
808 addType(Buffer, RTy);
810 bool isPrototyped = true;
811 if (Elements.size() == 2 && !Elements[1])
812 isPrototyped = false;
814 constructSubprogramArguments(Buffer, Elements);
816 // Add prototype flag if we're dealing with a C language and the function has
818 uint16_t Language = getLanguage();
820 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
821 Language == dwarf::DW_LANG_ObjC))
822 addFlag(Buffer, dwarf::DW_AT_prototyped);
824 // Add a DW_AT_calling_convention if this has an explicit convention.
825 if (CTy->getCC() && CTy->getCC() != dwarf::DW_CC_normal)
826 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
829 if (CTy->isLValueReference())
830 addFlag(Buffer, dwarf::DW_AT_reference);
832 if (CTy->isRValueReference())
833 addFlag(Buffer, dwarf::DW_AT_rvalue_reference);
836 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
837 // Add name if not anonymous or intermediate type.
838 StringRef Name = CTy->getName();
840 uint64_t Size = CTy->getSizeInBits() >> 3;
841 uint16_t Tag = Buffer.getTag();
844 case dwarf::DW_TAG_array_type:
845 constructArrayTypeDIE(Buffer, CTy);
847 case dwarf::DW_TAG_enumeration_type:
848 constructEnumTypeDIE(Buffer, CTy);
850 case dwarf::DW_TAG_variant_part:
851 case dwarf::DW_TAG_structure_type:
852 case dwarf::DW_TAG_union_type:
853 case dwarf::DW_TAG_class_type: {
854 // Emit the discriminator for a variant part.
855 DIDerivedType *Discriminator = nullptr;
856 if (Tag == dwarf::DW_TAG_variant_part) {
857 Discriminator = CTy->getDiscriminator();
860 // If the variant part has a discriminant, the discriminant is
861 // represented by a separate debugging information entry which is
862 // a child of the variant part entry.
863 DIE &DiscMember = constructMemberDIE(Buffer, Discriminator);
864 addDIEEntry(Buffer, dwarf::DW_AT_discr, DiscMember);
868 // Add elements to structure type.
869 DINodeArray Elements = CTy->getElements();
870 for (const auto *Element : Elements) {
873 if (auto *SP = dyn_cast<DISubprogram>(Element))
874 getOrCreateSubprogramDIE(SP);
875 else if (auto *DDTy = dyn_cast<DIDerivedType>(Element)) {
876 if (DDTy->getTag() == dwarf::DW_TAG_friend) {
877 DIE &ElemDie = createAndAddDIE(dwarf::DW_TAG_friend, Buffer);
878 addType(ElemDie, resolve(DDTy->getBaseType()), dwarf::DW_AT_friend);
879 } else if (DDTy->isStaticMember()) {
880 getOrCreateStaticMemberDIE(DDTy);
881 } else if (Tag == dwarf::DW_TAG_variant_part) {
882 // When emitting a variant part, wrap each member in
884 DIE &Variant = createAndAddDIE(dwarf::DW_TAG_variant, Buffer);
885 if (const ConstantInt *CI =
886 dyn_cast_or_null<ConstantInt>(DDTy->getDiscriminantValue())) {
887 if (isUnsignedDIType(DD, resolve(Discriminator->getBaseType())))
888 addUInt(Variant, dwarf::DW_AT_discr_value, None, CI->getZExtValue());
890 addSInt(Variant, dwarf::DW_AT_discr_value, None, CI->getSExtValue());
892 constructMemberDIE(Variant, DDTy);
894 constructMemberDIE(Buffer, DDTy);
896 } else if (auto *Property = dyn_cast<DIObjCProperty>(Element)) {
897 DIE &ElemDie = createAndAddDIE(Property->getTag(), Buffer);
898 StringRef PropertyName = Property->getName();
899 addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
900 if (Property->getType())
901 addType(ElemDie, resolve(Property->getType()));
902 addSourceLine(ElemDie, Property);
903 StringRef GetterName = Property->getGetterName();
904 if (!GetterName.empty())
905 addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
906 StringRef SetterName = Property->getSetterName();
907 if (!SetterName.empty())
908 addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
909 if (unsigned PropertyAttributes = Property->getAttributes())
910 addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, None,
912 } else if (auto *Composite = dyn_cast<DICompositeType>(Element)) {
913 if (Composite->getTag() == dwarf::DW_TAG_variant_part) {
914 DIE &VariantPart = createAndAddDIE(Composite->getTag(), Buffer);
915 constructTypeDIE(VariantPart, Composite);
920 if (CTy->isAppleBlockExtension())
921 addFlag(Buffer, dwarf::DW_AT_APPLE_block);
923 // This is outside the DWARF spec, but GDB expects a DW_AT_containing_type
924 // inside C++ composite types to point to the base class with the vtable.
925 // Rust uses DW_AT_containing_type to link a vtable to the type
926 // for which it was created.
927 if (auto *ContainingType = resolve(CTy->getVTableHolder()))
928 addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
929 *getOrCreateTypeDIE(ContainingType));
931 if (CTy->isObjcClassComplete())
932 addFlag(Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
934 // Add template parameters to a class, structure or union types.
935 // FIXME: The support isn't in the metadata for this yet.
936 if (Tag == dwarf::DW_TAG_class_type ||
937 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
938 addTemplateParams(Buffer, CTy->getTemplateParams());
940 // Add the type's non-standard calling convention.
942 if (CTy->isTypePassByValue())
943 CC = dwarf::DW_CC_pass_by_value;
944 else if (CTy->isTypePassByReference())
945 CC = dwarf::DW_CC_pass_by_reference;
947 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
955 // Add name if not anonymous or intermediate type.
957 addString(Buffer, dwarf::DW_AT_name, Name);
959 if (Tag == dwarf::DW_TAG_enumeration_type ||
960 Tag == dwarf::DW_TAG_class_type || Tag == dwarf::DW_TAG_structure_type ||
961 Tag == dwarf::DW_TAG_union_type) {
962 // Add size if non-zero (derived types might be zero-sized.)
963 // TODO: Do we care about size for enum forward declarations?
965 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
966 else if (!CTy->isForwardDecl())
967 // Add zero size if it is not a forward declaration.
968 addUInt(Buffer, dwarf::DW_AT_byte_size, None, 0);
970 // If we're a forward decl, say so.
971 if (CTy->isForwardDecl())
972 addFlag(Buffer, dwarf::DW_AT_declaration);
974 // Add source line info if available.
975 if (!CTy->isForwardDecl())
976 addSourceLine(Buffer, CTy);
978 // No harm in adding the runtime language to the declaration.
979 unsigned RLang = CTy->getRuntimeLang();
981 addUInt(Buffer, dwarf::DW_AT_APPLE_runtime_class, dwarf::DW_FORM_data1,
984 // Add align info if available.
985 if (uint32_t AlignInBytes = CTy->getAlignInBytes())
986 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
991 void DwarfUnit::constructTemplateTypeParameterDIE(
992 DIE &Buffer, const DITemplateTypeParameter *TP) {
994 createAndAddDIE(dwarf::DW_TAG_template_type_parameter, Buffer);
995 // Add the type if it exists, it could be void and therefore no type.
997 addType(ParamDIE, resolve(TP->getType()));
998 if (!TP->getName().empty())
999 addString(ParamDIE, dwarf::DW_AT_name, TP->getName());
1002 void DwarfUnit::constructTemplateValueParameterDIE(
1003 DIE &Buffer, const DITemplateValueParameter *VP) {
1004 DIE &ParamDIE = createAndAddDIE(VP->getTag(), Buffer);
1006 // Add the type if there is one, template template and template parameter
1007 // packs will not have a type.
1008 if (VP->getTag() == dwarf::DW_TAG_template_value_parameter)
1009 addType(ParamDIE, resolve(VP->getType()));
1010 if (!VP->getName().empty())
1011 addString(ParamDIE, dwarf::DW_AT_name, VP->getName());
1012 if (Metadata *Val = VP->getValue()) {
1013 if (ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(Val))
1014 addConstantValue(ParamDIE, CI, resolve(VP->getType()));
1015 else if (GlobalValue *GV = mdconst::dyn_extract<GlobalValue>(Val)) {
1016 // We cannot describe the location of dllimport'd entities: the
1017 // computation of their address requires loads from the IAT.
1018 if (!GV->hasDLLImportStorageClass()) {
1019 // For declaration non-type template parameters (such as global values
1021 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1022 addOpAddress(*Loc, Asm->getSymbol(GV));
1023 // Emit DW_OP_stack_value to use the address as the immediate value of
1024 // the parameter, rather than a pointer to it.
1025 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1026 addBlock(ParamDIE, dwarf::DW_AT_location, Loc);
1028 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_template_param) {
1029 assert(isa<MDString>(Val));
1030 addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1031 cast<MDString>(Val)->getString());
1032 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
1033 addTemplateParams(ParamDIE, cast<MDTuple>(Val));
1038 DIE *DwarfUnit::getOrCreateNameSpace(const DINamespace *NS) {
1039 // Construct the context before querying for the existence of the DIE in case
1040 // such construction creates the DIE.
1041 DIE *ContextDIE = getOrCreateContextDIE(NS->getScope());
1043 if (DIE *NDie = getDIE(NS))
1045 DIE &NDie = createAndAddDIE(dwarf::DW_TAG_namespace, *ContextDIE, NS);
1047 StringRef Name = NS->getName();
1049 addString(NDie, dwarf::DW_AT_name, NS->getName());
1051 Name = "(anonymous namespace)";
1052 DD->addAccelNamespace(*CUNode, Name, NDie);
1053 addGlobalName(Name, NDie, NS->getScope());
1054 if (NS->getExportSymbols())
1055 addFlag(NDie, dwarf::DW_AT_export_symbols);
1059 DIE *DwarfUnit::getOrCreateModule(const DIModule *M) {
1060 // Construct the context before querying for the existence of the DIE in case
1061 // such construction creates the DIE.
1062 DIE *ContextDIE = getOrCreateContextDIE(M->getScope());
1064 if (DIE *MDie = getDIE(M))
1066 DIE &MDie = createAndAddDIE(dwarf::DW_TAG_module, *ContextDIE, M);
1068 if (!M->getName().empty()) {
1069 addString(MDie, dwarf::DW_AT_name, M->getName());
1070 addGlobalName(M->getName(), MDie, M->getScope());
1072 if (!M->getConfigurationMacros().empty())
1073 addString(MDie, dwarf::DW_AT_LLVM_config_macros,
1074 M->getConfigurationMacros());
1075 if (!M->getIncludePath().empty())
1076 addString(MDie, dwarf::DW_AT_LLVM_include_path, M->getIncludePath());
1077 if (!M->getISysRoot().empty())
1078 addString(MDie, dwarf::DW_AT_LLVM_isysroot, M->getISysRoot());
1083 DIE *DwarfUnit::getOrCreateSubprogramDIE(const DISubprogram *SP, bool Minimal) {
1084 // Construct the context before querying for the existence of the DIE in case
1085 // such construction creates the DIE (as is the case for member function
1088 Minimal ? &getUnitDie() : getOrCreateContextDIE(resolve(SP->getScope()));
1090 if (DIE *SPDie = getDIE(SP))
1093 if (auto *SPDecl = SP->getDeclaration()) {
1095 // Add subprogram definitions to the CU die directly.
1096 ContextDIE = &getUnitDie();
1097 // Build the decl now to ensure it precedes the definition.
1098 getOrCreateSubprogramDIE(SPDecl);
1102 // DW_TAG_inlined_subroutine may refer to this DIE.
1103 DIE &SPDie = createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, SP);
1105 // Stop here and fill this in later, depending on whether or not this
1106 // subprogram turns out to have inlined instances or not.
1107 if (SP->isDefinition())
1110 applySubprogramAttributes(SP, SPDie);
1114 bool DwarfUnit::applySubprogramDefinitionAttributes(const DISubprogram *SP,
1116 DIE *DeclDie = nullptr;
1117 StringRef DeclLinkageName;
1118 if (auto *SPDecl = SP->getDeclaration()) {
1119 DeclDie = getDIE(SPDecl);
1120 assert(DeclDie && "This DIE should've already been constructed when the "
1121 "definition DIE was created in "
1122 "getOrCreateSubprogramDIE");
1123 // Look at the Decl's linkage name only if we emitted it.
1124 if (DD->useAllLinkageNames())
1125 DeclLinkageName = SPDecl->getLinkageName();
1126 unsigned DeclID = getOrCreateSourceID(SPDecl->getFile());
1127 unsigned DefID = getOrCreateSourceID(SP->getFile());
1128 if (DeclID != DefID)
1129 addUInt(SPDie, dwarf::DW_AT_decl_file, None, DefID);
1131 if (SP->getLine() != SPDecl->getLine())
1132 addUInt(SPDie, dwarf::DW_AT_decl_line, None, SP->getLine());
1135 // Add function template parameters.
1136 addTemplateParams(SPDie, SP->getTemplateParams());
1138 // Add the linkage name if we have one and it isn't in the Decl.
1139 StringRef LinkageName = SP->getLinkageName();
1140 assert(((LinkageName.empty() || DeclLinkageName.empty()) ||
1141 LinkageName == DeclLinkageName) &&
1142 "decl has a linkage name and it is different");
1143 if (DeclLinkageName.empty() &&
1144 // Always emit it for abstract subprograms.
1145 (DD->useAllLinkageNames() || DU->getAbstractSPDies().lookup(SP)))
1146 addLinkageName(SPDie, LinkageName);
1151 // Refer to the function declaration where all the other attributes will be
1153 addDIEEntry(SPDie, dwarf::DW_AT_specification, *DeclDie);
1157 void DwarfUnit::applySubprogramAttributes(const DISubprogram *SP, DIE &SPDie,
1158 bool SkipSPAttributes) {
1159 // If -fdebug-info-for-profiling is enabled, need to emit the subprogram
1160 // and its source location.
1161 bool SkipSPSourceLocation = SkipSPAttributes &&
1162 !CUNode->getDebugInfoForProfiling();
1163 if (!SkipSPSourceLocation)
1164 if (applySubprogramDefinitionAttributes(SP, SPDie))
1167 // Constructors and operators for anonymous aggregates do not have names.
1168 if (!SP->getName().empty())
1169 addString(SPDie, dwarf::DW_AT_name, SP->getName());
1171 if (!SkipSPSourceLocation)
1172 addSourceLine(SPDie, SP);
1174 // Skip the rest of the attributes under -gmlt to save space.
1175 if (SkipSPAttributes)
1178 // Add the prototype if we have a prototype and we have a C like
1180 uint16_t Language = getLanguage();
1181 if (SP->isPrototyped() &&
1182 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
1183 Language == dwarf::DW_LANG_ObjC))
1184 addFlag(SPDie, dwarf::DW_AT_prototyped);
1187 DITypeRefArray Args;
1188 if (const DISubroutineType *SPTy = SP->getType()) {
1189 Args = SPTy->getTypeArray();
1193 // Add a DW_AT_calling_convention if this has an explicit convention.
1194 if (CC && CC != dwarf::DW_CC_normal)
1195 addUInt(SPDie, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, CC);
1197 // Add a return type. If this is a type like a C/C++ void type we don't add a
1200 if (auto Ty = resolve(Args[0]))
1203 unsigned VK = SP->getVirtuality();
1205 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
1206 if (SP->getVirtualIndex() != -1u) {
1207 DIELoc *Block = getDIELoc();
1208 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1209 addUInt(*Block, dwarf::DW_FORM_udata, SP->getVirtualIndex());
1210 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, Block);
1212 ContainingTypeMap.insert(
1213 std::make_pair(&SPDie, resolve(SP->getContainingType())));
1216 if (!SP->isDefinition()) {
1217 addFlag(SPDie, dwarf::DW_AT_declaration);
1219 // Add arguments. Do not add arguments for subprogram definition. They will
1220 // be handled while processing variables.
1221 constructSubprogramArguments(SPDie, Args);
1224 addThrownTypes(SPDie, SP->getThrownTypes());
1226 if (SP->isArtificial())
1227 addFlag(SPDie, dwarf::DW_AT_artificial);
1229 if (!SP->isLocalToUnit())
1230 addFlag(SPDie, dwarf::DW_AT_external);
1232 if (DD->useAppleExtensionAttributes()) {
1233 if (SP->isOptimized())
1234 addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
1236 if (unsigned isa = Asm->getISAEncoding())
1237 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1240 if (SP->isLValueReference())
1241 addFlag(SPDie, dwarf::DW_AT_reference);
1243 if (SP->isRValueReference())
1244 addFlag(SPDie, dwarf::DW_AT_rvalue_reference);
1246 if (SP->isNoReturn())
1247 addFlag(SPDie, dwarf::DW_AT_noreturn);
1249 if (SP->isProtected())
1250 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1251 dwarf::DW_ACCESS_protected);
1252 else if (SP->isPrivate())
1253 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1254 dwarf::DW_ACCESS_private);
1255 else if (SP->isPublic())
1256 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1257 dwarf::DW_ACCESS_public);
1259 if (SP->isExplicit())
1260 addFlag(SPDie, dwarf::DW_AT_explicit);
1262 if (SP->isMainSubprogram())
1263 addFlag(SPDie, dwarf::DW_AT_main_subprogram);
1266 void DwarfUnit::constructSubrangeDIE(DIE &Buffer, const DISubrange *SR,
1268 DIE &DW_Subrange = createAndAddDIE(dwarf::DW_TAG_subrange_type, Buffer);
1269 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, *IndexTy);
1271 // The LowerBound value defines the lower bounds which is typically zero for
1272 // C/C++. The Count value is the number of elements. Values are 64 bit. If
1273 // Count == -1 then the array is unbounded and we do not emit
1274 // DW_AT_lower_bound and DW_AT_count attributes.
1275 int64_t LowerBound = SR->getLowerBound();
1276 int64_t DefaultLowerBound = getDefaultLowerBound();
1278 if (auto *CI = SR->getCount().dyn_cast<ConstantInt*>())
1279 Count = CI->getSExtValue();
1281 if (DefaultLowerBound == -1 || LowerBound != DefaultLowerBound)
1282 addUInt(DW_Subrange, dwarf::DW_AT_lower_bound, None, LowerBound);
1284 if (auto *CV = SR->getCount().dyn_cast<DIVariable*>()) {
1285 if (auto *CountVarDIE = getDIE(CV))
1286 addDIEEntry(DW_Subrange, dwarf::DW_AT_count, *CountVarDIE);
1287 } else if (Count != -1)
1288 addUInt(DW_Subrange, dwarf::DW_AT_count, None, Count);
1291 DIE *DwarfUnit::getIndexTyDie() {
1294 // Construct an integer type to use for indexes.
1295 IndexTyDie = &createAndAddDIE(dwarf::DW_TAG_base_type, getUnitDie());
1296 StringRef Name = "__ARRAY_SIZE_TYPE__";
1297 addString(*IndexTyDie, dwarf::DW_AT_name, Name);
1298 addUInt(*IndexTyDie, dwarf::DW_AT_byte_size, None, sizeof(int64_t));
1299 addUInt(*IndexTyDie, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1300 dwarf::DW_ATE_unsigned);
1301 DD->addAccelType(*CUNode, Name, *IndexTyDie, /*Flags*/ 0);
1305 /// Returns true if the vector's size differs from the sum of sizes of elements
1306 /// the user specified. This can occur if the vector has been rounded up to
1307 /// fit memory alignment constraints.
1308 static bool hasVectorBeenPadded(const DICompositeType *CTy) {
1309 assert(CTy && CTy->isVector() && "Composite type is not a vector");
1310 const uint64_t ActualSize = CTy->getSizeInBits();
1312 // Obtain the size of each element in the vector.
1313 DIType *BaseTy = CTy->getBaseType().resolve();
1314 assert(BaseTy && "Unknown vector element type.");
1315 const uint64_t ElementSize = BaseTy->getSizeInBits();
1317 // Locate the number of elements in the vector.
1318 const DINodeArray Elements = CTy->getElements();
1319 assert(Elements.size() == 1 &&
1320 Elements[0]->getTag() == dwarf::DW_TAG_subrange_type &&
1321 "Invalid vector element array, expected one element of type subrange");
1322 const auto Subrange = cast<DISubrange>(Elements[0]);
1323 const auto CI = Subrange->getCount().get<ConstantInt *>();
1324 const int32_t NumVecElements = CI->getSExtValue();
1326 // Ensure we found the element count and that the actual size is wide
1327 // enough to contain the requested size.
1328 assert(ActualSize >= (NumVecElements * ElementSize) && "Invalid vector size");
1329 return ActualSize != (NumVecElements * ElementSize);
1332 void DwarfUnit::constructArrayTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
1333 if (CTy->isVector()) {
1334 addFlag(Buffer, dwarf::DW_AT_GNU_vector);
1335 if (hasVectorBeenPadded(CTy))
1336 addUInt(Buffer, dwarf::DW_AT_byte_size, None,
1337 CTy->getSizeInBits() / CHAR_BIT);
1340 // Emit the element type.
1341 addType(Buffer, resolve(CTy->getBaseType()));
1343 // Get an anonymous type for index type.
1344 // FIXME: This type should be passed down from the front end
1345 // as different languages may have different sizes for indexes.
1346 DIE *IdxTy = getIndexTyDie();
1348 // Add subranges to array type.
1349 DINodeArray Elements = CTy->getElements();
1350 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
1351 // FIXME: Should this really be such a loose cast?
1352 if (auto *Element = dyn_cast_or_null<DINode>(Elements[i]))
1353 if (Element->getTag() == dwarf::DW_TAG_subrange_type)
1354 constructSubrangeDIE(Buffer, cast<DISubrange>(Element), IdxTy);
1358 void DwarfUnit::constructEnumTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
1359 const DIType *DTy = resolve(CTy->getBaseType());
1360 bool IsUnsigned = DTy && isUnsignedDIType(DD, DTy);
1362 if (DD->getDwarfVersion() >= 3)
1363 addType(Buffer, DTy);
1364 if (DD->getDwarfVersion() >= 4 && (CTy->getFlags() & DINode::FlagEnumClass))
1365 addFlag(Buffer, dwarf::DW_AT_enum_class);
1368 DINodeArray Elements = CTy->getElements();
1370 // Add enumerators to enumeration type.
1371 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
1372 auto *Enum = dyn_cast_or_null<DIEnumerator>(Elements[i]);
1374 DIE &Enumerator = createAndAddDIE(dwarf::DW_TAG_enumerator, Buffer);
1375 StringRef Name = Enum->getName();
1376 addString(Enumerator, dwarf::DW_AT_name, Name);
1377 auto Value = static_cast<uint64_t>(Enum->getValue());
1378 addConstantValue(Enumerator, IsUnsigned, Value);
1383 void DwarfUnit::constructContainingTypeDIEs() {
1384 for (auto CI = ContainingTypeMap.begin(), CE = ContainingTypeMap.end();
1386 DIE &SPDie = *CI->first;
1387 const DINode *D = CI->second;
1390 DIE *NDie = getDIE(D);
1393 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, *NDie);
1397 DIE &DwarfUnit::constructMemberDIE(DIE &Buffer, const DIDerivedType *DT) {
1398 DIE &MemberDie = createAndAddDIE(DT->getTag(), Buffer);
1399 StringRef Name = DT->getName();
1401 addString(MemberDie, dwarf::DW_AT_name, Name);
1403 if (DIType *Resolved = resolve(DT->getBaseType()))
1404 addType(MemberDie, Resolved);
1406 addSourceLine(MemberDie, DT);
1408 if (DT->getTag() == dwarf::DW_TAG_inheritance && DT->isVirtual()) {
1410 // For C++, virtual base classes are not at fixed offset. Use following
1411 // expression to extract appropriate offset from vtable.
1412 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1414 DIELoc *VBaseLocationDie = new (DIEValueAllocator) DIELoc;
1415 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1416 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1417 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1418 addUInt(*VBaseLocationDie, dwarf::DW_FORM_udata, DT->getOffsetInBits());
1419 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1420 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1421 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1423 addBlock(MemberDie, dwarf::DW_AT_data_member_location, VBaseLocationDie);
1425 uint64_t Size = DT->getSizeInBits();
1426 uint64_t FieldSize = DD->getBaseTypeSize(DT);
1427 uint32_t AlignInBytes = DT->getAlignInBytes();
1428 uint64_t OffsetInBytes;
1430 bool IsBitfield = FieldSize && Size != FieldSize;
1432 // Handle bitfield, assume bytes are 8 bits.
1433 if (DD->useDWARF2Bitfields())
1434 addUInt(MemberDie, dwarf::DW_AT_byte_size, None, FieldSize/8);
1435 addUInt(MemberDie, dwarf::DW_AT_bit_size, None, Size);
1437 uint64_t Offset = DT->getOffsetInBits();
1438 // We can't use DT->getAlignInBits() here: AlignInBits for member type
1439 // is non-zero if and only if alignment was forced (e.g. _Alignas()),
1440 // which can't be done with bitfields. Thus we use FieldSize here.
1441 uint32_t AlignInBits = FieldSize;
1442 uint32_t AlignMask = ~(AlignInBits - 1);
1443 // The bits from the start of the storage unit to the start of the field.
1444 uint64_t StartBitOffset = Offset - (Offset & AlignMask);
1445 // The byte offset of the field's aligned storage unit inside the struct.
1446 OffsetInBytes = (Offset - StartBitOffset) / 8;
1448 if (DD->useDWARF2Bitfields()) {
1449 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1450 uint64_t FieldOffset = (HiMark - FieldSize);
1451 Offset -= FieldOffset;
1453 // Maybe we need to work from the other end.
1454 if (Asm->getDataLayout().isLittleEndian())
1455 Offset = FieldSize - (Offset + Size);
1457 addUInt(MemberDie, dwarf::DW_AT_bit_offset, None, Offset);
1458 OffsetInBytes = FieldOffset >> 3;
1460 addUInt(MemberDie, dwarf::DW_AT_data_bit_offset, None, Offset);
1463 // This is not a bitfield.
1464 OffsetInBytes = DT->getOffsetInBits() / 8;
1466 addUInt(MemberDie, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1470 if (DD->getDwarfVersion() <= 2) {
1471 DIELoc *MemLocationDie = new (DIEValueAllocator) DIELoc;
1472 addUInt(*MemLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1473 addUInt(*MemLocationDie, dwarf::DW_FORM_udata, OffsetInBytes);
1474 addBlock(MemberDie, dwarf::DW_AT_data_member_location, MemLocationDie);
1475 } else if (!IsBitfield || DD->useDWARF2Bitfields())
1476 addUInt(MemberDie, dwarf::DW_AT_data_member_location, None,
1480 if (DT->isProtected())
1481 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1482 dwarf::DW_ACCESS_protected);
1483 else if (DT->isPrivate())
1484 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1485 dwarf::DW_ACCESS_private);
1486 // Otherwise C++ member and base classes are considered public.
1487 else if (DT->isPublic())
1488 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1489 dwarf::DW_ACCESS_public);
1490 if (DT->isVirtual())
1491 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
1492 dwarf::DW_VIRTUALITY_virtual);
1494 // Objective-C properties.
1495 if (DINode *PNode = DT->getObjCProperty())
1496 if (DIE *PDie = getDIE(PNode))
1497 MemberDie.addValue(DIEValueAllocator, dwarf::DW_AT_APPLE_property,
1498 dwarf::DW_FORM_ref4, DIEEntry(*PDie));
1500 if (DT->isArtificial())
1501 addFlag(MemberDie, dwarf::DW_AT_artificial);
1506 DIE *DwarfUnit::getOrCreateStaticMemberDIE(const DIDerivedType *DT) {
1510 // Construct the context before querying for the existence of the DIE in case
1511 // such construction creates the DIE.
1512 DIE *ContextDIE = getOrCreateContextDIE(resolve(DT->getScope()));
1513 assert(dwarf::isType(ContextDIE->getTag()) &&
1514 "Static member should belong to a type.");
1516 if (DIE *StaticMemberDIE = getDIE(DT))
1517 return StaticMemberDIE;
1519 DIE &StaticMemberDIE = createAndAddDIE(DT->getTag(), *ContextDIE, DT);
1521 const DIType *Ty = resolve(DT->getBaseType());
1523 addString(StaticMemberDIE, dwarf::DW_AT_name, DT->getName());
1524 addType(StaticMemberDIE, Ty);
1525 addSourceLine(StaticMemberDIE, DT);
1526 addFlag(StaticMemberDIE, dwarf::DW_AT_external);
1527 addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
1529 // FIXME: We could omit private if the parent is a class_type, and
1530 // public if the parent is something else.
1531 if (DT->isProtected())
1532 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1533 dwarf::DW_ACCESS_protected);
1534 else if (DT->isPrivate())
1535 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1536 dwarf::DW_ACCESS_private);
1537 else if (DT->isPublic())
1538 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1539 dwarf::DW_ACCESS_public);
1541 if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT->getConstant()))
1542 addConstantValue(StaticMemberDIE, CI, Ty);
1543 if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT->getConstant()))
1544 addConstantFPValue(StaticMemberDIE, CFP);
1546 if (uint32_t AlignInBytes = DT->getAlignInBytes())
1547 addUInt(StaticMemberDIE, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1550 return &StaticMemberDIE;
1553 void DwarfUnit::emitCommonHeader(bool UseOffsets, dwarf::UnitType UT) {
1554 // Emit size of content not including length itself
1555 Asm->OutStreamer->AddComment("Length of Unit");
1556 if (!DD->useSectionsAsReferences()) {
1557 StringRef Prefix = isDwoUnit() ? "debug_info_dwo_" : "debug_info_";
1558 MCSymbol *BeginLabel = Asm->createTempSymbol(Prefix + "start");
1559 EndLabel = Asm->createTempSymbol(Prefix + "end");
1560 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
1561 Asm->OutStreamer->EmitLabel(BeginLabel);
1563 Asm->emitInt32(getHeaderSize() + getUnitDie().getSize());
1565 Asm->OutStreamer->AddComment("DWARF version number");
1566 unsigned Version = DD->getDwarfVersion();
1567 Asm->emitInt16(Version);
1569 // DWARF v5 reorders the address size and adds a unit type.
1571 Asm->OutStreamer->AddComment("DWARF Unit Type");
1573 Asm->OutStreamer->AddComment("Address Size (in bytes)");
1574 Asm->emitInt8(Asm->MAI->getCodePointerSize());
1577 // We share one abbreviations table across all units so it's always at the
1578 // start of the section. Use a relocatable offset where needed to ensure
1579 // linking doesn't invalidate that offset.
1580 Asm->OutStreamer->AddComment("Offset Into Abbrev. Section");
1581 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1585 Asm->emitDwarfSymbolReference(
1586 TLOF.getDwarfAbbrevSection()->getBeginSymbol(), false);
1589 Asm->OutStreamer->AddComment("Address Size (in bytes)");
1590 Asm->emitInt8(Asm->MAI->getCodePointerSize());
1594 void DwarfTypeUnit::emitHeader(bool UseOffsets) {
1595 DwarfUnit::emitCommonHeader(UseOffsets,
1596 DD->useSplitDwarf() ? dwarf::DW_UT_split_type
1597 : dwarf::DW_UT_type);
1598 Asm->OutStreamer->AddComment("Type Signature");
1599 Asm->OutStreamer->EmitIntValue(TypeSignature, sizeof(TypeSignature));
1600 Asm->OutStreamer->AddComment("Type DIE Offset");
1601 // In a skeleton type unit there is no type DIE so emit a zero offset.
1602 Asm->OutStreamer->EmitIntValue(Ty ? Ty->getOffset() : 0,
1603 sizeof(Ty->getOffset()));
1607 DwarfUnit::addSectionDelta(DIE &Die, dwarf::Attribute Attribute,
1608 const MCSymbol *Hi, const MCSymbol *Lo) {
1609 return Die.addValue(DIEValueAllocator, Attribute,
1610 DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
1611 : dwarf::DW_FORM_data4,
1612 new (DIEValueAllocator) DIEDelta(Hi, Lo));
1616 DwarfUnit::addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
1617 const MCSymbol *Label, const MCSymbol *Sec) {
1618 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1619 return addLabel(Die, Attribute,
1620 DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
1621 : dwarf::DW_FORM_data4,
1623 return addSectionDelta(Die, Attribute, Label, Sec);
1626 bool DwarfTypeUnit::isDwoUnit() const {
1627 // Since there are no skeleton type units, all type units are dwo type units
1628 // when split DWARF is being used.
1629 return DD->useSplitDwarf();
1632 void DwarfTypeUnit::addGlobalName(StringRef Name, const DIE &Die,
1633 const DIScope *Context) {
1634 getCU().addGlobalNameForTypeUnit(Name, Context);
1637 void DwarfTypeUnit::addGlobalType(const DIType *Ty, const DIE &Die,
1638 const DIScope *Context) {
1639 getCU().addGlobalTypeUnitType(Ty, Context);
1642 const MCSymbol *DwarfUnit::getCrossSectionRelativeBaseAddress() const {
1643 if (!Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1647 return getSection()->getBeginSymbol();
1650 void DwarfUnit::addStringOffsetsStart() {
1651 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1652 addSectionLabel(getUnitDie(), dwarf::DW_AT_str_offsets_base,
1653 DU->getStringOffsetsStartSym(),
1654 TLOF.getDwarfStrOffSection()->getBeginSymbol());
1657 void DwarfUnit::addRnglistsBase() {
1658 assert(DD->getDwarfVersion() >= 5 &&
1659 "DW_AT_rnglists_base requires DWARF version 5 or later");
1660 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1661 addSectionLabel(getUnitDie(), dwarf::DW_AT_rnglists_base,
1662 DU->getRnglistsTableBaseSym(),
1663 TLOF.getDwarfRnglistsSection()->getBeginSymbol());
1666 void DwarfUnit::addLoclistsBase() {
1667 assert(DD->getDwarfVersion() >= 5 &&
1668 "DW_AT_loclists_base requires DWARF version 5 or later");
1669 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1670 addSectionLabel(getUnitDie(), dwarf::DW_AT_loclists_base,
1671 DU->getLoclistsTableBaseSym(),
1672 TLOF.getDwarfLoclistsSection()->getBeginSymbol());