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