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