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