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 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_CATEGORY(mc, "All MC categories");
  39
  40 int MC_random(int min, int max)
  41 {
  42 #if 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 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 HAVE_MC
  72   xbt_dynar_reset(simix_global->actors_vector);
  73   for (std::pair<int, 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_SEM_ACQUIRE:
 100     xbt_die("Don't use semaphores in model-checked code, it's not supported yet");
 101   case SIMCALL_COND_WAIT:
 102     xbt_die("Don't use condition variables in model-checked code, it's not supported yet");
 103
 104   case SIMCALL_COMM_WAIT:
 105   {
 106     /* FIXME: check also that src and dst processes are not suspended */
 107     simgrid::kernel::activity::Comm *act =
 108         static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(req));
 109
 110 #if HAVE_MC
 111     // Fetch from MCed memory:
 112     // HACK, type puning
 113     if (mc_model_checker != nullptr) {
 114       simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
 115       mc_model_checker->process().read(temp_comm, remote(act));
 116       act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
 117     }
 118 #endif
 119
 120     if (simcall_comm_wait__get__timeout(req) >= 0) {
 121       /* If it has a timeout it will be always be enabled, because even if the
 122        * communication is not ready, it can timeout and won't block. */
 123       if (_sg_mc_timeout == 1)
 124         return true;
 125     }
 126     /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
 127     else if (act->detached && act->src_proc == nullptr
 128           && act->type == SIMIX_COMM_READY)
 129         return (act->dst_proc != nullptr);
 130     return (act->src_proc && act->dst_proc);
 131   }
 132
 133   case SIMCALL_COMM_WAITANY: {
 134     xbt_dynar_t comms;
 135     simgrid::kernel::activity::Comm *act =
 136         static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(req));
 137
 138 #if HAVE_MC
 139     s_xbt_dynar_t comms_buffer;
 140     size_t buffer_size = 0;
 141     if (mc_model_checker != nullptr) {
 142       // Read dynar:
 143       mc_model_checker->process().read(
 144         &comms_buffer, remote(simcall_comm_waitany__get__comms(req)));
 145       assert(comms_buffer.elmsize == sizeof(act));
 146       buffer_size = comms_buffer.elmsize * comms_buffer.used;
 147       comms = &comms_buffer;
 148     } else
 149       comms = simcall_comm_waitany__get__comms(req);
 150
 151     // Read all the dynar buffer:
 152     char buffer[buffer_size];
 153     if (mc_model_checker != nullptr)
 154       mc_model_checker->process().read_bytes(buffer, sizeof(buffer),
 155         remote(comms->data));
 156 #else
 157     comms = simcall_comm_waitany__get__comms(req);
 158 #endif
 159
 160     for (index = 0; index < comms->used; ++index) {
 161 #if HAVE_MC
 162       // Fetch act from MCed memory:
 163       // HACK, type puning
 164       simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
 165       if (mc_model_checker != nullptr) {
 166         memcpy(&act, buffer + comms->elmsize * index, sizeof(act));
 167         mc_model_checker->process().read(temp_comm, remote(act));
 168         act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
 169       }
 170       else
 171 #endif
 172         act = xbt_dynar_get_as(comms, index, simgrid::kernel::activity::Comm*);
 173       if (act->src_proc && act->dst_proc)
 174         return true;
 175     }
 176     return false;
 177   }
 178
 179   case SIMCALL_MUTEX_LOCK: {
 180     smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
 181 #if HAVE_MC
 182     simgrid::mc::Remote<simgrid::simix::Mutex> temp_mutex;
 183     if (mc_model_checker != nullptr) {
 184       mc_model_checker->process().read(temp_mutex.getBuffer(), remote(mutex));
 185       mutex = temp_mutex.getBuffer();
 186     }
 187 #endif
 188
 189     if(mutex->owner == nullptr)
 190       return true;
 191 #if HAVE_MC
 192     else if (mc_model_checker != nullptr) {
 193       simgrid::mc::Process& modelchecked = mc_model_checker->process();
 194       // TODO, *(mutex->owner) :/
 195       return modelchecked.resolveActor(simgrid::mc::remote(mutex->owner))->pid ==
 196              modelchecked.resolveActor(simgrid::mc::remote(req->issuer))->pid;
 197     }
 198 #endif
 199     else
 200       return mutex->owner->pid == req->issuer->pid;
 201     }
 202
 203   default:
 204     /* The rest of the requests are always enabled */
 205     return true;
 206   }
 207 }
 208
 209 bool request_is_visible(smx_simcall_t req)
 210 {
 211   return req->call == SIMCALL_COMM_ISEND
 212       || req->call == SIMCALL_COMM_IRECV
 213       || req->call == SIMCALL_COMM_WAIT
 214       || req->call == SIMCALL_COMM_WAITANY
 215       || req->call == SIMCALL_COMM_TEST
 216       || req->call == SIMCALL_COMM_TESTANY
 217       || req->call == SIMCALL_MC_RANDOM
 218       || req->call == SIMCALL_MUTEX_LOCK
 219       || req->call == SIMCALL_MUTEX_TRYLOCK
 220       ;
 221 }
 222
 223 }
 224 }
 225
 226 static int prng_random(int min, int max)
 227 {
 228   unsigned long output_size = ((unsigned long) max - (unsigned long) min) + 1;
 229   unsigned long input_size = (unsigned long) RAND_MAX + 1;
 230   unsigned long reject_size = input_size % output_size;
 231   unsigned long accept_size = input_size - reject_size; // module*accept_size
 232
 233   // Use rejection in order to avoid skew
 234   unsigned long x;
 235   do {
 236 #ifndef _WIN32
 237     x = (unsigned long) random();
 238 #else
 239     x = (unsigned long) rand();
 240 #endif
 241   } while( x >= accept_size );
 242   return min + (x % output_size);
 243 }
 244
 245 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
 246 {
 247   if (!MC_is_active() && !MC_record_path)
 248     return prng_random(min, max);
 249   return simcall->mc_value;
 250 }