Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Fix constness issue in MC_make_functions_index()
[simgrid.git] / src / mc / mc_dwarf.cpp
index 2c10779..37b97da 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"
+#include "mc_process.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);
+#include "mc/ObjectInformation.hpp"
+#include "mc/Variable.hpp"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dwarf, mc, "DWARF processing");
 
@@ -66,14 +65,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 +82,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 +93,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
@@ -455,7 +454,25 @@ static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * 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,7 +481,7 @@ 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,
+static void MC_dwarf_fill_member_location(simgrid::mc::Type* type, simgrid::mc::Type* member,
                                           Dwarf_Die * child)
 {
   if (dwarf_hasattr(child, DW_AT_data_bit_offset)) {
@@ -527,11 +544,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
@@ -539,8 +551,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;
@@ -598,18 +610,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);
 
@@ -682,8 +691,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 +704,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<simgrid::mc::Variable> 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:
@@ -806,16 +815,25 @@ static std::unique_ptr<simgrid::mc::Variable> 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<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,
-                                      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
@@ -840,8 +858,10 @@ static void MC_dwarf_handle_scope_die(mc_object_info_t info, Dwarf_Die * die,
     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 =
@@ -898,6 +918,10 @@ 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);
 
+  // Someone needs this to be sorted but who?
+  std::sort(frame.variables.begin(), frame.variables.end(),
+    MC_compare_variable);
+
   // Register it:
   if (klass == mc_tag_subprogram)
     info->subprograms[frame.id] = frame;
@@ -905,9 +929,9 @@ static void MC_dwarf_handle_scope_die(mc_object_info_t info, Dwarf_Die * die,
     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);
@@ -919,8 +943,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:
@@ -932,8 +956,8 @@ 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);
@@ -971,16 +995,15 @@ static void MC_dwarf_handle_die(mc_object_info_t info, Dwarf_Die * die,
  *  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)
+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("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;
@@ -1008,8 +1031,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;
@@ -1019,45 +1042,44 @@ 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);
+  info->functions_index.clear();
 
   for (auto& e : info->subprograms) {
     if (e.second.low_pc == nullptr)
       continue;
-    s_mc_function_index_item_t entry;
+    simgrid::mc::FunctionIndexEntry entry;
     entry.low_pc = e.second.low_pc;
-    entry.high_pc = e.second.high_pc;
     entry.function = &e.second;
-    xbt_dynar_push(index, &entry);
+    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;
+      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) {
@@ -1072,11 +1094,8 @@ static void mc_post_process_scope(mc_object_info_t info, mc_frame_t scope)
   // 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;
+      variable.type = simgrid::util::find_map_ptr(
+        info->types, variable.type_id);
     }
 
   // Recursive post-processing of nested-scopes:
@@ -1085,39 +1104,28 @@ 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)
-{
-  for (auto& entry : info->subprograms)
-    mc_post_process_scope(info, &entry.second);
-}
-
-
 /** \brief Fill/lookup the "subtype" field.
  */
-static void MC_resolve_subtype(mc_object_info_t info, mc_type_t type)
+static void MC_resolve_subtype(simgrid::mc::ObjectInformation* info, simgrid::mc::Type* 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;
+  type->subtype = simgrid::util::find_map_ptr(info->types, type->type_id);
+  if (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->subtype->name);
+  if (subtype)
+    type->subtype = *subtype;
 }
 
-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) {
@@ -1128,119 +1136,32 @@ static void MC_post_process_types(mc_object_info_t info)
 }
 
 /** \brief Finds informations about a given shared object/executable */
-std::shared_ptr<s_mc_object_info_t> MC_find_object_info(
+std::shared_ptr<simgrid::mc::ObjectInformation> MC_find_object_info(
   std::vector<simgrid::mc::VmMap> const& maps, const char *name, int executable)
 {
-  std::shared_ptr<s_mc_object_info_t> result =
-    std::make_shared<s_mc_object_info_t>();
+  std::shared_ptr<simgrid::mc::ObjectInformation> result =
+    std::make_shared<simgrid::mc::ObjectInformation>();
   if (executable)
-    result->flags |= MC_OBJECT_INFO_EXECUTABLE;
-  result->file_name = xbt_strdup(name);
+    result->flags |= simgrid::mc::ObjectInformation::Executable;
+  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)
+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;
+    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)