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 #if SIMGRID_HAVE_STATEFUL_MC
  33   /* Stateful model checking */
  34   if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
  35     system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
  36                                                             *remote_app.get_remote_process_memory());
  37 #endif
  38 }
  39
  40 State::State(RemoteApp& remote_app, std::shared_ptr<State> parent_state)
  41     : num_(++expended_states_), parent_state_(parent_state)
  42 {
  43   if (_sg_mc_strategy == "none")
  44     strategy_ = std::make_shared<BasicStrategy>();
  45   if (_sg_mc_strategy == "nb_wait")
  46     strategy_ = std::make_shared<WaitStrategy>();
  47   *strategy_ = *(parent_state->strategy_);
  48
  49   recipe_ = std::list(parent_state_->get_recipe());
  50   recipe_.push_back(parent_state_->get_transition());
  51
  52   remote_app.get_actors_status(strategy_->actors_to_run_);
  53
  54 #if SIMGRID_HAVE_STATEFUL_MC /* Stateful model checking */
  55   if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
  56     system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
  57                                                             *remote_app.get_remote_process_memory());
  58 #endif
  59
  60   /* If we want sleep set reduction, copy the sleep set and eventually removes things from it */
  61   if (_sg_mc_sleep_set) {
  62     /* For each actor in the previous sleep set, keep it if it is not dependent with current transition.
  63      * And if we kept it and the actor is enabled in this state, mark the actor as already done, so that
  64      * it is not explored*/
  65     for (auto& [aid, transition] : parent_state_->get_sleep_set()) {
  66       if (not parent_state_->get_transition()->depends(&transition)) {
  67         sleep_set_.try_emplace(aid, transition);
  68         if (strategy_->actors_to_run_.count(aid) != 0) {
  69           XBT_DEBUG("Actor %ld will not be explored, for it is in the sleep set", aid);
  70
  71           strategy_->actors_to_run_.at(aid).mark_done();
  72         }
  73       } else
  74         XBT_DEBUG("Transition >>%s<< removed from the sleep set because it was dependent with >>%s<<",
  75                   transition.to_string().c_str(), parent_state_->get_transition()->to_string().c_str());
  76     }
  77   }
  78 }
  79
  80 std::size_t State::count_todo() const
  81 {
  82   return boost::range::count_if(this->strategy_->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
  83 }
  84
  85 std::size_t State::count_todo_multiples() const
  86 {
  87   size_t count = 0;
  88   for (auto& [_, actor] : strategy_->actors_to_run_)
  89     if (actor.is_todo())
  90       count += actor.get_times_not_considered();
  91
  92   return count;
  93 }
  94
  95 Transition* State::get_transition() const
  96 {
  97   return transition_;
  98 }
  99
 100 aid_t State::next_transition() const
 101 {
 102   XBT_DEBUG("Search for an actor to run. %zu actors to consider", strategy_->actors_to_run_.size());
 103   for (auto const& [aid, actor] : strategy_->actors_to_run_) {
 104     /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
 105     if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
 106       if (not actor.is_todo())
 107         XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
 108
 109       if (not actor.is_enabled())
 110         XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
 111
 112       if (actor.is_done())
 113         XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
 114
 115       continue;
 116     }
 117
 118     return aid;
 119   }
 120   return -1;
 121 }
 122
 123 std::pair<aid_t, int> State::next_transition_guided() const
 124 {
 125   return strategy_->next_transition();
 126 }
 127
 128 // This should be done in GuidedState, or at least interact with it
 129 void State::execute_next(aid_t next, RemoteApp& app)
 130 {
 131   // First, warn the guide, so it knows how to build a proper child state
 132   strategy_->execute_next(next, app);
 133
 134   // This actor is ready to be executed. Execution involves three phases:
 135
 136   // 1. Identify the appropriate ActorState to prepare for execution
 137   // when simcall_handle will be called on it
 138   auto& actor_state                        = strategy_->actors_to_run_.at(next);
 139   const unsigned times_considered          = actor_state.do_consider();
 140   const auto* expected_executed_transition = actor_state.get_transition(times_considered);
 141   xbt_assert(expected_executed_transition != nullptr,
 142              "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
 143
 144   XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
 145
 146   // 2. Execute the actor according to the preparation above
 147   Transition::executed_transitions_++;
 148   auto* just_executed = app.handle_simcall(next, times_considered, true);
 149   xbt_assert(just_executed->type_ == expected_executed_transition->type_,
 150              "The transition that was just executed by actor %ld, viz:\n"
 151              "%s\n"
 152              "is not what was purportedly scheduled to execute, which was:\n"
 153              "%s\n",
 154              next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
 155
 156   // 3. Update the state with the newest information. This means recording
 157   // both
 158   //  1. what action was last taken from this state (viz. `executed_transition`)
 159   //  2. what action actor `next` was able to take given `times_considered`
 160   // The latter update is important as *more* information is potentially available
 161   // about a transition AFTER it has executed.
 162   transition_ = just_executed;
 163
 164   auto executed_transition = std::unique_ptr<Transition>(just_executed);
 165   actor_state.set_transition(std::move(executed_transition), times_considered);
 166
 167   app.wait_for_requests();
 168 }
 169 } // namespace simgrid::mc