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