src/mc/mc_base.cpp

   1 /* Copyright (c) 2008-2017. 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.h"
  11 #include "src/simix/smx_private.h"
  12
  13 #if SIMGRID_HAVE_MC
  14 #include "src/mc/ModelChecker.hpp"
  15
  16 using simgrid::mc::remote;
  17 #endif
  18
  19 XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
  20
  21 int MC_random(int min, int max)
  22 {
  23 #if SIMGRID_HAVE_MC
  24   xbt_assert(mc_model_checker == nullptr);
  25 #endif
  26   /* TODO, if the MC is disabled we do not really need to make a simcall for this :) */
  27   return simcall_mc_random(min, max);
  28 }
  29
  30 namespace simgrid {
  31 namespace mc {
  32
  33 void wait_for_requests()
  34 {
  35 #if SIMGRID_HAVE_MC
  36   xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
  37 #endif
  38
  39   smx_actor_t process;
  40   unsigned int iter;
  41
  42   while (not xbt_dynar_is_empty(simix_global->process_to_run)) {
  43     SIMIX_process_runall();
  44     xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
  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> 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   smx_simcall_t req = &actor->simcall;
  73   // TODO, add support for the subtypes?
  74
  75   switch (req->call) {
  76     case SIMCALL_NONE:
  77       return false;
  78
  79     case SIMCALL_COMM_WAIT: {
  80       /* FIXME: check also that src and dst processes are not suspended */
  81       simgrid::kernel::activity::CommImpl* act =
  82           static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
  83
  84 #if SIMGRID_HAVE_MC
  85       // Fetch from MCed memory:
  86       // HACK, type puning
  87       if (mc_model_checker != nullptr) {
  88         simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
  89         mc_model_checker->process().read(temp_comm, remote(act));
  90         act = static_cast<simgrid::kernel::activity::CommImpl*>(temp_comm.getBuffer());
  91       }
  92 #endif
  93
  94       if (act->src_timeout || act->dst_timeout) {
  95         /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
  96          * because even if the communication is not ready, it can timeout and won't block. */
  97         if (_sg_mc_timeout == 1)
  98           return true;
  99       }
 100       /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
 101       else if (act->detached && act->src_proc == nullptr && act->type == SIMIX_COMM_READY)
 102         return (act->dst_proc != nullptr);
 103       return (act->src_proc && act->dst_proc);
 104     }
 105
 106     case SIMCALL_COMM_WAITANY: {
 107       xbt_dynar_t comms;
 108       simgrid::kernel::activity::CommImpl* act =
 109           static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
 110
 111 #if SIMGRID_HAVE_MC
 112       s_xbt_dynar_t comms_buffer;
 113       size_t buffer_size = 0;
 114       if (mc_model_checker != nullptr) {
 115         // Read dynar:
 116         mc_model_checker->process().read(&comms_buffer, remote(simcall_comm_waitany__get__comms(req)));
 117         assert(comms_buffer.elmsize == sizeof(act));
 118         buffer_size = comms_buffer.elmsize * comms_buffer.used;
 119         comms       = &comms_buffer;
 120       } else
 121         comms = simcall_comm_waitany__get__comms(req);
 122
 123       // Read all the dynar buffer:
 124       char buffer[buffer_size];
 125       if (mc_model_checker != nullptr)
 126         mc_model_checker->process().read_bytes(buffer, sizeof(buffer), remote(comms->data));
 127 #else
 128       comms = simcall_comm_waitany__get__comms(req);
 129 #endif
 130
 131       for (unsigned int index = 0; index < comms->used; ++index) {
 132 #if SIMGRID_HAVE_MC
 133         // Fetch act from MCed memory:
 134         // HACK, type puning
 135         simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
 136         if (mc_model_checker != nullptr) {
 137           memcpy(&act, buffer + comms->elmsize * index, sizeof(act));
 138           mc_model_checker->process().read(temp_comm, remote(act));
 139           act = static_cast<simgrid::kernel::activity::CommImpl*>(temp_comm.getBuffer());
 140         } else
 141 #endif
 142           act = xbt_dynar_get_as(comms, index, simgrid::kernel::activity::CommImpl*);
 143         if (act->src_proc && act->dst_proc)
 144           return true;
 145       }
 146       return false;
 147     }
 148
 149     case SIMCALL_MUTEX_LOCK: {
 150       smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
 151 #if SIMGRID_HAVE_MC
 152       simgrid::mc::Remote<simgrid::simix::MutexImpl> temp_mutex;
 153       if (mc_model_checker != nullptr) {
 154         mc_model_checker->process().read(temp_mutex.getBuffer(), remote(mutex));
 155         mutex = temp_mutex.getBuffer();
 156       }
 157 #endif
 158
 159       if (mutex->owner == nullptr)
 160         return true;
 161 #if SIMGRID_HAVE_MC
 162       else if (mc_model_checker != nullptr) {
 163         simgrid::mc::RemoteClient& modelchecked = mc_model_checker->process();
 164         // TODO, *(mutex->owner) :/
 165         return modelchecked.resolveActor(simgrid::mc::remote(mutex->owner))->pid ==
 166                modelchecked.resolveActor(simgrid::mc::remote(req->issuer))->pid;
 167       }
 168 #endif
 169       else
 170         return mutex->owner->pid == req->issuer->pid;
 171     }
 172
 173     case SIMCALL_SEM_ACQUIRE: {
 174       static int warned = 0;
 175       if (not warned)
 176         XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
 177       warned = 1;
 178       return true;
 179     }
 180
 181     case SIMCALL_COND_WAIT: {
 182       static int warned = 0;
 183       if (not warned)
 184         XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
 185       warned = 1;
 186       return true;
 187     }
 188
 189     default:
 190       /* The rest of the requests are always enabled */
 191       return true;
 192   }
 193 }
 194
 195 /* This is the list of requests that are visible from the checker algorithm.
 196  * Any other requests are handled right away on the application side.
 197  */
 198 bool request_is_visible(smx_simcall_t req)
 199 {
 200   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
 201   return req->call == SIMCALL_COMM_ISEND
 202       || req->call == SIMCALL_COMM_IRECV
 203       || req->call == SIMCALL_COMM_WAIT
 204       || req->call == SIMCALL_COMM_WAITANY
 205       || req->call == SIMCALL_COMM_TEST
 206       || req->call == SIMCALL_COMM_TESTANY
 207       || req->call == SIMCALL_MC_RANDOM
 208       || req->call == SIMCALL_MUTEX_LOCK
 209       || req->call == SIMCALL_MUTEX_TRYLOCK
 210       ;
 211 }
 212
 213 }
 214 }
 215
 216 static int prng_random(int min, int max)
 217 {
 218   unsigned long output_size = ((unsigned long) max - (unsigned long) min) + 1;
 219   unsigned long input_size = (unsigned long) RAND_MAX + 1;
 220   unsigned long reject_size = input_size % output_size;
 221   unsigned long accept_size = input_size - reject_size; // module*accept_size
 222
 223   // Use rejection in order to avoid skew
 224   unsigned long x;
 225   do {
 226 #ifndef _WIN32
 227     x = (unsigned long) random();
 228 #else
 229     x = (unsigned long) rand();
 230 #endif
 231   } while( x >= accept_size );
 232   return min + (x % output_size);
 233 }
 234
 235 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
 236 {
 237   if (not MC_is_active() && not MC_record_path)
 238     return prng_random(min, max);
 239   return simcall->mc_value;
 240 }