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 "DWARFDebugInfoEntry.h"
11 #include "DWARFCompileUnit.h"
12 #include "DWARFContext.h"
13 #include "DWARFDebugAbbrev.h"
14 #include "llvm/DebugInfo/DWARFFormValue.h"
15 #include "llvm/Support/Debug.h"
16 #include "llvm/Support/Dwarf.h"
17 #include "llvm/Support/Format.h"
18 #include "llvm/Support/raw_ostream.h"
20 using namespace dwarf;
21 typedef DILineInfoSpecifier::FunctionNameKind FunctionNameKind;
23 void DWARFDebugInfoEntryMinimal::dump(raw_ostream &OS, const DWARFUnit *u,
24 unsigned recurseDepth,
25 unsigned indent) const {
26 DataExtractor debug_info_data = u->getDebugInfoExtractor();
27 uint32_t offset = Offset;
29 if (debug_info_data.isValidOffset(offset)) {
30 uint32_t abbrCode = debug_info_data.getULEB128(&offset);
32 OS << format("\n0x%8.8x: ", Offset);
35 const char *tagString = TagString(getTag());
37 OS.indent(indent) << tagString;
39 OS.indent(indent) << format("DW_TAG_Unknown_%x", getTag());
40 OS << format(" [%u] %c\n", abbrCode,
41 AbbrevDecl->hasChildren() ? '*' : ' ');
43 // Dump all data in the DIE for the attributes.
44 for (const auto &AttrSpec : AbbrevDecl->attributes()) {
45 dumpAttribute(OS, u, &offset, AttrSpec.Attr, AttrSpec.Form, indent);
48 const DWARFDebugInfoEntryMinimal *child = getFirstChild();
49 if (recurseDepth > 0 && child) {
51 child->dump(OS, u, recurseDepth-1, indent+2);
52 child = child->getSibling();
56 OS << "Abbreviation code not found in 'debug_abbrev' class for code: "
60 OS.indent(indent) << "NULL\n";
65 void DWARFDebugInfoEntryMinimal::dumpAttribute(raw_ostream &OS,
68 uint16_t attr, uint16_t form,
69 unsigned indent) const {
72 const char *attrString = AttributeString(attr);
76 OS << format("DW_AT_Unknown_%x", attr);
77 const char *formString = FormEncodingString(form);
79 OS << " [" << formString << ']';
81 OS << format(" [DW_FORM_Unknown_%x]", form);
83 DWARFFormValue formValue(form);
85 if (!formValue.extractValue(u->getDebugInfoExtractor(), offset_ptr, u))
90 const char *Name = nullptr;
91 if (Optional<uint64_t> Val = formValue.getAsUnsignedConstant())
92 Name = AttributeValueString(attr, *Val);
96 } else if (attr == DW_AT_decl_line || attr == DW_AT_call_line) {
97 OS << *formValue.getAsUnsignedConstant();
99 formValue.dump(OS, u);
105 bool DWARFDebugInfoEntryMinimal::extractFast(const DWARFUnit *U,
106 uint32_t *OffsetPtr) {
108 DataExtractor DebugInfoData = U->getDebugInfoExtractor();
109 uint32_t UEndOffset = U->getNextUnitOffset();
110 if (Offset >= UEndOffset || !DebugInfoData.isValidOffset(Offset))
112 uint64_t AbbrCode = DebugInfoData.getULEB128(OffsetPtr);
114 // NULL debug tag entry.
115 AbbrevDecl = nullptr;
118 AbbrevDecl = U->getAbbreviations()->getAbbreviationDeclaration(AbbrCode);
119 if (nullptr == AbbrevDecl) {
120 // Restore the original offset.
124 ArrayRef<uint8_t> FixedFormSizes = DWARFFormValue::getFixedFormSizes(
125 U->getAddressByteSize(), U->getVersion());
126 assert(FixedFormSizes.size() > 0);
128 // Skip all data in the .debug_info for the attributes
129 for (const auto &AttrSpec : AbbrevDecl->attributes()) {
130 uint16_t Form = AttrSpec.Form;
132 uint8_t FixedFormSize =
133 (Form < FixedFormSizes.size()) ? FixedFormSizes[Form] : 0;
135 *OffsetPtr += FixedFormSize;
136 else if (!DWARFFormValue::skipValue(Form, DebugInfoData, OffsetPtr, U)) {
137 // Restore the original offset.
145 bool DWARFDebugInfoEntryMinimal::isSubprogramDIE() const {
146 return getTag() == DW_TAG_subprogram;
149 bool DWARFDebugInfoEntryMinimal::isSubroutineDIE() const {
150 uint32_t Tag = getTag();
151 return Tag == DW_TAG_subprogram ||
152 Tag == DW_TAG_inlined_subroutine;
155 bool DWARFDebugInfoEntryMinimal::getAttributeValue(
156 const DWARFUnit *U, const uint16_t Attr, DWARFFormValue &FormValue) const {
160 uint32_t AttrIdx = AbbrevDecl->findAttributeIndex(Attr);
164 DataExtractor DebugInfoData = U->getDebugInfoExtractor();
165 uint32_t DebugInfoOffset = getOffset();
167 // Skip the abbreviation code so we are at the data for the attributes
168 DebugInfoData.getULEB128(&DebugInfoOffset);
170 // Skip preceding attribute values.
171 for (uint32_t i = 0; i < AttrIdx; ++i) {
172 DWARFFormValue::skipValue(AbbrevDecl->getFormByIndex(i),
173 DebugInfoData, &DebugInfoOffset, U);
176 FormValue = DWARFFormValue(AbbrevDecl->getFormByIndex(AttrIdx));
177 return FormValue.extractValue(DebugInfoData, &DebugInfoOffset, U);
180 const char *DWARFDebugInfoEntryMinimal::getAttributeValueAsString(
181 const DWARFUnit *U, const uint16_t Attr, const char *FailValue) const {
182 DWARFFormValue FormValue;
183 if (!getAttributeValue(U, Attr, FormValue))
185 Optional<const char *> Result = FormValue.getAsCString(U);
186 return Result.hasValue() ? Result.getValue() : FailValue;
189 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsAddress(
190 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
191 DWARFFormValue FormValue;
192 if (!getAttributeValue(U, Attr, FormValue))
194 Optional<uint64_t> Result = FormValue.getAsAddress(U);
195 return Result.hasValue() ? Result.getValue() : FailValue;
198 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsUnsignedConstant(
199 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
200 DWARFFormValue FormValue;
201 if (!getAttributeValue(U, Attr, FormValue))
203 Optional<uint64_t> Result = FormValue.getAsUnsignedConstant();
204 return Result.hasValue() ? Result.getValue() : FailValue;
207 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsReference(
208 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
209 DWARFFormValue FormValue;
210 if (!getAttributeValue(U, Attr, FormValue))
212 Optional<uint64_t> Result = FormValue.getAsReference(U);
213 return Result.hasValue() ? Result.getValue() : FailValue;
216 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsSectionOffset(
217 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
218 DWARFFormValue FormValue;
219 if (!getAttributeValue(U, Attr, FormValue))
221 Optional<uint64_t> Result = FormValue.getAsSectionOffset();
222 return Result.hasValue() ? Result.getValue() : FailValue;
226 DWARFDebugInfoEntryMinimal::getRangesBaseAttribute(const DWARFUnit *U,
227 uint64_t FailValue) const {
229 getAttributeValueAsSectionOffset(U, DW_AT_ranges_base, -1ULL);
232 return getAttributeValueAsSectionOffset(U, DW_AT_GNU_ranges_base, FailValue);
235 bool DWARFDebugInfoEntryMinimal::getLowAndHighPC(const DWARFUnit *U,
237 uint64_t &HighPC) const {
238 LowPC = getAttributeValueAsAddress(U, DW_AT_low_pc, -1ULL);
241 HighPC = getAttributeValueAsAddress(U, DW_AT_high_pc, -1ULL);
242 if (HighPC == -1ULL) {
243 // Since DWARF4, DW_AT_high_pc may also be of class constant, in which case
244 // it represents function size.
245 HighPC = getAttributeValueAsUnsignedConstant(U, DW_AT_high_pc, -1ULL);
249 return (HighPC != -1ULL);
252 DWARFAddressRangesVector
253 DWARFDebugInfoEntryMinimal::getAddressRanges(const DWARFUnit *U) const {
255 return DWARFAddressRangesVector();
256 // Single range specified by low/high PC.
257 uint64_t LowPC, HighPC;
258 if (getLowAndHighPC(U, LowPC, HighPC)) {
259 return DWARFAddressRangesVector(1, std::make_pair(LowPC, HighPC));
261 // Multiple ranges from .debug_ranges section.
262 uint32_t RangesOffset =
263 getAttributeValueAsSectionOffset(U, DW_AT_ranges, -1U);
264 if (RangesOffset != -1U) {
265 DWARFDebugRangeList RangeList;
266 if (U->extractRangeList(RangesOffset, RangeList))
267 return RangeList.getAbsoluteRanges(U->getBaseAddress());
269 return DWARFAddressRangesVector();
272 void DWARFDebugInfoEntryMinimal::collectChildrenAddressRanges(
273 const DWARFUnit *U, DWARFAddressRangesVector& Ranges) const {
276 if (isSubprogramDIE()) {
277 const auto &DIERanges = getAddressRanges(U);
278 Ranges.insert(Ranges.end(), DIERanges.begin(), DIERanges.end());
281 const DWARFDebugInfoEntryMinimal *Child = getFirstChild();
283 Child->collectChildrenAddressRanges(U, Ranges);
284 Child = Child->getSibling();
288 bool DWARFDebugInfoEntryMinimal::addressRangeContainsAddress(
289 const DWARFUnit *U, const uint64_t Address) const {
290 for (const auto& R : getAddressRanges(U)) {
291 if (R.first <= Address && Address < R.second)
298 DWARFDebugInfoEntryMinimal::getSubroutineName(const DWARFUnit *U,
299 FunctionNameKind Kind) const {
300 if (!isSubroutineDIE() || Kind == FunctionNameKind::None)
302 // Try to get mangled name only if it was asked for.
303 if (Kind == FunctionNameKind::LinkageName) {
304 if (const char *name =
305 getAttributeValueAsString(U, DW_AT_MIPS_linkage_name, nullptr))
307 if (const char *name =
308 getAttributeValueAsString(U, DW_AT_linkage_name, nullptr))
311 if (const char *name = getAttributeValueAsString(U, DW_AT_name, nullptr))
313 // Try to get name from specification DIE.
315 getAttributeValueAsReference(U, DW_AT_specification, -1U);
316 if (spec_ref != -1U) {
317 DWARFDebugInfoEntryMinimal spec_die;
318 if (spec_die.extractFast(U, &spec_ref)) {
319 if (const char *name = spec_die.getSubroutineName(U, Kind))
323 // Try to get name from abstract origin DIE.
324 uint32_t abs_origin_ref =
325 getAttributeValueAsReference(U, DW_AT_abstract_origin, -1U);
326 if (abs_origin_ref != -1U) {
327 DWARFDebugInfoEntryMinimal abs_origin_die;
328 if (abs_origin_die.extractFast(U, &abs_origin_ref)) {
329 if (const char *name = abs_origin_die.getSubroutineName(U, Kind))
336 void DWARFDebugInfoEntryMinimal::getCallerFrame(const DWARFUnit *U,
339 uint32_t &CallColumn) const {
340 CallFile = getAttributeValueAsUnsignedConstant(U, DW_AT_call_file, 0);
341 CallLine = getAttributeValueAsUnsignedConstant(U, DW_AT_call_line, 0);
342 CallColumn = getAttributeValueAsUnsignedConstant(U, DW_AT_call_column, 0);
345 DWARFDebugInfoEntryInlinedChain
346 DWARFDebugInfoEntryMinimal::getInlinedChainForAddress(
347 const DWARFUnit *U, const uint64_t Address) const {
348 DWARFDebugInfoEntryInlinedChain InlinedChain;
352 for (const DWARFDebugInfoEntryMinimal *DIE = this; DIE; ) {
353 // Append current DIE to inlined chain only if it has correct tag
354 // (e.g. it is not a lexical block).
355 if (DIE->isSubroutineDIE()) {
356 InlinedChain.DIEs.push_back(*DIE);
358 // Try to get child which also contains provided address.
359 const DWARFDebugInfoEntryMinimal *Child = DIE->getFirstChild();
361 if (Child->addressRangeContainsAddress(U, Address)) {
362 // Assume there is only one such child.
365 Child = Child->getSibling();
369 // Reverse the obtained chain to make the root of inlined chain last.
370 std::reverse(InlinedChain.DIEs.begin(), InlinedChain.DIEs.end());