Document more changes, and update the Release Notes

[simgrid.git] / src / mc / api / State.hpp

diff --git a/src/mc/api/State.hpp b/src/mc/api/State.hpp
index ddca326..7303b64 100644 (file)
--- a/src/mc/api/State.hpp
+++ b/src/mc/api/State.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2022. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-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. */
@@ -7,6 +7,7 @@
 #define SIMGRID_MC_STATE_HPP
 
 #include "src/mc/api/ActorState.hpp"
+#include "src/mc/api/RemoteApp.hpp"
 #include "src/mc/sosp/Snapshot.hpp"
 #include "src/mc/transition/Transition.hpp"
 
@@ -16,20 +17,33 @@ namespace simgrid::mc {
 class XBT_PRIVATE State : public xbt::Extendable<State> {
   static long expended_states_; /* Count total amount of states, for stats */
 
-  /* Outgoing transition: what was the last transition that we took to leave this state? */
-  std::unique_ptr<Transition> transition_;
+  /**
+   * @brief An empty transition that leads to this state by default
+   */
+  const std::unique_ptr<Transition> default_transition_ = std::make_unique<Transition>();
+
+  /**
+   * @brief The outgoing transition: what was the last transition that
+   * we took to leave this state?
+   *
+   * The owner of the transition is the `ActorState` instance which exists in this state,
+   * or a reference to the internal default transition `Transition()` if no transition has been
+   * set
+   */
+  Transition* transition_ = default_transition_.get();
 
   /** Sequential state ID (used for debugging) */
   long num_ = 0;
 
-  /** State's exploration status by actor. Not all the actors are there, only the ones that are ready-to-run in this state */
+  /** State's exploration status by actor. Not all the actors are there, only the ones that are ready-to-run in this
+   * state */
   std::map<aid_t, ActorState> actors_to_run_;
 
   /** Snapshot of system state (if needed) */
   std::shared_ptr<Snapshot> system_state_;
 
 public:
-  explicit State(Session& session);
+  explicit State(const RemoteApp& remote_app);
 
   /* Returns a positive number if there is another transition to pick, or -1 if not */
   aid_t next_transition() const;
@@ -40,13 +54,14 @@ public:
   long get_num() const { return num_; }
   std::size_t count_todo() const;
   void mark_todo(aid_t actor) { actors_to_run_.at(actor).mark_todo(); }
+  void mark_all_enabled_todo();
   bool is_done(aid_t actor) const { return actors_to_run_.at(actor).is_done(); }
   Transition* get_transition() const;
-  void set_transition(Transition* t) { transition_.reset(t); }
-  std::map<aid_t, ActorState> const& get_actors_list() { return actors_to_run_; }
+  void set_transition(Transition* t) { transition_ = t; }
+  std::map<aid_t, ActorState> const& get_actors_list() const { return actors_to_run_; }
 
-  int get_actor_count() { return actors_to_run_.size(); }
-  bool is_actor_enabled(int actor) { return actors_to_run_.at(actor).is_enabled(); }
+  unsigned long get_actor_count() const { return actors_to_run_.size(); }
+  bool is_actor_enabled(aid_t actor) { return actors_to_run_.at(actor).is_enabled(); }
 
   Snapshot* get_system_state() const { return system_state_.get(); }
   void set_system_state(std::shared_ptr<Snapshot> state) { system_state_ = std::move(state); }