MC request_enabled: add documentation and an explosive support for semaphores and...

[simgrid.git] / src / mc / mc_base.cpp

diff --git a/src/mc/mc_base.cpp b/src/mc/mc_base.cpp
index 7c350f7..b82c3f2 100644 (file)
--- a/src/mc/mc_base.cpp
+++ b/src/mc/mc_base.cpp
@@ -20,12 +20,12 @@
 #include "mc/mc.h"
 #include "src/mc/mc_protocol.h"
 
-#include "src/simix/Synchro.h"
-#include "src/simix/SynchroIo.hpp"
-#include "src/simix/SynchroComm.hpp"
-#include "src/simix/SynchroRaw.hpp"
-#include "src/simix/SynchroSleep.hpp"
-#include "src/simix/SynchroExec.hpp"
+#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"
@@ -73,6 +73,16 @@ void wait_for_requests(void)
   }
 }
 
+/** @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:
 bool request_is_enabled(smx_simcall_t req)
 {
@@ -83,18 +93,24 @@ bool request_is_enabled(smx_simcall_t req)
   case SIMCALL_NONE:
     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 */
-    simgrid::simix::Comm *act = static_cast<simgrid::simix::Comm*>(simcall_comm_wait__get__comm(req));
+    simgrid::kernel::activity::Comm *act =
+        static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(req));
 
 #if HAVE_MC
     // Fetch from MCed memory:
     // HACK, type puning
-    simgrid::mc::Remote<simgrid::simix::Comm> temp_comm;
+    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::simix::Comm*>(temp_comm.getBuffer());
+      act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
     }
 #endif
 
@@ -113,7 +129,8 @@ bool request_is_enabled(smx_simcall_t req)
 
   case SIMCALL_COMM_WAITANY: {
     xbt_dynar_t comms;
-    simgrid::simix::Comm *act = static_cast<simgrid::simix::Comm*>(simcall_comm_wait__get__comm(req));
+    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;
@@ -141,24 +158,21 @@ bool request_is_enabled(smx_simcall_t req)
 #if HAVE_MC
       // Fetch act from MCed memory:
       // HACK, type puning
-      simgrid::mc::Remote<simgrid::simix::Comm> temp_comm;
+      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_comm, remote(act));
-        act = static_cast<simgrid::simix::Comm*>(temp_comm.getBuffer());
+        act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
       }
       else
 #endif
-        act = xbt_dynar_get_as(comms, index, simgrid::simix::Comm*);
+        act = xbt_dynar_get_as(comms, index, simgrid::kernel::activity::Comm*);
       if (act->src_proc && act->dst_proc)
         return true;
     }
     return false;
   }
 
-  case SIMCALL_MUTEX_TRYLOCK:
-    return true;
-
   case SIMCALL_MUTEX_LOCK: {
     smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
 #if HAVE_MC