Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
A few calls to mc_model_checker less by passing more parameters
[simgrid.git] / src / mc / api / State.cpp
index cee599d..90045f5 100644 (file)
-/* Copyright (c) 2008-2022. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2008-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "src/mc/api/State.hpp"
-#include "src/mc/Session.hpp"
-#include "src/mc/api.hpp"
+#include "src/mc/explo/Exploration.hpp"
 #include "src/mc/mc_config.hpp"
 
 #include <boost/range/algorithm.hpp>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_state, mc, "Logging specific to MC states");
 
-using simgrid::mc::remote;
-using api = simgrid::mc::Api;
-
-namespace simgrid {
-namespace mc {
+namespace simgrid::mc {
 
 long State::expended_states_ = 0;
 
-State::State() : num_(++expended_states_)
+State::State(RemoteApp& remote_app) : num_(++expended_states_)
+{
+  remote_app.get_actors_status(actors_to_run_);
+
+  /* Stateful model checking */
+  if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
+    system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
+                                                            remote_app.get_remote_process_memory());
+}
+
+State::State(RemoteApp& remote_app, const State* parent_state)
+    :  num_(++expended_states_), parent_state_(parent_state)
 {
-  const unsigned long maxpid = api::get().get_maxpid();
-  actor_states_.resize(maxpid);
-  transition_.reset(new Transition());
+
+  remote_app.get_actors_status(actors_to_run_);
+
   /* Stateful model checking */
-  if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination) {
-    auto snapshot_ptr = api::get().take_snapshot(num_);
-    system_state_     = std::shared_ptr<simgrid::mc::Snapshot>(snapshot_ptr);
+  if ((_sg_mc_checkpoint > 0 && (num_ % _sg_mc_checkpoint == 0)) || _sg_mc_termination)
+    system_state_ = std::make_shared<simgrid::mc::Snapshot>(num_, remote_app.get_page_store(),
+                                                            remote_app.get_remote_process_memory());
+
+  
+  /* If we want sleep set reduction, copy the sleep set and eventually removes things from it */ 
+  if (_sg_mc_sleep_set) {      
+      /* For each actor in the previous sleep set, keep it if it is not dependent with current transition.
+       * And if we kept it and the actor is enabled in this state, mark the actor as already done, so that
+       * it is not explored*/
+      for (auto& [aid, transition] : parent_state_->get_sleep_set()) {
+
+         if (not parent_state_->get_transition()->depends(&transition)) {
+
+             sleep_set_.emplace(aid, transition);
+             if (actors_to_run_.count(aid) != 0) {
+                 XBT_DEBUG("Actor %ld will not be explored, for it is in the sleep set", aid);
+
+                 actors_to_run_.at(aid).mark_done();
+             }
+         } else
+             XBT_DEBUG("Transition >>%s<< removed from the sleep set because it was dependent with >>%s<<",
+                       transition.to_string().c_str(), parent_state_->get_transition()->to_string().c_str());
+      }
   }
 }
 
 std::size_t State::count_todo() const
 {
-  return boost::range::count_if(this->actor_states_, [](simgrid::mc::ActorState const& a) { return a.is_todo(); });
+  return boost::range::count_if(this->actors_to_run_, [](auto& pair) { return pair.second.is_todo(); });
+}
+
+void State::mark_all_enabled_todo()
+{
+  for (auto const& [aid, _] : this->get_actors_list()) {
+      if (this->is_actor_enabled(aid) and not is_actor_done(aid)) {
+      this->mark_todo(aid);
+    }
+  }
 }
 
 Transition* State::get_transition() const
 {
-  return transition_.get();
+  return transition_;
 }
 
-int State::next_transition() const
+aid_t State::next_transition() const
 {
-  std::vector<ActorInformation>& actors = mc_model_checker->get_remote_process().actors();
-  XBT_DEBUG("Search for an actor to run. %zu actors to consider", actors.size());
-  for (unsigned int i = 0; i < actors.size(); i++) {
-    aid_t aid                     = actors[i].copy.get_buffer()->get_pid();
-    const ActorState* actor_state = &actor_states_[aid];
-
-    /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application*/
-    if (not actor_state->is_todo() || not simgrid::mc::session_singleton->actor_is_enabled(aid))
+  XBT_DEBUG("Search for an actor to run. %zu actors to consider", actors_to_run_.size());
+  for (auto const& [aid, actor] : actors_to_run_) {
+    /* Only consider actors (1) marked as interleaving by the checker and (2) currently enabled in the application */
+    if (not actor.is_todo() || not actor.is_enabled() || actor.is_done()) {
+
+      if (not actor.is_todo())
+        XBT_DEBUG("Can't run actor %ld because it is not todo", aid);
+
+      if (not actor.is_enabled())
+        XBT_DEBUG("Can't run actor %ld because it is not enabled", aid);
+
+      if (actor.is_done())
+        XBT_DEBUG("Can't run actor %ld because it has already been done", aid);
+
       continue;
+    }
 
-    return i;
+    return aid;
   }
   return -1;
 }
-void State::execute_next(int next)
-{
-  std::vector<ActorInformation>& actors = mc_model_checker->get_remote_process().actors();
 
-  const kernel::actor::ActorImpl* actor = actors[next].copy.get_buffer();
-  aid_t aid                       = actor->get_pid();
-  int times_considered;
+void State::execute_next(aid_t next, RemoteApp& app)
+{
+  // This actor is ready to be executed. Execution involves three phases:
 
-  simgrid::mc::ActorState* actor_state = &actor_states_[aid];
-  /* This actor is ready to be executed. Prepare its execution when simcall_handle will be called on it */
-  times_considered = actor_state->get_times_considered_and_inc();
-  if (actor->simcall_.mc_max_consider_ <= actor_state->get_times_considered())
-    actor_state->set_done();
+  // 1. Identify the appropriate ActorState to prepare for execution
+  // when simcall_handle will be called on it
+  auto& actor_state                        = actors_to_run_.at(next);
+  const unsigned times_considered          = actor_state.do_consider();
+  const auto* expected_executed_transition = actor_state.get_transition(times_considered);
+  xbt_assert(expected_executed_transition != nullptr,
+             "Expected a transition with %u times considered to be noted in actor %ld", times_considered, next);
 
-  XBT_DEBUG("Let's run actor %ld (times_considered = %d)", aid, times_considered);
+  XBT_DEBUG("Let's run actor %ld (times_considered = %u)", next, times_considered);
 
+  // 2. Execute the actor according to the preparation above
   Transition::executed_transitions_++;
-
-  transition_.reset(mc_model_checker->handle_simcall(aid, times_considered, true));
-  mc_model_checker->wait_for_requests();
+  auto* just_executed = app.handle_simcall(next, times_considered, true);
+  xbt_assert(just_executed->type_ == expected_executed_transition->type_,
+             "The transition that was just executed by actor %ld, viz:\n"
+             "%s\n"
+             "is not what was purportedly scheduled to execute, which was:\n"
+             "%s\n",
+             next, just_executed->to_string().c_str(), expected_executed_transition->to_string().c_str());
+
+  // 3. Update the state with the newest information. This means recording
+  // both
+  //  1. what action was last taken from this state (viz. `executed_transition`)
+  //  2. what action actor `next` was able to take given `times_considered`
+  // The latter update is important as *more* information is potentially available
+  // about a transition AFTER it has executed.
+  transition_ = just_executed;
+
+  auto executed_transition = std::unique_ptr<Transition>(just_executed);
+  actor_state.set_transition(std::move(executed_transition), times_considered);
+
+  app.wait_for_requests();
 }
-} // namespace mc
-} // namespace simgrid
+} // namespace simgrid::mc