src/mc/mc_base.cpp

   1 /* Copyright (c) 2008-2021. 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 "src/kernel/activity/CommImpl.hpp"
   9 #include "src/kernel/activity/MutexImpl.hpp"
  10 #include "src/mc/checker/SimcallInspector.hpp"
  11 #include "src/mc/mc_replay.hpp"
  12 #include "src/simix/smx_private.hpp"
  13
  14 #include "xbt/random.hpp"
  15
  16 #if SIMGRID_HAVE_MC
  17 #include "src/mc/ModelChecker.hpp"
  18 #include "src/mc/Session.hpp"
  19 #include "src/mc/remote/RemoteSimulation.hpp"
  20
  21 using simgrid::mc::remote;
  22 #endif
  23
  24 XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
  25
  26 int MC_random(int min, int max)
  27 {
  28 #if SIMGRID_HAVE_MC
  29   xbt_assert(mc_model_checker == nullptr);
  30 #endif
  31   /* TODO, if the MC is disabled we do not really need to make a simcall for this :) */
  32   return simcall_mc_random(min, max);
  33 }
  34
  35 namespace simgrid {
  36 namespace mc {
  37
  38 void wait_for_requests()
  39 {
  40 #if SIMGRID_HAVE_MC
  41   xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
  42 #endif
  43   while (not simix_global->actors_to_run.empty()) {
  44     simix_global->run_all_actors();
  45     for (smx_actor_t const& process : simix_global->actors_that_ran) {
  46       const s_smx_simcall* req = &process->simcall_;
  47       if (req->call_ != simix::Simcall::NONE && not simgrid::mc::request_is_visible(req))
  48         process->simcall_handle(0);
  49     }
  50   }
  51 #if SIMGRID_HAVE_MC
  52   xbt_dynar_reset(simix_global->actors_vector);
  53   for (std::pair<const aid_t, smx_actor_t> const& 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 // #del
  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 simgrid::mc::session->actor_is_enabled(actor->get_pid());
  78   }
  79 #endif
  80 // #
  81
  82   // Now, we are in the client app, no need for remote memory reading.
  83   smx_simcall_t req = &actor->simcall_;
  84
  85   if (req->inspector_ != nullptr)
  86     return req->inspector_->is_enabled();
  87
  88   using simix::Simcall;
  89   switch (req->call_) {
  90     case Simcall::NONE:
  91       return false;
  92
  93     case Simcall::COMM_WAIT: {
  94       /* FIXME: check also that src and dst processes are not suspended */
  95       const kernel::activity::CommImpl* act = simcall_comm_wait__getraw__comm(req);
  96
  97       if (act->src_timeout_ || act->dst_timeout_) {
  98         /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
  99          * because even if the communication is not ready, it can timeout and won't block. */
 100         if (_sg_mc_timeout == 1)
 101           return true;
 102       }
 103       /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
 104       else if (act->detached() && act->src_actor_ == nullptr &&
 105                act->type_ == simgrid::kernel::activity::CommImpl::Type::READY)
 106         return (act->dst_actor_ != nullptr);
 107       return (act->src_actor_ && act->dst_actor_);
 108     }
 109
 110     case Simcall::COMM_WAITANY: {
 111       simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(req);
 112       size_t count                                = simcall_comm_waitany__get__count(req);
 113       for (unsigned int index = 0; index < count; ++index) {
 114         auto const* comm = comms[index];
 115         if (comm->src_actor_ && comm->dst_actor_)
 116           return true;
 117       }
 118       return false;
 119     }
 120
 121     case Simcall::MUTEX_LOCK: {
 122       const kernel::activity::MutexImpl* mutex = simcall_mutex_lock__get__mutex(req);
 123
 124       if (mutex->get_owner() == nullptr)
 125         return true;
 126       return mutex->get_owner()->get_pid() == req->issuer_->get_pid();
 127     }
 128
 129     case Simcall::SEM_ACQUIRE: {
 130       static int warned = 0;
 131       if (not warned)
 132         XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
 133       warned = 1;
 134       return true;
 135     }
 136
 137     case Simcall::COND_WAIT: {
 138       static int warned = 0;
 139       if (not warned)
 140         XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
 141       warned = 1;
 142       return true;
 143     }
 144
 145     default:
 146       /* The rest of the requests are always enabled */
 147       return true;
 148   }
 149 }
 150
 151 /* This is the list of requests that are visible from the checker algorithm.
 152  * Any other requests are handled right away on the application side.
 153  */
 154 bool request_is_visible(const s_smx_simcall* req)
 155 {
 156 #if SIMGRID_HAVE_MC
 157   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
 158 #endif
 159
 160   using simix::Simcall;
 161   return (req->inspector_ != nullptr && req->inspector_->is_visible()) || req->call_ == Simcall::COMM_ISEND ||
 162          req->call_ == Simcall::COMM_IRECV || req->call_ == Simcall::COMM_WAIT || req->call_ == Simcall::COMM_WAITANY ||
 163          req->call_ == Simcall::COMM_TEST || req->call_ == Simcall::COMM_TESTANY || req->call_ == Simcall::MC_RANDOM ||
 164          req->call_ == Simcall::MUTEX_LOCK || req->call_ == Simcall::MUTEX_TRYLOCK ||
 165          req->call_ == Simcall::MUTEX_UNLOCK;
 166 }
 167
 168 }
 169 }
 170
 171 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
 172 {
 173   if (not MC_is_active() && MC_record_path.empty()) {
 174     static simgrid::xbt::random::XbtRandom prng;
 175     return prng.uniform_int(min, max);
 176   }
 177   return simcall->mc_value_;
 178 }