Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
MC request_enabled: add documentation and an explosive support for semaphores and...
[simgrid.git] / src / mc / mc_base.cpp
index 9717dfc..b82c3f2 100644 (file)
 #include "mc/mc.h"
 #include "src/mc/mc_protocol.h"
 
-#ifdef HAVE_MC
+#include "src/kernel/activity/ActivityImpl.hpp"
+#include "src/kernel/activity/SynchroIo.hpp"
+#include "src/kernel/activity/SynchroComm.hpp"
+#include "src/kernel/activity/SynchroRaw.hpp"
+#include "src/kernel/activity/SynchroSleep.hpp"
+#include "src/kernel/activity/SynchroExec.hpp"
+
+#if HAVE_MC
+#include "src/mc/mc_request.h"
 #include "src/mc/Process.hpp"
 #include "src/mc/ModelChecker.hpp"
 #include "src/mc/mc_smx.h"
 #endif
 
-#ifdef HAVE_MC
+#if HAVE_MC
 using simgrid::mc::remote;
 #endif
 
-extern "C" {
-
 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
 
 int MC_random(int min, int max)
 {
-  xbt_assert(mc_mode != MC_MODE_SERVER);
+#if HAVE_MC
+  xbt_assert(mc_model_checker == nullptr);
   /* TODO, if the MC is disabled we do not really need to make a simcall for
    * this :) */
-  /* FIXME: return mc_current_state->executed_transition->random.value; */
+#endif
   return simcall_mc_random(min, max);
 }
 
-void MC_wait_for_requests(void)
+namespace simgrid {
+namespace mc {
+
+void wait_for_requests(void)
 {
-  assert(mc_mode != MC_MODE_SERVER);
+#if HAVE_MC
+  xbt_assert(mc_model_checker == nullptr);
+#endif
 
   smx_process_t process;
   smx_simcall_t req;
@@ -55,34 +67,50 @@ void MC_wait_for_requests(void)
     SIMIX_process_runall();
     xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
       req = &process->simcall;
-      if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
+      if (req->call != SIMCALL_NONE && !simgrid::mc::request_is_visible(req))
         SIMIX_simcall_handle(req, 0);
     }
   }
 }
 
+/** @brief returns if there this transition can proceed in a finite amount of time
+ *
+ * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
+ *
+ * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
+ * Wait operations are OK and return true in only two situations:
+ *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
+ *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this transition for ever.
+ *
+ */
 // Called from both MCer and MCed:
-int MC_request_is_enabled(smx_simcall_t req)
+bool request_is_enabled(smx_simcall_t req)
 {
   unsigned int index = 0;
-  smx_synchro_t act = 0;
-#ifdef HAVE_MC
-  s_smx_synchro_t temp_synchro;
-#endif
+  // TODO, add support for the subtypes?
 
   switch (req->call) {
   case SIMCALL_NONE:
-    return FALSE;
+    return false;
+
+  case SIMCALL_SEM_ACQUIRE:
+    xbt_die("Don't use semaphores in model-checked code, it's not supported yet");
+  case SIMCALL_COND_WAIT:
+    xbt_die("Don't use condition variables in model-checked code, it's not supported yet");
 
   case SIMCALL_COMM_WAIT:
+  {
     /* FIXME: check also that src and dst processes are not suspended */
-    act = simcall_comm_wait__get__comm(req);
+    simgrid::kernel::activity::Comm *act =
+        static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(req));
 
-#ifdef HAVE_MC
+#if HAVE_MC
     // Fetch from MCed memory:
-    if (mc_mode == MC_MODE_SERVER) {
-      mc_model_checker->process().read(&temp_synchro, remote(act));
-      act = &temp_synchro;
+    // HACK, type puning
+    simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
+    if (mc_model_checker != nullptr) {
+      mc_model_checker->process().read(temp_comm, remote(act));
+      act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
     }
 #endif
 
@@ -90,21 +118,24 @@ int MC_request_is_enabled(smx_simcall_t req)
       /* If it has a timeout it will be always be enabled, because even if the
        * communication is not ready, it can timeout and won't block. */
       if (_sg_mc_timeout == 1)
-        return TRUE;
+        return true;
     }
     /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
-    else if (act->comm.detached && act->comm.src_proc == nullptr
-          && act->comm.type == SIMIX_COMM_READY)
-        return (act->comm.dst_proc != nullptr);
-    return (act->comm.src_proc && act->comm.dst_proc);
+    else if (act->detached && act->src_proc == nullptr
+          && act->type == SIMIX_COMM_READY)
+        return (act->dst_proc != nullptr);
+    return (act->src_proc && act->dst_proc);
+  }
 
   case SIMCALL_COMM_WAITANY: {
     xbt_dynar_t comms;
-#ifdef HAVE_MC
+    simgrid::kernel::activity::Comm *act =
+        static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(req));
+#if HAVE_MC
 
     s_xbt_dynar_t comms_buffer;
     size_t buffer_size = 0;
-    if (mc_mode == MC_MODE_SERVER) {
+    if (mc_model_checker != nullptr) {
       // Read dynar:
       mc_model_checker->process().read(
         &comms_buffer, remote(simcall_comm_waitany__get__comms(req)));
@@ -116,7 +147,7 @@ int MC_request_is_enabled(smx_simcall_t req)
 
     // Read all the dynar buffer:
     char buffer[buffer_size];
-    if (mc_mode == MC_MODE_SERVER)
+    if (mc_model_checker != nullptr)
       mc_model_checker->process().read_bytes(buffer, sizeof(buffer),
         remote(comms->data));
 #else
@@ -124,53 +155,55 @@ int MC_request_is_enabled(smx_simcall_t req)
 #endif
 
     for (index = 0; index < comms->used; ++index) {
-#ifdef HAVE_MC
+#if HAVE_MC
       // Fetch act from MCed memory:
-      if (mc_mode == MC_MODE_SERVER) {
+      // HACK, type puning
+      simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
+      if (mc_model_checker != nullptr) {
         memcpy(&act, buffer + comms->elmsize * index, sizeof(act));
-        mc_model_checker->process().read(&temp_synchro, remote(act));
-        act = &temp_synchro;
+        mc_model_checker->process().read(temp_comm, remote(act));
+        act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
       }
       else
 #endif
-        act = xbt_dynar_get_as(comms, index, smx_synchro_t);
-      if (act->comm.src_proc && act->comm.dst_proc)
-        return TRUE;
+        act = xbt_dynar_get_as(comms, index, simgrid::kernel::activity::Comm*);
+      if (act->src_proc && act->dst_proc)
+        return true;
     }
-    return FALSE;
+    return false;
   }
 
-  case SIMCALL_MUTEX_TRYLOCK:
-    return TRUE;
-
   case SIMCALL_MUTEX_LOCK: {
     smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
-#ifdef HAVE_MC
-    s_smx_mutex_t temp_mutex;
-    if (mc_mode == MC_MODE_SERVER) {
-      mc_model_checker->process().read(&temp_mutex, remote(mutex));
-      mutex = &temp_mutex;
+#if HAVE_MC
+    simgrid::mc::Remote<simgrid::simix::Mutex> temp_mutex;
+    if (mc_model_checker != nullptr) {
+      mc_model_checker->process().read(temp_mutex.getBuffer(), remote(mutex));
+      mutex = temp_mutex.getBuffer();
     }
 #endif
+
     if(mutex->owner == nullptr)
-      return TRUE;
-    else
-#ifdef HAVE_MC
+      return true;
+#if HAVE_MC
+    else if (mc_model_checker != nullptr) {
+      simgrid::mc::Process& modelchecked = mc_model_checker->process();
       // TODO, *(mutex->owner) :/
-      return MC_smx_resolve_process(mutex->owner)->pid ==
-        MC_smx_resolve_process(req->issuer)->pid;
-#else
-      return mutex->owner->pid == req->issuer->pid;
+      return modelchecked.resolveProcess(simgrid::mc::remote(mutex->owner))->pid
+        == modelchecked.resolveProcess(simgrid::mc::remote(req->issuer))->pid;
+    }
 #endif
+    else
+      return mutex->owner->pid == req->issuer->pid;
     }
 
   default:
     /* The rest of the requests are always enabled */
-    return TRUE;
+    return true;
   }
 }
 
-int MC_request_is_visible(smx_simcall_t req)
+bool request_is_visible(smx_simcall_t req)
 {
   return req->call == SIMCALL_COMM_ISEND
       || req->call == SIMCALL_COMM_IRECV
@@ -181,13 +214,12 @@ int MC_request_is_visible(smx_simcall_t req)
       || req->call == SIMCALL_MC_RANDOM
       || req->call == SIMCALL_MUTEX_LOCK
       || req->call == SIMCALL_MUTEX_TRYLOCK
-#ifdef HAVE_MC
-      || req->call == SIMCALL_MC_SNAPSHOT
-      || req->call == SIMCALL_MC_COMPARE_SNAPSHOTS
-#endif
       ;
 }
 
+}
+}
+
 static int prng_random(int min, int max)
 {
   unsigned long output_size = ((unsigned long) max - (unsigned long) min) + 1;
@@ -213,26 +245,3 @@ int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
     return prng_random(min, max);
   return simcall->mc_value;
 }
-
-void MC_simcall_handle(smx_simcall_t req, int value)
-{
-#ifndef HAVE_MC
-  SIMIX_simcall_handle(req, value);
-#else
-  if (mc_mode == MC_MODE_CLIENT) {
-    SIMIX_simcall_handle(req, value);
-    return;
-  }
-
-  for (auto& pi : mc_model_checker->process().smx_process_infos)
-    if (req == &pi.copy.simcall) {
-      mc_model_checker->simcall_handle(
-        mc_model_checker->process(), pi.copy.pid, value);
-      return;
-    }
-
-  xbt_die("Could not find the request");
-#endif
-}
-
-}