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 "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,
23 const DWARFCompileUnit *cu,
24 unsigned recurseDepth,
25 unsigned indent) const {
26 DataExtractor debug_info_data = cu->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 const uint32_t numAttributes = AbbrevDecl->getNumAttributes();
45 for (uint32_t i = 0; i != numAttributes; ++i) {
46 uint16_t attr = AbbrevDecl->getAttrByIndex(i);
47 uint16_t form = AbbrevDecl->getFormByIndex(i);
48 dumpAttribute(OS, cu, &offset, attr, form, indent);
51 const DWARFDebugInfoEntryMinimal *child = getFirstChild();
52 if (recurseDepth > 0 && child) {
54 child->dump(OS, cu, recurseDepth-1, indent+2);
55 child = child->getSibling();
59 OS << "Abbreviation code not found in 'debug_abbrev' class for code: "
63 OS.indent(indent) << "NULL\n";
68 void DWARFDebugInfoEntryMinimal::dumpAttribute(raw_ostream &OS,
69 const DWARFCompileUnit *cu,
73 unsigned indent) const {
74 OS << format("0x%8.8x: ", *offset_ptr);
76 const char *attrString = AttributeString(attr);
80 OS << format("DW_AT_Unknown_%x", attr);
81 const char *formString = FormEncodingString(form);
83 OS << " [" << formString << ']';
85 OS << format(" [DW_FORM_Unknown_%x]", form);
87 DWARFFormValue formValue(form);
89 if (!formValue.extractValue(cu->getDebugInfoExtractor(), offset_ptr, cu))
93 formValue.dump(OS, cu);
97 bool DWARFDebugInfoEntryMinimal::extractFast(const DWARFCompileUnit *cu,
98 const uint8_t *fixed_form_sizes,
99 uint32_t *offset_ptr) {
100 Offset = *offset_ptr;
102 DataExtractor debug_info_data = cu->getDebugInfoExtractor();
103 uint64_t abbrCode = debug_info_data.getULEB128(offset_ptr);
105 assert(fixed_form_sizes); // For best performance this should be specified!
108 uint32_t offset = *offset_ptr;
110 AbbrevDecl = cu->getAbbreviations()->getAbbreviationDeclaration(abbrCode);
112 // Skip all data in the .debug_info for the attributes
113 const uint32_t numAttributes = AbbrevDecl->getNumAttributes();
116 for (i=0; i<numAttributes; ++i) {
118 form = AbbrevDecl->getFormByIndex(i);
120 // FIXME: Currently we're checking if this is less than the last
121 // entry in the fixed_form_sizes table, but this should be changed
122 // to use dynamic dispatch.
123 const uint8_t fixed_skip_size = (form < DW_FORM_ref_sig8) ?
124 fixed_form_sizes[form] : 0;
126 offset += fixed_skip_size;
128 bool form_is_indirect = false;
130 form_is_indirect = false;
131 uint32_t form_size = 0;
133 // Blocks if inlined data that have a length field and the data bytes
134 // inlined in the .debug_info.
135 case DW_FORM_exprloc:
137 form_size = debug_info_data.getULEB128(&offset);
140 form_size = debug_info_data.getU8(&offset);
143 form_size = debug_info_data.getU16(&offset);
146 form_size = debug_info_data.getU32(&offset);
149 // Inlined NULL terminated C-strings
151 debug_info_data.getCStr(&offset);
154 // Compile unit address sized values
156 case DW_FORM_ref_addr:
157 form_size = cu->getAddressByteSize();
161 case DW_FORM_flag_present:
188 case DW_FORM_ref_sig8:
192 // signed or unsigned LEB 128 values
195 case DW_FORM_ref_udata:
196 case DW_FORM_GNU_str_index:
197 case DW_FORM_GNU_addr_index:
198 debug_info_data.getULEB128(&offset);
201 case DW_FORM_indirect:
202 form_is_indirect = true;
203 form = debug_info_data.getULEB128(&offset);
206 // FIXME: 64-bit for DWARF64
207 case DW_FORM_sec_offset:
208 debug_info_data.getU32(offset_ptr);
212 *offset_ptr = Offset;
216 } while (form_is_indirect);
219 *offset_ptr = offset;
223 return true; // NULL debug tag entry
228 DWARFDebugInfoEntryMinimal::extract(const DWARFCompileUnit *cu,
229 uint32_t *offset_ptr) {
230 DataExtractor debug_info_data = cu->getDebugInfoExtractor();
231 const uint32_t cu_end_offset = cu->getNextCompileUnitOffset();
232 const uint8_t cu_addr_size = cu->getAddressByteSize();
233 uint32_t offset = *offset_ptr;
234 if ((offset < cu_end_offset) && debug_info_data.isValidOffset(offset)) {
237 uint64_t abbrCode = debug_info_data.getULEB128(&offset);
240 AbbrevDecl = cu->getAbbreviations()->getAbbreviationDeclaration(abbrCode);
243 uint16_t tag = AbbrevDecl->getTag();
245 bool isCompileUnitTag = tag == DW_TAG_compile_unit;
246 if(cu && isCompileUnitTag)
247 const_cast<DWARFCompileUnit*>(cu)->setBaseAddress(0);
249 // Skip all data in the .debug_info for the attributes
250 const uint32_t numAttributes = AbbrevDecl->getNumAttributes();
251 for (uint32_t i = 0; i != numAttributes; ++i) {
252 uint16_t attr = AbbrevDecl->getAttrByIndex(i);
253 uint16_t form = AbbrevDecl->getFormByIndex(i);
255 if (isCompileUnitTag &&
256 ((attr == DW_AT_entry_pc) || (attr == DW_AT_low_pc))) {
257 DWARFFormValue form_value(form);
258 if (form_value.extractValue(debug_info_data, &offset, cu)) {
259 if (attr == DW_AT_low_pc || attr == DW_AT_entry_pc)
260 const_cast<DWARFCompileUnit*>(cu)
261 ->setBaseAddress(form_value.getUnsigned());
264 bool form_is_indirect = false;
266 form_is_indirect = false;
267 register uint32_t form_size = 0;
269 // Blocks if inlined data that have a length field and the data
270 // bytes // inlined in the .debug_info
271 case DW_FORM_exprloc:
273 form_size = debug_info_data.getULEB128(&offset);
276 form_size = debug_info_data.getU8(&offset);
279 form_size = debug_info_data.getU16(&offset);
282 form_size = debug_info_data.getU32(&offset);
285 // Inlined NULL terminated C-strings
287 debug_info_data.getCStr(&offset);
290 // Compile unit address sized values
292 case DW_FORM_ref_addr:
293 form_size = cu_addr_size;
297 case DW_FORM_flag_present:
327 case DW_FORM_ref_sig8:
331 // signed or unsigned LEB 128 values
334 case DW_FORM_ref_udata:
335 case DW_FORM_GNU_str_index:
336 case DW_FORM_GNU_addr_index:
337 debug_info_data.getULEB128(&offset);
340 case DW_FORM_indirect:
341 form = debug_info_data.getULEB128(&offset);
342 form_is_indirect = true;
345 // FIXME: 64-bit for DWARF64.
346 case DW_FORM_sec_offset:
347 debug_info_data.getU32(offset_ptr);
351 *offset_ptr = offset;
356 } while (form_is_indirect);
359 *offset_ptr = offset;
364 *offset_ptr = offset;
365 return true; // NULL debug tag entry
372 bool DWARFDebugInfoEntryMinimal::isSubprogramDIE() const {
373 return getTag() == DW_TAG_subprogram;
376 bool DWARFDebugInfoEntryMinimal::isSubroutineDIE() const {
377 uint32_t Tag = getTag();
378 return Tag == DW_TAG_subprogram ||
379 Tag == DW_TAG_inlined_subroutine;
383 DWARFDebugInfoEntryMinimal::getAttributeValue(const DWARFCompileUnit *cu,
385 DWARFFormValue &form_value,
386 uint32_t *end_attr_offset_ptr)
389 uint32_t attr_idx = AbbrevDecl->findAttributeIndex(attr);
391 if (attr_idx != -1U) {
392 uint32_t offset = getOffset();
394 DataExtractor debug_info_data = cu->getDebugInfoExtractor();
396 // Skip the abbreviation code so we are at the data for the attributes
397 debug_info_data.getULEB128(&offset);
400 while (idx < attr_idx)
401 DWARFFormValue::skipValue(AbbrevDecl->getFormByIndex(idx++),
402 debug_info_data, &offset, cu);
404 const uint32_t attr_offset = offset;
405 form_value = DWARFFormValue(AbbrevDecl->getFormByIndex(idx));
406 if (form_value.extractValue(debug_info_data, &offset, cu)) {
407 if (end_attr_offset_ptr)
408 *end_attr_offset_ptr = offset;
418 DWARFDebugInfoEntryMinimal::getAttributeValueAsString(
419 const DWARFCompileUnit* cu,
421 const char* fail_value)
423 DWARFFormValue form_value;
424 if (getAttributeValue(cu, attr, form_value)) {
425 DataExtractor stringExtractor(cu->getStringSection(), false, 0);
426 return form_value.getAsCString(&stringExtractor);
432 DWARFDebugInfoEntryMinimal::getAttributeValueAsUnsigned(
433 const DWARFCompileUnit* cu,
435 uint64_t fail_value) const {
436 DWARFFormValue form_value;
437 if (getAttributeValue(cu, attr, form_value))
438 return form_value.getUnsigned();
443 DWARFDebugInfoEntryMinimal::getAttributeValueAsSigned(
444 const DWARFCompileUnit* cu,
446 int64_t fail_value) const {
447 DWARFFormValue form_value;
448 if (getAttributeValue(cu, attr, form_value))
449 return form_value.getSigned();
454 DWARFDebugInfoEntryMinimal::getAttributeValueAsReference(
455 const DWARFCompileUnit* cu,
459 DWARFFormValue form_value;
460 if (getAttributeValue(cu, attr, form_value))
461 return form_value.getReference(cu);
465 bool DWARFDebugInfoEntryMinimal::getLowAndHighPC(const DWARFCompileUnit *CU,
467 uint64_t &HighPC) const {
469 LowPC = getAttributeValueAsUnsigned(CU, DW_AT_low_pc, -1ULL);
471 HighPC = getAttributeValueAsUnsigned(CU, DW_AT_high_pc, -1ULL);
472 return (HighPC != -1ULL);
476 DWARFDebugInfoEntryMinimal::buildAddressRangeTable(const DWARFCompileUnit *CU,
477 DWARFDebugAranges *DebugAranges)
480 if (isSubprogramDIE()) {
481 uint64_t LowPC, HighPC;
482 if (getLowAndHighPC(CU, LowPC, HighPC)) {
483 DebugAranges->appendRange(CU->getOffset(), LowPC, HighPC);
485 // FIXME: try to append ranges from .debug_ranges section.
488 const DWARFDebugInfoEntryMinimal *child = getFirstChild();
490 child->buildAddressRangeTable(CU, DebugAranges);
491 child = child->getSibling();
497 DWARFDebugInfoEntryMinimal::addressRangeContainsAddress(
498 const DWARFCompileUnit *CU,
499 const uint64_t Address)
503 uint64_t LowPC, HighPC;
504 if (getLowAndHighPC(CU, LowPC, HighPC))
505 return (LowPC <= Address && Address <= HighPC);
506 // Try to get address ranges from .debug_ranges section.
507 uint32_t RangesOffset = getAttributeValueAsReference(CU, DW_AT_ranges, -1U);
508 if (RangesOffset != -1U) {
509 DWARFDebugRangeList RangeList;
510 if (CU->extractRangeList(RangesOffset, RangeList))
511 return RangeList.containsAddress(CU->getBaseAddress(), Address);
517 DWARFDebugInfoEntryMinimal::getSubroutineName(const DWARFCompileUnit *CU)
519 if (!isSubroutineDIE())
521 // Try to get mangled name if possible.
522 if (const char *name =
523 getAttributeValueAsString(CU, DW_AT_MIPS_linkage_name, 0))
525 if (const char *name = getAttributeValueAsString(CU, DW_AT_linkage_name, 0))
527 if (const char *name = getAttributeValueAsString(CU, DW_AT_name, 0))
529 // Try to get name from specification DIE.
531 getAttributeValueAsReference(CU, DW_AT_specification, -1U);
532 if (spec_ref != -1U) {
533 DWARFDebugInfoEntryMinimal spec_die;
534 if (spec_die.extract(CU, &spec_ref)) {
535 if (const char *name = spec_die.getSubroutineName(CU))
539 // Try to get name from abstract origin DIE.
540 uint32_t abs_origin_ref =
541 getAttributeValueAsReference(CU, DW_AT_abstract_origin, -1U);
542 if (abs_origin_ref != -1U) {
543 DWARFDebugInfoEntryMinimal abs_origin_die;
544 if (abs_origin_die.extract(CU, &abs_origin_ref)) {
545 if (const char *name = abs_origin_die.getSubroutineName(CU))
552 void DWARFDebugInfoEntryMinimal::getCallerFrame(const DWARFCompileUnit *CU,
555 uint32_t &CallColumn) const {
556 CallFile = getAttributeValueAsUnsigned(CU, DW_AT_call_file, 0);
557 CallLine = getAttributeValueAsUnsigned(CU, DW_AT_call_line, 0);
558 CallColumn = getAttributeValueAsUnsigned(CU, DW_AT_call_column, 0);
561 DWARFDebugInfoEntryMinimal::InlinedChain
562 DWARFDebugInfoEntryMinimal::getInlinedChainForAddress(
563 const DWARFCompileUnit *CU,
564 const uint64_t Address)
566 DWARFDebugInfoEntryMinimal::InlinedChain InlinedChain;
569 for (const DWARFDebugInfoEntryMinimal *DIE = this; DIE; ) {
570 // Append current DIE to inlined chain only if it has correct tag
571 // (e.g. it is not a lexical block).
572 if (DIE->isSubroutineDIE()) {
573 InlinedChain.push_back(*DIE);
575 // Try to get child which also contains provided address.
576 const DWARFDebugInfoEntryMinimal *Child = DIE->getFirstChild();
578 if (Child->addressRangeContainsAddress(CU, Address)) {
579 // Assume there is only one such child.
582 Child = Child->getSibling();
586 // Reverse the obtained chain to make the root of inlined chain last.
587 std::reverse(InlinedChain.begin(), InlinedChain.end());