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/guide/BasicGuide.hpp"
8 #include "src/mc/explo/Exploration.hpp"
9 #include "src/mc/mc_config.hpp"
11 #include <boost/range/algorithm.hpp>
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_state, mc, "Logging specific to MC states");
15 namespace simgrid::mc {
17 long State::expended_states_ = 0;
19 State::State(RemoteApp& remote_app) : num_(++expended_states_), guide(std::make_unique<BasicGuide>())
21 remote_app.get_actors_status(guide->actors_to_run_);
23 /* Stateful model checking */
24 if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
25 system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
26 *remote_app.get_remote_process_memory());
29 State::State(RemoteApp& remote_app, const State* parent_state)
30 : num_(++expended_states_), parent_state_(parent_state), guide(std::make_unique<BasicGuide>())
32 remote_app.get_actors_status(guide->actors_to_run_);
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(),
37 *remote_app.get_remote_process_memory());
39 /* If we want sleep set reduction, copy the sleep set and eventually removes things from it */
40 if (_sg_mc_sleep_set) {
41 /* For each actor in the previous sleep set, keep it if it is not dependent with current transition.
42 * And if we kept it and the actor is enabled in this state, mark the actor as already done, so that
43 * it is not explored*/
44 for (auto& [aid, transition] : parent_state_->get_sleep_set()) {
45 if (not parent_state_->get_transition()->depends(&transition)) {
46 sleep_set_.try_emplace(aid, transition);
47 if (guide->actors_to_run_.count(aid) != 0) {
48 XBT_DEBUG("Actor %ld will not be explored, for it is in the sleep set", aid);
50 guide->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(), parent_state_->get_transition()->to_string().c_str());
59 std::size_t State::count_todo() const
61 return boost::range::count_if(this->guide->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
64 Transition* State::get_transition() const
69 aid_t State::next_transition() const
71 XBT_DEBUG("Search for an actor to run. %zu actors to consider", guide->actors_to_run_.size());
72 for (auto const& [aid, actor] : guide->actors_to_run_) {
73 /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
74 if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
75 if (not actor.is_todo())
76 XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
78 if (not actor.is_enabled())
79 XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
82 XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
92 std::pair<aid_t, double> State::next_transition_guided() const
94 return guide->next_transition();
97 // This should be done in GuidedState, or at least interact with it
98 void State::execute_next(aid_t next, RemoteApp& app)
100 // This actor is ready to be executed. Execution involves three phases:
102 // 1. Identify the appropriate ActorState to prepare for execution
103 // when simcall_handle will be called on it
104 auto& actor_state = guide->actors_to_run_.at(next);
105 const unsigned times_considered = actor_state.do_consider();
106 const auto* expected_executed_transition = actor_state.get_transition(times_considered);
107 xbt_assert(expected_executed_transition != nullptr,
108 "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
110 XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
112 // 2. Execute the actor according to the preparation above
113 Transition::executed_transitions_++;
114 auto* just_executed = app.handle_simcall(next, times_considered, true);
115 xbt_assert(just_executed->type_ == expected_executed_transition->type_,
116 "The transition that was just executed by actor %ld, viz:\n"
118 "is not what was purportedly scheduled to execute, which was:\n"
120 next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
122 // 3. Update the state with the newest information. This means recording
124 // 1. what action was last taken from this state (viz. `executed_transition`)
125 // 2. what action actor `next` was able to take given `times_considered`
126 // The latter update is important as *more* information is potentially available
127 // about a transition AFTER it has executed.
128 transition_ = just_executed;
130 auto executed_transition = std::unique_ptr<Transition>(just_executed);
131 actor_state.set_transition(std::move(executed_transition), times_considered);
133 app.wait_for_requests();
135 } // namespace simgrid::mc