#include "mc_private.h"
+// Define symbols not present in old version of dwarf.h.
+// Old version of dwarf.h, use DW_LANG_Objc instead of this:
+#define DW_LANG_ObjC 0x0010
+
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dwarf, mc, "DWARF processing");
/** \brief The default DW_TAG_lower_bound for a given DW_AT_language.
case DW_TAG_lexical_block:
case DW_TAG_try_block:
+ case DW_TAG_catch_block:
case DW_TAG_inlined_subroutine:
+ case DW_TAG_with_stmt:
return mc_tag_scope;
case DW_TAG_namespace:
#define MC_DW_CLASS_MACPTR 9
#define MC_DW_CLASS_RANGELISTPTR 10
+/** \brief Find the DWARF data class for a given DWARF data form
+ *
+ * This mapping is defined in the DWARF spec.
+ *
+ * \param form The form (values taken from the DWARF spec)
+ * \return An internal representation for the corresponding class
+ * */
static int MC_dwarf_form_get_class(int form) {
switch(form) {
case DW_FORM_addr:
/** \brief Get an attribute of a given DIE as a string
*
- * \param the DIE
+ * \param die the DIE
* \param attribute attribute
* \return value of the given attribute of the given DIE
*/
-static const char* MC_dwarf_attr_string(Dwarf_Die* die, int attribute) {
+static const char* MC_dwarf_attr_integrate_string(Dwarf_Die* die, int attribute) {
Dwarf_Attribute attr;
if (!dwarf_attr_integrate(die, attribute, &attr)) {
return NULL;
/** \brief Get the linkage name of a DIE.
*
- * Use either DW_AT_linkage_name or DW_AR_MIPS_linkage_name.
+ * Use either DW_AT_linkage_name or DW_AT_MIPS_linkage_name.
+ * DW_AT_linkage_name is standardized since DWARF 4.
+ * Before this version of DWARF, the MIPS extensions
+ * DW_AT_MIPS_linkage_name is used (at least by GCC).
*
- * \param DIE
+ * \param the DIE
* \return linkage name of the given DIE (or NULL)
* */
static const char* MC_dwarf_at_linkage_name(Dwarf_Die* die) {
- const char* name = MC_dwarf_attr_string(die, DW_AT_linkage_name);
+ const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_linkage_name);
if (!name)
- name = MC_dwarf_attr_string(die, DW_AT_MIPS_linkage_name);
+ name = MC_dwarf_attr_integrate_string(die, DW_AT_MIPS_linkage_name);
return name;
}
-static char* MC_dwarf_at_type(Dwarf_Die* die) {
+static Dwarf_Off MC_dwarf_attr_dieoffset(Dwarf_Die* die, int attribute) {
Dwarf_Attribute attr;
- if (dwarf_hasattr_integrate(die, DW_AT_type)) {
- dwarf_attr_integrate(die, DW_AT_type, &attr);
- Dwarf_Die subtype_die;
- if (dwarf_formref_die(&attr, &subtype_die)==NULL) {
- xbt_die("Could not find DIE for type");
- }
- Dwarf_Off subtype_global_offset = dwarf_dieoffset(&subtype_die);
- return bprintf("%" PRIx64 , subtype_global_offset);
- }
- else return NULL;
+ if (dwarf_hasattr_integrate(die, attribute)) {
+ dwarf_attr_integrate(die, attribute, &attr);
+ Dwarf_Die subtype_die;
+ if (dwarf_formref_die(&attr, &subtype_die)==NULL) {
+ xbt_die("Could not find DIE");
+ }
+ return dwarf_dieoffset(&subtype_die);
+ }
+ else return 0;
+}
+
+static Dwarf_Off MC_dwarf_attr_integrate_dieoffset(Dwarf_Die* die, int attribute) {
+ Dwarf_Attribute attr;
+ if (dwarf_hasattr_integrate(die, attribute)) {
+ dwarf_attr_integrate(die, DW_AT_type, &attr);
+ Dwarf_Die subtype_die;
+ if (dwarf_formref_die(&attr, &subtype_die)==NULL) {
+ xbt_die("Could not find DIE");
+ }
+ return dwarf_dieoffset(&subtype_die);
+ }
+ else return 0;
+}
+
+/** \brief Find the type/subtype (DW_AT_type) for a DIE
+ *
+ * \param dit the DIE
+ * \return DW_AT_type reference as a global offset in hexadecimal (or NULL)
+ */
+static char* MC_dwarf_at_type(Dwarf_Die* die) {
+ Dwarf_Off offset = MC_dwarf_attr_integrate_dieoffset(die, DW_AT_type);
+ return offset == 0 ? NULL : bprintf("%" PRIx64 , offset);
}
-static uint64_t MC_dwarf_attr_addr(Dwarf_Die* die, int attribute) {
+static uint64_t MC_dwarf_attr_integrate_addr(Dwarf_Die* die, int attribute) {
Dwarf_Attribute attr;
if(dwarf_attr_integrate(die, attribute, &attr)==NULL)
return 0;
return 0;
}
-static uint64_t MC_dwarf_attr_uint(Dwarf_Die* die, int attribute, uint64_t default_value) {
+static uint64_t MC_dwarf_attr_integrate_uint(Dwarf_Die* die, int attribute, uint64_t default_value) {
Dwarf_Attribute attr;
if (dwarf_attr_integrate(die, attribute, &attr)==NULL)
return default_value;
return dwarf_formudata(dwarf_attr_integrate(die, attribute, &attr), &value) == 0 ? (uint64_t) value : default_value;
}
-static bool MC_dwarf_attr_flag(Dwarf_Die* die, int attribute, int integrate) {
+static bool MC_dwarf_attr_flag(Dwarf_Die* die, int attribute, bool integrate) {
Dwarf_Attribute attr;
if ((integrate ? dwarf_attr_integrate(die, attribute, &attr)
: dwarf_attr(die, attribute, &attr))==0)
return result;
}
+/** \brief Find the default lower bound for a given language
+ *
+ * The default lower bound of an array (when DW_TAG_lower_bound
+ * is missing) depends on the language of the compilation unit.
+ *
+ * \param lang Language of the compilation unit (values defined in the DWARF spec)
+ * \return Default lower bound of an array in this compilation unit
+ * */
static uint64_t MC_dwarf_default_lower_bound(int lang) {
switch(lang) {
case DW_LANG_C:
case DW_LANG_Cobol85:
return 1;
default:
- xbt_die("No default MT_TAG_lower_bound for language %i and none given", lang);
+ xbt_die("No default DW_TAG_lower_bound for language %i and none given", lang);
return 0;
}
}
+/** \brief Finds the number of elements in a DW_TAG_subrange_type or DW_TAG_enumeration_type DIE
+ *
+ * \param die the DIE
+ * \param unit DIE of the compilation unit
+ * \return number of elements in the range
+ * */
static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die* die, Dwarf_Die* unit) {
xbt_assert(dwarf_tag(die)==DW_TAG_enumeration_type ||dwarf_tag(die)==DW_TAG_subrange_type,
"MC_dwarf_subrange_element_count called with DIE of type %s", MC_dwarf_die_tagname(die));
// Use DW_TAG_count if present:
if (dwarf_hasattr_integrate(die, DW_AT_count)) {
- return MC_dwarf_attr_uint(die, DW_AT_count, 0);
+ return MC_dwarf_attr_integrate_uint(die, DW_AT_count, 0);
}
// Otherwise compute DW_TAG_upper_bound-DW_TAG_lower_bound + 1:
// This is not really 0, but the code expects this (we do not know):
return 0;
}
- uint64_t upper_bound = MC_dwarf_attr_uint(die, DW_AT_upper_bound, -1);
+ uint64_t upper_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_upper_bound, -1);
uint64_t lower_bound = 0;
if (dwarf_hasattr_integrate(die, DW_AT_lower_bound)) {
- lower_bound = MC_dwarf_attr_uint(die, DW_AT_lower_bound, -1);
+ lower_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_lower_bound, -1);
} else {
lower_bound = MC_dwarf_default_lower_bound(dwarf_srclang(unit));
}
return upper_bound - lower_bound + 1;
}
+/** \brief Finds the number of elements in a array type (DW_TAG_array_type)
+ *
+ * The compilation unit might be needed because the default lower
+ * bound depends on the language of the compilation unit.
+ *
+ * \param die the DIE of the DW_TAG_array_type
+ * \param unit the DIE of the compilation unit
+ * \return number of elements in this array type
+ * */
static uint64_t MC_dwarf_array_element_count(Dwarf_Die* die, Dwarf_Die* unit) {
xbt_assert(dwarf_tag(die)==DW_TAG_array_type,
"MC_dwarf_array_element_count called with DIE of type %s", MC_dwarf_die_tagname(die));
// ***** dw_type_t
+/** \brief Initialize the location of a member of a type
+ * (DW_AT_data_member_location of a DW_TAG_member).
+ *
+ * \param type a type (struct, class)
+ * \param member the member of the type
+ * \param child DIE of the member (DW_TAG_member)
+ */
static void MC_dwarf_fill_member_location(dw_type_t type, dw_type_t member, Dwarf_Die* child) {
if (dwarf_hasattr(child, DW_AT_data_bit_offset)) {
xbt_die("Can't groke DW_AT_data_bit_offset.");
if (!dwarf_hasattr_integrate(child, DW_AT_data_member_location)) {
if (type->type != DW_TAG_union_type) {
xbt_die(
- "Missing DW_AT_data_member_location field in DW_TAG_member %s of type <%p>%s",
- member->name, type->id, type->name);
+ "Missing DW_AT_data_member_location field in DW_TAG_member %s of type <%"PRIx64">%s",
+ member->name, (uint64_t) type->id, type->name);
} else {
return;
}
size_t len;
if (dwarf_getlocation(&attr, &expr, &len)) {
xbt_die(
- "Could not read location expression DW_AT_data_member_location in DW_TAG_member %s of type <%p>%s",
- MC_dwarf_attr_string(child, DW_AT_name),
- type->id, type->name);
+ "Could not read location expression DW_AT_data_member_location in DW_TAG_member %s of type <%"PRIx64">%s",
+ MC_dwarf_attr_integrate_string(child, DW_AT_name),
+ (uint64_t) type->id, type->name);
}
if (len==1 && expr[0].atom == DW_OP_plus_uconst) {
member->offset = expr[0].number;
if (!dwarf_formudata(&attr, &offset))
member->offset = offset;
else
- xbt_die("Cannot get %s location <%p>%s",
- MC_dwarf_attr_string(child, DW_AT_name),
- type->id, type->name);
+ xbt_die("Cannot get %s location <%"PRIx64">%s",
+ MC_dwarf_attr_integrate_string(child, DW_AT_name),
+ (uint64_t) type->id, type->name);
break;
}
case MC_DW_CLASS_LOCLISTPTR:
}
+static void dw_type_free_voidp(void *t){
+ dw_type_free((dw_type_t) * (void **) t);
+}
+
+/** \brief Populate the list of members of a type
+ *
+ * \param info ELF object containing the type DIE
+ * \param die DIE of the type
+ * \param unit DIE of the compilation unit containing the type DIE
+ * \param type the type
+ */
static void MC_dwarf_add_members(mc_object_info_t info, Dwarf_Die* die, Dwarf_Die* unit, dw_type_t type) {
int res;
Dwarf_Die child;
xbt_assert(!type->members);
- type->members = xbt_dynar_new(sizeof(dw_type_t), (void(*)(void*))dw_type_free);
+ type->members = xbt_dynar_new(sizeof(dw_type_t), (void(*)(void*))dw_type_free_voidp);
for (res=dwarf_child(die, &child); res==0; res=dwarf_siblingof(&child,&child)) {
int tag = dwarf_tag(&child);
if (tag==DW_TAG_member || tag==DW_TAG_inheritance) {
member->type = tag;
// Global Offset:
- member->id = (void *) dwarf_dieoffset(&child);
+ member->id = dwarf_dieoffset(&child);
- const char* name = MC_dwarf_attr_string(&child, DW_AT_name);
+ const char* name = MC_dwarf_attr_integrate_string(&child, DW_AT_name);
if(name)
member->name = xbt_strdup(name);
else
member->name = NULL;
- member->byte_size = MC_dwarf_attr_uint(&child, DW_AT_byte_size, 0);
+ member->byte_size = MC_dwarf_attr_integrate_uint(&child, DW_AT_byte_size, 0);
member->element_count = -1;
member->dw_type_id = MC_dwarf_at_type(&child);
member->members = NULL;
MC_dwarf_fill_member_location(type, member, &child);
if (!member->dw_type_id) {
- xbt_die("Missing type for member %s of <%p>%s", member->name, type->id, type->name);
+ xbt_die("Missing type for member %s of <%"PRIx64">%s", member->name, (uint64_t) type->id, type->name);
}
xbt_dynar_push(type->members, &member);
dw_type_t type = xbt_new0(s_dw_type_t, 1);
type->type = -1;
- type->id = NULL;
+ type->id = 0;
type->name = NULL;
type->byte_size = 0;
type->element_count = -1;
type->type = dwarf_tag(die);
// Global Offset
- type->id = (void *) dwarf_dieoffset(die);
+ type->id = dwarf_dieoffset(die);
const char* prefix = "";
switch (type->type) {
prefix = "";
}
- const char* name = MC_dwarf_attr_string(die, DW_AT_name);
+ const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
if (name!=NULL) {
type->name = namespace ? bprintf("%s%s::%s", prefix, namespace, name) : bprintf("%s%s", prefix, name);
}
- XBT_DEBUG("Processing type <%p>%s", type->id, type->name);
-
type->dw_type_id = MC_dwarf_at_type(die);
// Computation of the byte_size;
if (dwarf_hasattr_integrate(die, DW_AT_byte_size))
- type->byte_size = MC_dwarf_attr_uint(die, DW_AT_byte_size, 0);
+ type->byte_size = MC_dwarf_attr_integrate_uint(die, DW_AT_byte_size, 0);
else if (type->type == DW_TAG_array_type || type->type==DW_TAG_structure_type || type->type==DW_TAG_class_type) {
Dwarf_Word size;
if (dwarf_aggregate_size(die, &size)==0) {
char* key = bprintf("%" PRIx64, (uint64_t) type->id);
xbt_dict_set(info->types, key, type, NULL);
+ xbt_free(key);
if(type->name && type->byte_size!=0) {
xbt_dict_set(info->full_types_by_name, type->name, type, NULL);
dw_variable_t variable = xbt_new0(s_dw_variable_t, 1);
variable->dwarf_offset = dwarf_dieoffset(die);
variable->global = frame == NULL; // Can be override base on DW_AT_location
+ variable->object_info = info;
- const char* name = MC_dwarf_attr_string(die, DW_AT_name);
+ const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
variable->name = xbt_strdup(name);
variable->type_origin = MC_dwarf_at_type(die);
if (len==1 && expr[0].atom == DW_OP_addr) {
variable->global = 1;
Dwarf_Off offset = expr[0].number;
- // TODO, Why is this different base on the object?
- Dwarf_Off base = strcmp(info->file_name, xbt_binary_name) !=0 ? (Dwarf_Off) info->start_exec : 0;
+ Dwarf_Off base = (Dwarf_Off) MC_object_base_address(info);
variable->address = (void*) (base + offset);
} else {
mc_dwarf_location_list_init_from_expression(&variable->locations, len, expr);
variable->start_scope = dwarf_formudata(&attr, &value) == 0 ? (size_t) value : 0;
break;
}
+ case MC_DW_CLASS_RANGELISTPTR: // TODO
default:
xbt_die("Unhandled form 0x%x, class 0x%X for DW_AT_start_scope of variable %s",
form, klass, name==NULL ? "?" : name);
MC_dwarf_register_variable(info, frame, variable);
}
-static void MC_dwarf_handle_subprogram_die(mc_object_info_t info, Dwarf_Die* die, Dwarf_Die* unit, dw_frame_t parent_frame, const char* namespace) {
+static void mc_frame_free_voipd(dw_frame_t* p) {
+ mc_frame_free(*p);
+ *p = NULL;
+}
+
+static void MC_dwarf_handle_scope_die(mc_object_info_t info, Dwarf_Die* die, Dwarf_Die* unit, dw_frame_t parent_frame, const char* namespace) {
+ // TODO, handle DW_TAG_type/DW_TAG_location for DW_TAG_with_stmt
+ int tag = dwarf_tag(die);
+ mc_tag_class klass = MC_dwarf_tag_classify(tag);
// (Template) Subprogram declaration:
- if (MC_dwarf_attr_flag(die, DW_AT_declaration, false))
+ if(klass==mc_tag_subprogram && MC_dwarf_attr_flag(die, DW_AT_declaration, false))
return;
+ if(klass==mc_tag_scope)
+ xbt_assert(parent_frame, "No parent scope for this scope");
+
dw_frame_t frame = xbt_new0(s_dw_frame_t, 1);
- frame->start = dwarf_dieoffset(die);
+ frame->tag = tag;
+ frame->id = dwarf_dieoffset(die);
+ frame->object_info = info;
- const char* name = MC_dwarf_attr_string(die, DW_AT_name);
- frame->name = namespace ? bprintf("%s::%s", namespace, name) : xbt_strdup(name);
+ if(klass==mc_tag_subprogram) {
+ const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
+ frame->name = namespace ? bprintf("%s::%s", namespace, name) : xbt_strdup(name);
+ }
+
+ frame->abstract_origin_id = MC_dwarf_attr_dieoffset(die, DW_AT_abstract_origin);
// This is the base address for DWARF addresses.
// Relocated addresses are offset from this base address.
// See DWARF4 spec 7.5
- void* base = info->flags & MC_OBJECT_INFO_EXECUTABLE ? 0 : MC_object_base_address(info);
+ void* base = MC_object_base_address(info);
// Variables are filled in the (recursive) call of MC_dwarf_handle_children:
frame->variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
- frame->high_pc = ((char*) base) + MC_dwarf_attr_addr(die, DW_AT_high_pc);
- frame->low_pc = ((char*) base) + MC_dwarf_attr_addr(die, DW_AT_low_pc);
- Dwarf_Attribute attr_frame_base;
- if (dwarf_attr_integrate(die, DW_AT_frame_base, &attr_frame_base))
- mc_dwarf_location_list_init(&frame->frame_base, info, die, &attr_frame_base);
+ // TODO, support DW_AT_ranges
+ uint64_t low_pc = MC_dwarf_attr_integrate_addr(die, DW_AT_low_pc);
+ frame->low_pc = low_pc ? ((char*) base) + low_pc : 0;
+ if(low_pc) {
+ // DW_AT_high_pc:
+ Dwarf_Attribute attr;
+ if(!dwarf_attr_integrate(die, DW_AT_high_pc, &attr)) {
+ xbt_die("Missing DW_AT_high_pc matching with DW_AT_low_pc");
+ }
+
+ Dwarf_Sword offset;
+ Dwarf_Addr high_pc;
- frame->end = -1; // This one is now useless:
+ switch(MC_dwarf_form_get_class(dwarf_whatform(&attr))) {
+
+ // DW_AT_high_pc if an offset from the low_pc:
+ case MC_DW_CLASS_CONSTANT:
+
+ if (dwarf_formsdata(&attr, &offset) !=0)
+ xbt_die("Could not read constant");
+ frame->high_pc = (void*) ((Dwarf_Off)frame->low_pc + offset);
+ break;
+
+ // DW_AT_high_pc is a relocatable address:
+ case MC_DW_CLASS_ADDRESS:
+ if (dwarf_formaddr(&attr, &high_pc) != 0)
+ xbt_die("Could not read address");
+ frame->high_pc = ((char*) base) + high_pc;
+ break;
+
+ default:
+ xbt_die("Unexpected class for DW_AT_high_pc");
+
+ }
+ }
+
+ if(klass==mc_tag_subprogram) {
+ Dwarf_Attribute attr_frame_base;
+ if (dwarf_attr_integrate(die, DW_AT_frame_base, &attr_frame_base))
+ mc_dwarf_location_list_init(&frame->frame_base, info, die, &attr_frame_base);
+ }
+
+ frame->scopes = xbt_dynar_new(sizeof(dw_frame_t), (void_f_pvoid_t) mc_frame_free_voipd);
// Register it:
- const char* key = bprintf("%" PRIx64, (uint64_t) frame->start);
- xbt_dict_set(info->subprograms, key, frame, NULL);
+ if(klass==mc_tag_subprogram) {
+ char* key = bprintf("%" PRIx64, (uint64_t) frame->id);
+ xbt_dict_set(info->subprograms, key, frame, NULL);
+ xbt_free(key);
+ } else if(klass==mc_tag_scope) {
+ xbt_dynar_push(parent_frame->scopes, &frame);
+ }
// Handle children:
MC_dwarf_handle_children(info, die, unit, frame, namespace);
static void mc_dwarf_handle_namespace_die(
mc_object_info_t info, Dwarf_Die* die, Dwarf_Die* unit, dw_frame_t frame, const char* namespace) {
- const char* name = MC_dwarf_attr_string(die, DW_AT_name);
+ const char* name = MC_dwarf_attr_integrate_string(die, DW_AT_name);
if(frame)
xbt_die("Unexpected namespace in a subprogram");
char* new_namespace = namespace == NULL ? xbt_strdup(name)
: bprintf("%s::%s", namespace, name);
MC_dwarf_handle_children(info, die, unit, frame, new_namespace);
+ xbt_free(new_namespace);
}
static void MC_dwarf_handle_children(mc_object_info_t info, Dwarf_Die* die, Dwarf_Die* unit, dw_frame_t frame, const char* namespace) {
+ // For each child DIE:
Dwarf_Die child;
int res;
for (res=dwarf_child(die, &child); res==0; res=dwarf_siblingof(&child,&child)) {
MC_dwarf_handle_type_die(info, die, unit, frame, namespace);
break;
- // Program:
+ // Subprogram or scope:
case mc_tag_subprogram:
- MC_dwarf_handle_subprogram_die(info, die, unit, frame, namespace);
+ case mc_tag_scope:
+ MC_dwarf_handle_scope_die(info, die, unit, frame, namespace);
return;
// Variable:
MC_dwarf_handle_variable_die(info, die, unit, frame, namespace);
break;
- // Scope:
- case mc_tag_scope:
- // TODO
- break;
-
case mc_tag_namespace:
mc_dwarf_handle_namespace_die(info, die, unit, frame, namespace);
break;
}
}
+/** \brief Populate the debugging informations of the given ELF object
+ *
+ * Read the DWARf information of the EFFL object and populate the
+ * lists of types, variables, functions.
+ */
void MC_dwarf_get_variables(mc_object_info_t info) {
int fd = open(info->file_name, O_RDONLY);
if (fd<0) {
xbt_die("Your program must be compiled with -g");
}
+ // For each compilation unit:
Dwarf_Off offset = 0;
Dwarf_Off next_offset = 0;
size_t length;
while (dwarf_nextcu (dwarf, offset, &next_offset, &length, NULL, NULL, NULL) == 0) {
Dwarf_Die unit_die;
-
if(dwarf_offdie(dwarf, offset+length, &unit_die)!=NULL) {
+
+ // For each child DIE:
Dwarf_Die child;
int res;
for (res=dwarf_child(&unit_die, &child); res==0; res=dwarf_siblingof(&child,&child)) {
MC_dwarf_handle_die(info, &child, &unit_die, NULL, NULL);
}
+
}
offset = next_offset;
}
