Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Simplify lookup of maps
[simgrid.git] / src / mc / mc_dwarf.cpp
index 91e62c0..ed26c43 100644 (file)
@@ -6,6 +6,7 @@
 
 #include <cinttypes>
 
+#include <algorithm>
 #include <memory>
 
 #include <stdlib.h>
 #include <elfutils/libdw.h>
 
 #include <simgrid_config.h>
+#include <simgrid/util.hpp>
 #include <xbt/log.h>
 #include <xbt/sysdep.h>
 
+#include <simgrid/util.hpp>
+
 #include "mc_object_info.h"
 #include "mc_private.h"
 
-static void MC_dwarf_register_global_variable(
-  mc_object_info_t info, std::unique_ptr<simgrid::mc::Variable> variable);
-static void MC_register_variable(
-  mc_object_info_t info, mc_frame_t frame, std::unique_ptr<simgrid::mc::Variable> 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<simgrid::mc::Variable> variable);
-
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dwarf, mc, "DWARF processing");
 
 /** \brief The default DW_TAG_lower_bound for a given DW_AT_language.
@@ -103,7 +98,7 @@ static void MC_dwarf_handle_variable_die(mc_object_info_t info, Dwarf_Die * die,
  *  \param die DIE
  *  \return DW_TAG_type attribute as a new string (NULL if none)
  */
-static std::string MC_dwarf_at_type(Dwarf_Die * die);
+static std::uint64_t MC_dwarf_at_type(Dwarf_Die * die);
 
 /** \brief A class of DWARF tags (DW_TAG_*)
  */
@@ -309,15 +304,9 @@ static Dwarf_Off MC_dwarf_attr_integrate_dieoffset(Dwarf_Die * die,
  *  \return DW_AT_type reference as a global offset in hexadecimal (or NULL)
  */
 static
-std::string MC_dwarf_at_type(Dwarf_Die * die)
+std::uint64_t MC_dwarf_at_type(Dwarf_Die * die)
 {
-  Dwarf_Off offset = MC_dwarf_attr_integrate_dieoffset(die, DW_AT_type);
-  if (offset == 0)
-    return std::string();
-  char* s = bprintf("%" PRIx64, offset);
-  std::string res(s);
-  free(s);
-  return std::move(res);
+  return MC_dwarf_attr_integrate_dieoffset(die, DW_AT_type);
 }
 
 static uint64_t MC_dwarf_attr_integrate_addr(Dwarf_Die * die, int attribute)
@@ -461,6 +450,24 @@ static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit)
   return result;
 }
 
+// ***** 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;
+}
+
 // ***** mc_type_t
 
 /** \brief Initialize the location of a member of a type
@@ -533,11 +540,6 @@ static void MC_dwarf_fill_member_location(mc_type_t type, mc_type_t member,
 
 }
 
-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
@@ -585,7 +587,7 @@ static void MC_dwarf_add_members(mc_object_info_t info, Dwarf_Die * die,
 
       MC_dwarf_fill_member_location(type, &member, &child);
 
-      if (member.type_id.empty()) {
+      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());
@@ -603,23 +605,24 @@ static void MC_dwarf_add_members(mc_object_info_t info, Dwarf_Die * die,
  *  \param unit compilation unit of the current DIE
  *  \return MC representation of the type
  */
-static mc_type_t MC_dwarf_die_to_type(mc_object_info_t info, Dwarf_Die * die,
-                                      Dwarf_Die * unit, mc_frame_t frame,
-                                      const char *ns)
+static simgrid::mc::Type MC_dwarf_die_to_type(
+  mc_object_info_t info, Dwarf_Die * die,
+  Dwarf_Die * unit, mc_frame_t frame,
+  const char *ns)
 {
 
-  mc_type_t type = new simgrid::mc::Type();
-  type->type = -1;
-  type->name = std::string();
-  type->element_count = -1;
+  simgrid::mc::Type type;
+  type.type = -1;
+  type.name = std::string();
+  type.element_count = -1;
 
-  type->type = dwarf_tag(die);
+  type.type = dwarf_tag(die);
 
   // Global Offset
-  type->id = dwarf_dieoffset(die);
+  type.id = dwarf_dieoffset(die);
 
   const char *prefix = "";
-  switch (type->type) {
+  switch (type.type) {
   case DW_TAG_structure_type:
     prefix = "struct ";
     break;
@@ -637,69 +640,64 @@ static mc_type_t MC_dwarf_die_to_type(mc_object_info_t info, Dwarf_Die * die,
   if (name != NULL) {
     char* full_name = ns ? bprintf("%s%s::%s", prefix, ns, name) :
       bprintf("%s%s", prefix, name);
-    type->name = std::string(full_name);
+    type.name = std::string(full_name);
     free(full_name);
   }
 
-  type->type_id = MC_dwarf_at_type(die);
+  type.type_id = MC_dwarf_at_type(die);
 
   // Some compilers do not emit DW_AT_byte_size for pointer_type,
   // so we fill this. We currently assume that the model-checked process is in
   // the same architecture..
-  if (type->type == DW_TAG_pointer_type)
-    type->byte_size = sizeof(void*);
+  if (type.type == DW_TAG_pointer_type)
+    type.byte_size = sizeof(void*);
 
   // 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
-           || type->type == DW_TAG_structure_type
-           || type->type == DW_TAG_class_type) {
+    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) {
-      type->byte_size = size;
+      type.byte_size = size;
     }
   }
 
-  switch (type->type) {
+  switch (type.type) {
   case DW_TAG_array_type:
-    type->element_count = MC_dwarf_array_element_count(die, unit);
+    type.element_count = MC_dwarf_array_element_count(die, unit);
     // TODO, handle DW_byte_stride and (not) DW_bit_stride
     break;
 
   case DW_TAG_pointer_type:
   case DW_TAG_reference_type:
   case DW_TAG_rvalue_reference_type:
-    type->is_pointer_type = 1;
+    type.is_pointer_type = 1;
     break;
 
   case DW_TAG_structure_type:
   case DW_TAG_union_type:
   case DW_TAG_class_type:
-    MC_dwarf_add_members(info, die, unit, type);
-    char *new_ns = ns == NULL ? xbt_strdup(type->name.c_str())
+    MC_dwarf_add_members(info, die, unit, &type);
+    char *new_ns = ns == NULL ? xbt_strdup(type.name.c_str())
         : bprintf("%s::%s", ns, name);
     MC_dwarf_handle_children(info, die, unit, frame, new_ns);
     free(new_ns);
     break;
   }
 
-  return 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,
                                      const char *ns)
 {
-  mc_type_t type = MC_dwarf_die_to_type(info, die, unit, frame, ns);
-
-  char *key = bprintf("%" PRIx64, (uint64_t) type->id);
-  xbt_dict_set(info->types, key, type, NULL);
-  xbt_free(key);
-
-  if (!type->name.empty() && type->byte_size != 0) {
-    xbt_dict_set(info->full_types_by_name, type->name.c_str(), type, NULL);
-  }
+  simgrid::mc::Type type = MC_dwarf_die_to_type(info, die, unit, frame, ns);
+  auto& t = (info->types[type.id] = std::move(type));
+  if (!t.name.empty() && type.byte_size != 0)
+    info->full_types_by_name[t.name] = &t;
 }
 
 static int mc_anonymous_variable_index = 0;
@@ -820,8 +818,17 @@ static void MC_dwarf_handle_variable_die(mc_object_info_t info, Dwarf_Die * die,
                                          Dwarf_Die * unit, mc_frame_t frame,
                                          const char *ns)
 {
-  MC_dwarf_register_variable(info, frame,
-    MC_die_to_variable(info, die, unit, frame, ns));
+  std::unique_ptr<simgrid::mc::Variable> 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,
@@ -908,14 +915,14 @@ static void MC_dwarf_handle_scope_die(mc_object_info_t info, Dwarf_Die * die,
   // 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 == mc_tag_subprogram)
+    info->subprograms[frame.id] = frame;
+  else if (klass == mc_tag_scope)
     parent_frame->scopes.push_back(std::move(frame));
 }
 
@@ -987,14 +994,13 @@ static void MC_dwarf_handle_die(mc_object_info_t info, Dwarf_Die * die,
  */
 void MC_dwarf_get_variables(mc_object_info_t 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("Your program must be compiled with -g (%s)",
+      info->file_name.c_str());
   // For each compilation unit:
   Dwarf_Off offset = 0;
   Dwarf_Off next_offset = 0;
@@ -1022,8 +1028,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;
@@ -1035,60 +1041,59 @@ static int MC_compare_frame_index_items(mc_function_index_item_t a,
 
 static void MC_make_functions_index(mc_object_info_t 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& a,
+          simgrid::mc::FunctionIndexEntry& b)
+        {
+          return a.low_pc < b.low_pc;
+        });
 }
 
 static void MC_post_process_variables(mc_object_info_t 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.empty())
-      variable.type = (mc_type_t) xbt_dict_get_or_null(
-        info->types, variable.type_id.c_str());
+    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)
 {
 
   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,
+      (uint64_t) scope->abstract_origin_id);
+    scope->name = i->second.name;
   }
 
   // Direct:
   for (simgrid::mc::Variable& variable : scope->variables)
-    if (!variable.type_id.empty())
-      variable.type = (mc_type_t) xbt_dict_get_or_null(
-        info->types, variable.type_id.c_str());
+    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)
@@ -1096,27 +1101,14 @@ 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)
-{
-  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);
-  }
-}
-
-
 /** \brief Fill/lookup the "subtype" field.
  */
 static void MC_resolve_subtype(mc_object_info_t info, mc_type_t type)
 {
-
-  if (type->type_id.empty())
+  if (!type->type_id)
     return;
-  type->subtype = (mc_type_t) xbt_dict_get_or_null(
-    info->types, type->type_id.c_str());
-  if (type->subtype == NULL)
+  type->subtype = simgrid::util::find_map_ptr(info->types, type->type_id);
+  if (type->subtype == nullptr)
     return;
   if (type->subtype->byte_size != 0)
     return;
@@ -1124,26 +1116,18 @@ static void MC_resolve_subtype(mc_object_info_t info, mc_type_t type)
     return;
   // Try to find a more complete description of the type:
   // We need to fix in order to support C++.
-
-  mc_type_t subtype =
-    (mc_type_t) xbt_dict_get_or_null(
-      info->full_types_by_name, type->subtype->name.c_str());
-  if (subtype != NULL) {
-    type->subtype = subtype;
-  }
-
+  simgrid::mc::Type** subtype = simgrid::util::find_map_ptr(
+    info->full_types_by_name, type->subtype->name);
+  if (subtype)
+    type->subtype = *subtype;
 }
 
 static void MC_post_process_types(mc_object_info_t info)
 {
-  xbt_dict_cursor_t cursor = NULL;
-  char *origin;
-  mc_type_t type;
-
   // Lookup "subtype" field:
-  xbt_dict_foreach(info->types, cursor, origin, type) {
-    MC_resolve_subtype(info, type);
-    for (simgrid::mc::Type& member : type->members)
+  for(auto& i : info->types) {
+    MC_resolve_subtype(info, &(i.second));
+    for (simgrid::mc::Type& member : i.second.members)
       MC_resolve_subtype(info, &member);
   }
 }
@@ -1156,113 +1140,24 @@ std::shared_ptr<s_mc_object_info_t> MC_find_object_info(
     std::make_shared<s_mc_object_info_t>();
   if (executable)
     result->flags |= MC_OBJECT_INFO_EXECUTABLE;
-  result->file_name = xbt_strdup(name);
+  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<simgrid::mc::Variable> 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<simgrid::mc::Variable> 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<simgrid::mc::Variable> 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<simgrid::mc::Variable> 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)
 {
-  xbt_dict_cursor_t cursor = NULL;
-  char *key = NULL;
-  mc_type_t type = NULL;
-  xbt_dict_foreach(info->types, cursor, key, type) {
+  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) {
@@ -1275,11 +1170,10 @@ void MC_post_process_object_info(mc_process_t process, mc_object_info_t info)
     // Resolve full_type:
     if (!subtype->name.empty() && subtype->byte_size == 0) {
       for (auto const& object_info : process->object_infos) {
-        mc_type_t same_type = (mc_type_t)
-            xbt_dict_get_or_null(object_info->full_types_by_name,
-                                 subtype->name.c_str());
-        if (same_type && !same_type->name.empty() && same_type->byte_size) {
-          type->full_type = same_type;
+        auto i = object_info->full_types_by_name.find(subtype->name);
+        if (i != object_info->full_types_by_name.end()
+            && !i->second->name.empty() && i->second->byte_size) {
+          type->full_type = i->second;
           break;
         }
       }