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/MaxMatchComm.hpp"
   9 #include "src/mc/api/strategy/MinMatchComm.hpp"
  10 #include "src/mc/api/strategy/UniformStrategy.hpp"
  11 #include "src/mc/explo/Exploration.hpp"
  12 #include "src/mc/mc_config.hpp"
  13 #include "xbt/random.hpp"
  14
  15 #include <algorithm>
  16 #include <boost/range/algorithm.hpp>
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_state, mc, "Logging specific to MC states");
  19
  20 namespace simgrid::mc {
  21
  22 long State::expended_states_ = 0;
  23
  24 State::State(RemoteApp& remote_app) : num_(++expended_states_)
  25 {
  26   XBT_VERB("Creating a guide for the state");
  27
  28
  29   if (_sg_mc_strategy == "none")
  30     strategy_ = std::make_shared<BasicStrategy>();
  31   else if (_sg_mc_strategy == "max_match_comm")
  32     strategy_ = std::make_shared<MaxMatchComm>();
  33   else if (_sg_mc_strategy == "min_match_comm")
  34     strategy_ = std::make_shared<MinMatchComm>();
  35   else if (_sg_mc_strategy == "uniform") {
  36     xbt::random::set_mersenne_seed(_sg_mc_random_seed);
  37     strategy_ = std::make_shared<UniformStrategy>();
  38   }
  39   else
  40     THROW_IMPOSSIBLE;
  41
  42   remote_app.get_actors_status(strategy_->actors_to_run_);
  43
  44 #if SIMGRID_HAVE_STATEFUL_MC
  45   /* Stateful model checking */
  46   if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
  47     system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
  48                                                             *remote_app.get_remote_process_memory());
  49 #endif
  50 }
  51
  52 State::State(RemoteApp& remote_app, std::shared_ptr<State> parent_state)
  53     : incoming_transition_(parent_state->get_transition_out()), num_(++expended_states_), parent_state_(parent_state)
  54 {
  55
  56    if (_sg_mc_strategy == "none")
  57     strategy_ = std::make_shared<BasicStrategy>();
  58   else if (_sg_mc_strategy == "max_match_comm")
  59     strategy_ = std::make_shared<MaxMatchComm>();
  60   else if (_sg_mc_strategy == "min_match_comm")
  61     strategy_ = std::make_shared<MinMatchComm>();
  62   else if (_sg_mc_strategy == "uniform")
  63     strategy_ = std::make_shared<UniformStrategy>();
  64   else
  65     THROW_IMPOSSIBLE;
  66   strategy_->copy_from(parent_state_->strategy_.get());
  67
  68   remote_app.get_actors_status(strategy_->actors_to_run_);
  69
  70 #if SIMGRID_HAVE_STATEFUL_MC /* Stateful model checking */
  71   if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
  72     system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
  73                                                             *remote_app.get_remote_process_memory());
  74 #endif
  75
  76   /* If we want sleep set reduction, copy the sleep set and eventually removes things from it */
  77   if (_sg_mc_sleep_set) {
  78     /* For each actor in the previous sleep set, keep it if it is not dependent with current transition.
  79      * And if we kept it and the actor is enabled in this state, mark the actor as already done, so that
  80      * it is not explored*/
  81     for (const auto& [aid, transition] : parent_state_->get_sleep_set()) {
  82       if (not incoming_transition_->depends(transition.get())) {
  83         sleep_set_.try_emplace(aid, transition);
  84         if (strategy_->actors_to_run_.count(aid) != 0) {
  85           XBT_DEBUG("Actor %ld will not be explored, for it is in the sleep set", aid);
  86           strategy_->actors_to_run_.at(aid).mark_done();
  87         }
  88       } else
  89         XBT_DEBUG("Transition >>%s<< removed from the sleep set because it was dependent with incoming >>%s<<",
  90                   transition->to_string().c_str(), incoming_transition_->to_string().c_str());
  91     }
  92   }
  93 }
  94
  95 std::size_t State::count_todo() const
  96 {
  97   return boost::range::count_if(this->strategy_->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
  98 }
  99
 100 std::size_t State::count_todo_multiples() const
 101 {
 102   size_t count = 0;
 103   for (auto const& [_, actor] : strategy_->actors_to_run_)
 104     if (actor.is_todo())
 105       count += actor.get_times_not_considered();
 106
 107   return count;
 108 }
 109
 110 aid_t State::next_transition() const
 111 {
 112   XBT_DEBUG("Search for an actor to run. %zu actors to consider", strategy_->actors_to_run_.size());
 113   for (auto const& [aid, actor] : strategy_->actors_to_run_) {
 114     /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
 115     if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
 116       if (not actor.is_todo())
 117         XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
 118
 119       if (not actor.is_enabled())
 120         XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
 121
 122       if (actor.is_done())
 123         XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
 124
 125       continue;
 126     }
 127
 128     return aid;
 129   }
 130   return -1;
 131 }
 132
 133 std::pair<aid_t, int> State::next_transition_guided() const
 134 {
 135   return strategy_->next_transition();
 136 }
 137
 138 aid_t State::next_odpor_transition() const
 139 {
 140   return wakeup_tree_.get_min_single_process_actor().value_or(-1);
 141 }
 142
 143 // This should be done in GuidedState, or at least interact with it
 144 std::shared_ptr<Transition> State::execute_next(aid_t next, RemoteApp& app)
 145 {
 146   // First, warn the guide, so it knows how to build a proper child state
 147   strategy_->execute_next(next, app);
 148
 149   // This actor is ready to be executed. Execution involves three phases:
 150
 151   // 1. Identify the appropriate ActorState to prepare for execution
 152   // when simcall_handle will be called on it
 153   auto& actor_state                        = strategy_->actors_to_run_.at(next);
 154   const unsigned times_considered          = actor_state.do_consider();
 155   const auto* expected_executed_transition = actor_state.get_transition(times_considered).get();
 156   xbt_assert(expected_executed_transition != nullptr,
 157              "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
 158
 159   XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
 160
 161   // 2. Execute the actor according to the preparation above
 162   Transition::executed_transitions_++;
 163   auto* just_executed = app.handle_simcall(next, times_considered, true);
 164   xbt_assert(just_executed->type_ == expected_executed_transition->type_,
 165              "The transition that was just executed by actor %ld, viz:\n"
 166              "%s\n"
 167              "is not what was purportedly scheduled to execute, which was:\n"
 168              "%s\n",
 169              next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
 170
 171   // 3. Update the state with the newest information. This means recording
 172   // both
 173   //  1. what action was last taken from this state (viz. `executed_transition`)
 174   //  2. what action actor `next` was able to take given `times_considered`
 175   // The latter update is important as *more* information is potentially available
 176   // about a transition AFTER it has executed.
 177   outgoing_transition_ = std::shared_ptr<Transition>(just_executed);
 178
 179   actor_state.set_transition(outgoing_transition_, times_considered);
 180   app.wait_for_requests();
 181
 182   return outgoing_transition_;
 183 }
 184
 185 std::unordered_set<aid_t> State::get_backtrack_set() const
 186 {
 187   std::unordered_set<aid_t> actors;
 188   for (const auto& [aid, state] : get_actors_list()) {
 189     if (state.is_todo() or state.is_done()) {
 190       actors.insert(aid);
 191     }
 192   }
 193   return actors;
 194 }
 195
 196 std::unordered_set<aid_t> State::get_sleeping_actors() const
 197 {
 198   std::unordered_set<aid_t> actors;
 199   for (const auto& [aid, _] : get_sleep_set()) {
 200     actors.insert(aid);
 201   }
 202   return actors;
 203 }
 204
 205 std::unordered_set<aid_t> State::get_enabled_actors() const
 206 {
 207   std::unordered_set<aid_t> actors;
 208   for (const auto& [aid, state] : get_actors_list()) {
 209     if (state.is_enabled()) {
 210       actors.insert(aid);
 211     }
 212   }
 213   return actors;
 214 }
 215
 216 void State::seed_wakeup_tree_if_needed(const odpor::Execution& prior)
 217 {
 218   // TODO: It would be better not to have such a flag.
 219   if (has_initialized_wakeup_tree) {
 220     return;
 221   }
 222   // TODO: Note that the next action taken by the actor may be updated
 223   // after it executes. But we will have already inserted it into the
 224   // tree and decided upon "happens-before" at that point for different
 225   // executions :(
 226   if (wakeup_tree_.empty()) {
 227     // Find an enabled transition to pick
 228     for (const auto& [_, actor] : get_actors_list()) {
 229       if (actor.is_enabled()) {
 230         // For each variant of the transition, we want
 231         // to insert the action into the tree. This ensures
 232         // that all variants are searched
 233         for (unsigned times = 0; times < actor.get_max_considered(); ++times) {
 234           wakeup_tree_.insert(prior, odpor::PartialExecution{actor.get_transition(times)});
 235         }
 236         break; // Only one actor gets inserted (see pseudocode)
 237       }
 238     }
 239   }
 240   has_initialized_wakeup_tree = true;
 241 }
 242
 243 void State::sprout_tree_from_parent_state()
 244 {
 245   xbt_assert(parent_state_ != nullptr, "Attempting to construct a wakeup tree for the root state "
 246                                        "(or what appears to be, rather for state without a parent defined)");
 247   const auto min_process_node = parent_state_->wakeup_tree_.get_min_single_process_node();
 248   xbt_assert(min_process_node.has_value(), "Attempting to construct a subtree for a substate from a "
 249                                            "parent with an empty wakeup tree. This indicates either that ODPOR "
 250                                            "actor selection in State.cpp is incorrect, or that the code "
 251                                            "deciding when to make subtrees in ODPOR is incorrect");
 252   xbt_assert((get_transition_in()->aid_ == min_process_node.value()->get_actor()) &&
 253                  (get_transition_in()->type_ == min_process_node.value()->get_action()->type_),
 254              "We tried to make a subtree from a parent state who claimed to have executed `%s` "
 255              "but whose wakeup tree indicates it should have executed `%s`. This indicates "
 256              "that exploration is not following ODPOR. Are you sure you're choosing actors "
 257              "to schedule from the wakeup tree?",
 258              get_transition_in()->to_string(false).c_str(),
 259              min_process_node.value()->get_action()->to_string(false).c_str());
 260   this->wakeup_tree_ = odpor::WakeupTree::make_subtree_rooted_at(min_process_node.value());
 261 }
 262
 263 void State::remove_subtree_using_current_out_transition()
 264 {
 265   if (auto out_transition = get_transition_out(); out_transition != nullptr) {
 266     if (const auto min_process_node = wakeup_tree_.get_min_single_process_node(); min_process_node.has_value()) {
 267       xbt_assert((out_transition->aid_ == min_process_node.value()->get_actor()) &&
 268                      (out_transition->type_ == min_process_node.value()->get_action()->type_),
 269                  "We tried to make a subtree from a parent state who claimed to have executed `%s` "
 270                  "but whose wakeup tree indicates it should have executed `%s`. This indicates "
 271                  "that exploration is not following ODPOR. Are you sure you're choosing actors "
 272                  "to schedule from the wakeup tree?",
 273                  out_transition->to_string(false).c_str(),
 274                  min_process_node.value()->get_action()->to_string(false).c_str());
 275     }
 276   }
 277   wakeup_tree_.remove_min_single_process_subtree();
 278 }
 279
 280 odpor::WakeupTree::InsertionResult State::insert_into_wakeup_tree(const odpor::PartialExecution& pe,
 281                                                                   const odpor::Execution& E)
 282 {
 283   return this->wakeup_tree_.insert(E, pe);
 284 }
 285
 286 void State::do_odpor_unwind()
 287 {
 288   if (auto out_transition = get_transition_out(); out_transition != nullptr) {
 289     remove_subtree_using_current_out_transition();
 290
 291     // Only when we've exhausted all variants of the transition which
 292     // can be chosen from this state do we finally add the actor to the
 293     // sleep set. This ensures that the current logic handling sleep sets
 294     // works with ODPOR in the way we intend it to work. There is not a
 295     // good way to perform transition equality in SimGrid; instead, we
 296     // effectively simply check for the presence of an actor in the sleep set.
 297     if (!get_actors_list().at(out_transition->aid_).has_more_to_consider())
 298       add_sleep_set(std::move(out_transition));
 299   }
 300 }
 301
 302 } // namespace simgrid::mc