LLVM  12.0.0git
DIE.cpp
Go to the documentation of this file.
1 //===--- lib/CodeGen/DIE.cpp - DWARF Info Entries -------------------------===//
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 // Data structures for DWARF info entries.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/CodeGen/DIE.h"
14 #include "DwarfCompileUnit.h"
15 #include "DwarfDebug.h"
16 #include "DwarfUnit.h"
17 #include "llvm/ADT/Twine.h"
19 #include "llvm/Config/llvm-config.h"
20 #include "llvm/IR/DataLayout.h"
21 #include "llvm/MC/MCAsmInfo.h"
22 #include "llvm/MC/MCContext.h"
23 #include "llvm/MC/MCStreamer.h"
24 #include "llvm/MC/MCSymbol.h"
25 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/Format.h"
29 #include "llvm/Support/LEB128.h"
30 #include "llvm/Support/MD5.h"
32 using namespace llvm;
33 
34 #define DEBUG_TYPE "dwarfdebug"
35 
36 //===----------------------------------------------------------------------===//
37 // DIEAbbrevData Implementation
38 //===----------------------------------------------------------------------===//
39 
40 /// Profile - Used to gather unique data for the abbreviation folding set.
41 ///
43  // Explicitly cast to an integer type for which FoldingSetNodeID has
44  // overloads. Otherwise MSVC 2010 thinks this call is ambiguous.
45  ID.AddInteger(unsigned(Attribute));
46  ID.AddInteger(unsigned(Form));
47  if (Form == dwarf::DW_FORM_implicit_const)
48  ID.AddInteger(Value);
49 }
50 
51 //===----------------------------------------------------------------------===//
52 // DIEAbbrev Implementation
53 //===----------------------------------------------------------------------===//
54 
55 /// Profile - Used to gather unique data for the abbreviation folding set.
56 ///
58  ID.AddInteger(unsigned(Tag));
59  ID.AddInteger(unsigned(Children));
60 
61  // For each attribute description.
62  for (unsigned i = 0, N = Data.size(); i < N; ++i)
63  Data[i].Profile(ID);
64 }
65 
66 /// Emit - Print the abbreviation using the specified asm printer.
67 ///
68 void DIEAbbrev::Emit(const AsmPrinter *AP) const {
69  // Emit its Dwarf tag type.
70  AP->emitULEB128(Tag, dwarf::TagString(Tag).data());
71 
72  // Emit whether it has children DIEs.
73  AP->emitULEB128((unsigned)Children, dwarf::ChildrenString(Children).data());
74 
75  // For each attribute description.
76  for (unsigned i = 0, N = Data.size(); i < N; ++i) {
77  const DIEAbbrevData &AttrData = Data[i];
78 
79  // Emit attribute type.
80  AP->emitULEB128(AttrData.getAttribute(),
81  dwarf::AttributeString(AttrData.getAttribute()).data());
82 
83  // Emit form type.
84 #ifndef NDEBUG
85  // Could be an assertion, but this way we can see the failing form code
86  // easily, which helps track down where it came from.
87  if (!dwarf::isValidFormForVersion(AttrData.getForm(),
88  AP->getDwarfVersion())) {
89  LLVM_DEBUG(dbgs() << "Invalid form " << format("0x%x", AttrData.getForm())
90  << " for DWARF version " << AP->getDwarfVersion()
91  << "\n");
92  llvm_unreachable("Invalid form for specified DWARF version");
93  }
94 #endif
95  AP->emitULEB128(AttrData.getForm(),
96  dwarf::FormEncodingString(AttrData.getForm()).data());
97 
98  // Emit value for DW_FORM_implicit_const.
99  if (AttrData.getForm() == dwarf::DW_FORM_implicit_const)
100  AP->emitSLEB128(AttrData.getValue());
101  }
102 
103  // Mark end of abbreviation.
104  AP->emitULEB128(0, "EOM(1)");
105  AP->emitULEB128(0, "EOM(2)");
106 }
107 
110  O << "Abbreviation @"
111  << format("0x%lx", (long)(intptr_t)this)
112  << " "
114  << " "
115  << dwarf::ChildrenString(Children)
116  << '\n';
117 
118  for (unsigned i = 0, N = Data.size(); i < N; ++i) {
119  O << " "
121  << " "
123 
124  if (Data[i].getForm() == dwarf::DW_FORM_implicit_const)
125  O << " " << Data[i].getValue();
126 
127  O << '\n';
128  }
129 }
130 
131 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
133  print(dbgs());
134 }
135 #endif
136 
137 //===----------------------------------------------------------------------===//
138 // DIEAbbrevSet Implementation
139 //===----------------------------------------------------------------------===//
140 
142  for (DIEAbbrev *Abbrev : Abbreviations)
143  Abbrev->~DIEAbbrev();
144 }
145 
147 
149  DIEAbbrev Abbrev = Die.generateAbbrev();
150  Abbrev.Profile(ID);
151 
152  void *InsertPos;
153  if (DIEAbbrev *Existing =
154  AbbreviationsSet.FindNodeOrInsertPos(ID, InsertPos)) {
155  Die.setAbbrevNumber(Existing->getNumber());
156  return *Existing;
157  }
158 
159  // Move the abbreviation to the heap and assign a number.
160  DIEAbbrev *New = new (Alloc) DIEAbbrev(std::move(Abbrev));
161  Abbreviations.push_back(New);
162  New->setNumber(Abbreviations.size());
163  Die.setAbbrevNumber(Abbreviations.size());
164 
165  // Store it for lookup.
166  AbbreviationsSet.InsertNode(New, InsertPos);
167  return *New;
168 }
169 
171  if (!Abbreviations.empty()) {
172  // Start the debug abbrev section.
173  AP->OutStreamer->SwitchSection(Section);
174  AP->emitDwarfAbbrevs(Abbreviations);
175  }
176 }
177 
178 //===----------------------------------------------------------------------===//
179 // DIE Implementation
180 //===----------------------------------------------------------------------===//
181 
182 DIE *DIE::getParent() const {
183  return Owner.dyn_cast<DIE*>();
184 }
185 
187  DIEAbbrev Abbrev(Tag, hasChildren());
188  for (const DIEValue &V : values())
189  if (V.getForm() == dwarf::DW_FORM_implicit_const)
190  Abbrev.AddImplicitConstAttribute(V.getAttribute(),
191  V.getDIEInteger().getValue());
192  else
193  Abbrev.AddAttribute(V.getAttribute(), V.getForm());
194  return Abbrev;
195 }
196 
197 unsigned DIE::getDebugSectionOffset() const {
198  const DIEUnit *Unit = getUnit();
199  assert(Unit && "DIE must be owned by a DIEUnit to get its absolute offset");
200  return Unit->getDebugSectionOffset() + getOffset();
201 }
202 
203 const DIE *DIE::getUnitDie() const {
204  const DIE *p = this;
205  while (p) {
206  if (p->getTag() == dwarf::DW_TAG_compile_unit ||
207  p->getTag() == dwarf::DW_TAG_type_unit)
208  return p;
209  p = p->getParent();
210  }
211  return nullptr;
212 }
213 
215  const DIE *UnitDie = getUnitDie();
216  if (UnitDie)
217  return UnitDie->Owner.dyn_cast<DIEUnit*>();
218  return nullptr;
219 }
220 
222  // Iterate through all the attributes until we find the one we're
223  // looking for, if we can't find it return NULL.
224  for (const auto &V : values())
225  if (V.getAttribute() == Attribute)
226  return V;
227  return DIEValue();
228 }
229 
231 static void printValues(raw_ostream &O, const DIEValueList &Values,
232  StringRef Type, unsigned Size, unsigned IndentCount) {
233  O << Type << ": Size: " << Size << "\n";
234 
235  unsigned I = 0;
236  const std::string Indent(IndentCount, ' ');
237  for (const auto &V : Values.values()) {
238  O << Indent;
239  O << "Blk[" << I++ << "]";
240  O << " " << dwarf::FormEncodingString(V.getForm()) << " ";
241  V.print(O);
242  O << "\n";
243  }
244 }
245 
247 void DIE::print(raw_ostream &O, unsigned IndentCount) const {
248  const std::string Indent(IndentCount, ' ');
249  O << Indent << "Die: " << format("0x%lx", (long)(intptr_t) this)
250  << ", Offset: " << Offset << ", Size: " << Size << "\n";
251 
252  O << Indent << dwarf::TagString(getTag()) << " "
253  << dwarf::ChildrenString(hasChildren()) << "\n";
254 
255  IndentCount += 2;
256  for (const auto &V : values()) {
257  O << Indent;
258  O << dwarf::AttributeString(V.getAttribute());
259  O << " " << dwarf::FormEncodingString(V.getForm()) << " ";
260  V.print(O);
261  O << "\n";
262  }
263  IndentCount -= 2;
264 
265  for (const auto &Child : children())
266  Child.print(O, IndentCount + 4);
267 
268  O << "\n";
269 }
270 
271 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
273  print(dbgs());
274 }
275 #endif
276 
278  DIEAbbrevSet &AbbrevSet,
279  unsigned CUOffset) {
280  // Unique the abbreviation and fill in the abbreviation number so this DIE
281  // can be emitted.
282  const DIEAbbrev &Abbrev = AbbrevSet.uniqueAbbreviation(*this);
283 
284  // Set compile/type unit relative offset of this DIE.
285  setOffset(CUOffset);
286 
287  // Add the byte size of the abbreviation code.
288  CUOffset += getULEB128Size(getAbbrevNumber());
289 
290  // Add the byte size of all the DIE attribute values.
291  for (const auto &V : values())
292  CUOffset += V.SizeOf(AP);
293 
294  // Let the children compute their offsets and abbreviation numbers.
295  if (hasChildren()) {
296  (void)Abbrev;
297  assert(Abbrev.hasChildren() && "Children flag not set");
298 
299  for (auto &Child : children())
300  CUOffset = Child.computeOffsetsAndAbbrevs(AP, AbbrevSet, CUOffset);
301 
302  // Each child chain is terminated with a zero byte, adjust the offset.
303  CUOffset += sizeof(int8_t);
304  }
305 
306  // Compute the byte size of this DIE and all of its children correctly. This
307  // is needed so that top level DIE can help the compile unit set its length
308  // correctly.
309  setSize(CUOffset - getOffset());
310  return CUOffset;
311 }
312 
313 //===----------------------------------------------------------------------===//
314 // DIEUnit Implementation
315 //===----------------------------------------------------------------------===//
316 DIEUnit::DIEUnit(uint16_t V, uint8_t A, dwarf::Tag UnitTag)
317  : Die(UnitTag), Section(nullptr), Offset(0), Length(0), Version(V),
318  AddrSize(A)
319 {
320  Die.Owner = this;
321  assert((UnitTag == dwarf::DW_TAG_compile_unit ||
322  UnitTag == dwarf::DW_TAG_skeleton_unit ||
323  UnitTag == dwarf::DW_TAG_type_unit ||
324  UnitTag == dwarf::DW_TAG_partial_unit) &&
325  "expected a unit TAG");
326 }
327 
328 void DIEValue::emitValue(const AsmPrinter *AP) const {
329  switch (Ty) {
330  case isNone:
331  llvm_unreachable("Expected valid DIEValue");
332 #define HANDLE_DIEVALUE(T) \
333  case is##T: \
334  getDIE##T().emitValue(AP, Form); \
335  break;
336 #include "llvm/CodeGen/DIEValue.def"
337  }
338 }
339 
340 unsigned DIEValue::SizeOf(const AsmPrinter *AP) const {
341  switch (Ty) {
342  case isNone:
343  llvm_unreachable("Expected valid DIEValue");
344 #define HANDLE_DIEVALUE(T) \
345  case is##T: \
346  return getDIE##T().SizeOf(AP, Form);
347 #include "llvm/CodeGen/DIEValue.def"
348  }
349  llvm_unreachable("Unknown DIE kind");
350 }
351 
354  switch (Ty) {
355  case isNone:
356  llvm_unreachable("Expected valid DIEValue");
357 #define HANDLE_DIEVALUE(T) \
358  case is##T: \
359  getDIE##T().print(O); \
360  break;
361 #include "llvm/CodeGen/DIEValue.def"
362  }
363 }
364 
365 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
367  print(dbgs());
368 }
369 #endif
370 
371 //===----------------------------------------------------------------------===//
372 // DIEInteger Implementation
373 //===----------------------------------------------------------------------===//
374 
375 /// EmitValue - Emit integer of appropriate size.
376 ///
378  switch (Form) {
379  case dwarf::DW_FORM_implicit_const:
380  case dwarf::DW_FORM_flag_present:
381  // Emit something to keep the lines and comments in sync.
382  // FIXME: Is there a better way to do this?
383  Asm->OutStreamer->AddBlankLine();
384  return;
385  case dwarf::DW_FORM_flag:
386  case dwarf::DW_FORM_ref1:
387  case dwarf::DW_FORM_data1:
388  case dwarf::DW_FORM_strx1:
389  case dwarf::DW_FORM_addrx1:
390  case dwarf::DW_FORM_ref2:
391  case dwarf::DW_FORM_data2:
392  case dwarf::DW_FORM_strx2:
393  case dwarf::DW_FORM_addrx2:
394  case dwarf::DW_FORM_strx3:
395  case dwarf::DW_FORM_strp:
396  case dwarf::DW_FORM_ref4:
397  case dwarf::DW_FORM_data4:
398  case dwarf::DW_FORM_ref_sup4:
399  case dwarf::DW_FORM_strx4:
400  case dwarf::DW_FORM_addrx4:
401  case dwarf::DW_FORM_ref8:
402  case dwarf::DW_FORM_ref_sig8:
403  case dwarf::DW_FORM_data8:
404  case dwarf::DW_FORM_ref_sup8:
405  case dwarf::DW_FORM_GNU_ref_alt:
406  case dwarf::DW_FORM_GNU_strp_alt:
407  case dwarf::DW_FORM_line_strp:
408  case dwarf::DW_FORM_sec_offset:
409  case dwarf::DW_FORM_strp_sup:
410  case dwarf::DW_FORM_addr:
411  case dwarf::DW_FORM_ref_addr:
412  Asm->OutStreamer->emitIntValue(Integer, SizeOf(Asm, Form));
413  return;
414  case dwarf::DW_FORM_GNU_str_index:
415  case dwarf::DW_FORM_GNU_addr_index:
416  case dwarf::DW_FORM_ref_udata:
417  case dwarf::DW_FORM_strx:
418  case dwarf::DW_FORM_addrx:
419  case dwarf::DW_FORM_rnglistx:
420  case dwarf::DW_FORM_udata:
421  Asm->emitULEB128(Integer);
422  return;
423  case dwarf::DW_FORM_sdata:
424  Asm->emitSLEB128(Integer);
425  return;
426  default: llvm_unreachable("DIE Value form not supported yet");
427  }
428 }
429 
430 /// SizeOf - Determine size of integer value in bytes.
431 ///
432 unsigned DIEInteger::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
433  dwarf::FormParams Params = {0, 0, dwarf::DWARF32};
434  if (AP)
435  Params = {AP->getDwarfVersion(), uint8_t(AP->getPointerSize()),
436  AP->OutStreamer->getContext().getDwarfFormat()};
437 
438  if (Optional<uint8_t> FixedSize = dwarf::getFixedFormByteSize(Form, Params))
439  return *FixedSize;
440 
441  switch (Form) {
442  case dwarf::DW_FORM_GNU_str_index:
443  case dwarf::DW_FORM_GNU_addr_index:
444  case dwarf::DW_FORM_ref_udata:
445  case dwarf::DW_FORM_strx:
446  case dwarf::DW_FORM_addrx:
447  case dwarf::DW_FORM_rnglistx:
448  case dwarf::DW_FORM_udata:
449  return getULEB128Size(Integer);
450  case dwarf::DW_FORM_sdata:
451  return getSLEB128Size(Integer);
452  default: llvm_unreachable("DIE Value form not supported yet");
453  }
454 }
455 
458  O << "Int: " << (int64_t)Integer << " 0x";
459  O.write_hex(Integer);
460 }
461 
462 //===----------------------------------------------------------------------===//
463 // DIEExpr Implementation
464 //===----------------------------------------------------------------------===//
465 
466 /// EmitValue - Emit expression value.
467 ///
469  AP->emitDebugValue(Expr, SizeOf(AP, Form));
470 }
471 
472 /// SizeOf - Determine size of expression value in bytes.
473 ///
474 unsigned DIEExpr::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
475  if (Form == dwarf::DW_FORM_data4) return 4;
476  if (Form == dwarf::DW_FORM_sec_offset) return 4;
477  if (Form == dwarf::DW_FORM_strp) return 4;
478  return AP->getPointerSize();
479 }
480 
482 void DIEExpr::print(raw_ostream &O) const { O << "Expr: " << *Expr; }
483 
484 //===----------------------------------------------------------------------===//
485 // DIELabel Implementation
486 //===----------------------------------------------------------------------===//
487 
488 /// EmitValue - Emit label value.
489 ///
491  AP->emitLabelReference(
492  Label, SizeOf(AP, Form),
493  Form == dwarf::DW_FORM_strp || Form == dwarf::DW_FORM_sec_offset ||
494  Form == dwarf::DW_FORM_ref_addr || Form == dwarf::DW_FORM_data4);
495 }
496 
497 /// SizeOf - Determine size of label value in bytes.
498 ///
499 unsigned DIELabel::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
500  if (Form == dwarf::DW_FORM_data4) return 4;
501  if (Form == dwarf::DW_FORM_sec_offset) return 4;
502  if (Form == dwarf::DW_FORM_strp) return 4;
503  return AP->MAI->getCodePointerSize();
504 }
505 
507 void DIELabel::print(raw_ostream &O) const { O << "Lbl: " << Label->getName(); }
508 
509 //===----------------------------------------------------------------------===//
510 // DIEBaseTypeRef Implementation
511 //===----------------------------------------------------------------------===//
512 
514  uint64_t Offset = CU->ExprRefedBaseTypes[Index].Die->getOffset();
515  assert(Offset < (1ULL << (ULEB128PadSize * 7)) && "Offset wont fit");
516  AP->emitULEB128(Offset, nullptr, ULEB128PadSize);
517 }
518 
519 unsigned DIEBaseTypeRef::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
520  return ULEB128PadSize;
521 }
522 
524 void DIEBaseTypeRef::print(raw_ostream &O) const { O << "BaseTypeRef: " << Index; }
525 
526 //===----------------------------------------------------------------------===//
527 // DIEDelta Implementation
528 //===----------------------------------------------------------------------===//
529 
530 /// EmitValue - Emit delta value.
531 ///
533  AP->emitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
534 }
535 
536 /// SizeOf - Determine size of delta value in bytes.
537 ///
538 unsigned DIEDelta::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
539  if (Form == dwarf::DW_FORM_data4) return 4;
540  if (Form == dwarf::DW_FORM_sec_offset) return 4;
541  if (Form == dwarf::DW_FORM_strp) return 4;
542  return AP->MAI->getCodePointerSize();
543 }
544 
547  O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
548 }
549 
550 //===----------------------------------------------------------------------===//
551 // DIEString Implementation
552 //===----------------------------------------------------------------------===//
553 
554 /// EmitValue - Emit string value.
555 ///
557  // Index of string in symbol table.
558  switch (Form) {
559  case dwarf::DW_FORM_GNU_str_index:
560  case dwarf::DW_FORM_strx:
561  case dwarf::DW_FORM_strx1:
562  case dwarf::DW_FORM_strx2:
563  case dwarf::DW_FORM_strx3:
564  case dwarf::DW_FORM_strx4:
565  DIEInteger(S.getIndex()).emitValue(AP, Form);
566  return;
567  case dwarf::DW_FORM_strp:
569  DIELabel(S.getSymbol()).emitValue(AP, Form);
570  else
571  DIEInteger(S.getOffset()).emitValue(AP, Form);
572  return;
573  default:
574  llvm_unreachable("Expected valid string form");
575  }
576 }
577 
578 /// SizeOf - Determine size of delta value in bytes.
579 ///
580 unsigned DIEString::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
581  // Index of string in symbol table.
582  switch (Form) {
583  case dwarf::DW_FORM_GNU_str_index:
584  case dwarf::DW_FORM_strx:
585  case dwarf::DW_FORM_strx1:
586  case dwarf::DW_FORM_strx2:
587  case dwarf::DW_FORM_strx3:
588  case dwarf::DW_FORM_strx4:
589  return DIEInteger(S.getIndex()).SizeOf(AP, Form);
590  case dwarf::DW_FORM_strp:
592  return DIELabel(S.getSymbol()).SizeOf(AP, Form);
593  return DIEInteger(S.getOffset()).SizeOf(AP, Form);
594  default:
595  llvm_unreachable("Expected valid string form");
596  }
597 }
598 
601  O << "String: " << S.getString();
602 }
603 
604 //===----------------------------------------------------------------------===//
605 // DIEInlineString Implementation
606 //===----------------------------------------------------------------------===//
608  if (Form == dwarf::DW_FORM_string) {
609  AP->OutStreamer->emitBytes(S);
610  AP->emitInt8(0);
611  return;
612  }
613  llvm_unreachable("Expected valid string form");
614 }
615 
617  // Emit string bytes + NULL byte.
618  return S.size() + 1;
619 }
620 
623  O << "InlineString: " << S;
624 }
625 
626 //===----------------------------------------------------------------------===//
627 // DIEEntry Implementation
628 //===----------------------------------------------------------------------===//
629 
630 /// EmitValue - Emit debug information entry offset.
631 ///
633 
634  switch (Form) {
635  case dwarf::DW_FORM_ref1:
636  case dwarf::DW_FORM_ref2:
637  case dwarf::DW_FORM_ref4:
638  case dwarf::DW_FORM_ref8:
639  AP->OutStreamer->emitIntValue(Entry->getOffset(), SizeOf(AP, Form));
640  return;
641 
642  case dwarf::DW_FORM_ref_udata:
643  AP->emitULEB128(Entry->getOffset());
644  return;
645 
646  case dwarf::DW_FORM_ref_addr: {
647  // Get the absolute offset for this DIE within the debug info/types section.
648  unsigned Addr = Entry->getDebugSectionOffset();
649  if (const MCSymbol *SectionSym =
650  Entry->getUnit()->getCrossSectionRelativeBaseAddress()) {
651  AP->emitLabelPlusOffset(SectionSym, Addr, SizeOf(AP, Form), true);
652  return;
653  }
654 
655  AP->OutStreamer->emitIntValue(Addr, SizeOf(AP, Form));
656  return;
657  }
658  default:
659  llvm_unreachable("Improper form for DIE reference");
660  }
661 }
662 
663 unsigned DIEEntry::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
664  switch (Form) {
665  case dwarf::DW_FORM_ref1:
666  return 1;
667  case dwarf::DW_FORM_ref2:
668  return 2;
669  case dwarf::DW_FORM_ref4:
670  return 4;
671  case dwarf::DW_FORM_ref8:
672  return 8;
673  case dwarf::DW_FORM_ref_udata:
674  return getULEB128Size(Entry->getOffset());
675  case dwarf::DW_FORM_ref_addr:
676  if (AP->getDwarfVersion() == 2)
677  return AP->MAI->getCodePointerSize();
678  switch (AP->OutStreamer->getContext().getDwarfFormat()) {
679  case dwarf::DWARF32:
680  return 4;
681  case dwarf::DWARF64:
682  return 8;
683  }
684  llvm_unreachable("Invalid DWARF format");
685 
686  default:
687  llvm_unreachable("Improper form for DIE reference");
688  }
689 }
690 
693  O << format("Die: 0x%lx", (long)(intptr_t)&Entry);
694 }
695 
696 //===----------------------------------------------------------------------===//
697 // DIELoc Implementation
698 //===----------------------------------------------------------------------===//
699 
700 /// ComputeSize - calculate the size of the location expression.
701 ///
702 unsigned DIELoc::ComputeSize(const AsmPrinter *AP) const {
703  if (!Size) {
704  for (const auto &V : values())
705  Size += V.SizeOf(AP);
706  }
707 
708  return Size;
709 }
710 
711 /// EmitValue - Emit location data.
712 ///
714  switch (Form) {
715  default: llvm_unreachable("Improper form for block");
716  case dwarf::DW_FORM_block1: Asm->emitInt8(Size); break;
717  case dwarf::DW_FORM_block2: Asm->emitInt16(Size); break;
718  case dwarf::DW_FORM_block4: Asm->emitInt32(Size); break;
719  case dwarf::DW_FORM_block:
720  case dwarf::DW_FORM_exprloc:
721  Asm->emitULEB128(Size);
722  break;
723  }
724 
725  for (const auto &V : values())
726  V.emitValue(Asm);
727 }
728 
729 /// SizeOf - Determine size of location data in bytes.
730 ///
731 unsigned DIELoc::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
732  switch (Form) {
733  case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
734  case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
735  case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
736  case dwarf::DW_FORM_block:
737  case dwarf::DW_FORM_exprloc:
738  return Size + getULEB128Size(Size);
739  default: llvm_unreachable("Improper form for block");
740  }
741 }
742 
745  printValues(O, *this, "ExprLoc", Size, 5);
746 }
747 
748 //===----------------------------------------------------------------------===//
749 // DIEBlock Implementation
750 //===----------------------------------------------------------------------===//
751 
752 /// ComputeSize - calculate the size of the block.
753 ///
754 unsigned DIEBlock::ComputeSize(const AsmPrinter *AP) const {
755  if (!Size) {
756  for (const auto &V : values())
757  Size += V.SizeOf(AP);
758  }
759 
760  return Size;
761 }
762 
763 /// EmitValue - Emit block data.
764 ///
766  switch (Form) {
767  default: llvm_unreachable("Improper form for block");
768  case dwarf::DW_FORM_block1: Asm->emitInt8(Size); break;
769  case dwarf::DW_FORM_block2: Asm->emitInt16(Size); break;
770  case dwarf::DW_FORM_block4: Asm->emitInt32(Size); break;
771  case dwarf::DW_FORM_block:
772  Asm->emitULEB128(Size);
773  break;
774  case dwarf::DW_FORM_string: break;
775  case dwarf::DW_FORM_data16: break;
776  }
777 
778  for (const auto &V : values())
779  V.emitValue(Asm);
780 }
781 
782 /// SizeOf - Determine size of block data in bytes.
783 ///
784 unsigned DIEBlock::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
785  switch (Form) {
786  case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
787  case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
788  case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
789  case dwarf::DW_FORM_block: return Size + getULEB128Size(Size);
790  case dwarf::DW_FORM_data16: return 16;
791  default: llvm_unreachable("Improper form for block");
792  }
793 }
794 
797  printValues(O, *this, "Blk", Size, 5);
798 }
799 
800 //===----------------------------------------------------------------------===//
801 // DIELocList Implementation
802 //===----------------------------------------------------------------------===//
803 
804 unsigned DIELocList::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
805  if (Form == dwarf::DW_FORM_loclistx)
806  return getULEB128Size(Index);
807  if (Form == dwarf::DW_FORM_data4)
808  return 4;
809  if (Form == dwarf::DW_FORM_sec_offset)
810  return 4;
811  return AP->MAI->getCodePointerSize();
812 }
813 
814 /// EmitValue - Emit label value.
815 ///
817  if (Form == dwarf::DW_FORM_loclistx) {
818  AP->emitULEB128(Index);
819  return;
820  }
821  DwarfDebug *DD = AP->getDwarfDebug();
822  MCSymbol *Label = DD->getDebugLocs().getList(Index).Label;
823  AP->emitDwarfSymbolReference(Label, /*ForceOffset*/ DD->useSplitDwarf());
824 }
825 
827 void DIELocList::print(raw_ostream &O) const { O << "LocList: " << Index; }
Instances of this class represent a uniqued identifier for a section in the current translation unit...
Definition: MCSection.h:39
void emitValue(const AsmPrinter *AP, dwarf::Form Form) const
EmitValue - Emit delta value.
Definition: DIE.cpp:532
iterator_range< typename GraphTraits< GraphType >::ChildIteratorType > children(const typename GraphTraits< GraphType >::NodeRef &G)
Definition: GraphTraits.h:121
A helper struct providing information about the byte size of DW_FORM values that vary in size dependi...
Definition: Dwarf.h:554
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
SizeOf - Determine size of location data in bytes.
Definition: DIE.cpp:731
void print(raw_ostream &O) const
Definition: DIE.cpp:622
std::unique_ptr< MCStreamer > OutStreamer
This is the MCStreamer object for the file we are generating.
Definition: AsmPrinter.h:96
void emitValue(const AsmPrinter *Asm, dwarf::Form Form) const
EmitValue - Emit block data.
Definition: DIE.cpp:765
void emitValue(const AsmPrinter *AP, dwarf::Form Form) const
EmitValue - Emit string value.
Definition: DIE.cpp:556
This class represents lattice values for constants.
Definition: AllocatorList.h:23
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds...
Definition: Compiler.h:508
void emitValue(const AsmPrinter *Asm, dwarf::Form Form) const
EmitValue - Emit location data.
Definition: DIE.cpp:713
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:41
Attribute
Attributes.
Definition: Dwarf.h:103
const DebugLocStream & getDebugLocs() const
Returns the entries for the .debug_loc section.
Definition: DwarfDebug.h:732
uint16_t getDwarfVersion() const
Collects and handles dwarf debug information.
Definition: DwarfDebug.h:295
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Definition: Format.h:124
unsigned getDebugSectionOffset() const
Definition: DIE.h:897
void emitDwarfSymbolReference(const MCSymbol *Label, bool ForceOffset=false) const
Emit a reference to a symbol for use in dwarf.
void AddAttribute(dwarf::Attribute Attribute, dwarf::Form Form)
Adds another set of attribute information to the abbreviation.
Definition: DIE.h:109
void print(raw_ostream &O) const
Definition: DIE.cpp:744
void dump() const
Definition: DIE.cpp:272
void print(raw_ostream &O) const
Definition: DIE.cpp:109
bool useSplitDwarf() const
Returns whether or not to change the current debug info for the split dwarf proposal support...
Definition: DwarfDebug.h:706
int64_t getValue() const
Definition: DIE.h:69
Dwarf abbreviation data, describes one attribute of a Dwarf abbreviation.
Definition: DIE.h:49
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
SizeOf - Determine size of delta value in bytes.
Definition: DIE.cpp:580
void Profile(FoldingSetNodeID &ID) const
Used to gather unique data for the abbreviation folding set.
Definition: DIE.cpp:57
void emitValue(const AsmPrinter *AP, dwarf::Form Form) const
EmitValue - Emit base type reference.
Definition: DIE.cpp:513
void print(raw_ostream &O) const
Definition: DIE.cpp:507
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...
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
SizeOf - Determine size of the base type reference in bytes.
Definition: DIE.cpp:519
void AddImplicitConstAttribute(dwarf::Attribute Attribute, int64_t Value)
Adds attribute with DW_FORM_implicit_const value.
Definition: DIE.h:114
const DIE * getUnitDie() const
Climb up the parent chain to get the compile unit or type unit DIE that this DIE belongs to...
Definition: DIE.cpp:203
StringRef FormEncodingString(unsigned Encoding)
Definition: Dwarf.cpp:105
void print(raw_ostream &O) const
Definition: DIE.cpp:457
dwarf::Form getForm() const
Definition: DIE.h:68
void AddInteger(signed I)
Definition: FoldingSet.cpp:61
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
Definition: DIE.cpp:804
DIEAbbrev generateAbbrev() const
Generate the abbreviation for this DIE.
Definition: DIE.cpp:186
void print(raw_ostream &O) const
Definition: DIE.cpp:796
unsigned getPointerSize() const
Return the pointer size from the TargetMachine.
Definition: AsmPrinter.cpp:220
void emitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset, unsigned Size, bool IsSectionRelative=false) const
Emit something like ".long Label+Offset" where the size in bytes of the directive is specified by Siz...
StringRef AttributeString(unsigned Attribute)
Definition: Dwarf.cpp:72
void setNumber(unsigned N)
Definition: DIE.h:105
bool doesDwarfUseRelocationsAcrossSections() const
Definition: MCAsmInfo.h:631
raw_ostream & write_hex(unsigned long long N)
Output N in hexadecimal, without any prefix or padding.
A list of DIE values.
Definition: DIE.h:646
static Error getOffset(const SymbolRef &Sym, SectionRef Sec, uint64_t &Result)
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
SizeOf - Determine size of block data in bytes.
Definition: DIE.cpp:784
void emitValue(const AsmPrinter *AP, dwarf::Form Form) const
EmitValue - Emit label value.
Definition: DIE.cpp:490
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
Definition: DIE.cpp:663
Helps unique DIEAbbrev objects and assigns abbreviation numbers.
Definition: DIE.h:135
void emitValue(const AsmPrinter *Asm, dwarf::Form Form) const
EmitValue - Emit integer of appropriate size.
Definition: DIE.cpp:377
void Emit(const AsmPrinter *AP) const
Print the abbreviation using the specified asm printer.
Definition: DIE.cpp:68
void emitSLEB128(int64_t Value, const char *Desc=nullptr) const
Emit the specified signed leb128 value.
FoldingSetNodeID - This class is used to gather all the unique data bits of a node.
Definition: FoldingSet.h:313
void emitValue(const AsmPrinter *AP, dwarf::Form Form) const
EmitValue - Emit debug information entry offset.
Definition: DIE.cpp:632
void print(raw_ostream &O) const
Definition: DIE.cpp:353
const MCAsmInfo * MAI
Target Asm Printer information.
Definition: AsmPrinter.h:87
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:46
void print(raw_ostream &O) const
Definition: DIE.cpp:827
void dump() const
Definition: DIE.cpp:132
value_range values()
Definition: DIE.h:711
ValuesClass values(OptsTy... Options)
Helper to build a ValuesClass by forwarding a variable number of arguments as an initializer list to ...
Definition: CommandLine.h:690
bool hasChildren() const
Definition: DIE.h:102
A structured debug information entry.
Definition: DIE.h:723
void Profile(FoldingSetNodeID &ID) const
Used to gather unique data for the abbreviation folding set.
Definition: DIE.cpp:42
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
This class is intended to be used as a driving class for all asm writers.
Definition: AsmPrinter.h:81
void print(raw_ostream &O) const
Definition: DIE.cpp:482
void emitULEB128(uint64_t Value, const char *Desc=nullptr, unsigned PadTo=0) const
Emit the specified unsigned leb128 value.
dwarf::Attribute getAttribute() const
Accessors.
Definition: DIE.h:67
static LLVM_DUMP_METHOD void printValues(raw_ostream &O, const DIEValueList &Values, StringRef Type, unsigned Size, unsigned IndentCount)
Definition: DIE.cpp:231
DwarfDebug * getDwarfDebug()
Definition: AsmPrinter.h:213
A label DIE.
Definition: DIE.h:218
void emitLabelReference(const MCSymbol *Label, unsigned Size, bool IsSectionRelative=false) const
Emit something like ".long Label" where the size in bytes of the directive is specified by Size and L...
Definition: AsmPrinter.h:532
static void print(raw_ostream &Out, object::Archive::Kind Kind, T Val)
void print(raw_ostream &O) const
Definition: DIE.cpp:546
DIE * getParent() const
Definition: DIE.cpp:182
void emitValue(const AsmPrinter *AP, dwarf::Form Form) const
EmitValue - Emit label value.
Definition: DIE.cpp:816
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
unsigned computeOffsetsAndAbbrevs(const AsmPrinter *AP, DIEAbbrevSet &AbbrevSet, unsigned CUOffset)
Compute the offset of this DIE and all its children.
Definition: DIE.cpp:277
unsigned getULEB128Size(uint64_t Value)
Utility function to get the size of the ULEB128-encoded value.
Definition: LEB128.cpp:19
unsigned SizeOf(const AsmPrinter *AP) const
Return the size of a value in bytes.
Definition: DIE.cpp:340
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
SizeOf - Determine size of expression value in bytes.
Definition: DIE.cpp:474
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
SizeOf - Determine size of label value in bytes.
Definition: DIE.cpp:499
DIEUnit(uint16_t Version, uint8_t AddrSize, dwarf::Tag UnitTag)
Definition: DIE.cpp:316
virtual void emitDebugValue(const MCExpr *Value, unsigned Size) const
Emit the directive and value for debug thread local expression.
Definition: AsmPrinter.cpp:659
void dump() const
Definition: DIE.cpp:366
Represents a compile or type unit.
Definition: DIE.h:856
void print(raw_ostream &O) const
Definition: DIE.cpp:600
static Optional< unsigned > getTag(const TargetRegisterInfo *TRI, const MachineInstr &MI, const LoadInfo &LI)
void emitInt32(int Value) const
Emit a long directive and value.
const List & getList(size_t LI) const
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
void emitDwarfAbbrevs(const T &Abbrevs) const
Emit Dwarf abbreviation table.
Definition: AsmPrinter.h:603
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
SizeOf - Determine size of delta value in bytes.
Definition: DIE.cpp:538
dwarf::Tag getTag() const
Definition: DIE.h:759
static constexpr unsigned ULEB128PadSize
Definition: DwarfDebug.cpp:179
Optional< uint8_t > getFixedFormByteSize(dwarf::Form Form, FormParams Params)
Get the fixed byte size for a given form.
Definition: Dwarf.cpp:677
DIEAbbrev & uniqueAbbreviation(DIE &Die)
Generate the abbreviation declaration for a DIE and return a pointer to the generated abbreviation...
Definition: DIE.cpp:146
An integer value DIE.
Definition: DIE.h:163
Dwarf abbreviation, describes the organization of a debug information object.
Definition: DIE.h:79
void print(raw_ostream &O, unsigned IndentCount=0) const
Definition: DIE.cpp:247
StringRef TagString(unsigned Tag)
Definition: Dwarf.cpp:21
void print(raw_ostream &O) const
Definition: DIE.cpp:524
#define I(x, y, z)
Definition: MD5.cpp:59
#define N
uint32_t Size
Definition: Profile.cpp:46
unsigned getSLEB128Size(int64_t Value)
Utility function to get the size of the SLEB128-encoded value.
Definition: LEB128.cpp:29
StringRef ChildrenString(unsigned Children)
Definition: Dwarf.cpp:62
DIEValue findAttribute(dwarf::Attribute Attribute) const
Find a value in the DIE with the attribute given.
Definition: DIE.cpp:221
bool isValidFormForVersion(Form F, unsigned Version, bool ExtensionsOk=true)
Tells whether the specified form is defined in the specified version, or is an extension if extension...
Definition: Dwarf.cpp:764
unsigned getCodePointerSize() const
Get the code pointer size in bytes.
Definition: MCAsmInfo.h:417
void emitValue(const AsmPrinter *AP, dwarf::Form Form) const
EmitValue - Emit expression value.
Definition: DIE.cpp:468
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
void emitInt8(int Value) const
Emit a byte directive and value.
LLVM Value Representation.
Definition: Value.h:74
unsigned ComputeSize(const AsmPrinter *AP) const
ComputeSize - Calculate the size of the location expression.
Definition: DIE.cpp:702
void emitValue(const AsmPrinter *AP, dwarf::Form Form) const
Definition: DIE.cpp:607
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
SizeOf - Determine size of integer value in bytes.
Definition: DIE.cpp:432
void setAbbrevNumber(unsigned I)
Set the abbreviation number for this DIE.
Definition: DIE.h:787
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:46
unsigned SizeOf(const AsmPrinter *AP, dwarf::Form Form) const
Definition: DIE.cpp:616
unsigned getDebugSectionOffset() const
Get the absolute offset within the .debug_info or .debug_types section for this DIE.
Definition: DIE.cpp:197
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:57
void Emit(const AsmPrinter *AP, MCSection *Section) const
Print all abbreviations using the specified asm printer.
Definition: DIE.cpp:170
unsigned ComputeSize(const AsmPrinter *AP) const
ComputeSize - Calculate the size of the location expression.
Definition: DIE.cpp:754
#define LLVM_DEBUG(X)
Definition: Debug.h:122
void emitValue(const AsmPrinter *AP) const
Emit value via the Dwarf writer.
Definition: DIE.cpp:328
const uint64_t Version
Definition: InstrProf.h:996
void print(raw_ostream &O) const
Definition: DIE.cpp:692
void emitInt16(int Value) const
Emit a short directive and value.