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