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