X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/22cae46149e1fb4988ad9e46060c3e7ecd4e0e44..debe4e5871c0c3d1c714bbb1bd28ba7147454aa5:/src/mc/mc_dwarf.cpp diff --git a/src/mc/mc_dwarf.cpp b/src/mc/mc_dwarf.cpp index 8cc387cfa0..59655e8539 100644 --- a/src/mc/mc_dwarf.cpp +++ b/src/mc/mc_dwarf.cpp @@ -1,5 +1,4 @@ -/* Copyright (c) 2008-2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2008-2019. 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. */ @@ -14,35 +13,34 @@ #include #include -#define DW_LANG_Objc DW_LANG_ObjC /* fix spelling error in older dwarf.h */ -#include #include #include #include "src/simgrid/util.hpp" #include "xbt/log.h" +#include "xbt/string.hpp" #include "xbt/sysdep.h" -#include +#include -#include "src/mc/mc_private.h" #include "src/mc/mc_dwarf.hpp" +#include "src/mc/mc_private.hpp" -#include "src/mc/Process.hpp" #include "src/mc/ObjectInformation.hpp" #include "src/mc/Variable.hpp" +#include "src/mc/remote/RemoteClient.hpp" XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dwarf, mc, "DWARF processing"); -/** \brief The default DW_TAG_lower_bound for a given DW_AT_language. +/** @brief The default DW_TAG_lower_bound for a given DW_AT_language. * * The default for a given language is defined in the DWARF spec. * - * \param language constant as defined by the DWARf spec + * @param language constant as defined by the DWARf spec */ static uint64_t MC_dwarf_default_lower_bound(int lang); -/** \brief Computes the the element_count of a DW_TAG_enumeration_type DIE +/** @brief Computes the the element_count of a DW_TAG_enumeration_type DIE * * This is the number of elements in a given array dimension. * @@ -50,60 +48,60 @@ static uint64_t MC_dwarf_default_lower_bound(int lang); * needed because the default lower bound (when there is no DW_AT_lower_bound) * depends of the language of the compilation unit (DW_AT_language). * - * \param die DIE for the DW_TAG_enumeration_type or DW_TAG_subrange_type - * \param unit DIE of the DW_TAG_compile_unit + * @param die DIE for the DW_TAG_enumeration_type or DW_TAG_subrange_type + * @param unit DIE of the DW_TAG_compile_unit */ static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die* die, Dwarf_Die* unit); -/** \brief Computes the number of elements of a given DW_TAG_array_type. +/** @brief Computes the number of elements of a given DW_TAG_array_type. * - * \param die DIE for the DW_TAG_array_type + * @param die DIE for the DW_TAG_array_type */ static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit); -/** \brief Process a DIE +/** @brief Process a DIE * - * \param info the resulting object fot the library/binary file (output) - * \param die the current DIE - * \param unit the DIE of the compile unit of the current DIE - * \param frame containing frame if any + * @param info the resulting object fot the library/binary file (output) + * @param die the current DIE + * @param unit the DIE of the compile unit of the current DIE + * @param frame containing frame if any */ 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 +/** @brief Process a type DIE */ 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 children of the given die +/** @brief Calls MC_dwarf_handle_die on all children of the given die * - * \param info the resulting object fot the library/binary file (output) - * \param die the current DIE - * \param unit the DIE of the compile unit of the current DIE - * \param frame containing frame if any + * @param info the resulting object fot the library/binary file (output) + * @param die the current DIE + * @param unit the DIE of the compile unit of the current DIE + * @param frame containing frame if any */ 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) +/** @brief Handle a variable (DW_TAG_variable or other) * - * \param info the resulting object fot the library/binary file (output) - * \param die the current DIE - * \param unit the DIE of the compile unit of the current DIE - * \param frame containing frame if any + * @param info the resulting object fot the library/binary file (output) + * @param die the current DIE + * @param unit the DIE of the compile unit of the current DIE + * @param frame containing frame if any */ 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 +/** @brief Get the DW_TAG_type of the DIE * - * \param die DIE - * \return DW_TAG_type attribute as a new string (nullptr if none) + * @param die DIE + * @return DW_TAG_type attribute as a new string (nullptr if none) */ static std::uint64_t MC_dwarf_at_type(Dwarf_Die * die); @@ -187,12 +185,12 @@ TagClass classify_tag(int tag) } } -/** \brief Find the DWARF data class for a given DWARF data form +/** @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 + * @param form The form (values taken from the DWARF spec) + * @return An internal representation for the corresponding class * */ static FormClass classify_form(int form) @@ -234,10 +232,10 @@ FormClass classify_form(int form) } } -/** \brief Get the name of the tag of a given DIE +/** @brief Get the name of the tag of a given DIE * - * \param die DIE - * \return name of the tag of this DIE + * @param die DIE + * @return name of the tag of this DIE */ inline XBT_PRIVATE const char *tagname(Dwarf_Die * die) @@ -250,11 +248,11 @@ const char *tagname(Dwarf_Die * die) // ***** Attributes -/** \brief Get an attribute of a given DIE as a string +/** @brief Get an attribute of a given DIE as a string * - * \param die the DIE - * \param attribute attribute - * \return value of the given attribute of the given DIE + * @param die the DIE + * @param attribute attribute + * @return value of the given attribute of the given DIE */ static const char *MC_dwarf_attr_integrate_string(Dwarf_Die * die, int attribute) @@ -266,24 +264,6 @@ static const char *MC_dwarf_attr_integrate_string(Dwarf_Die * die, return dwarf_formstring(&attr); } -/** \brief Get the linkage name of a DIE. - * - * 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 the DIE - * \return linkage name of the given DIE (or nullptr) - * */ -static const char *MC_dwarf_at_linkage_name(Dwarf_Die * die) -{ - const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_linkage_name); - if (not name) - name = MC_dwarf_attr_integrate_string(die, DW_AT_MIPS_linkage_name); - return name; -} - static Dwarf_Off MC_dwarf_attr_dieoffset(Dwarf_Die * die, int attribute) { Dwarf_Attribute attr; @@ -309,10 +289,10 @@ static Dwarf_Off MC_dwarf_attr_integrate_dieoffset(Dwarf_Die * die, return dwarf_dieoffset(&subtype_die); } -/** \brief Find the type/subtype (DW_AT_type) for a DIE +/** @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 nullptr) + * @param die the DIE + * @return DW_AT_type reference as a global offset in hexadecimal (or nullptr) */ static std::uint64_t MC_dwarf_at_type(Dwarf_Die * die) @@ -397,11 +377,11 @@ static uint64_t MC_dwarf_default_lower_bound(int lang) } } -/** \brief Finds the number of elements in a DW_TAG_subrange_type or DW_TAG_enumeration_type DIE +/** @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 + * @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) @@ -420,25 +400,24 @@ static uint64_t MC_dwarf_subrange_element_count(Dwarf_Die * die, // 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 upper_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_upper_bound, static_cast(-1)); uint64_t lower_bound = 0; if (dwarf_hasattr_integrate(die, DW_AT_lower_bound)) - lower_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_lower_bound, -1); + lower_bound = MC_dwarf_attr_integrate_uint(die, DW_AT_lower_bound, static_cast(-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) +/** @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 + * @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) { @@ -479,12 +458,12 @@ static bool MC_compare_variable( // ***** simgrid::mc::Type* -/** \brief Initialize the location of a member of a type +/** @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) + * @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( simgrid::mc::Type* type, simgrid::mc::Member* member, Dwarf_Die * child) @@ -532,28 +511,24 @@ static void MC_dwarf_fill_member_location( (uint64_t) type->id, type->name.c_str()); break; } - case simgrid::dwarf::FormClass::LocListPtr: - // Reference to a location list: - // TODO - 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", - (int) form_class, form); + // includes FormClass::LocListPtr (reference to a location list: TODO) and FormClass::Reference (it's supposed to be + // possible in DWARF2 but I couldn't find its semantic in the spec) + xbt_die("Can't handle form class (%d) / form 0x%x as DW_AT_member_location", (int)form_class, (unsigned)form); } } -/** \brief Populate the list of members of a type +/** @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 + * @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(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, - Dwarf_Die * unit, simgrid::mc::Type* 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; @@ -621,12 +596,12 @@ static void MC_dwarf_add_members(simgrid::mc::ObjectInformation* info, Dwarf_Die } } -/** \brief Create a MC type object from a DIE +/** @brief Create a MC type object from a DIE * - * \param info current object info object - * \param DIE (for a given type); - * \param unit compilation unit of the current DIE - * \return MC representation of the type + * @param info current object info object + * @param die DIE (for a given type) + * @param unit compilation unit of the current DIE + * @return MC representation of the type */ static simgrid::mc::Type MC_dwarf_die_to_type( simgrid::mc::ObjectInformation* info, Dwarf_Die * die, @@ -658,10 +633,10 @@ static simgrid::mc::Type MC_dwarf_die_to_type( const char *name = MC_dwarf_attr_integrate_string(die, DW_AT_name); if (name != nullptr) { - char* full_name = ns ? bprintf("%s%s::%s", prefix, ns, name) : - bprintf("%s%s", prefix, name); - type.name = std::string(full_name); - free(full_name); + if (ns) + type.name = simgrid::xbt::string_printf("%s%s::%s", prefix, ns, name); + else + type.name = simgrid::xbt::string_printf("%s%s", prefix, name); } type.type_id = MC_dwarf_at_type(die); @@ -672,7 +647,7 @@ static simgrid::mc::Type MC_dwarf_die_to_type( if (type.type == DW_TAG_pointer_type) type.byte_size = sizeof(void*); - // Computation of the byte_size; + // Computation of the byte_size if (dwarf_hasattr_integrate(die, DW_AT_byte_size)) type.byte_size = MC_dwarf_attr_integrate_uint(die, DW_AT_byte_size, 0); else if (type.type == DW_TAG_array_type @@ -698,10 +673,12 @@ static simgrid::mc::Type MC_dwarf_die_to_type( case DW_TAG_union_type: case DW_TAG_class_type: MC_dwarf_add_members(info, die, unit, &type); - char *new_ns = ns == nullptr ? xbt_strdup(type.name.c_str()) - : bprintf("%s::%s", ns, name); - MC_dwarf_handle_children(info, die, unit, frame, new_ns); - free(new_ns); + MC_dwarf_handle_children(info, die, unit, frame, + ns ? simgrid::xbt::string_printf("%s::%s", ns, name).c_str() : type.name.c_str()); + break; + + default: + XBT_DEBUG("Unhandled type: %d (%s)", type.type, simgrid::dwarf::tagname(type.type)); break; } @@ -720,10 +697,9 @@ static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf static int mc_anonymous_variable_index = 0; -static std::unique_ptr MC_die_to_variable( - simgrid::mc::ObjectInformation* info, Dwarf_Die * die, - Dwarf_Die * unit, simgrid::mc::Frame* frame, - const char *ns) +static std::unique_ptr MC_die_to_variable(simgrid::mc::ObjectInformation* info, Dwarf_Die* die, + Dwarf_Die* /*unit*/, simgrid::mc::Frame* frame, + const char* ns) { // Skip declarations: if (MC_dwarf_attr_flag(die, DW_AT_declaration, false)) @@ -777,7 +753,7 @@ static std::unique_ptr MC_die_to_variable( variable->address = (void *) (base + offset); } else variable->location_list = { - simgrid::dwarf::DwarfExpression(expr, expr + len) }; + simgrid::dwarf::LocationListEntry(simgrid::dwarf::DwarfExpression(expr, expr + len))}; break; } @@ -790,11 +766,8 @@ static std::unique_ptr MC_die_to_variable( break; default: - xbt_die("Unexpected form 0x%x (%i), class 0x%x (%i) list for location " - "in <%" PRIx64 ">%s", - form, form, (int) form_class, (int) form_class, - (uint64_t) variable->id, - variable->name.c_str()); + xbt_die("Unexpected form 0x%x (%i), class 0x%x (%i) list for location in <%" PRIx64 ">%s", (unsigned)form, form, + (unsigned)form_class, (int)form_class, (uint64_t)variable->id, variable->name.c_str()); } // Handle start_scope: @@ -803,20 +776,13 @@ static std::unique_ptr MC_die_to_variable( dwarf_attr(die, DW_AT_start_scope, &attr); int form = dwarf_whatform(&attr); 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 simgrid::dwarf::FormClass::RangeListPtr: // TODO - default: - xbt_die - ("Unhandled form 0x%x, class 0x%X for DW_AT_start_scope of variable %s", - form, (int) form_class, name == nullptr ? "?" : name); + if (form_class == simgrid::dwarf::FormClass::Constant) { + Dwarf_Word value; + variable->start_scope = dwarf_formudata(&attr, &value) == 0 ? (size_t)value : 0; + } else { + // TODO: FormClass::RangeListPtr + xbt_die("Unhandled form 0x%x, class 0x%X for DW_AT_start_scope of variable %s", (unsigned)form, + (unsigned)form_class, name == nullptr ? "?" : name); } } @@ -826,10 +792,10 @@ static std::unique_ptr MC_die_to_variable( // The current code needs a variable name, // generate a fake one: - if (variable->name.empty()) - variable->name = - "@anonymous#" + std::to_string(mc_anonymous_variable_index++); - + if (variable->name.empty()) { + variable->name = "@anonymous#" + std::to_string(mc_anonymous_variable_index); + mc_anonymous_variable_index++; + } return variable; } @@ -842,7 +808,7 @@ static void MC_dwarf_handle_variable_die(simgrid::mc::ObjectInformation* info, D if (not variable) return; // Those arrays are sorted later: - else if (variable->global) + if (variable->global) info->global_variables.push_back(std::move(*variable)); else if (frame != nullptr) frame->variables.push_back(std::move(*variable)); @@ -1139,7 +1105,7 @@ std::string find_by_build_id(std::vector id) { std::string filename; std::string hex = to_hex(id); - for (const char* debug_path : debug_paths) { + for (const char* const& debug_path : debug_paths) { // Example: filename = std::string(debug_path) + ".build-id/" + to_hex(id.data(), 1) + '/' @@ -1154,7 +1120,7 @@ std::string find_by_build_id(std::vector id) return std::string(); } -/** \brief Populate the debugging informations of the given ELF object +/** @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. @@ -1194,8 +1160,8 @@ void MC_load_dwarf(simgrid::mc::ObjectInformation* info) // If there was no DWARF in the file, try to find it in a separate file. // Different methods might be used to store the DWARF informations: - // * GNU NT_GNU_BUILD_ID; - // * .gnu_debuglink. + // * GNU NT_GNU_BUILD_ID + // * .gnu_debuglink // See https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html // for reference of what we are doing. @@ -1236,23 +1202,12 @@ void MC_load_dwarf(simgrid::mc::ObjectInformation* info) elf_end(elf); close(fd); xbt_die("Debugging information not found for %s\n" - "Try recompiling with -g\n", - info->file_name.c_str()); + "Try recompiling with -g\n", + info->file_name.c_str()); } // ***** Functions index -static int MC_compare_frame_index_items(simgrid::mc::FunctionIndexEntry* a, - simgrid::mc::FunctionIndexEntry* b) -{ - if (a->low_pc < b->low_pc) - return -1; - else if (a->low_pc == b->low_pc) - return 0; - else - return 1; -} - static void MC_make_functions_index(simgrid::mc::ObjectInformation* info) { info->functions_index.clear(); @@ -1282,7 +1237,7 @@ static void MC_post_process_variables(simgrid::mc::ObjectInformation* info) // Someone needs this to be sorted but who? boost::range::sort(info->global_variables, MC_compare_variable); - for(simgrid::mc::Variable& variable : info->global_variables) + for (simgrid::mc::Variable& variable : info->global_variables) if (variable.type_id) variable.type = simgrid::util::find_map_ptr( info->types, variable.type_id); @@ -1308,8 +1263,7 @@ static void mc_post_process_scope(simgrid::mc::ObjectInformation* info, simgrid: // Recursive post-processing of nested-scopes: for (simgrid::mc::Frame& nested_scope : scope->scopes) - mc_post_process_scope(info, &nested_scope); - + mc_post_process_scope(info, &nested_scope); } static @@ -1342,7 +1296,7 @@ simgrid::mc::Type* MC_resolve_type( static void MC_post_process_types(simgrid::mc::ObjectInformation* info) { // Lookup "subtype" field: - for(auto& i : info->types) { + for (auto& i : info->types) { 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); @@ -1352,7 +1306,7 @@ static void MC_post_process_types(simgrid::mc::ObjectInformation* info) namespace simgrid { namespace mc { -/** \brief Finds informations about a given shared object/executable */ +/** @brief Finds informations about a given shared object/executable */ std::shared_ptr createObjectInformation( std::vector const& maps, const char *name) { @@ -1371,7 +1325,7 @@ std::shared_ptr createObjectInformation( /*************************************************************************/ -void postProcessObjectInformation(simgrid::mc::Process* process, simgrid::mc::ObjectInformation* info) +void postProcessObjectInformation(simgrid::mc::RemoteClient* process, simgrid::mc::ObjectInformation* info) { for (auto& i : info->types) {