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