Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
remove one layer of calls
[simgrid.git] / src / mc / mc_request.cpp
index 1d3b8c6..4c8b4f5 100644 (file)
@@ -1,20 +1,13 @@
-/* Copyright (c) 2008-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2008-2017. 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. */
 
 #include <cassert>
 
-#include <xbt/log.h>
-#include <xbt/str.h>
-#include <xbt/sysdep.h>
-#include <xbt/dynar.h>
-#include <xbt/swag.h>
-
+#include "src/include/mc/mc.h"
+#include "src/mc/ModelChecker.hpp"
 #include "src/mc/mc_request.h"
-#include "src/mc/mc_safety.h"
-#include "src/mc/mc_private.h"
 #include "src/mc/mc_smx.h"
 #include "src/mc/mc_xbt.hpp"
 
@@ -26,14 +19,13 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_request, mc,
 static char *pointer_to_string(void *pointer);
 static char *buff_size_to_string(size_t size);
 
-static inline
-simgrid::kernel::activity::Comm* MC_get_comm(smx_simcall_t r)
+static inline simgrid::kernel::activity::CommImpl* MC_get_comm(smx_simcall_t r)
 {
   switch (r->call ) {
   case SIMCALL_COMM_WAIT:
-    return static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(r));
+    return static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(r));
   case SIMCALL_COMM_TEST:
-    return static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_test__get__comm(r));
+    return static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_test__getraw__comm(r));
   default:
     return nullptr;
   }
@@ -67,8 +59,8 @@ bool request_depend_asymmetric(smx_simcall_t r1, smx_simcall_t r2)
 
   // Those are internal requests, we do not need indirection
   // because those objects are copies:
-  simgrid::kernel::activity::Comm* synchro1 = MC_get_comm(r1);
-  simgrid::kernel::activity::Comm* synchro2 = MC_get_comm(r2);
+  simgrid::kernel::activity::CommImpl* synchro1 = MC_get_comm(r1);
+  simgrid::kernel::activity::CommImpl* synchro2 = MC_get_comm(r2);
 
   if ((r1->call == SIMCALL_COMM_ISEND || r1->call == SIMCALL_COMM_IRECV)
       && r2->call == SIMCALL_COMM_WAIT) {
@@ -154,8 +146,8 @@ bool request_depend(smx_simcall_t r1, smx_simcall_t r2)
 
   // Those are internal requests, we do not need indirection
   // because those objects are copies:
-  simgrid::kernel::activity::Comm* synchro1 = MC_get_comm(r1);
-  simgrid::kernel::activity::Comm* synchro2 = MC_get_comm(r2);
+  simgrid::kernel::activity::CommImpl* synchro1 = MC_get_comm(r1);
+  simgrid::kernel::activity::CommImpl* synchro2 = MC_get_comm(r2);
 
   switch(r1->call) {
   case SIMCALL_COMM_ISEND:
@@ -264,8 +256,8 @@ std::string simgrid::mc::request_to_string(smx_simcall_t req, int value, simgrid
   }
 
   case SIMCALL_COMM_WAIT: {
-    simgrid::kernel::activity::Comm* remote_act =
-      static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(req));
+    simgrid::kernel::activity::CommImpl* remote_act =
+        static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
     char* p;
     if (value == -1) {
       type = "WaitTimeout";
@@ -275,11 +267,11 @@ std::string simgrid::mc::request_to_string(smx_simcall_t req, int value, simgrid
       type = "Wait";
       p = pointer_to_string(remote_act);
 
-      simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_synchro;
-      simgrid::kernel::activity::Comm* act;
+      simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_synchro;
+      simgrid::kernel::activity::CommImpl* act;
       if (use_remote_comm) {
-        mc_model_checker->process().read(temp_synchro, remote(
-          static_cast<simgrid::kernel::activity::Comm*>(remote_act)));
+        mc_model_checker->process().read(temp_synchro,
+                                         remote(static_cast<simgrid::kernel::activity::CommImpl*>(remote_act)));
         act = temp_synchro.getBuffer();
       } else
         act = remote_act;
@@ -297,13 +289,13 @@ std::string simgrid::mc::request_to_string(smx_simcall_t req, int value, simgrid
   }
 
   case SIMCALL_COMM_TEST: {
-    simgrid::kernel::activity::Comm* remote_act = static_cast<simgrid::kernel::activity::Comm*>(
-      simcall_comm_test__get__comm(req));
-    simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_synchro;
-    simgrid::kernel::activity::Comm* act;
+    simgrid::kernel::activity::CommImpl* remote_act =
+        static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_test__getraw__comm(req));
+    simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_synchro;
+    simgrid::kernel::activity::CommImpl* act;
     if (use_remote_comm) {
-      mc_model_checker->process().read(temp_synchro, remote(
-        static_cast<simgrid::kernel::activity::Comm*>(remote_act)));
+      mc_model_checker->process().read(temp_synchro,
+                                       remote(static_cast<simgrid::kernel::activity::CommImpl*>(remote_act)));
       act = temp_synchro.getBuffer();
     } else
       act = remote_act;
@@ -332,12 +324,12 @@ std::string simgrid::mc::request_to_string(smx_simcall_t req, int value, simgrid
     s_xbt_dynar_t comms;
     mc_model_checker->process().read_bytes(
       &comms, sizeof(comms), remote(simcall_comm_waitany__get__comms(req)));
-    if (!xbt_dynar_is_empty(&comms)) {
+    if (not xbt_dynar_is_empty(&comms)) {
       smx_activity_t remote_sync;
       read_element(mc_model_checker->process(),
         &remote_sync, remote(simcall_comm_waitany__get__comms(req)), value,
         sizeof(remote_sync));
-      char* p = pointer_to_string(remote_sync);
+      char* p = pointer_to_string(&*remote_sync);
       args = bprintf("comm=%s (%d of %lu)",
         p, value + 1, xbt_dynar_length(&comms));
       xbt_free(p);
@@ -365,7 +357,7 @@ std::string simgrid::mc::request_to_string(smx_simcall_t req, int value, simgrid
     else
       type = "Mutex TRYLOCK";
 
-    simgrid::mc::Remote<simgrid::simix::Mutex> mutex;
+    simgrid::mc::Remote<simgrid::simix::MutexImpl> mutex;
     mc_model_checker->process().read_bytes(mutex.getBuffer(), sizeof(mutex),
       remote(
         req->call == SIMCALL_MUTEX_LOCK
@@ -412,41 +404,169 @@ namespace mc {
 
 bool request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx)
 {
-  smx_activity_t remote_act = nullptr;
+  simgrid::kernel::activity::ActivityImpl* remote_act = nullptr;
   switch (req->call) {
 
   case SIMCALL_COMM_WAIT:
     /* FIXME: check also that src and dst processes are not suspended */
-    remote_act = simcall_comm_wait__get__comm(req);
+    remote_act = simcall_comm_wait__getraw__comm(req);
     break;
 
   case SIMCALL_COMM_WAITANY: {
-    read_element(
-      mc_model_checker->process(), &remote_act,
-      remote(simcall_comm_waitany__get__comms(req)),
-      idx, sizeof(remote_act));
+    read_element(mc_model_checker->process(), &remote_act, remote(simcall_comm_waitany__getraw__comms(req)), idx,
+                 sizeof(remote_act));
     }
     break;
 
   case SIMCALL_COMM_TESTANY:
-    remote_act = mc_model_checker->process().read(remote(
-      simcall_comm_testany__get__comms(req) + idx));
+    remote_act = mc_model_checker->process().read(remote(simcall_comm_testany__getraw__comms(req) + idx));
     break;
 
   default:
     return true;
   }
 
-  simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
-  mc_model_checker->process().read(temp_comm, remote(
-    static_cast<simgrid::kernel::activity::Comm*>(remote_act)));
-  simgrid::kernel::activity::Comm* comm = temp_comm.getBuffer();
+  simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
+  mc_model_checker->process().read(temp_comm, remote(static_cast<simgrid::kernel::activity::CommImpl*>(remote_act)));
+  simgrid::kernel::activity::CommImpl* comm = temp_comm.getBuffer();
   return comm->src_proc && comm->dst_proc;
 }
 
+/** @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 actor_is_enabled(smx_actor_t actor)
 {
-  return simgrid::mc::request_is_enabled(&actor->simcall);
+  smx_simcall_t req = &actor->simcall;
+  // TODO, add support for the subtypes?
+
+  switch (req->call) {
+    case SIMCALL_NONE:
+      return false;
+
+    case SIMCALL_COMM_WAIT: {
+      /* FIXME: check also that src and dst processes are not suspended */
+      simgrid::kernel::activity::CommImpl* act =
+          static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
+
+#if SIMGRID_HAVE_MC
+      // Fetch from MCed memory:
+      // HACK, type puning
+      if (mc_model_checker != nullptr) {
+        simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
+        mc_model_checker->process().read(temp_comm, remote(act));
+        act = static_cast<simgrid::kernel::activity::CommImpl*>(temp_comm.getBuffer());
+      }
+#endif
+
+      if (act->src_timeout || act->dst_timeout) {
+        /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
+         * because even if the communication is not ready, it can timeout and won't block. */
+        if (_sg_mc_timeout == 1)
+          return true;
+      }
+      /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
+      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;
+      simgrid::kernel::activity::CommImpl* act =
+          static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
+
+#if SIMGRID_HAVE_MC
+      s_xbt_dynar_t comms_buffer;
+      size_t buffer_size = 0;
+      if (mc_model_checker != nullptr) {
+        // Read dynar:
+        mc_model_checker->process().read(&comms_buffer, remote(simcall_comm_waitany__get__comms(req)));
+        assert(comms_buffer.elmsize == sizeof(act));
+        buffer_size = comms_buffer.elmsize * comms_buffer.used;
+        comms       = &comms_buffer;
+      } else
+        comms = simcall_comm_waitany__get__comms(req);
+
+      // Read all the dynar buffer:
+      char buffer[buffer_size];
+      if (mc_model_checker != nullptr)
+        mc_model_checker->process().read_bytes(buffer, sizeof(buffer), remote(comms->data));
+#else
+      comms = simcall_comm_waitany__get__comms(req);
+#endif
+
+      for (unsigned int index = 0; index < comms->used; ++index) {
+#if SIMGRID_HAVE_MC
+        // Fetch act from MCed memory:
+        // HACK, type puning
+        simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> 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::kernel::activity::CommImpl*>(temp_comm.getBuffer());
+        } else
+#endif
+          act = xbt_dynar_get_as(comms, index, simgrid::kernel::activity::CommImpl*);
+        if (act->src_proc && act->dst_proc)
+          return true;
+      }
+      return false;
+    }
+
+    case SIMCALL_MUTEX_LOCK: {
+      smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
+#if SIMGRID_HAVE_MC
+      simgrid::mc::Remote<simgrid::simix::MutexImpl> 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;
+#if SIMGRID_HAVE_MC
+      else if (mc_model_checker != nullptr) {
+        simgrid::mc::RemoteClient& modelchecked = mc_model_checker->process();
+        // TODO, *(mutex->owner) :/
+        return modelchecked.resolveActor(simgrid::mc::remote(mutex->owner))->pid ==
+               modelchecked.resolveActor(simgrid::mc::remote(req->issuer))->pid;
+      }
+#endif
+      else
+        return mutex->owner->pid == req->issuer->pid;
+    }
+
+    case SIMCALL_SEM_ACQUIRE: {
+      static int warned = 0;
+      if (not warned)
+        XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
+      warned = 1;
+      return true;
+    }
+
+    case SIMCALL_COND_WAIT: {
+      static int warned = 0;
+      if (not warned)
+        XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
+      warned = 1;
+      return true;
+    }
+
+    default:
+      /* The rest of the requests are always enabled */
+      return true;
+  }
 }
 
 static const char* colors[] = {
@@ -498,11 +618,11 @@ std::string request_get_dot_output(smx_simcall_t req, int value)
       else
         label = simgrid::xbt::string_printf("[(%lu)] WaitTimeout", issuer->pid);
     } else {
-      smx_activity_t remote_act = simcall_comm_wait__get__comm(req);
-      simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
-      mc_model_checker->process().read(temp_comm, remote(
-        static_cast<simgrid::kernel::activity::Comm*>(remote_act)));
-      simgrid::kernel::activity::Comm* comm = temp_comm.getBuffer();
+      simgrid::kernel::activity::ActivityImpl* remote_act = simcall_comm_wait__getraw__comm(req);
+      simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
+      mc_model_checker->process().read(temp_comm,
+                                       remote(static_cast<simgrid::kernel::activity::CommImpl*>(remote_act)));
+      simgrid::kernel::activity::CommImpl* comm = temp_comm.getBuffer();
 
       smx_actor_t src_proc = mc_model_checker->process().resolveActor(simgrid::mc::remote(comm->src_proc));
       smx_actor_t dst_proc = mc_model_checker->process().resolveActor(simgrid::mc::remote(comm->dst_proc));
@@ -520,11 +640,10 @@ std::string request_get_dot_output(smx_simcall_t req, int value)
   }
 
   case SIMCALL_COMM_TEST: {
-    smx_activity_t remote_act = simcall_comm_test__get__comm(req);
-    simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
-    mc_model_checker->process().read(temp_comm, remote(
-      static_cast<simgrid::kernel::activity::Comm*>(remote_act)));
-    simgrid::kernel::activity::Comm* comm = temp_comm.getBuffer();
+    simgrid::kernel::activity::ActivityImpl* remote_act = simcall_comm_test__getraw__comm(req);
+    simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
+    mc_model_checker->process().read(temp_comm, remote(static_cast<simgrid::kernel::activity::CommImpl*>(remote_act)));
+    simgrid::kernel::activity::CommImpl* comm = temp_comm.getBuffer();
     if (comm->src_proc == nullptr || comm->dst_proc == nullptr) {
       if (issuer->host)
         label = simgrid::xbt::string_printf("[(%lu)%s] Test FALSE", issuer->pid, MC_smx_actor_get_host_name(issuer));