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) : 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_);
  24   }
  25 }
  26
  27 State::State(const RemoteApp& remote_app, const State* previous_state) : num_(++expended_states_)
  28 {
  29
  30   remote_app.get_actors_status(actors_to_run_);
  31
  32   transition_.reset(new Transition());
  33   /* Stateful model checking */
  34   if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination) {
  35     system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_);
  36   }
  37
  38   /* For each actor in the previous sleep set, keep it if it is not dependent with current transition.
  39    * And if we kept it and the actor is enabled in this state, mark the actor as already done, so that
  40    * it is not explored*/
  41   for (auto & [aid, transition] : previous_state->get_sleep_set()) {
  42
  43       if (not previous_state->get_transition()->depends(&transition)) {
  44
  45           sleep_set_.emplace(aid, transition);
  46           if (actors_to_run_.count(aid) != 0) {
  47               XBT_DEBUG("Actor %ld will not be explored, for it is in the sleep set", aid);
  48
  49               actors_to_run_.at(aid).mark_done();
  50           }
  51       }
  52       else
  53           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());
  54
  55   }
  56
  57 }
  58
  59 std::size_t State::count_todo() const
  60 {
  61   return boost::range::count_if(this->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
  62 }
  63
  64 void State::mark_all_todo()
  65 {
  66     for (auto & [aid, actor] : actors_to_run_) {
  67
  68         if (actor.is_enabled() and not actor.is_done() and not actor.is_todo())
  69             actor.mark_todo();
  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
  96           continue;
  97
  98
  99       }
 100
 101     return aid;
 102   }
 103   return -1;
 104 }
 105
 106 void State::execute_next(aid_t next)
 107 {
 108   // This actor is ready to be executed. Execution involves three phases:
 109
 110   // 1. Identify the appropriate ActorState to prepare for execution
 111   // when simcall_handle will be called on it
 112   auto& actor_state                        = actors_to_run_.at(next);
 113   const unsigned times_considered          = actor_state.do_consider();
 114   const auto* expected_executed_transition = actor_state.get_transition(times_considered);
 115   xbt_assert(expected_executed_transition != nullptr,
 116              "Expected a transition with %d times considered to be noted in actor %lu", times_considered, next);
 117
 118   XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
 119
 120   // 2. Execute the actor according to the preparation above
 121   Transition::executed_transitions_++;
 122   auto* just_executed = mc_model_checker->handle_simcall(next, times_considered, true);
 123   xbt_assert(just_executed->type_ == expected_executed_transition->type_,
 124              "The transition that was just executed by actor %lu, viz:\n"
 125              "%s\n"
 126              "is not what was purportedly scheduled to execute, which was:\n"
 127              "%s\n",
 128              next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
 129
 130   // 3. Update the state with the newest information. This means recording
 131   // both
 132   //  1. what action was last taken from this state (viz. `executed_transition`)
 133   //  2. what action actor `next` was able to take given `times_considered`
 134   // The latter update is important as *more* information is potentially available
 135   // about a transition AFTER it has executed.
 136   transition_ = just_executed;
 137
 138   auto executed_transition = std::unique_ptr<Transition>(just_executed);
 139   actor_state.set_transition(std::move(executed_transition), times_considered);
 140
 141   mc_model_checker->wait_for_requests();
 142 }
 143 } // namespace simgrid::mc