src/mc/mc_base.cpp

   1 /* Copyright (c) 2008-2020. 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_ != 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 #if SIMGRID_HAVE_MC
  74   // If in the MCer, ask the client app since it has all the data
  75   if (mc_model_checker != nullptr) {
  76     return simgrid::mc::session->actor_is_enabled(actor->get_pid());
  77   }
  78 #endif
  79
  80   // Now, we are in the client app, no need for remote memory reading.
  81   smx_simcall_t req = &actor->simcall;
  82
  83   if (req->inspector_ != nullptr)
  84     return req->inspector_->is_enabled();
  85
  86   switch (req->call_) {
  87     case SIMCALL_NONE:
  88       return false;
  89
  90     case SIMCALL_COMM_WAIT: {
  91       /* FIXME: check also that src and dst processes are not suspended */
  92       const kernel::activity::CommImpl* act =
  93           static_cast<kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
  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_actor_ == nullptr &&
 103                act->type_ == simgrid::kernel::activity::CommImpl::Type::READY)
 104         return (act->dst_actor_ != nullptr);
 105       return (act->src_actor_ && act->dst_actor_);
 106     }
 107
 108     case SIMCALL_COMM_WAITANY: {
 109       simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(req);
 110       size_t count                                = simcall_comm_waitany__get__count(req);
 111       for (unsigned int index = 0; index < count; ++index) {
 112         auto const* comm = comms[index];
 113         if (comm->src_actor_ && comm->dst_actor_)
 114           return true;
 115       }
 116       return false;
 117     }
 118
 119     case SIMCALL_MUTEX_LOCK: {
 120       const kernel::activity::MutexImpl* mutex = simcall_mutex_lock__get__mutex(req);
 121
 122       if (mutex->get_owner() == nullptr)
 123         return true;
 124       return mutex->get_owner()->get_pid() == req->issuer_->get_pid();
 125     }
 126
 127     case SIMCALL_SEM_ACQUIRE: {
 128       static int warned = 0;
 129       if (not warned)
 130         XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
 131       warned = 1;
 132       return true;
 133     }
 134
 135     case SIMCALL_COND_WAIT: {
 136       static int warned = 0;
 137       if (not warned)
 138         XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
 139       warned = 1;
 140       return true;
 141     }
 142
 143     default:
 144       /* The rest of the requests are always enabled */
 145       return true;
 146   }
 147 }
 148
 149 /* This is the list of requests that are visible from the checker algorithm.
 150  * Any other requests are handled right away on the application side.
 151  */
 152 bool request_is_visible(const s_smx_simcall* req)
 153 {
 154 #if SIMGRID_HAVE_MC
 155   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
 156 #endif
 157
 158   return (req->inspector_ != nullptr && req->inspector_->is_visible()) || req->call_ == SIMCALL_COMM_ISEND ||
 159          req->call_ == SIMCALL_COMM_IRECV || req->call_ == SIMCALL_COMM_WAIT || req->call_ == SIMCALL_COMM_WAITANY ||
 160          req->call_ == SIMCALL_COMM_TEST || req->call_ == SIMCALL_COMM_TESTANY || req->call_ == SIMCALL_MC_RANDOM ||
 161          req->call_ == SIMCALL_MUTEX_LOCK || req->call_ == SIMCALL_MUTEX_TRYLOCK || req->call_ == SIMCALL_MUTEX_UNLOCK;
 162 }
 163
 164 }
 165 }
 166
 167 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
 168 {
 169   if (not MC_is_active() && MC_record_path.empty()) {
 170     static simgrid::xbt::random::XbtRandom prng;
 171     return prng.uniform_int(min, max);
 172   }
 173   return simcall->mc_value_;
 174 }