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 <cassert>
   7
   8 #include <simgrid_config.h>
   9
  10 #include <xbt/log.h>
  11 #include <xbt/asserts.h>
  12 #include <xbt/dynar.h>
  13
  14 #include <simgrid/simix.h>
  15
  16 #include "mc/mc.h"
  17 #include "src/mc/mc_base.h"
  18 #include "src/mc/mc_replay.h"
  19 #include "src/mc/remote/mc_protocol.h"
  20 #include "src/simix/smx_private.h"
  21
  22 #include "src/kernel/activity/ActivityImpl.hpp"
  23 #include "src/kernel/activity/SynchroIo.hpp"
  24 #include "src/kernel/activity/SynchroComm.hpp"
  25 #include "src/kernel/activity/SynchroRaw.hpp"
  26 #include "src/kernel/activity/SynchroSleep.hpp"
  27 #include "src/kernel/activity/SynchroExec.hpp"
  28
  29 #if SIMGRID_HAVE_MC
  30 #include "src/mc/mc_request.h"
  31 #include "src/mc/Process.hpp"
  32 #include "src/mc/ModelChecker.hpp"
  33 #include "src/mc/mc_smx.h"
  34
  35 using simgrid::mc::remote;
  36 #endif
  37
  38 XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
  39
  40 int MC_random(int min, int max)
  41 {
  42 #if SIMGRID_HAVE_MC
  43   xbt_assert(mc_model_checker == nullptr);
  44   /* TODO, if the MC is disabled we do not really need to make a simcall for
  45    * this :) */
  46 #endif
  47   return simcall_mc_random(min, max);
  48 }
  49
  50 namespace simgrid {
  51 namespace mc {
  52
  53 void wait_for_requests(void)
  54 {
  55 #if SIMGRID_HAVE_MC
  56   xbt_assert(mc_model_checker == nullptr);
  57 #endif
  58
  59   smx_actor_t process;
  60   smx_simcall_t req;
  61   unsigned int iter;
  62
  63   while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
  64     SIMIX_process_runall();
  65     xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
  66       req = &process->simcall;
  67       if (req->call != SIMCALL_NONE && !simgrid::mc::request_is_visible(req))
  68         SIMIX_simcall_handle(req, 0);
  69     }
  70   }
  71 #if SIMGRID_HAVE_MC
  72   xbt_dynar_reset(simix_global->actors_vector);
  73   for (std::pair<aid_t, smx_actor_t> kv : simix_global->process_list) {
  74     xbt_dynar_push_as(simix_global->actors_vector, smx_actor_t, kv.second);
  75   }
  76 #endif
  77 }
  78
  79 /** @brief returns if there this transition can proceed in a finite amount of time
  80  *
  81  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
  82  *
  83  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
  84  * Wait operations are OK and return true in only two situations:
  85  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
  86  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this transition for ever.
  87  *
  88  */
  89 // Called from both MCer and MCed:
  90 bool request_is_enabled(smx_simcall_t req)
  91 {
  92   unsigned int index = 0;
  93   // TODO, add support for the subtypes?
  94
  95   switch (req->call) {
  96   case SIMCALL_NONE:
  97     return false;
  98
  99   case SIMCALL_COMM_WAIT:
 100   {
 101     /* FIXME: check also that src and dst processes are not suspended */
 102     simgrid::kernel::activity::Comm *act =
 103         static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(req));
 104
 105 #if SIMGRID_HAVE_MC
 106     // Fetch from MCed memory:
 107     // HACK, type puning
 108     if (mc_model_checker != nullptr) {
 109       simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
 110       mc_model_checker->process().read(temp_comm, remote(act));
 111       act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
 112     }
 113 #endif
 114
 115     if (simcall_comm_wait__get__timeout(req) >= 0) {
 116       /* If it has a timeout it will be always be enabled, because even if the
 117        * communication is not ready, it can timeout and won't block. */
 118       if (_sg_mc_timeout == 1)
 119         return true;
 120     }
 121     /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
 122     else if (act->detached && act->src_proc == nullptr
 123           && act->type == SIMIX_COMM_READY)
 124         return (act->dst_proc != nullptr);
 125     return (act->src_proc && act->dst_proc);
 126   }
 127
 128   case SIMCALL_COMM_WAITANY: {
 129     xbt_dynar_t comms;
 130     simgrid::kernel::activity::Comm *act =
 131         static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(req));
 132
 133 #if SIMGRID_HAVE_MC
 134     s_xbt_dynar_t comms_buffer;
 135     size_t buffer_size = 0;
 136     if (mc_model_checker != nullptr) {
 137       // Read dynar:
 138       mc_model_checker->process().read(
 139         &comms_buffer, remote(simcall_comm_waitany__get__comms(req)));
 140       assert(comms_buffer.elmsize == sizeof(act));
 141       buffer_size = comms_buffer.elmsize * comms_buffer.used;
 142       comms = &comms_buffer;
 143     } else
 144       comms = simcall_comm_waitany__get__comms(req);
 145
 146     // Read all the dynar buffer:
 147     char buffer[buffer_size];
 148     if (mc_model_checker != nullptr)
 149       mc_model_checker->process().read_bytes(buffer, sizeof(buffer),
 150         remote(comms->data));
 151 #else
 152     comms = simcall_comm_waitany__get__comms(req);
 153 #endif
 154
 155     for (index = 0; index < comms->used; ++index) {
 156 #if SIMGRID_HAVE_MC
 157       // Fetch act from MCed memory:
 158       // HACK, type puning
 159       simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
 160       if (mc_model_checker != nullptr) {
 161         memcpy(&act, buffer + comms->elmsize * index, sizeof(act));
 162         mc_model_checker->process().read(temp_comm, remote(act));
 163         act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
 164       }
 165       else
 166 #endif
 167         act = xbt_dynar_get_as(comms, index, simgrid::kernel::activity::Comm*);
 168       if (act->src_proc && act->dst_proc)
 169         return true;
 170     }
 171     return false;
 172   }
 173
 174   case SIMCALL_MUTEX_LOCK: {
 175     smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
 176 #if SIMGRID_HAVE_MC
 177     simgrid::mc::Remote<simgrid::simix::Mutex> temp_mutex;
 178     if (mc_model_checker != nullptr) {
 179       mc_model_checker->process().read(temp_mutex.getBuffer(), remote(mutex));
 180       mutex = temp_mutex.getBuffer();
 181     }
 182 #endif
 183
 184     if(mutex->owner == nullptr)
 185       return true;
 186 #if SIMGRID_HAVE_MC
 187     else if (mc_model_checker != nullptr) {
 188       simgrid::mc::Process& modelchecked = mc_model_checker->process();
 189       // TODO, *(mutex->owner) :/
 190       return modelchecked.resolveActor(simgrid::mc::remote(mutex->owner))->pid ==
 191              modelchecked.resolveActor(simgrid::mc::remote(req->issuer))->pid;
 192     }
 193 #endif
 194     else
 195       return mutex->owner->pid == req->issuer->pid;
 196     }
 197
 198     case SIMCALL_SEM_ACQUIRE: {
 199       static int warned = 0;
 200       if (!warned)
 201         XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
 202       warned = 1;
 203       return true;
 204     }
 205
 206     case SIMCALL_COND_WAIT: {
 207       static int warned = 0;
 208       if (!warned)
 209         XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
 210       warned = 1;
 211       return true;
 212     }
 213
 214     default:
 215       /* The rest of the requests are always enabled */
 216       return true;
 217   }
 218 }
 219
 220 bool request_is_visible(smx_simcall_t req)
 221 {
 222   return req->call == SIMCALL_COMM_ISEND
 223       || req->call == SIMCALL_COMM_IRECV
 224       || req->call == SIMCALL_COMM_WAIT
 225       || req->call == SIMCALL_COMM_WAITANY
 226       || req->call == SIMCALL_COMM_TEST
 227       || req->call == SIMCALL_COMM_TESTANY
 228       || req->call == SIMCALL_MC_RANDOM
 229       || req->call == SIMCALL_MUTEX_LOCK
 230       || req->call == SIMCALL_MUTEX_TRYLOCK
 231       ;
 232 }
 233
 234 }
 235 }
 236
 237 static int prng_random(int min, int max)
 238 {
 239   unsigned long output_size = ((unsigned long) max - (unsigned long) min) + 1;
 240   unsigned long input_size = (unsigned long) RAND_MAX + 1;
 241   unsigned long reject_size = input_size % output_size;
 242   unsigned long accept_size = input_size - reject_size; // module*accept_size
 243
 244   // Use rejection in order to avoid skew
 245   unsigned long x;
 246   do {
 247 #ifndef _WIN32
 248     x = (unsigned long) random();
 249 #else
 250     x = (unsigned long) rand();
 251 #endif
 252   } while( x >= accept_size );
 253   return min + (x % output_size);
 254 }
 255
 256 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
 257 {
 258   if (!MC_is_active() && !MC_record_path)
 259     return prng_random(min, max);
 260   return simcall->mc_value;
 261 }