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