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 const uint8_t *FixedFormSizes,
97 uint32_t *OffsetPtr) {
99 DataExtractor DebugInfoData = U->getDebugInfoExtractor();
100 uint64_t AbbrCode = DebugInfoData.getULEB128(OffsetPtr);
102 // NULL debug tag entry.
106 AbbrevDecl = U->getAbbreviations()->getAbbreviationDeclaration(AbbrCode);
108 assert(FixedFormSizes); // For best performance this should be specified!
110 // Skip all data in the .debug_info for the attributes
111 for (uint32_t i = 0, n = AbbrevDecl->getNumAttributes(); i < n; ++i) {
112 uint16_t Form = AbbrevDecl->getFormByIndex(i);
114 // FIXME: Currently we're checking if this is less than the last
115 // entry in the fixed_form_sizes table, but this should be changed
116 // to use dynamic dispatch.
117 uint8_t FixedFormSize =
118 (Form < DW_FORM_ref_sig8) ? FixedFormSizes[Form] : 0;
120 *OffsetPtr += FixedFormSize;
121 else if (!DWARFFormValue::skipValue(Form, DebugInfoData, OffsetPtr,
123 // Restore the original offset.
131 bool DWARFDebugInfoEntryMinimal::extract(const DWARFUnit *U,
132 uint32_t *OffsetPtr) {
133 DataExtractor DebugInfoData = U->getDebugInfoExtractor();
134 const uint32_t UEndOffset = U->getNextUnitOffset();
136 if ((Offset >= UEndOffset) || !DebugInfoData.isValidOffset(Offset))
138 uint64_t AbbrCode = DebugInfoData.getULEB128(OffsetPtr);
140 // NULL debug tag entry.
144 AbbrevDecl = U->getAbbreviations()->getAbbreviationDeclaration(AbbrCode);
145 if (0 == AbbrevDecl) {
146 // Restore the original offset.
150 bool IsCompileUnitTag = (AbbrevDecl->getTag() == DW_TAG_compile_unit);
151 if (IsCompileUnitTag)
152 const_cast<DWARFUnit *>(U)->setBaseAddress(0);
154 // Skip all data in the .debug_info for the attributes
155 for (uint32_t i = 0, n = AbbrevDecl->getNumAttributes(); i < n; ++i) {
156 uint16_t Attr = AbbrevDecl->getAttrByIndex(i);
157 uint16_t Form = AbbrevDecl->getFormByIndex(i);
159 if (IsCompileUnitTag &&
160 ((Attr == DW_AT_entry_pc) || (Attr == DW_AT_low_pc))) {
161 DWARFFormValue FormValue(Form);
162 if (FormValue.extractValue(DebugInfoData, OffsetPtr, U)) {
163 if (Attr == DW_AT_low_pc || Attr == DW_AT_entry_pc)
164 const_cast<DWARFUnit *>(U)->setBaseAddress(FormValue.getUnsigned());
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 uint32_t DWARFDebugInfoEntryMinimal::getAttributeValue(
186 const DWARFUnit *u, const uint16_t attr, DWARFFormValue &form_value,
187 uint32_t *end_attr_offset_ptr) const {
189 uint32_t attr_idx = AbbrevDecl->findAttributeIndex(attr);
191 if (attr_idx != -1U) {
192 uint32_t offset = getOffset();
194 DataExtractor debug_info_data = u->getDebugInfoExtractor();
196 // Skip the abbreviation code so we are at the data for the attributes
197 debug_info_data.getULEB128(&offset);
200 while (idx < attr_idx)
201 DWARFFormValue::skipValue(AbbrevDecl->getFormByIndex(idx++),
202 debug_info_data, &offset, u);
204 const uint32_t attr_offset = offset;
205 form_value = DWARFFormValue(AbbrevDecl->getFormByIndex(idx));
206 if (form_value.extractValue(debug_info_data, &offset, u)) {
207 if (end_attr_offset_ptr)
208 *end_attr_offset_ptr = offset;
217 const char *DWARFDebugInfoEntryMinimal::getAttributeValueAsString(
218 const DWARFUnit *U, const uint16_t Attr, const char *FailValue) const {
219 DWARFFormValue FormValue;
220 if (getAttributeValue(U, Attr, FormValue))
221 return FormValue.getAsCString(U);
225 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsAddress(
226 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
227 DWARFFormValue FormValue;
228 if (getAttributeValue(U, Attr, FormValue))
229 return FormValue.getAsAddress(U);
233 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsUnsigned(
234 const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
235 DWARFFormValue FormValue;
236 if (getAttributeValue(U, Attr, FormValue))
237 return FormValue.getUnsigned();
241 int64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsSigned(
242 const DWARFUnit *u, const uint16_t attr, int64_t fail_value) const {
243 DWARFFormValue form_value;
244 if (getAttributeValue(u, attr, form_value))
245 return form_value.getSigned();
249 uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsReference(
250 const DWARFUnit *u, const uint16_t attr, uint64_t fail_value) const {
251 DWARFFormValue form_value;
252 if (getAttributeValue(u, attr, form_value))
253 return form_value.getReference(u);
257 bool DWARFDebugInfoEntryMinimal::getLowAndHighPC(const DWARFUnit *U,
259 uint64_t &HighPC) const {
261 LowPC = getAttributeValueAsAddress(U, DW_AT_low_pc, -1ULL);
263 HighPC = getAttributeValueAsAddress(U, DW_AT_high_pc, -1ULL);
264 return (HighPC != -1ULL);
267 void DWARFDebugInfoEntryMinimal::buildAddressRangeTable(
268 const DWARFUnit *U, DWARFDebugAranges *DebugAranges,
269 uint32_t UOffsetInAranges) const {
271 if (isSubprogramDIE()) {
272 uint64_t LowPC, HighPC;
273 if (getLowAndHighPC(U, LowPC, HighPC))
274 DebugAranges->appendRange(UOffsetInAranges, LowPC, HighPC);
275 // FIXME: try to append ranges from .debug_ranges section.
278 const DWARFDebugInfoEntryMinimal *Child = getFirstChild();
280 Child->buildAddressRangeTable(U, DebugAranges, UOffsetInAranges);
281 Child = Child->getSibling();
286 bool DWARFDebugInfoEntryMinimal::addressRangeContainsAddress(
287 const DWARFUnit *U, const uint64_t Address) const {
290 uint64_t LowPC, HighPC;
291 if (getLowAndHighPC(U, LowPC, HighPC))
292 return (LowPC <= Address && Address <= HighPC);
293 // Try to get address ranges from .debug_ranges section.
294 uint32_t RangesOffset = getAttributeValueAsReference(U, DW_AT_ranges, -1U);
295 if (RangesOffset != -1U) {
296 DWARFDebugRangeList RangeList;
297 if (U->extractRangeList(RangesOffset, RangeList))
298 return RangeList.containsAddress(U->getBaseAddress(), Address);
304 DWARFDebugInfoEntryMinimal::getSubroutineName(const DWARFUnit *U) const {
305 if (!isSubroutineDIE())
307 // Try to get mangled name if possible.
308 if (const char *name =
309 getAttributeValueAsString(U, DW_AT_MIPS_linkage_name, 0))
311 if (const char *name = getAttributeValueAsString(U, DW_AT_linkage_name, 0))
313 if (const char *name = getAttributeValueAsString(U, DW_AT_name, 0))
315 // Try to get name from specification DIE.
317 getAttributeValueAsReference(U, DW_AT_specification, -1U);
318 if (spec_ref != -1U) {
319 DWARFDebugInfoEntryMinimal spec_die;
320 if (spec_die.extract(U, &spec_ref)) {
321 if (const char *name = spec_die.getSubroutineName(U))
325 // Try to get name from abstract origin DIE.
326 uint32_t abs_origin_ref =
327 getAttributeValueAsReference(U, DW_AT_abstract_origin, -1U);
328 if (abs_origin_ref != -1U) {
329 DWARFDebugInfoEntryMinimal abs_origin_die;
330 if (abs_origin_die.extract(U, &abs_origin_ref)) {
331 if (const char *name = abs_origin_die.getSubroutineName(U))
338 void DWARFDebugInfoEntryMinimal::getCallerFrame(const DWARFUnit *U,
341 uint32_t &CallColumn) const {
342 CallFile = getAttributeValueAsUnsigned(U, DW_AT_call_file, 0);
343 CallLine = getAttributeValueAsUnsigned(U, DW_AT_call_line, 0);
344 CallColumn = getAttributeValueAsUnsigned(U, DW_AT_call_column, 0);
347 DWARFDebugInfoEntryInlinedChain
348 DWARFDebugInfoEntryMinimal::getInlinedChainForAddress(
349 const DWARFUnit *U, const uint64_t Address) const {
350 DWARFDebugInfoEntryInlinedChain InlinedChain;
354 for (const DWARFDebugInfoEntryMinimal *DIE = this; DIE; ) {
355 // Append current DIE to inlined chain only if it has correct tag
356 // (e.g. it is not a lexical block).
357 if (DIE->isSubroutineDIE()) {
358 InlinedChain.DIEs.push_back(*DIE);
360 // Try to get child which also contains provided address.
361 const DWARFDebugInfoEntryMinimal *Child = DIE->getFirstChild();
363 if (Child->addressRangeContainsAddress(U, Address)) {
364 // Assume there is only one such child.
367 Child = Child->getSibling();
371 // Reverse the obtained chain to make the root of inlined chain last.
372 std::reverse(InlinedChain.DIEs.begin(), InlinedChain.DIEs.end());