Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Make s_local_variable::name a std::string
[simgrid.git] / src / mc / mc_compare.cpp
index bf0a7ec..6bf43b3 100644 (file)
@@ -4,16 +4,29 @@
 /* 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 <inttypes.h>
+#define __STDC_FORMAT_MACROS
+#include <cinttypes>
 #include <boost/unordered_set.hpp>
 
+#include <xbt/sysdep.h>
+
+#include "internal_config.h"
+#include "mc_object_info.h"
+#include "mc_safety.h"
+#include "mc_liveness.h"
 #include "mc_private.h"
+#include "mc_smx.h"
+
+#ifdef HAVE_SMPI
+#include "smpi/private.h"
+#endif
 
 #include "xbt/mmalloc.h"
 #include "xbt/mmalloc/mmprivate.h"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, mc,
-                                "Logging specific to mc_compare");
+#include <xbt/probes.h>
+
+using simgrid::mc::remote;
 
 typedef struct s_pointers_pair {
   void *p1;
@@ -43,13 +56,15 @@ struct mc_compare_state {
 
 extern "C" {
 
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, xbt,
+                                "Logging specific to mc_compare in mc");
+
 /************************** Free functions ****************************/
 /********************************************************************/
 
 static void stack_region_free(stack_region_t s)
 {
   if (s) {
-    xbt_free(s->process_name);
     xbt_free(s);
   }
 }
@@ -86,10 +101,13 @@ static int add_compared_pointers(mc_compare_state& state, void *p1, void *p2)
 }
 
 static int compare_areas_with_type(struct mc_compare_state& state,
+                                   int process_index,
                                    void* real_area1, mc_snapshot_t snapshot1, mc_mem_region_t region1,
                                    void* real_area2, mc_snapshot_t snapshot2, mc_mem_region_t region2,
                                    dw_type_t type, int pointer_level)
 {
+  mc_process_t process = &mc_model_checker->process();
+
   unsigned int cursor = 0;
   dw_type_t member, subtype, subsubtype;
   int elm_size, i, res;
@@ -103,12 +121,9 @@ static int compare_areas_with_type(struct mc_compare_state& state,
   case DW_TAG_enumeration_type:
   case DW_TAG_union_type:
   {
-    void* data1 =
-      mc_snapshot_read_region(real_area1, region1, alloca(type->byte_size), type->byte_size);
-    void* data2 =
-      mc_snapshot_read_region(real_area2, region2, alloca(type->byte_size), type->byte_size);
-    return (memcmp(data1, data2, type->byte_size) != 0);
-    break;
+    return MC_snapshot_region_memcmp(
+      real_area1, region1, real_area2, region2,
+      type->byte_size) != 0;
   }
   case DW_TAG_typedef:
   case DW_TAG_volatile_type:
@@ -148,7 +163,7 @@ static int compare_areas_with_type(struct mc_compare_state& state,
     }
     for (i = 0; i < type->element_count; i++) {
       size_t off = i * elm_size;
-      res = compare_areas_with_type(state,
+      res = compare_areas_with_type(state, process_index,
             (char*) real_area1 + off, snapshot1, region1,
             (char*) real_area2 + off, snapshot2, region2,
             type->subtype, pointer_level);
@@ -160,8 +175,8 @@ static int compare_areas_with_type(struct mc_compare_state& state,
   case DW_TAG_reference_type:
   case DW_TAG_rvalue_reference_type:
   {
-    void* addr_pointed1 = mc_snapshot_read_pointer_region(real_area1, region1);
-    void* addr_pointed2 = mc_snapshot_read_pointer_region(real_area2, region2);
+    void* addr_pointed1 = MC_region_read_pointer(region1, real_area1);
+    void* addr_pointed2 = MC_region_read_pointer(region2, real_area2);
 
     if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
       return (addr_pointed1 != addr_pointed2);
@@ -169,6 +184,8 @@ static int compare_areas_with_type(struct mc_compare_state& state,
 
       if (addr_pointed1 == NULL && addr_pointed2 == NULL)
         return 0;
+      if (addr_pointed1 == NULL || addr_pointed2 == NULL)
+        return 1;
       if (!add_compared_pointers(state, addr_pointed1, addr_pointed2))
         return 0;
 
@@ -179,33 +196,34 @@ static int compare_areas_with_type(struct mc_compare_state& state,
       // * a pointer leads to the read-only segment of the current object;
       // * a pointer lead to a different ELF object.
 
-      if (addr_pointed1 > std_heap
+      if (addr_pointed1 > process->heap_address
           && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)) {
         if (!
-            (addr_pointed2 > std_heap
+            (addr_pointed2 > process->heap_address
              && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
           return 1;
         // The pointers are both in the heap:
-        return compare_heap_area(addr_pointed1, addr_pointed2, snapshot1,
+        return compare_heap_area(process_index, addr_pointed1, addr_pointed2, snapshot1,
                                  snapshot2, NULL, type->subtype, pointer_level);
       }
+
       // The pointers are both in the current object R/W segment:
-      else if (addr_pointed1 > region1->start_addr
-               && (char *) addr_pointed1 <= (char *) region1->start_addr + region1->size) {
-        if (!
-            (addr_pointed2 > region2->start_addr
-             && (char *) addr_pointed2 <= (char *) region2->start_addr + region2->size))
+      else if (region1->contain(simgrid::mc::remote(addr_pointed1))) {
+        if (!region2->contain(simgrid::mc::remote(addr_pointed2)))
           return 1;
         if (type->dw_type_id == NULL)
           return (addr_pointed1 != addr_pointed2);
         else {
-          return compare_areas_with_type(state,
+          return compare_areas_with_type(state, process_index,
                                          addr_pointed1, snapshot1, region1,
                                          addr_pointed2, snapshot2, region2,
                                          type->subtype, pointer_level);
         }
       }
 
+      // TODO, We do not handle very well the case where
+      // it belongs to a different (non-heap) region from the current one.
+
       else {
         return (addr_pointed1 != addr_pointed2);
       }
@@ -216,13 +234,13 @@ static int compare_areas_with_type(struct mc_compare_state& state,
   case DW_TAG_class_type:
     xbt_dynar_foreach(type->members, cursor, member) {
       void *member1 =
-        mc_member_resolve(real_area1, type, member, snapshot1);
+        mc_member_resolve(real_area1, type, member, snapshot1, process_index);
       void *member2 =
-        mc_member_resolve(real_area2, type, member, snapshot2);
-      mc_mem_region_t subregion1 = mc_get_region_hinted(member1, snapshot1, region1);
-      mc_mem_region_t subregion2 = mc_get_region_hinted(member2, snapshot2, region2);
+        mc_member_resolve(real_area2, type, member, snapshot2, process_index);
+      mc_mem_region_t subregion1 = mc_get_region_hinted(member1, snapshot1, process_index, region1);
+      mc_mem_region_t subregion2 = mc_get_region_hinted(member2, snapshot2, process_index, region2);
       res =
-          compare_areas_with_type(state,
+          compare_areas_with_type(state, process_index,
                                   member1, snapshot1, subregion1,
                                   member2, snapshot2, subregion2,
                                   member->subtype, pointer_level);
@@ -241,12 +259,40 @@ static int compare_areas_with_type(struct mc_compare_state& state,
   return 0;
 }
 
-static int compare_global_variables(int region_type, mc_mem_region_t r1,
+static int compare_global_variables(mc_object_info_t object_info,
+                                    int process_index,
+                                    mc_mem_region_t r1,
                                     mc_mem_region_t r2, mc_snapshot_t snapshot1,
                                     mc_snapshot_t snapshot2)
 {
-  xbt_assert(r1 && r2,
-    "Missing region. Did you enable SMPI privatisation? It is not compatible with state comparison.");
+  xbt_assert(r1 && r2, "Missing region.");
+
+#ifdef HAVE_SMPI
+  if (r1->storage_type() == simgrid::mc::StorageType::Privatized) {
+    xbt_assert(process_index >= 0);
+    if (r2->storage_type() != simgrid::mc::StorageType::Privatized) {
+      return 1;
+    }
+
+    size_t process_count = MC_smpi_process_count();
+    xbt_assert(process_count == r1->privatized_data().size()
+      && process_count == r2->privatized_data().size());
+
+    // Compare the global variables separately for each simulates process:
+    for (size_t process_index = 0; process_index < process_count; process_index++) {
+      int is_diff = compare_global_variables(object_info, process_index,
+        &r1->privatized_data()[process_index],
+        &r2->privatized_data()[process_index],
+        snapshot1, snapshot2);
+      if (is_diff) return 1;
+    }
+    return 0;
+  }
+#else
+  xbt_assert(r1->storage_type() != simgrid::mc::StorageType::Privatized);
+#endif
+  xbt_assert(r2->storage_type() != simgrid::mc::StorageType::Privatized);
+
   struct mc_compare_state state;
 
   xbt_dynar_t variables;
@@ -254,12 +300,6 @@ static int compare_global_variables(int region_type, mc_mem_region_t r1,
   unsigned int cursor = 0;
   dw_variable_t current_var;
 
-  mc_object_info_t object_info = NULL;
-  if (region_type == 2) {
-    object_info = mc_binary_info;
-  } else {
-    object_info = mc_libsimgrid_info;
-  }
   variables = object_info->global_variables;
 
   xbt_dynar_foreach(variables, cursor, current_var) {
@@ -273,11 +313,12 @@ static int compare_global_variables(int region_type, mc_mem_region_t r1,
 
     dw_type_t bvariable_type = current_var->type;
     res =
-        compare_areas_with_type(state,
+        compare_areas_with_type(state, process_index,
                                 (char *) current_var->address, snapshot1, r1,
                                 (char *) current_var->address, snapshot2, r2,
                                 bvariable_type, 0);
     if (res == 1) {
+      XBT_TRACE3(mc, global_diff, -1, -1, current_var->name);
       XBT_VERB("Global variable %s (%p) is different between snapshots",
                current_var->name, (char *) current_var->address);
       return 1;
@@ -289,7 +330,8 @@ static int compare_global_variables(int region_type, mc_mem_region_t r1,
 
 }
 
-static int compare_local_variables(mc_snapshot_t snapshot1,
+static int compare_local_variables(int process_index,
+                                   mc_snapshot_t snapshot1,
                                    mc_snapshot_t snapshot2,
                                    mc_snapshot_stack_t stack1,
                                    mc_snapshot_stack_t stack2)
@@ -311,13 +353,13 @@ static int compare_local_variables(mc_snapshot_t snapshot1,
       current_var2 =
           (local_variable_t) xbt_dynar_get_as(stack2->local_variables, cursor,
                                               local_variable_t);
-      if (strcmp(current_var1->name, current_var2->name) != 0
+      if (current_var1->name != current_var2->name
           || current_var1->subprogram != current_var1->subprogram
           || current_var1->ip != current_var2->ip) {
         // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
         XBT_VERB
             ("Different name of variable (%s - %s) or frame (%s - %s) or ip (%lu - %lu)",
-             current_var1->name, current_var2->name,
+             current_var1->name.c_str(), current_var2->name.c_str(),
              current_var1->subprogram->name, current_var2->subprogram->name,
              current_var1->ip, current_var2->ip);
         return 1;
@@ -326,16 +368,17 @@ static int compare_local_variables(mc_snapshot_t snapshot1,
 
         dw_type_t subtype = current_var1->type;
         res =
-            compare_areas_with_type(state,
-                                    current_var1->address, snapshot1, mc_get_snapshot_region(current_var1->address, snapshot1),
-                                    current_var2->address, snapshot2, mc_get_snapshot_region(current_var2->address, snapshot2),
+            compare_areas_with_type(state, process_index,
+                                    current_var1->address, snapshot1, mc_get_snapshot_region(current_var1->address, snapshot1, process_index),
+                                    current_var2->address, snapshot2, mc_get_snapshot_region(current_var2->address, snapshot2, process_index),
                                     subtype, 0);
 
       if (res == 1) {
         // TODO, fix current_varX->subprogram->name to include name if DW_TAG_inlined_subprogram
+        XBT_TRACE3(mc, local_diff, -1, -1, current_var1->name);
         XBT_VERB
             ("Local variable %s (%p - %p) in frame %s  is different between snapshots",
-             current_var1->name, current_var1->address, current_var2->address,
+             current_var1->name.c_str(), current_var1->address, current_var2->address,
              current_var1->subprogram->name);
         return res;
       }
@@ -347,6 +390,7 @@ static int compare_local_variables(mc_snapshot_t snapshot1,
 
 int snapshot_compare(void *state1, void *state2)
 {
+  mc_process_t process = &mc_model_checker->process();
 
   mc_snapshot_t s1, s2;
   int num1, num2;
@@ -356,6 +400,11 @@ int snapshot_compare(void *state1, void *state2)
     s2 = ((mc_visited_pair_t) state2)->graph_state->system_state;
     num1 = ((mc_visited_pair_t) state1)->num;
     num2 = ((mc_visited_pair_t) state2)->num;
+  }else if (_sg_mc_termination) { /* Non-progressive cycle MC */
+    s1 = ((mc_state_t) state1)->system_state;
+    s2 = ((mc_state_t) state2)->system_state;
+    num1 = ((mc_state_t) state1)->num;
+    num2 = ((mc_state_t) state2)->num;
   } else {                      /* Safety or comm determinism MC */
     s1 = ((mc_visited_state_t) state1)->system_state;
     s2 = ((mc_visited_state_t) state2)->system_state;
@@ -379,6 +428,7 @@ int snapshot_compare(void *state1, void *state2)
   if (_sg_mc_hash) {
     hash_result = (s1->hash != s2->hash);
     if (hash_result) {
+      XBT_TRACE2(mc, hash_diff, num1, num2);
       XBT_VERB("(%d - %d) Different hash : 0x%" PRIx64 "--0x%" PRIx64, num1,
                num2, s1->hash, s2->hash);
 #ifndef MC_DEBUG
@@ -390,11 +440,10 @@ int snapshot_compare(void *state1, void *state2)
   }
 
   /* Compare enabled processes */
-  unsigned int cursor;
-  int pid;
-  xbt_dynar_foreach(s1->enabled_processes, cursor, pid){
-    if(!xbt_dynar_member(s2->enabled_processes, &pid))
+  if (s1->enabled_processes != s2->enabled_processes) {
+      //XBT_TRACE3(mc, state_diff, num1, num2, "Different enabled processes");
       XBT_VERB("(%d - %d) Different enabled processes", num1, num2);
+      // return 1; ??
   }
 
   unsigned long i = 0;
@@ -421,6 +470,7 @@ int snapshot_compare(void *state1, void *state2)
       XBT_VERB("(%d - %d) Different size used in stacks : %zu - %zu", num1,
                num2, size_used1, size_used2);
 #endif
+      XBT_TRACE3(mc, state_diff, num1, num2, "Different stack size");
 
       xbt_os_walltimer_stop(timer);
       xbt_os_timer_free(timer);
@@ -441,17 +491,22 @@ int snapshot_compare(void *state1, void *state2)
 #endif
 
   /* Init heap information used in heap comparison algorithm */
-  xbt_mheap_t heap1 = (xbt_mheap_t) mc_snapshot_read(std_heap, s1,
-    alloca(sizeof(struct mdesc)), sizeof(struct mdesc));
-  xbt_mheap_t heap2 = (xbt_mheap_t) mc_snapshot_read(std_heap, s2,
-    alloca(sizeof(struct mdesc)), sizeof(struct mdesc));
-  res_init = init_heap_information(heap1, heap2, s1->to_ignore, s2->to_ignore);
+  xbt_mheap_t heap1 = (xbt_mheap_t)s1->read_bytes(
+    alloca(sizeof(struct mdesc)), sizeof(struct mdesc),
+    remote(process->heap_address),
+    simgrid::mc::ProcessIndexMissing, simgrid::mc::AddressSpace::Lazy);
+  xbt_mheap_t heap2 = (xbt_mheap_t)s2->read_bytes(
+    alloca(sizeof(struct mdesc)), sizeof(struct mdesc),
+    remote(process->heap_address),
+    simgrid::mc::ProcessIndexMissing, simgrid::mc::AddressSpace::Lazy);
+  res_init = init_heap_information(heap1, heap2, &s1->to_ignore, &s2->to_ignore);
   if (res_init == -1) {
 #ifdef MC_DEBUG
     XBT_DEBUG("(%d - %d) Different heap information", num1, num2);
     errors++;
 #else
 #ifdef MC_VERBOSE
+    XBT_TRACE3(mc, state_diff, num1, num2, "Different heap information");
     XBT_VERB("(%d - %d) Different heap information", num1, num2);
 #endif
 
@@ -467,13 +522,12 @@ int snapshot_compare(void *state1, void *state2)
 #endif
 
   /* Stacks comparison */
-  cursor = 0;
+  unsigned cursor = 0;
   int diff_local = 0;
 #ifdef MC_DEBUG
   is_diff = 0;
 #endif
   mc_snapshot_stack_t stack1, stack2;
-
   while (cursor < xbt_dynar_length(s1->stacks)) {
     stack1 =
         (mc_snapshot_stack_t) xbt_dynar_get_as(s1->stacks, cursor,
@@ -481,9 +535,16 @@ int snapshot_compare(void *state1, void *state2)
     stack2 =
         (mc_snapshot_stack_t) xbt_dynar_get_as(s2->stacks, cursor,
                                                mc_snapshot_stack_t);
-    diff_local =
-        compare_local_variables(s1, s2, stack1, stack2);
+
+    if (stack1->process_index != stack2->process_index) {
+      diff_local = 1;
+      XBT_DEBUG("(%d - %d) Stacks with different process index (%i vs %i)", num1, num2,
+        stack1->process_index, stack2->process_index);
+    }
+    else diff_local =
+        compare_local_variables(stack1->process_index, s1, s2, stack1, stack2);
     if (diff_local > 0) {
+      XBT_TRACE3(mc, state_diff, num1, num2, "Different local variables");
 #ifdef MC_DEBUG
       if (is_diff == 0) {
         xbt_os_walltimer_stop(timer);
@@ -513,19 +574,26 @@ int snapshot_compare(void *state1, void *state2)
     cursor++;
   }
 
+  size_t regions_count = s1->snapshot_regions.size();
+  // TODO, raise a difference instead?
+  xbt_assert(regions_count == s2->snapshot_regions.size());
 
+  mc_comp_times->global_variables_comparison_time = 0;
 
-  const char *names[3] = { "?", "libsimgrid", "binary" };
-#ifdef MC_DEBUG
-  double *times[3] = {
-    NULL,
-    &mc_comp_times->libsimgrid_global_variables_comparison_time,
-    &mc_comp_times->binary_global_variables_comparison_time
-  };
-#endif
+  for (size_t k = 0; k != regions_count; ++k) {
+    mc_mem_region_t region1 = s1->snapshot_regions[k].get();
+    mc_mem_region_t region2 = s2->snapshot_regions[k].get();
+
+    // Preconditions:
+    if (region1->region_type() != simgrid::mc::RegionType::Data)
+      continue;
+
+    xbt_assert(region1->region_type() == region2->region_type());
+    xbt_assert(region1->object_info() == region2->object_info());
+    xbt_assert(region1->object_info());
+
+    const char* name = region1->object_info()->file_name;
 
-  int k = 0;
-  for (k = 2; k != 0; --k) {
 #ifdef MC_DEBUG
     if (is_diff == 0)
       xbt_os_walltimer_stop(timer);
@@ -534,18 +602,23 @@ int snapshot_compare(void *state1, void *state2)
 
     /* Compare global variables */
     is_diff =
-        compare_global_variables(k, s1->regions[k], s2->regions[k], s1, s2);
+      compare_global_variables(region1->object_info(  ), simgrid::mc::AddressSpace::Normal,
+        region1, region2,
+        s1, s2);
+
     if (is_diff != 0) {
+      XBT_TRACE3(mc, state_diff, num1, num2, "Different global variables");
 #ifdef MC_DEBUG
       xbt_os_walltimer_stop(timer);
-      *times[k] = xbt_os_timer_elapsed(timer);
+      mc_comp_times->global_variables_comparison_time
+        += xbt_os_timer_elapsed(timer);
       XBT_DEBUG("(%d - %d) Different global variables in %s", num1, num2,
-                names[k]);
+                name);
       errors++;
 #else
 #ifdef MC_VERBOSE
       XBT_VERB("(%d - %d) Different global variables in %s", num1, num2,
-               names[k]);
+               name);
 #endif
 
       reset_heap_information();
@@ -566,6 +639,7 @@ int snapshot_compare(void *state1, void *state2)
 
   /* Compare heap */
   if (mmalloc_compare_heap(s1, s2) > 0) {
+    XBT_TRACE3(mc, state_diff, num1, num2, "Different heap");
 
 #ifdef MC_DEBUG
     xbt_os_walltimer_stop(timer);
@@ -640,28 +714,9 @@ void print_comparison_times()
   XBT_DEBUG("- Nb processes : %f", mc_comp_times->nb_processes_comparison_time);
   XBT_DEBUG("- Nb bytes used : %f", mc_comp_times->bytes_used_comparison_time);
   XBT_DEBUG("- Stacks sizes : %f", mc_comp_times->stacks_sizes_comparison_time);
-  XBT_DEBUG("- Binary global variables : %f",
-            mc_comp_times->binary_global_variables_comparison_time);
-  XBT_DEBUG("- Libsimgrid global variables : %f",
-            mc_comp_times->libsimgrid_global_variables_comparison_time);
+  XBT_DEBUG("- GLobal variables : %f", mc_comp_times->global_variables_comparison_time);
   XBT_DEBUG("- Heap : %f", mc_comp_times->heap_comparison_time);
   XBT_DEBUG("- Stacks : %f", mc_comp_times->stacks_comparison_time);
 }
 
-/**************************** MC snapshot compare simcall **************************/
-/***********************************************************************************/
-
-int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall,
-                                   mc_snapshot_t s1, mc_snapshot_t s2)
-{
-  return snapshot_compare(s1, s2);
-}
-
-int MC_compare_snapshots(void *s1, void *s2)
-{
-
-  return simcall_mc_compare_snapshots(s1, s2);
-
-}
-
 }