Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Try to copy penalties correctly
[simgrid.git] / src / mc / api / State.cpp
1 /* Copyright (c) 2008-2023. The SimGrid Team. All rights reserved.          */
2
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. */
5
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"
11
12 #include <boost/range/algorithm.hpp>
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_state, mc, "Logging specific to MC states");
15
16 namespace simgrid::mc {
17
18 long State::expended_states_ = 0;
19
20 State::State(RemoteApp& remote_app) : num_(++expended_states_)
21 {
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>();
27
28   recipe_ = std::list<Transition*>();
29
30   remote_app.get_actors_status(strategy_->actors_to_run_);
31
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());
36 }
37
38 State::State(RemoteApp& remote_app, std::shared_ptr<State> parent_state)
39     : num_(++expended_states_), parent_state_(parent_state)
40 {
41
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_);
47
48   recipe_ = std::list(parent_state_->get_recipe());
49   recipe_.push_back(parent_state_->get_transition());
50
51   remote_app.get_actors_status(strategy_->actors_to_run_);
52
53   for (auto const& [aid, _] : strategy_->actors_to_run_)
54     strategy_->penalties_[aid] = parent_state_->strategy_->penalties_[aid];
55
56   /* Stateful model checking */
57   if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
58     system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
59                                                             *remote_app.get_remote_process_memory());
60
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);
71
72           strategy_->actors_to_run_.at(aid).mark_done();
73         }
74       } else
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());
77     }
78   }
79 }
80
81 std::size_t State::count_todo() const
82 {
83   return boost::range::count_if(this->strategy_->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
84 }
85
86 std::size_t State::count_todo_multiples() const
87 {
88   size_t count = 0;
89   for (auto& [_, actor] : strategy_->actors_to_run_)
90     if (actor.is_todo())
91       count += actor.get_times_not_considered();
92
93   return count;
94 }
95
96 Transition* State::get_transition() const
97 {
98   return transition_;
99 }
100
101 aid_t State::next_transition() const
102 {
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);
109
110       if (not actor.is_enabled())
111         XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
112
113       if (actor.is_done())
114         XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
115
116       continue;
117     }
118
119     return aid;
120   }
121   return -1;
122 }
123
124 std::pair<aid_t, double> State::next_transition_guided() const
125 {
126
127   for (auto const& [aid, penalty] : strategy_->penalties_)
128     XBT_DEBUG("Current penalty for actor %ld:%f", aid, strategy_->penalties_[aid]);
129
130   for (auto const& [aid, actor] : strategy_->actors_to_run_) {
131
132     /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
133     if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
134
135       if (not actor.is_todo())
136         XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
137
138       if (not actor.is_enabled())
139         XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
140
141       if (actor.is_done())
142         XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
143     }
144   }
145   return strategy_->next_transition();
146 }
147
148 // This should be done in GuidedState, or at least interact with it
149 void State::execute_next(aid_t next, RemoteApp& app)
150 {
151   // First, warn the guide, so it knows how to build a proper child state
152   strategy_->execute_next(next, app);
153
154   // This actor is ready to be executed. Execution involves three phases:
155
156   // 1. Identify the appropriate ActorState to prepare for execution
157   // when simcall_handle will be called on it
158   auto& actor_state                        = strategy_->actors_to_run_.at(next);
159   const unsigned times_considered          = actor_state.do_consider();
160   const auto* expected_executed_transition = actor_state.get_transition(times_considered);
161   xbt_assert(expected_executed_transition != nullptr,
162              "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
163
164   XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
165
166   // 2. Execute the actor according to the preparation above
167   Transition::executed_transitions_++;
168   auto* just_executed = app.handle_simcall(next, times_considered, true);
169   xbt_assert(just_executed->type_ == expected_executed_transition->type_,
170              "The transition that was just executed by actor %ld, viz:\n"
171              "%s\n"
172              "is not what was purportedly scheduled to execute, which was:\n"
173              "%s\n",
174              next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
175
176   // 3. Update the state with the newest information. This means recording
177   // both
178   //  1. what action was last taken from this state (viz. `executed_transition`)
179   //  2. what action actor `next` was able to take given `times_considered`
180   // The latter update is important as *more* information is potentially available
181   // about a transition AFTER it has executed.
182   transition_ = just_executed;
183
184   auto executed_transition = std::unique_ptr<Transition>(just_executed);
185   actor_state.set_transition(std::move(executed_transition), times_considered);
186
187   app.wait_for_requests();
188 }
189 } // namespace simgrid::mc