LLVM 22.0.0git
DWARFDie.cpp
Go to the documentation of this file.
1//===- DWARFDie.cpp -------------------------------------------------------===//
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
11#include "llvm/ADT/SmallSet.h"
12#include "llvm/ADT/StringRef.h"
26#include "llvm/Support/Format.h"
30#include <cassert>
31#include <cinttypes>
32#include <cstdint>
33#include <string>
34#include <utility>
35
36using namespace llvm;
37using namespace dwarf;
38using namespace object;
39
41 OS << " (";
42 do {
43 uint64_t Shift = llvm::countr_zero(Val);
44 assert(Shift < 64 && "undefined behavior");
45 uint64_t Bit = 1ULL << Shift;
46 auto PropName = ApplePropertyString(Bit);
47 if (!PropName.empty())
48 OS << PropName;
49 else
50 OS << format("DW_APPLE_PROPERTY_0x%" PRIx64, Bit);
51 if (!(Val ^= Bit))
52 break;
53 OS << ", ";
54 } while (true);
55 OS << ")";
56}
57
58static void dumpRanges(const DWARFObject &Obj, raw_ostream &OS,
59 const DWARFAddressRangesVector &Ranges,
60 unsigned AddressSize, unsigned Indent,
61 const DIDumpOptions &DumpOpts) {
62 if (!DumpOpts.ShowAddresses)
63 return;
64
65 for (const DWARFAddressRange &R : Ranges) {
66 OS << '\n';
67 OS.indent(Indent);
68 R.dump(OS, AddressSize, DumpOpts, &Obj);
69 }
70}
71
72static void dumpLocationList(raw_ostream &OS, const DWARFFormValue &FormValue,
73 DWARFUnit *U, unsigned Indent,
74 DIDumpOptions DumpOpts) {
76 "bad FORM for location list");
77 DWARFContext &Ctx = U->getContext();
78 uint64_t Offset = *FormValue.getAsSectionOffset();
79
80 if (FormValue.getForm() == DW_FORM_loclistx) {
81 FormValue.dump(OS, DumpOpts);
82
83 if (auto LoclistOffset = U->getLoclistOffset(Offset))
84 Offset = *LoclistOffset;
85 else
86 return;
87 }
88 U->getLocationTable().dumpLocationList(
89 &Offset, OS, U->getBaseAddress(), Ctx.getDWARFObj(), U, DumpOpts, Indent);
90}
91
92static void dumpLocationExpr(raw_ostream &OS, const DWARFFormValue &FormValue,
93 DWARFUnit *U, unsigned Indent,
94 DIDumpOptions DumpOpts) {
97 "bad FORM for location expression");
98 DWARFContext &Ctx = U->getContext();
99 ArrayRef<uint8_t> Expr = *FormValue.getAsBlock();
100 DataExtractor Data(StringRef((const char *)Expr.data(), Expr.size()),
101 Ctx.isLittleEndian(), 0);
102 DWARFExpression DE(Data, U->getAddressByteSize(), U->getFormParams().Format);
103 printDwarfExpression(&DE, OS, DumpOpts, U);
104}
105
107 return D.getAttributeValueAsReferencedDie(F).resolveTypeUnitReference();
108}
109
110static llvm::StringRef
112 const DWARFDie &Die) {
113 if (AttrValue.Attr != DW_AT_language_version)
114 return {};
115
116 auto NameForm = Die.find(DW_AT_language_name);
117 if (!NameForm)
118 return {};
119
120 auto LName = NameForm->getAsUnsignedConstant();
121 if (!LName)
122 return {};
123
124 auto LVersion = AttrValue.Value.getAsUnsignedConstant();
125 if (!LVersion)
126 return {};
127
129 static_cast<SourceLanguageName>(*LName), *LVersion);
130}
131
132static void dumpAttribute(raw_ostream &OS, const DWARFDie &Die,
133 const DWARFAttribute &AttrValue, unsigned Indent,
134 DIDumpOptions DumpOpts) {
135 if (!Die.isValid())
136 return;
137 const char BaseIndent[] = " ";
138 OS << BaseIndent;
139 OS.indent(Indent + 2);
140 dwarf::Attribute Attr = AttrValue.Attr;
141 WithColor(OS, HighlightColor::Attribute) << formatv("{0}", Attr);
142
143 dwarf::Form Form = AttrValue.Value.getForm();
144 if (DumpOpts.Verbose || DumpOpts.ShowForm)
145 OS << formatv(" [{0}]", Form);
146
147 DWARFUnit *U = Die.getDwarfUnit();
148 const DWARFFormValue &FormValue = AttrValue.Value;
149
150 OS << "\t(";
151
152 StringRef Name;
153 std::string File;
154 auto Color = HighlightColor::Enumerator;
155 if (Attr == DW_AT_decl_file || Attr == DW_AT_call_file) {
157 if (const auto *LT = U->getContext().getLineTableForUnit(U)) {
158 if (std::optional<uint64_t> Val = FormValue.getAsUnsignedConstant()) {
159 if (LT->getFileNameByIndex(
160 *Val, U->getCompilationDir(),
162 File)) {
163 File = '"' + File + '"';
164 Name = File;
165 }
166 }
167 }
168 } else if (std::optional<uint64_t> Val = FormValue.getAsUnsignedConstant())
169 Name = AttributeValueString(Attr, *Val);
170
171 auto DumpUnsignedConstant = [&OS,
172 &DumpOpts](const DWARFFormValue &FormValue) {
173 if (std::optional<uint64_t> Val = FormValue.getAsUnsignedConstant())
174 OS << *Val;
175 else
176 FormValue.dump(OS, DumpOpts);
177 };
178
179 llvm::StringRef PrettyVersionName =
180 prettyLanguageVersionString(AttrValue, Die);
181 bool ShouldDumpRawLanguageVersion =
182 Attr == DW_AT_language_version &&
183 (DumpOpts.Verbose || PrettyVersionName.empty());
184
185 if (!Name.empty())
186 WithColor(OS, Color) << Name;
187 else if (Attr == DW_AT_decl_line || Attr == DW_AT_decl_column ||
188 Attr == DW_AT_call_line || Attr == DW_AT_call_column) {
189 DumpUnsignedConstant(FormValue);
190 } else if (Attr == DW_AT_language_version) {
191 if (ShouldDumpRawLanguageVersion)
192 DumpUnsignedConstant(FormValue);
193 } else if (Attr == DW_AT_low_pc &&
194 (FormValue.getAsAddress() ==
195 dwarf::computeTombstoneAddress(U->getAddressByteSize()))) {
196 if (DumpOpts.Verbose) {
197 FormValue.dump(OS, DumpOpts);
198 OS << " (";
199 }
200 OS << "dead code";
201 if (DumpOpts.Verbose)
202 OS << ')';
203 } else if (Attr == DW_AT_high_pc && !DumpOpts.ShowForm && !DumpOpts.Verbose &&
204 FormValue.getAsUnsignedConstant()) {
205 if (DumpOpts.ShowAddresses) {
206 // Print the actual address rather than the offset.
207 uint64_t LowPC, HighPC, Index;
208 if (Die.getLowAndHighPC(LowPC, HighPC, Index))
209 DWARFFormValue::dumpAddress(OS, U->getAddressByteSize(), HighPC);
210 else
211 FormValue.dump(OS, DumpOpts);
212 }
213 } else if (DWARFAttribute::mayHaveLocationList(Attr) &&
215 dumpLocationList(OS, FormValue, U, sizeof(BaseIndent) + Indent + 4,
216 DumpOpts);
217 else if (FormValue.isFormClass(DWARFFormValue::FC_Exprloc) ||
220 dumpLocationExpr(OS, FormValue, U, sizeof(BaseIndent) + Indent + 4,
221 DumpOpts);
222 else
223 FormValue.dump(OS, DumpOpts);
224
225 std::string Space = DumpOpts.ShowAddresses ? " " : "";
226
227 // We have dumped the attribute raw value. For some attributes
228 // having both the raw value and the pretty-printed value is
229 // interesting. These attributes are handled below.
230 if (Attr == DW_AT_specification || Attr == DW_AT_abstract_origin ||
231 Attr == DW_AT_call_origin) {
232 if (const char *Name =
235 OS << Space << "\"" << Name << '\"';
236 } else if (Attr == DW_AT_type || Attr == DW_AT_containing_type) {
237 DWARFDie D = resolveReferencedType(Die, FormValue);
238 if (D && !D.isNULL()) {
239 OS << Space << "\"";
241 OS << '"';
242 }
243 } else if (Attr == DW_AT_APPLE_property_attribute) {
244 if (std::optional<uint64_t> OptVal = FormValue.getAsUnsignedConstant())
245 dumpApplePropertyAttribute(OS, *OptVal);
246 } else if (Attr == DW_AT_ranges) {
247 const DWARFObject &Obj = Die.getDwarfUnit()->getContext().getDWARFObj();
248 // For DW_FORM_rnglistx we need to dump the offset separately, since
249 // we have only dumped the index so far.
250 if (FormValue.getForm() == DW_FORM_rnglistx)
251 if (auto RangeListOffset =
252 U->getRnglistOffset(*FormValue.getAsSectionOffset())) {
254 dwarf::DW_FORM_sec_offset, *RangeListOffset);
255 FV.dump(OS, DumpOpts);
256 }
257 if (auto RangesOrError = Die.getAddressRanges())
258 dumpRanges(Obj, OS, RangesOrError.get(), U->getAddressByteSize(),
259 sizeof(BaseIndent) + Indent + 4, DumpOpts);
260 else
262 errc::invalid_argument, "decoding address ranges: %s",
263 toString(RangesOrError.takeError()).c_str()));
264 } else if (Attr == DW_AT_language_version) {
265 if (!PrettyVersionName.empty())
266 WithColor(OS, Color) << (ShouldDumpRawLanguageVersion ? " " : "")
267 << PrettyVersionName;
268 }
269
270 OS << ")\n";
271}
272
274 std::string *OriginalFullName) const {
275 const char *NamePtr = getShortName();
276 if (!NamePtr)
277 return;
278 if (getTag() == DW_TAG_GNU_template_parameter_pack)
279 return;
280 dumpTypeUnqualifiedName(*this, OS, OriginalFullName);
281}
282
283bool DWARFDie::isSubprogramDIE() const { return getTag() == DW_TAG_subprogram; }
284
286 auto Tag = getTag();
287 return Tag == DW_TAG_subprogram || Tag == DW_TAG_inlined_subroutine;
288}
289
290std::optional<DWARFFormValue> DWARFDie::find(dwarf::Attribute Attr) const {
291 if (!isValid())
292 return std::nullopt;
293 auto AbbrevDecl = getAbbreviationDeclarationPtr();
294 if (AbbrevDecl)
295 return AbbrevDecl->getAttributeValue(getOffset(), Attr, *U);
296 return std::nullopt;
297}
298
299std::optional<DWARFFormValue>
301 if (!isValid())
302 return std::nullopt;
303 auto AbbrevDecl = getAbbreviationDeclarationPtr();
304 if (AbbrevDecl) {
305 for (auto Attr : Attrs) {
306 if (auto Value = AbbrevDecl->getAttributeValue(getOffset(), Attr, *U))
307 return Value;
308 }
309 }
310 return std::nullopt;
311}
312
313std::optional<DWARFFormValue>
316 Worklist.push_back(*this);
317
318 // Keep track if DIEs already seen to prevent infinite recursion.
319 // Empirically we rarely see a depth of more than 3 when dealing with valid
320 // DWARF. This corresponds to following the DW_AT_abstract_origin and
321 // DW_AT_specification just once.
323 Seen.insert(*this);
324
325 while (!Worklist.empty()) {
326 DWARFDie Die = Worklist.pop_back_val();
327
328 if (!Die.isValid())
329 continue;
330
331 if (auto Value = Die.find(Attrs))
332 return Value;
333
334 for (dwarf::Attribute Attr :
335 {DW_AT_abstract_origin, DW_AT_specification, DW_AT_signature}) {
336 if (auto D = Die.getAttributeValueAsReferencedDie(Attr))
337 if (Seen.insert(D).second)
338 Worklist.push_back(D);
339 }
340 }
341
342 return std::nullopt;
343}
344
347 if (std::optional<DWARFFormValue> F = find(Attr))
349 return DWARFDie();
350}
351
354 DWARFDie Result;
355 if (std::optional<uint64_t> Offset = V.getAsRelativeReference()) {
356 Result = const_cast<DWARFUnit *>(V.getUnit())
357 ->getDIEForOffset(V.getUnit()->getOffset() + *Offset);
358 } else if (Offset = V.getAsDebugInfoReference(); Offset) {
359 if (DWARFUnit *SpecUnit = U->getUnitVector().getUnitForOffset(*Offset))
360 Result = SpecUnit->getDIEForOffset(*Offset);
361 } else if (std::optional<uint64_t> Sig = V.getAsSignatureReference()) {
362 if (DWARFTypeUnit *TU =
363 U->getContext().getTypeUnitForHash(*Sig, U->isDWOUnit()))
364 Result = TU->getDIEForOffset(TU->getTypeOffset() + TU->getOffset());
365 }
366 return Result;
367}
368
370 if (auto Attr = find(DW_AT_signature)) {
371 if (std::optional<uint64_t> Sig = Attr->getAsReferenceUVal()) {
372 if (DWARFTypeUnit *TU =
373 U->getContext().getTypeUnitForHash(*Sig, U->isDWOUnit()))
374 return TU->getDIEForOffset(TU->getTypeOffset() + TU->getOffset());
375 }
376 }
377 return *this;
378}
379
386
387std::optional<uint64_t> DWARFDie::getRangesBaseAttribute() const {
388 return toSectionOffset(find({DW_AT_rnglists_base, DW_AT_GNU_ranges_base}));
389}
390
391std::optional<uint64_t> DWARFDie::getLocBaseAttribute() const {
392 return toSectionOffset(find(DW_AT_loclists_base));
393}
394
395std::optional<uint64_t> DWARFDie::getHighPC(uint64_t LowPC) const {
396 uint64_t Tombstone = dwarf::computeTombstoneAddress(U->getAddressByteSize());
397 if (LowPC == Tombstone)
398 return std::nullopt;
399 if (auto FormValue = find(DW_AT_high_pc)) {
400 if (auto Address = FormValue->getAsAddress()) {
401 // High PC is an address.
402 return Address;
403 }
404 if (auto Offset = FormValue->getAsUnsignedConstant()) {
405 // High PC is an offset from LowPC.
406 return LowPC + *Offset;
407 }
408 }
409 return std::nullopt;
410}
411
413 uint64_t &SectionIndex) const {
414 auto F = find(DW_AT_low_pc);
415 auto LowPcAddr = toSectionedAddress(F);
416 if (!LowPcAddr)
417 return false;
418 if (auto HighPcAddr = getHighPC(LowPcAddr->Address)) {
419 LowPC = LowPcAddr->Address;
420 HighPC = *HighPcAddr;
421 SectionIndex = LowPcAddr->SectionIndex;
422 return true;
423 }
424 return false;
425}
426
428 if (isNULL())
430 // Single range specified by low/high PC.
431 uint64_t LowPC, HighPC, Index;
432 if (getLowAndHighPC(LowPC, HighPC, Index))
433 return DWARFAddressRangesVector{{LowPC, HighPC, Index}};
434
435 std::optional<DWARFFormValue> Value = find(DW_AT_ranges);
436 if (Value) {
437 if (Value->getForm() == DW_FORM_rnglistx)
438 return U->findRnglistFromIndex(*Value->getAsSectionOffset());
439 return U->findRnglistFromOffset(*Value->getAsSectionOffset());
440 }
442}
443
445 auto RangesOrError = getAddressRanges();
446 if (!RangesOrError) {
447 llvm::consumeError(RangesOrError.takeError());
448 return false;
449 }
450
451 for (const auto &R : RangesOrError.get())
452 if (R.LowPC <= Address && Address < R.HighPC)
453 return true;
454 return false;
455}
456
457std::optional<uint64_t> DWARFDie::getLanguage() const {
458 if (isValid()) {
459 if (std::optional<DWARFFormValue> LV =
460 U->getUnitDIE().find(dwarf::DW_AT_language))
461 return LV->getAsUnsignedConstant();
462 }
463 return std::nullopt;
464}
465
468 std::optional<DWARFFormValue> Location = find(Attr);
469 if (!Location)
472
473 if (std::optional<uint64_t> Off = Location->getAsSectionOffset()) {
474 uint64_t Offset = *Off;
475
476 if (Location->getForm() == DW_FORM_loclistx) {
477 if (auto LoclistOffset = U->getLoclistOffset(Offset))
478 Offset = *LoclistOffset;
479 else
481 "Loclist table not found");
482 }
483 return U->findLoclistFromOffset(Offset);
484 }
485
486 if (std::optional<ArrayRef<uint8_t>> Expr = Location->getAsBlock()) {
488 DWARFLocationExpression{std::nullopt, to_vector<4>(*Expr)}};
489 }
490
491 return createStringError(
492 inconvertibleErrorCode(), "Unsupported %s encoding: %s",
494 dwarf::FormEncodingString(Location->getForm()).data());
495}
496
498 if (!isSubroutineDIE())
499 return nullptr;
500 return getName(Kind);
501}
502
504 if (!isValid() || Kind == DINameKind::None)
505 return nullptr;
506 // Try to get mangled name only if it was asked for.
508 if (auto Name = getLinkageName())
509 return Name;
510 }
511 return getShortName();
512}
513
514const char *DWARFDie::getShortName() const {
515 if (!isValid())
516 return nullptr;
517
518 return dwarf::toString(findRecursively(dwarf::DW_AT_name), nullptr);
519}
520
521const char *DWARFDie::getLinkageName() const {
522 if (!isValid())
523 return nullptr;
524
525 return dwarf::toString(findRecursively({dwarf::DW_AT_MIPS_linkage_name,
526 dwarf::DW_AT_linkage_name}),
527 nullptr);
528}
529
531 return toUnsigned(findRecursively(DW_AT_decl_line), 0);
532}
533
534std::string
536 if (auto FormValue = findRecursively(DW_AT_decl_file))
537 if (auto OptString = FormValue->getAsFile(Kind))
538 return *OptString;
539 return {};
540}
541
543 uint32_t &CallColumn,
544 uint32_t &CallDiscriminator) const {
545 CallFile = toUnsigned(find(DW_AT_call_file), 0);
546 CallLine = toUnsigned(find(DW_AT_call_line), 0);
547 CallColumn = toUnsigned(find(DW_AT_call_column), 0);
548 CallDiscriminator = toUnsigned(find(DW_AT_GNU_discriminator), 0);
549}
550
551static std::optional<uint64_t>
554 // Cycle detected?
555 if (!Visited.insert(Die.getDebugInfoEntry()).second)
556 return {};
557 if (auto SizeAttr = Die.find(DW_AT_byte_size))
558 if (std::optional<uint64_t> Size = SizeAttr->getAsUnsignedConstant())
559 return Size;
560
561 switch (Die.getTag()) {
562 case DW_TAG_pointer_type:
563 case DW_TAG_reference_type:
564 case DW_TAG_rvalue_reference_type:
565 return PointerSize;
566 case DW_TAG_ptr_to_member_type: {
568 if (BaseType.getTag() == DW_TAG_subroutine_type)
569 return 2 * PointerSize;
570 return PointerSize;
571 }
572 case DW_TAG_const_type:
573 case DW_TAG_immutable_type:
574 case DW_TAG_volatile_type:
575 case DW_TAG_restrict_type:
576 case DW_TAG_template_alias:
577 case DW_TAG_typedef: {
579 return getTypeSizeImpl(BaseType, PointerSize, Visited);
580 break;
581 }
582 case DW_TAG_array_type: {
584 if (!BaseType)
585 return std::nullopt;
586 std::optional<uint64_t> BaseSize =
587 getTypeSizeImpl(BaseType, PointerSize, Visited);
588 if (!BaseSize)
589 return std::nullopt;
590 uint64_t Size = *BaseSize;
591 for (DWARFDie Child : Die) {
592 if (Child.getTag() != DW_TAG_subrange_type)
593 continue;
594
595 if (auto ElemCountAttr = Child.find(DW_AT_count))
596 if (std::optional<uint64_t> ElemCount =
597 ElemCountAttr->getAsUnsignedConstant())
598 Size *= *ElemCount;
599 if (auto UpperBoundAttr = Child.find(DW_AT_upper_bound))
600 if (std::optional<int64_t> UpperBound =
601 UpperBoundAttr->getAsSignedConstant()) {
602 int64_t LowerBound = 0;
603 if (auto LowerBoundAttr = Child.find(DW_AT_lower_bound))
604 LowerBound = LowerBoundAttr->getAsSignedConstant().value_or(0);
605 Size *= *UpperBound - LowerBound + 1;
606 }
607 }
608 return Size;
609 }
610 default:
612 return getTypeSizeImpl(BaseType, PointerSize, Visited);
613 break;
614 }
615 return std::nullopt;
616}
617
618std::optional<uint64_t> DWARFDie::getTypeSize(uint64_t PointerSize) {
620 return getTypeSizeImpl(*this, PointerSize, Visited);
621}
622
623/// Helper to dump a DIE with all of its parents, but no siblings.
624static unsigned dumpParentChain(DWARFDie Die, raw_ostream &OS, unsigned Indent,
625 DIDumpOptions DumpOpts, unsigned Depth = 0) {
626 if (!Die)
627 return Indent;
628 if (DumpOpts.ParentRecurseDepth > 0 && Depth >= DumpOpts.ParentRecurseDepth)
629 return Indent;
630 Indent = dumpParentChain(Die.getParent(), OS, Indent, DumpOpts, Depth + 1);
631 Die.dump(OS, Indent, DumpOpts);
632 return Indent + 2;
633}
634
635void DWARFDie::dump(raw_ostream &OS, unsigned Indent,
636 DIDumpOptions DumpOpts) const {
637 if (!isValid())
638 return;
639 DWARFDataExtractor debug_info_data = U->getDebugInfoExtractor();
640 const uint64_t Offset = getOffset();
641 uint64_t offset = Offset;
642 if (DumpOpts.ShowParents) {
643 DIDumpOptions ParentDumpOpts = DumpOpts;
644 ParentDumpOpts.ShowParents = false;
645 ParentDumpOpts.ShowChildren = false;
646 Indent = dumpParentChain(getParent(), OS, Indent, ParentDumpOpts);
647 }
648
649 if (debug_info_data.isValidOffset(offset)) {
650 uint32_t abbrCode = debug_info_data.getULEB128(&offset);
651 if (DumpOpts.ShowAddresses)
653 << format("\n0x%8.8" PRIx64 ": ", Offset);
654
655 if (abbrCode) {
656 auto AbbrevDecl = getAbbreviationDeclarationPtr();
657 if (AbbrevDecl) {
659 << formatv("{0}", getTag());
660 if (DumpOpts.Verbose) {
661 OS << format(" [%u] %c", abbrCode,
662 AbbrevDecl->hasChildren() ? '*' : ' ');
663 if (std::optional<uint32_t> ParentIdx = Die->getParentIdx())
664 OS << format(" (0x%8.8" PRIx64 ")",
665 U->getDIEAtIndex(*ParentIdx).getOffset());
666 }
667 OS << '\n';
668
669 // Dump all data in the DIE for the attributes.
670 for (const DWARFAttribute &AttrValue : attributes())
671 dumpAttribute(OS, *this, AttrValue, Indent, DumpOpts);
672
673 if (DumpOpts.ShowChildren && DumpOpts.ChildRecurseDepth > 0) {
674 DWARFDie Child = getFirstChild();
675 DumpOpts.ChildRecurseDepth--;
676 DIDumpOptions ChildDumpOpts = DumpOpts;
677 ChildDumpOpts.ShowParents = false;
678 while (Child) {
679 Child.dump(OS, Indent + 2, ChildDumpOpts);
680 Child = Child.getSibling();
681 }
682 }
683 } else {
684 OS << "Abbreviation code not found in 'debug_abbrev' class for code: "
685 << abbrCode << '\n';
686 }
687 } else {
688 OS.indent(Indent) << "NULL\n";
689 }
690 }
691}
692
694
696 if (isValid())
697 return U->getParent(Die);
698 return DWARFDie();
699}
700
702 if (isValid())
703 return U->getSibling(Die);
704 return DWARFDie();
705}
706
708 if (isValid())
709 return U->getPreviousSibling(Die);
710 return DWARFDie();
711}
712
714 if (isValid())
715 return U->getFirstChild(Die);
716 return DWARFDie();
717}
718
720 if (isValid())
721 return U->getLastChild(Die);
722 return DWARFDie();
723}
724
729
731 : Die(D), Index(0) {
732 auto AbbrDecl = Die.getAbbreviationDeclarationPtr();
733 assert(AbbrDecl && "Must have abbreviation declaration");
734 if (End) {
735 // This is the end iterator so we set the index to the attribute count.
736 Index = AbbrDecl->getNumAttributes();
737 } else {
738 // This is the begin iterator so we extract the value for this->Index.
739 AttrValue.Offset = D.getOffset() + AbbrDecl->getCodeByteSize();
740 updateForIndex(*AbbrDecl, 0);
741 }
742}
743
744void DWARFDie::attribute_iterator::updateForIndex(
745 const DWARFAbbreviationDeclaration &AbbrDecl, uint32_t I) {
746 Index = I;
747 // AbbrDecl must be valid before calling this function.
748 auto NumAttrs = AbbrDecl.getNumAttributes();
749 if (Index < NumAttrs) {
750 AttrValue.Attr = AbbrDecl.getAttrByIndex(Index);
751 // Add the previous byte size of any previous attribute value.
752 AttrValue.Offset += AttrValue.ByteSize;
753 uint64_t ParseOffset = AttrValue.Offset;
755 AttrValue.Value = DWARFFormValue::createFromSValue(
756 AbbrDecl.getFormByIndex(Index),
758 else {
759 auto U = Die.getDwarfUnit();
760 assert(U && "Die must have valid DWARF unit");
761 AttrValue.Value = DWARFFormValue::createFromUnit(
762 AbbrDecl.getFormByIndex(Index), U, &ParseOffset);
763 }
764 AttrValue.ByteSize = ParseOffset - AttrValue.Offset;
765 } else {
766 assert(Index == NumAttrs && "Indexes should be [0, NumAttrs) only");
767 AttrValue = {};
768 }
769}
770
772 if (auto AbbrDecl = Die.getAbbreviationDeclarationPtr())
773 updateForIndex(*AbbrDecl, Index + 1);
774 return *this;
775}
776
778 switch(Attr) {
779 case DW_AT_location:
780 case DW_AT_string_length:
781 case DW_AT_return_addr:
782 case DW_AT_data_member_location:
783 case DW_AT_frame_base:
784 case DW_AT_static_link:
785 case DW_AT_segment:
786 case DW_AT_use_location:
787 case DW_AT_vtable_elem_location:
788 return true;
789 default:
790 return false;
791 }
792}
793
795 switch (Attr) {
796 // From the DWARF v5 specification.
797 case DW_AT_location:
798 case DW_AT_byte_size:
799 case DW_AT_bit_offset:
800 case DW_AT_bit_size:
801 case DW_AT_string_length:
802 case DW_AT_lower_bound:
803 case DW_AT_return_addr:
804 case DW_AT_bit_stride:
805 case DW_AT_upper_bound:
806 case DW_AT_count:
807 case DW_AT_data_member_location:
808 case DW_AT_frame_base:
809 case DW_AT_segment:
810 case DW_AT_static_link:
811 case DW_AT_use_location:
812 case DW_AT_vtable_elem_location:
813 case DW_AT_allocated:
814 case DW_AT_associated:
815 case DW_AT_data_location:
816 case DW_AT_byte_stride:
817 case DW_AT_rank:
818 case DW_AT_call_value:
819 case DW_AT_call_origin:
820 case DW_AT_call_target:
821 case DW_AT_call_target_clobbered:
822 case DW_AT_call_data_location:
823 case DW_AT_call_data_value:
824 // Extensions.
825 case DW_AT_GNU_call_site_value:
826 case DW_AT_GNU_call_site_target:
827 return true;
828 default:
829 return false;
830 }
831}
832
833namespace llvm {
834
838
840 std::string *OriginalFullName) {
842}
843
844} // namespace llvm
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds.
Definition Compiler.h:638
static void dumpAttribute(raw_ostream &OS, const DWARFDie &Die, const DWARFAttribute &AttrValue, unsigned Indent, DIDumpOptions DumpOpts)
Definition DWARFDie.cpp:132
static void dumpLocationExpr(raw_ostream &OS, const DWARFFormValue &FormValue, DWARFUnit *U, unsigned Indent, DIDumpOptions DumpOpts)
Definition DWARFDie.cpp:92
static unsigned dumpParentChain(DWARFDie Die, raw_ostream &OS, unsigned Indent, DIDumpOptions DumpOpts, unsigned Depth=0)
Helper to dump a DIE with all of its parents, but no siblings.
Definition DWARFDie.cpp:624
static DWARFDie resolveReferencedType(DWARFDie D, DWARFFormValue F)
Definition DWARFDie.cpp:106
static void dumpLocationList(raw_ostream &OS, const DWARFFormValue &FormValue, DWARFUnit *U, unsigned Indent, DIDumpOptions DumpOpts)
Definition DWARFDie.cpp:72
static llvm::StringRef prettyLanguageVersionString(const DWARFAttribute &AttrValue, const DWARFDie &Die)
Definition DWARFDie.cpp:111
static std::optional< uint64_t > getTypeSizeImpl(DWARFDie Die, uint64_t PointerSize, SmallPtrSetImpl< const DWARFDebugInfoEntry * > &Visited)
Definition DWARFDie.cpp:552
static void dumpApplePropertyAttribute(raw_ostream &OS, uint64_t Val)
Definition DWARFDie.cpp:40
static void dumpRanges(const DWARFObject &Obj, raw_ostream &OS, const DWARFAddressRangesVector &Ranges, unsigned AddressSize, unsigned Indent, const DIDumpOptions &DumpOpts)
Definition DWARFDie.cpp:58
This file contains constants used for implementing Dwarf debug support.
#define F(x, y, z)
Definition MD5.cpp:55
#define I(x, y, z)
Definition MD5.cpp:58
BaseType
A given derived pointer can have multiple base pointers through phi/selects.
This file defines the SmallPtrSet class.
This file defines the SmallSet class.
static Split data
LocallyHashedType DenseMapInfo< LocallyHashedType >::Tombstone
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:41
size_t size() const
size - Get the array size.
Definition ArrayRef.h:147
const T * data() const
Definition ArrayRef.h:144
A structured debug information entry.
Definition DIE.h:828
dwarf::Attribute getAttrByIndex(uint32_t idx) const
int64_t getAttrImplicitConstValueByIndex(uint32_t idx) const
dwarf::Form getFormByIndex(uint32_t idx) const
DWARFContext This data structure is the top level entity that deals with dwarf debug information pars...
DWARFTypeUnit * getTypeUnitForHash(uint64_t Hash, bool IsDWO)
const DWARFObject & getDWARFObj() const
A DWARFDataExtractor (typically for an in-memory copy of an object-file section) plus a relocation ma...
LLVM_ABI attribute_iterator & operator++()
Definition DWARFDie.cpp:771
Utility class that carries the DWARF compile/type unit and the debug info entry in an object.
Definition DWARFDie.h:43
LLVM_ABI void getFullName(raw_string_ostream &, std::string *OriginalFullName=nullptr) const
Definition DWARFDie.cpp:273
LLVM_ABI DWARFDie resolveTypeUnitReference() const
Definition DWARFDie.cpp:369
LLVM_ABI std::optional< uint64_t > getLocBaseAttribute() const
Definition DWARFDie.cpp:391
uint64_t getOffset() const
Get the absolute offset into the debug info or types section.
Definition DWARFDie.h:68
LLVM_ABI const char * getShortName() const
Return the DIE short name resolving DW_AT_specification or DW_AT_abstract_origin references if necess...
Definition DWARFDie.cpp:514
LLVM_ABI Expected< DWARFAddressRangesVector > getAddressRanges() const
Get the address ranges for this DIE.
Definition DWARFDie.cpp:427
LLVM_ABI DWARFDie getAttributeValueAsReferencedDie(dwarf::Attribute Attr) const
Extract the specified attribute from this DIE as the referenced DIE.
Definition DWARFDie.cpp:346
LLVM_ABI DWARFDie getParent() const
Get the parent of this DIE object.
Definition DWARFDie.cpp:695
LLVM_ABI std::optional< DWARFFormValue > find(dwarf::Attribute Attr) const
Extract the specified attribute from this DIE.
Definition DWARFDie.cpp:290
DWARFUnit * getDwarfUnit() const
Definition DWARFDie.h:55
const DWARFDebugInfoEntry * getDebugInfoEntry() const
Definition DWARFDie.h:54
LLVM_ABI const char * getSubroutineName(DINameKind Kind) const
If a DIE represents a subprogram (or inlined subroutine), returns its mangled name (or short name,...
Definition DWARFDie.cpp:497
LLVM_ABI DWARFDie getSibling() const
Get the sibling of this DIE object.
Definition DWARFDie.cpp:701
LLVM_ABI bool isSubroutineDIE() const
Returns true if DIE represents a subprogram or an inlined subroutine.
Definition DWARFDie.cpp:285
LLVM_ABI bool getLowAndHighPC(uint64_t &LowPC, uint64_t &HighPC, uint64_t &SectionIndex) const
Retrieves DW_AT_low_pc and DW_AT_high_pc from CU.
Definition DWARFDie.cpp:412
LLVM_ABI LLVM_DUMP_METHOD void dump() const
Convenience zero-argument overload for debugging.
Definition DWARFDie.cpp:693
LLVM_ABI void getCallerFrame(uint32_t &CallFile, uint32_t &CallLine, uint32_t &CallColumn, uint32_t &CallDiscriminator) const
Retrieves values of DW_AT_call_file, DW_AT_call_line and DW_AT_call_column from DIE (or zeroes if the...
Definition DWARFDie.cpp:542
LLVM_ABI bool isSubprogramDIE() const
Returns true if DIE represents a subprogram (not inlined).
Definition DWARFDie.cpp:283
LLVM_ABI bool addressRangeContainsAddress(const uint64_t Address) const
Definition DWARFDie.cpp:444
LLVM_ABI std::optional< DWARFFormValue > findRecursively(ArrayRef< dwarf::Attribute > Attrs) const
Extract the first value of any attribute in Attrs from this DIE and recurse into any DW_AT_specificat...
Definition DWARFDie.cpp:314
llvm::DWARFFormValue DWARFFormValue
Definition DWARFDie.h:48
LLVM_ABI std::optional< uint64_t > getHighPC(uint64_t LowPC) const
Get the DW_AT_high_pc attribute value as an address.
Definition DWARFDie.cpp:395
LLVM_ABI std::optional< uint64_t > getTypeSize(uint64_t PointerSize)
Gets the type size (in bytes) for this DIE.
Definition DWARFDie.cpp:618
LLVM_ABI DWARFDie resolveReferencedType(dwarf::Attribute Attr) const
Definition DWARFDie.cpp:380
LLVM_ABI const char * getName(DINameKind Kind) const
Return the DIE name resolving DW_AT_specification or DW_AT_abstract_origin references if necessary.
Definition DWARFDie.cpp:503
LLVM_ABI DWARFDie getLastChild() const
Get the last child of this DIE object.
Definition DWARFDie.cpp:719
LLVM_ABI DWARFDie getPreviousSibling() const
Get the previous sibling of this DIE object.
Definition DWARFDie.cpp:707
const DWARFAbbreviationDeclaration * getAbbreviationDeclarationPtr() const
Get the abbreviation declaration for this DIE.
Definition DWARFDie.h:60
DWARFDie()=default
LLVM_ABI std::string getDeclFile(DILineInfoSpecifier::FileLineInfoKind Kind) const
Definition DWARFDie.cpp:535
LLVM_ABI DWARFDie getFirstChild() const
Get the first child of this DIE object.
Definition DWARFDie.cpp:713
LLVM_ABI uint64_t getDeclLine() const
Returns the declaration line (start line) for a DIE, assuming it specifies a subprogram.
Definition DWARFDie.cpp:530
dwarf::Tag getTag() const
Definition DWARFDie.h:73
LLVM_ABI const char * getLinkageName() const
Return the DIE linkage name resolving DW_AT_specification or DW_AT_abstract_origin references if nece...
Definition DWARFDie.cpp:521
LLVM_ABI Expected< DWARFLocationExpressionsVector > getLocations(dwarf::Attribute Attr) const
Definition DWARFDie.cpp:467
LLVM_ABI std::optional< uint64_t > getRangesBaseAttribute() const
Extract the range base attribute from this DIE as absolute section offset.
Definition DWARFDie.cpp:387
bool isNULL() const
Returns true for a valid DIE that terminates a sibling chain.
Definition DWARFDie.h:86
LLVM_ABI std::optional< uint64_t > getLanguage() const
Definition DWARFDie.cpp:457
bool isValid() const
Definition DWARFDie.h:52
LLVM_ABI iterator_range< attribute_iterator > attributes() const
Get an iterator range to all attributes in the current DIE only.
Definition DWARFDie.cpp:725
LLVM_ABI void dump(raw_ostream &OS, unsigned indent=0, DIDumpOptions DumpOpts=DIDumpOptions()) const
Dump the DIE and all of its attributes to the supplied stream.
Definition DWARFDie.cpp:635
static LLVM_ABI DWARFFormValue createFromUValue(dwarf::Form F, uint64_t V)
LLVM_ABI std::optional< ArrayRef< uint8_t > > getAsBlock() const
LLVM_ABI std::optional< uint64_t > getAsSectionOffset() const
LLVM_ABI bool isFormClass(FormClass FC) const
LLVM_ABI void dumpAddress(raw_ostream &OS, uint64_t Address) const
LLVM_ABI std::optional< uint64_t > getAsAddress() const
LLVM_ABI void dump(raw_ostream &OS, DIDumpOptions DumpOpts=DIDumpOptions()) const
static LLVM_ABI DWARFFormValue createFromSValue(dwarf::Form F, int64_t V)
LLVM_ABI std::optional< uint64_t > getAsUnsignedConstant() const
static LLVM_ABI DWARFFormValue createFromUnit(dwarf::Form F, const DWARFUnit *Unit, uint64_t *OffsetPtr)
dwarf::Form getForm() const
LLVM_ABI DWARFUnit * getUnitForOffset(uint64_t Offset) const
DWARFContext & getContext() const
Definition DWARFUnit.h:323
DWARFDie getDIEForOffset(uint64_t Offset)
Return the DIE object for a given offset Offset inside the unit's DIE vector.
Definition DWARFUnit.h:537
const DWARFUnitVector & getUnitVector() const
Return the DWARFUnitVector containing this unit.
Definition DWARFUnit.h:505
LLVM_ABI uint64_t getULEB128(uint64_t *offset_ptr, llvm::Error *Err=nullptr) const
Extract a unsigned LEB128 value from *offset_ptr.
bool isValidOffset(uint64_t offset) const
Test the validity of offset.
Tagged union holding either a T or a Error.
Definition Error.h:485
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
SmallSet - This maintains a set of unique values, optimizing for the case when the set is small (less...
Definition SmallSet.h:133
std::pair< const_iterator, bool > insert(const T &V)
insert - Insert an element into the set if it isn't already there.
Definition SmallSet.h:183
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
constexpr bool empty() const
empty - Check if the string is empty.
Definition StringRef.h:143
LLVM Value Representation.
Definition Value.h:75
An RAII object that temporarily switches an output stream to a specific color.
Definition WithColor.h:54
raw_ostream & get()
Definition WithColor.h:79
A range adaptor for a pair of iterators.
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
raw_ostream & indent(unsigned NumSpaces)
indent - Insert 'NumSpaces' spaces.
A raw_ostream that writes to an std::string.
LLVM_ABI StringRef AttributeString(unsigned Attribute)
Definition Dwarf.cpp:72
LLVM_ABI StringRef FormEncodingString(unsigned Encoding)
Definition Dwarf.cpp:105
LLVM_ABI StringRef ApplePropertyString(unsigned)
Definition Dwarf.cpp:792
Calculates the starting offsets for various sections within the .debug_names section.
Definition Dwarf.h:35
Attribute
Attributes.
Definition Dwarf.h:125
SourceLanguageName
Definition Dwarf.h:223
std::optional< const char * > toString(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract a string value from it.
std::optional< object::SectionedAddress > toSectionedAddress(const std::optional< DWARFFormValue > &V)
std::optional< uint64_t > toSectionOffset(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract an section offset.
LLVM_ABI StringRef AttributeValueString(uint16_t Attr, unsigned Val)
Returns the symbolic string representing Val when used as a value for attribute Attr.
Definition Dwarf.cpp:866
uint64_t computeTombstoneAddress(uint8_t AddressByteSize)
Definition Dwarf.h:1242
LLVM_ABI llvm::StringRef LanguageDescription(SourceLanguageName name)
Returns a version-independent language name.
Definition Dwarf.cpp:465
std::optional< uint64_t > toUnsigned(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract an unsigned constant.
This is an optimization pass for GlobalISel generic memory operations.
@ Offset
Definition DWP.cpp:477
LLVM_ABI std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
Definition Error.cpp:98
LLVM_ABI void printDwarfExpression(const DWARFExpression *E, raw_ostream &OS, DIDumpOptions DumpOpts, DWARFUnit *U, bool IsEH=false)
Print a Dwarf expression/.
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
Definition Error.h:1305
int countr_zero(T Val)
Count number of 0's from the least significant bit to the most stopping at the first 1.
Definition bit.h:202
@ invalid_argument
Definition Errc.h:56
auto formatv(bool Validate, const char *Fmt, Ts &&...Vals)
SmallVector< ValueTypeFromRangeType< R >, Size > to_vector(R &&Range)
Given a range of type R, iterate the entire range and return a SmallVector with elements of the vecto...
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Definition Format.h:129
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
LLVM_ABI void dumpTypeQualifiedName(const DWARFDie &DIE, raw_ostream &OS)
Definition DWARFDie.cpp:835
FunctionAddr VTableAddr uintptr_t uintptr_t Data
Definition InstrProf.h:189
DINameKind
A DINameKind is passed to name search methods to specify a preference regarding the type of name reso...
Definition DIContext.h:142
std::string toString(const APInt &I, unsigned Radix, bool Signed, bool formatAsCLiteral=false, bool UpperCase=true, bool InsertSeparators=false)
LLVM_ABI void dumpTypeUnqualifiedName(const DWARFDie &DIE, raw_ostream &OS, std::string *OriginalFullName=nullptr)
Definition DWARFDie.cpp:839
void consumeError(Error Err)
Consume a Error without doing anything.
Definition Error.h:1083
std::vector< DWARFAddressRange > DWARFAddressRangesVector
DWARFAddressRangesVector - represents a set of absolute address ranges.
std::vector< DWARFLocationExpression > DWARFLocationExpressionsVector
Represents a set of absolute location expressions.
Container for dump options that control which debug information will be dumped.
Definition DIContext.h:196
std::function< void(Error)> RecoverableErrorHandler
Definition DIContext.h:235
unsigned ChildRecurseDepth
Definition DIContext.h:198
unsigned ParentRecurseDepth
Definition DIContext.h:199
Encapsulates a DWARF attribute value and all of the data required to describe the attribute value.
static LLVM_ABI bool mayHaveLocationList(dwarf::Attribute Attr)
Identify DWARF attributes that may contain a pointer to a location list.
Definition DWARFDie.cpp:777
DWARFFormValue Value
The form and value for this attribute.
static LLVM_ABI bool mayHaveLocationExpr(dwarf::Attribute Attr)
Identifies DWARF attributes that may contain a reference to a DWARF expression.
Definition DWARFDie.cpp:794
dwarf::Attribute Attr
The attribute enumeration of this attribute.
Represents a single DWARF expression, whose value is location-dependent.
void appendQualifiedName(DieType D)
void appendUnqualifiedName(DieType D, std::string *OriginalFullName=nullptr)
Recursively append the DIE type name when applicable.