1 //===-- llvm/CodeGen/DwarfUnit.cpp - Dwarf Type and Compile Units ---------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains support for constructing a dwarf compile unit.
10 //
11 //===----------------------------------------------------------------------===//
12
13 #include "DwarfUnit.h"
14 #include "AddressPool.h"
15 #include "DwarfCompileUnit.h"
16 #include "DwarfExpression.h"
17 #include "llvm/ADT/APFloat.h"
18 #include "llvm/ADT/APInt.h"
19 #include "llvm/ADT/None.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/ADT/iterator_range.h"
22 #include "llvm/CodeGen/MachineFunction.h"
23 #include "llvm/CodeGen/MachineOperand.h"
24 #include "llvm/CodeGen/TargetRegisterInfo.h"
25 #include "llvm/CodeGen/TargetSubtargetInfo.h"
26 #include "llvm/IR/Constants.h"
27 #include "llvm/IR/DataLayout.h"
28 #include "llvm/IR/GlobalValue.h"
29 #include "llvm/IR/Metadata.h"
30 #include "llvm/MC/MCAsmInfo.h"
31 #include "llvm/MC/MCContext.h"
32 #include "llvm/MC/MCDwarf.h"
33 #include "llvm/MC/MCSection.h"
34 #include "llvm/MC/MCStreamer.h"
35 #include "llvm/MC/MachineLocation.h"
36 #include "llvm/Support/Casting.h"
37 #include "llvm/Support/CommandLine.h"
38 #include "llvm/Target/TargetLoweringObjectFile.h"
39 #include <cassert>
40 #include <cstdint>
41 #include <string>
42 #include <utility>
43
44 using namespace llvm;
45
46 #define DEBUG_TYPE "dwarfdebug"
47
DIEDwarfExpression(const AsmPrinter & AP,DwarfCompileUnit & CU,DIELoc & DIE)48 DIEDwarfExpression::DIEDwarfExpression(const AsmPrinter &AP,
49 DwarfCompileUnit &CU, DIELoc &DIE)
50 : DwarfExpression(AP.getDwarfVersion(), CU), AP(AP), OutDIE(DIE) {}
51
emitOp(uint8_t Op,const char * Comment)52 void DIEDwarfExpression::emitOp(uint8_t Op, const char* Comment) {
53 CU.addUInt(getActiveDIE(), dwarf::DW_FORM_data1, Op);
54 }
55
emitSigned(int64_t Value)56 void DIEDwarfExpression::emitSigned(int64_t Value) {
57 CU.addSInt(getActiveDIE(), dwarf::DW_FORM_sdata, Value);
58 }
59
emitUnsigned(uint64_t Value)60 void DIEDwarfExpression::emitUnsigned(uint64_t Value) {
61 CU.addUInt(getActiveDIE(), dwarf::DW_FORM_udata, Value);
62 }
63
emitData1(uint8_t Value)64 void DIEDwarfExpression::emitData1(uint8_t Value) {
65 CU.addUInt(getActiveDIE(), dwarf::DW_FORM_data1, Value);
66 }
67
emitBaseTypeRef(uint64_t Idx)68 void DIEDwarfExpression::emitBaseTypeRef(uint64_t Idx) {
69 CU.addBaseTypeRef(getActiveDIE(), Idx);
70 }
71
enableTemporaryBuffer()72 void DIEDwarfExpression::enableTemporaryBuffer() {
73 assert(!IsBuffering && "Already buffering?");
74 IsBuffering = true;
75 }
76
disableTemporaryBuffer()77 void DIEDwarfExpression::disableTemporaryBuffer() { IsBuffering = false; }
78
getTemporaryBufferSize()79 unsigned DIEDwarfExpression::getTemporaryBufferSize() {
80 return TmpDIE.ComputeSize(&AP);
81 }
82
commitTemporaryBuffer()83 void DIEDwarfExpression::commitTemporaryBuffer() { OutDIE.takeValues(TmpDIE); }
84
isFrameRegister(const TargetRegisterInfo & TRI,llvm::Register MachineReg)85 bool DIEDwarfExpression::isFrameRegister(const TargetRegisterInfo &TRI,
86 llvm::Register MachineReg) {
87 return MachineReg == TRI.getFrameRegister(*AP.MF);
88 }
89
DwarfUnit(dwarf::Tag UnitTag,const DICompileUnit * Node,AsmPrinter * A,DwarfDebug * DW,DwarfFile * DWU)90 DwarfUnit::DwarfUnit(dwarf::Tag UnitTag, const DICompileUnit *Node,
91 AsmPrinter *A, DwarfDebug *DW, DwarfFile *DWU)
92 : DIEUnit(UnitTag), CUNode(Node), Asm(A), DD(DW), DU(DWU),
93 IndexTyDie(nullptr) {}
94
DwarfTypeUnit(DwarfCompileUnit & CU,AsmPrinter * A,DwarfDebug * DW,DwarfFile * DWU,MCDwarfDwoLineTable * SplitLineTable)95 DwarfTypeUnit::DwarfTypeUnit(DwarfCompileUnit &CU, AsmPrinter *A,
96 DwarfDebug *DW, DwarfFile *DWU,
97 MCDwarfDwoLineTable *SplitLineTable)
98 : DwarfUnit(dwarf::DW_TAG_type_unit, CU.getCUNode(), A, DW, DWU), CU(CU),
99 SplitLineTable(SplitLineTable) {
100 }
101
~DwarfUnit()102 DwarfUnit::~DwarfUnit() {
103 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
104 DIEBlocks[j]->~DIEBlock();
105 for (unsigned j = 0, M = DIELocs.size(); j < M; ++j)
106 DIELocs[j]->~DIELoc();
107 }
108
getDefaultLowerBound() const109 int64_t DwarfUnit::getDefaultLowerBound() const {
110 switch (getLanguage()) {
111 default:
112 break;
113
114 // The languages below have valid values in all DWARF versions.
115 case dwarf::DW_LANG_C:
116 case dwarf::DW_LANG_C89:
117 case dwarf::DW_LANG_C_plus_plus:
118 return 0;
119
120 case dwarf::DW_LANG_Fortran77:
121 case dwarf::DW_LANG_Fortran90:
122 return 1;
123
124 // The languages below have valid values only if the DWARF version >= 3.
125 case dwarf::DW_LANG_C99:
126 case dwarf::DW_LANG_ObjC:
127 case dwarf::DW_LANG_ObjC_plus_plus:
128 if (DD->getDwarfVersion() >= 3)
129 return 0;
130 break;
131
132 case dwarf::DW_LANG_Fortran95:
133 if (DD->getDwarfVersion() >= 3)
134 return 1;
135 break;
136
137 // Starting with DWARF v4, all defined languages have valid values.
138 case dwarf::DW_LANG_D:
139 case dwarf::DW_LANG_Java:
140 case dwarf::DW_LANG_Python:
141 case dwarf::DW_LANG_UPC:
142 if (DD->getDwarfVersion() >= 4)
143 return 0;
144 break;
145
146 case dwarf::DW_LANG_Ada83:
147 case dwarf::DW_LANG_Ada95:
148 case dwarf::DW_LANG_Cobol74:
149 case dwarf::DW_LANG_Cobol85:
150 case dwarf::DW_LANG_Modula2:
151 case dwarf::DW_LANG_Pascal83:
152 case dwarf::DW_LANG_PLI:
153 if (DD->getDwarfVersion() >= 4)
154 return 1;
155 break;
156
157 // The languages below are new in DWARF v5.
158 case dwarf::DW_LANG_BLISS:
159 case dwarf::DW_LANG_C11:
160 case dwarf::DW_LANG_C_plus_plus_03:
161 case dwarf::DW_LANG_C_plus_plus_11:
162 case dwarf::DW_LANG_C_plus_plus_14:
163 case dwarf::DW_LANG_Dylan:
164 case dwarf::DW_LANG_Go:
165 case dwarf::DW_LANG_Haskell:
166 case dwarf::DW_LANG_OCaml:
167 case dwarf::DW_LANG_OpenCL:
168 case dwarf::DW_LANG_RenderScript:
169 case dwarf::DW_LANG_Rust:
170 case dwarf::DW_LANG_Swift:
171 if (DD->getDwarfVersion() >= 5)
172 return 0;
173 break;
174
175 case dwarf::DW_LANG_Fortran03:
176 case dwarf::DW_LANG_Fortran08:
177 case dwarf::DW_LANG_Julia:
178 case dwarf::DW_LANG_Modula3:
179 if (DD->getDwarfVersion() >= 5)
180 return 1;
181 break;
182 }
183
184 return -1;
185 }
186
187 /// Check whether the DIE for this MDNode can be shared across CUs.
isShareableAcrossCUs(const DINode * D) const188 bool DwarfUnit::isShareableAcrossCUs(const DINode *D) const {
189 // When the MDNode can be part of the type system (this includes subprogram
190 // declarations *and* subprogram definitions, even local definitions), the
191 // DIE must be shared across CUs.
192 // Combining type units and cross-CU DIE sharing is lower value (since
193 // cross-CU DIE sharing is used in LTO and removes type redundancy at that
194 // level already) but may be implementable for some value in projects
195 // building multiple independent libraries with LTO and then linking those
196 // together.
197 if (isDwoUnit() && !DD->shareAcrossDWOCUs())
198 return false;
199 return (isa<DIType>(D) || isa<DISubprogram>(D)) && !DD->generateTypeUnits();
200 }
201
getDIE(const DINode * D) const202 DIE *DwarfUnit::getDIE(const DINode *D) const {
203 if (isShareableAcrossCUs(D))
204 return DU->getDIE(D);
205 return MDNodeToDieMap.lookup(D);
206 }
207
insertDIE(const DINode * Desc,DIE * D)208 void DwarfUnit::insertDIE(const DINode *Desc, DIE *D) {
209 if (isShareableAcrossCUs(Desc)) {
210 DU->insertDIE(Desc, D);
211 return;
212 }
213 MDNodeToDieMap.insert(std::make_pair(Desc, D));
214 }
215
insertDIE(DIE * D)216 void DwarfUnit::insertDIE(DIE *D) {
217 MDNodeToDieMap.insert(std::make_pair(nullptr, D));
218 }
219
addFlag(DIE & Die,dwarf::Attribute Attribute)220 void DwarfUnit::addFlag(DIE &Die, dwarf::Attribute Attribute) {
221 if (DD->getDwarfVersion() >= 4)
222 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_flag_present,
223 DIEInteger(1));
224 else
225 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_flag,
226 DIEInteger(1));
227 }
228
addUInt(DIEValueList & Die,dwarf::Attribute Attribute,Optional<dwarf::Form> Form,uint64_t Integer)229 void DwarfUnit::addUInt(DIEValueList &Die, dwarf::Attribute Attribute,
230 Optional<dwarf::Form> Form, uint64_t Integer) {
231 if (!Form)
232 Form = DIEInteger::BestForm(false, Integer);
233 assert(Form != dwarf::DW_FORM_implicit_const &&
234 "DW_FORM_implicit_const is used only for signed integers");
235 Die.addValue(DIEValueAllocator, Attribute, *Form, DIEInteger(Integer));
236 }
237
addUInt(DIEValueList & Block,dwarf::Form Form,uint64_t Integer)238 void DwarfUnit::addUInt(DIEValueList &Block, dwarf::Form Form,
239 uint64_t Integer) {
240 addUInt(Block, (dwarf::Attribute)0, Form, Integer);
241 }
242
addSInt(DIEValueList & Die,dwarf::Attribute Attribute,Optional<dwarf::Form> Form,int64_t Integer)243 void DwarfUnit::addSInt(DIEValueList &Die, dwarf::Attribute Attribute,
244 Optional<dwarf::Form> Form, int64_t Integer) {
245 if (!Form)
246 Form = DIEInteger::BestForm(true, Integer);
247 Die.addValue(DIEValueAllocator, Attribute, *Form, DIEInteger(Integer));
248 }
249
addSInt(DIELoc & Die,Optional<dwarf::Form> Form,int64_t Integer)250 void DwarfUnit::addSInt(DIELoc &Die, Optional<dwarf::Form> Form,
251 int64_t Integer) {
252 addSInt(Die, (dwarf::Attribute)0, Form, Integer);
253 }
254
addString(DIE & Die,dwarf::Attribute Attribute,StringRef String)255 void DwarfUnit::addString(DIE &Die, dwarf::Attribute Attribute,
256 StringRef String) {
257 if (CUNode->isDebugDirectivesOnly())
258 return;
259
260 if (DD->useInlineStrings()) {
261 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_string,
262 new (DIEValueAllocator)
263 DIEInlineString(String, DIEValueAllocator));
264 return;
265 }
266 dwarf::Form IxForm =
267 isDwoUnit() ? dwarf::DW_FORM_GNU_str_index : dwarf::DW_FORM_strp;
268
269 auto StringPoolEntry =
270 useSegmentedStringOffsetsTable() || IxForm == dwarf::DW_FORM_GNU_str_index
271 ? DU->getStringPool().getIndexedEntry(*Asm, String)
272 : DU->getStringPool().getEntry(*Asm, String);
273
274 // For DWARF v5 and beyond, use the smallest strx? form possible.
275 if (useSegmentedStringOffsetsTable()) {
276 IxForm = dwarf::DW_FORM_strx1;
277 unsigned Index = StringPoolEntry.getIndex();
278 if (Index > 0xffffff)
279 IxForm = dwarf::DW_FORM_strx4;
280 else if (Index > 0xffff)
281 IxForm = dwarf::DW_FORM_strx3;
282 else if (Index > 0xff)
283 IxForm = dwarf::DW_FORM_strx2;
284 }
285 Die.addValue(DIEValueAllocator, Attribute, IxForm,
286 DIEString(StringPoolEntry));
287 }
288
addLabel(DIEValueList & Die,dwarf::Attribute Attribute,dwarf::Form Form,const MCSymbol * Label)289 DIEValueList::value_iterator DwarfUnit::addLabel(DIEValueList &Die,
290 dwarf::Attribute Attribute,
291 dwarf::Form Form,
292 const MCSymbol *Label) {
293 return Die.addValue(DIEValueAllocator, Attribute, Form, DIELabel(Label));
294 }
295
addLabel(DIELoc & Die,dwarf::Form Form,const MCSymbol * Label)296 void DwarfUnit::addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label) {
297 addLabel(Die, (dwarf::Attribute)0, Form, Label);
298 }
299
addSectionOffset(DIE & Die,dwarf::Attribute Attribute,uint64_t Integer)300 void DwarfUnit::addSectionOffset(DIE &Die, dwarf::Attribute Attribute,
301 uint64_t Integer) {
302 addUInt(Die, Attribute, DD->getDwarfSectionOffsetForm(), Integer);
303 }
304
getOrCreateSourceID(const DIFile * File)305 unsigned DwarfTypeUnit::getOrCreateSourceID(const DIFile *File) {
306 if (!SplitLineTable)
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);
312 }
313 return SplitLineTable->getFile(
314 File->getDirectory(), File->getFilename(), DD->getMD5AsBytes(File),
315 Asm->OutContext.getDwarfVersion(), File->getSource());
316 }
317
addOpAddress(DIELoc & Die,const MCSymbol * Sym)318 void DwarfUnit::addOpAddress(DIELoc &Die, const MCSymbol *Sym) {
319 if (DD->getDwarfVersion() >= 5) {
320 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addrx);
321 addUInt(Die, dwarf::DW_FORM_addrx, DD->getAddressPool().getIndex(Sym));
322 return;
323 }
324
325 if (DD->useSplitDwarf()) {
326 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_addr_index);
327 addUInt(Die, dwarf::DW_FORM_GNU_addr_index,
328 DD->getAddressPool().getIndex(Sym));
329 return;
330 }
331
332 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
333 addLabel(Die, dwarf::DW_FORM_addr, Sym);
334 }
335
addLabelDelta(DIE & Die,dwarf::Attribute Attribute,const MCSymbol * Hi,const MCSymbol * Lo)336 void DwarfUnit::addLabelDelta(DIE &Die, dwarf::Attribute Attribute,
337 const MCSymbol *Hi, const MCSymbol *Lo) {
338 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_data4,
339 new (DIEValueAllocator) DIEDelta(Hi, Lo));
340 }
341
addDIEEntry(DIE & Die,dwarf::Attribute Attribute,DIE & Entry)342 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry) {
343 addDIEEntry(Die, Attribute, DIEEntry(Entry));
344 }
345
addDIETypeSignature(DIE & Die,uint64_t Signature)346 void DwarfUnit::addDIETypeSignature(DIE &Die, uint64_t Signature) {
347 // Flag the type unit reference as a declaration so that if it contains
348 // members (implicit special members, static data member definitions, member
349 // declarations for definitions in this CU, etc) consumers don't get confused
350 // and think this is a full definition.
351 addFlag(Die, dwarf::DW_AT_declaration);
352
353 Die.addValue(DIEValueAllocator, dwarf::DW_AT_signature,
354 dwarf::DW_FORM_ref_sig8, DIEInteger(Signature));
355 }
356
addDIEEntry(DIE & Die,dwarf::Attribute Attribute,DIEEntry Entry)357 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute,
358 DIEEntry Entry) {
359 const DIEUnit *CU = Die.getUnit();
360 const DIEUnit *EntryCU = Entry.getEntry().getUnit();
361 if (!CU)
362 // We assume that Die belongs to this CU, if it is not linked to any CU yet.
363 CU = getUnitDie().getUnit();
364 if (!EntryCU)
365 EntryCU = getUnitDie().getUnit();
366 Die.addValue(DIEValueAllocator, Attribute,
367 EntryCU == CU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr,
368 Entry);
369 }
370
createAndAddDIE(unsigned Tag,DIE & Parent,const DINode * N)371 DIE &DwarfUnit::createAndAddDIE(unsigned Tag, DIE &Parent, const DINode *N) {
372 DIE &Die = Parent.addChild(DIE::get(DIEValueAllocator, (dwarf::Tag)Tag));
373 if (N)
374 insertDIE(N, &Die);
375 return Die;
376 }
377
addBlock(DIE & Die,dwarf::Attribute Attribute,DIELoc * Loc)378 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Loc) {
379 Loc->ComputeSize(Asm);
380 DIELocs.push_back(Loc); // Memoize so we can call the destructor later on.
381 Die.addValue(DIEValueAllocator, Attribute,
382 Loc->BestForm(DD->getDwarfVersion()), Loc);
383 }
384
addBlock(DIE & Die,dwarf::Attribute Attribute,DIEBlock * Block)385 void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute,
386 DIEBlock *Block) {
387 Block->ComputeSize(Asm);
388 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
389 Die.addValue(DIEValueAllocator, Attribute, Block->BestForm(), Block);
390 }
391
addSourceLine(DIE & Die,unsigned Line,const DIFile * File)392 void DwarfUnit::addSourceLine(DIE &Die, unsigned Line, const DIFile *File) {
393 if (Line == 0)
394 return;
395
396 unsigned FileID = getOrCreateSourceID(File);
397 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
398 addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
399 }
400
addSourceLine(DIE & Die,const DILocalVariable * V)401 void DwarfUnit::addSourceLine(DIE &Die, const DILocalVariable *V) {
402 assert(V);
403
404 addSourceLine(Die, V->getLine(), V->getFile());
405 }
406
addSourceLine(DIE & Die,const DIGlobalVariable * G)407 void DwarfUnit::addSourceLine(DIE &Die, const DIGlobalVariable *G) {
408 assert(G);
409
410 addSourceLine(Die, G->getLine(), G->getFile());
411 }
412
addSourceLine(DIE & Die,const DISubprogram * SP)413 void DwarfUnit::addSourceLine(DIE &Die, const DISubprogram *SP) {
414 assert(SP);
415
416 addSourceLine(Die, SP->getLine(), SP->getFile());
417 }
418
addSourceLine(DIE & Die,const DILabel * L)419 void DwarfUnit::addSourceLine(DIE &Die, const DILabel *L) {
420 assert(L);
421
422 addSourceLine(Die, L->getLine(), L->getFile());
423 }
424
addSourceLine(DIE & Die,const DIType * Ty)425 void DwarfUnit::addSourceLine(DIE &Die, const DIType *Ty) {
426 assert(Ty);
427
428 addSourceLine(Die, Ty->getLine(), Ty->getFile());
429 }
430
addSourceLine(DIE & Die,const DIObjCProperty * Ty)431 void DwarfUnit::addSourceLine(DIE &Die, const DIObjCProperty *Ty) {
432 assert(Ty);
433
434 addSourceLine(Die, Ty->getLine(), Ty->getFile());
435 }
436
addConstantFPValue(DIE & Die,const ConstantFP * CFP)437 void DwarfUnit::addConstantFPValue(DIE &Die, const ConstantFP *CFP) {
438 // Pass this down to addConstantValue as an unsigned bag of bits.
439 addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), true);
440 }
441
addConstantValue(DIE & Die,const ConstantInt * CI,const DIType * Ty)442 void DwarfUnit::addConstantValue(DIE &Die, const ConstantInt *CI,
443 const DIType *Ty) {
444 addConstantValue(Die, CI->getValue(), Ty);
445 }
446
addConstantValue(DIE & Die,uint64_t Val,const DIType * Ty)447 void DwarfUnit::addConstantValue(DIE &Die, uint64_t Val, const DIType *Ty) {
448 addConstantValue(Die, DD->isUnsignedDIType(Ty), Val);
449 }
450
addConstantValue(DIE & Die,bool Unsigned,uint64_t Val)451 void DwarfUnit::addConstantValue(DIE &Die, bool Unsigned, uint64_t Val) {
452 // FIXME: This is a bit conservative/simple - it emits negative values always
453 // sign extended to 64 bits rather than minimizing the number of bytes.
454 addUInt(Die, dwarf::DW_AT_const_value,
455 Unsigned ? dwarf::DW_FORM_udata : dwarf::DW_FORM_sdata, Val);
456 }
457
addConstantValue(DIE & Die,const APInt & Val,const DIType * Ty)458 void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, const DIType *Ty) {
459 addConstantValue(Die, Val, DD->isUnsignedDIType(Ty));
460 }
461
addConstantValue(DIE & Die,const APInt & Val,bool Unsigned)462 void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, bool Unsigned) {
463 unsigned CIBitWidth = Val.getBitWidth();
464 if (CIBitWidth <= 64) {
465 addConstantValue(Die, Unsigned,
466 Unsigned ? Val.getZExtValue() : Val.getSExtValue());
467 return;
468 }
469
470 DIEBlock *Block = new (DIEValueAllocator) DIEBlock;
471
472 // Get the raw data form of the large APInt.
473 const uint64_t *Ptr64 = Val.getRawData();
474
475 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
476 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
477
478 // Output the constant to DWARF one byte at a time.
479 for (int i = 0; i < NumBytes; i++) {
480 uint8_t c;
481 if (LittleEndian)
482 c = Ptr64[i / 8] >> (8 * (i & 7));
483 else
484 c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7));
485 addUInt(*Block, dwarf::DW_FORM_data1, c);
486 }
487
488 addBlock(Die, dwarf::DW_AT_const_value, Block);
489 }
490
addLinkageName(DIE & Die,StringRef LinkageName)491 void DwarfUnit::addLinkageName(DIE &Die, StringRef LinkageName) {
492 if (!LinkageName.empty())
493 addString(Die,
494 DD->getDwarfVersion() >= 4 ? dwarf::DW_AT_linkage_name
495 : dwarf::DW_AT_MIPS_linkage_name,
496 GlobalValue::dropLLVMManglingEscape(LinkageName));
497 }
498
addTemplateParams(DIE & Buffer,DINodeArray TParams)499 void DwarfUnit::addTemplateParams(DIE &Buffer, DINodeArray TParams) {
500 // Add template parameters.
501 for (const auto *Element : TParams) {
502 if (auto *TTP = dyn_cast<DITemplateTypeParameter>(Element))
503 constructTemplateTypeParameterDIE(Buffer, TTP);
504 else if (auto *TVP = dyn_cast<DITemplateValueParameter>(Element))
505 constructTemplateValueParameterDIE(Buffer, TVP);
506 }
507 }
508
509 /// Add thrown types.
addThrownTypes(DIE & Die,DINodeArray ThrownTypes)510 void DwarfUnit::addThrownTypes(DIE &Die, DINodeArray ThrownTypes) {
511 for (const auto *Ty : ThrownTypes) {
512 DIE &TT = createAndAddDIE(dwarf::DW_TAG_thrown_type, Die);
513 addType(TT, cast<DIType>(Ty));
514 }
515 }
516
getOrCreateContextDIE(const DIScope * Context)517 DIE *DwarfUnit::getOrCreateContextDIE(const DIScope *Context) {
518 if (!Context || isa<DIFile>(Context))
519 return &getUnitDie();
520 if (auto *T = dyn_cast<DIType>(Context))
521 return getOrCreateTypeDIE(T);
522 if (auto *NS = dyn_cast<DINamespace>(Context))
523 return getOrCreateNameSpace(NS);
524 if (auto *SP = dyn_cast<DISubprogram>(Context))
525 return getOrCreateSubprogramDIE(SP);
526 if (auto *M = dyn_cast<DIModule>(Context))
527 return getOrCreateModule(M);
528 return getDIE(Context);
529 }
530
createTypeDIE(const DICompositeType * Ty)531 DIE *DwarfUnit::createTypeDIE(const DICompositeType *Ty) {
532 auto *Context = Ty->getScope();
533 DIE *ContextDIE = getOrCreateContextDIE(Context);
534
535 if (DIE *TyDIE = getDIE(Ty))
536 return TyDIE;
537
538 // Create new type.
539 DIE &TyDIE = createAndAddDIE(Ty->getTag(), *ContextDIE, Ty);
540
541 constructTypeDIE(TyDIE, cast<DICompositeType>(Ty));
542
543 updateAcceleratorTables(Context, Ty, TyDIE);
544 return &TyDIE;
545 }
546
createTypeDIE(const DIScope * Context,DIE & ContextDIE,const DIType * Ty)547 DIE *DwarfUnit::createTypeDIE(const DIScope *Context, DIE &ContextDIE,
548 const DIType *Ty) {
549 // Create new type.
550 DIE &TyDIE = createAndAddDIE(Ty->getTag(), ContextDIE, Ty);
551
552 updateAcceleratorTables(Context, Ty, TyDIE);
553
554 if (auto *BT = dyn_cast<DIBasicType>(Ty))
555 constructTypeDIE(TyDIE, BT);
556 else if (auto *ST = dyn_cast<DIStringType>(Ty))
557 constructTypeDIE(TyDIE, ST);
558 else if (auto *STy = dyn_cast<DISubroutineType>(Ty))
559 constructTypeDIE(TyDIE, STy);
560 else if (auto *CTy = dyn_cast<DICompositeType>(Ty)) {
561 if (DD->generateTypeUnits() && !Ty->isForwardDecl() &&
562 (Ty->getRawName() || CTy->getRawIdentifier())) {
563 // Skip updating the accelerator tables since this is not the full type.
564 if (MDString *TypeId = CTy->getRawIdentifier())
565 DD->addDwarfTypeUnitType(getCU(), TypeId->getString(), TyDIE, CTy);
566 else {
567 auto X = DD->enterNonTypeUnitContext();
568 finishNonUnitTypeDIE(TyDIE, CTy);
569 }
570 return &TyDIE;
571 }
572 constructTypeDIE(TyDIE, CTy);
573 } else {
574 constructTypeDIE(TyDIE, cast<DIDerivedType>(Ty));
575 }
576
577 return &TyDIE;
578 }
579
getOrCreateTypeDIE(const MDNode * TyNode)580 DIE *DwarfUnit::getOrCreateTypeDIE(const MDNode *TyNode) {
581 if (!TyNode)
582 return nullptr;
583
584 auto *Ty = cast<DIType>(TyNode);
585
586 // DW_TAG_restrict_type is not supported in DWARF2
587 if (Ty->getTag() == dwarf::DW_TAG_restrict_type && DD->getDwarfVersion() <= 2)
588 return getOrCreateTypeDIE(cast<DIDerivedType>(Ty)->getBaseType());
589
590 // DW_TAG_atomic_type is not supported in DWARF < 5
591 if (Ty->getTag() == dwarf::DW_TAG_atomic_type && DD->getDwarfVersion() < 5)
592 return getOrCreateTypeDIE(cast<DIDerivedType>(Ty)->getBaseType());
593
594 // Construct the context before querying for the existence of the DIE in case
595 // such construction creates the DIE.
596 auto *Context = Ty->getScope();
597 DIE *ContextDIE = getOrCreateContextDIE(Context);
598 assert(ContextDIE);
599
600 if (DIE *TyDIE = getDIE(Ty))
601 return TyDIE;
602
603 return static_cast<DwarfUnit *>(ContextDIE->getUnit())
604 ->createTypeDIE(Context, *ContextDIE, Ty);
605 }
606
updateAcceleratorTables(const DIScope * Context,const DIType * Ty,const DIE & TyDIE)607 void DwarfUnit::updateAcceleratorTables(const DIScope *Context,
608 const DIType *Ty, const DIE &TyDIE) {
609 if (!Ty->getName().empty() && !Ty->isForwardDecl()) {
610 bool IsImplementation = false;
611 if (auto *CT = dyn_cast<DICompositeType>(Ty)) {
612 // A runtime language of 0 actually means C/C++ and that any
613 // non-negative value is some version of Objective-C/C++.
614 IsImplementation = CT->getRuntimeLang() == 0 || CT->isObjcClassComplete();
615 }
616 unsigned Flags = IsImplementation ? dwarf::DW_FLAG_type_implementation : 0;
617 DD->addAccelType(*CUNode, Ty->getName(), TyDIE, Flags);
618
619 if (!Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) ||
620 isa<DINamespace>(Context) || isa<DICommonBlock>(Context))
621 addGlobalType(Ty, TyDIE, Context);
622 }
623 }
624
addType(DIE & Entity,const DIType * Ty,dwarf::Attribute Attribute)625 void DwarfUnit::addType(DIE &Entity, const DIType *Ty,
626 dwarf::Attribute Attribute) {
627 assert(Ty && "Trying to add a type that doesn't exist?");
628 addDIEEntry(Entity, Attribute, DIEEntry(*getOrCreateTypeDIE(Ty)));
629 }
630
getParentContextString(const DIScope * Context) const631 std::string DwarfUnit::getParentContextString(const DIScope *Context) const {
632 if (!Context)
633 return "";
634
635 // FIXME: Decide whether to implement this for non-C++ languages.
636 if (!dwarf::isCPlusPlus((dwarf::SourceLanguage)getLanguage()))
637 return "";
638
639 std::string CS;
640 SmallVector<const DIScope *, 1> Parents;
641 while (!isa<DICompileUnit>(Context)) {
642 Parents.push_back(Context);
643 if (const DIScope *S = Context->getScope())
644 Context = S;
645 else
646 // Structure, etc types will have a NULL context if they're at the top
647 // level.
648 break;
649 }
650
651 // Reverse iterate over our list to go from the outermost construct to the
652 // innermost.
653 for (const DIScope *Ctx : make_range(Parents.rbegin(), Parents.rend())) {
654 StringRef Name = Ctx->getName();
655 if (Name.empty() && isa<DINamespace>(Ctx))
656 Name = "(anonymous namespace)";
657 if (!Name.empty()) {
658 CS += Name;
659 CS += "::";
660 }
661 }
662 return CS;
663 }
664
constructTypeDIE(DIE & Buffer,const DIBasicType * BTy)665 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIBasicType *BTy) {
666 // Get core information.
667 StringRef Name = BTy->getName();
668 // Add name if not anonymous or intermediate type.
669 if (!Name.empty())
670 addString(Buffer, dwarf::DW_AT_name, Name);
671
672 // An unspecified type only has a name attribute.
673 if (BTy->getTag() == dwarf::DW_TAG_unspecified_type)
674 return;
675
676 if (BTy->getTag() != dwarf::DW_TAG_string_type)
677 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
678 BTy->getEncoding());
679
680 uint64_t Size = BTy->getSizeInBits() >> 3;
681 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
682
683 if (BTy->isBigEndian())
684 addUInt(Buffer, dwarf::DW_AT_endianity, None, dwarf::DW_END_big);
685 else if (BTy->isLittleEndian())
686 addUInt(Buffer, dwarf::DW_AT_endianity, None, dwarf::DW_END_little);
687 }
688
constructTypeDIE(DIE & Buffer,const DIStringType * STy)689 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIStringType *STy) {
690 // Get core information.
691 StringRef Name = STy->getName();
692 // Add name if not anonymous or intermediate type.
693 if (!Name.empty())
694 addString(Buffer, dwarf::DW_AT_name, Name);
695
696 if (DIVariable *Var = STy->getStringLength()) {
697 if (auto *VarDIE = getDIE(Var))
698 addDIEEntry(Buffer, dwarf::DW_AT_string_length, *VarDIE);
699 } else if (DIExpression *Expr = STy->getStringLengthExp()) {
700 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
701 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
702 // This is to describe the memory location of the
703 // length of a Fortran deferred length string, so
704 // lock it down as such.
705 DwarfExpr.setMemoryLocationKind();
706 DwarfExpr.addExpression(Expr);
707 addBlock(Buffer, dwarf::DW_AT_string_length, DwarfExpr.finalize());
708 } else {
709 uint64_t Size = STy->getSizeInBits() >> 3;
710 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
711 }
712
713 if (STy->getEncoding()) {
714 // For eventual Unicode support.
715 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
716 STy->getEncoding());
717 }
718 }
719
constructTypeDIE(DIE & Buffer,const DIDerivedType * DTy)720 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIDerivedType *DTy) {
721 // Get core information.
722 StringRef Name = DTy->getName();
723 uint64_t Size = DTy->getSizeInBits() >> 3;
724 uint16_t Tag = Buffer.getTag();
725
726 // Map to main type, void will not have a type.
727 const DIType *FromTy = DTy->getBaseType();
728 if (FromTy)
729 addType(Buffer, FromTy);
730
731 // Add name if not anonymous or intermediate type.
732 if (!Name.empty())
733 addString(Buffer, dwarf::DW_AT_name, Name);
734
735 // If alignment is specified for a typedef , create and insert DW_AT_alignment
736 // attribute in DW_TAG_typedef DIE.
737 if (Tag == dwarf::DW_TAG_typedef && DD->getDwarfVersion() >= 5) {
738 uint32_t AlignInBytes = DTy->getAlignInBytes();
739 if (AlignInBytes > 0)
740 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
741 AlignInBytes);
742 }
743
744 // Add size if non-zero (derived types might be zero-sized.)
745 if (Size && Tag != dwarf::DW_TAG_pointer_type
746 && Tag != dwarf::DW_TAG_ptr_to_member_type
747 && Tag != dwarf::DW_TAG_reference_type
748 && Tag != dwarf::DW_TAG_rvalue_reference_type)
749 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
750
751 if (Tag == dwarf::DW_TAG_ptr_to_member_type)
752 addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
753 *getOrCreateTypeDIE(cast<DIDerivedType>(DTy)->getClassType()));
754 // Add source line info if available and TyDesc is not a forward declaration.
755 if (!DTy->isForwardDecl())
756 addSourceLine(Buffer, DTy);
757
758 // If DWARF address space value is other than None, add it. The IR
759 // verifier checks that DWARF address space only exists for pointer
760 // or reference types.
761 if (DTy->getDWARFAddressSpace())
762 addUInt(Buffer, dwarf::DW_AT_address_class, dwarf::DW_FORM_data4,
763 DTy->getDWARFAddressSpace().getValue());
764 }
765
constructSubprogramArguments(DIE & Buffer,DITypeRefArray Args)766 void DwarfUnit::constructSubprogramArguments(DIE &Buffer, DITypeRefArray Args) {
767 for (unsigned i = 1, N = Args.size(); i < N; ++i) {
768 const DIType *Ty = Args[i];
769 if (!Ty) {
770 assert(i == N-1 && "Unspecified parameter must be the last argument");
771 createAndAddDIE(dwarf::DW_TAG_unspecified_parameters, Buffer);
772 } else {
773 DIE &Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, Buffer);
774 addType(Arg, Ty);
775 if (Ty->isArtificial())
776 addFlag(Arg, dwarf::DW_AT_artificial);
777 }
778 }
779 }
780
constructTypeDIE(DIE & Buffer,const DISubroutineType * CTy)781 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DISubroutineType *CTy) {
782 // Add return type. A void return won't have a type.
783 auto Elements = cast<DISubroutineType>(CTy)->getTypeArray();
784 if (Elements.size())
785 if (auto RTy = Elements[0])
786 addType(Buffer, RTy);
787
788 bool isPrototyped = true;
789 if (Elements.size() == 2 && !Elements[1])
790 isPrototyped = false;
791
792 constructSubprogramArguments(Buffer, Elements);
793
794 // Add prototype flag if we're dealing with a C language and the function has
795 // been prototyped.
796 uint16_t Language = getLanguage();
797 if (isPrototyped &&
798 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
799 Language == dwarf::DW_LANG_ObjC))
800 addFlag(Buffer, dwarf::DW_AT_prototyped);
801
802 // Add a DW_AT_calling_convention if this has an explicit convention.
803 if (CTy->getCC() && CTy->getCC() != dwarf::DW_CC_normal)
804 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
805 CTy->getCC());
806
807 if (CTy->isLValueReference())
808 addFlag(Buffer, dwarf::DW_AT_reference);
809
810 if (CTy->isRValueReference())
811 addFlag(Buffer, dwarf::DW_AT_rvalue_reference);
812 }
813
constructTypeDIE(DIE & Buffer,const DICompositeType * CTy)814 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
815 // Add name if not anonymous or intermediate type.
816 StringRef Name = CTy->getName();
817
818 uint64_t Size = CTy->getSizeInBits() >> 3;
819 uint16_t Tag = Buffer.getTag();
820
821 switch (Tag) {
822 case dwarf::DW_TAG_array_type:
823 constructArrayTypeDIE(Buffer, CTy);
824 break;
825 case dwarf::DW_TAG_enumeration_type:
826 constructEnumTypeDIE(Buffer, CTy);
827 break;
828 case dwarf::DW_TAG_variant_part:
829 case dwarf::DW_TAG_structure_type:
830 case dwarf::DW_TAG_union_type:
831 case dwarf::DW_TAG_class_type: {
832 // Emit the discriminator for a variant part.
833 DIDerivedType *Discriminator = nullptr;
834 if (Tag == dwarf::DW_TAG_variant_part) {
835 Discriminator = CTy->getDiscriminator();
836 if (Discriminator) {
837 // DWARF says:
838 // If the variant part has a discriminant, the discriminant is
839 // represented by a separate debugging information entry which is
840 // a child of the variant part entry.
841 DIE &DiscMember = constructMemberDIE(Buffer, Discriminator);
842 addDIEEntry(Buffer, dwarf::DW_AT_discr, DiscMember);
843 }
844 }
845
846 // Add template parameters to a class, structure or union types.
847 if (Tag == dwarf::DW_TAG_class_type ||
848 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
849 addTemplateParams(Buffer, CTy->getTemplateParams());
850
851 // Add elements to structure type.
852 DINodeArray Elements = CTy->getElements();
853 for (const auto *Element : Elements) {
854 if (!Element)
855 continue;
856 if (auto *SP = dyn_cast<DISubprogram>(Element))
857 getOrCreateSubprogramDIE(SP);
858 else if (auto *DDTy = dyn_cast<DIDerivedType>(Element)) {
859 if (DDTy->getTag() == dwarf::DW_TAG_friend) {
860 DIE &ElemDie = createAndAddDIE(dwarf::DW_TAG_friend, Buffer);
861 addType(ElemDie, DDTy->getBaseType(), dwarf::DW_AT_friend);
862 } else if (DDTy->isStaticMember()) {
863 getOrCreateStaticMemberDIE(DDTy);
864 } else if (Tag == dwarf::DW_TAG_variant_part) {
865 // When emitting a variant part, wrap each member in
866 // DW_TAG_variant.
867 DIE &Variant = createAndAddDIE(dwarf::DW_TAG_variant, Buffer);
868 if (const ConstantInt *CI =
869 dyn_cast_or_null<ConstantInt>(DDTy->getDiscriminantValue())) {
870 if (DD->isUnsignedDIType(Discriminator->getBaseType()))
871 addUInt(Variant, dwarf::DW_AT_discr_value, None, CI->getZExtValue());
872 else
873 addSInt(Variant, dwarf::DW_AT_discr_value, None, CI->getSExtValue());
874 }
875 constructMemberDIE(Variant, DDTy);
876 } else {
877 constructMemberDIE(Buffer, DDTy);
878 }
879 } else if (auto *Property = dyn_cast<DIObjCProperty>(Element)) {
880 DIE &ElemDie = createAndAddDIE(Property->getTag(), Buffer);
881 StringRef PropertyName = Property->getName();
882 addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
883 if (Property->getType())
884 addType(ElemDie, Property->getType());
885 addSourceLine(ElemDie, Property);
886 StringRef GetterName = Property->getGetterName();
887 if (!GetterName.empty())
888 addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
889 StringRef SetterName = Property->getSetterName();
890 if (!SetterName.empty())
891 addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
892 if (unsigned PropertyAttributes = Property->getAttributes())
893 addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, None,
894 PropertyAttributes);
895 } else if (auto *Composite = dyn_cast<DICompositeType>(Element)) {
896 if (Composite->getTag() == dwarf::DW_TAG_variant_part) {
897 DIE &VariantPart = createAndAddDIE(Composite->getTag(), Buffer);
898 constructTypeDIE(VariantPart, Composite);
899 }
900 }
901 }
902
903 if (CTy->isAppleBlockExtension())
904 addFlag(Buffer, dwarf::DW_AT_APPLE_block);
905
906 if (CTy->getExportSymbols())
907 addFlag(Buffer, dwarf::DW_AT_export_symbols);
908
909 // This is outside the DWARF spec, but GDB expects a DW_AT_containing_type
910 // inside C++ composite types to point to the base class with the vtable.
911 // Rust uses DW_AT_containing_type to link a vtable to the type
912 // for which it was created.
913 if (auto *ContainingType = CTy->getVTableHolder())
914 addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
915 *getOrCreateTypeDIE(ContainingType));
916
917 if (CTy->isObjcClassComplete())
918 addFlag(Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
919
920 // Add the type's non-standard calling convention.
921 uint8_t CC = 0;
922 if (CTy->isTypePassByValue())
923 CC = dwarf::DW_CC_pass_by_value;
924 else if (CTy->isTypePassByReference())
925 CC = dwarf::DW_CC_pass_by_reference;
926 if (CC)
927 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
928 CC);
929 break;
930 }
931 default:
932 break;
933 }
934
935 // Add name if not anonymous or intermediate type.
936 if (!Name.empty())
937 addString(Buffer, dwarf::DW_AT_name, Name);
938
939 if (Tag == dwarf::DW_TAG_enumeration_type ||
940 Tag == dwarf::DW_TAG_class_type || Tag == dwarf::DW_TAG_structure_type ||
941 Tag == dwarf::DW_TAG_union_type) {
942 // Add size if non-zero (derived types might be zero-sized.)
943 // Ignore the size if it's a non-enum forward decl.
944 // TODO: Do we care about size for enum forward declarations?
945 if (Size &&
946 (!CTy->isForwardDecl() || Tag == dwarf::DW_TAG_enumeration_type))
947 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
948 else if (!CTy->isForwardDecl())
949 // Add zero size if it is not a forward declaration.
950 addUInt(Buffer, dwarf::DW_AT_byte_size, None, 0);
951
952 // If we're a forward decl, say so.
953 if (CTy->isForwardDecl())
954 addFlag(Buffer, dwarf::DW_AT_declaration);
955
956 // Add source line info if available.
957 if (!CTy->isForwardDecl())
958 addSourceLine(Buffer, CTy);
959
960 // No harm in adding the runtime language to the declaration.
961 unsigned RLang = CTy->getRuntimeLang();
962 if (RLang)
963 addUInt(Buffer, dwarf::DW_AT_APPLE_runtime_class, dwarf::DW_FORM_data1,
964 RLang);
965
966 // Add align info if available.
967 if (uint32_t AlignInBytes = CTy->getAlignInBytes())
968 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
969 AlignInBytes);
970 }
971 }
972
constructTemplateTypeParameterDIE(DIE & Buffer,const DITemplateTypeParameter * TP)973 void DwarfUnit::constructTemplateTypeParameterDIE(
974 DIE &Buffer, const DITemplateTypeParameter *TP) {
975 DIE &ParamDIE =
976 createAndAddDIE(dwarf::DW_TAG_template_type_parameter, Buffer);
977 // Add the type if it exists, it could be void and therefore no type.
978 if (TP->getType())
979 addType(ParamDIE, TP->getType());
980 if (!TP->getName().empty())
981 addString(ParamDIE, dwarf::DW_AT_name, TP->getName());
982 if (TP->isDefault() && (DD->getDwarfVersion() >= 5))
983 addFlag(ParamDIE, dwarf::DW_AT_default_value);
984 }
985
constructTemplateValueParameterDIE(DIE & Buffer,const DITemplateValueParameter * VP)986 void DwarfUnit::constructTemplateValueParameterDIE(
987 DIE &Buffer, const DITemplateValueParameter *VP) {
988 DIE &ParamDIE = createAndAddDIE(VP->getTag(), Buffer);
989
990 // Add the type if there is one, template template and template parameter
991 // packs will not have a type.
992 if (VP->getTag() == dwarf::DW_TAG_template_value_parameter)
993 addType(ParamDIE, VP->getType());
994 if (!VP->getName().empty())
995 addString(ParamDIE, dwarf::DW_AT_name, VP->getName());
996 if (VP->isDefault() && (DD->getDwarfVersion() >= 5))
997 addFlag(ParamDIE, dwarf::DW_AT_default_value);
998 if (Metadata *Val = VP->getValue()) {
999 if (ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(Val))
1000 addConstantValue(ParamDIE, CI, VP->getType());
1001 else if (GlobalValue *GV = mdconst::dyn_extract<GlobalValue>(Val)) {
1002 // We cannot describe the location of dllimport'd entities: the
1003 // computation of their address requires loads from the IAT.
1004 if (!GV->hasDLLImportStorageClass()) {
1005 // For declaration non-type template parameters (such as global values
1006 // and functions)
1007 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1008 addOpAddress(*Loc, Asm->getSymbol(GV));
1009 // Emit DW_OP_stack_value to use the address as the immediate value of
1010 // the parameter, rather than a pointer to it.
1011 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1012 addBlock(ParamDIE, dwarf::DW_AT_location, Loc);
1013 }
1014 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_template_param) {
1015 assert(isa<MDString>(Val));
1016 addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1017 cast<MDString>(Val)->getString());
1018 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
1019 addTemplateParams(ParamDIE, cast<MDTuple>(Val));
1020 }
1021 }
1022 }
1023
getOrCreateNameSpace(const DINamespace * NS)1024 DIE *DwarfUnit::getOrCreateNameSpace(const DINamespace *NS) {
1025 // Construct the context before querying for the existence of the DIE in case
1026 // such construction creates the DIE.
1027 DIE *ContextDIE = getOrCreateContextDIE(NS->getScope());
1028
1029 if (DIE *NDie = getDIE(NS))
1030 return NDie;
1031 DIE &NDie = createAndAddDIE(dwarf::DW_TAG_namespace, *ContextDIE, NS);
1032
1033 StringRef Name = NS->getName();
1034 if (!Name.empty())
1035 addString(NDie, dwarf::DW_AT_name, NS->getName());
1036 else
1037 Name = "(anonymous namespace)";
1038 DD->addAccelNamespace(*CUNode, Name, NDie);
1039 addGlobalName(Name, NDie, NS->getScope());
1040 if (NS->getExportSymbols())
1041 addFlag(NDie, dwarf::DW_AT_export_symbols);
1042 return &NDie;
1043 }
1044
getOrCreateModule(const DIModule * M)1045 DIE *DwarfUnit::getOrCreateModule(const DIModule *M) {
1046 // Construct the context before querying for the existence of the DIE in case
1047 // such construction creates the DIE.
1048 DIE *ContextDIE = getOrCreateContextDIE(M->getScope());
1049
1050 if (DIE *MDie = getDIE(M))
1051 return MDie;
1052 DIE &MDie = createAndAddDIE(dwarf::DW_TAG_module, *ContextDIE, M);
1053
1054 if (!M->getName().empty()) {
1055 addString(MDie, dwarf::DW_AT_name, M->getName());
1056 addGlobalName(M->getName(), MDie, M->getScope());
1057 }
1058 if (!M->getConfigurationMacros().empty())
1059 addString(MDie, dwarf::DW_AT_LLVM_config_macros,
1060 M->getConfigurationMacros());
1061 if (!M->getIncludePath().empty())
1062 addString(MDie, dwarf::DW_AT_LLVM_include_path, M->getIncludePath());
1063 if (!M->getAPINotesFile().empty())
1064 addString(MDie, dwarf::DW_AT_LLVM_apinotes, M->getAPINotesFile());
1065 if (M->getFile())
1066 addUInt(MDie, dwarf::DW_AT_decl_file, None,
1067 getOrCreateSourceID(M->getFile()));
1068 if (M->getLineNo())
1069 addUInt(MDie, dwarf::DW_AT_decl_line, None, M->getLineNo());
1070
1071 return &MDie;
1072 }
1073
getOrCreateSubprogramDIE(const DISubprogram * SP,bool Minimal)1074 DIE *DwarfUnit::getOrCreateSubprogramDIE(const DISubprogram *SP, bool Minimal) {
1075 // Construct the context before querying for the existence of the DIE in case
1076 // such construction creates the DIE (as is the case for member function
1077 // declarations).
1078 DIE *ContextDIE =
1079 Minimal ? &getUnitDie() : getOrCreateContextDIE(SP->getScope());
1080
1081 if (DIE *SPDie = getDIE(SP))
1082 return SPDie;
1083
1084 if (auto *SPDecl = SP->getDeclaration()) {
1085 if (!Minimal) {
1086 // Add subprogram definitions to the CU die directly.
1087 ContextDIE = &getUnitDie();
1088 // Build the decl now to ensure it precedes the definition.
1089 getOrCreateSubprogramDIE(SPDecl);
1090 }
1091 }
1092
1093 // DW_TAG_inlined_subroutine may refer to this DIE.
1094 DIE &SPDie = createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, SP);
1095
1096 // Stop here and fill this in later, depending on whether or not this
1097 // subprogram turns out to have inlined instances or not.
1098 if (SP->isDefinition())
1099 return &SPDie;
1100
1101 static_cast<DwarfUnit *>(SPDie.getUnit())
1102 ->applySubprogramAttributes(SP, SPDie);
1103 return &SPDie;
1104 }
1105
applySubprogramDefinitionAttributes(const DISubprogram * SP,DIE & SPDie)1106 bool DwarfUnit::applySubprogramDefinitionAttributes(const DISubprogram *SP,
1107 DIE &SPDie) {
1108 DIE *DeclDie = nullptr;
1109 StringRef DeclLinkageName;
1110 if (auto *SPDecl = SP->getDeclaration()) {
1111 DITypeRefArray DeclArgs, DefinitionArgs;
1112 DeclArgs = SPDecl->getType()->getTypeArray();
1113 DefinitionArgs = SP->getType()->getTypeArray();
1114
1115 if (DeclArgs.size() && DefinitionArgs.size())
1116 if (DefinitionArgs[0] != NULL && DeclArgs[0] != DefinitionArgs[0])
1117 addType(SPDie, DefinitionArgs[0]);
1118
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);
1130
1131 if (SP->getLine() != SPDecl->getLine())
1132 addUInt(SPDie, dwarf::DW_AT_decl_line, None, SP->getLine());
1133 }
1134
1135 // Add function template parameters.
1136 addTemplateParams(SPDie, SP->getTemplateParams());
1137
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);
1147
1148 if (!DeclDie)
1149 return false;
1150
1151 // Refer to the function declaration where all the other attributes will be
1152 // found.
1153 addDIEEntry(SPDie, dwarf::DW_AT_specification, *DeclDie);
1154 return true;
1155 }
1156
applySubprogramAttributes(const DISubprogram * SP,DIE & SPDie,bool SkipSPAttributes)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))
1165 return;
1166
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());
1170
1171 if (!SkipSPSourceLocation)
1172 addSourceLine(SPDie, SP);
1173
1174 // Skip the rest of the attributes under -gmlt to save space.
1175 if (SkipSPAttributes)
1176 return;
1177
1178 // Add the prototype if we have a prototype and we have a C like
1179 // language.
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);
1185
1186 if (SP->isObjCDirect())
1187 addFlag(SPDie, dwarf::DW_AT_APPLE_objc_direct);
1188
1189 unsigned CC = 0;
1190 DITypeRefArray Args;
1191 if (const DISubroutineType *SPTy = SP->getType()) {
1192 Args = SPTy->getTypeArray();
1193 CC = SPTy->getCC();
1194 }
1195
1196 // Add a DW_AT_calling_convention if this has an explicit convention.
1197 if (CC && CC != dwarf::DW_CC_normal)
1198 addUInt(SPDie, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, CC);
1199
1200 // Add a return type. If this is a type like a C/C++ void type we don't add a
1201 // return type.
1202 if (Args.size())
1203 if (auto Ty = Args[0])
1204 addType(SPDie, Ty);
1205
1206 unsigned VK = SP->getVirtuality();
1207 if (VK) {
1208 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
1209 if (SP->getVirtualIndex() != -1u) {
1210 DIELoc *Block = getDIELoc();
1211 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1212 addUInt(*Block, dwarf::DW_FORM_udata, SP->getVirtualIndex());
1213 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, Block);
1214 }
1215 ContainingTypeMap.insert(std::make_pair(&SPDie, SP->getContainingType()));
1216 }
1217
1218 if (!SP->isDefinition()) {
1219 addFlag(SPDie, dwarf::DW_AT_declaration);
1220
1221 // Add arguments. Do not add arguments for subprogram definition. They will
1222 // be handled while processing variables.
1223 constructSubprogramArguments(SPDie, Args);
1224 }
1225
1226 addThrownTypes(SPDie, SP->getThrownTypes());
1227
1228 if (SP->isArtificial())
1229 addFlag(SPDie, dwarf::DW_AT_artificial);
1230
1231 if (!SP->isLocalToUnit())
1232 addFlag(SPDie, dwarf::DW_AT_external);
1233
1234 if (DD->useAppleExtensionAttributes()) {
1235 if (SP->isOptimized())
1236 addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
1237
1238 if (unsigned isa = Asm->getISAEncoding())
1239 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1240 }
1241
1242 if (SP->isLValueReference())
1243 addFlag(SPDie, dwarf::DW_AT_reference);
1244
1245 if (SP->isRValueReference())
1246 addFlag(SPDie, dwarf::DW_AT_rvalue_reference);
1247
1248 if (SP->isNoReturn())
1249 addFlag(SPDie, dwarf::DW_AT_noreturn);
1250
1251 if (SP->isProtected())
1252 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1253 dwarf::DW_ACCESS_protected);
1254 else if (SP->isPrivate())
1255 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1256 dwarf::DW_ACCESS_private);
1257 else if (SP->isPublic())
1258 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1259 dwarf::DW_ACCESS_public);
1260
1261 if (SP->isExplicit())
1262 addFlag(SPDie, dwarf::DW_AT_explicit);
1263
1264 if (SP->isMainSubprogram())
1265 addFlag(SPDie, dwarf::DW_AT_main_subprogram);
1266 if (SP->isPure())
1267 addFlag(SPDie, dwarf::DW_AT_pure);
1268 if (SP->isElemental())
1269 addFlag(SPDie, dwarf::DW_AT_elemental);
1270 if (SP->isRecursive())
1271 addFlag(SPDie, dwarf::DW_AT_recursive);
1272
1273 if (DD->getDwarfVersion() >= 5 && SP->isDeleted())
1274 addFlag(SPDie, dwarf::DW_AT_deleted);
1275 }
1276
constructSubrangeDIE(DIE & Buffer,const DISubrange * SR,DIE * IndexTy)1277 void DwarfUnit::constructSubrangeDIE(DIE &Buffer, const DISubrange *SR,
1278 DIE *IndexTy) {
1279 DIE &DW_Subrange = createAndAddDIE(dwarf::DW_TAG_subrange_type, Buffer);
1280 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, *IndexTy);
1281
1282 // The LowerBound value defines the lower bounds which is typically zero for
1283 // C/C++. The Count value is the number of elements. Values are 64 bit. If
1284 // Count == -1 then the array is unbounded and we do not emit
1285 // DW_AT_lower_bound and DW_AT_count attributes.
1286 int64_t DefaultLowerBound = getDefaultLowerBound();
1287 int64_t Count = -1;
1288 if (auto *CI = SR->getCount().dyn_cast<ConstantInt*>())
1289 Count = CI->getSExtValue();
1290
1291 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr,
1292 DISubrange::BoundType Bound) -> void {
1293 if (auto *BV = Bound.dyn_cast<DIVariable *>()) {
1294 if (auto *VarDIE = getDIE(BV))
1295 addDIEEntry(DW_Subrange, Attr, *VarDIE);
1296 } else if (auto *BE = Bound.dyn_cast<DIExpression *>()) {
1297 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1298 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1299 DwarfExpr.setMemoryLocationKind();
1300 DwarfExpr.addExpression(BE);
1301 addBlock(DW_Subrange, Attr, DwarfExpr.finalize());
1302 } else if (auto *BI = Bound.dyn_cast<ConstantInt *>()) {
1303 if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 ||
1304 BI->getSExtValue() != DefaultLowerBound)
1305 addSInt(DW_Subrange, Attr, dwarf::DW_FORM_sdata, BI->getSExtValue());
1306 }
1307 };
1308
1309 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, SR->getLowerBound());
1310
1311 if (auto *CV = SR->getCount().dyn_cast<DIVariable*>()) {
1312 if (auto *CountVarDIE = getDIE(CV))
1313 addDIEEntry(DW_Subrange, dwarf::DW_AT_count, *CountVarDIE);
1314 } else if (Count != -1)
1315 addUInt(DW_Subrange, dwarf::DW_AT_count, None, Count);
1316
1317 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, SR->getUpperBound());
1318
1319 AddBoundTypeEntry(dwarf::DW_AT_byte_stride, SR->getStride());
1320 }
1321
constructGenericSubrangeDIE(DIE & Buffer,const DIGenericSubrange * GSR,DIE * IndexTy)1322 void DwarfUnit::constructGenericSubrangeDIE(DIE &Buffer,
1323 const DIGenericSubrange *GSR,
1324 DIE *IndexTy) {
1325 DIE &DwGenericSubrange =
1326 createAndAddDIE(dwarf::DW_TAG_generic_subrange, Buffer);
1327 addDIEEntry(DwGenericSubrange, dwarf::DW_AT_type, *IndexTy);
1328
1329 int64_t DefaultLowerBound = getDefaultLowerBound();
1330
1331 auto AddBoundTypeEntry = [&](dwarf::Attribute Attr,
1332 DIGenericSubrange::BoundType Bound) -> void {
1333 if (auto *BV = Bound.dyn_cast<DIVariable *>()) {
1334 if (auto *VarDIE = getDIE(BV))
1335 addDIEEntry(DwGenericSubrange, Attr, *VarDIE);
1336 } else if (auto *BE = Bound.dyn_cast<DIExpression *>()) {
1337 if (BE->isSignedConstant()) {
1338 if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 ||
1339 static_cast<int64_t>(BE->getElement(1)) != DefaultLowerBound)
1340 addSInt(DwGenericSubrange, Attr, dwarf::DW_FORM_sdata,
1341 BE->getElement(1));
1342 } else {
1343 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1344 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1345 DwarfExpr.setMemoryLocationKind();
1346 DwarfExpr.addExpression(BE);
1347 addBlock(DwGenericSubrange, Attr, DwarfExpr.finalize());
1348 }
1349 }
1350 };
1351
1352 AddBoundTypeEntry(dwarf::DW_AT_lower_bound, GSR->getLowerBound());
1353 AddBoundTypeEntry(dwarf::DW_AT_count, GSR->getCount());
1354 AddBoundTypeEntry(dwarf::DW_AT_upper_bound, GSR->getUpperBound());
1355 AddBoundTypeEntry(dwarf::DW_AT_byte_stride, GSR->getStride());
1356 }
1357
getIndexTyDie()1358 DIE *DwarfUnit::getIndexTyDie() {
1359 if (IndexTyDie)
1360 return IndexTyDie;
1361 // Construct an integer type to use for indexes.
1362 IndexTyDie = &createAndAddDIE(dwarf::DW_TAG_base_type, getUnitDie());
1363 StringRef Name = "__ARRAY_SIZE_TYPE__";
1364 addString(*IndexTyDie, dwarf::DW_AT_name, Name);
1365 addUInt(*IndexTyDie, dwarf::DW_AT_byte_size, None, sizeof(int64_t));
1366 addUInt(*IndexTyDie, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1367 dwarf::DW_ATE_unsigned);
1368 DD->addAccelType(*CUNode, Name, *IndexTyDie, /*Flags*/ 0);
1369 return IndexTyDie;
1370 }
1371
1372 /// Returns true if the vector's size differs from the sum of sizes of elements
1373 /// the user specified. This can occur if the vector has been rounded up to
1374 /// fit memory alignment constraints.
hasVectorBeenPadded(const DICompositeType * CTy)1375 static bool hasVectorBeenPadded(const DICompositeType *CTy) {
1376 assert(CTy && CTy->isVector() && "Composite type is not a vector");
1377 const uint64_t ActualSize = CTy->getSizeInBits();
1378
1379 // Obtain the size of each element in the vector.
1380 DIType *BaseTy = CTy->getBaseType();
1381 assert(BaseTy && "Unknown vector element type.");
1382 const uint64_t ElementSize = BaseTy->getSizeInBits();
1383
1384 // Locate the number of elements in the vector.
1385 const DINodeArray Elements = CTy->getElements();
1386 assert(Elements.size() == 1 &&
1387 Elements[0]->getTag() == dwarf::DW_TAG_subrange_type &&
1388 "Invalid vector element array, expected one element of type subrange");
1389 const auto Subrange = cast<DISubrange>(Elements[0]);
1390 const auto NumVecElements =
1391 Subrange->getCount()
1392 ? Subrange->getCount().get<ConstantInt *>()->getSExtValue()
1393 : 0;
1394
1395 // Ensure we found the element count and that the actual size is wide
1396 // enough to contain the requested size.
1397 assert(ActualSize >= (NumVecElements * ElementSize) && "Invalid vector size");
1398 return ActualSize != (NumVecElements * ElementSize);
1399 }
1400
constructArrayTypeDIE(DIE & Buffer,const DICompositeType * CTy)1401 void DwarfUnit::constructArrayTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
1402 if (CTy->isVector()) {
1403 addFlag(Buffer, dwarf::DW_AT_GNU_vector);
1404 if (hasVectorBeenPadded(CTy))
1405 addUInt(Buffer, dwarf::DW_AT_byte_size, None,
1406 CTy->getSizeInBits() / CHAR_BIT);
1407 }
1408
1409 if (DIVariable *Var = CTy->getDataLocation()) {
1410 if (auto *VarDIE = getDIE(Var))
1411 addDIEEntry(Buffer, dwarf::DW_AT_data_location, *VarDIE);
1412 } else if (DIExpression *Expr = CTy->getDataLocationExp()) {
1413 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1414 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1415 DwarfExpr.setMemoryLocationKind();
1416 DwarfExpr.addExpression(Expr);
1417 addBlock(Buffer, dwarf::DW_AT_data_location, DwarfExpr.finalize());
1418 }
1419
1420 if (DIVariable *Var = CTy->getAssociated()) {
1421 if (auto *VarDIE = getDIE(Var))
1422 addDIEEntry(Buffer, dwarf::DW_AT_associated, *VarDIE);
1423 } else if (DIExpression *Expr = CTy->getAssociatedExp()) {
1424 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1425 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1426 DwarfExpr.setMemoryLocationKind();
1427 DwarfExpr.addExpression(Expr);
1428 addBlock(Buffer, dwarf::DW_AT_associated, DwarfExpr.finalize());
1429 }
1430
1431 if (DIVariable *Var = CTy->getAllocated()) {
1432 if (auto *VarDIE = getDIE(Var))
1433 addDIEEntry(Buffer, dwarf::DW_AT_allocated, *VarDIE);
1434 } else if (DIExpression *Expr = CTy->getAllocatedExp()) {
1435 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1436 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1437 DwarfExpr.setMemoryLocationKind();
1438 DwarfExpr.addExpression(Expr);
1439 addBlock(Buffer, dwarf::DW_AT_allocated, DwarfExpr.finalize());
1440 }
1441
1442 if (auto *RankConst = CTy->getRankConst()) {
1443 addSInt(Buffer, dwarf::DW_AT_rank, dwarf::DW_FORM_sdata,
1444 RankConst->getSExtValue());
1445 } else if (auto *RankExpr = CTy->getRankExp()) {
1446 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1447 DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1448 DwarfExpr.setMemoryLocationKind();
1449 DwarfExpr.addExpression(RankExpr);
1450 addBlock(Buffer, dwarf::DW_AT_rank, DwarfExpr.finalize());
1451 }
1452
1453 // Emit the element type.
1454 addType(Buffer, CTy->getBaseType());
1455
1456 // Get an anonymous type for index type.
1457 // FIXME: This type should be passed down from the front end
1458 // as different languages may have different sizes for indexes.
1459 DIE *IdxTy = getIndexTyDie();
1460
1461 // Add subranges to array type.
1462 DINodeArray Elements = CTy->getElements();
1463 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
1464 // FIXME: Should this really be such a loose cast?
1465 if (auto *Element = dyn_cast_or_null<DINode>(Elements[i])) {
1466 if (Element->getTag() == dwarf::DW_TAG_subrange_type)
1467 constructSubrangeDIE(Buffer, cast<DISubrange>(Element), IdxTy);
1468 else if (Element->getTag() == dwarf::DW_TAG_generic_subrange)
1469 constructGenericSubrangeDIE(Buffer, cast<DIGenericSubrange>(Element),
1470 IdxTy);
1471 }
1472 }
1473 }
1474
constructEnumTypeDIE(DIE & Buffer,const DICompositeType * CTy)1475 void DwarfUnit::constructEnumTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
1476 const DIType *DTy = CTy->getBaseType();
1477 bool IsUnsigned = DTy && DD->isUnsignedDIType(DTy);
1478 if (DTy) {
1479 if (DD->getDwarfVersion() >= 3)
1480 addType(Buffer, DTy);
1481 if (DD->getDwarfVersion() >= 4 && (CTy->getFlags() & DINode::FlagEnumClass))
1482 addFlag(Buffer, dwarf::DW_AT_enum_class);
1483 }
1484
1485 auto *Context = CTy->getScope();
1486 bool IndexEnumerators = !Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) ||
1487 isa<DINamespace>(Context) || isa<DICommonBlock>(Context);
1488 DINodeArray Elements = CTy->getElements();
1489
1490 // Add enumerators to enumeration type.
1491 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
1492 auto *Enum = dyn_cast_or_null<DIEnumerator>(Elements[i]);
1493 if (Enum) {
1494 DIE &Enumerator = createAndAddDIE(dwarf::DW_TAG_enumerator, Buffer);
1495 StringRef Name = Enum->getName();
1496 addString(Enumerator, dwarf::DW_AT_name, Name);
1497 addConstantValue(Enumerator, Enum->getValue(), IsUnsigned);
1498 if (IndexEnumerators)
1499 addGlobalName(Name, Enumerator, Context);
1500 }
1501 }
1502 }
1503
constructContainingTypeDIEs()1504 void DwarfUnit::constructContainingTypeDIEs() {
1505 for (auto CI = ContainingTypeMap.begin(), CE = ContainingTypeMap.end();
1506 CI != CE; ++CI) {
1507 DIE &SPDie = *CI->first;
1508 const DINode *D = CI->second;
1509 if (!D)
1510 continue;
1511 DIE *NDie = getDIE(D);
1512 if (!NDie)
1513 continue;
1514 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, *NDie);
1515 }
1516 }
1517
constructMemberDIE(DIE & Buffer,const DIDerivedType * DT)1518 DIE &DwarfUnit::constructMemberDIE(DIE &Buffer, const DIDerivedType *DT) {
1519 DIE &MemberDie = createAndAddDIE(DT->getTag(), Buffer);
1520 StringRef Name = DT->getName();
1521 if (!Name.empty())
1522 addString(MemberDie, dwarf::DW_AT_name, Name);
1523
1524 if (DIType *Resolved = DT->getBaseType())
1525 addType(MemberDie, Resolved);
1526
1527 addSourceLine(MemberDie, DT);
1528
1529 if (DT->getTag() == dwarf::DW_TAG_inheritance && DT->isVirtual()) {
1530
1531 // For C++, virtual base classes are not at fixed offset. Use following
1532 // expression to extract appropriate offset from vtable.
1533 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1534
1535 DIELoc *VBaseLocationDie = new (DIEValueAllocator) DIELoc;
1536 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1537 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1538 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1539 addUInt(*VBaseLocationDie, dwarf::DW_FORM_udata, DT->getOffsetInBits());
1540 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1541 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1542 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1543
1544 addBlock(MemberDie, dwarf::DW_AT_data_member_location, VBaseLocationDie);
1545 } else {
1546 uint64_t Size = DT->getSizeInBits();
1547 uint64_t FieldSize = DD->getBaseTypeSize(DT);
1548 uint32_t AlignInBytes = DT->getAlignInBytes();
1549 uint64_t OffsetInBytes;
1550
1551 bool IsBitfield = FieldSize && Size != FieldSize;
1552 if (IsBitfield) {
1553 // Handle bitfield, assume bytes are 8 bits.
1554 if (DD->useDWARF2Bitfields())
1555 addUInt(MemberDie, dwarf::DW_AT_byte_size, None, FieldSize/8);
1556 addUInt(MemberDie, dwarf::DW_AT_bit_size, None, Size);
1557
1558 uint64_t Offset = DT->getOffsetInBits();
1559 // We can't use DT->getAlignInBits() here: AlignInBits for member type
1560 // is non-zero if and only if alignment was forced (e.g. _Alignas()),
1561 // which can't be done with bitfields. Thus we use FieldSize here.
1562 uint32_t AlignInBits = FieldSize;
1563 uint32_t AlignMask = ~(AlignInBits - 1);
1564 // The bits from the start of the storage unit to the start of the field.
1565 uint64_t StartBitOffset = Offset - (Offset & AlignMask);
1566 // The byte offset of the field's aligned storage unit inside the struct.
1567 OffsetInBytes = (Offset - StartBitOffset) / 8;
1568
1569 if (DD->useDWARF2Bitfields()) {
1570 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1571 uint64_t FieldOffset = (HiMark - FieldSize);
1572 Offset -= FieldOffset;
1573
1574 // Maybe we need to work from the other end.
1575 if (Asm->getDataLayout().isLittleEndian())
1576 Offset = FieldSize - (Offset + Size);
1577
1578 addUInt(MemberDie, dwarf::DW_AT_bit_offset, None, Offset);
1579 OffsetInBytes = FieldOffset >> 3;
1580 } else {
1581 addUInt(MemberDie, dwarf::DW_AT_data_bit_offset, None, Offset);
1582 }
1583 } else {
1584 // This is not a bitfield.
1585 OffsetInBytes = DT->getOffsetInBits() / 8;
1586 if (AlignInBytes)
1587 addUInt(MemberDie, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1588 AlignInBytes);
1589 }
1590
1591 if (DD->getDwarfVersion() <= 2) {
1592 DIELoc *MemLocationDie = new (DIEValueAllocator) DIELoc;
1593 addUInt(*MemLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1594 addUInt(*MemLocationDie, dwarf::DW_FORM_udata, OffsetInBytes);
1595 addBlock(MemberDie, dwarf::DW_AT_data_member_location, MemLocationDie);
1596 } else if (!IsBitfield || DD->useDWARF2Bitfields())
1597 addUInt(MemberDie, dwarf::DW_AT_data_member_location, None,
1598 OffsetInBytes);
1599 }
1600
1601 if (DT->isProtected())
1602 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1603 dwarf::DW_ACCESS_protected);
1604 else if (DT->isPrivate())
1605 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1606 dwarf::DW_ACCESS_private);
1607 // Otherwise C++ member and base classes are considered public.
1608 else if (DT->isPublic())
1609 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1610 dwarf::DW_ACCESS_public);
1611 if (DT->isVirtual())
1612 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
1613 dwarf::DW_VIRTUALITY_virtual);
1614
1615 // Objective-C properties.
1616 if (DINode *PNode = DT->getObjCProperty())
1617 if (DIE *PDie = getDIE(PNode))
1618 MemberDie.addValue(DIEValueAllocator, dwarf::DW_AT_APPLE_property,
1619 dwarf::DW_FORM_ref4, DIEEntry(*PDie));
1620
1621 if (DT->isArtificial())
1622 addFlag(MemberDie, dwarf::DW_AT_artificial);
1623
1624 return MemberDie;
1625 }
1626
getOrCreateStaticMemberDIE(const DIDerivedType * DT)1627 DIE *DwarfUnit::getOrCreateStaticMemberDIE(const DIDerivedType *DT) {
1628 if (!DT)
1629 return nullptr;
1630
1631 // Construct the context before querying for the existence of the DIE in case
1632 // such construction creates the DIE.
1633 DIE *ContextDIE = getOrCreateContextDIE(DT->getScope());
1634 assert(dwarf::isType(ContextDIE->getTag()) &&
1635 "Static member should belong to a type.");
1636
1637 if (DIE *StaticMemberDIE = getDIE(DT))
1638 return StaticMemberDIE;
1639
1640 DIE &StaticMemberDIE = createAndAddDIE(DT->getTag(), *ContextDIE, DT);
1641
1642 const DIType *Ty = DT->getBaseType();
1643
1644 addString(StaticMemberDIE, dwarf::DW_AT_name, DT->getName());
1645 addType(StaticMemberDIE, Ty);
1646 addSourceLine(StaticMemberDIE, DT);
1647 addFlag(StaticMemberDIE, dwarf::DW_AT_external);
1648 addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
1649
1650 // FIXME: We could omit private if the parent is a class_type, and
1651 // public if the parent is something else.
1652 if (DT->isProtected())
1653 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1654 dwarf::DW_ACCESS_protected);
1655 else if (DT->isPrivate())
1656 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1657 dwarf::DW_ACCESS_private);
1658 else if (DT->isPublic())
1659 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1660 dwarf::DW_ACCESS_public);
1661
1662 if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT->getConstant()))
1663 addConstantValue(StaticMemberDIE, CI, Ty);
1664 if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT->getConstant()))
1665 addConstantFPValue(StaticMemberDIE, CFP);
1666
1667 if (uint32_t AlignInBytes = DT->getAlignInBytes())
1668 addUInt(StaticMemberDIE, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1669 AlignInBytes);
1670
1671 return &StaticMemberDIE;
1672 }
1673
emitCommonHeader(bool UseOffsets,dwarf::UnitType UT)1674 void DwarfUnit::emitCommonHeader(bool UseOffsets, dwarf::UnitType UT) {
1675 // Emit size of content not including length itself
1676 if (!DD->useSectionsAsReferences()) {
1677 StringRef Prefix = isDwoUnit() ? "debug_info_dwo_" : "debug_info_";
1678 MCSymbol *BeginLabel = Asm->createTempSymbol(Prefix + "start");
1679 EndLabel = Asm->createTempSymbol(Prefix + "end");
1680 Asm->emitDwarfUnitLength(EndLabel, BeginLabel, "Length of Unit");
1681 Asm->OutStreamer->emitLabel(BeginLabel);
1682 } else
1683 Asm->emitDwarfUnitLength(getHeaderSize() + getUnitDie().getSize(),
1684 "Length of Unit");
1685
1686 Asm->OutStreamer->AddComment("DWARF version number");
1687 unsigned Version = DD->getDwarfVersion();
1688 Asm->emitInt16(Version);
1689
1690 // DWARF v5 reorders the address size and adds a unit type.
1691 if (Version >= 5) {
1692 Asm->OutStreamer->AddComment("DWARF Unit Type");
1693 Asm->emitInt8(UT);
1694 Asm->OutStreamer->AddComment("Address Size (in bytes)");
1695 Asm->emitInt8(Asm->MAI->getCodePointerSize());
1696 }
1697
1698 // We share one abbreviations table across all units so it's always at the
1699 // start of the section. Use a relocatable offset where needed to ensure
1700 // linking doesn't invalidate that offset.
1701 Asm->OutStreamer->AddComment("Offset Into Abbrev. Section");
1702 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1703 if (UseOffsets)
1704 Asm->emitDwarfLengthOrOffset(0);
1705 else
1706 Asm->emitDwarfSymbolReference(
1707 TLOF.getDwarfAbbrevSection()->getBeginSymbol(), false);
1708
1709 if (Version <= 4) {
1710 Asm->OutStreamer->AddComment("Address Size (in bytes)");
1711 Asm->emitInt8(Asm->MAI->getCodePointerSize());
1712 }
1713 }
1714
emitHeader(bool UseOffsets)1715 void DwarfTypeUnit::emitHeader(bool UseOffsets) {
1716 DwarfUnit::emitCommonHeader(UseOffsets,
1717 DD->useSplitDwarf() ? dwarf::DW_UT_split_type
1718 : dwarf::DW_UT_type);
1719 Asm->OutStreamer->AddComment("Type Signature");
1720 Asm->OutStreamer->emitIntValue(TypeSignature, sizeof(TypeSignature));
1721 Asm->OutStreamer->AddComment("Type DIE Offset");
1722 // In a skeleton type unit there is no type DIE so emit a zero offset.
1723 Asm->emitDwarfLengthOrOffset(Ty ? Ty->getOffset() : 0);
1724 }
1725
1726 DIE::value_iterator
addSectionDelta(DIE & Die,dwarf::Attribute Attribute,const MCSymbol * Hi,const MCSymbol * Lo)1727 DwarfUnit::addSectionDelta(DIE &Die, dwarf::Attribute Attribute,
1728 const MCSymbol *Hi, const MCSymbol *Lo) {
1729 return Die.addValue(DIEValueAllocator, Attribute,
1730 DD->getDwarfSectionOffsetForm(),
1731 new (DIEValueAllocator) DIEDelta(Hi, Lo));
1732 }
1733
1734 DIE::value_iterator
addSectionLabel(DIE & Die,dwarf::Attribute Attribute,const MCSymbol * Label,const MCSymbol * Sec)1735 DwarfUnit::addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
1736 const MCSymbol *Label, const MCSymbol *Sec) {
1737 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1738 return addLabel(Die, Attribute, DD->getDwarfSectionOffsetForm(), Label);
1739 return addSectionDelta(Die, Attribute, Label, Sec);
1740 }
1741
isDwoUnit() const1742 bool DwarfTypeUnit::isDwoUnit() const {
1743 // Since there are no skeleton type units, all type units are dwo type units
1744 // when split DWARF is being used.
1745 return DD->useSplitDwarf();
1746 }
1747
addGlobalName(StringRef Name,const DIE & Die,const DIScope * Context)1748 void DwarfTypeUnit::addGlobalName(StringRef Name, const DIE &Die,
1749 const DIScope *Context) {
1750 getCU().addGlobalNameForTypeUnit(Name, Context);
1751 }
1752
addGlobalType(const DIType * Ty,const DIE & Die,const DIScope * Context)1753 void DwarfTypeUnit::addGlobalType(const DIType *Ty, const DIE &Die,
1754 const DIScope *Context) {
1755 getCU().addGlobalTypeUnitType(Ty, Context);
1756 }
1757
getCrossSectionRelativeBaseAddress() const1758 const MCSymbol *DwarfUnit::getCrossSectionRelativeBaseAddress() const {
1759 if (!Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1760 return nullptr;
1761 if (isDwoUnit())
1762 return nullptr;
1763 return getSection()->getBeginSymbol();
1764 }
1765
addStringOffsetsStart()1766 void DwarfUnit::addStringOffsetsStart() {
1767 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1768 addSectionLabel(getUnitDie(), dwarf::DW_AT_str_offsets_base,
1769 DU->getStringOffsetsStartSym(),
1770 TLOF.getDwarfStrOffSection()->getBeginSymbol());
1771 }
1772
addRnglistsBase()1773 void DwarfUnit::addRnglistsBase() {
1774 assert(DD->getDwarfVersion() >= 5 &&
1775 "DW_AT_rnglists_base requires DWARF version 5 or later");
1776 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1777 addSectionLabel(getUnitDie(), dwarf::DW_AT_rnglists_base,
1778 DU->getRnglistsTableBaseSym(),
1779 TLOF.getDwarfRnglistsSection()->getBeginSymbol());
1780 }
1781
finishNonUnitTypeDIE(DIE & D,const DICompositeType * CTy)1782 void DwarfTypeUnit::finishNonUnitTypeDIE(DIE& D, const DICompositeType *CTy) {
1783 addFlag(D, dwarf::DW_AT_declaration);
1784 StringRef Name = CTy->getName();
1785 if (!Name.empty())
1786 addString(D, dwarf::DW_AT_name, Name);
1787 getCU().createTypeDIE(CTy);
1788 }
1789