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