Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Use libdw for functions and local variables
[simgrid.git] / src / mc / mc_global.c
index 457776c..e6cd34b 100644 (file)
@@ -8,6 +8,7 @@
 #include <sys/types.h>
 #include <sys/wait.h>
 #include <sys/time.h>
+#include <libgen.h>
 
 #include "simgrid/sg_config.h"
 #include "../surf/surf_private.h"
@@ -18,6 +19,8 @@
 #include "xbt/automaton.h"
 #include "xbt/dict.h"
 
+static void MC_post_process_types(mc_object_info_t info);
+
 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
                                 "Logging specific to MC (global)");
@@ -147,7 +150,7 @@ static void dw_location_entry_free(dw_location_entry_t e){
   xbt_free(e);
 }
 
-static void dw_type_free(dw_type_t t){
+void dw_type_free(dw_type_t t){
   xbt_free(t->name);
   xbt_free(t->dw_type_id);
   xbt_dynar_free(&(t->members));
@@ -158,7 +161,7 @@ static void dw_type_free_voidp(void *t){
   dw_type_free((dw_type_t) * (void **) t);
 }
 
-static void dw_variable_free(dw_variable_t v){
+void dw_variable_free(dw_variable_t v){
   if(v){
     xbt_free(v->name);
     xbt_free(v->type_origin);
@@ -168,15 +171,22 @@ static void dw_variable_free(dw_variable_t v){
   }
 }
 
-static void dw_variable_free_voidp(void *t){
+void dw_variable_free_voidp(void *t){
   dw_variable_free((dw_variable_t) * (void **) t);
 }
 
 // object_info
 
-mc_object_info_t MC_new_object_info() {
+mc_object_info_t MC_new_object_info(void) {
   mc_object_info_t res = xbt_new(s_mc_object_info_t, 1);
   res->file_name = NULL;
+  res->start_text = NULL;
+  res->start_data = NULL;
+  res->start_bss = NULL;
+  res->start_plt = NULL;
+  res->end_plt = NULL;
+  res->start_got_plt = NULL;
+  res->end_got_plt = NULL;
   res->local_variables = xbt_dict_new_homogeneous(NULL);
   res->global_variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
   res->types = xbt_dict_new_homogeneous(NULL);
@@ -188,6 +198,7 @@ void MC_free_object_info(mc_object_info_t* info) {
   xbt_dict_free(&(*info)->local_variables);
   xbt_dynar_free(&(*info)->global_variables);
   xbt_dict_free(&(*info)->types);
+  xbt_dict_free(&((*info)->location_list));
   xbt_free(info);
   info = NULL;
 }
@@ -335,7 +346,7 @@ static dw_location_t MC_dwarf_get_location(xbt_dict_t location_list, char *expr)
  *  @return A map from the offset in the list (in hexadecimal string)
  *          into a location list (dynar of dw_location_entry_t).
  */
-static xbt_dict_t MC_dwarf_get_location_list(const char *elf_file){
+xbt_dict_t MC_dwarf_get_location_list(const char *elf_file){
 
   char *command = bprintf("LANG=C objdump -Wo %s", elf_file);
 
@@ -444,6 +455,10 @@ static xbt_dict_t MC_dwarf_get_location_list(const char *elf_file){
   return location_list;
 }
 
+/** \brief Finds a frame (DW_TAG_subprogram) from an DWARF offset in the rangd of this subprogram
+ *
+ * The offset can be an offset of a child DW_TAG_variable.
+ */
 static dw_frame_t MC_dwarf_get_frame_by_offset(xbt_dict_t all_variables, unsigned long int offset){
 
   xbt_dict_cursor_t cursor = NULL;
@@ -518,9 +533,22 @@ static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *a
 
 }
 
-static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
+void MC_dwarf_get_variables_legacy(mc_object_info_t info);
 
-  xbt_dict_t location_list = MC_dwarf_get_location_list(elf_file);
+/** \brief Fill DWARf debug infomations (types, frames, variables ...). */
+void MC_dwarf_get_variables(mc_object_info_t info) {
+  if (MC_USE_LIBDW) {
+    MC_dwarf_get_variables_libdw(info);
+    MC_post_process_types(info);
+  } else {
+    MC_dwarf_get_variables_legacy(info);
+  }
+}
+
+void MC_dwarf_get_variables_legacy(mc_object_info_t info) {
+
+  mc_object_info_t result = info;
+  const char *elf_file = info->file_name;
 
   char *command = bprintf("LANG=C objdump -Wi %s", elf_file);
   
@@ -529,11 +557,7 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
   if(fp == NULL)
     perror("popen for objdump failed");
 
-  mc_object_info_t result = MC_new_object_info();
-  result->file_name = xbt_strdup(elf_file);
-
   xbt_dict_t *local_variables = &result->local_variables;
-  xbt_dynar_t *global_variables = &result->global_variables;
   xbt_dict_t *types = &result->types;
 
   char *line = NULL, *origin, *abstract_origin, *current_frame = NULL, 
@@ -546,7 +570,7 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
   size_t n = 0;
   int global_variable = 0, parent = 0, new_frame = 0, new_variable = 1, size = 0, 
     is_pointer = 0, struct_decl = 0, member_end = 0,
-    enumeration_size = 0, subrange = 0, union_decl = 0, offset = 0, index = 0;
+    enumeration_size = 0, subrange = 0, union_decl = 0, offset = 0;
   
   xbt_dynar_t split = NULL, split2 = NULL;
 
@@ -649,7 +673,7 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
 
           if(strcmp(location_type, "list)") == 0){ /* Search location in location list */
 
-            frame->frame_base = MC_dwarf_get_location(location_list, xbt_dynar_get_as(split, 3, char *));
+            frame->frame_base = MC_dwarf_get_location(info->location_list, xbt_dynar_get_as(split, 3, char *));
              
           }else{
                 
@@ -745,6 +769,7 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
         if(strcmp(node_type, "DW_AT_name") == 0){
 
           var = xbt_new0(s_dw_variable_t, 1);
+          var->dwarf_offset = 0;
           var->name = xbt_strdup(xbt_dynar_get_as(split, xbt_dynar_length(split) - 1, char *));
           xbt_dict_set(variables_origin, origin, xbt_strdup(var->name), NULL);
          
@@ -769,7 +794,7 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
               location_type = xbt_dynar_get_as(split, xbt_dynar_length(split) - 1, char *);
 
               if(strcmp(location_type, "list)") == 0){ /* Search location in location list */
-                var->address.location = MC_dwarf_get_location(location_list, xbt_dynar_get_as(split, 3, char *));
+                var->address.location = MC_dwarf_get_location(info->location_list, xbt_dynar_get_as(split, 3, char *));
               }else{
                 xbt_str_strip_spaces(line);
                 split2 = xbt_str_split(line, "(");
@@ -781,8 +806,9 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
                   xbt_dynar_free(&split2);
                   split2 = xbt_str_split(loc_expr, " ");
                   if(strcmp(elf_file, xbt_binary_name) != 0)
-                    var->address.address = (char *)start_text_libsimgrid + (long)((void *)strtoul(xbt_dynar_get_as(split2, xbt_dynar_length(split2) - 1, char*), NULL, 16));
+                    var->address.address = (char *) info->start_text + (long)((void *)strtoul(xbt_dynar_get_as(split2, xbt_dynar_length(split2) - 1, char*), NULL, 16));
                   else
+                    // Why is it different ?
                     var->address.address = (void *)strtoul(xbt_dynar_get_as(split2, xbt_dynar_length(split2) - 1, char*), NULL, 16);
                 }else{
                   var->address.location = MC_dwarf_get_location(NULL, loc_expr);
@@ -794,8 +820,9 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
               global_address = xbt_strdup(xbt_dynar_get_as(split, xbt_dynar_length(split) - 1, char *));
               xbt_str_rtrim(global_address, ")");
               if(strcmp(elf_file, xbt_binary_name) != 0)
-                var->address.address = (char *)start_text_libsimgrid + (long)((void *)strtoul(global_address, NULL, 16));
+                var->address.address = (char *) info->start_text + (long)((void *)strtoul(global_address, NULL, 16));
               else
+                // Why is it different ?
                 var->address.address = (void *)strtoul(global_address, NULL, 16);
               xbt_free(global_address);
               global_address = NULL;
@@ -833,19 +860,13 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
 
       if(new_variable == 1){
         
+        var->global = global_variable;
+        var->type_origin = strdup(type_origin);
         if(!global_variable){
           variable_frame = xbt_dict_get_or_null(*local_variables, current_frame);
-          var->type_origin = strdup(type_origin);
-          var->global = 0;
-          index = MC_dwarf_get_variable_index(variable_frame->variables, var->name, NULL);
-          if(index != -1)
-            xbt_dynar_insert_at(variable_frame->variables, index, &var);
+          MC_dwarf_register_non_global_variable(info, variable_frame, var);
         }else{
-          var->type_origin = strdup(type_origin);
-          var->global = 1;
-          index = MC_dwarf_get_variable_index(*global_variables, var->name, var->address.address);
-          if(index != -1)
-            xbt_dynar_insert_at(*global_variables, index, &var); 
+          MC_dwarf_register_global_variable(info, var);
         }
 
          xbt_free(type_origin);
@@ -902,9 +923,8 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
       
       }
 
-    }else if(strcmp(node_type, "(DW_TAG_base_type)") == 0 
+    }else if(strcmp(node_type, "(DW_TAG_base_type)") == 0
              || strcmp(node_type, "(DW_TAG_enumeration_type)") == 0
-             || strcmp(node_type, "(DW_TAG_enumerator)") == 0
              || strcmp(node_type, "(DW_TAG_typedef)") == 0
              || strcmp(node_type, "(DW_TAG_const_type)") == 0
              || strcmp(node_type, "(DW_TAG_subroutine_type)") == 0
@@ -914,21 +934,19 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
       /* Create the and add it to the types dictionnary */
 
       if(strcmp(node_type, "(DW_TAG_base_type)") == 0)
-        type_type = e_dw_base_type;
+        type_type = DW_TAG_base_type;
       else if(strcmp(node_type, "(DW_TAG_enumeration_type)") == 0)
-        type_type = e_dw_enumeration_type;
-      else if(strcmp(node_type, "(DW_TAG_enumerator)") == 0)
-        type_type = e_dw_enumerator;
+        type_type = DW_TAG_enumeration_type;
       else if(strcmp(node_type, "(DW_TAG_typedef)") == 0)
-        type_type = e_dw_typedef;
+        type_type = DW_TAG_typedef;
       else if(strcmp(node_type, "(DW_TAG_const_type)") == 0)
-        type_type = e_dw_const_type;
+        type_type = DW_TAG_const_type;
       else if(strcmp(node_type, "(DW_TAG_pointer_type)") == 0)
-        type_type = e_dw_pointer_type;
+        type_type = DW_TAG_pointer_type;
       else if(strcmp(node_type, "(DW_TAG_subroutine_type)") == 0)
-        type_type = e_dw_subroutine_type;
+        type_type = DW_TAG_subroutine_type;
       else if(strcmp(node_type, "(DW_TAG_volatile_type)") == 0)
-        type_type = e_dw_volatile_type;
+        type_type = DW_TAG_volatile_type;
 
       strtok(xbt_dynar_get_as(split, 0, char *), "<");
       origin = strdup(strtok(NULL, "<"));
@@ -958,7 +976,7 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
 
         if(strcmp(node_type, "DW_AT_byte_size") == 0){
           size = strtol(xbt_dynar_get_as(split, xbt_dynar_length(split) - 1, char*), NULL, 10);
-          if(type_type == e_dw_enumeration_type)
+          if(type_type == DW_TAG_enumeration_type)
             enumeration_size = size;
         }else if(strcmp(node_type, "DW_AT_name") == 0){
           end = xbt_str_join(split, " ");
@@ -985,10 +1003,11 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
       type->id = (void *)strtoul(origin, NULL, 16);
       if(type_origin)
         type->dw_type_id = xbt_strdup(type_origin);
-      if(type_type == e_dw_enumerator)
-        type->size = enumeration_size;
-      else
-        type->size = size;
+
+      type->byte_size = size;
+      // Not relevant:
+      type->element_count = -1;
+
       type->members = NULL;
 
       xbt_dict_set(*types, origin, type, NULL); 
@@ -1073,9 +1092,11 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
         if(member_end && type){         
           member_end = 0;
           
+          // Why are we not simply referencing, the DW_AT_type?
           dw_type_t member_type = xbt_new0(s_dw_type_t, 1);
           member_type->name = xbt_strdup(name);
-          member_type->size = size;
+          member_type->byte_size = size;
+          member_type->element_count = -1;
           member_type->is_pointer_type = is_pointer;
           member_type->id = (void *)strtoul(origin, NULL, 16);
           member_type->offset = offset;
@@ -1104,11 +1125,12 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
         if(struct_decl || union_decl){
           type = xbt_new0(s_dw_type_t, 1);
           if(struct_decl)
-            type->type = e_dw_structure_type;
+            type->type = DW_TAG_structure_type;
           else
-            type->type = e_dw_union_type;
+            type->type = DW_TAG_union_type;
           type->name = xbt_strdup(name);
-          type->size = size;
+          type->byte_size = size;
+          type->element_count = -1;
           type->is_pointer_type = is_pointer;
           type->id = (void *)strtoul(origin, NULL, 16);
           if(type_origin)
@@ -1149,8 +1171,10 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
 
       dw_type_t type = NULL;
 
+      // Read DW_TAG_subrange_type children:
       while(read != -1){
       
+        // Read attributes of the DW_TAG_subrange_type:
         while(read != -1){
         
           /* Wipeout the new line character */
@@ -1194,8 +1218,8 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
         }
 
         if(subrange && type){         
-          type->size = size;
-      
+          type->element_count = size;
+
           xbt_free(name);
           name = NULL;
           xbt_free(end);
@@ -1213,13 +1237,16 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
         }else {
           
           type = xbt_new0(s_dw_type_t, 1);
-          type->type = e_dw_array_type;
+          type->type = DW_TAG_array_type;
           type->name = xbt_strdup(name);
           type->is_pointer_type = is_pointer;
           type->id = (void *)strtoul(origin, NULL, 16);
           if(type_origin)
             type->dw_type_id = xbt_strdup(type_origin);
           type->members = NULL;
+
+          // Filled in a post processing step:
+          type-> byte_size = 0;
           
           xbt_dict_set(*types, origin, type, NULL); 
           
@@ -1255,12 +1282,53 @@ static mc_object_info_t MC_dwarf_get_variables(const char *elf_file){
   xbt_dict_free(&subprograms_origin);
   xbt_free(line);
   xbt_free(command);
-  xbt_dict_free(&location_list);
 
   pclose(fp);
-  return result;
 }
 
+void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
+  int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address.address);
+  if (index != -1)
+    xbt_dynar_insert_at(info->global_variables, index, &variable);
+  // TODO, else ?
+}
+
+void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
+  xbt_assert(frame, "Frame is NULL");
+  int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
+  if (index != -1)
+    xbt_dynar_insert_at(frame->variables, index, &variable);
+  // TODO, else ?
+}
+
+void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
+  if(variable->global)
+    MC_dwarf_register_global_variable(info, variable);
+  else if(frame==NULL)
+    xbt_die("No frame for this local variable");
+  else
+    MC_dwarf_register_non_global_variable(info, frame, variable);
+}
+
+static void MC_post_process_array_size(mc_object_info_t info, dw_type_t type) {
+  xbt_assert(type->dw_type_id, "No base type for array <%p>%s", type->id, type->name);
+  dw_type_t subtype = xbt_dict_get_or_null(info->types, type->dw_type_id);
+  xbt_assert(subtype, "Unkown base type <%s> for array <%p>%s", type->dw_type_id, type->id, type->name);
+  if(subtype->type==DW_TAG_array_type && type->byte_size==0) {
+         MC_post_process_array_size(info, subtype);
+  }
+  type->byte_size = type->element_count*subtype->byte_size;
+}
+
+static void MC_post_process_types(mc_object_info_t info) {
+  xbt_dict_cursor_t cursor;
+  char *origin;
+  dw_type_t type;
+  xbt_dict_foreach(info->types, cursor, origin, type){
+    if(type->type==DW_TAG_array_type && type->byte_size==0)
+      MC_post_process_array_size(info, type);
+  }
+}
 
 /*******************************  Ignore mechanism *******************************/
 /*********************************************************************************/
@@ -1734,10 +1802,24 @@ static void MC_dump_ignored_global_variables(void){
 
 }
 
+static void MC_init_debug_info();
+static void MC_init_debug_info() {
+  XBT_INFO("Get debug information ...");
+
+  memory_map_t maps = MC_get_memory_map();
+
+  /* Get local variables for state equality detection */
+  mc_binary_info = MC_find_object_info(maps, xbt_binary_name);
+  mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path);
+
+  MC_free_memory_map(maps);
+  XBT_INFO("Get debug information done !");
+}
+
 void MC_init(){
 
   int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
-  
+
   compare = 0;
 
   /* Initialize the data structures that must be persistent across every
@@ -1746,22 +1828,11 @@ void MC_init(){
   MC_SET_RAW_MEM;
 
   MC_init_memory_map_info();
-
-  XBT_INFO("Get debug information ...");
-
-  /* Get local variables for state equality detection */
-  mc_binary_info = MC_dwarf_get_variables(xbt_binary_name);
-  mc_libsimgrid_info = MC_dwarf_get_variables(libsimgrid_path);
-
-  XBT_INFO("Get debug information done !");
+  MC_init_debug_info();
 
   /* Remove variables ignored before getting list of variables */
   MC_dump_ignored_local_variables();
   MC_dump_ignored_global_variables();
-  
-  /* Get .plt section (start and end addresses) for data libsimgrid and data program comparison */
-  MC_get_libsimgrid_plt_section();
-  MC_get_binary_plt_section();
 
    /* Init parmap */
   parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
@@ -1896,8 +1967,7 @@ void MC_modelcheck_safety(void)
   }else{
     MC_SET_RAW_MEM;
     MC_init_memory_map_info();
-    MC_get_libsimgrid_plt_section();
-    MC_get_binary_plt_section();
+    MC_init_debug_info();
     MC_UNSET_RAW_MEM;
   }