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"
14 #include "src/simix/smx_private.hpp"
16 #include "xbt/random.hpp"
19 #include "src/mc/ModelChecker.hpp"
20 #include "src/mc/Session.hpp"
21 #include "src/mc/remote/RemoteProcess.hpp"
23 using simgrid::mc::remote;
26 XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
28 int MC_random(int min, int max)
31 xbt_assert(mc_model_checker == nullptr);
33 if (not MC_is_active() && not MC_record_replay_is_active()) { // no need to do a simcall in this case
34 static simgrid::xbt::random::XbtRandom prng;
35 return prng.uniform_int(min, max);
37 simgrid::kernel::actor::RandomSimcall observer{SIMIX_process_self(), min, max};
38 return simgrid::kernel::actor::simcall([&observer] { return observer.get_value(); }, &observer);
46 auto* engine = kernel::EngineImpl::get_instance();
48 xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
50 while (engine->has_actors_to_run()) {
51 engine->run_all_actors();
52 for (auto const& actor : engine->get_actors_that_ran()) {
53 const s_smx_simcall* req = &actor->simcall_;
54 if (req->call_ != simix::Simcall::NONE && not simgrid::mc::request_is_visible(req))
55 actor->simcall_handle(0);
59 engine->reset_actor_dynar();
60 for (auto const& kv : engine->get_actor_list()) {
61 auto actor = kv.second;
62 if (actor->simcall_.observer_ != nullptr)
63 actor->simcall_.mc_max_consider_ = actor->simcall_.observer_->get_max_consider();
64 engine->add_actor_to_dynar(actor);
69 /** @brief returns if there this transition can proceed in a finite amount of time
71 * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
73 * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
74 * Wait operations are OK and return true in only two situations:
75 * - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
76 * - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this
77 * transition for ever.
80 // Called from both MCer and MCed:
81 bool actor_is_enabled(smx_actor_t actor)
85 // If in the MCer, ask the client app since it has all the data
86 if (mc_model_checker != nullptr) {
87 return simgrid::mc::session_singleton->actor_is_enabled(actor->get_pid());
92 // Now, we are in the client app, no need for remote memory reading.
93 smx_simcall_t req = &actor->simcall_;
95 if (req->observer_ != nullptr)
96 return req->observer_->is_enabled();
103 case Simcall::COMM_WAIT: {
104 /* FIXME: check also that src and dst processes are not suspended */
105 const kernel::activity::CommImpl* act = simcall_comm_wait__getraw__comm(req);
107 if (act->src_timeout_ || act->dst_timeout_) {
108 /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
109 * because even if the communication is not ready, it can timeout and won't block. */
110 if (_sg_mc_timeout == 1)
113 /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
114 else if (act->detached() && act->src_actor_ == nullptr && act->state_ == simgrid::kernel::activity::State::READY)
115 return (act->dst_actor_ != nullptr);
116 return (act->src_actor_ && act->dst_actor_);
119 case Simcall::COMM_WAITANY: {
120 simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(req);
121 size_t count = simcall_comm_waitany__get__count(req);
122 for (unsigned int index = 0; index < count; ++index) {
123 auto const* comm = comms[index];
124 if (comm->src_actor_ && comm->dst_actor_)
131 /* The rest of the requests are always enabled */
136 /* This is the list of requests that are visible from the checker algorithm.
137 * Any other requests are handled right away on the application side.
139 bool request_is_visible(const s_smx_simcall* req)
142 xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
144 if (req->observer_ != nullptr)
145 return req->observer_->is_visible();
147 using simix::Simcall;
148 return req->call_ == Simcall::COMM_ISEND || req->call_ == Simcall::COMM_IRECV || req->call_ == Simcall::COMM_WAIT ||
149 req->call_ == Simcall::COMM_WAITANY || req->call_ == Simcall::COMM_TEST || req->call_ == Simcall::COMM_TESTANY;