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