-/* Copyright (c) 2008-2017. 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. */
#include <fcntl.h>
#include <cstdlib>
-#define DW_LANG_Objc DW_LANG_ObjC /* fix spelling error in older dwarf.h */
-#include <dwarf.h>
#include <elfutils/libdw.h>
#include <boost/algorithm/string/predicate.hpp>
#include "src/simgrid/util.hpp"
#include "xbt/log.h"
+#include "xbt/string.hpp"
#include "xbt/sysdep.h"
-#include <simgrid_config.h>
+#include <simgrid/config.h>
#include "src/mc/mc_dwarf.hpp"
#include "src/mc/mc_private.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.
*
* 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);
}
}
-/** \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)
}
}
-/** \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)
// ***** 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)
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;
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)
}
}
-/** \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)
// 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<uint64_t>(-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<uint64_t>(-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)
{
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());
+ int cmp = a.name.compare(b.name);
if (cmp < 0)
return true;
else if (cmp > 0)
// ***** 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)
}
-/** \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;
}
}
-/** \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,
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);
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;
}
static int mc_anonymous_variable_index = 0;
-static std::unique_ptr<simgrid::mc::Variable> 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<simgrid::mc::Variable> 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))
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;
}
if (dwarf_hasattr(die, DW_AT_start_scope)) {
Dwarf_Attribute attr;
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;
- }
-
- default: // includes FormClass::RangeListPtr (TODO)
- 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);
+ form = dwarf_whatform(&attr);
+ form_class = simgrid::dwarf::classify_form(form);
+ 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);
}
}
// 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;
}
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));
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.
fd = open(debug_file.c_str(), O_RDONLY);
if (fd < 0)
xbt_die("Could not open file %s", debug_file.c_str());
- Dwarf* dwarf = dwarf_begin(fd, DWARF_C_READ);
+ dwarf = dwarf_begin(fd, DWARF_C_READ);
if (dwarf == nullptr)
xbt_die("No DWARF info in %s for %s",
debug_file.c_str(), info->file_name.c_str());
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();
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<simgrid::mc::ObjectInformation> createObjectInformation(
std::vector<simgrid::xbt::VmMap> const& maps, const char *name)
{
void postProcessObjectInformation(simgrid::mc::RemoteClient* process, simgrid::mc::ObjectInformation* info)
{
- for (auto& i : info->types) {
+ for (auto& t : info->types) {
- simgrid::mc::Type* type = &(i.second);
+ simgrid::mc::Type* type = &(t.second);
simgrid::mc::Type* subtype = type;
while (subtype->type == DW_TAG_typedef
|| subtype->type == DW_TAG_volatile_type