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