1 /* Copyright (c) 2008-2023. 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/api/State.hpp"
7 #include "src/mc/api/strategy/BasicStrategy.hpp"
8 #include "src/mc/api/strategy/MaxMatchComm.hpp"
9 #include "src/mc/api/strategy/MinMatchComm.hpp"
10 #include "src/mc/api/strategy/UniformStrategy.hpp"
11 #include "src/mc/explo/Exploration.hpp"
12 #include "src/mc/mc_config.hpp"
14 #include <boost/range/algorithm.hpp>
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_state, mc, "Logging specific to MC states");
18 namespace simgrid::mc {
20 long State::expended_states_ = 0;
22 State::State(RemoteApp& remote_app) : num_(++expended_states_)
24 XBT_VERB("Creating a guide for the state");
26 srand(_sg_mc_random_seed);
28 if (_sg_mc_strategy == "none")
29 strategy_ = std::make_shared<BasicStrategy>();
30 else if (_sg_mc_strategy == "max_match_comm")
31 strategy_ = std::make_shared<MaxMatchComm>();
32 else if (_sg_mc_strategy == "min_match_comm")
33 strategy_ = std::make_shared<MinMatchComm>();
34 else if (_sg_mc_strategy == "uniform") {
35 strategy_ = std::make_shared<UniformStrategy>();
39 remote_app.get_actors_status(strategy_->actors_to_run_);
41 #if SIMGRID_HAVE_STATEFUL_MC
42 /* Stateful model checking */
43 if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
44 system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
45 *remote_app.get_remote_process_memory());
49 State::State(RemoteApp& remote_app, std::shared_ptr<State> parent_state)
50 : incoming_transition_(parent_state->get_transition_out()), num_(++expended_states_), parent_state_(parent_state)
53 if (_sg_mc_strategy == "none")
54 strategy_ = std::make_shared<BasicStrategy>();
55 else if (_sg_mc_strategy == "max_match_comm")
56 strategy_ = std::make_shared<MaxMatchComm>();
57 else if (_sg_mc_strategy == "min_match_comm")
58 strategy_ = std::make_shared<MinMatchComm>();
59 else if (_sg_mc_strategy == "uniform") {
60 strategy_ = std::make_shared<UniformStrategy>();
63 strategy_->copy_from(parent_state_->strategy_.get());
65 remote_app.get_actors_status(strategy_->actors_to_run_);
67 #if SIMGRID_HAVE_STATEFUL_MC /* Stateful model checking */
68 if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
69 system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
70 *remote_app.get_remote_process_memory());
73 /* If we want sleep set reduction, copy the sleep set and eventually removes things from it */
74 if (_sg_mc_sleep_set) {
75 /* For each actor in the previous sleep set, keep it if it is not dependent with current transition.
76 * And if we kept it and the actor is enabled in this state, mark the actor as already done, so that
77 * it is not explored*/
78 for (auto& [aid, transition] : parent_state_->get_sleep_set()) {
79 if (not incoming_transition_->depends(&transition)) {
80 sleep_set_.try_emplace(aid, transition);
81 if (strategy_->actors_to_run_.count(aid) != 0) {
82 XBT_DEBUG("Actor %ld will not be explored, for it is in the sleep set", aid);
84 strategy_->actors_to_run_.at(aid).mark_done();
87 XBT_DEBUG("Transition >>%s<< removed from the sleep set because it was dependent with incoming >>%s<<",
88 transition.to_string().c_str(), incoming_transition_->to_string().c_str());
93 std::size_t State::count_todo() const
95 return boost::range::count_if(this->strategy_->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
98 std::size_t State::count_todo_multiples() const
101 for (auto const& [_, actor] : strategy_->actors_to_run_)
103 count += actor.get_times_not_considered();
108 aid_t State::next_transition() const
110 XBT_DEBUG("Search for an actor to run. %zu actors to consider", strategy_->actors_to_run_.size());
111 for (auto const& [aid, actor] : strategy_->actors_to_run_) {
112 /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
113 if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
114 if (not actor.is_todo())
115 XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
117 if (not actor.is_enabled())
118 XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
121 XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
131 std::pair<aid_t, int> State::next_transition_guided() const
133 return strategy_->next_transition();
136 // This should be done in GuidedState, or at least interact with it
137 std::shared_ptr<Transition> State::execute_next(aid_t next, RemoteApp& app)
139 // First, warn the guide, so it knows how to build a proper child state
140 strategy_->execute_next(next, app);
142 // This actor is ready to be executed. Execution involves three phases:
144 // 1. Identify the appropriate ActorState to prepare for execution
145 // when simcall_handle will be called on it
146 auto& actor_state = strategy_->actors_to_run_.at(next);
147 const unsigned times_considered = actor_state.do_consider();
148 const auto* expected_executed_transition = actor_state.get_transition(times_considered);
149 xbt_assert(expected_executed_transition != nullptr,
150 "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
152 XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
154 // 2. Execute the actor according to the preparation above
155 Transition::executed_transitions_++;
156 auto* just_executed = app.handle_simcall(next, times_considered, true);
157 xbt_assert(just_executed->type_ == expected_executed_transition->type_,
158 "The transition that was just executed by actor %ld, viz:\n"
160 "is not what was purportedly scheduled to execute, which was:\n"
162 next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
164 // 3. Update the state with the newest information. This means recording
166 // 1. what action was last taken from this state (viz. `executed_transition`)
167 // 2. what action actor `next` was able to take given `times_considered`
168 // The latter update is important as *more* information is potentially available
169 // about a transition AFTER it has executed.
170 outgoing_transition_ = std::shared_ptr<Transition>(just_executed);
172 actor_state.set_transition(outgoing_transition_, times_considered);
173 app.wait_for_requests();
175 return outgoing_transition_;
177 } // namespace simgrid::mc