drgn/libdrgn/dwarf_info_cache.c
Omar Sandoval e5874ad18a libdrgn: use libdwfl
libdwfl is the elfutils "DWARF frontend library". It has high-level
functionality for looking up symbols, walking stack traces, etc. In
order to use this functionality, we need to report our debugging
information through libdwfl. For userspace programs, libdwfl has a much
better implementation than drgn for automatically finding debug
information from a core dump or PID. However, for the kernel, libdwfl
has a few issues:

- It only supports finding debug information for the running kernel, not
  vmcores.
- It determines the vmlinux address range by reading /proc/kallsyms,
  which is slow (~70ms on my machine).
- If separate debug information isn't available for a kernel module, it
  finds it by walking /lib/modules/$(uname -r)/kernel; this is repeated
  for every module.
- It doesn't find kernel modules with names containing both dashes and
  underscores (e.g., aes-x86_64).

Luckily, drgn already solved all of these problems, and with some
effort, we can keep doing it ourselves and report it to libdwfl.

The conversion replaces a bunch of code for dealing with userspace core
dump notes, /proc/$pid/maps, and relocations.
2019-07-15 12:27:48 -07:00

1565 lines
42 KiB
C

// Copyright 2018-2019 - Omar Sandoval
// SPDX-License-Identifier: GPL-3.0+
#include <dwarf.h>
#include <elfutils/libdw.h>
#include <libelf.h>
#include <string.h>
#include "internal.h"
#include "dwarf_index.h"
#include "dwarf_info_cache.h"
#include "hash_table.h"
#include "symbol_index.h"
#include "type_index.h"
#include "vector.h"
#if !_ELFUTILS_PREREQ(0, 162)
#define DW_TAG_atomic_type 0x47
#endif
#if !_ELFUTILS_PREREQ(0, 171)
#define DW_FORM_implicit_const 0x21
#endif
DEFINE_HASH_TABLE_FUNCTIONS(dwarf_type_map, hash_pair_ptr_type,
hash_table_scalar_eq)
struct drgn_type_from_dwarf_thunk {
struct drgn_type_thunk thunk;
struct drgn_dwarf_info_cache *dicache;
Dwarf_Die die;
bool can_be_incomplete_array;
};
static bool drgn_type_realloc(struct drgn_type **type, size_t capacity,
size_t element_size)
{
struct drgn_type *tmp;
size_t size;
if (__builtin_mul_overflow(capacity, element_size, &size) ||
__builtin_add_overflow(size, sizeof(**type), &size))
return false;
tmp = realloc(*type, size);
if (!tmp)
return false;
*type = tmp;
return true;
}
static void drgn_dwarf_type_free(struct drgn_dwarf_type *dwarf_type)
{
if (dwarf_type->should_free) {
struct drgn_type *type = dwarf_type->type;
if (drgn_type_has_members(type)) {
size_t num_members, i;
num_members = drgn_type_num_members(type);
for (i = 0; i < num_members; i++)
drgn_type_member_deinit(type, i);
}
if (drgn_type_has_parameters(type)) {
size_t num_parameters, i;
num_parameters = drgn_type_num_parameters(type);
for (i = 0; i < num_parameters; i++)
drgn_type_parameter_deinit(type, i);
}
free(type);
}
}
static int dwarf_type(Dwarf_Die *die, Dwarf_Die *ret)
{
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
if (!(attr = dwarf_attr_integrate(die, DW_AT_type, &attr_mem)))
return 1;
return dwarf_formref_die(attr, ret) ? 0 : -1;
}
static int dwarf_flag(Dwarf_Die *die, unsigned int name, bool *ret)
{
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
if (!(attr = dwarf_attr_integrate(die, name, &attr_mem))) {
*ret = false;
return 0;
}
return dwarf_formflag(attr, ret);
}
/**
* Parse a type from a DWARF debugging information entry.
*
* This is the same as @ref drgn_type_from_dwarf() except that it can be used to
* work around a bug in GCC < 9.0 that zero length array types are encoded the
* same as incomplete array types. There are a few places where GCC allows
* zero-length arrays but not incomplete arrays:
*
* - As the type of a member of a structure with only one member.
* - As the type of a structure member other than the last member.
* - As the type of a union member.
* - As the element type of an array.
*
* In these cases, we know that what appears to be an incomplete array type must
* actually have a length of zero. In other cases, a subrange DIE without
* DW_AT_count or DW_AT_upper_bound is ambiguous; we return an incomplete array
* type.
*
* @param[in] dicache Debugging information cache.
* @param[in] die DIE to parse.
* @param[in] can_be_incomplete_array Whether the type can be an incomplete
* array type. If this is @c false and the type appears to be an incomplete
* array type, its length is set to zero instead.
* @param[out] is_incomplete_array_ret Whether the encoded type is an incomplete
* array type or a typedef of an incomplete array type (regardless of @p
* can_be_incomplete_array).
* @param[out] ret Returned type.
* @return @c NULL on success, non-@c NULL on error.
*/
static struct drgn_error *
drgn_type_from_dwarf_internal(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, bool can_be_incomplete_array,
bool *is_incomplete_array_ret,
struct drgn_qualified_type *ret);
/**
* Parse a type from a DWARF debugging information entry.
*
* @param[in] dicache Debugging information cache.
* @param[in] die DIE to parse.
* @param[out] ret Returned type.
* @return @c NULL on success, non-@c NULL on error.
*/
static inline struct drgn_error *
drgn_type_from_dwarf(struct drgn_dwarf_info_cache *dicache, Dwarf_Die *die,
struct drgn_qualified_type *ret)
{
return drgn_type_from_dwarf_internal(dicache, die, true, NULL, ret);
}
static struct drgn_error *
drgn_type_from_dwarf_thunk_evaluate_fn(struct drgn_type_thunk *thunk,
struct drgn_qualified_type *ret)
{
struct drgn_type_from_dwarf_thunk *t;
t = container_of(thunk, struct drgn_type_from_dwarf_thunk, thunk);
return drgn_type_from_dwarf_internal(t->dicache, &t->die,
t->can_be_incomplete_array, NULL,
ret);
}
static void drgn_type_from_dwarf_thunk_free_fn(struct drgn_type_thunk *thunk)
{
free(container_of(thunk, struct drgn_type_from_dwarf_thunk, thunk));
}
static struct drgn_error *
drgn_lazy_type_from_dwarf(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *parent_die, bool can_be_void,
bool can_be_incomplete_array, const char *tag_name,
struct drgn_lazy_type *ret)
{
struct drgn_type_from_dwarf_thunk *thunk;
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
Dwarf_Die type_die;
if (!(attr = dwarf_attr_integrate(parent_die, DW_AT_type, &attr_mem))) {
if (can_be_void) {
drgn_lazy_type_init_evaluated(ret, &drgn_void_type, 0);
return NULL;
} else {
return drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"%s is missing DW_AT_type",
tag_name);
}
}
if (!dwarf_formref_die(attr, &type_die)) {
return drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"%s has invalid DW_AT_type", tag_name);
}
thunk = malloc(sizeof(*thunk));
if (!thunk)
return &drgn_enomem;
thunk->thunk.evaluate_fn = drgn_type_from_dwarf_thunk_evaluate_fn;
thunk->thunk.free_fn = drgn_type_from_dwarf_thunk_free_fn;
thunk->dicache = dicache;
thunk->die = type_die;
thunk->can_be_incomplete_array = can_be_incomplete_array;
drgn_lazy_type_init_thunk(ret, &thunk->thunk);
return NULL;
}
/**
* Parse a type from the @c DW_AT_type attribute of a DWARF debugging
* information entry.
*
* See @ref drgn_type_from_dwarf_child() and @ref
* drgn_type_from_dwarf_internal().
*/
struct drgn_error *
drgn_type_from_dwarf_child_internal(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *parent_die, const char *tag_name,
bool can_be_void,
bool can_be_incomplete_array,
bool *is_incomplete_array_ret,
struct drgn_qualified_type *ret)
{
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
Dwarf_Die type_die;
if (!(attr = dwarf_attr_integrate(parent_die, DW_AT_type, &attr_mem))) {
if (can_be_void) {
ret->type = &drgn_void_type;
ret->qualifiers = 0;
return NULL;
} else {
return drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"%s is missing DW_AT_type",
tag_name);
}
}
if (!dwarf_formref_die(attr, &type_die)) {
return drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"%s has invalid DW_AT_type", tag_name);
}
return drgn_type_from_dwarf_internal(dicache, &type_die,
can_be_incomplete_array,
is_incomplete_array_ret, ret);
}
/**
* Parse a type from the @c DW_AT_type attribute of a DWARF debugging
* information entry.
*
* @param[in] dicache Debugging information cache.
* @param[in] parent_die Parent DIE.
* @param[in] can_be_void Whether the @c DW_AT_type attribute may be missing,
* which is interpreted as a void type. If this is false and the @c DW_AT_type
* attribute is missing, an error is returned.
* @param[in] tag_name Spelling of the DWARF tag of @p parent_die. Used for
* error messages.
* @param[out] ret Returned type.
* @return @c NULL on success, non-@c NULL on error.
*/
static inline struct drgn_error *
drgn_type_from_dwarf_child(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *parent_die, const char *tag_name,
bool can_be_void, struct drgn_qualified_type *ret)
{
return drgn_type_from_dwarf_child_internal(dicache, parent_die,
tag_name, can_be_void, true,
NULL, ret);
}
static struct drgn_error *
drgn_base_type_from_dwarf(struct drgn_dwarf_info_cache *dicache, Dwarf_Die *die,
struct drgn_type **ret)
{
struct drgn_type *type;
Dwarf_Attribute attr;
Dwarf_Word encoding;
const char *name;
int size;
name = dwarf_diename(die);
if (!name) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_base_type has missing or invalid DW_AT_name");
}
if (!dwarf_attr_integrate(die, DW_AT_encoding, &attr) ||
dwarf_formudata(&attr, &encoding)) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_base_type has missing or invalid DW_AT_encoding");
}
size = dwarf_bytesize(die);
if (size == -1) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_base_type has missing or invalid DW_AT_byte_size");
}
type = malloc(sizeof(*type));
if (!type)
return &drgn_enomem;
switch (encoding) {
case DW_ATE_boolean:
drgn_bool_type_init(type, name, size);
break;
case DW_ATE_float:
drgn_float_type_init(type, name, size);
break;
case DW_ATE_signed:
case DW_ATE_signed_char:
drgn_int_type_init(type, name, size, true);
break;
case DW_ATE_unsigned:
case DW_ATE_unsigned_char:
drgn_int_type_init(type, name, size, false);
break;
/*
* GCC also supports complex integer types, but DWARF 4 doesn't have an
* encoding for that. GCC as of 8.2 emits DW_ATE_lo_user, but that's
* ambiguous because it also emits that in other cases. For now, we
* don't support it.
*/
case DW_ATE_complex_float: {
struct drgn_qualified_type real_type;
struct drgn_error *err;
Dwarf_Die child;
if (dwarf_type(die, &child)) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_base_type has missing or invalid DW_AT_type");
}
err = drgn_type_from_dwarf(dicache, &child, &real_type);
if (err)
return err;
if (drgn_type_kind(real_type.type) != DRGN_TYPE_FLOAT &&
drgn_type_kind(real_type.type) != DRGN_TYPE_INT) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_AT_type of DW_ATE_complex_float is not a floating-point or integer type");
}
drgn_complex_type_init(type, name, size, real_type.type);
break;
}
default:
return drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_base_type has unknown DWARF encoding 0x%llx",
(unsigned long long)encoding);
}
*ret = type;
return NULL;
}
/*
* DW_TAG_structure_type, DW_TAG_union_type, and DW_TAG_enumeration_type can be
* incomplete (i.e., have a DW_AT_declaration of true). This tries to find the
* complete type. If it succeeds, it returns NULL. If it can't find a complete
* type, it returns a DRGN_ERROR_STOP error. Otherwise, it returns an error.
*/
static struct drgn_error *
drgn_dwarf_info_cache_find_complete(struct drgn_dwarf_info_cache *dicache,
uint64_t tag, const char *name,
struct drgn_type **ret)
{
struct drgn_error *err;
struct drgn_dwarf_index_iterator it;
Dwarf_Die die;
struct drgn_qualified_type qualified_type;
drgn_dwarf_index_iterator_init(&it, &dicache->dindex, name,
strlen(name), &tag, 1);
/*
* Find a matching DIE. Note that drgn_dwarf_index does not contain DIEs
* with DW_AT_declaration, so this will always be a complete type.
*/
err = drgn_dwarf_index_iterator_next(&it, &die, NULL);
if (err)
return err;
/*
* Look for another matching DIE. If there is one, then we can't be sure
* which type this is, so leave it incomplete rather than guessing.
*/
err = drgn_dwarf_index_iterator_next(&it, &die, NULL);
if (!err)
return &drgn_stop;
else if (err->code != DRGN_ERROR_STOP)
return err;
err = drgn_type_from_dwarf(dicache, &die, &qualified_type);
if (err)
return err;
*ret = qualified_type.type;
return NULL;
}
static struct drgn_error *
parse_member_offset(Dwarf_Die *die, struct drgn_lazy_type *member_type,
uint64_t bit_field_size, bool little_endian, uint64_t *ret)
{
struct drgn_error *err;
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
/*
* The simplest case is when we have DW_AT_data_bit_offset, which is
* already the offset in bits from the beginning of the containing
* object to the beginning of the member (which may be a bit field).
*/
attr = dwarf_attr_integrate(die, DW_AT_data_bit_offset, &attr_mem);
if (attr) {
Dwarf_Word bit_offset;
if (dwarf_formudata(attr, &bit_offset)) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_member has invalid DW_AT_data_bit_offset");
}
*ret = bit_offset;
return NULL;
}
/*
* Otherwise, we might have DW_AT_data_member_location, which is the
* offset in bytes from the beginning of the containing object.
*/
attr = dwarf_attr_integrate(die, DW_AT_data_member_location, &attr_mem);
if (attr) {
Dwarf_Word byte_offset;
if (dwarf_formudata(attr, &byte_offset)) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_member has invalid DW_AT_data_member_location");
}
*ret = 8 * byte_offset;
} else {
*ret = 0;
}
/*
* In addition to DW_AT_data_member_location, a bit field might have
* DW_AT_bit_offset, which is the offset in bits of the most significant
* bit of the bit field from the most significant bit of the containing
* object.
*/
attr = dwarf_attr_integrate(die, DW_AT_bit_offset, &attr_mem);
if (attr) {
Dwarf_Word bit_offset;
if (dwarf_formudata(attr, &bit_offset)) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_member has invalid DW_AT_bit_offset");
}
/*
* If the architecture is little-endian, then we must compute
* the location of the most significant bit from the size of the
* member, then subtract the bit offset and bit size to get the
* location of the beginning of the bit field.
*
* If the architecture is big-endian, then the most significant
* bit of the bit field is the beginning.
*/
if (little_endian) {
uint64_t byte_size;
attr = dwarf_attr_integrate(die, DW_AT_byte_size,
&attr_mem);
/*
* If the member has an explicit byte size, we can use
* that. Otherwise, we have to get it from the member
* type.
*/
if (attr) {
Dwarf_Word word;
if (dwarf_formudata(attr, &word)) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_member has invalid DW_AT_byte_size");
}
byte_size = word;
} else {
struct drgn_qualified_type containing_type;
err = drgn_lazy_type_evaluate(member_type,
&containing_type);
if (err)
return err;
if (!drgn_type_has_size(containing_type.type)) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_member bit field type does not have size");
}
byte_size = drgn_type_size(containing_type.type);
}
*ret += 8 * byte_size - bit_offset - bit_field_size;
} else {
*ret += bit_offset;
}
}
return NULL;
}
static struct drgn_error *parse_member(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, struct drgn_type *type,
size_t i, bool little_endian)
{
struct drgn_error *err;
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
struct drgn_lazy_type member_type;
const char *name;
uint64_t bit_offset;
uint64_t bit_field_size;
attr = dwarf_attr_integrate(die, DW_AT_name, &attr_mem);
if (attr) {
name = dwarf_formstring(attr);
if (!name) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_member has invalid DW_AT_name");
}
} else {
name = NULL;
}
attr = dwarf_attr_integrate(die, DW_AT_bit_size, &attr_mem);
if (attr) {
Dwarf_Word bit_size;
if (dwarf_formudata(attr, &bit_size)) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_member has invalid DW_AT_bit_size");
}
bit_field_size = bit_size;
} else {
bit_field_size = 0;
}
err = drgn_lazy_type_from_dwarf(dicache, die, false, false,
"DW_TAG_member", &member_type);
if (err)
return err;
err = parse_member_offset(die, &member_type, bit_field_size,
little_endian, &bit_offset);
if (err) {
drgn_lazy_type_deinit(&member_type);
return err;
}
drgn_type_member_init(type, i, member_type, name, bit_offset,
bit_field_size);
return NULL;
}
static struct drgn_error *
drgn_compound_type_from_dwarf(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, bool is_struct,
struct drgn_type **ret, bool *should_free)
{
struct drgn_error *err;
struct drgn_type *type;
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
const char *tag;
bool declaration;
Dwarf_Die child;
int size;
size_t num_members = 0, capacity = 0;
bool little_endian;
int r;
attr = dwarf_attr_integrate(die, DW_AT_name, &attr_mem);
if (attr) {
tag = dwarf_formstring(attr);
if (!tag)
return drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_%s_type has invalid DW_AT_name",
is_struct ? "structure" : "union");
} else {
tag = NULL;
}
if (dwarf_flag(die, DW_AT_declaration, &declaration)) {
return drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_%s_type has invalid DW_AT_declaration",
is_struct ? "structure" : "union");
}
if (declaration && tag) {
err = drgn_dwarf_info_cache_find_complete(dicache,
is_struct ?
DW_TAG_structure_type :
DW_TAG_union_type,
tag, ret);
if (!err) {
*should_free = false;
return NULL;
} else if (err->code != DRGN_ERROR_STOP) {
return err;
}
}
*should_free = true;
type = malloc(sizeof(*type));
if (!type)
return &drgn_enomem;
if (declaration) {
if (is_struct)
drgn_struct_type_init_incomplete(type, tag);
else
drgn_union_type_init_incomplete(type, tag);
*ret = type;
return NULL;
}
size = dwarf_bytesize(die);
if (size == -1) {
err = drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_%s_type has missing or invalid DW_AT_byte_size",
is_struct ? "structure" : "union");
goto err;
}
little_endian = dwarf_die_is_little_endian(die);
r = dwarf_child(die, &child);
while (r == 0) {
if (dwarf_tag(&child) == DW_TAG_member) {
if (num_members >= capacity) {
if (capacity == 0)
capacity = 1;
else
capacity *= 2;
if (!drgn_type_realloc(&type, capacity,
sizeof(struct drgn_type_member))) {
err = &drgn_enomem;
goto err;
}
}
err = parse_member(dicache, &child, type, num_members,
little_endian);
if (err)
goto err;
num_members++;
}
r = dwarf_siblingof(&child, &child);
}
if (r == -1) {
err = drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"libdw could not parse DIE children");
goto err;
}
if (capacity != num_members) {
/* We don't care if this fails. */
drgn_type_realloc(&type, num_members,
sizeof(struct drgn_type_member));
}
if (is_struct) {
drgn_struct_type_init(type, tag, size, num_members);
/*
* Flexible array members are only allowed as the last member of
* a structure with more than one named member. We defaulted
* can_be_incomplete_array to false in parse_member(), so fix it
* up.
*/
if (num_members > 1) {
struct drgn_type_member *member;
member = &drgn_type_members(type)[num_members - 1];
/*
* The type may have already been evaluated if it's a
* bit field. Arrays can't be bit fields, so it's okay
* if we missed it.
*/
if (!drgn_lazy_type_is_evaluated(&member->type)) {
struct drgn_type_from_dwarf_thunk *thunk;
thunk = container_of(member->type.thunk,
struct drgn_type_from_dwarf_thunk,
thunk);
thunk->can_be_incomplete_array = true;
}
}
} else {
drgn_union_type_init(type, tag, size, num_members);
}
*ret = type;
return NULL;
err:
while (num_members)
drgn_type_member_deinit(type, --num_members);
free(type);
return err;
}
static struct drgn_error *parse_enumerator(Dwarf_Die *die,
struct drgn_type *type, size_t i,
bool *is_signed)
{
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
const char *name;
int r;
name = dwarf_diename(die);
if (!name) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_enumerator has missing or invalid DW_AT_name");
}
attr = dwarf_attr_integrate(die, DW_AT_const_value, &attr_mem);
if (!attr) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_enumerator is missing DW_AT_const_value");
}
if (attr->form == DW_FORM_sdata ||
attr->form == DW_FORM_implicit_const) {
Dwarf_Sword svalue;
r = dwarf_formsdata(attr, &svalue);
if (r == 0) {
drgn_type_enumerator_init_signed(type, i, name, svalue);
if (svalue < 0)
*is_signed = true;
}
} else {
Dwarf_Word uvalue;
r = dwarf_formudata(attr, &uvalue);
if (r == 0) {
drgn_type_enumerator_init_unsigned(type, i, name,
uvalue);
}
}
if (r) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_enumerator has invalid DW_AT_const_value");
}
return NULL;
}
static struct drgn_type fallback_enum_compatible_types[2][4];
__attribute__((constructor(200)))
static void fallback_enum_compatible_types_init(void)
{
unsigned int is_signed, shift;
for (is_signed = 0; is_signed < 2; is_signed++) {
for (shift = 0;
shift < ARRAY_SIZE(fallback_enum_compatible_types[0]);
shift++) {
struct drgn_type *type;
type = &fallback_enum_compatible_types[is_signed][shift];
drgn_int_type_init(type, "<unknown>", 1 << shift,
is_signed);
}
}
}
/*
* GCC before 5.1 did not include DW_AT_type for DW_TAG_enumeration_type DIEs,
* so we have to fabricate the compatible type.
*
* GCC before 7.1 didn't include DW_AT_encoding for DW_TAG_enumeration_type
* DIEs, either, so we also have to guess at the sign.
*/
static struct drgn_error *
enum_compatible_type_fallback(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, bool is_signed,
struct drgn_type **ret)
{
int size;
size = dwarf_bytesize(die);
switch (size) {
case 1:
*ret = &fallback_enum_compatible_types[is_signed][0];
return NULL;
case 2:
*ret = &fallback_enum_compatible_types[is_signed][1];
return NULL;
case 4:
*ret = &fallback_enum_compatible_types[is_signed][2];
return NULL;
case 8:
*ret = &fallback_enum_compatible_types[is_signed][3];
return NULL;
case -1:
*ret = NULL;
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_enumeration_type has missing or invalid DW_AT_byte_size");
default:
*ret = NULL;
return drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_enumeration_type has unsupported DW_AT_byte_size %d",
size);
}
}
static struct drgn_error *
drgn_enum_type_from_dwarf(struct drgn_dwarf_info_cache *dicache, Dwarf_Die *die,
struct drgn_type **ret, bool *should_free)
{
struct drgn_error *err;
struct drgn_type *type;
struct drgn_type *compatible_type;
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
const char *tag;
bool declaration;
Dwarf_Die child;
size_t num_enumerators = 0, capacity = 0;
bool is_signed = false;
int r;
attr = dwarf_attr_integrate(die, DW_AT_name, &attr_mem);
if (attr) {
tag = dwarf_formstring(attr);
if (!tag)
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_enumeration_type has invalid DW_AT_name");
} else {
tag = NULL;
}
if (dwarf_flag(die, DW_AT_declaration, &declaration)) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_enumeration_type has invalid DW_AT_declaration");
}
if (declaration && tag) {
err = drgn_dwarf_info_cache_find_complete(dicache,
DW_TAG_enumeration_type,
tag, ret);
if (!err) {
*should_free = false;
return NULL;
} else if (err->code != DRGN_ERROR_STOP) {
return err;
}
}
*should_free = true;
type = malloc(sizeof(*type));
if (!type)
return &drgn_enomem;
if (declaration) {
drgn_enum_type_init_incomplete(type, tag);
*ret = type;
return NULL;
}
r = dwarf_child(die, &child);
while (r == 0) {
int tag;
tag = dwarf_tag(&child);
if (tag == DW_TAG_enumerator) {
if (num_enumerators >= capacity) {
if (capacity == 0)
capacity = 1;
else
capacity *= 2;
if (!drgn_type_realloc(&type, capacity,
sizeof(struct drgn_type_enumerator))) {
err = &drgn_enomem;
goto err;
}
}
err = parse_enumerator(&child, type, num_enumerators,
&is_signed);
if (err)
goto err;
num_enumerators++;
}
r = dwarf_siblingof(&child, &child);
}
if (r == -1) {
err = drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"libdw could not parse DIE children");
goto err;
}
if (capacity != num_enumerators) {
/* We don't care if this fails. */
drgn_type_realloc(&type, num_enumerators,
sizeof(struct drgn_type_enumerator));
}
r = dwarf_type(die, &child);
if (r == -1) {
err = drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_enumeration_type has invalid DW_AT_type");
goto err;
} else if (r) {
err = enum_compatible_type_fallback(dicache, die, is_signed,
&compatible_type);
if (err)
goto err;
} else {
struct drgn_qualified_type qualified_compatible_type;
err = drgn_type_from_dwarf(dicache, &child,
&qualified_compatible_type);
if (err)
goto err;
compatible_type = qualified_compatible_type.type;
if (drgn_type_kind(compatible_type) != DRGN_TYPE_INT) {
err = drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_AT_type of DW_TAG_enumeration_type is not an integer type");
goto err;
}
}
drgn_enum_type_init(type, tag, compatible_type, num_enumerators);
*ret = type;
return NULL;
err:
free(type);
return err;
}
static struct drgn_error *
drgn_typedef_type_from_dwarf(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, bool can_be_incomplete_array,
bool *is_incomplete_array_ret,
struct drgn_type **ret)
{
struct drgn_error *err;
struct drgn_type *type;
struct drgn_qualified_type aliased_type;
const char *name;
name = dwarf_diename(die);
if (!name) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_typedef has missing or invalid DW_AT_name");
}
type = malloc(sizeof(*type));
if (!type)
return &drgn_enomem;
err = drgn_type_from_dwarf_child_internal(dicache, die,
"DW_TAG_typedef", true,
can_be_incomplete_array,
is_incomplete_array_ret,
&aliased_type);
if (err) {
free(type);
return err;
}
drgn_typedef_type_init(type, name, aliased_type);
*ret = type;
return NULL;
}
static struct drgn_error *
drgn_pointer_type_from_dwarf(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, struct drgn_type **ret)
{
struct drgn_error *err;
struct drgn_qualified_type referenced_type;
err = drgn_type_from_dwarf_child(dicache, die, "DW_TAG_pointer_type",
true, &referenced_type);
if (err)
return err;
return drgn_type_index_pointer_type(dicache->tindex, referenced_type,
ret);
}
struct array_dimension {
uint64_t length;
bool is_complete;
};
DEFINE_VECTOR(array_dimension_vector, struct array_dimension)
static struct drgn_error *subrange_length(Dwarf_Die *die,
struct array_dimension *dimension)
{
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
Dwarf_Word word;
if (!(attr = dwarf_attr_integrate(die, DW_AT_upper_bound, &attr_mem)) &&
!(attr = dwarf_attr_integrate(die, DW_AT_count, &attr_mem))) {
dimension->is_complete = false;
return NULL;
}
if (dwarf_formudata(attr, &word)) {
return drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_subrange_type has invalid %s",
attr->code == DW_AT_upper_bound ?
"DW_AT_upper_bound" :
"DW_AT_count");
}
dimension->is_complete = true;
if (attr->code == DW_AT_upper_bound) {
if (word == UINT64_MAX) {
return drgn_error_create(DRGN_ERROR_OVERFLOW,
"DW_AT_count is too large");
}
dimension->length = (uint64_t)word + 1;
} else {
if (word > UINT64_MAX) {
return drgn_error_create(DRGN_ERROR_OVERFLOW,
"DW_AT_upper_bound is too large");
}
dimension->length = word;
}
return NULL;
}
static struct drgn_error *
drgn_array_type_from_dwarf(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, bool can_be_incomplete_array,
bool *is_incomplete_array_ret,
struct drgn_type **ret)
{
struct drgn_error *err;
struct drgn_type *type;
struct drgn_qualified_type element_type;
Dwarf_Die child;
struct array_dimension_vector dimensions;
struct array_dimension *dimension;
int r;
array_dimension_vector_init(&dimensions);
r = dwarf_child(die, &child);
while (r == 0) {
if (dwarf_tag(&child) == DW_TAG_subrange_type) {
dimension = array_dimension_vector_append_entry(&dimensions);
if (!dimension)
goto out;
err = subrange_length(&child, dimension);
if (err)
goto out;
}
r = dwarf_siblingof(&child, &child);
}
if (r == -1) {
err = drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"libdw could not parse DIE children");
goto out;
}
if (!dimensions.size) {
dimension = array_dimension_vector_append_entry(&dimensions);
if (!dimension)
goto out;
dimension->is_complete = false;
}
err = drgn_type_from_dwarf_child_internal(dicache, die,
"DW_TAG_array_type", false,
false, NULL, &element_type);
if (err)
goto out;
*is_incomplete_array_ret = !dimensions.data[0].is_complete;
do {
dimension = array_dimension_vector_pop(&dimensions);
if (dimension->is_complete) {
err = drgn_type_index_array_type(dicache->tindex,
dimension->length,
element_type, &type);
} else if (dimensions.size || !can_be_incomplete_array) {
err = drgn_type_index_array_type(dicache->tindex, 0,
element_type, &type);
} else {
err = drgn_type_index_incomplete_array_type(dicache->tindex,
element_type,
&type);
}
if (err)
goto out;
element_type.type = type;
element_type.qualifiers = 0;
} while (dimensions.size);
*ret = type;
err = NULL;
out:
array_dimension_vector_deinit(&dimensions);
return err;
}
static struct drgn_error *
parse_formal_parameter(struct drgn_dwarf_info_cache *dicache, Dwarf_Die *die,
struct drgn_type *type, size_t i)
{
struct drgn_error *err;
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
const char *name;
struct drgn_lazy_type parameter_type;
attr = dwarf_attr_integrate(die, DW_AT_name, &attr_mem);
if (attr) {
name = dwarf_formstring(attr);
if (!name) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_TAG_formal_parameter has invalid DW_AT_name");
}
} else {
name = NULL;
}
err = drgn_lazy_type_from_dwarf(dicache, die, false, true,
"DW_TAG_formal_parameter",
&parameter_type);
if (err)
return err;
drgn_type_parameter_init(type, i, parameter_type, name);
return NULL;
}
static struct drgn_error *
drgn_function_type_from_dwarf(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, struct drgn_type **ret)
{
struct drgn_error *err;
const char *tag_name;
struct drgn_type *type;
struct drgn_qualified_type return_type;
Dwarf_Die child;
size_t num_parameters = 0, capacity = 0;
bool is_variadic = false;
int r;
if (dwarf_tag(die) == DW_TAG_subroutine_type)
tag_name = "DW_TAG_subroutine_type";
else
tag_name = "DW_TAG_subprogram";
type = malloc(sizeof(*type));
if (!type)
return &drgn_enomem;
r = dwarf_child(die, &child);
while (r == 0) {
int tag;
tag = dwarf_tag(&child);
if (tag == DW_TAG_formal_parameter) {
if (is_variadic) {
err = drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"%s has DW_TAG_formal_parameter child after DW_TAG_unspecified_parameters child",
tag_name);
goto err;
}
if (num_parameters >= capacity) {
if (capacity == 0)
capacity = 1;
else
capacity *= 2;
if (!drgn_type_realloc(&type, capacity,
sizeof(struct drgn_type_parameter))) {
err = &drgn_enomem;
goto err;
}
}
err = parse_formal_parameter(dicache, &child, type,
num_parameters);
if (err)
goto err;
num_parameters++;
} else if (tag == DW_TAG_unspecified_parameters) {
if (is_variadic) {
err = drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"%s has multiple DW_TAG_unspecified_parameters children",
tag_name);
goto err;
}
is_variadic = true;
}
r = dwarf_siblingof(&child, &child);
}
if (r == -1) {
err = drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"libdw could not parse DIE children");
goto err;
}
if (capacity != num_parameters) {
/* We don't care if this fails. */
drgn_type_realloc(&type, num_parameters,
sizeof(struct drgn_type_parameter));
}
err = drgn_type_from_dwarf_child(dicache, die, tag_name, true,
&return_type);
if (err)
goto err;
drgn_function_type_init(type, return_type, num_parameters, is_variadic);
*ret = type;
return NULL;
err:
while (num_parameters)
drgn_type_parameter_deinit(type, --num_parameters);
free(type);
return err;
}
static struct drgn_error *
drgn_type_from_dwarf_internal(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, bool can_be_incomplete_array,
bool *is_incomplete_array_ret,
struct drgn_qualified_type *ret)
{
struct drgn_error *err;
struct hash_pair hp;
struct dwarf_type_map_entry entry = {
.key = die->addr,
};
struct dwarf_type_map *map;
struct dwarf_type_map_iterator it;
if (dicache->depth >= 1000) {
return drgn_error_create(DRGN_ERROR_RECURSION,
"maximum DWARF type parsing depth exceeded");
}
hp = dwarf_type_map_hash(&entry.key);
it = dwarf_type_map_search_hashed(&dicache->map, &entry.key, hp);
if (it.entry) {
if (!can_be_incomplete_array &&
it.entry->value.is_incomplete_array) {
map = &dicache->cant_be_incomplete_array_map;
it = dwarf_type_map_search_hashed(map, &entry.key, hp);
}
if (it.entry) {
ret->type = it.entry->value.type;
ret->qualifiers = it.entry->value.qualifiers;
return NULL;
}
}
ret->qualifiers = 0;
dicache->depth++;
entry.value.is_incomplete_array = false;
switch (dwarf_tag(die)) {
case DW_TAG_const_type:
/*
* Qualified types share the struct drgn_type with the
* unqualified type.
*/
entry.value.should_free = false;
err = drgn_type_from_dwarf_child(dicache, die,
"DW_TAG_const_type", true,
ret);
ret->qualifiers |= DRGN_QUALIFIER_CONST;
break;
case DW_TAG_restrict_type:
entry.value.should_free = false;
err = drgn_type_from_dwarf_child(dicache, die,
"DW_TAG_restrict_type", true,
ret);
ret->qualifiers |= DRGN_QUALIFIER_RESTRICT;
break;
case DW_TAG_volatile_type:
entry.value.should_free = false;
err = drgn_type_from_dwarf_child(dicache, die,
"DW_TAG_volatile_type", true,
ret);
ret->qualifiers |= DRGN_QUALIFIER_VOLATILE;
break;
case DW_TAG_atomic_type:
entry.value.should_free = false;
err = drgn_type_from_dwarf_child(dicache, die,
"DW_TAG_atomic_type", true,
ret);
ret->qualifiers |= DRGN_QUALIFIER_ATOMIC;
break;
case DW_TAG_base_type:
entry.value.should_free = true;
err = drgn_base_type_from_dwarf(dicache, die, &ret->type);
break;
case DW_TAG_structure_type:
err = drgn_compound_type_from_dwarf(dicache, die, true,
&ret->type,
&entry.value.should_free);
break;
case DW_TAG_union_type:
err = drgn_compound_type_from_dwarf(dicache, die, false,
&ret->type,
&entry.value.should_free);
break;
case DW_TAG_enumeration_type:
err = drgn_enum_type_from_dwarf(dicache, die, &ret->type,
&entry.value.should_free);
break;
case DW_TAG_typedef:
entry.value.should_free = true;
err = drgn_typedef_type_from_dwarf(dicache, die,
can_be_incomplete_array,
&entry.value.is_incomplete_array,
&ret->type);
break;
case DW_TAG_pointer_type:
/* Pointer types are owned by the type index. */
entry.value.should_free = false;
err = drgn_pointer_type_from_dwarf(dicache, die, &ret->type);
break;
case DW_TAG_array_type:
/* Array types are owned by the type index. */
entry.value.should_free = false;
err = drgn_array_type_from_dwarf(dicache, die,
can_be_incomplete_array,
&entry.value.is_incomplete_array,
&ret->type);
break;
case DW_TAG_subroutine_type:
case DW_TAG_subprogram:
entry.value.should_free = true;
err = drgn_function_type_from_dwarf(dicache, die, &ret->type);
break;
default:
err = drgn_error_format(DRGN_ERROR_DWARF_FORMAT,
"unknown DWARF type tag 0x%x",
dwarf_tag(die));
break;
}
dicache->depth--;
if (err)
return err;
entry.value.type = ret->type;
entry.value.qualifiers = ret->qualifiers;
if (!can_be_incomplete_array && entry.value.is_incomplete_array)
map = &dicache->cant_be_incomplete_array_map;
else
map = &dicache->map;
if (dwarf_type_map_insert_searched(map, &entry, hp, NULL) == -1) {
drgn_dwarf_type_free(&entry.value);
return &drgn_enomem;
}
if (is_incomplete_array_ret)
*is_incomplete_array_ret = entry.value.is_incomplete_array;
return NULL;
}
struct drgn_error *drgn_dwarf_type_find(enum drgn_type_kind kind,
const char *name, size_t name_len,
const char *filename, void *arg,
struct drgn_qualified_type *ret)
{
struct drgn_error *err;
struct drgn_dwarf_info_cache *dicache = arg;
struct drgn_dwarf_index_iterator it;
Dwarf_Die die;
uint64_t tag;
switch (kind) {
case DRGN_TYPE_INT:
case DRGN_TYPE_BOOL:
case DRGN_TYPE_FLOAT:
tag = DW_TAG_base_type;
break;
case DRGN_TYPE_STRUCT:
tag = DW_TAG_structure_type;
break;
case DRGN_TYPE_UNION:
tag = DW_TAG_union_type;
break;
case DRGN_TYPE_ENUM:
tag = DW_TAG_enumeration_type;
break;
case DRGN_TYPE_TYPEDEF:
tag = DW_TAG_typedef;
break;
default:
DRGN_UNREACHABLE();
}
drgn_dwarf_index_iterator_init(&it, &dicache->dindex, name, name_len,
&tag, 1);
while (!(err = drgn_dwarf_index_iterator_next(&it, &die, NULL))) {
if (die_matches_filename(&die, filename)) {
err = drgn_type_from_dwarf(dicache, &die, ret);
if (err)
return err;
/*
* For DW_TAG_base_type, we need to check that the type
* we found was the right kind.
*/
if (drgn_type_kind(ret->type) == kind)
return NULL;
}
}
if (err && err->code != DRGN_ERROR_STOP)
return err;
ret->type = NULL;
return NULL;
}
static struct drgn_error *
drgn_symbol_from_dwarf_subprogram(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, uint64_t bias,
const char *name, struct drgn_symbol *ret)
{
struct drgn_error *err;
struct drgn_qualified_type qualified_type;
Dwarf_Addr low_pc;
err = drgn_type_from_dwarf(dicache, die, &qualified_type);
if (err)
return err;
ret->type = qualified_type.type;
ret->qualifiers = qualified_type.qualifiers;
ret->kind = DRGN_SYMBOL_ADDRESS;
if (dwarf_lowpc(die, &low_pc) == -1) {
return drgn_error_format(DRGN_ERROR_LOOKUP,
"could not find address of '%s'",
name);
}
ret->address = low_pc + bias;
ret->little_endian = dwarf_die_is_little_endian(die);
return NULL;
}
static struct drgn_error *
drgn_symbol_from_dwarf_variable(struct drgn_dwarf_info_cache *dicache,
Dwarf_Die *die, uint64_t bias, const char *name,
struct drgn_symbol *ret)
{
struct drgn_error *err;
struct drgn_qualified_type qualified_type;
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
Dwarf_Op *loc;
size_t nloc;
err = drgn_type_from_dwarf_child(dicache, die, "DW_TAG_variable", true,
&qualified_type);
if (err)
return err;
ret->type = qualified_type.type;
ret->qualifiers = qualified_type.qualifiers;
ret->kind = DRGN_SYMBOL_ADDRESS;
if (!(attr = dwarf_attr_integrate(die, DW_AT_location, &attr_mem))) {
return drgn_error_format(DRGN_ERROR_LOOKUP,
"could not find address of '%s'",
name);
}
if (dwarf_getlocation(attr, &loc, &nloc))
return drgn_error_libdw();
if (nloc != 1 || loc[0].atom != DW_OP_addr) {
return drgn_error_create(DRGN_ERROR_DWARF_FORMAT,
"DW_AT_location has unimplemented operation");
}
ret->address = loc[0].number + bias;
ret->little_endian = dwarf_die_is_little_endian(die);
return NULL;
}
struct drgn_error *
drgn_dwarf_symbol_find(const char *name, size_t name_len, const char *filename,
enum drgn_find_object_flags flags, void *arg,
struct drgn_symbol *ret)
{
struct drgn_error *err;
struct drgn_dwarf_info_cache *dicache = arg;
uint64_t tags[3];
size_t num_tags;
struct drgn_dwarf_index_iterator it;
Dwarf_Die die;
uint64_t bias;
num_tags = 0;
if (flags & DRGN_FIND_OBJECT_CONSTANT)
tags[num_tags++] = DW_TAG_enumerator;
if (flags & DRGN_FIND_OBJECT_FUNCTION)
tags[num_tags++] = DW_TAG_subprogram;
if (flags & DRGN_FIND_OBJECT_VARIABLE)
tags[num_tags++] = DW_TAG_variable;
drgn_dwarf_index_iterator_init(&it, &dicache->dindex, name,
strlen(name), tags, num_tags);
while (!(err = drgn_dwarf_index_iterator_next(&it, &die, &bias))) {
if (!die_matches_filename(&die, filename))
continue;
switch (dwarf_tag(&die)) {
case DW_TAG_enumeration_type: {
struct drgn_qualified_type qualified_type;
ret->kind = DRGN_SYMBOL_ENUMERATOR;
err = drgn_type_from_dwarf(dicache, &die,
&qualified_type);
if (err)
return err;
ret->type = qualified_type.type;
ret->qualifiers = qualified_type.qualifiers;
return NULL;
}
case DW_TAG_subprogram:
return drgn_symbol_from_dwarf_subprogram(dicache, &die,
bias, name,
ret);
case DW_TAG_variable:
return drgn_symbol_from_dwarf_variable(dicache, &die,
bias, name, ret);
default:
DRGN_UNREACHABLE();
}
}
if (err && err->code != DRGN_ERROR_STOP)
return err;
ret->type = NULL;
return NULL;
}
struct drgn_error *
drgn_dwarf_info_cache_create(struct drgn_type_index *tindex,
struct drgn_dwarf_info_cache **ret)
{
struct drgn_dwarf_info_cache *dicache;
dicache = malloc(sizeof(*dicache));
if (!dicache)
return &drgn_enomem;
drgn_dwarf_index_init(&dicache->dindex);
dwarf_type_map_init(&dicache->map);
dwarf_type_map_init(&dicache->cant_be_incomplete_array_map);
dicache->depth = 0;
dicache->tindex = tindex;
*ret = dicache;
return NULL;
}
void drgn_dwarf_info_cache_destroy(struct drgn_dwarf_info_cache *dicache)
{
struct dwarf_type_map_iterator it;
if (!dicache)
return;
for (it = dwarf_type_map_first(&dicache->map); it.entry;
it = dwarf_type_map_next(it))
drgn_dwarf_type_free(&it.entry->value);
/* Arrays don't need to be freed, but typedefs do. */
for (it = dwarf_type_map_first(&dicache->cant_be_incomplete_array_map);
it.entry; it = dwarf_type_map_next(it))
drgn_dwarf_type_free(&it.entry->value);
dwarf_type_map_deinit(&dicache->cant_be_incomplete_array_map);
dwarf_type_map_deinit(&dicache->map);
drgn_dwarf_index_deinit(&dicache->dindex);
free(dicache);
}