src/mc/api/State.hpp

   1 /* Copyright (c) 2007-2022. 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/mc_pattern.hpp"
  10 #include "src/mc/sosp/Snapshot.hpp"
  11 #include "src/mc/transition/Transition.hpp"
  12
  13 namespace simgrid::mc {
  14
  15 /* A node in the exploration graph (kind-of) */
  16 class XBT_PRIVATE State : public xbt::Extendable<State> {
  17   static long expended_states_; /* Count total amount of states, for stats */
  18
  19   /* Outgoing transition: what was the last transition that we took to leave this state? */
  20   std::unique_ptr<Transition> transition_;
  21
  22   /** Sequential state number (used for debugging) */
  23   long num_ = 0;
  24
  25   /** State's exploration status by process */
  26   std::vector<ActorState> actor_states_;
  27
  28   /** Snapshot of system state (if needed) */
  29   std::shared_ptr<Snapshot> system_state_;
  30
  31 public:
  32   explicit State();
  33
  34   /* Returns a positive number if there is another transition to pick, or -1 if not */
  35   int next_transition() const;
  36
  37   /* Explore a new path; the parameter must be the result of a previous call to next_transition() */
  38   void execute_next(int next);
  39
  40   long get_num() const { return num_; }
  41   std::size_t count_todo() const;
  42   void mark_todo(aid_t actor) { this->actor_states_[actor].mark_todo(); }
  43   bool is_done(aid_t actor) const { return this->actor_states_[actor].is_done(); }
  44   Transition* get_transition() const;
  45   void set_transition(Transition* t) { transition_.reset(t); }
  46
  47   Snapshot* get_system_state() const { return system_state_.get(); }
  48   void set_system_state(std::shared_ptr<Snapshot> state) { system_state_ = std::move(state); }
  49
  50   /* Returns the total amount of states created so far (for statistics) */
  51   static long get_expanded_states() { return expended_states_; }
  52 };
  53 } // namespace simgrid::mc
  54
  55 #endif