Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
mc/compare: define is_on_heap(const void*).
[simgrid.git] / src / mc / compare.cpp
index c86de8c..f0744fa 100644 (file)
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_compare, xbt, "Logging specific to mc_compare in mc");
 
+using simgrid::mc::remote;
+
 namespace simgrid {
 namespace mc {
 
-struct HeapLocation;
-typedef std::array<HeapLocation, 2> HeapLocationPair;
-typedef std::set<HeapLocationPair> HeapLocationPairs;
-struct HeapArea;
-struct ProcessComparisonState;
-struct StateComparator;
-
-static int compare_heap_area(StateComparator& state, const void* area1, const void* area2, Snapshot* snapshot1,
-                             Snapshot* snapshot2, HeapLocationPairs* previous, Type* type, int pointer_level);
-}
-}
-
-using simgrid::mc::remote;
-
 /*********************************** Heap comparison ***********************************/
 /***************************************************************************************/
 
-namespace simgrid {
-namespace mc {
-
 class HeapLocation {
 public:
   int block_    = 0;
@@ -53,13 +38,16 @@ public:
   }
 };
 
+typedef std::array<HeapLocation, 2> HeapLocationPair;
+typedef std::set<HeapLocationPair> HeapLocationPairs;
+
+struct ProcessComparisonState;
+struct StateComparator;
+
 static inline
 HeapLocationPair makeHeapLocationPair(int block1, int fragment1, int block2, int fragment2)
 {
-  return simgrid::mc::HeapLocationPair{{
-    simgrid::mc::HeapLocation(block1, fragment1),
-    simgrid::mc::HeapLocation(block2, fragment2)
-  }};
+  return HeapLocationPair{{HeapLocation(block1, fragment1), HeapLocation(block2, fragment2)}};
 }
 
 class HeapArea : public HeapLocation {
@@ -84,26 +72,8 @@ public:
   void initHeapInformation(xbt_mheap_t heap, std::vector<simgrid::mc::IgnoredHeapRegion>* i);
 };
 
-namespace {
-
-/** A hash which works with more stuff
- *
- *  It can hash pairs: the standard hash currently doesn't include this.
- */
-template <class X> class hash : public std::hash<X> {
-};
-
-template <class X, class Y> class hash<std::pair<X, Y>> {
-public:
-  std::size_t operator()(std::pair<X,Y>const& x) const
-  {
-    hash<X> h1;
-    hash<X> h2;
-    return h1(x.first) ^ h2(x.second);
-  }
-};
-
-}
+static int compare_heap_area(StateComparator& state, const void* area1, const void* area2, Snapshot* snapshot1,
+                             Snapshot* snapshot2, HeapLocationPairs* previous, Type* type, int pointer_level);
 
 class StateComparator {
 public:
@@ -111,7 +81,8 @@ public:
   std::size_t heaplimit;
   std::array<ProcessComparisonState, 2> processStates;
 
-  std::unordered_set<std::pair<void*, void*>, hash<std::pair<void*, void*>>> compared_pointers;
+  std::unordered_set<std::pair<const void*, const void*>, simgrid::xbt::hash<std::pair<const void*, const void*>>>
+      compared_pointers;
 
   void clear()
   {
@@ -211,6 +182,12 @@ static ssize_t heap_comparison_ignore_size(
   return -1;
 }
 
+static bool is_on_heap(const void* address)
+{
+  const xbt_mheap_t heap = mc_model_checker->process().get_heap();
+  return address >= heap->heapbase && address < heap->breakval;
+}
+
 static bool is_stack(const void *address)
 {
   for (auto const& stack : mc_model_checker->process().stack_areas())
@@ -281,11 +258,6 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
 {
   simgrid::mc::RemoteClient* process = &mc_model_checker->process();
 
-  /* Start comparison */
-  int nb_diff1 = 0;
-  int nb_diff2 = 0;
-  bool equal;
-
   /* Check busy blocks */
   size_t i1 = 1;
 
@@ -341,7 +313,7 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
       }
 
       size_t i2 = 1;
-      equal     = false;
+      bool equal = false;
 
       /* Try first to associate to same block in the other heap */
       if (heapinfo2->type == heapinfo1->type && state.equals_to2_(i1, 0).valid_ == 0) {
@@ -395,8 +367,7 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
 
       if (not equal) {
         XBT_DEBUG("Block %zu not found (size_used = %zu, addr = %p)", i1, heapinfo1->busy_block.busy_size, addr_block1);
-        i1 = state.heaplimit + 1;
-        nb_diff1++;
+        return false;
       }
 
     } else {                    /* Fragmented block */
@@ -412,7 +383,7 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
         void* addr_frag1 = (void*)((char*)addr_block1 + (j1 << heapinfo1->type));
 
         size_t i2 = 1;
-        equal     = false;
+        bool equal = false;
 
         /* Try first to associate to same fragment_ in the other heap */
         if (heapinfo2->type == heapinfo1->type && not state.equals_to2_(i1, j1).valid_) {
@@ -456,7 +427,7 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
             void* addr_frag2  = (void*)((char*)addr_block2 + (j2 << heapinfo2b->type));
 
             int res_compare =
-                compare_heap_area(state, addr_frag1, addr_frag2, snapshot2, snapshot2, nullptr, nullptr, 0);
+                compare_heap_area(state, addr_frag1, addr_frag2, snapshot1, snapshot2, nullptr, nullptr, 0);
             if (res_compare != 1) {
               equal = true;
               break;
@@ -469,9 +440,7 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
         if (not equal) {
           XBT_DEBUG("Block %zu, fragment_ %zu not found (size_used = %zd, address = %p)\n", i1, j1,
                     heapinfo1->busy_frag.frag_size[j1], addr_frag1);
-          i1 = state.heaplimit + 1;
-          nb_diff1++;
-          break;
+          return false;
         }
       }
 
@@ -487,7 +456,7 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
     if (heapinfo1->type == MMALLOC_TYPE_UNFRAGMENTED && i1 == state.heaplimit && heapinfo1->busy_block.busy_size > 0 &&
         not state.equals_to1_(i, 0).valid_) {
       XBT_DEBUG("Block %zu not found (size used = %zu)", i, heapinfo1->busy_block.busy_size);
-      nb_diff1++;
+      return false;
     }
 
     if (heapinfo1->type <= 0)
@@ -495,13 +464,10 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
     for (size_t j = 0; j < (size_t)(BLOCKSIZE >> heapinfo1->type); j++)
       if (i1 == state.heaplimit && heapinfo1->busy_frag.frag_size[j] > 0 && not state.equals_to1_(i, j).valid_) {
         XBT_DEBUG("Block %zu, Fragment %zu not found (size used = %zd)", i, j, heapinfo1->busy_frag.frag_size[j]);
-        nb_diff1++;
+        return false;
       }
   }
 
-  if (i1 == state.heaplimit)
-    XBT_DEBUG("Number of blocks/fragments not found in heap1: %d", nb_diff1);
-
   for (size_t i = 1; i < state.heaplimit; i++) {
     const malloc_info* heapinfo2 =
         (const malloc_info*)heap_region2->read(&heapinfo_temp2, &heapinfos2[i], sizeof(malloc_info));
@@ -509,7 +475,7 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
         not state.equals_to2_(i, 0).valid_) {
       XBT_DEBUG("Block %zu not found (size used = %zu)", i,
                 heapinfo2->busy_block.busy_size);
-      nb_diff2++;
+      return false;
     }
 
     if (heapinfo2->type <= 0)
@@ -519,15 +485,11 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
       if (i1 == state.heaplimit && heapinfo2->busy_frag.frag_size[j] > 0 && not state.equals_to2_(i, j).valid_) {
         XBT_DEBUG("Block %zu, Fragment %zu not found (size used = %zd)",
           i, j, heapinfo2->busy_frag.frag_size[j]);
-        nb_diff2++;
+        return false;
       }
-
   }
 
-  if (i1 == state.heaplimit)
-    XBT_DEBUG("Number of blocks/fragments not found in heap2: %d", nb_diff2);
-
-  return nb_diff1 == 0 && nb_diff2 == 0;
+  return true;
 }
 
 /**
@@ -541,10 +503,10 @@ static bool mmalloc_heap_equal(simgrid::mc::StateComparator& state, simgrid::mc:
  * @param size
  * @param check_ignore
  */
-static int compare_heap_area_without_type(simgrid::mc::StateComparator& state, const void* real_area1,
-                                          const void* real_area2, simgrid::mc::Snapshot* snapshot1,
-                                          simgrid::mc::Snapshot* snapshot2, HeapLocationPairs* previous, int size,
-                                          int check_ignore)
+static bool heap_area_equal_without_type(simgrid::mc::StateComparator& state, const void* real_area1,
+                                         const void* real_area2, simgrid::mc::Snapshot* snapshot1,
+                                         simgrid::mc::Snapshot* snapshot2, HeapLocationPairs* previous, int size,
+                                         int check_ignore)
 {
   simgrid::mc::RemoteClient* process = &mc_model_checker->process();
   simgrid::mc::Region* heap_region1  = MC_get_heap_region(snapshot1);
@@ -553,15 +515,13 @@ static int compare_heap_area_without_type(simgrid::mc::StateComparator& state, c
   for (int i = 0; i < size; ) {
 
     if (check_ignore > 0) {
-      ssize_t ignore1 = heap_comparison_ignore_size(
-        state.processStates[0].to_ignore, (char *) real_area1 + i);
+      ssize_t ignore1 = heap_comparison_ignore_size(state.processStates[0].to_ignore, (const char*)real_area1 + i);
       if (ignore1 != -1) {
-        ssize_t ignore2 = heap_comparison_ignore_size(
-          state.processStates[1].to_ignore, (char *) real_area2 + i);
+        ssize_t ignore2 = heap_comparison_ignore_size(state.processStates[1].to_ignore, (const char*)real_area2 + i);
         if (ignore2 == ignore1) {
           if (ignore1 == 0) {
             check_ignore--;
-            return 0;
+            return true;
           } else {
             i = i + ignore2;
             check_ignore--;
@@ -571,11 +531,12 @@ static int compare_heap_area_without_type(simgrid::mc::StateComparator& state, c
       }
     }
 
-    if (MC_snapshot_region_memcmp(((char *) real_area1) + i, heap_region1, ((char *) real_area2) + i, heap_region2, 1) != 0) {
+    if (MC_snapshot_region_memcmp((const char*)real_area1 + i, heap_region1, (const char*)real_area2 + i, heap_region2,
+                                  1) != 0) {
 
       int pointer_align = (i / sizeof(void *)) * sizeof(void *);
-      const void* addr_pointed1 = snapshot1->read(remote((void**)((char*)real_area1 + pointer_align)));
-      const void* addr_pointed2 = snapshot2->read(remote((void**)((char*)real_area2 + pointer_align)));
+      const void* addr_pointed1 = snapshot1->read(remote((void**)((const char*)real_area1 + pointer_align)));
+      const void* addr_pointed2 = snapshot2->read(remote((void**)((const char*)real_area2 + pointer_align)));
 
       if (process->in_maestro_stack(remote(addr_pointed1))
         && process->in_maestro_stack(remote(addr_pointed2))) {
@@ -583,26 +544,23 @@ static int compare_heap_area_without_type(simgrid::mc::StateComparator& state, c
         continue;
       }
 
-      if (addr_pointed1 > state.std_heap_copy.heapbase
-           && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)
-           && addr_pointed2 > state.std_heap_copy.heapbase
-           && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)) {
+      if (is_on_heap(addr_pointed1) && is_on_heap(addr_pointed2)) {
         // Both addresses are in the heap:
         int res_compare =
             compare_heap_area(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, previous, nullptr, 0);
         if (res_compare == 1)
-          return res_compare;
+          return false;
         i = pointer_align + sizeof(void *);
         continue;
       }
 
-      return 1;
+      return false;
     }
 
     i++;
   }
 
-  return 0;
+  return true;
 }
 
 /**
@@ -711,8 +669,8 @@ static int compare_heap_area_with_type(simgrid::mc::StateComparator& state, cons
       }
       for (int i = 0; i < type->element_count; i++) {
         // TODO, add support for variable stride (DW_AT_byte_stride)
-        int res = compare_heap_area_with_type(state, (char*)real_area1 + (i * elm_size),
-                                              (char*)real_area2 + (i * elm_size), snapshot1, snapshot2, previous,
+        int res = compare_heap_area_with_type(state, (const char*)real_area1 + (i * elm_size),
+                                              (const char*)real_area2 + (i * elm_size), snapshot1, snapshot2, previous,
                                               type->subtype, subtype->byte_size, check_ignore, pointer_level);
         if (res == 1)
           return res;
@@ -723,27 +681,25 @@ static int compare_heap_area_with_type(simgrid::mc::StateComparator& state, cons
     case DW_TAG_rvalue_reference_type:
     case DW_TAG_pointer_type:
       if (type->subtype && type->subtype->type == DW_TAG_subroutine_type) {
-        addr_pointed1 = snapshot1->read(remote((void**)real_area1));
-        addr_pointed2 = snapshot2->read(remote((void**)real_area2));
+        addr_pointed1 = snapshot1->read(remote((void* const*)real_area1));
+        addr_pointed2 = snapshot2->read(remote((void* const*)real_area2));
         return (addr_pointed1 != addr_pointed2);
       }
       pointer_level++;
       if (pointer_level <= 1) {
-        addr_pointed1 = snapshot1->read(remote((void**)real_area1));
-        addr_pointed2 = snapshot2->read(remote((void**)real_area2));
-        if (addr_pointed1 > state.std_heap_copy.heapbase && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1) &&
-            addr_pointed2 > state.std_heap_copy.heapbase && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2))
+        addr_pointed1 = snapshot1->read(remote((void* const*)real_area1));
+        addr_pointed2 = snapshot2->read(remote((void* const*)real_area2));
+        if (is_on_heap(addr_pointed1) && is_on_heap(addr_pointed2))
           return compare_heap_area(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, previous, type->subtype,
                                    pointer_level);
         else
           return (addr_pointed1 != addr_pointed2);
       }
       for (size_t i = 0; i < (area_size / sizeof(void*)); i++) {
-        addr_pointed1 = snapshot1->read(remote((void**)((char*)real_area1 + i * sizeof(void*))));
-        addr_pointed2 = snapshot2->read(remote((void**)((char*)real_area2 + i * sizeof(void*))));
+        addr_pointed1 = snapshot1->read(remote((void* const*)((const char*)real_area1 + i * sizeof(void*))));
+        addr_pointed2 = snapshot2->read(remote((void* const*)((const char*)real_area2 + i * sizeof(void*))));
         int res;
-        if (addr_pointed1 > state.std_heap_copy.heapbase && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1) &&
-            addr_pointed2 > state.std_heap_copy.heapbase && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2))
+        if (is_on_heap(addr_pointed1) && is_on_heap(addr_pointed2))
           res = compare_heap_area(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, previous, type->subtype,
                                   pointer_level);
         else
@@ -761,9 +717,9 @@ static int compare_heap_area_with_type(simgrid::mc::StateComparator& state, cons
         if (area_size <= type->byte_size || area_size % type->byte_size != 0)
           return -1;
         for (size_t i = 0; i < (size_t)(area_size / type->byte_size); i++) {
-          int res = compare_heap_area_with_type(state, (char*)real_area1 + i * type->byte_size,
-                                                (char*)real_area2 + i * type->byte_size, snapshot1, snapshot2, previous,
-                                                type, -1, check_ignore, 0);
+          int res = compare_heap_area_with_type(state, (const char*)real_area1 + i * type->byte_size,
+                                                (const char*)real_area2 + i * type->byte_size, snapshot1, snapshot2,
+                                                previous, type, -1, check_ignore, 0);
           if (res == 1)
             return res;
         }
@@ -783,8 +739,12 @@ static int compare_heap_area_with_type(simgrid::mc::StateComparator& state, cons
         return 0;
 
     case DW_TAG_union_type:
-      return compare_heap_area_without_type(state, real_area1, real_area2, snapshot1, snapshot2, previous,
-                                            type->byte_size, check_ignore);
+      return not heap_area_equal_without_type(state, real_area1, real_area2, snapshot1, snapshot2, previous,
+                                              type->byte_size, check_ignore);
+
+    default:
+      XBT_VERB("Unknown case: %d", type->type);
+      break;
   }
   return 0;
 }
@@ -1124,7 +1084,7 @@ static int compare_heap_area(simgrid::mc::StateComparator& state, const void* ar
                                               check_ignore, pointer_level);
   else
     res_compare =
-        compare_heap_area_without_type(state, area1, area2, snapshot1, snapshot2, previous, size, check_ignore);
+        not heap_area_equal_without_type(state, area1, area2, snapshot1, snapshot2, previous, size, check_ignore);
 
   if (res_compare == 1)
     return res_compare;
@@ -1140,13 +1100,11 @@ static int compare_heap_area(simgrid::mc::StateComparator& state, const void* ar
 /************************** Snapshot comparison *******************************/
 /******************************************************************************/
 
-static int compare_areas_with_type(simgrid::mc::StateComparator& state, void* real_area1,
-                                   simgrid::mc::Snapshot* snapshot1, simgrid::mc::Region* region1, void* real_area2,
-                                   simgrid::mc::Snapshot* snapshot2, simgrid::mc::Region* region2,
-                                   simgrid::mc::Type* type, int pointer_level)
+static int compare_areas_with_type(simgrid::mc::StateComparator& state, const void* real_area1,
+                                   simgrid::mc::Snapshot* snapshot1, simgrid::mc::Region* region1,
+                                   const void* real_area2, simgrid::mc::Snapshot* snapshot2,
+                                   simgrid::mc::Region* region2, simgrid::mc::Type* type, int pointer_level)
 {
-  simgrid::mc::RemoteClient* process = &mc_model_checker->process();
-
   simgrid::mc::Type* subtype;
   simgrid::mc::Type* subsubtype;
   int elm_size;
@@ -1207,8 +1165,8 @@ static int compare_areas_with_type(simgrid::mc::StateComparator& state, void* re
     case DW_TAG_pointer_type:
     case DW_TAG_reference_type:
     case DW_TAG_rvalue_reference_type: {
-      void* addr_pointed1 = MC_region_read_pointer(region1, real_area1);
-      void* addr_pointed2 = MC_region_read_pointer(region2, real_area2);
+      const void* addr_pointed1 = MC_region_read_pointer(region1, real_area1);
+      const 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);
@@ -1226,8 +1184,8 @@ static int compare_areas_with_type(simgrid::mc::StateComparator& state, void* re
       // * a pointer leads to the read-only segment of the current object
       // * a pointer lead to a different ELF object
 
-      if (addr_pointed1 > process->heap_address && addr_pointed1 < mc_snapshot_get_heap_end(snapshot1)) {
-        if (not(addr_pointed2 > process->heap_address && addr_pointed2 < mc_snapshot_get_heap_end(snapshot2)))
+      if (is_on_heap(addr_pointed1)) {
+        if (not is_on_heap(addr_pointed2))
           return 1;
         // The pointers are both in the heap:
         return simgrid::mc::compare_heap_area(state, addr_pointed1, addr_pointed2, snapshot1, snapshot2, nullptr,