1 /* Copyright (c) 2007-2023. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_MC_STATE_HPP
7 #define SIMGRID_MC_STATE_HPP
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"
14 #if SIMGRID_HAVE_STATEFUL_MC
15 #include "src/mc/sosp/Snapshot.hpp"
18 namespace simgrid::mc {
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 */
24 /** @brief The outgoing transition is the last transition that we took to leave this state. */
25 std::shared_ptr<Transition> outgoing_transition_ = nullptr;
27 /** @brief The incoming transition is what led to this state, coming from its parent */
28 std::shared_ptr<Transition> incoming_transition_ = nullptr;
30 /** @brief A list of transition to be replayed in order to get in this state. */
31 std::deque<Transition*> recipe_{};
33 /** Sequential state ID (used for debugging) */
36 /** Snapshot of system state (if needed) */
37 std::shared_ptr<Snapshot> system_state_;
39 /** Unique parent of this state. Required both for sleep set computation
40 and for guided model-checking */
41 std::shared_ptr<State> parent_state_ = nullptr;
43 std::shared_ptr<Strategy> strategy_;
45 /* Sleep sets are composed of the actor and the corresponding transition that made it being added to the sleep
46 * set. With this information, it is check whether it should be removed from it or not when exploring a new
48 std::map<aid_t, Transition> sleep_set_;
51 explicit State(RemoteApp& remote_app);
52 explicit State(RemoteApp& remote_app, std::shared_ptr<State> parent_state);
53 /* Returns a positive number if there is another transition to pick, or -1 if not */
54 aid_t next_transition() const; // this function should disapear as it is redundant with the next one
56 /* Same as next_transition, but choice is now guided, and an integer corresponding to the
57 internal cost of the transition is returned */
58 std::pair<aid_t, int> next_transition_guided() const;
61 * @brief Explore a new path on the remote app; the parameter 'next' must be the result of a previous call to
64 std::shared_ptr<Transition> execute_next(aid_t next, RemoteApp& app);
66 long get_num() const { return num_; }
67 std::size_t count_todo() const;
68 std::size_t count_todo_multiples() const;
70 /* Marking as TODO some actor in this state:
71 * + consider_one mark aid actor (and assert it is possible)
72 * + consider_best ensure one actor is marked by eventually marking the best regarding its guiding methode
73 * + conside_all mark all enabled actor that are not done yet */
74 void consider_one(aid_t aid) const { strategy_->consider_one(aid); }
75 void consider_best() const { strategy_->consider_best(); }
76 unsigned long consider_all() const { return strategy_->consider_all(); }
78 bool is_actor_done(aid_t actor) const { return strategy_->actors_to_run_.at(actor).is_done(); }
79 std::shared_ptr<Transition> get_transition_out() const { return outgoing_transition_; }
80 std::shared_ptr<Transition> get_transition_in() const { return incoming_transition_; }
81 std::shared_ptr<State> get_parent_state() const { return parent_state_; }
82 std::deque<Transition*>& get_recipe();
84 std::map<aid_t, ActorState> const& get_actors_list() const { return strategy_->actors_to_run_; }
86 unsigned long get_actor_count() const { return strategy_->actors_to_run_.size(); }
87 bool is_actor_enabled(aid_t actor) const { return strategy_->actors_to_run_.at(actor).is_enabled(); }
89 Snapshot* get_system_state() const { return system_state_.get(); }
90 void set_system_state(std::shared_ptr<Snapshot> state) { system_state_ = std::move(state); }
92 std::map<aid_t, Transition> const& get_sleep_set() const { return sleep_set_; }
93 void add_sleep_set(std::shared_ptr<Transition> t)
95 sleep_set_.insert_or_assign(t->aid_, Transition(t->type_, t->aid_, t->times_considered_));
98 /* Returns the total amount of states created so far (for statistics) */
99 static long get_expanded_states() { return expended_states_; }
101 } // namespace simgrid::mc