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 An empty transition that leads to this state by default
  22    */
  23   const std::unique_ptr<Transition> default_transition_ = std::make_unique<Transition>();
  24
  25   /**
  26    * @brief The outgoing transition: what was the last transition that
  27    * we took to leave this state?
  28    *
  29    * The owner of the transition is the `ActorState` instance which exists in this state,
  30    * or a reference to the internal default transition `Transition()` if no transition has been
  31    * set
  32    */
  33   Transition* transition_ = default_transition_.get();
  34
  35   /** Sequential state ID (used for debugging) */
  36   long num_ = 0;
  37
  38   /** State's exploration status by actor. Not all the actors are there, only the ones that are ready-to-run in this
  39    * state */
  40   std::map<aid_t, ActorState> actors_to_run_;
  41
  42   /** Snapshot of system state (if needed) */
  43   std::shared_ptr<Snapshot> system_state_;
  44
  45   /** Unique parent of this state. Required both for sleep set computation
  46       and for guided model-checking */
  47   const State* parent_state_;
  48
  49   /* Sleep sets are composed of the actor and the corresponding transition that made it being added to the sleep
  50    * set. With this information, it is check whether it should be removed from it or not when exploring a new
  51    * transition */
  52   std::map<aid_t, Transition> sleep_set_;
  53
  54 public:
  55   explicit State(RemoteApp& remote_app);
  56   explicit State(RemoteApp& remote_app, const State* parent_state);
  57   /* Returns a positive number if there is another transition to pick, or -1 if not */
  58   aid_t next_transition() const;
  59
  60   /* Explore a new path on the remote app; the parameter 'next' must be the result of a previous call to
  61    * next_transition() */
  62   void execute_next(aid_t next, RemoteApp& app);
  63
  64   long get_num() const { return num_; }
  65   std::size_t count_todo() const;
  66   void mark_todo(aid_t actor) { actors_to_run_.at(actor).mark_todo(); }
  67   void mark_all_enabled_todo();
  68   bool is_actor_done(aid_t actor) const { return actors_to_run_.at(actor).is_done(); }
  69   Transition* get_transition() const;
  70   void set_transition(Transition* t) { transition_ = t; }
  71   std::map<aid_t, ActorState> const& get_actors_list() const { return actors_to_run_; }
  72
  73   unsigned long get_actor_count() const { return actors_to_run_.size(); }
  74   bool is_actor_enabled(aid_t actor) { return actors_to_run_.at(actor).is_enabled(); }
  75
  76   Snapshot* get_system_state() const { return system_state_.get(); }
  77   void set_system_state(std::shared_ptr<Snapshot> state) { system_state_ = std::move(state); }
  78
  79   std::map<aid_t, Transition> const& get_sleep_set() const { return sleep_set_; }
  80   void add_sleep_set(Transition* t) {sleep_set_.insert_or_assign(t->aid_, Transition(t->type_, t->aid_, t->times_considered_)); }
  81
  82   /* Returns the total amount of states created so far (for statistics) */
  83   static long get_expanded_states() { return expended_states_; }
  84 };
  85 } // namespace simgrid::mc
  86
  87 #endif