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 (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 
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 (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 
202 DIE *DwarfUnit::getDIE(const DINode *D) const {
203   if (isShareableAcrossCUs(D))
204     return DU->getDIE(D);
205   return MDNodeToDieMap.lookup(D);
206 }
207 
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 
216 void DwarfUnit::insertDIE(DIE *D) {
217   MDNodeToDieMap.insert(std::make_pair(nullptr, D));
218 }
219 
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 
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 
238 void DwarfUnit::addUInt(DIEValueList &Block, dwarf::Form Form,
239                         uint64_t Integer) {
240   addUInt(Block, (dwarf::Attribute)0, Form, Integer);
241 }
242 
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 
250 void DwarfUnit::addSInt(DIELoc &Die, Optional<dwarf::Form> Form,
251                         int64_t Integer) {
252   addSInt(Die, (dwarf::Attribute)0, Form, Integer);
253 }
254 
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 
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 
296 void DwarfUnit::addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label) {
297   addLabel(Die, (dwarf::Attribute)0, Form, Label);
298 }
299 
300 void DwarfUnit::addSectionOffset(DIE &Die, dwarf::Attribute Attribute,
301                                  uint64_t Integer) {
302   addUInt(Die, Attribute, DD->getDwarfSectionOffsetForm(), Integer);
303 }
304 
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 
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 
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 
342 void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry) {
343   addDIEEntry(Die, Attribute, DIEEntry(Entry));
344 }
345 
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 
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 
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 
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 
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 
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 
401 void DwarfUnit::addSourceLine(DIE &Die, const DILocalVariable *V) {
402   assert(V);
403 
404   addSourceLine(Die, V->getLine(), V->getFile());
405 }
406 
407 void DwarfUnit::addSourceLine(DIE &Die, const DIGlobalVariable *G) {
408   assert(G);
409 
410   addSourceLine(Die, G->getLine(), G->getFile());
411 }
412 
413 void DwarfUnit::addSourceLine(DIE &Die, const DISubprogram *SP) {
414   assert(SP);
415 
416   addSourceLine(Die, SP->getLine(), SP->getFile());
417 }
418 
419 void DwarfUnit::addSourceLine(DIE &Die, const DILabel *L) {
420   assert(L);
421 
422   addSourceLine(Die, L->getLine(), L->getFile());
423 }
424 
425 void DwarfUnit::addSourceLine(DIE &Die, const DIType *Ty) {
426   assert(Ty);
427 
428   addSourceLine(Die, Ty->getLine(), Ty->getFile());
429 }
430 
431 void DwarfUnit::addSourceLine(DIE &Die, const DIObjCProperty *Ty) {
432   assert(Ty);
433 
434   addSourceLine(Die, Ty->getLine(), Ty->getFile());
435 }
436 
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 
442 void DwarfUnit::addConstantValue(DIE &Die, const ConstantInt *CI,
443                                  const DIType *Ty) {
444   addConstantValue(Die, CI->getValue(), Ty);
445 }
446 
447 void DwarfUnit::addConstantValue(DIE &Die, uint64_t Val, const DIType *Ty) {
448   addConstantValue(Die, DD->isUnsignedDIType(Ty), Val);
449 }
450 
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 
458 void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, const DIType *Ty) {
459   addConstantValue(Die, Val, DD->isUnsignedDIType(Ty));
460 }
461 
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 
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 
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.
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 
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     // Subprogram definitions should be created in the Unit that they specify,
526     // which might not be "this" unit when type definitions move around under
527     // LTO.
528     assert(SP->isDefinition());
529     return &DD->constructSubprogramDefinitionDIE(SP);
530   }
531   if (auto *M = dyn_cast<DIModule>(Context))
532     return getOrCreateModule(M);
533   return getDIE(Context);
534 }
535 
536 DIE *DwarfUnit::createTypeDIE(const DICompositeType *Ty) {
537   auto *Context = Ty->getScope();
538   DIE *ContextDIE = getOrCreateContextDIE(Context);
539 
540   if (DIE *TyDIE = getDIE(Ty))
541     return TyDIE;
542 
543   // Create new type.
544   DIE &TyDIE = createAndAddDIE(Ty->getTag(), *ContextDIE, Ty);
545 
546   constructTypeDIE(TyDIE, cast<DICompositeType>(Ty));
547 
548   updateAcceleratorTables(Context, Ty, TyDIE);
549   return &TyDIE;
550 }
551 
552 DIE *DwarfUnit::createTypeDIE(const DIScope *Context, DIE &ContextDIE,
553                               const DIType *Ty) {
554   // Create new type.
555   DIE &TyDIE = createAndAddDIE(Ty->getTag(), ContextDIE, Ty);
556 
557   updateAcceleratorTables(Context, Ty, TyDIE);
558 
559   if (auto *BT = dyn_cast<DIBasicType>(Ty))
560     constructTypeDIE(TyDIE, BT);
561   else if (auto *ST = dyn_cast<DIStringType>(Ty))
562     constructTypeDIE(TyDIE, ST);
563   else if (auto *STy = dyn_cast<DISubroutineType>(Ty))
564     constructTypeDIE(TyDIE, STy);
565   else if (auto *CTy = dyn_cast<DICompositeType>(Ty)) {
566     if (DD->generateTypeUnits() && !Ty->isForwardDecl() &&
567         (Ty->getRawName() || CTy->getRawIdentifier())) {
568       // Skip updating the accelerator tables since this is not the full type.
569       if (MDString *TypeId = CTy->getRawIdentifier())
570         DD->addDwarfTypeUnitType(getCU(), TypeId->getString(), TyDIE, CTy);
571       else {
572         auto X = DD->enterNonTypeUnitContext();
573         finishNonUnitTypeDIE(TyDIE, CTy);
574       }
575       return &TyDIE;
576     }
577     constructTypeDIE(TyDIE, CTy);
578   } else {
579     constructTypeDIE(TyDIE, cast<DIDerivedType>(Ty));
580   }
581 
582   return &TyDIE;
583 }
584 
585 DIE *DwarfUnit::getOrCreateTypeDIE(const MDNode *TyNode) {
586   if (!TyNode)
587     return nullptr;
588 
589   auto *Ty = cast<DIType>(TyNode);
590 
591   // DW_TAG_restrict_type is not supported in DWARF2
592   if (Ty->getTag() == dwarf::DW_TAG_restrict_type && DD->getDwarfVersion() <= 2)
593     return getOrCreateTypeDIE(cast<DIDerivedType>(Ty)->getBaseType());
594 
595   // DW_TAG_atomic_type is not supported in DWARF < 5
596   if (Ty->getTag() == dwarf::DW_TAG_atomic_type && DD->getDwarfVersion() < 5)
597     return getOrCreateTypeDIE(cast<DIDerivedType>(Ty)->getBaseType());
598 
599   // Construct the context before querying for the existence of the DIE in case
600   // such construction creates the DIE.
601   auto *Context = Ty->getScope();
602   DIE *ContextDIE = getOrCreateContextDIE(Context);
603   assert(ContextDIE);
604 
605   if (DIE *TyDIE = getDIE(Ty))
606     return TyDIE;
607 
608   return static_cast<DwarfUnit *>(ContextDIE->getUnit())
609       ->createTypeDIE(Context, *ContextDIE, Ty);
610 }
611 
612 void DwarfUnit::updateAcceleratorTables(const DIScope *Context,
613                                         const DIType *Ty, const DIE &TyDIE) {
614   if (!Ty->getName().empty() && !Ty->isForwardDecl()) {
615     bool IsImplementation = false;
616     if (auto *CT = dyn_cast<DICompositeType>(Ty)) {
617       // A runtime language of 0 actually means C/C++ and that any
618       // non-negative value is some version of Objective-C/C++.
619       IsImplementation = CT->getRuntimeLang() == 0 || CT->isObjcClassComplete();
620     }
621     unsigned Flags = IsImplementation ? dwarf::DW_FLAG_type_implementation : 0;
622     DD->addAccelType(*CUNode, Ty->getName(), TyDIE, Flags);
623 
624     if (!Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) ||
625         isa<DINamespace>(Context) || isa<DICommonBlock>(Context))
626       addGlobalType(Ty, TyDIE, Context);
627   }
628 }
629 
630 void DwarfUnit::addType(DIE &Entity, const DIType *Ty,
631                         dwarf::Attribute Attribute) {
632   assert(Ty && "Trying to add a type that doesn't exist?");
633   addDIEEntry(Entity, Attribute, DIEEntry(*getOrCreateTypeDIE(Ty)));
634 }
635 
636 std::string DwarfUnit::getParentContextString(const DIScope *Context) const {
637   if (!Context)
638     return "";
639 
640   // FIXME: Decide whether to implement this for non-C++ languages.
641   if (!dwarf::isCPlusPlus((dwarf::SourceLanguage)getLanguage()))
642     return "";
643 
644   std::string CS;
645   SmallVector<const DIScope *, 1> Parents;
646   while (!isa<DICompileUnit>(Context)) {
647     Parents.push_back(Context);
648     if (const DIScope *S = Context->getScope())
649       Context = S;
650     else
651       // Structure, etc types will have a NULL context if they're at the top
652       // level.
653       break;
654   }
655 
656   // Reverse iterate over our list to go from the outermost construct to the
657   // innermost.
658   for (const DIScope *Ctx : make_range(Parents.rbegin(), Parents.rend())) {
659     StringRef Name = Ctx->getName();
660     if (Name.empty() && isa<DINamespace>(Ctx))
661       Name = "(anonymous namespace)";
662     if (!Name.empty()) {
663       CS += Name;
664       CS += "::";
665     }
666   }
667   return CS;
668 }
669 
670 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIBasicType *BTy) {
671   // Get core information.
672   StringRef Name = BTy->getName();
673   // Add name if not anonymous or intermediate type.
674   if (!Name.empty())
675     addString(Buffer, dwarf::DW_AT_name, Name);
676 
677   // An unspecified type only has a name attribute.
678   if (BTy->getTag() == dwarf::DW_TAG_unspecified_type)
679     return;
680 
681   if (BTy->getTag() != dwarf::DW_TAG_string_type)
682     addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
683             BTy->getEncoding());
684 
685   uint64_t Size = BTy->getSizeInBits() >> 3;
686   addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
687 
688   if (BTy->isBigEndian())
689     addUInt(Buffer, dwarf::DW_AT_endianity, None, dwarf::DW_END_big);
690   else if (BTy->isLittleEndian())
691     addUInt(Buffer, dwarf::DW_AT_endianity, None, dwarf::DW_END_little);
692 }
693 
694 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIStringType *STy) {
695   // Get core information.
696   StringRef Name = STy->getName();
697   // Add name if not anonymous or intermediate type.
698   if (!Name.empty())
699     addString(Buffer, dwarf::DW_AT_name, Name);
700 
701   if (DIVariable *Var = STy->getStringLength()) {
702     if (auto *VarDIE = getDIE(Var))
703       addDIEEntry(Buffer, dwarf::DW_AT_string_length, *VarDIE);
704   } else if (DIExpression *Expr = STy->getStringLengthExp()) {
705     DIELoc *Loc = new (DIEValueAllocator) DIELoc;
706     DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
707     // This is to describe the memory location of the
708     // length of a Fortran deferred length string, so
709     // lock it down as such.
710     DwarfExpr.setMemoryLocationKind();
711     DwarfExpr.addExpression(Expr);
712     addBlock(Buffer, dwarf::DW_AT_string_length, DwarfExpr.finalize());
713   } else {
714     uint64_t Size = STy->getSizeInBits() >> 3;
715     addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
716   }
717 
718   if (STy->getEncoding()) {
719     // For eventual Unicode support.
720     addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
721             STy->getEncoding());
722   }
723 }
724 
725 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIDerivedType *DTy) {
726   // Get core information.
727   StringRef Name = DTy->getName();
728   uint64_t Size = DTy->getSizeInBits() >> 3;
729   uint16_t Tag = Buffer.getTag();
730 
731   // Map to main type, void will not have a type.
732   const DIType *FromTy = DTy->getBaseType();
733   if (FromTy)
734     addType(Buffer, FromTy);
735 
736   // Add name if not anonymous or intermediate type.
737   if (!Name.empty())
738     addString(Buffer, dwarf::DW_AT_name, Name);
739 
740   // If alignment is specified for a typedef , create and insert DW_AT_alignment
741   // attribute in DW_TAG_typedef DIE.
742   if (Tag == dwarf::DW_TAG_typedef && DD->getDwarfVersion() >= 5) {
743     uint32_t AlignInBytes = DTy->getAlignInBytes();
744     if (AlignInBytes > 0)
745       addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
746               AlignInBytes);
747   }
748 
749   // Add size if non-zero (derived types might be zero-sized.)
750   if (Size && Tag != dwarf::DW_TAG_pointer_type
751            && Tag != dwarf::DW_TAG_ptr_to_member_type
752            && Tag != dwarf::DW_TAG_reference_type
753            && Tag != dwarf::DW_TAG_rvalue_reference_type)
754     addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
755 
756   if (Tag == dwarf::DW_TAG_ptr_to_member_type)
757     addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
758                 *getOrCreateTypeDIE(cast<DIDerivedType>(DTy)->getClassType()));
759   // Add source line info if available and TyDesc is not a forward declaration.
760   if (!DTy->isForwardDecl())
761     addSourceLine(Buffer, DTy);
762 
763   // If DWARF address space value is other than None, add it.  The IR
764   // verifier checks that DWARF address space only exists for pointer
765   // or reference types.
766   if (DTy->getDWARFAddressSpace())
767     addUInt(Buffer, dwarf::DW_AT_address_class, dwarf::DW_FORM_data4,
768             DTy->getDWARFAddressSpace().getValue());
769 }
770 
771 void DwarfUnit::constructSubprogramArguments(DIE &Buffer, DITypeRefArray Args) {
772   for (unsigned i = 1, N = Args.size(); i < N; ++i) {
773     const DIType *Ty = Args[i];
774     if (!Ty) {
775       assert(i == N-1 && "Unspecified parameter must be the last argument");
776       createAndAddDIE(dwarf::DW_TAG_unspecified_parameters, Buffer);
777     } else {
778       DIE &Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, Buffer);
779       addType(Arg, Ty);
780       if (Ty->isArtificial())
781         addFlag(Arg, dwarf::DW_AT_artificial);
782     }
783   }
784 }
785 
786 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DISubroutineType *CTy) {
787   // Add return type.  A void return won't have a type.
788   auto Elements = cast<DISubroutineType>(CTy)->getTypeArray();
789   if (Elements.size())
790     if (auto RTy = Elements[0])
791       addType(Buffer, RTy);
792 
793   bool isPrototyped = true;
794   if (Elements.size() == 2 && !Elements[1])
795     isPrototyped = false;
796 
797   constructSubprogramArguments(Buffer, Elements);
798 
799   // Add prototype flag if we're dealing with a C language and the function has
800   // been prototyped.
801   uint16_t Language = getLanguage();
802   if (isPrototyped &&
803       (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
804        Language == dwarf::DW_LANG_ObjC))
805     addFlag(Buffer, dwarf::DW_AT_prototyped);
806 
807   // Add a DW_AT_calling_convention if this has an explicit convention.
808   if (CTy->getCC() && CTy->getCC() != dwarf::DW_CC_normal)
809     addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
810             CTy->getCC());
811 
812   if (CTy->isLValueReference())
813     addFlag(Buffer, dwarf::DW_AT_reference);
814 
815   if (CTy->isRValueReference())
816     addFlag(Buffer, dwarf::DW_AT_rvalue_reference);
817 }
818 
819 void DwarfUnit::constructTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
820   // Add name if not anonymous or intermediate type.
821   StringRef Name = CTy->getName();
822 
823   uint64_t Size = CTy->getSizeInBits() >> 3;
824   uint16_t Tag = Buffer.getTag();
825 
826   switch (Tag) {
827   case dwarf::DW_TAG_array_type:
828     constructArrayTypeDIE(Buffer, CTy);
829     break;
830   case dwarf::DW_TAG_enumeration_type:
831     constructEnumTypeDIE(Buffer, CTy);
832     break;
833   case dwarf::DW_TAG_variant_part:
834   case dwarf::DW_TAG_structure_type:
835   case dwarf::DW_TAG_union_type:
836   case dwarf::DW_TAG_class_type: {
837     // Emit the discriminator for a variant part.
838     DIDerivedType *Discriminator = nullptr;
839     if (Tag == dwarf::DW_TAG_variant_part) {
840       Discriminator = CTy->getDiscriminator();
841       if (Discriminator) {
842         // DWARF says:
843         //    If the variant part has a discriminant, the discriminant is
844         //    represented by a separate debugging information entry which is
845         //    a child of the variant part entry.
846         DIE &DiscMember = constructMemberDIE(Buffer, Discriminator);
847         addDIEEntry(Buffer, dwarf::DW_AT_discr, DiscMember);
848       }
849     }
850 
851     // Add template parameters to a class, structure or union types.
852     if (Tag == dwarf::DW_TAG_class_type ||
853         Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
854       addTemplateParams(Buffer, CTy->getTemplateParams());
855 
856     // Add elements to structure type.
857     DINodeArray Elements = CTy->getElements();
858     for (const auto *Element : Elements) {
859       if (!Element)
860         continue;
861       if (auto *SP = dyn_cast<DISubprogram>(Element))
862         getOrCreateSubprogramDIE(SP);
863       else if (auto *DDTy = dyn_cast<DIDerivedType>(Element)) {
864         if (DDTy->getTag() == dwarf::DW_TAG_friend) {
865           DIE &ElemDie = createAndAddDIE(dwarf::DW_TAG_friend, Buffer);
866           addType(ElemDie, DDTy->getBaseType(), dwarf::DW_AT_friend);
867         } else if (DDTy->isStaticMember()) {
868           getOrCreateStaticMemberDIE(DDTy);
869         } else if (Tag == dwarf::DW_TAG_variant_part) {
870           // When emitting a variant part, wrap each member in
871           // DW_TAG_variant.
872           DIE &Variant = createAndAddDIE(dwarf::DW_TAG_variant, Buffer);
873           if (const ConstantInt *CI =
874               dyn_cast_or_null<ConstantInt>(DDTy->getDiscriminantValue())) {
875             if (DD->isUnsignedDIType(Discriminator->getBaseType()))
876               addUInt(Variant, dwarf::DW_AT_discr_value, None, CI->getZExtValue());
877             else
878               addSInt(Variant, dwarf::DW_AT_discr_value, None, CI->getSExtValue());
879           }
880           constructMemberDIE(Variant, DDTy);
881         } else {
882           constructMemberDIE(Buffer, DDTy);
883         }
884       } else if (auto *Property = dyn_cast<DIObjCProperty>(Element)) {
885         DIE &ElemDie = createAndAddDIE(Property->getTag(), Buffer);
886         StringRef PropertyName = Property->getName();
887         addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
888         if (Property->getType())
889           addType(ElemDie, Property->getType());
890         addSourceLine(ElemDie, Property);
891         StringRef GetterName = Property->getGetterName();
892         if (!GetterName.empty())
893           addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
894         StringRef SetterName = Property->getSetterName();
895         if (!SetterName.empty())
896           addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
897         if (unsigned PropertyAttributes = Property->getAttributes())
898           addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, None,
899                   PropertyAttributes);
900       } else if (auto *Composite = dyn_cast<DICompositeType>(Element)) {
901         if (Composite->getTag() == dwarf::DW_TAG_variant_part) {
902           DIE &VariantPart = createAndAddDIE(Composite->getTag(), Buffer);
903           constructTypeDIE(VariantPart, Composite);
904         }
905       }
906     }
907 
908     if (CTy->isAppleBlockExtension())
909       addFlag(Buffer, dwarf::DW_AT_APPLE_block);
910 
911     if (CTy->getExportSymbols())
912       addFlag(Buffer, dwarf::DW_AT_export_symbols);
913 
914     // This is outside the DWARF spec, but GDB expects a DW_AT_containing_type
915     // inside C++ composite types to point to the base class with the vtable.
916     // Rust uses DW_AT_containing_type to link a vtable to the type
917     // for which it was created.
918     if (auto *ContainingType = CTy->getVTableHolder())
919       addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
920                   *getOrCreateTypeDIE(ContainingType));
921 
922     if (CTy->isObjcClassComplete())
923       addFlag(Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
924 
925     // Add the type's non-standard calling convention.
926     uint8_t CC = 0;
927     if (CTy->isTypePassByValue())
928       CC = dwarf::DW_CC_pass_by_value;
929     else if (CTy->isTypePassByReference())
930       CC = dwarf::DW_CC_pass_by_reference;
931     if (CC)
932       addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
933               CC);
934     break;
935   }
936   default:
937     break;
938   }
939 
940   // Add name if not anonymous or intermediate type.
941   if (!Name.empty())
942     addString(Buffer, dwarf::DW_AT_name, Name);
943 
944   if (Tag == dwarf::DW_TAG_enumeration_type ||
945       Tag == dwarf::DW_TAG_class_type || Tag == dwarf::DW_TAG_structure_type ||
946       Tag == dwarf::DW_TAG_union_type) {
947     // Add size if non-zero (derived types might be zero-sized.)
948     // Ignore the size if it's a non-enum forward decl.
949     // TODO: Do we care about size for enum forward declarations?
950     if (Size &&
951         (!CTy->isForwardDecl() || Tag == dwarf::DW_TAG_enumeration_type))
952       addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
953     else if (!CTy->isForwardDecl())
954       // Add zero size if it is not a forward declaration.
955       addUInt(Buffer, dwarf::DW_AT_byte_size, None, 0);
956 
957     // If we're a forward decl, say so.
958     if (CTy->isForwardDecl())
959       addFlag(Buffer, dwarf::DW_AT_declaration);
960 
961     // Add source line info if available.
962     if (!CTy->isForwardDecl())
963       addSourceLine(Buffer, CTy);
964 
965     // No harm in adding the runtime language to the declaration.
966     unsigned RLang = CTy->getRuntimeLang();
967     if (RLang)
968       addUInt(Buffer, dwarf::DW_AT_APPLE_runtime_class, dwarf::DW_FORM_data1,
969               RLang);
970 
971     // Add align info if available.
972     if (uint32_t AlignInBytes = CTy->getAlignInBytes())
973       addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
974               AlignInBytes);
975   }
976 }
977 
978 void DwarfUnit::constructTemplateTypeParameterDIE(
979     DIE &Buffer, const DITemplateTypeParameter *TP) {
980   DIE &ParamDIE =
981       createAndAddDIE(dwarf::DW_TAG_template_type_parameter, Buffer);
982   // Add the type if it exists, it could be void and therefore no type.
983   if (TP->getType())
984     addType(ParamDIE, TP->getType());
985   if (!TP->getName().empty())
986     addString(ParamDIE, dwarf::DW_AT_name, TP->getName());
987   if (TP->isDefault() && (DD->getDwarfVersion() >= 5))
988     addFlag(ParamDIE, dwarf::DW_AT_default_value);
989 }
990 
991 void DwarfUnit::constructTemplateValueParameterDIE(
992     DIE &Buffer, const DITemplateValueParameter *VP) {
993   DIE &ParamDIE = createAndAddDIE(VP->getTag(), Buffer);
994 
995   // Add the type if there is one, template template and template parameter
996   // packs will not have a type.
997   if (VP->getTag() == dwarf::DW_TAG_template_value_parameter)
998     addType(ParamDIE, VP->getType());
999   if (!VP->getName().empty())
1000     addString(ParamDIE, dwarf::DW_AT_name, VP->getName());
1001   if (VP->isDefault() && (DD->getDwarfVersion() >= 5))
1002     addFlag(ParamDIE, dwarf::DW_AT_default_value);
1003   if (Metadata *Val = VP->getValue()) {
1004     if (ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(Val))
1005       addConstantValue(ParamDIE, CI, VP->getType());
1006     else if (GlobalValue *GV = mdconst::dyn_extract<GlobalValue>(Val)) {
1007       // We cannot describe the location of dllimport'd entities: the
1008       // computation of their address requires loads from the IAT.
1009       if (!GV->hasDLLImportStorageClass()) {
1010         // For declaration non-type template parameters (such as global values
1011         // and functions)
1012         DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1013         addOpAddress(*Loc, Asm->getSymbol(GV));
1014         // Emit DW_OP_stack_value to use the address as the immediate value of
1015         // the parameter, rather than a pointer to it.
1016         addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1017         addBlock(ParamDIE, dwarf::DW_AT_location, Loc);
1018       }
1019     } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_template_param) {
1020       assert(isa<MDString>(Val));
1021       addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1022                 cast<MDString>(Val)->getString());
1023     } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
1024       addTemplateParams(ParamDIE, cast<MDTuple>(Val));
1025     }
1026   }
1027 }
1028 
1029 DIE *DwarfUnit::getOrCreateNameSpace(const DINamespace *NS) {
1030   // Construct the context before querying for the existence of the DIE in case
1031   // such construction creates the DIE.
1032   DIE *ContextDIE = getOrCreateContextDIE(NS->getScope());
1033 
1034   if (DIE *NDie = getDIE(NS))
1035     return NDie;
1036   DIE &NDie = createAndAddDIE(dwarf::DW_TAG_namespace, *ContextDIE, NS);
1037 
1038   StringRef Name = NS->getName();
1039   if (!Name.empty())
1040     addString(NDie, dwarf::DW_AT_name, NS->getName());
1041   else
1042     Name = "(anonymous namespace)";
1043   DD->addAccelNamespace(*CUNode, Name, NDie);
1044   addGlobalName(Name, NDie, NS->getScope());
1045   if (NS->getExportSymbols())
1046     addFlag(NDie, dwarf::DW_AT_export_symbols);
1047   return &NDie;
1048 }
1049 
1050 DIE *DwarfUnit::getOrCreateModule(const DIModule *M) {
1051   // Construct the context before querying for the existence of the DIE in case
1052   // such construction creates the DIE.
1053   DIE *ContextDIE = getOrCreateContextDIE(M->getScope());
1054 
1055   if (DIE *MDie = getDIE(M))
1056     return MDie;
1057   DIE &MDie = createAndAddDIE(dwarf::DW_TAG_module, *ContextDIE, M);
1058 
1059   if (!M->getName().empty()) {
1060     addString(MDie, dwarf::DW_AT_name, M->getName());
1061     addGlobalName(M->getName(), MDie, M->getScope());
1062   }
1063   if (!M->getConfigurationMacros().empty())
1064     addString(MDie, dwarf::DW_AT_LLVM_config_macros,
1065               M->getConfigurationMacros());
1066   if (!M->getIncludePath().empty())
1067     addString(MDie, dwarf::DW_AT_LLVM_include_path, M->getIncludePath());
1068   if (!M->getAPINotesFile().empty())
1069     addString(MDie, dwarf::DW_AT_LLVM_apinotes, M->getAPINotesFile());
1070   if (M->getFile())
1071     addUInt(MDie, dwarf::DW_AT_decl_file, None,
1072             getOrCreateSourceID(M->getFile()));
1073   if (M->getLineNo())
1074     addUInt(MDie, dwarf::DW_AT_decl_line, None, M->getLineNo());
1075   if (M->getIsDecl())
1076     addFlag(MDie, dwarf::DW_AT_declaration);
1077 
1078   return &MDie;
1079 }
1080 
1081 DIE *DwarfUnit::getOrCreateSubprogramDIE(const DISubprogram *SP, bool Minimal) {
1082   // Construct the context before querying for the existence of the DIE in case
1083   // such construction creates the DIE (as is the case for member function
1084   // declarations).
1085   DIE *ContextDIE =
1086       Minimal ? &getUnitDie() : getOrCreateContextDIE(SP->getScope());
1087 
1088   if (DIE *SPDie = getDIE(SP))
1089     return SPDie;
1090 
1091   if (auto *SPDecl = SP->getDeclaration()) {
1092     if (!Minimal) {
1093       // Add subprogram definitions to the CU die directly.
1094       ContextDIE = &getUnitDie();
1095       // Build the decl now to ensure it precedes the definition.
1096       getOrCreateSubprogramDIE(SPDecl);
1097     }
1098   }
1099 
1100   // DW_TAG_inlined_subroutine may refer to this DIE.
1101   DIE &SPDie = createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, SP);
1102 
1103   // Stop here and fill this in later, depending on whether or not this
1104   // subprogram turns out to have inlined instances or not.
1105   if (SP->isDefinition())
1106     return &SPDie;
1107 
1108   static_cast<DwarfUnit *>(SPDie.getUnit())
1109       ->applySubprogramAttributes(SP, SPDie);
1110   return &SPDie;
1111 }
1112 
1113 bool DwarfUnit::applySubprogramDefinitionAttributes(const DISubprogram *SP,
1114                                                     DIE &SPDie) {
1115   DIE *DeclDie = nullptr;
1116   StringRef DeclLinkageName;
1117   if (auto *SPDecl = SP->getDeclaration()) {
1118     DITypeRefArray DeclArgs, DefinitionArgs;
1119     DeclArgs = SPDecl->getType()->getTypeArray();
1120     DefinitionArgs = SP->getType()->getTypeArray();
1121 
1122     if (DeclArgs.size() && DefinitionArgs.size())
1123       if (DefinitionArgs[0] != NULL && DeclArgs[0] != DefinitionArgs[0])
1124         addType(SPDie, DefinitionArgs[0]);
1125 
1126     DeclDie = getDIE(SPDecl);
1127     assert(DeclDie && "This DIE should've already been constructed when the "
1128                       "definition DIE was created in "
1129                       "getOrCreateSubprogramDIE");
1130     // Look at the Decl's linkage name only if we emitted it.
1131     if (DD->useAllLinkageNames())
1132       DeclLinkageName = SPDecl->getLinkageName();
1133     unsigned DeclID = getOrCreateSourceID(SPDecl->getFile());
1134     unsigned DefID = getOrCreateSourceID(SP->getFile());
1135     if (DeclID != DefID)
1136       addUInt(SPDie, dwarf::DW_AT_decl_file, None, DefID);
1137 
1138     if (SP->getLine() != SPDecl->getLine())
1139       addUInt(SPDie, dwarf::DW_AT_decl_line, None, SP->getLine());
1140   }
1141 
1142   // Add function template parameters.
1143   addTemplateParams(SPDie, SP->getTemplateParams());
1144 
1145   // Add the linkage name if we have one and it isn't in the Decl.
1146   StringRef LinkageName = SP->getLinkageName();
1147   assert(((LinkageName.empty() || DeclLinkageName.empty()) ||
1148           LinkageName == DeclLinkageName) &&
1149          "decl has a linkage name and it is different");
1150   if (DeclLinkageName.empty() &&
1151       // Always emit it for abstract subprograms.
1152       (DD->useAllLinkageNames() || DU->getAbstractSPDies().lookup(SP)))
1153     addLinkageName(SPDie, LinkageName);
1154 
1155   if (!DeclDie)
1156     return false;
1157 
1158   // Refer to the function declaration where all the other attributes will be
1159   // found.
1160   addDIEEntry(SPDie, dwarf::DW_AT_specification, *DeclDie);
1161   return true;
1162 }
1163 
1164 void DwarfUnit::applySubprogramAttributes(const DISubprogram *SP, DIE &SPDie,
1165                                           bool SkipSPAttributes) {
1166   // If -fdebug-info-for-profiling is enabled, need to emit the subprogram
1167   // and its source location.
1168   bool SkipSPSourceLocation = SkipSPAttributes &&
1169                               !CUNode->getDebugInfoForProfiling();
1170   if (!SkipSPSourceLocation)
1171     if (applySubprogramDefinitionAttributes(SP, SPDie))
1172       return;
1173 
1174   // Constructors and operators for anonymous aggregates do not have names.
1175   if (!SP->getName().empty())
1176     addString(SPDie, dwarf::DW_AT_name, SP->getName());
1177 
1178   if (!SkipSPSourceLocation)
1179     addSourceLine(SPDie, SP);
1180 
1181   // Skip the rest of the attributes under -gmlt to save space.
1182   if (SkipSPAttributes)
1183     return;
1184 
1185   // Add the prototype if we have a prototype and we have a C like
1186   // language.
1187   uint16_t Language = getLanguage();
1188   if (SP->isPrototyped() &&
1189       (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
1190        Language == dwarf::DW_LANG_ObjC))
1191     addFlag(SPDie, dwarf::DW_AT_prototyped);
1192 
1193   if (SP->isObjCDirect())
1194     addFlag(SPDie, dwarf::DW_AT_APPLE_objc_direct);
1195 
1196   unsigned CC = 0;
1197   DITypeRefArray Args;
1198   if (const DISubroutineType *SPTy = SP->getType()) {
1199     Args = SPTy->getTypeArray();
1200     CC = SPTy->getCC();
1201   }
1202 
1203   // Add a DW_AT_calling_convention if this has an explicit convention.
1204   if (CC && CC != dwarf::DW_CC_normal)
1205     addUInt(SPDie, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, CC);
1206 
1207   // Add a return type. If this is a type like a C/C++ void type we don't add a
1208   // return type.
1209   if (Args.size())
1210     if (auto Ty = Args[0])
1211       addType(SPDie, Ty);
1212 
1213   unsigned VK = SP->getVirtuality();
1214   if (VK) {
1215     addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
1216     if (SP->getVirtualIndex() != -1u) {
1217       DIELoc *Block = getDIELoc();
1218       addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1219       addUInt(*Block, dwarf::DW_FORM_udata, SP->getVirtualIndex());
1220       addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, Block);
1221     }
1222     ContainingTypeMap.insert(std::make_pair(&SPDie, SP->getContainingType()));
1223   }
1224 
1225   if (!SP->isDefinition()) {
1226     addFlag(SPDie, dwarf::DW_AT_declaration);
1227 
1228     // Add arguments. Do not add arguments for subprogram definition. They will
1229     // be handled while processing variables.
1230     constructSubprogramArguments(SPDie, Args);
1231   }
1232 
1233   addThrownTypes(SPDie, SP->getThrownTypes());
1234 
1235   if (SP->isArtificial())
1236     addFlag(SPDie, dwarf::DW_AT_artificial);
1237 
1238   if (!SP->isLocalToUnit())
1239     addFlag(SPDie, dwarf::DW_AT_external);
1240 
1241   if (DD->useAppleExtensionAttributes()) {
1242     if (SP->isOptimized())
1243       addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
1244 
1245     if (unsigned isa = Asm->getISAEncoding())
1246       addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1247   }
1248 
1249   if (SP->isLValueReference())
1250     addFlag(SPDie, dwarf::DW_AT_reference);
1251 
1252   if (SP->isRValueReference())
1253     addFlag(SPDie, dwarf::DW_AT_rvalue_reference);
1254 
1255   if (SP->isNoReturn())
1256     addFlag(SPDie, dwarf::DW_AT_noreturn);
1257 
1258   if (SP->isProtected())
1259     addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1260             dwarf::DW_ACCESS_protected);
1261   else if (SP->isPrivate())
1262     addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1263             dwarf::DW_ACCESS_private);
1264   else if (SP->isPublic())
1265     addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1266             dwarf::DW_ACCESS_public);
1267 
1268   if (SP->isExplicit())
1269     addFlag(SPDie, dwarf::DW_AT_explicit);
1270 
1271   if (SP->isMainSubprogram())
1272     addFlag(SPDie, dwarf::DW_AT_main_subprogram);
1273   if (SP->isPure())
1274     addFlag(SPDie, dwarf::DW_AT_pure);
1275   if (SP->isElemental())
1276     addFlag(SPDie, dwarf::DW_AT_elemental);
1277   if (SP->isRecursive())
1278     addFlag(SPDie, dwarf::DW_AT_recursive);
1279 
1280   if (DD->getDwarfVersion() >= 5 && SP->isDeleted())
1281     addFlag(SPDie, dwarf::DW_AT_deleted);
1282 }
1283 
1284 void DwarfUnit::constructSubrangeDIE(DIE &Buffer, const DISubrange *SR,
1285                                      DIE *IndexTy) {
1286   DIE &DW_Subrange = createAndAddDIE(dwarf::DW_TAG_subrange_type, Buffer);
1287   addDIEEntry(DW_Subrange, dwarf::DW_AT_type, *IndexTy);
1288 
1289   // The LowerBound value defines the lower bounds which is typically zero for
1290   // C/C++. The Count value is the number of elements.  Values are 64 bit. If
1291   // Count == -1 then the array is unbounded and we do not emit
1292   // DW_AT_lower_bound and DW_AT_count attributes.
1293   int64_t DefaultLowerBound = getDefaultLowerBound();
1294   int64_t Count = -1;
1295   if (auto *CI = SR->getCount().dyn_cast<ConstantInt*>())
1296     Count = CI->getSExtValue();
1297 
1298   auto AddBoundTypeEntry = [&](dwarf::Attribute Attr,
1299                                DISubrange::BoundType Bound) -> void {
1300     if (auto *BV = Bound.dyn_cast<DIVariable *>()) {
1301       if (auto *VarDIE = getDIE(BV))
1302         addDIEEntry(DW_Subrange, Attr, *VarDIE);
1303     } else if (auto *BE = Bound.dyn_cast<DIExpression *>()) {
1304       DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1305       DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1306       DwarfExpr.setMemoryLocationKind();
1307       DwarfExpr.addExpression(BE);
1308       addBlock(DW_Subrange, Attr, DwarfExpr.finalize());
1309     } else if (auto *BI = Bound.dyn_cast<ConstantInt *>()) {
1310       if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 ||
1311           BI->getSExtValue() != DefaultLowerBound)
1312         addSInt(DW_Subrange, Attr, dwarf::DW_FORM_sdata, BI->getSExtValue());
1313     }
1314   };
1315 
1316   AddBoundTypeEntry(dwarf::DW_AT_lower_bound, SR->getLowerBound());
1317 
1318   if (auto *CV = SR->getCount().dyn_cast<DIVariable*>()) {
1319     if (auto *CountVarDIE = getDIE(CV))
1320       addDIEEntry(DW_Subrange, dwarf::DW_AT_count, *CountVarDIE);
1321   } else if (Count != -1)
1322     addUInt(DW_Subrange, dwarf::DW_AT_count, None, Count);
1323 
1324   AddBoundTypeEntry(dwarf::DW_AT_upper_bound, SR->getUpperBound());
1325 
1326   AddBoundTypeEntry(dwarf::DW_AT_byte_stride, SR->getStride());
1327 }
1328 
1329 void DwarfUnit::constructGenericSubrangeDIE(DIE &Buffer,
1330                                             const DIGenericSubrange *GSR,
1331                                             DIE *IndexTy) {
1332   DIE &DwGenericSubrange =
1333       createAndAddDIE(dwarf::DW_TAG_generic_subrange, Buffer);
1334   addDIEEntry(DwGenericSubrange, dwarf::DW_AT_type, *IndexTy);
1335 
1336   int64_t DefaultLowerBound = getDefaultLowerBound();
1337 
1338   auto AddBoundTypeEntry = [&](dwarf::Attribute Attr,
1339                                DIGenericSubrange::BoundType Bound) -> void {
1340     if (auto *BV = Bound.dyn_cast<DIVariable *>()) {
1341       if (auto *VarDIE = getDIE(BV))
1342         addDIEEntry(DwGenericSubrange, Attr, *VarDIE);
1343     } else if (auto *BE = Bound.dyn_cast<DIExpression *>()) {
1344       if (BE->isSignedConstant()) {
1345         if (Attr != dwarf::DW_AT_lower_bound || DefaultLowerBound == -1 ||
1346             static_cast<int64_t>(BE->getElement(1)) != DefaultLowerBound)
1347           addSInt(DwGenericSubrange, Attr, dwarf::DW_FORM_sdata,
1348                   BE->getElement(1));
1349       } else {
1350         DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1351         DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1352         DwarfExpr.setMemoryLocationKind();
1353         DwarfExpr.addExpression(BE);
1354         addBlock(DwGenericSubrange, Attr, DwarfExpr.finalize());
1355       }
1356     }
1357   };
1358 
1359   AddBoundTypeEntry(dwarf::DW_AT_lower_bound, GSR->getLowerBound());
1360   AddBoundTypeEntry(dwarf::DW_AT_count, GSR->getCount());
1361   AddBoundTypeEntry(dwarf::DW_AT_upper_bound, GSR->getUpperBound());
1362   AddBoundTypeEntry(dwarf::DW_AT_byte_stride, GSR->getStride());
1363 }
1364 
1365 DIE *DwarfUnit::getIndexTyDie() {
1366   if (IndexTyDie)
1367     return IndexTyDie;
1368   // Construct an integer type to use for indexes.
1369   IndexTyDie = &createAndAddDIE(dwarf::DW_TAG_base_type, getUnitDie());
1370   StringRef Name = "__ARRAY_SIZE_TYPE__";
1371   addString(*IndexTyDie, dwarf::DW_AT_name, Name);
1372   addUInt(*IndexTyDie, dwarf::DW_AT_byte_size, None, sizeof(int64_t));
1373   addUInt(*IndexTyDie, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1374           dwarf::DW_ATE_unsigned);
1375   DD->addAccelType(*CUNode, Name, *IndexTyDie, /*Flags*/ 0);
1376   return IndexTyDie;
1377 }
1378 
1379 /// Returns true if the vector's size differs from the sum of sizes of elements
1380 /// the user specified.  This can occur if the vector has been rounded up to
1381 /// fit memory alignment constraints.
1382 static bool hasVectorBeenPadded(const DICompositeType *CTy) {
1383   assert(CTy && CTy->isVector() && "Composite type is not a vector");
1384   const uint64_t ActualSize = CTy->getSizeInBits();
1385 
1386   // Obtain the size of each element in the vector.
1387   DIType *BaseTy = CTy->getBaseType();
1388   assert(BaseTy && "Unknown vector element type.");
1389   const uint64_t ElementSize = BaseTy->getSizeInBits();
1390 
1391   // Locate the number of elements in the vector.
1392   const DINodeArray Elements = CTy->getElements();
1393   assert(Elements.size() == 1 &&
1394          Elements[0]->getTag() == dwarf::DW_TAG_subrange_type &&
1395          "Invalid vector element array, expected one element of type subrange");
1396   const auto Subrange = cast<DISubrange>(Elements[0]);
1397   const auto NumVecElements =
1398       Subrange->getCount()
1399           ? Subrange->getCount().get<ConstantInt *>()->getSExtValue()
1400           : 0;
1401 
1402   // Ensure we found the element count and that the actual size is wide
1403   // enough to contain the requested size.
1404   assert(ActualSize >= (NumVecElements * ElementSize) && "Invalid vector size");
1405   return ActualSize != (NumVecElements * ElementSize);
1406 }
1407 
1408 void DwarfUnit::constructArrayTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
1409   if (CTy->isVector()) {
1410     addFlag(Buffer, dwarf::DW_AT_GNU_vector);
1411     if (hasVectorBeenPadded(CTy))
1412       addUInt(Buffer, dwarf::DW_AT_byte_size, None,
1413               CTy->getSizeInBits() / CHAR_BIT);
1414   }
1415 
1416   if (DIVariable *Var = CTy->getDataLocation()) {
1417     if (auto *VarDIE = getDIE(Var))
1418       addDIEEntry(Buffer, dwarf::DW_AT_data_location, *VarDIE);
1419   } else if (DIExpression *Expr = CTy->getDataLocationExp()) {
1420     DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1421     DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1422     DwarfExpr.setMemoryLocationKind();
1423     DwarfExpr.addExpression(Expr);
1424     addBlock(Buffer, dwarf::DW_AT_data_location, DwarfExpr.finalize());
1425   }
1426 
1427   if (DIVariable *Var = CTy->getAssociated()) {
1428     if (auto *VarDIE = getDIE(Var))
1429       addDIEEntry(Buffer, dwarf::DW_AT_associated, *VarDIE);
1430   } else if (DIExpression *Expr = CTy->getAssociatedExp()) {
1431     DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1432     DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1433     DwarfExpr.setMemoryLocationKind();
1434     DwarfExpr.addExpression(Expr);
1435     addBlock(Buffer, dwarf::DW_AT_associated, DwarfExpr.finalize());
1436   }
1437 
1438   if (DIVariable *Var = CTy->getAllocated()) {
1439     if (auto *VarDIE = getDIE(Var))
1440       addDIEEntry(Buffer, dwarf::DW_AT_allocated, *VarDIE);
1441   } else if (DIExpression *Expr = CTy->getAllocatedExp()) {
1442     DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1443     DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1444     DwarfExpr.setMemoryLocationKind();
1445     DwarfExpr.addExpression(Expr);
1446     addBlock(Buffer, dwarf::DW_AT_allocated, DwarfExpr.finalize());
1447   }
1448 
1449   if (auto *RankConst = CTy->getRankConst()) {
1450     addSInt(Buffer, dwarf::DW_AT_rank, dwarf::DW_FORM_sdata,
1451             RankConst->getSExtValue());
1452   } else if (auto *RankExpr = CTy->getRankExp()) {
1453     DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1454     DIEDwarfExpression DwarfExpr(*Asm, getCU(), *Loc);
1455     DwarfExpr.setMemoryLocationKind();
1456     DwarfExpr.addExpression(RankExpr);
1457     addBlock(Buffer, dwarf::DW_AT_rank, DwarfExpr.finalize());
1458   }
1459 
1460   // Emit the element type.
1461   addType(Buffer, CTy->getBaseType());
1462 
1463   // Get an anonymous type for index type.
1464   // FIXME: This type should be passed down from the front end
1465   // as different languages may have different sizes for indexes.
1466   DIE *IdxTy = getIndexTyDie();
1467 
1468   // Add subranges to array type.
1469   DINodeArray Elements = CTy->getElements();
1470   for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
1471     // FIXME: Should this really be such a loose cast?
1472     if (auto *Element = dyn_cast_or_null<DINode>(Elements[i])) {
1473       if (Element->getTag() == dwarf::DW_TAG_subrange_type)
1474         constructSubrangeDIE(Buffer, cast<DISubrange>(Element), IdxTy);
1475       else if (Element->getTag() == dwarf::DW_TAG_generic_subrange)
1476         constructGenericSubrangeDIE(Buffer, cast<DIGenericSubrange>(Element),
1477                                     IdxTy);
1478     }
1479   }
1480 }
1481 
1482 void DwarfUnit::constructEnumTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
1483   const DIType *DTy = CTy->getBaseType();
1484   bool IsUnsigned = DTy && DD->isUnsignedDIType(DTy);
1485   if (DTy) {
1486     if (DD->getDwarfVersion() >= 3)
1487       addType(Buffer, DTy);
1488     if (DD->getDwarfVersion() >= 4 && (CTy->getFlags() & DINode::FlagEnumClass))
1489       addFlag(Buffer, dwarf::DW_AT_enum_class);
1490   }
1491 
1492   auto *Context = CTy->getScope();
1493   bool IndexEnumerators = !Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) ||
1494       isa<DINamespace>(Context) || isa<DICommonBlock>(Context);
1495   DINodeArray Elements = CTy->getElements();
1496 
1497   // Add enumerators to enumeration type.
1498   for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
1499     auto *Enum = dyn_cast_or_null<DIEnumerator>(Elements[i]);
1500     if (Enum) {
1501       DIE &Enumerator = createAndAddDIE(dwarf::DW_TAG_enumerator, Buffer);
1502       StringRef Name = Enum->getName();
1503       addString(Enumerator, dwarf::DW_AT_name, Name);
1504       addConstantValue(Enumerator, Enum->getValue(), IsUnsigned);
1505       if (IndexEnumerators)
1506         addGlobalName(Name, Enumerator, Context);
1507     }
1508   }
1509 }
1510 
1511 void DwarfUnit::constructContainingTypeDIEs() {
1512   for (auto CI = ContainingTypeMap.begin(), CE = ContainingTypeMap.end();
1513        CI != CE; ++CI) {
1514     DIE &SPDie = *CI->first;
1515     const DINode *D = CI->second;
1516     if (!D)
1517       continue;
1518     DIE *NDie = getDIE(D);
1519     if (!NDie)
1520       continue;
1521     addDIEEntry(SPDie, dwarf::DW_AT_containing_type, *NDie);
1522   }
1523 }
1524 
1525 DIE &DwarfUnit::constructMemberDIE(DIE &Buffer, const DIDerivedType *DT) {
1526   DIE &MemberDie = createAndAddDIE(DT->getTag(), Buffer);
1527   StringRef Name = DT->getName();
1528   if (!Name.empty())
1529     addString(MemberDie, dwarf::DW_AT_name, Name);
1530 
1531   if (DIType *Resolved = DT->getBaseType())
1532     addType(MemberDie, Resolved);
1533 
1534   addSourceLine(MemberDie, DT);
1535 
1536   if (DT->getTag() == dwarf::DW_TAG_inheritance && DT->isVirtual()) {
1537 
1538     // For C++, virtual base classes are not at fixed offset. Use following
1539     // expression to extract appropriate offset from vtable.
1540     // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1541 
1542     DIELoc *VBaseLocationDie = new (DIEValueAllocator) DIELoc;
1543     addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1544     addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1545     addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1546     addUInt(*VBaseLocationDie, dwarf::DW_FORM_udata, DT->getOffsetInBits());
1547     addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1548     addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1549     addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1550 
1551     addBlock(MemberDie, dwarf::DW_AT_data_member_location, VBaseLocationDie);
1552   } else {
1553     uint64_t Size = DT->getSizeInBits();
1554     uint64_t FieldSize = DD->getBaseTypeSize(DT);
1555     uint32_t AlignInBytes = DT->getAlignInBytes();
1556     uint64_t OffsetInBytes;
1557 
1558     bool IsBitfield = FieldSize && Size != FieldSize;
1559     if (IsBitfield) {
1560       // Handle bitfield, assume bytes are 8 bits.
1561       if (DD->useDWARF2Bitfields())
1562         addUInt(MemberDie, dwarf::DW_AT_byte_size, None, FieldSize/8);
1563       addUInt(MemberDie, dwarf::DW_AT_bit_size, None, Size);
1564 
1565       uint64_t Offset = DT->getOffsetInBits();
1566       // We can't use DT->getAlignInBits() here: AlignInBits for member type
1567       // is non-zero if and only if alignment was forced (e.g. _Alignas()),
1568       // which can't be done with bitfields. Thus we use FieldSize here.
1569       uint32_t AlignInBits = FieldSize;
1570       uint32_t AlignMask = ~(AlignInBits - 1);
1571       // The bits from the start of the storage unit to the start of the field.
1572       uint64_t StartBitOffset = Offset - (Offset & AlignMask);
1573       // The byte offset of the field's aligned storage unit inside the struct.
1574       OffsetInBytes = (Offset - StartBitOffset) / 8;
1575 
1576       if (DD->useDWARF2Bitfields()) {
1577         uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1578         uint64_t FieldOffset = (HiMark - FieldSize);
1579         Offset -= FieldOffset;
1580 
1581         // Maybe we need to work from the other end.
1582         if (Asm->getDataLayout().isLittleEndian())
1583           Offset = FieldSize - (Offset + Size);
1584 
1585         addUInt(MemberDie, dwarf::DW_AT_bit_offset, None, Offset);
1586         OffsetInBytes = FieldOffset >> 3;
1587       } else {
1588         addUInt(MemberDie, dwarf::DW_AT_data_bit_offset, None, Offset);
1589       }
1590     } else {
1591       // This is not a bitfield.
1592       OffsetInBytes = DT->getOffsetInBits() / 8;
1593       if (AlignInBytes)
1594         addUInt(MemberDie, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1595                 AlignInBytes);
1596     }
1597 
1598     if (DD->getDwarfVersion() <= 2) {
1599       DIELoc *MemLocationDie = new (DIEValueAllocator) DIELoc;
1600       addUInt(*MemLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1601       addUInt(*MemLocationDie, dwarf::DW_FORM_udata, OffsetInBytes);
1602       addBlock(MemberDie, dwarf::DW_AT_data_member_location, MemLocationDie);
1603     } else if (!IsBitfield || DD->useDWARF2Bitfields())
1604       addUInt(MemberDie, dwarf::DW_AT_data_member_location, None,
1605               OffsetInBytes);
1606   }
1607 
1608   if (DT->isProtected())
1609     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1610             dwarf::DW_ACCESS_protected);
1611   else if (DT->isPrivate())
1612     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1613             dwarf::DW_ACCESS_private);
1614   // Otherwise C++ member and base classes are considered public.
1615   else if (DT->isPublic())
1616     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1617             dwarf::DW_ACCESS_public);
1618   if (DT->isVirtual())
1619     addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
1620             dwarf::DW_VIRTUALITY_virtual);
1621 
1622   // Objective-C properties.
1623   if (DINode *PNode = DT->getObjCProperty())
1624     if (DIE *PDie = getDIE(PNode))
1625       MemberDie.addValue(DIEValueAllocator, dwarf::DW_AT_APPLE_property,
1626                          dwarf::DW_FORM_ref4, DIEEntry(*PDie));
1627 
1628   if (DT->isArtificial())
1629     addFlag(MemberDie, dwarf::DW_AT_artificial);
1630 
1631   return MemberDie;
1632 }
1633 
1634 DIE *DwarfUnit::getOrCreateStaticMemberDIE(const DIDerivedType *DT) {
1635   if (!DT)
1636     return nullptr;
1637 
1638   // Construct the context before querying for the existence of the DIE in case
1639   // such construction creates the DIE.
1640   DIE *ContextDIE = getOrCreateContextDIE(DT->getScope());
1641   assert(dwarf::isType(ContextDIE->getTag()) &&
1642          "Static member should belong to a type.");
1643 
1644   if (DIE *StaticMemberDIE = getDIE(DT))
1645     return StaticMemberDIE;
1646 
1647   DIE &StaticMemberDIE = createAndAddDIE(DT->getTag(), *ContextDIE, DT);
1648 
1649   const DIType *Ty = DT->getBaseType();
1650 
1651   addString(StaticMemberDIE, dwarf::DW_AT_name, DT->getName());
1652   addType(StaticMemberDIE, Ty);
1653   addSourceLine(StaticMemberDIE, DT);
1654   addFlag(StaticMemberDIE, dwarf::DW_AT_external);
1655   addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
1656 
1657   // FIXME: We could omit private if the parent is a class_type, and
1658   // public if the parent is something else.
1659   if (DT->isProtected())
1660     addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1661             dwarf::DW_ACCESS_protected);
1662   else if (DT->isPrivate())
1663     addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1664             dwarf::DW_ACCESS_private);
1665   else if (DT->isPublic())
1666     addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1667             dwarf::DW_ACCESS_public);
1668 
1669   if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT->getConstant()))
1670     addConstantValue(StaticMemberDIE, CI, Ty);
1671   if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT->getConstant()))
1672     addConstantFPValue(StaticMemberDIE, CFP);
1673 
1674   if (uint32_t AlignInBytes = DT->getAlignInBytes())
1675     addUInt(StaticMemberDIE, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1676             AlignInBytes);
1677 
1678   return &StaticMemberDIE;
1679 }
1680 
1681 void DwarfUnit::emitCommonHeader(bool UseOffsets, dwarf::UnitType UT) {
1682   // Emit size of content not including length itself
1683   if (!DD->useSectionsAsReferences()) {
1684     StringRef Prefix = isDwoUnit() ? "debug_info_dwo_" : "debug_info_";
1685     MCSymbol *BeginLabel = Asm->createTempSymbol(Prefix + "start");
1686     EndLabel = Asm->createTempSymbol(Prefix + "end");
1687     Asm->emitDwarfUnitLength(EndLabel, BeginLabel, "Length of Unit");
1688     Asm->OutStreamer->emitLabel(BeginLabel);
1689   } else
1690     Asm->emitDwarfUnitLength(getHeaderSize() + getUnitDie().getSize(),
1691                              "Length of Unit");
1692 
1693   Asm->OutStreamer->AddComment("DWARF version number");
1694   unsigned Version = DD->getDwarfVersion();
1695   Asm->emitInt16(Version);
1696 
1697   // DWARF v5 reorders the address size and adds a unit type.
1698   if (Version >= 5) {
1699     Asm->OutStreamer->AddComment("DWARF Unit Type");
1700     Asm->emitInt8(UT);
1701     Asm->OutStreamer->AddComment("Address Size (in bytes)");
1702     Asm->emitInt8(Asm->MAI->getCodePointerSize());
1703   }
1704 
1705   // We share one abbreviations table across all units so it's always at the
1706   // start of the section. Use a relocatable offset where needed to ensure
1707   // linking doesn't invalidate that offset.
1708   Asm->OutStreamer->AddComment("Offset Into Abbrev. Section");
1709   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1710   if (UseOffsets)
1711     Asm->emitDwarfLengthOrOffset(0);
1712   else
1713     Asm->emitDwarfSymbolReference(
1714         TLOF.getDwarfAbbrevSection()->getBeginSymbol(), false);
1715 
1716   if (Version <= 4) {
1717     Asm->OutStreamer->AddComment("Address Size (in bytes)");
1718     Asm->emitInt8(Asm->MAI->getCodePointerSize());
1719   }
1720 }
1721 
1722 void DwarfTypeUnit::emitHeader(bool UseOffsets) {
1723   DwarfUnit::emitCommonHeader(UseOffsets,
1724                               DD->useSplitDwarf() ? dwarf::DW_UT_split_type
1725                                                   : dwarf::DW_UT_type);
1726   Asm->OutStreamer->AddComment("Type Signature");
1727   Asm->OutStreamer->emitIntValue(TypeSignature, sizeof(TypeSignature));
1728   Asm->OutStreamer->AddComment("Type DIE Offset");
1729   // In a skeleton type unit there is no type DIE so emit a zero offset.
1730   Asm->emitDwarfLengthOrOffset(Ty ? Ty->getOffset() : 0);
1731 }
1732 
1733 DIE::value_iterator
1734 DwarfUnit::addSectionDelta(DIE &Die, dwarf::Attribute Attribute,
1735                            const MCSymbol *Hi, const MCSymbol *Lo) {
1736   return Die.addValue(DIEValueAllocator, Attribute,
1737                       DD->getDwarfSectionOffsetForm(),
1738                       new (DIEValueAllocator) DIEDelta(Hi, Lo));
1739 }
1740 
1741 DIE::value_iterator
1742 DwarfUnit::addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
1743                            const MCSymbol *Label, const MCSymbol *Sec) {
1744   if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1745     return addLabel(Die, Attribute, DD->getDwarfSectionOffsetForm(), Label);
1746   return addSectionDelta(Die, Attribute, Label, Sec);
1747 }
1748 
1749 bool DwarfTypeUnit::isDwoUnit() const {
1750   // Since there are no skeleton type units, all type units are dwo type units
1751   // when split DWARF is being used.
1752   return DD->useSplitDwarf();
1753 }
1754 
1755 void DwarfTypeUnit::addGlobalName(StringRef Name, const DIE &Die,
1756                                   const DIScope *Context) {
1757   getCU().addGlobalNameForTypeUnit(Name, Context);
1758 }
1759 
1760 void DwarfTypeUnit::addGlobalType(const DIType *Ty, const DIE &Die,
1761                                   const DIScope *Context) {
1762   getCU().addGlobalTypeUnitType(Ty, Context);
1763 }
1764 
1765 const MCSymbol *DwarfUnit::getCrossSectionRelativeBaseAddress() const {
1766   if (!Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1767     return nullptr;
1768   if (isDwoUnit())
1769     return nullptr;
1770   return getSection()->getBeginSymbol();
1771 }
1772 
1773 void DwarfUnit::addStringOffsetsStart() {
1774   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1775   addSectionLabel(getUnitDie(), dwarf::DW_AT_str_offsets_base,
1776                   DU->getStringOffsetsStartSym(),
1777                   TLOF.getDwarfStrOffSection()->getBeginSymbol());
1778 }
1779 
1780 void DwarfUnit::addRnglistsBase() {
1781   assert(DD->getDwarfVersion() >= 5 &&
1782          "DW_AT_rnglists_base requires DWARF version 5 or later");
1783   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1784   addSectionLabel(getUnitDie(), dwarf::DW_AT_rnglists_base,
1785                   DU->getRnglistsTableBaseSym(),
1786                   TLOF.getDwarfRnglistsSection()->getBeginSymbol());
1787 }
1788 
1789 void DwarfTypeUnit::finishNonUnitTypeDIE(DIE& D, const DICompositeType *CTy) {
1790   addFlag(D, dwarf::DW_AT_declaration);
1791   StringRef Name = CTy->getName();
1792   if (!Name.empty())
1793     addString(D, dwarf::DW_AT_name, Name);
1794   getCU().createTypeDIE(CTy);
1795 }
1796