Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
The creation of the pimpl needs no simcall
[simgrid.git] / src / mc / mc_base.cpp
index 9144932..83a39e4 100644 (file)
-/* Copyright (c) 2008-2014. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2008-2019. 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 <assert.h>
-
-#include <simgrid/simix.h>
-
-#include "mc_base.h"
-#include "../simix/smx_private.h"
-#include "mc/mc_record.h"
-#include "mc/mc_replay.h"
+#include "src/mc/mc_base.h"
 #include "mc/mc.h"
-
-#ifdef HAVE_MC
-#include "mc_process.h"
-#include "ModelChecker.hpp"
-#include "mc_protocol.h"
-#include "mc_smx.h"
-#include "mc_server.h"
+#include "simgrid/config.h"
+#include "src/kernel/activity/CommImpl.hpp"
+#include "src/kernel/activity/MutexImpl.hpp"
+#include "src/mc/mc_config.hpp"
+#include "src/mc/mc_forward.hpp"
+#include "src/mc/mc_replay.hpp"
+#include "src/simix/smx_private.hpp"
+
+#if SIMGRID_HAVE_MC
+#include "src/mc/ModelChecker.hpp"
+#include "src/mc/remote/RemoteClient.hpp"
+
+using simgrid::mc::remote;
 #endif
 
-extern "C" {
-
-XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
+XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
 
-void MC_wait_for_requests(void)
+int MC_random(int min, int max)
 {
-#ifdef HAVE_MC
-  if (mc_mode == MC_MODE_SERVER) {
-    MC_server_wait_client(&mc_model_checker->process());
-    return;
-  }
+#if SIMGRID_HAVE_MC
+  xbt_assert(mc_model_checker == nullptr);
 #endif
+  /* TODO, if the MC is disabled we do not really need to make a simcall for this :) */
+  return simcall_mc_random(min, max);
+}
 
-  smx_process_t process;
-  smx_simcall_t req;
-  unsigned int iter;
+namespace simgrid {
+namespace mc {
 
-  while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
-    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))
+void wait_for_requests()
+{
+#if SIMGRID_HAVE_MC
+  xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
+#endif
+  while (not simix_global->actors_to_run.empty()) {
+    simix_global->run_all_actors();
+    for (smx_actor_t const& process : simix_global->actors_that_ran) {
+      smx_simcall_t req = &process->simcall;
+      if (req->call != SIMCALL_NONE && not simgrid::mc::request_is_visible(req))
         SIMIX_simcall_handle(req, 0);
     }
   }
+#if SIMGRID_HAVE_MC
+  xbt_dynar_reset(simix_global->actors_vector);
+  for (std::pair<aid_t, smx_actor_t> const& kv : simix_global->process_list) {
+    xbt_dynar_push_as(simix_global->actors_vector, smx_actor_t, kv.second);
+  }
+#endif
 }
 
-int MC_request_is_enabled(smx_simcall_t req)
+/** @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)
 {
-  unsigned int index = 0;
-  smx_synchro_t act = 0;
-#ifdef HAVE_MC
-  s_smx_synchro_t temp_synchro;
+#if SIMGRID_HAVE_MC
+  // If in the MCer, ask the client app since it has all the data
+  if (mc_model_checker != nullptr) {
+    return mc_model_checker->process().actor_is_enabled(actor->get_pid());
+  }
 #endif
 
-  switch (req->call) {
-  case SIMCALL_NONE:
-    return FALSE;
-
-  case SIMCALL_COMM_WAIT:
-    /* FIXME: check also that src and dst processes are not suspended */
-    act = simcall_comm_wait__get__comm(req);
-
-#ifdef HAVE_MC
-    // Fetch from MCed memory:
-    if (!MC_process_is_self(&mc_model_checker->process())) {
-      MC_process_read(&mc_model_checker->process(), MC_ADDRESS_SPACE_READ_FLAGS_NONE,
-        &temp_synchro, act, sizeof(temp_synchro),
-        MC_PROCESS_INDEX_ANY);
-      act = &temp_synchro;
-    }
-#endif
+  // Now, we are in the client app, no need for remote memory reading.
+  smx_simcall_t req = &actor->simcall;
 
-    if (simcall_comm_wait__get__timeout(req) >= 0) {
-      /* 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;
-    } else {
+  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 (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.*/
-      if (act->comm.detached && act->comm.src_proc == NULL
-          && act->comm.type == SIMIX_COMM_READY)
-        return (act->comm.dst_proc != NULL);
+      else if (act->detached && act->src_actor_ == nullptr &&
+               act->type == simgrid::kernel::activity::CommImpl::Type::READY)
+        return (act->dst_actor_ != nullptr);
+      return (act->src_actor_ && act->dst_actor_);
     }
-    return (act->comm.src_proc && act->comm.dst_proc);
-
-  case SIMCALL_COMM_WAITANY: {
-#ifdef HAVE_MC
-    // Read dynar:
-    s_xbt_dynar_t comms;
-    MC_process_read_simple(&mc_model_checker->process(),
-      &comms, simcall_comm_waitany__get__comms(req), sizeof(comms));
-    // Read dynar buffer:
-    assert(comms.elmsize == sizeof(act));
-    size_t buffer_size = comms.elmsize * comms.used;
-    char buffer[buffer_size];
-    MC_process_read_simple(&mc_model_checker->process(),
-      buffer, comms.data, sizeof(buffer));
-#endif
 
-#ifdef HAVE_MC
-    for (index = 0; index < comms.used; ++index) {
-      memcpy(&act, buffer + comms.elmsize * index, sizeof(act));
-#else
-    xbt_dynar_foreach(simcall_comm_waitany__get__comms(req), index, act) {
-#endif
-
-#ifdef HAVE_MC
-      // Fetch from MCed memory:
-      if (!MC_process_is_self(&mc_model_checker->process())) {
-        MC_process_read(&mc_model_checker->process(), MC_ADDRESS_SPACE_READ_FLAGS_NONE,
-          &temp_synchro, act, sizeof(temp_synchro),
-          MC_PROCESS_INDEX_ANY);
-        act = &temp_synchro;
+    case SIMCALL_COMM_WAITANY: {
+      simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(req);
+      size_t count                                = simcall_comm_waitany__get__count(req);
+      for (unsigned int index = 0; index < count; ++index) {
+        auto* comm = comms[index];
+        if (comm->src_actor_ && comm->dst_actor_)
+          return true;
       }
-#endif
+      return false;
+    }
+
+    case SIMCALL_MUTEX_LOCK: {
+      smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
 
-      if (act->comm.src_proc && act->comm.dst_proc)
-        return TRUE;
+      if (mutex->owner == nullptr)
+        return true;
+      return mutex->owner->get_pid() == req->issuer->get_pid();
     }
-    return FALSE;
-  }
 
-  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_process_is_self(&mc_model_checker->process())) {
-      MC_process_read(&mc_model_checker->process(), MC_ADDRESS_SPACE_READ_FLAGS_NONE,
-        &temp_mutex, mutex, sizeof(temp_mutex),
-        MC_PROCESS_INDEX_ANY);
-      mutex = &temp_mutex;
+    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;
     }
-#endif
-    if(mutex->owner == NULL)
-      return TRUE;
-    else
-#ifdef HAVE_MC
-      // 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;
-#endif
+
+    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;
+    default:
+      /* The rest of the requests are always enabled */
+      return true;
   }
 }
 
-int MC_request_is_visible(smx_simcall_t req)
+/* This is the list of requests that are visible from the checker algorithm.
+ * Any other requests are handled right away on the application side.
+ */
+bool request_is_visible(smx_simcall_t req)
 {
-  return req->call == SIMCALL_COMM_ISEND
-      || req->call == SIMCALL_COMM_IRECV
-      || req->call == SIMCALL_COMM_WAIT
-      || req->call == SIMCALL_COMM_WAITANY
-      || req->call == SIMCALL_COMM_TEST
-      || req->call == SIMCALL_COMM_TESTANY
-      || req->call == SIMCALL_MC_RANDOM
-      || req->call == SIMCALL_MUTEX_LOCK
-#ifdef HAVE_MC
-      || req->call == SIMCALL_MC_SNAPSHOT
-      || req->call == SIMCALL_MC_COMPARE_SNAPSHOTS
+#if SIMGRID_HAVE_MC
+  xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
 #endif
-      ;
+
+  return req->call == SIMCALL_COMM_ISEND || req->call == SIMCALL_COMM_IRECV || req->call == SIMCALL_COMM_WAIT ||
+         req->call == SIMCALL_COMM_WAITANY || req->call == SIMCALL_COMM_TEST || req->call == SIMCALL_COMM_TESTANY ||
+         req->call == SIMCALL_MC_RANDOM || req->call == SIMCALL_MUTEX_LOCK || req->call == SIMCALL_MUTEX_TRYLOCK ||
+         req->call == SIMCALL_MUTEX_UNLOCK;
 }
 
-int MC_random(int min, int max)
-{
-  /*FIXME: return mc_current_state->executed_transition->random.value; */
-  return simcall_mc_random(min, max);
+}
 }
 
 static int prng_random(int min, int max)
@@ -187,7 +170,7 @@ static int prng_random(int min, int max)
   // Use rejection in order to avoid skew
   unsigned long x;
   do {
-#ifndef _XBT_WIN32
+#ifndef _WIN32
     x = (unsigned long) random();
 #else
     x = (unsigned long) rand();
@@ -198,35 +181,7 @@ static int prng_random(int min, int max)
 
 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
 {
-  if (!MC_is_active() && !MC_record_path){
+  if (not MC_is_active() && MC_record_path.empty())
     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_process_is_self(&mc_model_checker->process())) {
-    SIMIX_simcall_handle(req, value);
-    return;
-  }
-
-  unsigned i;
-  mc_smx_process_info_t pi = NULL;
-
-  xbt_dynar_foreach_ptr(mc_model_checker->process().smx_process_infos, i, pi) {
-    if (req == &pi->copy.simcall) {
-      MC_server_simcall_handle(&mc_model_checker->process(), pi->copy.pid, value);
-      return;
-    }
-  }
-
-  xbt_die("Could not find the request");
-#endif
-}
-
-}