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