X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0f86d3285f605e43ba3f845eb2f5ee2502b2aed4..d4cffd7edd2269eb55baf61bee016bd7cb4a107d:/src/mc/mc_dwarf.cpp diff --git a/src/mc/mc_dwarf.cpp b/src/mc/mc_dwarf.cpp index fb1303108c..eeb6a367a2 100644 --- a/src/mc/mc_dwarf.cpp +++ b/src/mc/mc_dwarf.cpp @@ -1,33 +1,34 @@ -/* Copyright (c) 2008-2014. The SimGrid Team. +/* Copyright (c) 2008-2015. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ #include +#include +#include #include -#include +#include #define DW_LANG_Objc DW_LANG_ObjC /* fix spelling error in older dwarf.h */ #include #include #include +#include #include #include +#include + #include "mc_object_info.h" #include "mc_private.h" +#include "mc_dwarf.hpp" -static void MC_dwarf_register_global_variable( - mc_object_info_t info, std::unique_ptr variable); -static void MC_register_variable( - mc_object_info_t info, mc_frame_t frame, std::unique_ptr variable); -static void MC_dwarf_register_non_global_variable(mc_object_info_t info, mc_frame_t frame, mc_variable_t variable); -static void MC_dwarf_register_variable( - mc_object_info_t info, mc_frame_t frame, - std::unique_ptr variable); +#include "mc/Process.hpp" +#include "mc/ObjectInformation.hpp" +#include "mc/Variable.hpp" XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dwarf, mc, "DWARF processing"); @@ -66,14 +67,14 @@ static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit); * \param unit the DIE of the compile unit of the current DIE * \param frame containg frame if any */ -static void MC_dwarf_handle_die(mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t frame, +static void MC_dwarf_handle_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns); /** \brief Process a type DIE */ -static void MC_dwarf_handle_type_die(mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t frame, +static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns); /** \brief Calls MC_dwarf_handle_die on all childrend of the given die @@ -83,8 +84,8 @@ static void MC_dwarf_handle_type_die(mc_object_info_t info, Dwarf_Die * die, * \param unit the DIE of the compile unit of the current DIE * \param frame containg frame if any */ -static void MC_dwarf_handle_children(mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t frame, +static void MC_dwarf_handle_children(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns); /** \brief Handle a variable (DW_TAG_variable or other) @@ -94,8 +95,8 @@ static void MC_dwarf_handle_children(mc_object_info_t info, Dwarf_Die * die, * \param unit the DIE of the compile unit of the current DIE * \param frame containg frame if any */ -static void MC_dwarf_handle_variable_die(mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t frame, +static void MC_dwarf_handle_variable_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns); /** \brief Get the DW_TAG_type of the DIE @@ -105,18 +106,36 @@ static void MC_dwarf_handle_variable_die(mc_object_info_t info, Dwarf_Die * die, */ static std::uint64_t MC_dwarf_at_type(Dwarf_Die * die); -/** \brief A class of DWARF tags (DW_TAG_*) - */ -typedef enum mc_tag_class { - mc_tag_unknown, - mc_tag_type, - mc_tag_subprogram, - mc_tag_variable, - mc_tag_scope, - mc_tag_namespace -} mc_tag_class; - -static mc_tag_class MC_dwarf_tag_classify(int tag) +namespace simgrid { +namespace dwarf { + +enum class TagClass { + Unknown, + Type, + Subprogram, + Variable, + Scope, + Namespace +}; + +/*** Class of forms defined in the DWARF standard */ +enum class FormClass { + Unknown, + Address, // Location in the program's address space + Block, // Arbitrary block of bytes + Constant, + String, + Flag, // Boolean value + Reference, // Reference to another DIE + ExprLoc, // DWARF expression/location description + LinePtr, + LocListPtr, + MacPtr, + RangeListPtr +}; + +XBT_PRIVATE +TagClass classify_tag(int tag) { switch (tag) { @@ -143,44 +162,30 @@ static mc_tag_class MC_dwarf_tag_classify(int tag) case DW_TAG_interface_type: case DW_TAG_unspecified_type: case DW_TAG_shared_type: - return mc_tag_type; + return TagClass::Type; case DW_TAG_subprogram: - return mc_tag_subprogram; + return TagClass::Subprogram; case DW_TAG_variable: case DW_TAG_formal_parameter: - return mc_tag_variable; + return TagClass::Variable; 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; + return TagClass::Scope; case DW_TAG_namespace: - return mc_tag_namespace; + return TagClass::Namespace; default: - return mc_tag_unknown; - + return TagClass::Unknown; } } -#define MC_DW_CLASS_UNKNOWN 0 -#define MC_DW_CLASS_ADDRESS 1 // Location in the address space of the program -#define MC_DW_CLASS_BLOCK 2 // Arbitrary block of bytes -#define MC_DW_CLASS_CONSTANT 3 -#define MC_DW_CLASS_STRING 3 // String -#define MC_DW_CLASS_FLAG 4 // Boolean -#define MC_DW_CLASS_REFERENCE 5 // Reference to another DIE -#define MC_DW_CLASS_EXPRLOC 6 // DWARF expression/location description -#define MC_DW_CLASS_LINEPTR 7 -#define MC_DW_CLASS_LOCLISTPTR 8 -#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. @@ -188,42 +193,43 @@ static mc_tag_class MC_dwarf_tag_classify(int tag) * \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) +XBT_PRIVATE +FormClass classify_form(int form) { switch (form) { case DW_FORM_addr: - return MC_DW_CLASS_ADDRESS; + return FormClass::Address; case DW_FORM_block2: case DW_FORM_block4: case DW_FORM_block: case DW_FORM_block1: - return MC_DW_CLASS_BLOCK; + return FormClass::Block; case DW_FORM_data1: case DW_FORM_data2: case DW_FORM_data4: case DW_FORM_data8: case DW_FORM_udata: case DW_FORM_sdata: - return MC_DW_CLASS_CONSTANT; + return FormClass::Constant; case DW_FORM_string: case DW_FORM_strp: - return MC_DW_CLASS_STRING; + return FormClass::String; case DW_FORM_ref_addr: case DW_FORM_ref1: case DW_FORM_ref2: case DW_FORM_ref4: case DW_FORM_ref8: case DW_FORM_ref_udata: - return MC_DW_CLASS_REFERENCE; + return FormClass::Reference; case DW_FORM_flag: case DW_FORM_flag_present: - return MC_DW_CLASS_FLAG; + return FormClass::Flag; case DW_FORM_exprloc: - return MC_DW_CLASS_EXPRLOC; + return FormClass::ExprLoc; // TODO sec offset // TODO indirect default: - return MC_DW_CLASS_UNKNOWN; + return FormClass::Unknown; } } @@ -232,9 +238,13 @@ static int MC_dwarf_form_get_class(int form) * \param die DIE * \return name of the tag of this DIE */ -static inline const char *MC_dwarf_die_tagname(Dwarf_Die * die) +inline XBT_PRIVATE +const char *tagname(Dwarf_Die * die) { - return MC_dwarf_tagname(dwarf_tag(die)); + return simgrid::dwarf::tagname(dwarf_tag(die)); +} + +} } // ***** Attributes @@ -277,30 +287,26 @@ static const char *MC_dwarf_at_linkage_name(Dwarf_Die * die) static Dwarf_Off MC_dwarf_attr_dieoffset(Dwarf_Die * die, int attribute) { Dwarf_Attribute attr; - 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 + if (dwarf_hasattr_integrate(die, attribute) == 0) return 0; + 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); } 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 + if (dwarf_hasattr_integrate(die, attribute) == 0) return 0; + 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); } /** \brief Find the type/subtype (DW_AT_type) for a DIE @@ -346,7 +352,8 @@ static bool MC_dwarf_attr_flag(Dwarf_Die * die, int attribute, bool integrate) bool result; if (dwarf_formflag(&attr, &result)) - xbt_die("Unexpected form for attribute %s", MC_dwarf_attrname(attribute)); + xbt_die("Unexpected form for attribute %s", + simgrid::dwarf::attrname(attribute)); return result; } @@ -402,27 +409,25 @@ static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die * die, 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)); + simgrid::dwarf::tagname(die)); // Use DW_TAG_count if present: - if (dwarf_hasattr_integrate(die, DW_AT_count)) { + if (dwarf_hasattr_integrate(die, DW_AT_count)) return MC_dwarf_attr_integrate_uint(die, DW_AT_count, 0); - } // Otherwise compute DW_TAG_upper_bound-DW_TAG_lower_bound + 1: - if (!dwarf_hasattr_integrate(die, DW_AT_upper_bound)) { + if (!dwarf_hasattr_integrate(die, DW_AT_upper_bound)) // This is not really 0, but the code expects this (we do not know): return 0; - } + 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)) { + if (dwarf_hasattr_integrate(die, DW_AT_lower_bound)) lower_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_lower_bound, -1); - } else { + else lower_bound = MC_dwarf_default_lower_bound(dwarf_srclang(unit)); - } return upper_bound - lower_bound + 1; } @@ -439,7 +444,7 @@ 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)); + simgrid::dwarf::tagname(die)); int result = 1; Dwarf_Die child; @@ -448,14 +453,31 @@ static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit) res = dwarf_siblingof(&child, &child)) { int child_tag = dwarf_tag(&child); if (child_tag == DW_TAG_subrange_type - || child_tag == DW_TAG_enumeration_type) { + || child_tag == DW_TAG_enumeration_type) result *= MC_dwarf_subrange_element_count(&child, unit); - } } return result; } -// ***** mc_type_t +// ***** Variable + +/** Sort the variable by name and address. + * + * We could use boost::container::flat_set instead. + */ +static bool MC_compare_variable( + simgrid::mc::Variable const& a, simgrid::mc::Variable const& b) +{ + int cmp = strcmp(a.name.c_str(), b.name.c_str()); + if (cmp < 0) + return true; + else if (cmp > 0) + return false; + else + return a.address < b.address; +} + +// ***** simgrid::mc::Type* /** \brief Initialize the location of a member of a type * (DW_AT_data_member_location of a DW_TAG_member). @@ -464,45 +486,41 @@ static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit) * \param member the member of the type * \param child DIE of the member (DW_TAG_member) */ -static void MC_dwarf_fill_member_location(mc_type_t type, mc_type_t member, - Dwarf_Die * child) +static void MC_dwarf_fill_member_location( + simgrid::mc::Type* type, simgrid::mc::Member* member, Dwarf_Die * child) { - if (dwarf_hasattr(child, DW_AT_data_bit_offset)) { + 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 <%" - PRIx64 ">%s", member->name.c_str(), - (uint64_t) type->id, type->name.c_str()); - } else { + if (type->type == DW_TAG_union_type) return; - } + xbt_die + ("Missing DW_AT_data_member_location field in DW_TAG_member %s of type <%" + PRIx64 ">%s", member->name.c_str(), + (uint64_t) type->id, type->name.c_str()); } Dwarf_Attribute attr; dwarf_attr_integrate(child, DW_AT_data_member_location, &attr); int form = dwarf_whatform(&attr); - int klass = MC_dwarf_form_get_class(form); - switch (klass) { - case MC_DW_CLASS_EXPRLOC: - case MC_DW_CLASS_BLOCK: + simgrid::dwarf::FormClass form_class = simgrid::dwarf::classify_form(form); + switch (form_class) { + case simgrid::dwarf::FormClass::ExprLoc: + case simgrid::dwarf::FormClass::Block: // Location expression: { Dwarf_Op *expr; size_t len; - if (dwarf_getlocation(&attr, &expr, &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 <%" PRIx64 ">%s", MC_dwarf_attr_integrate_string(child, DW_AT_name), (uint64_t) type->id, type->name.c_str()); - } - simgrid::mc::DwarfExpression(expr, expr+len); + member->location_expression = simgrid::dwarf::DwarfExpression(expr, expr+len); break; } - case MC_DW_CLASS_CONSTANT: + case simgrid::dwarf::FormClass::Constant: // Offset from the base address of the object: { Dwarf_Word offset; @@ -514,24 +532,19 @@ static void MC_dwarf_fill_member_location(mc_type_t type, mc_type_t member, (uint64_t) type->id, type->name.c_str()); break; } - case MC_DW_CLASS_LOCLISTPTR: + case simgrid::dwarf::FormClass::LocListPtr: // Reference to a location list: // TODO - case MC_DW_CLASS_REFERENCE: + case simgrid::dwarf::FormClass::Reference: // It's supposed to be possible in DWARF2 but I couldn't find its semantic // in the spec. default: xbt_die("Can't handle form class (%i) / form 0x%x as DW_AT_member_location", - klass, form); + (int) form_class, form); } } -static void dw_type_free_voidp(void *t) -{ - delete *(mc_type_t*)t; -} - /** \brief Populate the list of members of a type * * \param info ELF object containing the type DIE @@ -539,8 +552,8 @@ static void dw_type_free_voidp(void *t) * \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, mc_type_t type) +static void MC_dwarf_add_members(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Type* type) { int res; Dwarf_Die child; @@ -559,31 +572,25 @@ static void MC_dwarf_add_members(mc_object_info_t info, Dwarf_Die * die, continue; // TODO, we should use another type (because is is not a type but a member) - simgrid::mc::Type member; - member.type = tag; - - // Global Offset: - member.id = dwarf_dieoffset(&child); + simgrid::mc::Member member; + member.inheritance = tag == DW_TAG_inheritance; const char *name = MC_dwarf_attr_integrate_string(&child, DW_AT_name); if (name) member.name = name; member.byte_size = MC_dwarf_attr_integrate_uint(&child, DW_AT_byte_size, 0); - member.element_count = -1; member.type_id = MC_dwarf_at_type(&child); - if (dwarf_hasattr(&child, DW_AT_data_bit_offset)) { + if (dwarf_hasattr(&child, DW_AT_data_bit_offset)) xbt_die("Can't groke DW_AT_data_bit_offset."); - } MC_dwarf_fill_member_location(type, &member, &child); - if (!member.type_id) { + if (!member.type_id) xbt_die("Missing type for member %s of <%" PRIx64 ">%s", member.name.c_str(), (uint64_t) type->id, type->name.c_str()); - } type->members.push_back(std::move(member)); } @@ -598,18 +605,15 @@ static void MC_dwarf_add_members(mc_object_info_t info, Dwarf_Die * die, * \return MC representation of the type */ static simgrid::mc::Type MC_dwarf_die_to_type( - mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t frame, + simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns) { - simgrid::mc::Type type; - type.type = -1; + type.type = dwarf_tag(die); type.name = std::string(); type.element_count = -1; - type.type = dwarf_tag(die); - // Global Offset type.id = dwarf_dieoffset(die); @@ -651,9 +655,8 @@ static simgrid::mc::Type MC_dwarf_die_to_type( || type.type == DW_TAG_structure_type || type.type == DW_TAG_class_type) { Dwarf_Word size; - if (dwarf_aggregate_size(die, &size) == 0) { + if (dwarf_aggregate_size(die, &size) == 0) type.byte_size = size; - } } switch (type.type) { @@ -682,8 +685,8 @@ static simgrid::mc::Type MC_dwarf_die_to_type( return std::move(type); } -static void MC_dwarf_handle_type_die(mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t frame, +static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns) { simgrid::mc::Type type = MC_dwarf_die_to_type(info, die, unit, frame, ns); @@ -695,8 +698,8 @@ static void MC_dwarf_handle_type_die(mc_object_info_t info, Dwarf_Die * die, static int mc_anonymous_variable_index = 0; static std::unique_ptr MC_die_to_variable( - mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t frame, + simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns) { // Skip declarations: @@ -708,10 +711,9 @@ static std::unique_ptr MC_die_to_variable( return nullptr; Dwarf_Attribute attr_location; - if (dwarf_attr(die, DW_AT_location, &attr_location) == NULL) { + if (dwarf_attr(die, DW_AT_location, &attr_location) == NULL) // No location: do not add it ? return nullptr; - } std::unique_ptr variable = std::unique_ptr(new simgrid::mc::Variable()); @@ -725,12 +727,14 @@ static std::unique_ptr MC_die_to_variable( variable->type_id = MC_dwarf_at_type(die); int form = dwarf_whatform(&attr_location); - int klass = - form == - DW_FORM_sec_offset ? MC_DW_CLASS_CONSTANT : MC_dwarf_form_get_class(form); - switch (klass) { - case MC_DW_CLASS_EXPRLOC: - case MC_DW_CLASS_BLOCK: + simgrid::dwarf::FormClass form_class; + if (form == DW_FORM_sec_offset) + form_class = simgrid::dwarf::FormClass::Constant; + else + form_class = simgrid::dwarf::classify_form(form); + switch (form_class) { + case simgrid::dwarf::FormClass::ExprLoc: + case simgrid::dwarf::FormClass::Block: // Location expression: { Dwarf_Op *expr; @@ -749,24 +753,25 @@ static std::unique_ptr MC_die_to_variable( uintptr_t base = (uintptr_t) info->base_address(); variable->address = (void *) (base + offset); } else { - simgrid::mc::LocationListEntry entry; + simgrid::dwarf::LocationListEntry entry; entry.expression = {expr, expr + len}; variable->location_list = { std::move(entry) }; } break; } - case MC_DW_CLASS_LOCLISTPTR: - case MC_DW_CLASS_CONSTANT: + + case simgrid::dwarf::FormClass::LocListPtr: + case simgrid::dwarf::FormClass::Constant: // Reference to location list: - mc_dwarf_location_list_init( - &variable->location_list, info, die, - &attr_location); + variable->location_list = simgrid::dwarf::location_list( + *info, attr_location); break; + default: xbt_die("Unexpected form 0x%x (%i), class 0x%x (%i) list for location " "in <%" PRIx64 ">%s", - form, form, klass, klass, + form, form, (int) form_class, (int) form_class, (uint64_t) variable->dwarf_offset, variable->name.c_str()); } @@ -776,20 +781,21 @@ static std::unique_ptr MC_die_to_variable( Dwarf_Attribute attr; dwarf_attr(die, DW_AT_start_scope, &attr); int form = dwarf_whatform(&attr); - int klass = MC_dwarf_form_get_class(form); - switch (klass) { - case MC_DW_CLASS_CONSTANT: + simgrid::dwarf::FormClass form_class = simgrid::dwarf::classify_form(form); + switch (form_class) { + case simgrid::dwarf::FormClass::Constant: { Dwarf_Word value; variable->start_scope = dwarf_formudata(&attr, &value) == 0 ? (size_t) value : 0; break; } - case MC_DW_CLASS_RANGELISTPTR: // TODO + + case simgrid::dwarf::FormClass::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); + form, (int) form_class, name == NULL ? "?" : name); } } @@ -806,28 +812,37 @@ static std::unique_ptr MC_die_to_variable( return std::move(variable); } -static void MC_dwarf_handle_variable_die(mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t frame, +static void MC_dwarf_handle_variable_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns) { - MC_dwarf_register_variable(info, frame, - MC_die_to_variable(info, die, unit, frame, ns)); + std::unique_ptr variable = + MC_die_to_variable(info, die, unit, frame, ns); + if (!variable) + return; + // Those arrays are sorted later: + else if (variable->global) + info->global_variables.push_back(std::move(*variable)); + else if (frame != nullptr) + frame->variables.push_back(std::move(*variable)); + else + xbt_die("No frame for this local variable"); } -static void MC_dwarf_handle_scope_die(mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t parent_frame, +static void MC_dwarf_handle_scope_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* parent_frame, const char *ns) { // 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); + simgrid::dwarf::TagClass klass = simgrid::dwarf::classify_tag(tag); // (Template) Subprogram declaration: - if (klass == mc_tag_subprogram + if (klass == simgrid::dwarf::TagClass::Subprogram && MC_dwarf_attr_flag(die, DW_AT_declaration, false)) return; - if (klass == mc_tag_scope) + if (klass == simgrid::dwarf::TagClass::Scope) xbt_assert(parent_frame, "No parent scope for this scope"); simgrid::mc::Frame frame; @@ -836,12 +851,14 @@ static void MC_dwarf_handle_scope_die(mc_object_info_t info, Dwarf_Die * die, frame.id = dwarf_dieoffset(die); frame.object_info = info; - if (klass == mc_tag_subprogram) { + if (klass == simgrid::dwarf::TagClass::Subprogram) { const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name); if(ns) frame.name = std::string(ns) + "::" + name; - else + else if (name) frame.name = name; + else + frame.name.clear(); } frame.abstract_origin_id = @@ -865,10 +882,10 @@ static void MC_dwarf_handle_scope_die(mc_object_info_t info, Dwarf_Die * die, Dwarf_Sword offset; Dwarf_Addr high_pc; - switch (MC_dwarf_form_get_class(dwarf_whatform(&attr))) { + switch (simgrid::dwarf::classify_form(dwarf_whatform(&attr))) { // DW_AT_high_pc if an offset from the low_pc: - case MC_DW_CLASS_CONSTANT: + case simgrid::dwarf::FormClass::Constant: if (dwarf_formsdata(&attr, &offset) != 0) xbt_die("Could not read constant"); @@ -876,7 +893,7 @@ static void MC_dwarf_handle_scope_die(mc_object_info_t info, Dwarf_Die * die, break; // DW_AT_high_pc is a relocatable address: - case MC_DW_CLASS_ADDRESS: + case simgrid::dwarf::FormClass::Address: if (dwarf_formaddr(&attr, &high_pc) != 0) xbt_die("Could not read address"); frame.high_pc = ((char *) base) + high_pc; @@ -888,30 +905,30 @@ static void MC_dwarf_handle_scope_die(mc_object_info_t info, Dwarf_Die * die, } } - if (klass == mc_tag_subprogram) { + if (klass == simgrid::dwarf::TagClass::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.frame_base_location = simgrid::dwarf::location_list(*info, + attr_frame_base); } // Handle children: MC_dwarf_handle_children(info, die, unit, &frame, ns); - // Register it: - if (klass == mc_tag_subprogram) { - char *key = bprintf("%" PRIx64, (uint64_t) frame.id); + // Someone needs this to be sorted but who? + std::sort(frame.variables.begin(), frame.variables.end(), + MC_compare_variable); - xbt_dict_set(info->subprograms, key, - new simgrid::mc::Frame(std::move(frame)), NULL); - xbt_free(key); - } else if (klass == mc_tag_scope) + // Register it: + if (klass == simgrid::dwarf::TagClass::Subprogram) + info->subprograms[frame.id] = frame; + else if (klass == simgrid::dwarf::TagClass::Scope) parent_frame->scopes.push_back(std::move(frame)); } -static void mc_dwarf_handle_namespace_die(mc_object_info_t info, +static void mc_dwarf_handle_namespace_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, Dwarf_Die * unit, - mc_frame_t frame, + simgrid::mc::Frame* frame, const char *ns) { const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name); @@ -923,8 +940,8 @@ static void mc_dwarf_handle_namespace_die(mc_object_info_t info, xbt_free(new_ns); } -static void MC_dwarf_handle_children(mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t frame, +static void MC_dwarf_handle_children(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns) { // For each child DIE: @@ -936,31 +953,31 @@ static void MC_dwarf_handle_children(mc_object_info_t info, Dwarf_Die * die, } } -static void MC_dwarf_handle_die(mc_object_info_t info, Dwarf_Die * die, - Dwarf_Die * unit, mc_frame_t frame, +static void MC_dwarf_handle_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, + Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns) { int tag = dwarf_tag(die); - mc_tag_class klass = MC_dwarf_tag_classify(tag); + simgrid::dwarf::TagClass klass = simgrid::dwarf::classify_tag(tag); switch (klass) { // Type: - case mc_tag_type: + case simgrid::dwarf::TagClass::Type: MC_dwarf_handle_type_die(info, die, unit, frame, ns); break; // Subprogram or scope: - case mc_tag_subprogram: - case mc_tag_scope: + case simgrid::dwarf::TagClass::Subprogram: + case simgrid::dwarf::TagClass::Scope: MC_dwarf_handle_scope_die(info, die, unit, frame, ns); return; // Variable: - case mc_tag_variable: + case simgrid::dwarf::TagClass::Variable: MC_dwarf_handle_variable_die(info, die, unit, frame, ns); break; - case mc_tag_namespace: + case simgrid::dwarf::TagClass::Namespace: mc_dwarf_handle_namespace_die(info, die, unit, frame, ns); break; @@ -970,39 +987,51 @@ static void MC_dwarf_handle_die(mc_object_info_t info, Dwarf_Die * die, } } +static +Elf64_Half MC_dwarf_elf_type(Dwarf* dwarf) +{ + Elf* elf = dwarf_getelf(dwarf); + Elf64_Ehdr* ehdr64 = elf64_getehdr(elf); + if (ehdr64) + return ehdr64->e_type; + Elf32_Ehdr* ehdr32 = elf32_getehdr(elf); + if (ehdr32) + return ehdr32->e_type; + xbt_die("Could not get ELF heeader"); +} + /** \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) +static +void MC_dwarf_get_variables(simgrid::mc::ObjectInformation* info) { - int fd = open(info->file_name, O_RDONLY); - if (fd < 0) { - xbt_die("Could not open file %s", info->file_name); - } + int fd = open(info->file_name.c_str(), O_RDONLY); + if (fd < 0) + xbt_die("Could not open file %s", info->file_name.c_str()); Dwarf *dwarf = dwarf_begin(fd, DWARF_C_READ); - if (dwarf == NULL) { - xbt_die("Your program must be compiled with -g (%s)", info->file_name); - } + if (dwarf == NULL) + xbt_die("Missing debugging information in %s\n" + "Your program and its dependencies must have debugging information.\n" + "You might want to recompile with -g or install the suitable debugging package.\n", + info->file_name.c_str()); + + Elf64_Half elf_type = MC_dwarf_elf_type(dwarf); + if (elf_type == ET_EXEC) + info->flags |= simgrid::mc::ObjectInformation::Executable; + // 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); - } - - } + if (dwarf_offdie(dwarf, offset + length, &unit_die) != NULL) + MC_dwarf_handle_children(info, &unit_die, &unit_die, NULL, NULL); offset = next_offset; } @@ -1012,8 +1041,8 @@ void MC_dwarf_get_variables(mc_object_info_t info) // ***** Functions index -static int MC_compare_frame_index_items(mc_function_index_item_t a, - mc_function_index_item_t b) +static int MC_compare_frame_index_items(simgrid::mc::FunctionIndexEntry* a, + simgrid::mc::FunctionIndexEntry* b) { if (a->low_pc < b->low_pc) return -1; @@ -1023,70 +1052,59 @@ static int MC_compare_frame_index_items(mc_function_index_item_t a, return 1; } -static void MC_make_functions_index(mc_object_info_t info) +static void MC_make_functions_index(simgrid::mc::ObjectInformation* info) { - xbt_dynar_t index = xbt_dynar_new(sizeof(s_mc_function_index_item_t), NULL); - - // Populate the array: - mc_frame_t frame = NULL; - xbt_dict_cursor_t cursor; - char *key; - xbt_dict_foreach(info->subprograms, cursor, key, frame) { - if (frame->low_pc == NULL) + info->functions_index.clear(); + + for (auto& e : info->subprograms) { + if (e.second.low_pc == nullptr) continue; - s_mc_function_index_item_t entry; - entry.low_pc = frame->low_pc; - entry.high_pc = frame->high_pc; - entry.function = frame; - xbt_dynar_push(index, &entry); + simgrid::mc::FunctionIndexEntry entry; + entry.low_pc = e.second.low_pc; + entry.function = &e.second; + info->functions_index.push_back(entry); } - mc_function_index_item_t base = - (mc_function_index_item_t) xbt_dynar_get_ptr(index, 0); + info->functions_index.shrink_to_fit(); // Sort the array by low_pc: - qsort(base, - xbt_dynar_length(index), - sizeof(s_mc_function_index_item_t), - (int (*)(const void *, const void *)) MC_compare_frame_index_items); - - info->functions_index = index; + std::sort(info->functions_index.begin(), info->functions_index.end(), + [](simgrid::mc::FunctionIndexEntry const& a, + simgrid::mc::FunctionIndexEntry const& b) + { + return a.low_pc < b.low_pc; + }); } -static void MC_post_process_variables(mc_object_info_t info) +static void MC_post_process_variables(simgrid::mc::ObjectInformation* info) { + // Someone needs this to be sorted but who? + std::sort(info->global_variables.begin(), info->global_variables.end(), + MC_compare_variable); + for(simgrid::mc::Variable& variable : info->global_variables) - if (variable.type_id) { - auto i = info->types.find(variable.type_id); - if (i != info->types.end()) - variable.type = &(i->second); - else - variable.type = nullptr; - } + if (variable.type_id) + variable.type = simgrid::util::find_map_ptr( + info->types, variable.type_id); } -static void mc_post_process_scope(mc_object_info_t info, mc_frame_t scope) +static void mc_post_process_scope(simgrid::mc::ObjectInformation* info, simgrid::mc::Frame* scope) { if (scope->tag == DW_TAG_inlined_subroutine) { - // Attach correct namespaced name in inlined subroutine: - char *key = bprintf("%" PRIx64, (uint64_t) scope->abstract_origin_id); - mc_frame_t abstract_origin = (mc_frame_t) xbt_dict_get_or_null(info->subprograms, key); - xbt_assert(abstract_origin, "Could not lookup abstract origin %s", key); - xbt_free(key); - scope->name = abstract_origin->name; + auto i = info->subprograms.find(scope->abstract_origin_id); + xbt_assert(i != info->subprograms.end(), + "Could not lookup abstract origin %" PRIx64, + (std::uint64_t) scope->abstract_origin_id); + scope->name = i->second.name; } // Direct: for (simgrid::mc::Variable& variable : scope->variables) - if (variable.type_id) { - auto i = info->types.find(variable.type_id); - if (i != info->types.end()) - variable.type = &(i->second); - else - variable.type = nullptr; - } + if (variable.type_id) + variable.type = simgrid::util::find_map_ptr( + info->types, variable.type_id); // Recursive post-processing of nested-scopes: for (simgrid::mc::Frame& nested_scope : scope->scopes) @@ -1094,173 +1112,75 @@ static void mc_post_process_scope(mc_object_info_t info, mc_frame_t scope) } -static void MC_post_process_functions(mc_object_info_t info) +static +simgrid::mc::Type* MC_resolve_type( + simgrid::mc::ObjectInformation* info, unsigned type_id) { - xbt_dict_cursor_t cursor; - char *key; - mc_frame_t subprogram = NULL; - xbt_dict_foreach(info->subprograms, cursor, key, subprogram) { - mc_post_process_scope(info, subprogram); - } -} + if (!type_id) + return nullptr; + simgrid::mc::Type* type = simgrid::util::find_map_ptr(info->types, type_id); + if (type == nullptr) + return nullptr; + // We already have the information on the type: + if (type->byte_size != 0) + return type; + + // Don't have a name, we can't find a more complete version: + if (type->name.empty()) + return type; -/** \brief Fill/lookup the "subtype" field. - */ -static void MC_resolve_subtype(mc_object_info_t info, mc_type_t type) -{ - if (!type->type_id) - return; - auto i = info->types.find(type->type_id); - if (i != info->types.end()) - type->subtype = &(i->second); - else { - type->subtype = nullptr; - return; - } - if (type->subtype->byte_size != 0) - return; - if (type->subtype->name.empty()) - return; // Try to find a more complete description of the type: // We need to fix in order to support C++. - - auto j = info->full_types_by_name.find(type->subtype->name); - if (j != info->full_types_by_name.end()) - type->subtype = j->second; + simgrid::mc::Type** subtype = simgrid::util::find_map_ptr( + info->full_types_by_name, type->name); + if (subtype) + type = *subtype; + return type; } -static void MC_post_process_types(mc_object_info_t info) +static void MC_post_process_types(simgrid::mc::ObjectInformation* info) { // Lookup "subtype" field: for(auto& i : info->types) { - MC_resolve_subtype(info, &(i.second)); - for (simgrid::mc::Type& member : i.second.members) - MC_resolve_subtype(info, &member); + i.second.subtype = MC_resolve_type(info, i.second.type_id); + for (simgrid::mc::Member& member : i.second.members) + member.type = MC_resolve_type(info, member.type_id); } } /** \brief Finds informations about a given shared object/executable */ -std::shared_ptr MC_find_object_info( - std::vector const& maps, const char *name, int executable) +std::shared_ptr MC_find_object_info( + std::vector const& maps, const char *name) { - std::shared_ptr result = - std::make_shared(); - if (executable) - result->flags |= MC_OBJECT_INFO_EXECUTABLE; - result->file_name = xbt_strdup(name); + std::shared_ptr result = + std::make_shared(); + result->file_name = name; MC_find_object_address(maps, result.get()); MC_dwarf_get_variables(result.get()); - MC_post_process_types(result.get()); MC_post_process_variables(result.get()); - MC_post_process_functions(result.get()); + MC_post_process_types(result.get()); + for (auto& entry : result.get()->subprograms) + mc_post_process_scope(result.get(), &entry.second); MC_make_functions_index(result.get()); return std::move(result); } /*************************************************************************/ -static int MC_dwarf_get_variable_index( - std::vector variables, const char *var, void *address) -{ - - if (variables.empty()) - return 0; - - unsigned int cursor = 0; - int start = 0; - int end = variables.size() - 1; - mc_variable_t var_test = nullptr; - - while (start <= end) { - cursor = (start + end) / 2; - var_test = &variables[cursor]; - if (strcmp(var_test->name.c_str(), var) < 0) { - start = cursor + 1; - } else if (strcmp(var_test->name.c_str(), var) > 0) { - end = cursor - 1; - } else { - if (address) { /* global variable */ - if (var_test->address == address) - return -1; - if (var_test->address > address) - end = cursor - 1; - else - start = cursor + 1; - } else { /* local variable */ - return -1; - } - } - } - - if (strcmp(var_test->name.c_str(), var) == 0) { - if (address && var_test->address < address) - return cursor + 1; - else - return cursor; - } else if (strcmp(var_test->name.c_str(), var) < 0) - return cursor + 1; - else - return cursor; - -} - -void MC_dwarf_register_global_variable( - mc_object_info_t info, - std::unique_ptr variable) -{ - int index = - MC_dwarf_get_variable_index(info->global_variables, - variable->name.c_str(), - variable->address); - if (index != -1) - info->global_variables.insert( - info->global_variables.begin() + index, std::move(*variable)); - // TODO, else ? -} - -void MC_dwarf_register_non_global_variable( - mc_object_info_t info, - mc_frame_t frame, - std::unique_ptr variable) -{ - xbt_assert(frame, "Frame is NULL"); - int index = - MC_dwarf_get_variable_index( - frame->variables, variable->name.c_str(), NULL); - if (index != -1) - frame->variables.insert( - frame->variables.begin() + index, std::move(*variable)); - // TODO, else ? -} - -void MC_dwarf_register_variable( - mc_object_info_t info, mc_frame_t frame, - std::unique_ptr variable) -{ - if (!variable) - return; - if (variable->global) - MC_dwarf_register_global_variable(info, std::move(variable)); - else if (frame != nullptr) - MC_dwarf_register_non_global_variable(info, frame, std::move(variable)); - else - xbt_die("No frame for this local variable"); -} - -void MC_post_process_object_info(mc_process_t process, mc_object_info_t info) +void MC_post_process_object_info(simgrid::mc::Process* process, simgrid::mc::ObjectInformation* info) { for (auto& i : info->types) { - mc_type_t type = &(i.second); - mc_type_t subtype = type; - while (subtype->type == DW_TAG_typedef || subtype->type == DW_TAG_volatile_type - || subtype->type == DW_TAG_const_type) { + simgrid::mc::Type* type = &(i.second); + simgrid::mc::Type* subtype = type; + while (subtype->type == DW_TAG_typedef + || subtype->type == DW_TAG_volatile_type + || subtype->type == DW_TAG_const_type) if (subtype->subtype) subtype = subtype->subtype; else break; - } // Resolve full_type: if (!subtype->name.empty() && subtype->byte_size == 0) { @@ -1276,3 +1196,80 @@ void MC_post_process_object_info(mc_process_t process, mc_object_info_t info) } } + +namespace simgrid { +namespace dwarf { + +/** Convert a DWARF register into a libunwind register + * + * DWARF and libunwind does not use the same convention for numbering the + * registers on some architectures. The function makes the necessary + * convertion. + */ +int dwarf_register_to_libunwind(int dwarf_register) +{ +#if defined(__x86_64__) + // It seems for this arch, DWARF and libunwind agree in the numbering: + return dwarf_register; +#elif defined(__i386__) + // Could't find the authoritative source of information for this. + // This is inspired from http://source.winehq.org/source/dlls/dbghelp/cpu_i386.c#L517. + switch (dwarf_register) { + case 0: + return UNW_X86_EAX; + case 1: + return UNW_X86_ECX; + case 2: + return UNW_X86_EDX; + case 3: + return UNW_X86_EBX; + case 4: + return UNW_X86_ESP; + case 5: + return UNW_X86_EBP; + case 6: + return UNW_X86_ESI; + case 7: + return UNW_X86_EDI; + case 8: + return UNW_X86_EIP; + case 9: + return UNW_X86_EFLAGS; + case 10: + return UNW_X86_CS; + case 11: + return UNW_X86_SS; + case 12: + return UNW_X86_DS; + case 13: + return UNW_X86_ES; + case 14: + return UNW_X86_FS; + case 15: + return UNW_X86_GS; + case 16: + return UNW_X86_ST0; + case 17: + return UNW_X86_ST1; + case 18: + return UNW_X86_ST2; + case 19: + return UNW_X86_ST3; + case 20: + return UNW_X86_ST4; + case 21: + return UNW_X86_ST5; + case 22: + return UNW_X86_ST6; + case 23: + return UNW_X86_ST7; + default: + xbt_die("Bad/unknown register number."); + } +#else +#error This architecture is not supported yet for DWARF expression evaluation. +#endif +} + +} +} \ No newline at end of file