src/mc/mc_base.cpp

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