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