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/api/strategy/Strategy.hpp"
  12 #include "src/mc/transition/Transition.hpp"
  13
  14 #if SIMGRID_HAVE_STATEFUL_MC
  15 #include "src/mc/sosp/Snapshot.hpp"
  16 #endif
  17
  18 namespace simgrid::mc {
  19
  20 /* A node in the exploration graph (kind-of) */
  21 class XBT_PRIVATE State : public xbt::Extendable<State> {
  22   static long expended_states_; /* Count total amount of states, for stats */
  23
  24   /** @brief The outgoing transition is the last transition that we took to leave this state.  */
  25   std::shared_ptr<Transition> outgoing_transition_ = nullptr;
  26
  27   /** @brief The incoming transition is what led to this state, coming from its parent  */
  28   std::shared_ptr<Transition> incoming_transition_ = nullptr;
  29
  30   /** Sequential state ID (used for debugging) */
  31   long num_ = 0;
  32
  33   /** Snapshot of system state (if needed) */
  34   std::shared_ptr<Snapshot> system_state_;
  35
  36   /** Unique parent of this state. Required both for sleep set computation
  37       and for guided model-checking */
  38   std::shared_ptr<State> parent_state_ = nullptr;
  39
  40   std::shared_ptr<Strategy> strategy_;
  41
  42   /* Sleep sets are composed of the actor and the corresponding transition that made it being added to the sleep
  43    * set. With this information, it is check whether it should be removed from it or not when exploring a new
  44    * transition */
  45   std::map<aid_t, Transition> sleep_set_;
  46
  47 public:
  48   explicit State(RemoteApp& remote_app);
  49   explicit State(RemoteApp& remote_app, std::shared_ptr<State> parent_state);
  50   /* Returns a positive number if there is another transition to pick, or -1 if not */
  51   aid_t next_transition() const; // this function should disapear as it is redundant with the next one
  52
  53   /* Same as next_transition, but choice is now guided, and an integer corresponding to the
  54    internal cost of the transition is returned */
  55   std::pair<aid_t, int> next_transition_guided() const;
  56
  57   /**
  58    * @brief Explore a new path on the remote app; the parameter 'next' must be the result of a previous call to
  59    * next_transition()
  60    */
  61   std::shared_ptr<Transition> execute_next(aid_t next, RemoteApp& app);
  62
  63   long get_num() const { return num_; }
  64   std::size_t count_todo() const;
  65   std::size_t count_todo_multiples() const;
  66
  67   /* Marking as TODO some actor in this state:
  68    *  + consider_one mark aid actor (and assert it is possible)
  69    *  + consider_best ensure one actor is marked by eventually marking the best regarding its guiding methode
  70    *  + conside_all mark all enabled actor that are not done yet */
  71   void consider_one(aid_t aid) const { strategy_->consider_one(aid); }
  72   void consider_best() const { strategy_->consider_best(); }
  73   unsigned long consider_all() const { return strategy_->consider_all(); }
  74
  75   bool is_actor_done(aid_t actor) const { return strategy_->actors_to_run_.at(actor).is_done(); }
  76   std::shared_ptr<Transition> get_transition_out() const { return outgoing_transition_; }
  77   std::shared_ptr<Transition> get_transition_in() const { return incoming_transition_; }
  78   std::shared_ptr<State> get_parent_state() const { return parent_state_; }
  79
  80   std::map<aid_t, ActorState> const& get_actors_list() const { return strategy_->actors_to_run_; }
  81
  82   unsigned long get_actor_count() const { return strategy_->actors_to_run_.size(); }
  83   bool is_actor_enabled(aid_t actor) const { return strategy_->actors_to_run_.at(actor).is_enabled(); }
  84
  85   Snapshot* get_system_state() const { return system_state_.get(); }
  86   void set_system_state(std::shared_ptr<Snapshot> state) { system_state_ = std::move(state); }
  87
  88   std::map<aid_t, Transition> const& get_sleep_set() const { return sleep_set_; }
  89   void add_sleep_set(std::shared_ptr<Transition> t)
  90   {
  91     sleep_set_.insert_or_assign(t->aid_, Transition(t->type_, t->aid_, t->times_considered_));
  92   }
  93
  94   /* Returns the total amount of states created so far (for statistics) */
  95   static long get_expanded_states() { return expended_states_; }
  96 };
  97 } // namespace simgrid::mc
  98
  99 #endif