src/mc/api/State.hpp

   1 /* Copyright (c) 2007-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 #ifndef SIMGRID_MC_STATE_HPP
   7 #define SIMGRID_MC_STATE_HPP
   8
   9 #include "src/mc/api/ActorState.hpp"
  10 #include "src/mc/api/RemoteApp.hpp"
  11 #include "src/mc/sosp/Snapshot.hpp"
  12 #include "src/mc/transition/Transition.hpp"
  13
  14 namespace simgrid::mc {
  15
  16 /* A node in the exploration graph (kind-of) */
  17 class XBT_PRIVATE State : public xbt::Extendable<State> {
  18   static long expended_states_; /* Count total amount of states, for stats */
  19
  20   /**
  21    * @brief The outgoing transition: what was the last transition that
  22    * we took to leave this state?
  23    *
  24    * The owner of the transition is the `ActorState` instance which exists in this state,
  25    * or nullptr if the state represents the root
  26    */
  27   Transition* transition_ = nullptr;
  28
  29   /** Sequential state ID (used for debugging) */
  30   long num_ = 0;
  31
  32   /** State's exploration status by actor. Not all the actors are there, only the ones that are ready-to-run in this
  33    * state */
  34   std::map<aid_t, ActorState> actors_to_run_;
  35
  36   /** Snapshot of system state (if needed) */
  37   std::shared_ptr<Snapshot> system_state_;
  38
  39 public:
  40   explicit State(const RemoteApp& remote_app);
  41
  42   /* Returns a positive number if there is another transition to pick, or -1 if not */
  43   aid_t next_transition() const;
  44
  45   /* Explore a new path; the parameter must be the result of a previous call to next_transition() */
  46   void execute_next(aid_t next);
  47
  48   long get_num() const { return num_; }
  49   std::size_t count_todo() const;
  50   void mark_todo(aid_t actor) { actors_to_run_.at(actor).mark_todo(); }
  51   bool is_done(aid_t actor) const { return actors_to_run_.at(actor).is_done(); }
  52   Transition* get_transition() const;
  53   void set_transition(Transition* t) { transition_ = t; }
  54   std::map<aid_t, ActorState> const& get_actors_list() const { return actors_to_run_; }
  55
  56   unsigned long get_actor_count() const { return actors_to_run_.size(); }
  57   bool is_actor_enabled(aid_t actor) { return actors_to_run_.at(actor).is_enabled(); }
  58
  59   Snapshot* get_system_state() const { return system_state_.get(); }
  60   void set_system_state(std::shared_ptr<Snapshot> state) { system_state_ = std::move(state); }
  61
  62   /* Returns the total amount of states created so far (for statistics) */
  63   static long get_expanded_states() { return expended_states_; }
  64 };
  65 } // namespace simgrid::mc
  66
  67 #endif