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