1 /* Copyright (c) 2008-2021. The SimGrid Team. All rights reserved. */
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. */
6 #include "src/mc/mc_base.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_config.hpp"
12 #include "src/mc/mc_replay.hpp"
13 #include "src/simix/smx_private.hpp"
15 #include "xbt/random.hpp"
18 #include "src/mc/ModelChecker.hpp"
19 #include "src/mc/Session.hpp"
20 #include "src/mc/remote/RemoteSimulation.hpp"
22 using simgrid::mc::remote;
25 XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
27 int MC_random(int min, int max)
30 xbt_assert(mc_model_checker == nullptr);
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);
39 void wait_for_requests()
42 xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
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 const s_smx_simcall* req = &process->simcall_;
48 if (req->call_ != simix::Simcall::NONE && not simgrid::mc::request_is_visible(req))
49 process->simcall_handle(0);
53 xbt_dynar_reset(simix_global->actors_vector);
54 for (std::pair<const 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);
60 /** @brief returns if there this transition can proceed in a finite amount of time
62 * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
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.
71 // Called from both MCer and MCed:
72 bool actor_is_enabled(smx_actor_t actor)
76 // If in the MCer, ask the client app since it has all the data
77 if (mc_model_checker != nullptr) {
78 return simgrid::mc::session->actor_is_enabled(actor->get_pid());
83 // Now, we are in the client app, no need for remote memory reading.
84 smx_simcall_t req = &actor->simcall_;
86 if (req->inspector_ != nullptr)
87 return req->inspector_->is_enabled();
94 case Simcall::COMM_WAIT: {
95 /* FIXME: check also that src and dst processes are not suspended */
96 const kernel::activity::CommImpl* act = simcall_comm_wait__getraw__comm(req);
98 if (act->src_timeout_ || act->dst_timeout_) {
99 /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
100 * because even if the communication is not ready, it can timeout and won't block. */
101 if (_sg_mc_timeout == 1)
104 /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
105 else if (act->detached() && act->src_actor_ == nullptr &&
106 act->type_ == simgrid::kernel::activity::CommImpl::Type::READY)
107 return (act->dst_actor_ != nullptr);
108 return (act->src_actor_ && act->dst_actor_);
111 case Simcall::COMM_WAITANY: {
112 simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(req);
113 size_t count = simcall_comm_waitany__get__count(req);
114 for (unsigned int index = 0; index < count; ++index) {
115 auto const* comm = comms[index];
116 if (comm->src_actor_ && comm->dst_actor_)
122 case Simcall::MUTEX_LOCK: {
123 const kernel::activity::MutexImpl* mutex = simcall_mutex_lock__get__mutex(req);
125 if (mutex->get_owner() == nullptr)
127 return mutex->get_owner()->get_pid() == req->issuer_->get_pid();
130 case Simcall::SEM_ACQUIRE: {
131 static int warned = 0;
133 XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
138 case Simcall::COND_WAIT: {
139 static int warned = 0;
141 XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
147 /* The rest of the requests are always enabled */
152 /* This is the list of requests that are visible from the checker algorithm.
153 * Any other requests are handled right away on the application side.
155 bool request_is_visible(const s_smx_simcall* req)
158 xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
161 using simix::Simcall;
162 return (req->inspector_ != nullptr && req->inspector_->is_visible()) || req->call_ == Simcall::COMM_ISEND ||
163 req->call_ == Simcall::COMM_IRECV || req->call_ == Simcall::COMM_WAIT || req->call_ == Simcall::COMM_WAITANY ||
164 req->call_ == Simcall::COMM_TEST || req->call_ == Simcall::COMM_TESTANY || req->call_ == Simcall::MC_RANDOM ||
165 req->call_ == Simcall::MUTEX_LOCK || req->call_ == Simcall::MUTEX_TRYLOCK ||
166 req->call_ == Simcall::MUTEX_UNLOCK;
172 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
174 if (not MC_is_active() && not MC_record_replay_is_active()) {
175 static simgrid::xbt::random::XbtRandom prng;
176 return prng.uniform_int(min, max);
178 return simcall->mc_value_;