Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'fix-mc-tests' into 'master'
[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/mc_config.hpp"
8
9 #include <boost/range/algorithm.hpp>
10
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_state, mc, "Logging specific to MC states");
12
13 namespace simgrid::mc {
14
15 long State::expended_states_ = 0;
16
17 State::State(const RemoteApp& remote_app) : default_transition(std::make_unique<Transition>()), num_(++expended_states_)
18 {
19   remote_app.get_actors_status(actors_to_run_);
20
21   transition_ = default_transition.get();
22
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_);
26   }
27 }
28
29 std::size_t State::count_todo() const
30 {
31   return boost::range::count_if(this->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
32 }
33
34 Transition* State::get_transition() const
35 {
36   if (transition_ == nullptr) {
37     return default_transition.get();
38   }
39   return transition_;
40 }
41
42 aid_t State::next_transition() const
43 {
44   XBT_DEBUG("Search for an actor to run. %zu actors to consider", actors_to_run_.size());
45   for (auto const& [aid, actor] : actors_to_run_) {
46     /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
47     if (not actor.is_todo() || not actor.is_enabled())
48       continue;
49
50     return aid;
51   }
52   return -1;
53 }
54
55 void State::execute_next(aid_t next)
56 {
57   // This actor is ready to be executed. Execution involves three phases:
58
59   // 1. Identify the appropriate ActorState to prepare for execution
60   // when simcall_handle will be called on it
61   auto& actor_state                        = actors_to_run_.at(next);
62   const unsigned times_considered          = actor_state.do_consider();
63   const auto* expected_executed_transition = actor_state.get_transition(times_considered);
64   xbt_assert(expected_executed_transition != nullptr,
65              "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
66
67   XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
68
69   // 2. Execute the actor according to the preparation above
70   Transition::executed_transitions_++;
71   auto* just_executed = mc_model_checker->handle_simcall(next, times_considered, true);
72   xbt_assert(just_executed->type_ == expected_executed_transition->type_,
73              "The transition that was just executed by actor %ld, viz:\n"
74              "%s\n"
75              "is not what was purportedly scheduled to execute, which was:\n"
76              "%s\n",
77              next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
78
79   // 3. Update the state with the newest information. This means recording
80   // both
81   //  1. what action was last taken from this state (viz. `executed_transition`)
82   //  2. what action actor `next` was able to take given `times_considered`
83   // The latter update is important as *more* information is potentially available
84   // about a transition AFTER it has executed.
85   transition_ = just_executed;
86
87   auto executed_transition = std::unique_ptr<Transition>(just_executed);
88   actor_state.set_transition(std::move(executed_transition), times_considered);
89
90   mc_model_checker->wait_for_requests();
91 }
92 } // namespace simgrid::mc