Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Remove type DW_TAG_enumerator type (because it is not a type)
[simgrid.git] / src / mc / mc_global.c
index 47e6c78..07c7800 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)");
@@ -110,12 +113,8 @@ int compare;
 xbt_automaton_t _mc_property_automaton = NULL;
 
 /* Variables */
-xbt_dict_t mc_local_variables_libsimgrid = NULL;
-xbt_dict_t mc_local_variables_binary = NULL;
-xbt_dynar_t mc_global_variables_libsimgrid = NULL;
-xbt_dynar_t mc_global_variables_binary = NULL;
-xbt_dict_t mc_variables_type_libsimgrid = NULL;
-xbt_dict_t mc_variables_type_binary = NULL;
+mc_object_info_t mc_libsimgrid_info = NULL;
+mc_object_info_t mc_binary_info = NULL;
 
 /* Ignore mechanism */
 xbt_dynar_t mc_stack_comparison_ignore;
@@ -176,6 +175,33 @@ static 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 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);
+  return res;
+}
+
+void MC_free_object_info(mc_object_info_t* info) {
+  xbt_free(&(*info)->file_name);
+  xbt_dict_free(&(*info)->local_variables);
+  xbt_dynar_free(&(*info)->global_variables);
+  xbt_dict_free(&(*info)->types);
+  xbt_free(info);
+  info = NULL;
+}
+
 /*************************************************************************/
 
 static dw_location_t MC_dwarf_get_location(xbt_dict_t location_list, char *expr){
@@ -314,9 +340,14 @@ static dw_location_t MC_dwarf_get_location(xbt_dict_t location_list, char *expr)
 
 }
 
+/** @brief Extract the location lists from an ELF file (.debug_loc)
+ *
+ *  @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){
 
-  char *command = bprintf("objdump -Wo %s", elf_file);
+  char *command = bprintf("LANG=C objdump -Wo %s", elf_file);
 
   FILE *fp = popen(command, "r");
 
@@ -371,8 +402,14 @@ static xbt_dict_t MC_dwarf_get_location_list(const char *elf_file){
     xbt_str_strip_spaces(line);
     split = xbt_str_split(line, " ");
 
+    char *key = NULL;
     while(read != -1 && strcmp("<End", (char *)xbt_dynar_get_as(split, 1, char *)) != 0){
       
+      // Take the key from the first line of the list:
+      if(key==NULL){
+        key = bprintf("%d", (int)strtoul((char *)xbt_dynar_get_as(split, 0, char *), NULL, 16));
+      }
+
       dw_location_entry_t new_entry = xbt_new0(s_dw_location_entry_t, 1);
       new_entry->lowpc = strtoul((char *)xbt_dynar_get_as(split, 1, char *), NULL, 16);
       new_entry->highpc = strtoul((char *)xbt_dynar_get_as(split, 2, char *), NULL, 16);
@@ -403,7 +440,6 @@ static xbt_dict_t MC_dwarf_get_location_list(const char *elf_file){
     }
 
 
-    char *key = bprintf("%d", (int)strtoul((char *)xbt_dynar_get_as(split, 0, char *), NULL, 16));
     xbt_dict_set(location_list, key, loclist, NULL);
     xbt_free(key);
     
@@ -418,6 +454,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;
@@ -492,16 +532,24 @@ static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *a
 
 }
 
+/** \brief Fill DWARf debug infomations (types, frames, variables ...). */
+void MC_dwarf_get_variables(mc_object_info_t info) {
+  mc_object_info_t result = info;
+  const char *elf_file = info->file_name;
 
-static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_list, xbt_dict_t *local_variables, xbt_dynar_t *global_variables, xbt_dict_t *types){
+  xbt_dict_t location_list = MC_dwarf_get_location_list(elf_file);
 
-  char *command = bprintf("objdump -Wi %s", elf_file);
+  char *command = bprintf("LANG=C objdump -Wi %s", elf_file);
   
   FILE *fp = popen(command, "r");
 
   if(fp == NULL)
     perror("popen for objdump failed");
 
+  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, 
     *subprogram_name = NULL, *subprogram_start = NULL, *subprogram_end = NULL,
     *node_type = NULL, *location_type = NULL, *variable_name = NULL, 
@@ -550,6 +598,8 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
     node_type = xbt_dynar_get_as(split, xbt_dynar_length(split) - 1, char *);
 
     if(strcmp(node_type, "(DW_TAG_subprogram)") == 0){ /* New frame */
+      /* We build/complete a dw_frame_t object
+       * and append it if necessary to the local_variables dictionnary */
 
       dw_frame_t frame = NULL;
 
@@ -665,6 +715,9 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
         
 
     }else if(strcmp(node_type, "(DW_TAG_variable)") == 0){ /* New variable */
+      /* We build a dw_variable_t object and append it either to
+         the list of variables of the frame (local variable)
+         or to the list of global variables (global variables). */
 
       dw_variable_t var = NULL;
       
@@ -742,8 +795,9 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
                   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);
@@ -755,8 +809,9 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
               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;
@@ -817,6 +872,7 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
       new_variable = 1;
 
     }else if(strcmp(node_type, "(DW_TAG_inlined_subroutine)") == 0){
+      /* Update the information on the frame (we should duplicate it instead). */
 
       read = xbt_getline(&line, &n, fp);
 
@@ -864,19 +920,18 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
 
     }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
              || strcmp(node_type, "(DW_TAG_volatile_type)") == 0
              || (is_pointer = !strcmp(node_type, "(DW_TAG_pointer_type)"))){
 
+      /* Create the and add it to the types dictionnary */
+
       if(strcmp(node_type, "(DW_TAG_base_type)") == 0)
         type_type = e_dw_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;
       else if(strcmp(node_type, "(DW_TAG_typedef)") == 0)
         type_type = e_dw_typedef;
       else if(strcmp(node_type, "(DW_TAG_const_type)") == 0)
@@ -943,10 +998,11 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
       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); 
@@ -1031,9 +1087,11 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
         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;
@@ -1066,7 +1124,8 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
           else
             type->type = e_dw_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)
@@ -1107,8 +1166,10 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
 
       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 */
@@ -1152,8 +1213,8 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
         }
 
         if(subrange && type){         
-          type->size = size;
-      
+          type->element_count = size;
+
           xbt_free(name);
           name = NULL;
           xbt_free(end);
@@ -1178,6 +1239,9 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
           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); 
           
@@ -1213,10 +1277,26 @@ static void MC_dwarf_get_variables(const char *elf_file, xbt_dict_t location_lis
   xbt_dict_free(&subprograms_origin);
   xbt_free(line);
   xbt_free(command);
+  xbt_dict_free(&location_list);
+
   pclose(fp);
-  
+
+  MC_post_process_types(info);
 }
 
+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==e_dw_array_type) {
+      xbt_assert(type->dw_type_id, "No base type for array %s %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 for array %s %s", type->id, type->name);
+      type->byte_size = type->element_count*subtype->byte_size;
+    }
+  }
+}
 
 /*******************************  Ignore mechanism *******************************/
 /*********************************************************************************/
@@ -1375,20 +1455,20 @@ void MC_ignore_global_variable(const char *name){
 
   MC_SET_RAW_MEM;
 
-  if(mc_global_variables_libsimgrid){
+  if(mc_libsimgrid_info){
 
     unsigned int cursor = 0;
     dw_variable_t current_var;
     int start = 0;
-    int end = xbt_dynar_length(mc_global_variables_libsimgrid) - 1;
+    int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
 
     while(start <= end){
       cursor = (start + end) /2;
-      current_var = (dw_variable_t)xbt_dynar_get_as(mc_global_variables_libsimgrid, cursor, dw_variable_t);
+      current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
       if(strcmp(current_var->name, name) == 0){
-        xbt_dynar_remove_at(mc_global_variables_libsimgrid, cursor, NULL);
+        xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
         start = 0;
-        end = xbt_dynar_length(mc_global_variables_libsimgrid) - 1;
+        end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
       }else if(strcmp(current_var->name, name) < 0){
         start = cursor + 1;
       }else{
@@ -1449,7 +1529,7 @@ void MC_ignore_local_variable(const char *var_name, const char *frame_name){
 
   MC_SET_RAW_MEM;
 
-  if(mc_local_variables_libsimgrid){
+  if(mc_libsimgrid_info){
     unsigned int cursor = 0;
     dw_variable_t current_var;
     int start, end;
@@ -1457,7 +1537,7 @@ void MC_ignore_local_variable(const char *var_name, const char *frame_name){
       xbt_dict_cursor_t dict_cursor;
       char *current_frame_name;
       dw_frame_t frame;
-      xbt_dict_foreach(mc_local_variables_libsimgrid, dict_cursor, current_frame_name, frame){
+      xbt_dict_foreach(mc_libsimgrid_info->local_variables, dict_cursor, current_frame_name, frame){
         start = 0;
         end = xbt_dynar_length(frame->variables) - 1;
         while(start <= end){
@@ -1474,7 +1554,7 @@ void MC_ignore_local_variable(const char *var_name, const char *frame_name){
           } 
         }
       }
-       xbt_dict_foreach(mc_local_variables_binary, dict_cursor, current_frame_name, frame){
+       xbt_dict_foreach(mc_binary_info->local_variables, dict_cursor, current_frame_name, frame){
         start = 0;
         end = xbt_dynar_length(frame->variables) - 1;
         while(start <= end){
@@ -1492,7 +1572,8 @@ void MC_ignore_local_variable(const char *var_name, const char *frame_name){
         }
       }
     }else{
-      xbt_dynar_t variables_list = ((dw_frame_t)xbt_dict_get_or_null(mc_local_variables_libsimgrid, frame_name))->variables;
+      xbt_dynar_t variables_list = ((dw_frame_t)xbt_dict_get_or_null(
+                                      mc_libsimgrid_info->local_variables, frame_name))->variables;
       start = 0;
       end = xbt_dynar_length(variables_list) - 1;
       while(start <= end){
@@ -1689,10 +1770,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
@@ -1701,36 +1796,11 @@ void MC_init(){
   MC_SET_RAW_MEM;
 
   MC_init_memory_map_info();
-  
-  mc_local_variables_libsimgrid = xbt_dict_new_homogeneous(NULL);
-  mc_local_variables_binary = xbt_dict_new_homogeneous(NULL);
-  mc_global_variables_libsimgrid = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
-  mc_global_variables_binary = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
-  mc_variables_type_libsimgrid = xbt_dict_new_homogeneous(NULL);
-  mc_variables_type_binary = xbt_dict_new_homogeneous(NULL);
-
-  XBT_INFO("Get debug information ...");
-
-  /* Get local variables in binary for state equality detection */
-  xbt_dict_t binary_location_list = MC_dwarf_get_location_list(xbt_binary_name);
-  MC_dwarf_get_variables(xbt_binary_name, binary_location_list, &mc_local_variables_binary, &mc_global_variables_binary, &mc_variables_type_binary);
-
-  /* Get local variables in libsimgrid for state equality detection */
-  xbt_dict_t libsimgrid_location_list = MC_dwarf_get_location_list(libsimgrid_path);
-  MC_dwarf_get_variables(libsimgrid_path, libsimgrid_location_list, &mc_local_variables_libsimgrid, &mc_global_variables_libsimgrid, &mc_variables_type_libsimgrid);
-
-  xbt_dict_free(&libsimgrid_location_list);
-  xbt_dict_free(&binary_location_list);
-
-  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);
@@ -1760,9 +1830,12 @@ void MC_init(){
   MC_ignore_global_variable("counter"); /* Static variable used for tracing */
   MC_ignore_global_variable("maestro_stack_start");
   MC_ignore_global_variable("maestro_stack_end");
+
   MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
   MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
+  MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
+  MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
+  
   smx_process_t process;
   xbt_swag_foreach(process, simix_global->process_list){
     MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
@@ -1862,8 +1935,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;
   }
 
@@ -1872,7 +1944,7 @@ void MC_modelcheck_safety(void)
   MC_SET_RAW_MEM;
   /* Save the initial state */
   initial_state_safety = xbt_new0(s_mc_global_t, 1);
-  initial_state_safety->snapshot = MC_take_snapshot();
+  initial_state_safety->snapshot = MC_take_snapshot(0);
   MC_UNSET_RAW_MEM;
 
   MC_dpor();