Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'udpor-phase6' into 'master'
[simgrid.git] / src / mc / compare.cpp
index fdeba59..9fe8072 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2008-2022. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2008-2023. The SimGrid Team. All rights reserved.          */
 
 /* 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. */
@@ -7,7 +7,9 @@
 
 #include "src/mc/mc_config.hpp"
 #include "src/mc/mc_private.hpp"
+#include "src/mc/sosp/RemoteProcessMemory.hpp"
 #include "src/mc/sosp/Snapshot.hpp"
+#include "xbt/ex.h"
 
 #include <algorithm>
 
@@ -75,7 +77,7 @@ public:
     compared_pointers.clear();
   }
 
-  int initHeapInformation(const s_xbt_mheap_t* heap1, const s_xbt_mheap_t* heap2,
+  int initHeapInformation(RemoteProcessMemory& appli, const s_xbt_mheap_t* heap1, const s_xbt_mheap_t* heap2,
                           const std::vector<IgnoredHeapRegion>& i1, const std::vector<IgnoredHeapRegion>& i2);
 
   template <int rank> HeapArea& equals_to_(std::size_t i, std::size_t j)
@@ -136,7 +138,7 @@ static ssize_t heap_comparison_ignore_size(const std::vector<simgrid::mc::Ignore
   return (pos != ignore_list->end() && pos->address == address) ? pos->size : -1;
 }
 
-static bool is_stack(const simgrid::mc::RemoteProcess& process, const void* address)
+static bool is_stack(const simgrid::mc::RemoteProcessMemory& process, const void* address)
 {
   auto const& stack_areas = process.stack_areas();
   return std::any_of(stack_areas.begin(), stack_areas.end(),
@@ -144,7 +146,7 @@ static bool is_stack(const simgrid::mc::RemoteProcess& process, const void* addr
 }
 
 // TODO, this should depend on the snapshot?
-static bool is_block_stack(const simgrid::mc::RemoteProcess& process, int block)
+static bool is_block_stack(const simgrid::mc::RemoteProcessMemory& process, int block)
 {
   auto const& stack_areas = process.stack_areas();
   return std::any_of(stack_areas.begin(), stack_areas.end(),
@@ -175,14 +177,14 @@ void ProcessComparisonState::initHeapInformation(const s_xbt_mheap_t* heap, cons
   this->types.assign(heaplimit * MAX_FRAGMENT_PER_BLOCK, nullptr);
 }
 
-int StateComparator::initHeapInformation(const s_xbt_mheap_t* heap1, const s_xbt_mheap_t* heap2,
-                                         const std::vector<IgnoredHeapRegion>& i1,
+int StateComparator::initHeapInformation(simgrid::mc::RemoteProcessMemory& memory, const s_xbt_mheap_t* heap1,
+                                         const s_xbt_mheap_t* heap2, const std::vector<IgnoredHeapRegion>& i1,
                                          const std::vector<IgnoredHeapRegion>& i2)
 {
   if ((heap1->heaplimit != heap2->heaplimit) || (heap1->heapsize != heap2->heapsize))
     return -1;
   this->heaplimit     = heap1->heaplimit;
-  this->std_heap_copy = *mc_model_checker->get_remote_process().get_heap();
+  this->std_heap_copy = *memory.get_heap();
   this->processStates[0].initHeapInformation(heap1, i1);
   this->processStates[1].initHeapInformation(heap2, i2);
   return 0;
@@ -197,9 +199,9 @@ static inline Region* MC_get_heap_region(const Snapshot& snapshot)
   xbt_die("No heap region");
 }
 
-static bool heap_area_differ(const RemoteProcess& process, StateComparator& state, const void* area1, const void* area2,
-                             const Snapshot& snapshot1, const Snapshot& snapshot2, HeapLocationPairs* previous,
-                             Type* type, int pointer_level);
+static bool heap_area_differ(const RemoteProcessMemory& process, StateComparator& state, const void* area1,
+                             const void* area2, const Snapshot& snapshot1, const Snapshot& snapshot2,
+                             HeapLocationPairs* previous, Type* type, int pointer_level);
 
 /* Compares the content of each heap fragment between the two states, at the bit level.
  *
@@ -232,7 +234,7 @@ static bool heap_area_differ(const RemoteProcess& process, StateComparator& stat
  * of the liveness model-checker, as state-equality is used to detect the loops that constitute the accepting states of
  * the verified property. So we could miss counter-examples to the verified property. Not good. Not good at all.
  */
-static bool mmalloc_heap_differ(const RemoteProcess& process, StateComparator& state, const Snapshot& snapshot1,
+static bool mmalloc_heap_differ(const RemoteProcessMemory& process, StateComparator& state, const Snapshot& snapshot1,
                                 const Snapshot& snapshot2)
 {
   /* Check busy blocks */
@@ -456,9 +458,10 @@ static bool mmalloc_heap_differ(const RemoteProcess& process, StateComparator& s
  * @param check_ignore
  * @return true when different, false otherwise (same or unknown)
  */
-static bool heap_area_differ_without_type(const RemoteProcess& process, StateComparator& state, const void* real_area1,
-                                          const void* real_area2, const Snapshot& snapshot1, const Snapshot& snapshot2,
-                                          HeapLocationPairs* previous, int size, int check_ignore)
+static bool heap_area_differ_without_type(const RemoteProcessMemory& process, StateComparator& state,
+                                          const void* real_area1, const void* real_area2, const Snapshot& snapshot1,
+                                          const Snapshot& snapshot2, HeapLocationPairs* previous, int size,
+                                          int check_ignore)
 {
   const Region* heap_region1  = MC_get_heap_region(snapshot1);
   const Region* heap_region2  = MC_get_heap_region(snapshot2);
@@ -519,7 +522,7 @@ static bool heap_area_differ_without_type(const RemoteProcess& process, StateCom
  * @param pointer_level
  * @return               true when different, false otherwise (same or unknown)
  */
-static bool heap_area_differ_with_type(const simgrid::mc::RemoteProcess& process, StateComparator& state,
+static bool heap_area_differ_with_type(const simgrid::mc::RemoteProcessMemory& process, StateComparator& state,
                                        const void* real_area1, const void* real_area2, const Snapshot& snapshot1,
                                        const Snapshot& snapshot2, HeapLocationPairs* previous, const Type* type,
                                        int area_size, int check_ignore, int pointer_level)
@@ -742,9 +745,9 @@ static Type* get_offset_type(void* real_base_address, Type* type, int offset, in
  * @param pointer_level
  * @return true when different, false otherwise (same or unknown)
  */
-static bool heap_area_differ(const RemoteProcess& process, StateComparator& state, const void* area1, const void* area2,
-                             const Snapshot& snapshot1, const Snapshot& snapshot2, HeapLocationPairs* previous,
-                             Type* type, int pointer_level)
+static bool heap_area_differ(const RemoteProcessMemory& process, StateComparator& state, const void* area1,
+                             const void* area2, const Snapshot& snapshot1, const Snapshot& snapshot2,
+                             HeapLocationPairs* previous, Type* type, int pointer_level)
 {
   ssize_t block1;
   ssize_t block2;
@@ -790,9 +793,9 @@ static bool heap_area_differ(const RemoteProcess& process, StateComparator& stat
 
   // If either block is not in the expected area of memory:
   if (((const char*)area1 < (const char*)state.std_heap_copy.heapbase) ||
-      (block1 > (ssize_t)state.processStates[0].heapsize) || (block1 < 1) ||
+      (block1 > (ssize_t)state.processStates[0].heapsize) ||
       ((const char*)area2 < (const char*)state.std_heap_copy.heapbase) ||
-      (block2 > (ssize_t)state.processStates[1].heapsize) || (block2 < 1)) {
+      (block2 > (ssize_t)state.processStates[1].heapsize)) {
     return true;
   }
 
@@ -1015,7 +1018,7 @@ static bool heap_area_differ(const RemoteProcess& process, StateComparator& stat
 /************************** Snapshot comparison *******************************/
 /******************************************************************************/
 
-static bool areas_differ_with_type(const simgrid::mc::RemoteProcess& process, simgrid::mc::StateComparator& state,
+static bool areas_differ_with_type(const simgrid::mc::RemoteProcessMemory& process, simgrid::mc::StateComparator& state,
                                    const void* real_area1, const simgrid::mc::Snapshot& snapshot1,
                                    simgrid::mc::Region* region1, const void* real_area2,
                                    const simgrid::mc::Snapshot& snapshot2, simgrid::mc::Region* region2,
@@ -1142,7 +1145,8 @@ static bool areas_differ_with_type(const simgrid::mc::RemoteProcess& process, si
   return false;
 }
 
-static bool global_variables_differ(const simgrid::mc::RemoteProcess& process, simgrid::mc::StateComparator& state,
+static bool global_variables_differ(const simgrid::mc::RemoteProcessMemory& process,
+                                    simgrid::mc::StateComparator& state,
                                     const simgrid::mc::ObjectInformation* object_info, simgrid::mc::Region* r1,
                                     simgrid::mc::Region* r2, const simgrid::mc::Snapshot& snapshot1,
                                     const simgrid::mc::Snapshot& snapshot2)
@@ -1169,7 +1173,7 @@ static bool global_variables_differ(const simgrid::mc::RemoteProcess& process, s
   return false;
 }
 
-static bool local_variables_differ(const simgrid::mc::RemoteProcess& process, simgrid::mc::StateComparator& state,
+static bool local_variables_differ(const simgrid::mc::RemoteProcessMemory& process, simgrid::mc::StateComparator& state,
                                    const simgrid::mc::Snapshot& snapshot1, const simgrid::mc::Snapshot& snapshot2,
                                    const_mc_snapshot_stack_t stack1, const_mc_snapshot_stack_t stack2)
 {
@@ -1202,13 +1206,19 @@ static bool local_variables_differ(const simgrid::mc::RemoteProcess& process, si
 }
 
 namespace simgrid::mc {
-
-bool Snapshot::operator==(const Snapshot& other)
+bool Snapshot::equals_to(const Snapshot& other, RemoteProcessMemory& memory)
 {
-  // TODO, make this a field of ModelChecker or something similar
-  static StateComparator state_comparator;
+  /* TODO: the memory parameter should be eventually removed. It seems to be there because each snapshot lacks some sort
+    of metadata. That's OK for now (letting appart the fact that we cannot have a nice operator== because we need that
+    extra parameter), but it will fall short when we want to have parallel explorations, with more than one
+    RemoteProcess. At the very least, snapshots will need to know the remote process they are corresponding to, and more
+    probably they will need to embeed all their metadata to let the remoteprocesses die before the end of the
+    exploration. */
+
+  /* TODO: This method should moved to Snapshot.cpp, but it needs the StateComparator that is declared locally to this
+   * file only. */
 
-  const RemoteProcess& process = mc_model_checker->get_remote_process();
+  static StateComparator state_comparator; // TODO, make this a field of a persistant state object
 
   if (hash_ != other.hash_) {
     XBT_VERB("(%ld - %ld) Different hash: 0x%" PRIx64 "--0x%" PRIx64, this->num_state_, other.num_state_, this->hash_,
@@ -1231,11 +1241,11 @@ bool Snapshot::operator==(const Snapshot& other)
   }
 
   /* Init heap information used in heap comparison algorithm */
-  const s_xbt_mheap_t* heap1 = static_cast<xbt_mheap_t>(this->read_bytes(
-      alloca(sizeof(s_xbt_mheap_t)), sizeof(s_xbt_mheap_t), process.heap_address, ReadOptions::lazy()));
-  const s_xbt_mheap_t* heap2 = static_cast<xbt_mheap_t>(other.read_bytes(
-      alloca(sizeof(s_xbt_mheap_t)), sizeof(s_xbt_mheap_t), process.heap_address, ReadOptions::lazy()));
-  if (state_comparator.initHeapInformation(heap1, heap2, this->to_ignore_, other.to_ignore_) == -1) {
+  const s_xbt_mheap_t* heap1 = static_cast<xbt_mheap_t>(
+      this->read_bytes(alloca(sizeof(s_xbt_mheap_t)), sizeof(s_xbt_mheap_t), memory.heap_address, ReadOptions::lazy()));
+  const s_xbt_mheap_t* heap2 = static_cast<xbt_mheap_t>(
+      other.read_bytes(alloca(sizeof(s_xbt_mheap_t)), sizeof(s_xbt_mheap_t), memory.heap_address, ReadOptions::lazy()));
+  if (state_comparator.initHeapInformation(memory, heap1, heap2, this->to_ignore_, other.to_ignore_) == -1) {
     XBT_VERB("(%ld - %ld) Different heap information", this->num_state_, other.num_state_);
     return false;
   }
@@ -1245,7 +1255,7 @@ bool Snapshot::operator==(const Snapshot& other)
     const_mc_snapshot_stack_t stack1 = &this->stacks_[cursor];
     const_mc_snapshot_stack_t stack2 = &other.stacks_[cursor];
 
-    if (local_variables_differ(process, state_comparator, *this, other, stack1, stack2)) {
+    if (local_variables_differ(memory, state_comparator, *this, other, stack1, stack2)) {
       XBT_VERB("(%ld - %ld) Different local variables between stacks %u", this->num_state_, other.num_state_,
                cursor + 1);
       return false;
@@ -1269,7 +1279,7 @@ bool Snapshot::operator==(const Snapshot& other)
     xbt_assert(region1->object_info());
 
     /* Compare global variables */
-    if (global_variables_differ(process, state_comparator, region1->object_info(), region1, region2, *this, other)) {
+    if (global_variables_differ(memory, state_comparator, region1->object_info(), region1, region2, *this, other)) {
       std::string const& name = region1->object_info()->file_name;
       XBT_VERB("(%ld - %ld) Different global variables in %s", this->num_state_, other.num_state_, name.c_str());
       return false;
@@ -1278,7 +1288,7 @@ bool Snapshot::operator==(const Snapshot& other)
 
   XBT_VERB("   Compare heap...");
   /* Compare heap */
-  if (mmalloc_heap_differ(process, state_comparator, *this, other)) {
+  if (mmalloc_heap_differ(memory, state_comparator, *this, other)) {
     XBT_VERB("(%ld - %ld) Different heap (mmalloc_heap_differ)", this->num_state_, other.num_state_);
     return false;
   }