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 "src/mc/mc_base.h"
  18 #include "src/simix/smx_private.h"
  19 #include "src/mc/mc_replay.h"
  20 #include "mc/mc.h"
  21 #include "src/mc/mc_protocol.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_process_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 }
  75
  76 /** @brief returns if there this transition can proceed in a finite amount of time
  77  *
  78  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
  79  *
  80  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
  81  * Wait operations are OK and return true in only two situations:
  82  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
  83  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this transition for ever.
  84  *
  85  */
  86 // Called from both MCer and MCed:
  87 bool request_is_enabled(smx_simcall_t req)
  88 {
  89   unsigned int index = 0;
  90   // TODO, add support for the subtypes?
  91
  92   switch (req->call) {
  93   case SIMCALL_NONE:
  94     return false;
  95
  96   case SIMCALL_SEM_ACQUIRE:
  97     xbt_die("Don't use semaphores in model-checked code, it's not supported yet");
  98   case SIMCALL_COND_WAIT:
  99     xbt_die("Don't use condition variables in model-checked code, it's not supported yet");
 100
 101   case SIMCALL_COMM_WAIT:
 102   {
 103     /* FIXME: check also that src and dst processes are not suspended */
 104     simgrid::kernel::activity::Comm *act =
 105         static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(req));
 106
 107 #if HAVE_MC
 108     // Fetch from MCed memory:
 109     // HACK, type puning
 110     simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
 111     if (mc_model_checker != nullptr) {
 112       mc_model_checker->process().read(temp_comm, remote(act));
 113       act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
 114     }
 115 #endif
 116
 117     if (simcall_comm_wait__get__timeout(req) >= 0) {
 118       /* If it has a timeout it will be always be enabled, because even if the
 119        * communication is not ready, it can timeout and won't block. */
 120       if (_sg_mc_timeout == 1)
 121         return true;
 122     }
 123     /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
 124     else if (act->detached && act->src_proc == nullptr
 125           && act->type == SIMIX_COMM_READY)
 126         return (act->dst_proc != nullptr);
 127     return (act->src_proc && act->dst_proc);
 128   }
 129
 130   case SIMCALL_COMM_WAITANY: {
 131     xbt_dynar_t comms;
 132     simgrid::kernel::activity::Comm *act =
 133         static_cast<simgrid::kernel::activity::Comm*>(simcall_comm_wait__get__comm(req));
 134 #if HAVE_MC
 135
 136     s_xbt_dynar_t comms_buffer;
 137     size_t buffer_size = 0;
 138     if (mc_model_checker != nullptr) {
 139       // Read dynar:
 140       mc_model_checker->process().read(
 141         &comms_buffer, remote(simcall_comm_waitany__get__comms(req)));
 142       assert(comms_buffer.elmsize == sizeof(act));
 143       buffer_size = comms_buffer.elmsize * comms_buffer.used;
 144       comms = &comms_buffer;
 145     } else
 146       comms = simcall_comm_waitany__get__comms(req);
 147
 148     // Read all the dynar buffer:
 149     char buffer[buffer_size];
 150     if (mc_model_checker != nullptr)
 151       mc_model_checker->process().read_bytes(buffer, sizeof(buffer),
 152         remote(comms->data));
 153 #else
 154     comms = simcall_comm_waitany__get__comms(req);
 155 #endif
 156
 157     for (index = 0; index < comms->used; ++index) {
 158 #if HAVE_MC
 159       // Fetch act from MCed memory:
 160       // HACK, type puning
 161       simgrid::mc::Remote<simgrid::kernel::activity::Comm> temp_comm;
 162       if (mc_model_checker != nullptr) {
 163         memcpy(&act, buffer + comms->elmsize * index, sizeof(act));
 164         mc_model_checker->process().read(temp_comm, remote(act));
 165         act = static_cast<simgrid::kernel::activity::Comm*>(temp_comm.getBuffer());
 166       }
 167       else
 168 #endif
 169         act = xbt_dynar_get_as(comms, index, simgrid::kernel::activity::Comm*);
 170       if (act->src_proc && act->dst_proc)
 171         return true;
 172     }
 173     return false;
 174   }
 175
 176   case SIMCALL_MUTEX_LOCK: {
 177     smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
 178 #if HAVE_MC
 179     simgrid::mc::Remote<simgrid::simix::Mutex> temp_mutex;
 180     if (mc_model_checker != nullptr) {
 181       mc_model_checker->process().read(temp_mutex.getBuffer(), remote(mutex));
 182       mutex = temp_mutex.getBuffer();
 183     }
 184 #endif
 185
 186     if(mutex->owner == nullptr)
 187       return true;
 188 #if HAVE_MC
 189     else if (mc_model_checker != nullptr) {
 190       simgrid::mc::Process& modelchecked = mc_model_checker->process();
 191       // TODO, *(mutex->owner) :/
 192       return modelchecked.resolveProcess(simgrid::mc::remote(mutex->owner))->pid
 193         == modelchecked.resolveProcess(simgrid::mc::remote(req->issuer))->pid;
 194     }
 195 #endif
 196     else
 197       return mutex->owner->pid == req->issuer->pid;
 198     }
 199
 200   default:
 201     /* The rest of the requests are always enabled */
 202     return true;
 203   }
 204 }
 205
 206 bool request_is_visible(smx_simcall_t req)
 207 {
 208   return req->call == SIMCALL_COMM_ISEND
 209       || req->call == SIMCALL_COMM_IRECV
 210       || req->call == SIMCALL_COMM_WAIT
 211       || req->call == SIMCALL_COMM_WAITANY
 212       || req->call == SIMCALL_COMM_TEST
 213       || req->call == SIMCALL_COMM_TESTANY
 214       || req->call == SIMCALL_MC_RANDOM
 215       || req->call == SIMCALL_MUTEX_LOCK
 216       || req->call == SIMCALL_MUTEX_TRYLOCK
 217       ;
 218 }
 219
 220 }
 221 }
 222
 223 static int prng_random(int min, int max)
 224 {
 225   unsigned long output_size = ((unsigned long) max - (unsigned long) min) + 1;
 226   unsigned long input_size = (unsigned long) RAND_MAX + 1;
 227   unsigned long reject_size = input_size % output_size;
 228   unsigned long accept_size = input_size - reject_size; // module*accept_size
 229
 230   // Use rejection in order to avoid skew
 231   unsigned long x;
 232   do {
 233 #ifndef _WIN32
 234     x = (unsigned long) random();
 235 #else
 236     x = (unsigned long) rand();
 237 #endif
 238   } while( x >= accept_size );
 239   return min + (x % output_size);
 240 }
 241
 242 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
 243 {
 244   if (!MC_is_active() && !MC_record_path)
 245     return prng_random(min, max);
 246   return simcall->mc_value;
 247 }