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(const RemoteApp& remote_app) : default_transition(std::make_unique<Transition>()), num_(++expended_states_)
  18 {
  19   remote_app.get_actors_status(actors_to_run_);
  20
  21   transition_ = default_transition.get();
  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_);
  26   }
  27 }
  28
  29 State::State(const RemoteApp& remote_app, const State* previous_state) : num_(++expended_states_)
  30 {
  31
  32   remote_app.get_actors_status(actors_to_run_);
  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_);
  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       }
  53       else
  54           XBT_DEBUG("Transition >>%s<< removed from the sleep set because it was dependent with >>%s<<", transition.to_string().c_str(), previous_state->get_transition()->to_string().c_str());
  55
  56   }
  57
  58 }
  59
  60 std::size_t State::count_todo() const
  61 {
  62   return boost::range::count_if(this->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
  63 }
  64
  65 void State::mark_all_todo()
  66 {
  67     for (auto & [aid, actor] : actors_to_run_) {
  68
  69         if (actor.is_enabled() and not actor.is_done() and not actor.is_todo())
  70             actor.mark_todo();
  71
  72     }
  73 }
  74
  75 Transition* State::get_transition() const
  76 {
  77     if (transition_ == nullptr) {
  78         return default_transition.get();
  79     }
  80     return transition_;
  81 }
  82
  83 aid_t State::next_transition() const
  84 {
  85   XBT_DEBUG("Search for an actor to run. %zu actors to consider", actors_to_run_.size());
  86   for (auto const& [aid, actor] : actors_to_run_) {
  87     /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
  88       if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
  89
  90           if (not actor.is_todo())
  91               XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
  92
  93           if (not actor.is_enabled())
  94               XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
  95
  96           if (actor.is_done())
  97               XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
  98
  99
 100           continue;
 101
 102
 103       }
 104
 105     return aid;
 106   }
 107   return -1;
 108 }
 109
 110 void State::execute_next(aid_t next)
 111 {
 112   // This actor is ready to be executed. Execution involves three phases:
 113
 114   // 1. Identify the appropriate ActorState to prepare for execution
 115   // when simcall_handle will be called on it
 116   auto& actor_state                        = actors_to_run_.at(next);
 117   const unsigned times_considered          = actor_state.do_consider();
 118   const auto* expected_executed_transition = actor_state.get_transition(times_considered);
 119   xbt_assert(expected_executed_transition != nullptr,
 120              "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
 121
 122   XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
 123
 124   // 2. Execute the actor according to the preparation above
 125   Transition::executed_transitions_++;
 126   auto* just_executed = mc_model_checker->handle_simcall(next, times_considered, true);
 127   xbt_assert(just_executed->type_ == expected_executed_transition->type_,
 128              "The transition that was just executed by actor %ld, viz:\n"
 129              "%s\n"
 130              "is not what was purportedly scheduled to execute, which was:\n"
 131              "%s\n",
 132              next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
 133
 134   // 3. Update the state with the newest information. This means recording
 135   // both
 136   //  1. what action was last taken from this state (viz. `executed_transition`)
 137   //  2. what action actor `next` was able to take given `times_considered`
 138   // The latter update is important as *more* information is potentially available
 139   // about a transition AFTER it has executed.
 140   transition_ = just_executed;
 141
 142   auto executed_transition = std::unique_ptr<Transition>(just_executed);
 143   actor_state.set_transition(std::move(executed_transition), times_considered);
 144
 145   mc_model_checker->wait_for_requests();
 146 }
 147 } // namespace simgrid::mc