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.hpp"
   7 #include "mc/mc.h"
   8 #include "src/kernel/activity/CommImpl.hpp"
   9 #include "src/kernel/activity/MutexImpl.hpp"
  10 #include "src/mc/checker/SimcallObserver.hpp"
  11 #include "src/mc/mc_config.hpp"
  12 #include "src/mc/mc_replay.hpp"
  13 #include "src/simix/smx_private.hpp"
  14
  15 #include "xbt/random.hpp"
  16
  17 #if SIMGRID_HAVE_MC
  18 #include "src/mc/ModelChecker.hpp"
  19 #include "src/mc/Session.hpp"
  20 #include "src/mc/remote/RemoteSimulation.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   if (not MC_is_active() && not MC_record_replay_is_active()) { // no need to do a simcall in this case
  33     static simgrid::xbt::random::XbtRandom prng;
  34     return prng.uniform_int(min, max);
  35   }
  36   simgrid::mc::RandomSimcall observer{SIMIX_process_self(), min, max};
  37   return simgrid::kernel::actor::simcall([&observer] { return observer.get_value(); }, &observer);
  38 }
  39
  40 namespace simgrid {
  41 namespace mc {
  42
  43 void wait_for_requests()
  44 {
  45 #if SIMGRID_HAVE_MC
  46   xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
  47 #endif
  48   while (not simix_global->actors_to_run.empty()) {
  49     simix_global->run_all_actors();
  50     for (smx_actor_t const& process : simix_global->actors_that_ran) {
  51       const s_smx_simcall* req = &process->simcall_;
  52       if (req->call_ != simix::Simcall::NONE && not simgrid::mc::request_is_visible(req))
  53         process->simcall_handle(0);
  54     }
  55   }
  56 #if SIMGRID_HAVE_MC
  57   xbt_dynar_reset(simix_global->actors_vector);
  58   for (std::pair<const aid_t, smx_actor_t> const& kv : simix_global->process_list) {
  59     auto actor = kv.second;
  60     if (actor->simcall_.observer_ != nullptr)
  61       actor->simcall_.mc_max_consider_ = actor->simcall_.observer_->get_max_consider();
  62     xbt_dynar_push_as(simix_global->actors_vector, smx_actor_t, actor);
  63   }
  64 #endif
  65 }
  66
  67 /** @brief returns if there this transition can proceed in a finite amount of time
  68  *
  69  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
  70  *
  71  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
  72  * Wait operations are OK and return true in only two situations:
  73  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
  74  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this
  75  * transition for ever.
  76  *
  77  */
  78 // Called from both MCer and MCed:
  79 bool actor_is_enabled(smx_actor_t actor)
  80 {
  81 // #del
  82 #if SIMGRID_HAVE_MC
  83   // If in the MCer, ask the client app since it has all the data
  84   if (mc_model_checker != nullptr) {
  85     return simgrid::mc::session->actor_is_enabled(actor->get_pid());
  86   }
  87 #endif
  88 // #
  89
  90   // Now, we are in the client app, no need for remote memory reading.
  91   smx_simcall_t req = &actor->simcall_;
  92
  93   if (req->observer_ != nullptr)
  94     return req->observer_->is_enabled();
  95
  96   using simix::Simcall;
  97   switch (req->call_) {
  98     case Simcall::NONE:
  99       return false;
 100
 101     case Simcall::COMM_WAIT: {
 102       /* FIXME: check also that src and dst processes are not suspended */
 103       const kernel::activity::CommImpl* act = simcall_comm_wait__getraw__comm(req);
 104
 105       if (act->src_timeout_ || act->dst_timeout_) {
 106         /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
 107          * because even if the communication is not ready, it can timeout and won't block. */
 108         if (_sg_mc_timeout == 1)
 109           return true;
 110       }
 111       /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
 112       else if (act->detached() && act->src_actor_ == nullptr && act->state_ == simgrid::kernel::activity::State::READY)
 113         return (act->dst_actor_ != nullptr);
 114       return (act->src_actor_ && act->dst_actor_);
 115     }
 116
 117     case Simcall::COMM_WAITANY: {
 118       simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(req);
 119       size_t count                                = simcall_comm_waitany__get__count(req);
 120       for (unsigned int index = 0; index < count; ++index) {
 121         auto const* comm = comms[index];
 122         if (comm->src_actor_ && comm->dst_actor_)
 123           return true;
 124       }
 125       return false;
 126     }
 127
 128     case Simcall::SEM_ACQUIRE: {
 129       static bool warned = false;
 130       if (not warned)
 131         XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
 132       warned = true;
 133       return true;
 134     }
 135
 136     case Simcall::COND_WAIT: {
 137       static bool warned = false;
 138       if (not warned)
 139         XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
 140       warned = true;
 141       return true;
 142     }
 143
 144     default:
 145       /* The rest of the requests are always enabled */
 146       return true;
 147   }
 148 }
 149
 150 /* This is the list of requests that are visible from the checker algorithm.
 151  * Any other requests are handled right away on the application side.
 152  */
 153 bool request_is_visible(const s_smx_simcall* req)
 154 {
 155 #if SIMGRID_HAVE_MC
 156   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
 157 #endif
 158   if (req->observer_ != nullptr)
 159     return req->observer_->is_visible();
 160
 161   using simix::Simcall;
 162   return req->call_ == Simcall::COMM_ISEND || req->call_ == Simcall::COMM_IRECV || req->call_ == Simcall::COMM_WAIT ||
 163          req->call_ == Simcall::COMM_WAITANY || req->call_ == Simcall::COMM_TEST || req->call_ == Simcall::COMM_TESTANY;
 164 }
 165
 166 }
 167 }