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