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