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