src/mc/mc_base.cpp

   1 /* Copyright (c) 2008-2018. 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 <simgrid_config.h>
   7
   8 #include "mc/mc.h"
   9 #include "src/mc/mc_base.h"
  10 #include "src/mc/mc_config.hpp"
  11 #include "src/mc/mc_replay.hpp"
  12 #include "src/simix/smx_private.hpp"
  13
  14 #include "src/kernel/activity/MutexImpl.hpp"
  15
  16 #if SIMGRID_HAVE_MC
  17 #include "src/mc/ModelChecker.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->process_to_run.empty()) {
  42     SIMIX_process_runall();
  43     for (smx_actor_t const& process : simix_global->process_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->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_proc == nullptr && act->type == SIMIX_COMM_READY)
  98         return (act->dst_proc != nullptr);
  99       return (act->src_proc && act->dst_proc);
 100     }
 101
 102     case SIMCALL_COMM_WAITANY: {
 103       xbt_dynar_t comms = simcall_comm_waitany__get__comms(req);
 104       for (unsigned int index = 0; index < comms->used; ++index) {
 105         simgrid::kernel::activity::CommImpl* act = xbt_dynar_get_as(comms, index, simgrid::kernel::activity::CommImpl*);
 106         if (act->src_proc && act->dst_proc)
 107           return true;
 108       }
 109       return false;
 110     }
 111
 112     case SIMCALL_MUTEX_LOCK: {
 113       smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
 114
 115       if (mutex->owner == nullptr)
 116         return true;
 117       return mutex->owner->pid == req->issuer->pid;
 118     }
 119
 120     case SIMCALL_SEM_ACQUIRE: {
 121       static int warned = 0;
 122       if (not warned)
 123         XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
 124       warned = 1;
 125       return true;
 126     }
 127
 128     case SIMCALL_COND_WAIT: {
 129       static int warned = 0;
 130       if (not warned)
 131         XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
 132       warned = 1;
 133       return true;
 134     }
 135
 136     default:
 137       /* The rest of the requests are always enabled */
 138       return true;
 139   }
 140 }
 141
 142 /* This is the list of requests that are visible from the checker algorithm.
 143  * Any other requests are handled right away on the application side.
 144  */
 145 bool request_is_visible(smx_simcall_t req)
 146 {
 147 #if SIMGRID_HAVE_MC
 148   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
 149 #endif
 150
 151   return req->call == SIMCALL_COMM_ISEND || req->call == SIMCALL_COMM_IRECV || req->call == SIMCALL_COMM_WAIT ||
 152          req->call == SIMCALL_COMM_WAITANY || req->call == SIMCALL_COMM_TEST || req->call == SIMCALL_COMM_TESTANY ||
 153          req->call == SIMCALL_MC_RANDOM || req->call == SIMCALL_MUTEX_LOCK || req->call == SIMCALL_MUTEX_TRYLOCK ||
 154          req->call == SIMCALL_MUTEX_UNLOCK;
 155 }
 156
 157 }
 158 }
 159
 160 static int prng_random(int min, int max)
 161 {
 162   unsigned long output_size = ((unsigned long) max - (unsigned long) min) + 1;
 163   unsigned long input_size = (unsigned long) RAND_MAX + 1;
 164   unsigned long reject_size = input_size % output_size;
 165   unsigned long accept_size = input_size - reject_size; // module*accept_size
 166
 167   // Use rejection in order to avoid skew
 168   unsigned long x;
 169   do {
 170 #ifndef _WIN32
 171     x = (unsigned long) random();
 172 #else
 173     x = (unsigned long) rand();
 174 #endif
 175   } while( x >= accept_size );
 176   return min + (x % output_size);
 177 }
 178
 179 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
 180 {
 181   if (not MC_is_active() && MC_record_path.empty())
 182     return prng_random(min, max);
 183   return simcall->mc_value;
 184 }