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