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/WaitStrategy.hpp"
9 #include "src/mc/explo/Exploration.hpp"
10 #include "src/mc/mc_config.hpp"
12 #include <boost/range/algorithm.hpp>
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_state, mc, "Logging specific to MC states");
16 namespace simgrid::mc {
18 long State::expended_states_ = 0;
20 State::State(RemoteApp& remote_app) : num_(++expended_states_)
22 XBT_VERB("Creating a guide for the state");
23 if (_sg_mc_strategy == "none")
24 strategy_ = std::make_shared<BasicStrategy>();
25 if (_sg_mc_strategy == "nb_wait")
26 strategy_ = std::make_shared<WaitStrategy>();
28 recipe_ = std::list<Transition*>();
30 remote_app.get_actors_status(strategy_->actors_to_run_);
32 #if SIMGRID_HAVE_STATEFUL_MC
33 /* Stateful model checking */
34 if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
35 system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
36 *remote_app.get_remote_process_memory());
40 State::State(RemoteApp& remote_app, std::shared_ptr<State> parent_state)
41 : num_(++expended_states_), parent_state_(parent_state)
44 if (_sg_mc_strategy == "none")
45 strategy_ = std::make_shared<BasicStrategy>();
46 if (_sg_mc_strategy == "nb_wait")
47 strategy_ = std::make_shared<WaitStrategy>();
48 *strategy_ = *(parent_state->strategy_);
50 recipe_ = std::list(parent_state_->get_recipe());
51 recipe_.push_back(parent_state_->get_transition());
53 remote_app.get_actors_status(strategy_->actors_to_run_);
55 #if SIMGRID_HAVE_STATEFUL_MC /* Stateful model checking */
56 if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
57 system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
58 *remote_app.get_remote_process_memory());
61 /* If we want sleep set reduction, copy the sleep set and eventually removes things from it */
62 if (_sg_mc_sleep_set) {
63 /* For each actor in the previous sleep set, keep it if it is not dependent with current transition.
64 * And if we kept it and the actor is enabled in this state, mark the actor as already done, so that
65 * it is not explored*/
66 for (auto& [aid, transition] : parent_state_->get_sleep_set()) {
67 if (not parent_state_->get_transition()->depends(&transition)) {
68 sleep_set_.try_emplace(aid, transition);
69 if (strategy_->actors_to_run_.count(aid) != 0) {
70 XBT_DEBUG("Actor %ld will not be explored, for it is in the sleep set", aid);
72 strategy_->actors_to_run_.at(aid).mark_done();
75 XBT_DEBUG("Transition >>%s<< removed from the sleep set because it was dependent with >>%s<<",
76 transition.to_string().c_str(), parent_state_->get_transition()->to_string().c_str());
81 std::size_t State::count_todo() const
83 return boost::range::count_if(this->strategy_->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
86 std::size_t State::count_todo_multiples() const
89 for (auto& [_, actor] : strategy_->actors_to_run_)
91 count += actor.get_times_not_considered();
96 Transition* State::get_transition() const
101 aid_t State::next_transition() const
103 XBT_DEBUG("Search for an actor to run. %zu actors to consider", strategy_->actors_to_run_.size());
104 for (auto const& [aid, actor] : strategy_->actors_to_run_) {
105 /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
106 if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
107 if (not actor.is_todo())
108 XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
110 if (not actor.is_enabled())
111 XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
114 XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
124 std::pair<aid_t, int> State::next_transition_guided() const
126 return strategy_->next_transition();
129 // This should be done in GuidedState, or at least interact with it
130 void State::execute_next(aid_t next, RemoteApp& app)
132 // First, warn the guide, so it knows how to build a proper child state
133 strategy_->execute_next(next, app);
135 // This actor is ready to be executed. Execution involves three phases:
137 // 1. Identify the appropriate ActorState to prepare for execution
138 // when simcall_handle will be called on it
139 auto& actor_state = strategy_->actors_to_run_.at(next);
140 const unsigned times_considered = actor_state.do_consider();
141 const auto* expected_executed_transition = actor_state.get_transition(times_considered);
142 xbt_assert(expected_executed_transition != nullptr,
143 "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
145 XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
147 // 2. Execute the actor according to the preparation above
148 Transition::executed_transitions_++;
149 auto* just_executed = app.handle_simcall(next, times_considered, true);
150 xbt_assert(just_executed->type_ == expected_executed_transition->type_,
151 "The transition that was just executed by actor %ld, viz:\n"
153 "is not what was purportedly scheduled to execute, which was:\n"
155 next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
157 // 3. Update the state with the newest information. This means recording
159 // 1. what action was last taken from this state (viz. `executed_transition`)
160 // 2. what action actor `next` was able to take given `times_considered`
161 // The latter update is important as *more* information is potentially available
162 // about a transition AFTER it has executed.
163 transition_ = just_executed;
165 auto executed_transition = std::unique_ptr<Transition>(just_executed);
166 actor_state.set_transition(std::move(executed_transition), times_considered);
168 app.wait_for_requests();
170 } // namespace simgrid::mc