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