Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move the selection of the next transition to execute to mc::State
[simgrid.git] / src / mc / mc_base.cpp
index 4c3667c..32139fc 100644 (file)
-/* Copyright (c) 2008-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2008-2022. 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 <simgrid_config.h>
-
-#include <xbt/log.h>
-#include <xbt/asserts.h>
-#include <xbt/dynar.h>
-
-#include <simgrid/simix.h>
-
-#include "src/mc/mc_base.h"
-#include "src/simix/smx_private.h"
-#include "src/mc/mc_replay.h"
+#include "src/mc/mc_base.hpp"
 #include "mc/mc.h"
-#include "src/mc/mc_protocol.h"
+#include "src/kernel/EngineImpl.hpp"
+#include "src/kernel/activity/CommImpl.hpp"
+#include "src/kernel/activity/MutexImpl.hpp"
+#include "src/kernel/actor/SimcallObserver.hpp"
+#include "src/mc/mc_config.hpp"
+#include "src/mc/mc_replay.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"
+#include "xbt/random.hpp"
 
-#if HAVE_MC
-#include "src/mc/mc_request.h"
-#include "src/mc/Process.hpp"
+#if SIMGRID_HAVE_MC
 #include "src/mc/ModelChecker.hpp"
-#include "src/mc/mc_smx.h"
-#endif
+#include "src/mc/Session.hpp"
+#include "src/mc/remote/RemoteProcess.hpp"
 
-#if HAVE_MC
 using simgrid::mc::remote;
 #endif
 
-XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
+XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
 
 int MC_random(int min, int max)
 {
-#if HAVE_MC
+#if SIMGRID_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 :) */
 #endif
-  return simcall_mc_random(min, max);
+  if (not MC_is_active() && not MC_record_replay_is_active()) { // no need to do a simcall in this case
+    static simgrid::xbt::random::XbtRandom prng;
+    return prng.uniform_int(min, max);
+  }
+  simgrid::kernel::actor::RandomSimcall observer{simgrid::kernel::actor::ActorImpl::self(), min, max};
+  return simgrid::kernel::actor::simcall([&observer] { return observer.get_value(); }, &observer);
 }
 
 namespace simgrid {
 namespace mc {
 
-void wait_for_requests(void)
+void execute_actors()
 {
-#if HAVE_MC
-  xbt_assert(mc_model_checker == nullptr);
+  auto* engine = kernel::EngineImpl::get_instance();
+#if SIMGRID_HAVE_MC
+  xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
 #endif
-
-  smx_process_t process;
-  smx_simcall_t req;
-  unsigned int iter;
-
-  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 && !simgrid::mc::request_is_visible(req))
-        SIMIX_simcall_handle(req, 0);
+  while (engine->has_actors_to_run()) {
+    engine->run_all_actors();
+    for (auto const& actor : engine->get_actors_that_ran()) {
+      const s_smx_simcall* req = &actor->simcall_;
+      if (req->call_ != simix::Simcall::NONE && not simgrid::mc::request_is_visible(req))
+        actor->simcall_handle(0);
     }
   }
+#if SIMGRID_HAVE_MC
+  engine->reset_actor_dynar();
+  for (auto const& kv : engine->get_actor_list()) {
+    auto actor = kv.second;
+    if (actor->simcall_.observer_ != nullptr)
+      actor->simcall_.mc_max_consider_ = actor->simcall_.observer_->get_max_consider();
+    engine->add_actor_to_dynar(actor);
+  }
+#endif
 }
 
+/** @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.
+ * This is controlled in the is_enabled() method of the corresponding observers.
+ */
 // Called from both MCer and MCed:
-bool request_is_enabled(smx_simcall_t req)
+bool actor_is_enabled(smx_actor_t actor)
 {
-  unsigned int index = 0;
-  // 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::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::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
-
-    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;
-    }
-    /* 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);
+// #del
+#if SIMGRID_HAVE_MC
+  // If in the MCer, ask the client app since it has all the data
+  if (mc_model_checker != nullptr) {
+    return simgrid::mc::session_singleton->actor_is_enabled(actor->get_pid());
   }
-
-  case SIMCALL_COMM_WAITANY: {
-    xbt_dynar_t comms;
-    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_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 (index = 0; index < comms->used; ++index) {
-#if HAVE_MC
-      // Fetch act from MCed memory:
-      // 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_comm, remote(act));
-        act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
-      }
-      else
 #endif
-        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
-    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
+  // Now, we are in the client app, no need for remote memory reading.
+  smx_simcall_t req = &actor->simcall_;
 
-    if(mutex->owner == nullptr)
-      return true;
-#if HAVE_MC
-    else if (mc_model_checker != nullptr) {
-      simgrid::mc::Process& modelchecked = mc_model_checker->process();
-      // TODO, *(mutex->owner) :/
-      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;
-    }
+  if (req->observer_ != nullptr)
+    return req->observer_->is_enabled();
 
-  default:
+  if (req->call_ == simix::Simcall::NONE)
+    return false;
+  else
     /* The rest of the requests are always enabled */
     return true;
-  }
 }
 
-bool 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(const s_smx_simcall* 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
-      || req->call == SIMCALL_MUTEX_TRYLOCK
-      ;
-}
-
-}
-}
-
-static int prng_random(int min, int max)
-{
-  unsigned long output_size = ((unsigned long) max - (unsigned long) min) + 1;
-  unsigned long input_size = (unsigned long) RAND_MAX + 1;
-  unsigned long reject_size = input_size % output_size;
-  unsigned long accept_size = input_size - reject_size; // module*accept_size
-
-  // Use rejection in order to avoid skew
-  unsigned long x;
-  do {
-#ifndef _WIN32
-    x = (unsigned long) random();
-#else
-    x = (unsigned long) rand();
+#if SIMGRID_HAVE_MC
+  xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
 #endif
-  } while( x >= accept_size );
-  return min + (x % output_size);
+  if (req->observer_ != nullptr)
+    return req->observer_->is_visible();
+  else
+    return false;
 }
 
-int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
-{
-  if (!MC_is_active() && !MC_record_path)
-    return prng_random(min, max);
-  return simcall->mc_value;
-}
+} // namespace mc
+} // namespace simgrid