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;
22 void DWARFDebugInfoEntryMinimal::dump(raw_ostream &OS, const DWARFUnit *u,
23 unsigned recurseDepth,
24 unsigned indent) const {
25 DataExtractor debug_info_data = u->getDebugInfoExtractor();
26 uint32_t offset = Offset;
28 if (debug_info_data.isValidOffset(offset)) {
29 uint32_t abbrCode = debug_info_data.getULEB128(&offset);
31 OS << format("\n0x%8.8x: ", Offset);
34 const char *tagString = TagString(getTag());
36 OS.indent(indent) << tagString;
38 OS.indent(indent) << format("DW_TAG_Unknown_%x", getTag());
39 OS << format(" [%u] %c\n", abbrCode,
40 AbbrevDecl->hasChildren() ? '*' : ' ');
42 // Dump all data in the DIE for the attributes.
43 const uint32_t numAttributes = AbbrevDecl->getNumAttributes();
44 for (uint32_t i = 0; i != numAttributes; ++i) {
45 uint16_t attr = AbbrevDecl->getAttrByIndex(i);
46 uint16_t form = AbbrevDecl->getFormByIndex(i);
47 dumpAttribute(OS, u, &offset, attr, form, indent);
50 const DWARFDebugInfoEntryMinimal *child = getFirstChild();
51 if (recurseDepth > 0 && child) {
53 child->dump(OS, u, recurseDepth-1, indent+2);
54 child = child->getSibling();
58 OS << "Abbreviation code not found in 'debug_abbrev' class for code: "
62 OS.indent(indent) << "NULL\n";
67 void DWARFDebugInfoEntryMinimal::dumpAttribute(raw_ostream &OS,
70 uint16_t attr, uint16_t form,
71 unsigned indent) const {
74 const char *attrString = AttributeString(attr);
78 OS << format("DW_AT_Unknown_%x", attr);
79 const char *formString = FormEncodingString(form);
81 OS << " [" << formString << ']';
83 OS << format(" [DW_FORM_Unknown_%x]", form);
85 DWARFFormValue formValue(form);
87 if (!formValue.extractValue(u->getDebugInfoExtractor(), offset_ptr, u))
91 formValue.dump(OS, u);
95 bool DWARFDebugInfoEntryMinimal::extractFast(const DWARFUnit *U,
96 uint32_t *OffsetPtr) {
98 DataExtractor DebugInfoData = U->getDebugInfoExtractor();
99 uint64_t AbbrCode = DebugInfoData.getULEB128(OffsetPtr);
101 // NULL debug tag entry.
105 AbbrevDecl = U->getAbbreviations()->getAbbreviationDeclaration(AbbrCode);
107 ArrayRef<uint8_t> FixedFormSizes = DWARFFormValue::getFixedFormSizes(
108 U->getAddressByteSize(), U->getVersion());
109 assert(FixedFormSizes.size() > 0);
111 // Skip all data in the .debug_info for the attributes
112 for (uint32_t i = 0, n = AbbrevDecl->getNumAttributes(); i < n; ++i) {
113 uint16_t Form = AbbrevDecl->getFormByIndex(i);
115 uint8_t FixedFormSize =
116 (Form < FixedFormSizes.size()) ? FixedFormSizes[Form] : 0;
118 *OffsetPtr += FixedFormSize;
119 else if (!DWARFFormValue::skipValue(Form, DebugInfoData, OffsetPtr, U)) {
120 // Restore the original offset.
128 bool DWARFDebugInfoEntryMinimal::extract(const DWARFUnit *U,
129 uint32_t *OffsetPtr) {
130 DataExtractor DebugInfoData = U->getDebugInfoExtractor();
131 const uint32_t UEndOffset = U->getNextUnitOffset();
133 if ((Offset >= UEndOffset) || !DebugInfoData.isValidOffset(Offset))
135 uint64_t AbbrCode = DebugInfoData.getULEB128(OffsetPtr);
137 // NULL debug tag entry.
141 AbbrevDecl = U->getAbbreviations()->getAbbreviationDeclaration(AbbrCode);
142 if (0 == AbbrevDecl) {
143 // Restore the original offset.
147 bool IsCompileUnitTag = (AbbrevDecl->getTag() == DW_TAG_compile_unit);
148 if (IsCompileUnitTag)
149 const_cast<DWARFUnit *>(U)->setBaseAddress(0);
151 // Skip all data in the .debug_info for the attributes
152 for (uint32_t i = 0, n = AbbrevDecl->getNumAttributes(); i < n; ++i) {
153 uint16_t Attr = AbbrevDecl->getAttrByIndex(i);
154 uint16_t Form = AbbrevDecl->getFormByIndex(i);
156 if (IsCompileUnitTag &&
157 ((Attr == DW_AT_entry_pc) || (Attr == DW_AT_low_pc))) {
158 DWARFFormValue FormValue(Form);
159 if (FormValue.extractValue(DebugInfoData, OffsetPtr, U)) {
160 if (Attr == DW_AT_low_pc || Attr == DW_AT_entry_pc) {
161 Optional<uint64_t> BaseAddr = FormValue.getAsAddress(U);
162 if (BaseAddr.hasValue())
163 const_cast<DWARFUnit *>(U)->setBaseAddress(BaseAddr.getValue());
166 } else if (!DWARFFormValue::skipValue(Form, DebugInfoData, OffsetPtr, U)) {
167 // Restore the original offset.
175 bool DWARFDebugInfoEntryMinimal::isSubprogramDIE() const {
176 return getTag() == DW_TAG_subprogram;
179 bool DWARFDebugInfoEntryMinimal::isSubroutineDIE() const {
180 uint32_t Tag = getTag();
181 return Tag == DW_TAG_subprogram ||
182 Tag == DW_TAG_inlined_subroutine;
185 bool DWARFDebugInfoEntryMinimal::getAttributeValue(
186 const DWARFUnit *U, const uint16_t Attr, DWARFFormValue &FormValue) const {
190 uint32_t AttrIdx = AbbrevDecl->findAttributeIndex(Attr);
194 DataExtractor DebugInfoData = U->getDebugInfoExtractor();
195 uint32_t DebugInfoOffset = getOffset();
197 // Skip the abbreviation code so we are at the data for the attributes
198 DebugInfoData.getULEB128(&DebugInfoOffset);
200 // Skip preceding attribute values.
201 for (uint32_t i = 0; i < AttrIdx; ++i) {
202 DWARFFormValue::skipValue(AbbrevDecl->getFormByIndex(i),
203 DebugInfoData, &DebugInfoOffset, U);
206 FormValue = DWARFFormValue(AbbrevDecl->getFormByIndex(AttrIdx));
207 return FormValue.extractValue(DebugInfoData, &DebugInfoOffset, U);
210 const char *DWARFDebugInfoEntryMinimal::getAttributeValueAsString(
211 const DWARFUnit *U, const uint16_t Attr, const char *FailValue) const {
212 DWARFFormValue FormValue;
213 if (!getAttributeValue(U, Attr, FormValue))
215 Optional<const char *> Result = FormValue.getAsCString(U);
216 return Result.hasValue() ? Result.getValue() : FailValue;
219 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsAddress(
220 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
221 DWARFFormValue FormValue;
222 if (!getAttributeValue(U, Attr, FormValue))
224 Optional<uint64_t> Result = FormValue.getAsAddress(U);
225 return Result.hasValue() ? Result.getValue() : FailValue;
228 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsUnsignedConstant(
229 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
230 DWARFFormValue FormValue;
231 if (!getAttributeValue(U, Attr, FormValue))
233 Optional<uint64_t> Result = FormValue.getAsUnsignedConstant();
234 return Result.hasValue() ? Result.getValue() : FailValue;
237 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsReference(
238 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
239 DWARFFormValue FormValue;
240 if (!getAttributeValue(U, Attr, FormValue))
242 Optional<uint64_t> Result = FormValue.getAsReference(U);
243 return Result.hasValue() ? Result.getValue() : FailValue;
246 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsSectionOffset(
247 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
248 DWARFFormValue FormValue;
249 if (!getAttributeValue(U, Attr, FormValue))
251 Optional<uint64_t> Result = FormValue.getAsSectionOffset();
252 return Result.hasValue() ? Result.getValue() : FailValue;
255 bool DWARFDebugInfoEntryMinimal::getLowAndHighPC(const DWARFUnit *U,
257 uint64_t &HighPC) const {
258 LowPC = getAttributeValueAsAddress(U, DW_AT_low_pc, -1ULL);
261 HighPC = getAttributeValueAsAddress(U, DW_AT_high_pc, -1ULL);
262 if (HighPC == -1ULL) {
263 // Since DWARF4, DW_AT_high_pc may also be of class constant, in which case
264 // it represents function size.
265 HighPC = getAttributeValueAsUnsignedConstant(U, DW_AT_high_pc, -1ULL);
269 return (HighPC != -1ULL);
272 void DWARFDebugInfoEntryMinimal::buildAddressRangeTable(
273 const DWARFUnit *U, DWARFDebugAranges *DebugAranges,
274 uint32_t UOffsetInAranges) const {
276 if (isSubprogramDIE()) {
277 uint64_t LowPC, HighPC;
278 if (getLowAndHighPC(U, LowPC, HighPC))
279 DebugAranges->appendRange(UOffsetInAranges, LowPC, HighPC);
280 // FIXME: try to append ranges from .debug_ranges section.
283 const DWARFDebugInfoEntryMinimal *Child = getFirstChild();
285 Child->buildAddressRangeTable(U, DebugAranges, UOffsetInAranges);
286 Child = Child->getSibling();
291 bool DWARFDebugInfoEntryMinimal::addressRangeContainsAddress(
292 const DWARFUnit *U, const uint64_t Address) const {
295 uint64_t LowPC, HighPC;
296 if (getLowAndHighPC(U, LowPC, HighPC))
297 return (LowPC <= Address && Address <= HighPC);
298 // Try to get address ranges from .debug_ranges section.
299 uint32_t RangesOffset =
300 getAttributeValueAsSectionOffset(U, DW_AT_ranges, -1U);
301 if (RangesOffset != -1U) {
302 DWARFDebugRangeList RangeList;
303 if (U->extractRangeList(RangesOffset, RangeList))
304 return RangeList.containsAddress(U->getBaseAddress(), Address);
310 DWARFDebugInfoEntryMinimal::getSubroutineName(const DWARFUnit *U) const {
311 if (!isSubroutineDIE())
313 // Try to get mangled name if possible.
314 if (const char *name =
315 getAttributeValueAsString(U, DW_AT_MIPS_linkage_name, 0))
317 if (const char *name = getAttributeValueAsString(U, DW_AT_linkage_name, 0))
319 if (const char *name = getAttributeValueAsString(U, DW_AT_name, 0))
321 // Try to get name from specification DIE.
323 getAttributeValueAsReference(U, DW_AT_specification, -1U);
324 if (spec_ref != -1U) {
325 DWARFDebugInfoEntryMinimal spec_die;
326 if (spec_die.extract(U, &spec_ref)) {
327 if (const char *name = spec_die.getSubroutineName(U))
331 // Try to get name from abstract origin DIE.
332 uint32_t abs_origin_ref =
333 getAttributeValueAsReference(U, DW_AT_abstract_origin, -1U);
334 if (abs_origin_ref != -1U) {
335 DWARFDebugInfoEntryMinimal abs_origin_die;
336 if (abs_origin_die.extract(U, &abs_origin_ref)) {
337 if (const char *name = abs_origin_die.getSubroutineName(U))
344 void DWARFDebugInfoEntryMinimal::getCallerFrame(const DWARFUnit *U,
347 uint32_t &CallColumn) const {
348 CallFile = getAttributeValueAsUnsignedConstant(U, DW_AT_call_file, 0);
349 CallLine = getAttributeValueAsUnsignedConstant(U, DW_AT_call_line, 0);
350 CallColumn = getAttributeValueAsUnsignedConstant(U, DW_AT_call_column, 0);
353 DWARFDebugInfoEntryInlinedChain
354 DWARFDebugInfoEntryMinimal::getInlinedChainForAddress(
355 const DWARFUnit *U, const uint64_t Address) const {
356 DWARFDebugInfoEntryInlinedChain InlinedChain;
360 for (const DWARFDebugInfoEntryMinimal *DIE = this; DIE; ) {
361 // Append current DIE to inlined chain only if it has correct tag
362 // (e.g. it is not a lexical block).
363 if (DIE->isSubroutineDIE()) {
364 InlinedChain.DIEs.push_back(*DIE);
366 // Try to get child which also contains provided address.
367 const DWARFDebugInfoEntryMinimal *Child = DIE->getFirstChild();
369 if (Child->addressRangeContainsAddress(U, Address)) {
370 // Assume there is only one such child.
373 Child = Child->getSibling();
377 // Reverse the obtained chain to make the root of inlined chain last.
378 std::reverse(InlinedChain.DIEs.begin(), InlinedChain.DIEs.end());