Newer
Older
//===-- DWARFDebugInfoEntry.cpp -------------------------------------------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "DWARFDebugInfoEntry.h"
#include "DWARFCompileUnit.h"
#include "DWARFContext.h"
#include "DWARFDebugAbbrev.h"
#include "llvm/DebugInfo/DWARFFormValue.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Dwarf.h"
#include "llvm/Support/Format.h"
#include "llvm/Support/raw_ostream.h"
using namespace llvm;
using namespace dwarf;
David Blaikie
committed
void DWARFDebugInfoEntryMinimal::dump(raw_ostream &OS, const DWARFUnit *u,
unsigned recurseDepth,
unsigned indent) const {
David Blaikie
committed
DataExtractor debug_info_data = u->getDebugInfoExtractor();
uint32_t offset = Offset;
if (debug_info_data.isValidOffset(offset)) {
Benjamin Kramer
committed
uint32_t abbrCode = debug_info_data.getULEB128(&offset);
Benjamin Kramer
committed
OS << format("\n0x%8.8x: ", Offset);
const char *tagString = TagString(getTag());
if (tagString)
OS.indent(indent) << tagString;
else
OS.indent(indent) << format("DW_TAG_Unknown_%x", getTag());
OS << format(" [%u] %c\n", abbrCode,
AbbrevDecl->hasChildren() ? '*' : ' ');
const uint32_t numAttributes = AbbrevDecl->getNumAttributes();
for (uint32_t i = 0; i != numAttributes; ++i) {
uint16_t attr = AbbrevDecl->getAttrByIndex(i);
uint16_t form = AbbrevDecl->getFormByIndex(i);
David Blaikie
committed
dumpAttribute(OS, u, &offset, attr, form, indent);
}
const DWARFDebugInfoEntryMinimal *child = getFirstChild();
if (recurseDepth > 0 && child) {
while (child) {
David Blaikie
committed
child->dump(OS, u, recurseDepth-1, indent+2);
child = child->getSibling();
}
}
} else {
OS << "Abbreviation code not found in 'debug_abbrev' class for code: "
<< abbrCode << '\n';
}
} else {
Benjamin Kramer
committed
OS.indent(indent) << "NULL\n";
}
}
}
void DWARFDebugInfoEntryMinimal::dumpAttribute(raw_ostream &OS,
David Blaikie
committed
const DWARFUnit *u,
uint32_t *offset_ptr,
uint16_t attr, uint16_t form,
David Blaikie
committed
OS << " ";
OS.indent(indent+2);
const char *attrString = AttributeString(attr);
if (attrString)
OS << attrString;
else
OS << format("DW_AT_Unknown_%x", attr);
const char *formString = FormEncodingString(form);
if (formString)
OS << " [" << formString << ']';
else
OS << format(" [DW_FORM_Unknown_%x]", form);
David Blaikie
committed
if (!formValue.extractValue(u->getDebugInfoExtractor(), offset_ptr, u))
David Blaikie
committed
formValue.dump(OS, u);
David Blaikie
committed
bool DWARFDebugInfoEntryMinimal::extractFast(const DWARFUnit *U,
Alexey Samsonov
committed
const uint8_t *FixedFormSizes,
uint32_t *OffsetPtr) {
Offset = *OffsetPtr;
David Blaikie
committed
DataExtractor DebugInfoData = U->getDebugInfoExtractor();
Alexey Samsonov
committed
uint64_t AbbrCode = DebugInfoData.getULEB128(OffsetPtr);
if (0 == AbbrCode) {
// NULL debug tag entry.
Alexey Samsonov
committed
return true;
}
David Blaikie
committed
AbbrevDecl = U->getAbbreviations()->getAbbreviationDeclaration(AbbrCode);
Alexey Samsonov
committed
assert(AbbrevDecl);
assert(FixedFormSizes); // For best performance this should be specified!
// Skip all data in the .debug_info for the attributes
for (uint32_t i = 0, n = AbbrevDecl->getNumAttributes(); i < n; ++i) {
uint16_t Form = AbbrevDecl->getFormByIndex(i);
// FIXME: Currently we're checking if this is less than the last
// entry in the fixed_form_sizes table, but this should be changed
// to use dynamic dispatch.
uint8_t FixedFormSize =
(Form < DW_FORM_ref_sig8) ? FixedFormSizes[Form] : 0;
if (FixedFormSize)
*OffsetPtr += FixedFormSize;
else if (!DWARFFormValue::skipValue(Form, DebugInfoData, OffsetPtr,
David Blaikie
committed
U)) {
Alexey Samsonov
committed
// Restore the original offset.
*OffsetPtr = Offset;
return false;
}
Alexey Samsonov
committed
return true;
David Blaikie
committed
bool DWARFDebugInfoEntryMinimal::extract(const DWARFUnit *U,
uint32_t *OffsetPtr) {
DataExtractor DebugInfoData = U->getDebugInfoExtractor();
const uint32_t UEndOffset = U->getNextUnitOffset();
Alexey Samsonov
committed
Offset = *OffsetPtr;
David Blaikie
committed
if ((Offset >= UEndOffset) || !DebugInfoData.isValidOffset(Offset))
Alexey Samsonov
committed
return false;
uint64_t AbbrCode = DebugInfoData.getULEB128(OffsetPtr);
if (0 == AbbrCode) {
// NULL debug tag entry.
AbbrevDecl = NULL;
return true;
}
David Blaikie
committed
AbbrevDecl = U->getAbbreviations()->getAbbreviationDeclaration(AbbrCode);
Alexey Samsonov
committed
if (0 == AbbrevDecl) {
// Restore the original offset.
*OffsetPtr = Offset;
return false;
}
bool IsCompileUnitTag = (AbbrevDecl->getTag() == DW_TAG_compile_unit);
if (IsCompileUnitTag)
David Blaikie
committed
const_cast<DWARFUnit *>(U)->setBaseAddress(0);
Alexey Samsonov
committed
// Skip all data in the .debug_info for the attributes
for (uint32_t i = 0, n = AbbrevDecl->getNumAttributes(); i < n; ++i) {
uint16_t Attr = AbbrevDecl->getAttrByIndex(i);
uint16_t Form = AbbrevDecl->getFormByIndex(i);
if (IsCompileUnitTag &&
((Attr == DW_AT_entry_pc) || (Attr == DW_AT_low_pc))) {
DWARFFormValue FormValue(Form);
David Blaikie
committed
if (FormValue.extractValue(DebugInfoData, OffsetPtr, U)) {
Alexey Samsonov
committed
if (Attr == DW_AT_low_pc || Attr == DW_AT_entry_pc)
David Blaikie
committed
const_cast<DWARFUnit *>(U)->setBaseAddress(FormValue.getUnsigned());
David Blaikie
committed
} else if (!DWARFFormValue::skipValue(Form, DebugInfoData, OffsetPtr, U)) {
Alexey Samsonov
committed
// Restore the original offset.
*OffsetPtr = Offset;
return false;
Alexey Samsonov
committed
return true;
Alexey Samsonov
committed
bool DWARFDebugInfoEntryMinimal::isSubprogramDIE() const {
return getTag() == DW_TAG_subprogram;
}
bool DWARFDebugInfoEntryMinimal::isSubroutineDIE() const {
uint32_t Tag = getTag();
return Tag == DW_TAG_subprogram ||
Tag == DW_TAG_inlined_subroutine;
}
David Blaikie
committed
uint32_t DWARFDebugInfoEntryMinimal::getAttributeValue(
const DWARFUnit *u, const uint16_t attr, DWARFFormValue &form_value,
uint32_t *end_attr_offset_ptr) const {
if (AbbrevDecl) {
uint32_t attr_idx = AbbrevDecl->findAttributeIndex(attr);
if (attr_idx != -1U) {
uint32_t offset = getOffset();
David Blaikie
committed
DataExtractor debug_info_data = u->getDebugInfoExtractor();
// Skip the abbreviation code so we are at the data for the attributes
debug_info_data.getULEB128(&offset);
uint32_t idx = 0;
while (idx < attr_idx)
DWARFFormValue::skipValue(AbbrevDecl->getFormByIndex(idx++),
David Blaikie
committed
debug_info_data, &offset, u);
const uint32_t attr_offset = offset;
form_value = DWARFFormValue(AbbrevDecl->getFormByIndex(idx));
David Blaikie
committed
if (form_value.extractValue(debug_info_data, &offset, u)) {
if (end_attr_offset_ptr)
*end_attr_offset_ptr = offset;
return attr_offset;
}
}
}
return 0;
}
const char *DWARFDebugInfoEntryMinimal::getAttributeValueAsString(
David Blaikie
committed
const DWARFUnit *U, const uint16_t Attr, const char *FailValue) const {
DWARFFormValue FormValue;
David Blaikie
committed
if (getAttributeValue(U, Attr, FormValue))
return FormValue.getAsCString(U);
uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsAddress(
David Blaikie
committed
const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
DWARFFormValue FormValue;
David Blaikie
committed
if (getAttributeValue(U, Attr, FormValue))
return FormValue.getAsAddress(U);
return FailValue;
}
uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsUnsigned(
David Blaikie
committed
const DWARFUnit *U, const uint16_t Attr, uint64_t FailValue) const {
DWARFFormValue FormValue;
David Blaikie
committed
if (getAttributeValue(U, Attr, FormValue))
return FormValue.getUnsigned();
return FailValue;
David Blaikie
committed
int64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsSigned(
const DWARFUnit *u, const uint16_t attr, int64_t fail_value) const {
David Blaikie
committed
if (getAttributeValue(u, attr, form_value))
return form_value.getSigned();
return fail_value;
}
David Blaikie
committed
uint64_t DWARFDebugInfoEntryMinimal::getAttributeValueAsReference(
const DWARFUnit *u, const uint16_t attr, uint64_t fail_value) const {
David Blaikie
committed
if (getAttributeValue(u, attr, form_value))
return form_value.getReference(u);
Benjamin Kramer
committed
David Blaikie
committed
bool DWARFDebugInfoEntryMinimal::getLowAndHighPC(const DWARFUnit *U,
uint64_t &LowPC,
uint64_t &HighPC) const {
Alexey Samsonov
committed
HighPC = -1ULL;
David Blaikie
committed
LowPC = getAttributeValueAsAddress(U, DW_AT_low_pc, -1ULL);
Alexey Samsonov
committed
if (LowPC != -1ULL)
David Blaikie
committed
HighPC = getAttributeValueAsAddress(U, DW_AT_high_pc, -1ULL);
Alexey Samsonov
committed
return (HighPC != -1ULL);
}
David Blaikie
committed
void DWARFDebugInfoEntryMinimal::buildAddressRangeTable(
const DWARFUnit *U, DWARFDebugAranges *DebugAranges,
uint32_t UOffsetInAranges) const {
Benjamin Kramer
committed
if (AbbrevDecl) {
Alexey Samsonov
committed
if (isSubprogramDIE()) {
uint64_t LowPC, HighPC;
David Blaikie
committed
if (getLowAndHighPC(U, LowPC, HighPC))
DebugAranges->appendRange(UOffsetInAranges, LowPC, HighPC);
Alexey Samsonov
committed
// FIXME: try to append ranges from .debug_ranges section.
Benjamin Kramer
committed
}
const DWARFDebugInfoEntryMinimal *Child = getFirstChild();
while (Child) {
David Blaikie
committed
Child->buildAddressRangeTable(U, DebugAranges, UOffsetInAranges);
Child = Child->getSibling();
Benjamin Kramer
committed
}
}
}
Alexey Samsonov
committed
David Blaikie
committed
bool DWARFDebugInfoEntryMinimal::addressRangeContainsAddress(
const DWARFUnit *U, const uint64_t Address) const {
Alexey Samsonov
committed
if (isNULL())
return false;
uint64_t LowPC, HighPC;
David Blaikie
committed
if (getLowAndHighPC(U, LowPC, HighPC))
Alexey Samsonov
committed
return (LowPC <= Address && Address <= HighPC);
// Try to get address ranges from .debug_ranges section.
David Blaikie
committed
uint32_t RangesOffset = getAttributeValueAsReference(U, DW_AT_ranges, -1U);
Alexey Samsonov
committed
if (RangesOffset != -1U) {
DWARFDebugRangeList RangeList;
David Blaikie
committed
if (U->extractRangeList(RangesOffset, RangeList))
return RangeList.containsAddress(U->getBaseAddress(), Address);
Alexey Samsonov
committed
}
return false;
}
David Blaikie
committed
const char *
DWARFDebugInfoEntryMinimal::getSubroutineName(const DWARFUnit *U) const {
Alexey Samsonov
committed
if (!isSubroutineDIE())
Alexey Samsonov
committed
return 0;
Alexey Samsonov
committed
// Try to get mangled name if possible.
if (const char *name =
David Blaikie
committed
getAttributeValueAsString(U, DW_AT_MIPS_linkage_name, 0))
Alexey Samsonov
committed
return name;
David Blaikie
committed
if (const char *name = getAttributeValueAsString(U, DW_AT_linkage_name, 0))
Alexey Samsonov
committed
return name;
David Blaikie
committed
if (const char *name = getAttributeValueAsString(U, DW_AT_name, 0))
Alexey Samsonov
committed
return name;
// Try to get name from specification DIE.
uint32_t spec_ref =
David Blaikie
committed
getAttributeValueAsReference(U, DW_AT_specification, -1U);
Alexey Samsonov
committed
if (spec_ref != -1U) {
DWARFDebugInfoEntryMinimal spec_die;
David Blaikie
committed
if (spec_die.extract(U, &spec_ref)) {
if (const char *name = spec_die.getSubroutineName(U))
Alexey Samsonov
committed
return name;
Alexey Samsonov
committed
}
}
Alexey Samsonov
committed
// Try to get name from abstract origin DIE.
uint32_t abs_origin_ref =
David Blaikie
committed
getAttributeValueAsReference(U, DW_AT_abstract_origin, -1U);
Alexey Samsonov
committed
if (abs_origin_ref != -1U) {
DWARFDebugInfoEntryMinimal abs_origin_die;
David Blaikie
committed
if (abs_origin_die.extract(U, &abs_origin_ref)) {
if (const char *name = abs_origin_die.getSubroutineName(U))
Alexey Samsonov
committed
return name;
}
}
return 0;
Alexey Samsonov
committed
}
Alexey Samsonov
committed
David Blaikie
committed
void DWARFDebugInfoEntryMinimal::getCallerFrame(const DWARFUnit *U,
uint32_t &CallFile,
uint32_t &CallLine,
uint32_t &CallColumn) const {
David Blaikie
committed
CallFile = getAttributeValueAsUnsigned(U, DW_AT_call_file, 0);
CallLine = getAttributeValueAsUnsigned(U, DW_AT_call_line, 0);
CallColumn = getAttributeValueAsUnsigned(U, DW_AT_call_column, 0);
Alexey Samsonov
committed
}
Alexey Samsonov
committed
DWARFDebugInfoEntryInlinedChain
Alexey Samsonov
committed
DWARFDebugInfoEntryMinimal::getInlinedChainForAddress(
David Blaikie
committed
const DWARFUnit *U, const uint64_t Address) const {
Alexey Samsonov
committed
DWARFDebugInfoEntryInlinedChain InlinedChain;
David Blaikie
committed
InlinedChain.U = U;
Alexey Samsonov
committed
if (isNULL())
return InlinedChain;
for (const DWARFDebugInfoEntryMinimal *DIE = this; DIE; ) {
// Append current DIE to inlined chain only if it has correct tag
// (e.g. it is not a lexical block).
if (DIE->isSubroutineDIE()) {
Alexey Samsonov
committed
InlinedChain.DIEs.push_back(*DIE);
Alexey Samsonov
committed
}
// Try to get child which also contains provided address.
const DWARFDebugInfoEntryMinimal *Child = DIE->getFirstChild();
while (Child) {
David Blaikie
committed
if (Child->addressRangeContainsAddress(U, Address)) {
Alexey Samsonov
committed
// Assume there is only one such child.
break;
}
Child = Child->getSibling();
}
DIE = Child;
}
// Reverse the obtained chain to make the root of inlined chain last.
Alexey Samsonov
committed
std::reverse(InlinedChain.DIEs.begin(), InlinedChain.DIEs.end());
Alexey Samsonov
committed
return InlinedChain;
}