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