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 std::size_t State::count_todo() const
  28 {
  29   return boost::range::count_if(this->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
  30 }
  31
  32 Transition* State::get_transition() const
  33 {
  34   return transition_;
  35 }
  36
  37 aid_t State::next_transition() const
  38 {
  39   XBT_DEBUG("Search for an actor to run. %zu actors to consider", actors_to_run_.size());
  40   for (auto const& [aid, actor] : actors_to_run_) {
  41     /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
  42     if (not actor.is_todo() || not actor.is_enabled())
  43       continue;
  44
  45     return aid;
  46   }
  47   return -1;
  48 }
  49
  50 void State::execute_next(aid_t next)
  51 {
  52   // This actor is ready to be executed. Execution involves three phases:
  53
  54   // 1. Identify the appropriate ActorState to prepare for execution
  55   // when simcall_handle will be called on it
  56   auto& actor_state                        = actors_to_run_.at(next);
  57   const unsigned times_considered          = actor_state.do_consider();
  58   const auto* expected_executed_transition = actor_state.get_transition(times_considered);
  59   xbt_assert(expected_executed_transition != nullptr,
  60              "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
  61
  62   XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
  63
  64   // 2. Execute the actor according to the preparation above
  65   Transition::executed_transitions_++;
  66   auto* just_executed = mc_model_checker->handle_simcall(next, times_considered, true);
  67   xbt_assert(just_executed->type_ == expected_executed_transition->type_,
  68              "The transition that was just executed by actor %ld, viz:\n"
  69              "%s\n"
  70              "is not what was purportedly scheduled to execute, which was:\n"
  71              "%s\n",
  72              next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
  73
  74   // 3. Update the state with the newest information. This means recording
  75   // both
  76   //  1. what action was last taken from this state (viz. `executed_transition`)
  77   //  2. what action actor `next` was able to take given `times_considered`
  78   // The latter update is important as *more* information is potentially available
  79   // about a transition AFTER it has executed.
  80   transition_ = just_executed;
  81
  82   auto executed_transition = std::unique_ptr<Transition>(just_executed);
  83   actor_state.set_transition(std::move(executed_transition), times_considered);
  84
  85   mc_model_checker->wait_for_requests();
  86 }
  87 } // namespace simgrid::mc