src/mc/mc_base.cpp

   1 /* Copyright (c) 2008-2019. 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 "src/mc/mc_base.h"
   7 #include "mc/mc.h"
   8 #include "simgrid/config.h"
   9 #include "src/kernel/activity/CommImpl.hpp"
  10 #include "src/kernel/activity/MutexImpl.hpp"
  11 #include "src/mc/mc_config.hpp"
  12 #include "src/mc/mc_forward.hpp"
  13 #include "src/mc/mc_replay.hpp"
  14 #include "src/simix/smx_private.hpp"
  15
  16 #include <random>
  17
  18 #if SIMGRID_HAVE_MC
  19 #include "src/mc/ModelChecker.hpp"
  20 #include "src/mc/remote/RemoteClient.hpp"
  21
  22 using simgrid::mc::remote;
  23 #endif
  24
  25 XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
  26
  27 int MC_random(int min, int max)
  28 {
  29 #if SIMGRID_HAVE_MC
  30   xbt_assert(mc_model_checker == nullptr);
  31 #endif
  32   /* TODO, if the MC is disabled we do not really need to make a simcall for this :) */
  33   return simcall_mc_random(min, max);
  34 }
  35
  36 namespace simgrid {
  37 namespace mc {
  38
  39 void wait_for_requests()
  40 {
  41 #if SIMGRID_HAVE_MC
  42   xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
  43 #endif
  44   while (not simix_global->actors_to_run.empty()) {
  45     simix_global->run_all_actors();
  46     for (smx_actor_t const& process : simix_global->actors_that_ran) {
  47       smx_simcall_t req = &process->simcall;
  48       if (req->call != SIMCALL_NONE && not simgrid::mc::request_is_visible(req))
  49         SIMIX_simcall_handle(req, 0);
  50     }
  51   }
  52 #if SIMGRID_HAVE_MC
  53   xbt_dynar_reset(simix_global->actors_vector);
  54   for (std::pair<aid_t, smx_actor_t> const& kv : simix_global->process_list) {
  55     xbt_dynar_push_as(simix_global->actors_vector, smx_actor_t, kv.second);
  56   }
  57 #endif
  58 }
  59
  60 /** @brief returns if there this transition can proceed in a finite amount of time
  61  *
  62  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
  63  *
  64  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
  65  * Wait operations are OK and return true in only two situations:
  66  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
  67  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this
  68  * transition for ever.
  69  *
  70  */
  71 // Called from both MCer and MCed:
  72 bool actor_is_enabled(smx_actor_t actor)
  73 {
  74 #if SIMGRID_HAVE_MC
  75   // If in the MCer, ask the client app since it has all the data
  76   if (mc_model_checker != nullptr) {
  77     return mc_model_checker->process().actor_is_enabled(actor->get_pid());
  78   }
  79 #endif
  80
  81   // Now, we are in the client app, no need for remote memory reading.
  82   smx_simcall_t req = &actor->simcall;
  83
  84   switch (req->call) {
  85     case SIMCALL_NONE:
  86       return false;
  87
  88     case SIMCALL_COMM_WAIT: {
  89       /* FIXME: check also that src and dst processes are not suspended */
  90       simgrid::kernel::activity::CommImpl* act =
  91           static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
  92
  93       if (act->src_timeout_ || act->dst_timeout_) {
  94         /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
  95          * because even if the 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_actor_ == nullptr &&
 101                act->type_ == simgrid::kernel::activity::CommImpl::Type::READY)
 102         return (act->dst_actor_ != nullptr);
 103       return (act->src_actor_ && act->dst_actor_);
 104     }
 105
 106     case SIMCALL_COMM_WAITANY: {
 107       simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(req);
 108       size_t count                                = simcall_comm_waitany__get__count(req);
 109       for (unsigned int index = 0; index < count; ++index) {
 110         auto* comm = comms[index];
 111         if (comm->src_actor_ && comm->dst_actor_)
 112           return true;
 113       }
 114       return false;
 115     }
 116
 117     case SIMCALL_MUTEX_LOCK: {
 118       smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
 119
 120       if (mutex->owner_ == nullptr)
 121         return true;
 122       return mutex->owner_->get_pid() == req->issuer->get_pid();
 123     }
 124
 125     case SIMCALL_SEM_ACQUIRE: {
 126       static int warned = 0;
 127       if (not warned)
 128         XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
 129       warned = 1;
 130       return true;
 131     }
 132
 133     case SIMCALL_COND_WAIT: {
 134       static int warned = 0;
 135       if (not warned)
 136         XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
 137       warned = 1;
 138       return true;
 139     }
 140
 141     default:
 142       /* The rest of the requests are always enabled */
 143       return true;
 144   }
 145 }
 146
 147 /* This is the list of requests that are visible from the checker algorithm.
 148  * Any other requests are handled right away on the application side.
 149  */
 150 bool request_is_visible(smx_simcall_t req)
 151 {
 152 #if SIMGRID_HAVE_MC
 153   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
 154 #endif
 155
 156   return req->call == SIMCALL_COMM_ISEND || req->call == SIMCALL_COMM_IRECV || req->call == SIMCALL_COMM_WAIT ||
 157          req->call == SIMCALL_COMM_WAITANY || req->call == SIMCALL_COMM_TEST || req->call == SIMCALL_COMM_TESTANY ||
 158          req->call == SIMCALL_MC_RANDOM || req->call == SIMCALL_MUTEX_LOCK || req->call == SIMCALL_MUTEX_TRYLOCK ||
 159          req->call == SIMCALL_MUTEX_UNLOCK;
 160 }
 161
 162 }
 163 }
 164
 165 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
 166 {
 167   if (not MC_is_active() && MC_record_path.empty()) {
 168     static std::default_random_engine rnd_engine;
 169     std::uniform_int_distribution<int> prng(min, max);
 170     return prng(rnd_engine);
 171   }
 172   return simcall->mc_value;
 173 }