1 //===-- DWARFDebugInfoEntry.cpp -------------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "SyntaxHighlighting.h"
11 #include "llvm/DebugInfo/DWARFDebugInfoEntry.h"
12 #include "llvm/DebugInfo/DWARFCompileUnit.h"
13 #include "llvm/DebugInfo/DWARFContext.h"
14 #include "llvm/DebugInfo/DWARFDebugAbbrev.h"
15 #include "llvm/DebugInfo/DWARFFormValue.h"
16 #include "llvm/Support/DataTypes.h"
17 #include "llvm/Support/Debug.h"
18 #include "llvm/Support/Dwarf.h"
19 #include "llvm/Support/Format.h"
20 #include "llvm/Support/raw_ostream.h"
22 using namespace dwarf;
23 using namespace syntax;
25 // Small helper to extract a DIE pointed by a reference
26 // attribute. It looks up the Unit containing the DIE and calls
27 // DIE.extractFast with the right unit. Returns new unit on success,
29 static const DWARFUnit *findUnitAndExtractFast(DWARFDebugInfoEntryMinimal &DIE,
30 const DWARFUnit *Unit,
32 Unit = Unit->getUnitSection().getUnitForOffset(*Offset);
33 return (Unit && DIE.extractFast(Unit, Offset)) ? Unit : nullptr;
36 void DWARFDebugInfoEntryMinimal::dump(raw_ostream &OS, DWARFUnit *u,
37 unsigned recurseDepth,
38 unsigned indent) const {
39 DataExtractor debug_info_data = u->getDebugInfoExtractor();
40 uint32_t offset = Offset;
42 if (debug_info_data.isValidOffset(offset)) {
43 uint32_t abbrCode = debug_info_data.getULEB128(&offset);
44 WithColor(OS, syntax::Address).get() << format("\n0x%8.8x: ", Offset);
48 const char *tagString = TagString(getTag());
50 WithColor(OS, syntax::Tag).get().indent(indent) << tagString;
52 WithColor(OS, syntax::Tag).get().indent(indent) <<
53 format("DW_TAG_Unknown_%x", getTag());
55 OS << format(" [%u] %c\n", abbrCode,
56 AbbrevDecl->hasChildren() ? '*' : ' ');
58 // Dump all data in the DIE for the attributes.
59 for (const auto &AttrSpec : AbbrevDecl->attributes()) {
60 dumpAttribute(OS, u, &offset, AttrSpec.Attr, AttrSpec.Form, indent);
63 const DWARFDebugInfoEntryMinimal *child = getFirstChild();
64 if (recurseDepth > 0 && child) {
66 child->dump(OS, u, recurseDepth-1, indent+2);
67 child = child->getSibling();
71 OS << "Abbreviation code not found in 'debug_abbrev' class for code: "
75 OS.indent(indent) << "NULL\n";
80 static void dumpApplePropertyAttribute(raw_ostream &OS, uint64_t Val) {
83 uint64_t Shift = countTrailingZeros(Val);
84 assert(Shift < 64 && "undefined behavior");
85 uint64_t Bit = 1ULL << Shift;
86 if (const char *PropName = ApplePropertyString(Bit))
89 OS << format("DW_APPLE_PROPERTY_0x%" PRIx64, Bit);
97 static void dumpRanges(raw_ostream &OS, const DWARFAddressRangesVector& Ranges,
98 unsigned AddressSize, unsigned Indent) {
102 for (const auto &Range: Ranges) {
105 OS << format("[0x%0*" PRIx64 " - 0x%0*" PRIx64 ")",
106 AddressSize*2, Range.first,
107 AddressSize*2, Range.second);
111 void DWARFDebugInfoEntryMinimal::dumpAttribute(raw_ostream &OS,
113 uint32_t *offset_ptr,
114 uint16_t attr, uint16_t form,
115 unsigned indent) const {
116 const char BaseIndent[] = " ";
119 const char *attrString = AttributeString(attr);
121 WithColor(OS, syntax::Attribute) << attrString;
123 WithColor(OS, syntax::Attribute).get() << format("DW_AT_Unknown_%x", attr);
125 const char *formString = FormEncodingString(form);
127 OS << " [" << formString << ']';
129 OS << format(" [DW_FORM_Unknown_%x]", form);
131 DWARFFormValue formValue(form);
133 if (!formValue.extractValue(u->getDebugInfoExtractor(), offset_ptr, u))
138 const char *Name = nullptr;
140 auto Color = syntax::Enumerator;
141 if (attr == DW_AT_decl_file || attr == DW_AT_call_file) {
142 Color = syntax::String;
143 if (const auto *LT = u->getContext().getLineTableForUnit(u))
144 if (LT->getFileNameByIndex(
145 formValue.getAsUnsignedConstant().getValue(),
146 u->getCompilationDir(),
147 DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath, File)) {
148 File = '"' + File + '"';
151 } else if (Optional<uint64_t> Val = formValue.getAsUnsignedConstant())
152 Name = AttributeValueString(attr, *Val);
155 WithColor(OS, Color) << Name;
156 else if (attr == DW_AT_decl_line || attr == DW_AT_call_line)
157 OS << *formValue.getAsUnsignedConstant();
159 formValue.dump(OS, u);
161 // We have dumped the attribute raw value. For some attributes
162 // having both the raw value and the pretty-printed value is
163 // interesting. These attributes are handled below.
164 if ((attr == DW_AT_specification || attr == DW_AT_abstract_origin) &&
165 // The signature references aren't handled.
166 formValue.getForm() != DW_FORM_ref_sig8) {
167 uint32_t Ref = formValue.getAsReference(u).getValue();
168 DWARFDebugInfoEntryMinimal DIE;
169 if (const DWARFUnit *RefU = findUnitAndExtractFast(DIE, u, &Ref))
170 if (const char *Ref = DIE.getName(RefU, DINameKind::LinkageName))
171 OS << " \"" << Ref << '\"';
172 } else if (attr == DW_AT_APPLE_property_attribute) {
173 if (Optional<uint64_t> OptVal = formValue.getAsUnsignedConstant())
174 dumpApplePropertyAttribute(OS, *OptVal);
175 } else if (attr == DW_AT_ranges) {
176 dumpRanges(OS, getAddressRanges(u), u->getAddressByteSize(),
177 sizeof(BaseIndent)+indent+4);
183 bool DWARFDebugInfoEntryMinimal::extractFast(const DWARFUnit *U,
184 uint32_t *OffsetPtr) {
186 DataExtractor DebugInfoData = U->getDebugInfoExtractor();
187 uint32_t UEndOffset = U->getNextUnitOffset();
188 if (Offset >= UEndOffset || !DebugInfoData.isValidOffset(Offset))
190 uint64_t AbbrCode = DebugInfoData.getULEB128(OffsetPtr);
192 // NULL debug tag entry.
193 AbbrevDecl = nullptr;
196 AbbrevDecl = U->getAbbreviations()->getAbbreviationDeclaration(AbbrCode);
197 if (nullptr == AbbrevDecl) {
198 // Restore the original offset.
202 ArrayRef<uint8_t> FixedFormSizes = DWARFFormValue::getFixedFormSizes(
203 U->getAddressByteSize(), U->getVersion());
204 assert(FixedFormSizes.size() > 0);
206 // Skip all data in the .debug_info for the attributes
207 for (const auto &AttrSpec : AbbrevDecl->attributes()) {
208 uint16_t Form = AttrSpec.Form;
210 uint8_t FixedFormSize =
211 (Form < FixedFormSizes.size()) ? FixedFormSizes[Form] : 0;
213 *OffsetPtr += FixedFormSize;
214 else if (!DWARFFormValue::skipValue(Form, DebugInfoData, OffsetPtr, U)) {
215 // Restore the original offset.
223 bool DWARFDebugInfoEntryMinimal::isSubprogramDIE() const {
224 return getTag() == DW_TAG_subprogram;
227 bool DWARFDebugInfoEntryMinimal::isSubroutineDIE() const {
228 uint32_t Tag = getTag();
229 return Tag == DW_TAG_subprogram ||
230 Tag == DW_TAG_inlined_subroutine;
233 bool DWARFDebugInfoEntryMinimal::getAttributeValue(
234 const DWARFUnit *U, const uint16_t Attr, DWARFFormValue &FormValue) const {
238 uint32_t AttrIdx = AbbrevDecl->findAttributeIndex(Attr);
242 DataExtractor DebugInfoData = U->getDebugInfoExtractor();
243 uint32_t DebugInfoOffset = getOffset();
245 // Skip the abbreviation code so we are at the data for the attributes
246 DebugInfoData.getULEB128(&DebugInfoOffset);
248 // Skip preceding attribute values.
249 for (uint32_t i = 0; i < AttrIdx; ++i) {
250 DWARFFormValue::skipValue(AbbrevDecl->getFormByIndex(i),
251 DebugInfoData, &DebugInfoOffset, U);
254 FormValue = DWARFFormValue(AbbrevDecl->getFormByIndex(AttrIdx));
255 return FormValue.extractValue(DebugInfoData, &DebugInfoOffset, U);
258 const char *DWARFDebugInfoEntryMinimal::getAttributeValueAsString(
259 const DWARFUnit *U, const uint16_t Attr, const char *FailValue) const {
260 DWARFFormValue FormValue;
261 if (!getAttributeValue(U, Attr, FormValue))
263 Optional<const char *> Result = FormValue.getAsCString(U);
264 return Result.hasValue() ? Result.getValue() : FailValue;
267 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsAddress(
268 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
269 DWARFFormValue FormValue;
270 if (!getAttributeValue(U, Attr, FormValue))
272 Optional<uint64_t> Result = FormValue.getAsAddress(U);
273 return Result.hasValue() ? Result.getValue() : FailValue;
276 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsUnsignedConstant(
277 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
278 DWARFFormValue FormValue;
279 if (!getAttributeValue(U, Attr, FormValue))
281 Optional<uint64_t> Result = FormValue.getAsUnsignedConstant();
282 return Result.hasValue() ? Result.getValue() : FailValue;
285 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsReference(
286 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
287 DWARFFormValue FormValue;
288 if (!getAttributeValue(U, Attr, FormValue))
290 Optional<uint64_t> Result = FormValue.getAsReference(U);
291 return Result.hasValue() ? Result.getValue() : FailValue;
294 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsSectionOffset(
295 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
296 DWARFFormValue FormValue;
297 if (!getAttributeValue(U, Attr, FormValue))
299 Optional<uint64_t> Result = FormValue.getAsSectionOffset();
300 return Result.hasValue() ? Result.getValue() : FailValue;
304 DWARFDebugInfoEntryMinimal::getRangesBaseAttribute(const DWARFUnit *U,
305 uint64_t FailValue) const {
307 getAttributeValueAsSectionOffset(U, DW_AT_ranges_base, -1ULL);
310 return getAttributeValueAsSectionOffset(U, DW_AT_GNU_ranges_base, FailValue);
313 bool DWARFDebugInfoEntryMinimal::getLowAndHighPC(const DWARFUnit *U,
315 uint64_t &HighPC) const {
316 LowPC = getAttributeValueAsAddress(U, DW_AT_low_pc, -1ULL);
319 HighPC = getAttributeValueAsAddress(U, DW_AT_high_pc, -1ULL);
320 if (HighPC == -1ULL) {
321 // Since DWARF4, DW_AT_high_pc may also be of class constant, in which case
322 // it represents function size.
323 HighPC = getAttributeValueAsUnsignedConstant(U, DW_AT_high_pc, -1ULL);
327 return (HighPC != -1ULL);
330 DWARFAddressRangesVector
331 DWARFDebugInfoEntryMinimal::getAddressRanges(const DWARFUnit *U) const {
333 return DWARFAddressRangesVector();
334 // Single range specified by low/high PC.
335 uint64_t LowPC, HighPC;
336 if (getLowAndHighPC(U, LowPC, HighPC)) {
337 return DWARFAddressRangesVector(1, std::make_pair(LowPC, HighPC));
339 // Multiple ranges from .debug_ranges section.
340 uint32_t RangesOffset =
341 getAttributeValueAsSectionOffset(U, DW_AT_ranges, -1U);
342 if (RangesOffset != -1U) {
343 DWARFDebugRangeList RangeList;
344 if (U->extractRangeList(RangesOffset, RangeList))
345 return RangeList.getAbsoluteRanges(U->getBaseAddress());
347 return DWARFAddressRangesVector();
350 void DWARFDebugInfoEntryMinimal::collectChildrenAddressRanges(
351 const DWARFUnit *U, DWARFAddressRangesVector& Ranges) const {
354 if (isSubprogramDIE()) {
355 const auto &DIERanges = getAddressRanges(U);
356 Ranges.insert(Ranges.end(), DIERanges.begin(), DIERanges.end());
359 const DWARFDebugInfoEntryMinimal *Child = getFirstChild();
361 Child->collectChildrenAddressRanges(U, Ranges);
362 Child = Child->getSibling();
366 bool DWARFDebugInfoEntryMinimal::addressRangeContainsAddress(
367 const DWARFUnit *U, const uint64_t Address) const {
368 for (const auto& R : getAddressRanges(U)) {
369 if (R.first <= Address && Address < R.second)
376 DWARFDebugInfoEntryMinimal::getSubroutineName(const DWARFUnit *U,
377 DINameKind Kind) const {
378 if (!isSubroutineDIE())
380 return getName(U, Kind);
384 DWARFDebugInfoEntryMinimal::getName(const DWARFUnit *U,
385 DINameKind Kind) const {
386 if (Kind == DINameKind::None)
388 // Try to get mangled name only if it was asked for.
389 if (Kind == DINameKind::LinkageName) {
390 if (const char *name =
391 getAttributeValueAsString(U, DW_AT_MIPS_linkage_name, nullptr))
393 if (const char *name =
394 getAttributeValueAsString(U, DW_AT_linkage_name, nullptr))
397 if (const char *name = getAttributeValueAsString(U, DW_AT_name, nullptr))
399 // Try to get name from specification DIE.
401 getAttributeValueAsReference(U, DW_AT_specification, -1U);
402 if (spec_ref != -1U) {
403 DWARFDebugInfoEntryMinimal spec_die;
404 if (const DWARFUnit *RefU = findUnitAndExtractFast(spec_die, U, &spec_ref)) {
405 if (const char *name = spec_die.getName(RefU, Kind))
409 // Try to get name from abstract origin DIE.
410 uint32_t abs_origin_ref =
411 getAttributeValueAsReference(U, DW_AT_abstract_origin, -1U);
412 if (abs_origin_ref != -1U) {
413 DWARFDebugInfoEntryMinimal abs_origin_die;
414 if (const DWARFUnit *RefU = findUnitAndExtractFast(abs_origin_die, U,
416 if (const char *name = abs_origin_die.getName(RefU, Kind))
423 void DWARFDebugInfoEntryMinimal::getCallerFrame(const DWARFUnit *U,
426 uint32_t &CallColumn) const {
427 CallFile = getAttributeValueAsUnsignedConstant(U, DW_AT_call_file, 0);
428 CallLine = getAttributeValueAsUnsignedConstant(U, DW_AT_call_line, 0);
429 CallColumn = getAttributeValueAsUnsignedConstant(U, DW_AT_call_column, 0);
432 DWARFDebugInfoEntryInlinedChain
433 DWARFDebugInfoEntryMinimal::getInlinedChainForAddress(
434 const DWARFUnit *U, const uint64_t Address) const {
435 DWARFDebugInfoEntryInlinedChain InlinedChain;
439 for (const DWARFDebugInfoEntryMinimal *DIE = this; DIE; ) {
440 // Append current DIE to inlined chain only if it has correct tag
441 // (e.g. it is not a lexical block).
442 if (DIE->isSubroutineDIE()) {
443 InlinedChain.DIEs.push_back(*DIE);
445 // Try to get child which also contains provided address.
446 const DWARFDebugInfoEntryMinimal *Child = DIE->getFirstChild();
448 if (Child->addressRangeContainsAddress(U, Address)) {
449 // Assume there is only one such child.
452 Child = Child->getSibling();
456 // Reverse the obtained chain to make the root of inlined chain last.
457 std::reverse(InlinedChain.DIEs.begin(), InlinedChain.DIEs.end());