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.hpp"
8 #include "src/kernel/EngineImpl.hpp"
9 #include "src/kernel/activity/CommImpl.hpp"
10 #include "src/kernel/activity/MutexImpl.hpp"
11 #include "src/kernel/actor/SimcallObserver.hpp"
12 #include "src/mc/mc_config.hpp"
13 #include "src/mc/mc_replay.hpp"
15 #include "xbt/random.hpp"
18 #include "src/mc/ModelChecker.hpp"
19 #include "src/mc/Session.hpp"
20 #include "src/mc/remote/RemoteProcess.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 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);
36 simgrid::kernel::actor::RandomSimcall observer{simgrid::kernel::actor::ActorImpl::self(), min, max};
37 return simgrid::kernel::actor::simcall([&observer] { return observer.get_value(); }, &observer);
45 auto* engine = kernel::EngineImpl::get_instance();
47 xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
49 while (engine->has_actors_to_run()) {
50 engine->run_all_actors();
51 for (auto const& actor : engine->get_actors_that_ran()) {
52 const s_smx_simcall* req = &actor->simcall_;
53 if (req->call_ != simix::Simcall::NONE && not simgrid::mc::request_is_visible(req))
54 actor->simcall_handle(0);
58 engine->reset_actor_dynar();
59 for (auto const& kv : engine->get_actor_list()) {
60 auto actor = kv.second;
61 if (actor->simcall_.observer_ != nullptr)
62 actor->simcall_.mc_max_consider_ = actor->simcall_.observer_->get_max_consider();
63 engine->add_actor_to_dynar(actor);
68 /** @brief returns if there this transition can proceed in a finite amount of time
70 * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
72 * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
73 * Wait operations are OK and return true in only two situations:
74 * - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
75 * - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this
76 * transition for ever.
79 // Called from both MCer and MCed:
80 bool actor_is_enabled(smx_actor_t actor)
84 // If in the MCer, ask the client app since it has all the data
85 if (mc_model_checker != nullptr) {
86 return simgrid::mc::session_singleton->actor_is_enabled(actor->get_pid());
91 // Now, we are in the client app, no need for remote memory reading.
92 smx_simcall_t req = &actor->simcall_;
94 if (req->observer_ != nullptr)
95 return req->observer_->is_enabled();
102 case Simcall::COMM_WAIT: {
103 /* FIXME: check also that src and dst processes are not suspended */
104 const kernel::activity::CommImpl* act = simcall_comm_wait__getraw__comm(req);
106 if (act->src_timeout_ || act->dst_timeout_) {
107 /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
108 * because even if the communication is not ready, it can timeout and won't block. */
109 if (_sg_mc_timeout == 1)
112 /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
113 else if (act->detached() && act->src_actor_ == nullptr && act->state_ == simgrid::kernel::activity::State::READY)
114 return (act->dst_actor_ != nullptr);
115 return (act->src_actor_ && act->dst_actor_);
118 case Simcall::COMM_WAITANY: {
119 simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(req);
120 size_t count = simcall_comm_waitany__get__count(req);
121 for (unsigned int index = 0; index < count; ++index) {
122 auto const* comm = comms[index];
123 if (comm->src_actor_ && comm->dst_actor_)
130 /* The rest of the requests are always enabled */
135 /* This is the list of requests that are visible from the checker algorithm.
136 * Any other requests are handled right away on the application side.
138 bool request_is_visible(const s_smx_simcall* req)
141 xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
143 if (req->observer_ != nullptr)
144 return req->observer_->is_visible();
146 using simix::Simcall;
147 return req->call_ == Simcall::COMM_ISEND || req->call_ == Simcall::COMM_IRECV || req->call_ == Simcall::COMM_WAIT ||
148 req->call_ == Simcall::COMM_WAITANY || req->call_ == Simcall::COMM_TEST || req->call_ == Simcall::COMM_TESTANY;