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
  69       if (not parent_state_->get_transition()->depends(&transition)) {
  70
  71         sleep_set_.try_emplace(aid, transition);
  72         if (guide_->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           guide_->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 >>%s<<",
  79                   transition.to_string().c_str(), parent_state_->get_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->guide_->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
  87 }
  88
  89 Transition* State::get_transition() const
  90 {
  91   return transition_;
  92 }
  93
  94 aid_t State::next_transition() const
  95 {
  96   XBT_DEBUG("Search for an actor to run. %zu actors to consider", guide_->actors_to_run_.size());
  97   for (auto const& [aid, actor] : guide_->actors_to_run_) {
  98     /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
  99     if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
 100
 101       if (not actor.is_todo())
 102         XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
 103
 104       if (not actor.is_enabled())
 105         XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
 106
 107       if (actor.is_done())
 108         XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
 109
 110       continue;
 111     }
 112
 113     return aid;
 114   }
 115   return -1;
 116 }
 117
 118 std::pair<aid_t, double> State::next_transition_guided() const
 119 {
 120   return guide_->next_transition();
 121 }
 122
 123 // This should be done in GuidedState, or at least interact with it
 124 void State::execute_next(aid_t next, RemoteApp& app)
 125 {
 126   // First, warn the guide, so it knows how to build a proper child state
 127   guide_->execute_next(next, app);
 128
 129   // This actor is ready to be executed. Execution involves three phases:
 130
 131   // 1. Identify the appropriate ActorState to prepare for execution
 132   // when simcall_handle will be called on it
 133   auto& actor_state                        = guide_->actors_to_run_.at(next);
 134   const unsigned times_considered          = actor_state.do_consider();
 135   const auto* expected_executed_transition = actor_state.get_transition(times_considered);
 136   xbt_assert(expected_executed_transition != nullptr,
 137              "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
 138
 139   XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
 140
 141   // 2. Execute the actor according to the preparation above
 142   Transition::executed_transitions_++;
 143   auto* just_executed = app.handle_simcall(next, times_considered, true);
 144   xbt_assert(just_executed->type_ == expected_executed_transition->type_,
 145              "The transition that was just executed by actor %ld, viz:\n"
 146              "%s\n"
 147              "is not what was purportedly scheduled to execute, which was:\n"
 148              "%s\n",
 149              next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
 150
 151   // 3. Update the state with the newest information. This means recording
 152   // both
 153   //  1. what action was last taken from this state (viz. `executed_transition`)
 154   //  2. what action actor `next` was able to take given `times_considered`
 155   // The latter update is important as *more* information is potentially available
 156   // about a transition AFTER it has executed.
 157   transition_ = just_executed;
 158
 159   auto executed_transition = std::unique_ptr<Transition>(just_executed);
 160   actor_state.set_transition(std::move(executed_transition), times_considered);
 161
 162   app.wait_for_requests();
 163 }
 164 } // namespace simgrid::mc