src/mc/mc_base.cpp

   1 /* Copyright (c) 2008-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/mc/mc_base.h"
   7 #include "mc/mc.h"
   8 #include "src/kernel/activity/CommImpl.hpp"
   9 #include "src/kernel/activity/MutexImpl.hpp"
  10 #include "src/mc/mc_replay.hpp"
  11 #include "src/simix/smx_private.hpp"
  12
  13 #include <random>
  14
  15 #if SIMGRID_HAVE_MC
  16 #include "src/mc/ModelChecker.hpp"
  17 #include "src/mc/remote/RemoteClient.hpp"
  18
  19 using simgrid::mc::remote;
  20 #endif
  21
  22 XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
  23
  24 int MC_random(int min, int max)
  25 {
  26 #if SIMGRID_HAVE_MC
  27   xbt_assert(mc_model_checker == nullptr);
  28 #endif
  29   /* TODO, if the MC is disabled we do not really need to make a simcall for this :) */
  30   return simcall_mc_random(min, max);
  31 }
  32
  33 namespace simgrid {
  34 namespace mc {
  35
  36 void wait_for_requests()
  37 {
  38 #if SIMGRID_HAVE_MC
  39   xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
  40 #endif
  41   while (not simix_global->actors_to_run.empty()) {
  42     simix_global->run_all_actors();
  43     for (smx_actor_t const& process : simix_global->actors_that_ran) {
  44       smx_simcall_t req = &process->simcall;
  45       if (req->call != SIMCALL_NONE && not simgrid::mc::request_is_visible(req))
  46         SIMIX_simcall_handle(req, 0);
  47     }
  48   }
  49 #if SIMGRID_HAVE_MC
  50   xbt_dynar_reset(simix_global->actors_vector);
  51   for (std::pair<aid_t, smx_actor_t> const& kv : simix_global->process_list) {
  52     xbt_dynar_push_as(simix_global->actors_vector, smx_actor_t, kv.second);
  53   }
  54 #endif
  55 }
  56
  57 /** @brief returns if there this transition can proceed in a finite amount of time
  58  *
  59  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
  60  *
  61  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
  62  * Wait operations are OK and return true in only two situations:
  63  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
  64  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this
  65  * transition for ever.
  66  *
  67  */
  68 // Called from both MCer and MCed:
  69 bool actor_is_enabled(smx_actor_t actor)
  70 {
  71 #if SIMGRID_HAVE_MC
  72   // If in the MCer, ask the client app since it has all the data
  73   if (mc_model_checker != nullptr) {
  74     return mc_model_checker->process().actor_is_enabled(actor->get_pid());
  75   }
  76 #endif
  77
  78   // Now, we are in the client app, no need for remote memory reading.
  79   smx_simcall_t req = &actor->simcall;
  80
  81   switch (req->call) {
  82     case SIMCALL_NONE:
  83       return false;
  84
  85     case SIMCALL_COMM_WAIT: {
  86       /* FIXME: check also that src and dst processes are not suspended */
  87       simgrid::kernel::activity::CommImpl* act =
  88           static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
  89
  90       if (act->src_timeout_ || act->dst_timeout_) {
  91         /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
  92          * because even if the communication is not ready, it can timeout and won't block. */
  93         if (_sg_mc_timeout == 1)
  94           return true;
  95       }
  96       /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
  97       else if (act->detached() && act->src_actor_ == nullptr &&
  98                act->type_ == simgrid::kernel::activity::CommImpl::Type::READY)
  99         return (act->dst_actor_ != nullptr);
 100       return (act->src_actor_ && act->dst_actor_);
 101     }
 102
 103     case SIMCALL_COMM_WAITANY: {
 104       simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(req);
 105       size_t count                                = simcall_comm_waitany__get__count(req);
 106       for (unsigned int index = 0; index < count; ++index) {
 107         auto* comm = comms[index];
 108         if (comm->src_actor_ && comm->dst_actor_)
 109           return true;
 110       }
 111       return false;
 112     }
 113
 114     case SIMCALL_MUTEX_LOCK: {
 115       smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
 116
 117       if (mutex->owner_ == nullptr)
 118         return true;
 119       return mutex->owner_->get_pid() == req->issuer->get_pid();
 120     }
 121
 122     case SIMCALL_SEM_ACQUIRE: {
 123       static int warned = 0;
 124       if (not warned)
 125         XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
 126       warned = 1;
 127       return true;
 128     }
 129
 130     case SIMCALL_COND_WAIT: {
 131       static int warned = 0;
 132       if (not warned)
 133         XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
 134       warned = 1;
 135       return true;
 136     }
 137
 138     default:
 139       /* The rest of the requests are always enabled */
 140       return true;
 141   }
 142 }
 143
 144 /* This is the list of requests that are visible from the checker algorithm.
 145  * Any other requests are handled right away on the application side.
 146  */
 147 bool request_is_visible(smx_simcall_t req)
 148 {
 149 #if SIMGRID_HAVE_MC
 150   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
 151 #endif
 152
 153   return req->call == SIMCALL_COMM_ISEND || req->call == SIMCALL_COMM_IRECV || req->call == SIMCALL_COMM_WAIT ||
 154          req->call == SIMCALL_COMM_WAITANY || req->call == SIMCALL_COMM_TEST || req->call == SIMCALL_COMM_TESTANY ||
 155          req->call == SIMCALL_MC_RANDOM || req->call == SIMCALL_MUTEX_LOCK || req->call == SIMCALL_MUTEX_TRYLOCK ||
 156          req->call == SIMCALL_MUTEX_UNLOCK;
 157 }
 158
 159 }
 160 }
 161
 162 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
 163 {
 164   if (not MC_is_active() && MC_record_path.empty()) {
 165     static std::default_random_engine rnd_engine;
 166     std::uniform_int_distribution<int> prng(min, max);
 167     return prng(rnd_engine);
 168   }
 169   return simcall->mc_value;
 170 }