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/mc_config.hpp"
9 #include <boost/range/algorithm.hpp>
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_state, mc, "Logging specific to MC states");
13 namespace simgrid::mc {
15 long State::expended_states_ = 0;
17 State::State(RemoteApp& remote_app) : num_(++expended_states_)
19 remote_app.get_actors_status(actors_to_run_);
21 /* Stateful model checking */
22 if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
23 system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store());
26 State::State(RemoteApp& remote_app, const State* previous_state)
27 : default_transition_(std::make_unique<Transition>()), num_(++expended_states_)
30 remote_app.get_actors_status(actors_to_run_);
32 transition_ = default_transition_.get();
34 /* Stateful model checking */
35 if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination) {
36 system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store());
39 /* For each actor in the previous sleep set, keep it if it is not dependent with current transition.
40 * And if we kept it and the actor is enabled in this state, mark the actor as already done, so that
41 * it is not explored*/
42 for (auto& [aid, transition] : previous_state->get_sleep_set()) {
44 if (not previous_state->get_transition()->depends(&transition)) {
46 sleep_set_.emplace(aid, transition);
47 if (actors_to_run_.count(aid) != 0) {
48 XBT_DEBUG("Actor %ld will not be explored, for it is in the sleep set", aid);
50 actors_to_run_.at(aid).mark_done();
53 XBT_DEBUG("Transition >>%s<< removed from the sleep set because it was dependent with >>%s<<",
54 transition.to_string().c_str(), previous_state->get_transition()->to_string().c_str());
58 std::size_t State::count_todo() const
60 return boost::range::count_if(this->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
63 void State::mark_all_enabled_todo()
65 for (auto const& [aid, _] : this->get_actors_list()) {
66 if (this->is_actor_enabled(aid) and not is_actor_done(aid)) {
72 Transition* State::get_transition() const
77 aid_t State::next_transition() const
79 XBT_DEBUG("Search for an actor to run. %zu actors to consider", actors_to_run_.size());
80 for (auto const& [aid, actor] : actors_to_run_) {
81 /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
82 if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
84 if (not actor.is_todo())
85 XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
87 if (not actor.is_enabled())
88 XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
91 XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
101 void State::execute_next(aid_t next)
103 // This actor is ready to be executed. Execution involves three phases:
105 // 1. Identify the appropriate ActorState to prepare for execution
106 // when simcall_handle will be called on it
107 auto& actor_state = actors_to_run_.at(next);
108 const unsigned times_considered = actor_state.do_consider();
109 const auto* expected_executed_transition = actor_state.get_transition(times_considered);
110 xbt_assert(expected_executed_transition != nullptr,
111 "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
113 XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
115 // 2. Execute the actor according to the preparation above
116 Transition::executed_transitions_++;
117 auto* just_executed = mc_model_checker->handle_simcall(next, times_considered, true);
118 xbt_assert(just_executed->type_ == expected_executed_transition->type_,
119 "The transition that was just executed by actor %ld, viz:\n"
121 "is not what was purportedly scheduled to execute, which was:\n"
123 next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
125 // 3. Update the state with the newest information. This means recording
127 // 1. what action was last taken from this state (viz. `executed_transition`)
128 // 2. what action actor `next` was able to take given `times_considered`
129 // The latter update is important as *more* information is potentially available
130 // about a transition AFTER it has executed.
131 transition_ = just_executed;
133 auto executed_transition = std::unique_ptr<Transition>(just_executed);
134 actor_state.set_transition(std::move(executed_transition), times_considered);
136 mc_model_checker->wait_for_requests();
138 } // namespace simgrid::mc