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 /* Stateful model checking */
33 if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
34 system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
35 *remote_app.get_remote_process_memory());
38 State::State(RemoteApp& remote_app, std::shared_ptr<State> parent_state)
39 : num_(++expended_states_), parent_state_(parent_state)
42 if (_sg_mc_strategy == "none")
43 strategy_ = std::make_shared<BasicStrategy>();
44 if (_sg_mc_strategy == "nb_wait")
45 strategy_ = std::make_shared<WaitStrategy>();
46 *strategy_ = *(parent_state->strategy_);
48 recipe_ = std::list(parent_state_->get_recipe());
49 recipe_.push_back(parent_state_->get_transition());
51 remote_app.get_actors_status(strategy_->actors_to_run_);
53 /* Stateful model checking */
54 if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
55 system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
56 *remote_app.get_remote_process_memory());
58 /* If we want sleep set reduction, copy the sleep set and eventually removes things from it */
59 if (_sg_mc_sleep_set) {
60 /* For each actor in the previous sleep set, keep it if it is not dependent with current transition.
61 * And if we kept it and the actor is enabled in this state, mark the actor as already done, so that
62 * it is not explored*/
63 for (auto& [aid, transition] : parent_state_->get_sleep_set()) {
64 if (not parent_state_->get_transition()->depends(&transition)) {
65 sleep_set_.try_emplace(aid, transition);
66 if (strategy_->actors_to_run_.count(aid) != 0) {
67 XBT_DEBUG("Actor %ld will not be explored, for it is in the sleep set", aid);
69 strategy_->actors_to_run_.at(aid).mark_done();
72 XBT_DEBUG("Transition >>%s<< removed from the sleep set because it was dependent with >>%s<<",
73 transition.to_string().c_str(), parent_state_->get_transition()->to_string().c_str());
78 std::size_t State::count_todo() const
80 return boost::range::count_if(this->strategy_->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
83 std::size_t State::count_todo_multiples() const
86 for (auto& [_, actor] : strategy_->actors_to_run_)
88 count += actor.get_times_not_considered();
93 Transition* State::get_transition() const
98 aid_t State::next_transition() const
100 XBT_DEBUG("Search for an actor to run. %zu actors to consider", strategy_->actors_to_run_.size());
101 for (auto const& [aid, actor] : strategy_->actors_to_run_) {
102 XBT_DEBUG("Current penalty for actor %ld:%f", aid, strategy_->penalties_[aid]);
103 /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
104 if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
105 if (not actor.is_todo())
106 XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
108 if (not actor.is_enabled())
109 XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
112 XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
122 std::pair<aid_t, double> State::next_transition_guided() const
124 for (auto const& [aid, actor] : strategy_->actors_to_run_) {
125 /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
126 if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
127 if (not actor.is_todo())
128 XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
130 if (not actor.is_enabled())
131 XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
134 XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
137 return strategy_->next_transition();
140 // This should be done in GuidedState, or at least interact with it
141 void State::execute_next(aid_t next, RemoteApp& app)
143 // First, warn the guide, so it knows how to build a proper child state
144 strategy_->execute_next(next, app);
146 // This actor is ready to be executed. Execution involves three phases:
148 // 1. Identify the appropriate ActorState to prepare for execution
149 // when simcall_handle will be called on it
150 auto& actor_state = strategy_->actors_to_run_.at(next);
151 const unsigned times_considered = actor_state.do_consider();
152 const auto* expected_executed_transition = actor_state.get_transition(times_considered);
153 xbt_assert(expected_executed_transition != nullptr,
154 "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
156 XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
158 // 2. Execute the actor according to the preparation above
159 Transition::executed_transitions_++;
160 auto* just_executed = app.handle_simcall(next, times_considered, true);
161 xbt_assert(just_executed->type_ == expected_executed_transition->type_,
162 "The transition that was just executed by actor %ld, viz:\n"
164 "is not what was purportedly scheduled to execute, which was:\n"
166 next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
168 // 3. Update the state with the newest information. This means recording
170 // 1. what action was last taken from this state (viz. `executed_transition`)
171 // 2. what action actor `next` was able to take given `times_considered`
172 // The latter update is important as *more* information is potentially available
173 // about a transition AFTER it has executed.
174 transition_ = just_executed;
176 auto executed_transition = std::unique_ptr<Transition>(just_executed);
177 actor_state.set_transition(std::move(executed_transition), times_considered);
179 app.wait_for_requests();
181 } // namespace simgrid::mc