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   /* Outgoing transition: what was the last transition that we took to leave this state? */
  21   std::unique_ptr<Transition> transition_;
  22
  23   /** Sequential state ID (used for debugging) */
  24   long num_ = 0;
  25
  26   /** State's exploration status by actor. Not all the actors are there, only the ones that are ready-to-run in this state */
  27   std::map<aid_t, ActorState> actors_to_run_;
  28
  29   /** Snapshot of system state (if needed) */
  30   std::shared_ptr<Snapshot> system_state_;
  31
  32   std::map<aid_t, Transition> sleep_set_;
  33
  34 public:
  35   explicit State(const RemoteApp& remote_app);
  36   explicit State(const RemoteApp& remote_app, const State* previous_state);
  37   /* Returns a positive number if there is another transition to pick, or -1 if not */
  38   aid_t next_transition() const;
  39
  40   /* Explore a new path; the parameter must be the result of a previous call to next_transition() */
  41   void execute_next(aid_t next);
  42
  43   long get_num() const { return num_; }
  44   std::size_t count_todo() const;
  45   void mark_todo(aid_t actor) { actors_to_run_.at(actor).mark_todo(); }
  46   void mark_done(aid_t actor) { actors_to_run_.at(actor).mark_done();}
  47   void mark_all_todo();
  48   bool is_done(aid_t actor) const { return actors_to_run_.at(actor).is_done(); }
  49   Transition* get_transition() const;
  50   void set_transition(Transition* t) { transition_.reset(t); }
  51   std::map<aid_t, ActorState> const& get_actors_list() const { return actors_to_run_; }
  52
  53   unsigned long get_actor_count() const { return actors_to_run_.size(); }
  54   bool is_actor_enabled(aid_t actor) { return actors_to_run_.at(actor).is_enabled(); }
  55
  56   Snapshot* get_system_state() const { return system_state_.get(); }
  57   void set_system_state(std::shared_ptr<Snapshot> state) { system_state_ = std::move(state); }
  58
  59   std::map<aid_t, Transition> const& get_sleep_set() const { return sleep_set_; }
  60   void set_sleep_set(Transition* t) {sleep_set_.insert_or_assign(t->aid_, Transition(t->type_, t->aid_, t->times_considered_)); }
  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