-/* Copyright (c) 2008-2022. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2008-2023. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef SIMGRID_MC_SAFETY_CHECKER_HPP
#define SIMGRID_MC_SAFETY_CHECKER_HPP
-#include "src/mc/VisitedState.hpp"
+#include "src/mc/api/State.hpp"
#include "src/mc/explo/Exploration.hpp"
-#include "src/mc/mc_safety.hpp"
+
+#if SIMGRID_HAVE_STATEFUL_MC
+#include "src/mc/VisitedState.hpp"
+#endif
#include <list>
#include <memory>
+#include <set>
#include <string>
#include <vector>
-namespace simgrid {
-namespace mc {
+namespace simgrid::mc {
+
+typedef std::list<std::shared_ptr<State>> stack_t;
+
+/* Used to compare two stacks and decide which one is better to backtrack,
+ * regarding the chosen guide in the last state. */
+class OpenedStatesCompare {
+public:
+ bool operator()(std::shared_ptr<State> const& lhs, std::shared_ptr<State> const& rhs) const
+ {
+ return lhs->next_transition_guided().second > rhs->next_transition_guided().second;
+ }
+};
class XBT_PRIVATE DFSExplorer : public Exploration {
- ReductionMode reductionMode_ = ReductionMode::unset;
- long backtrack_count_ = 0;
- static xbt::signal<void()> on_exploration_start_signal;
- static xbt::signal<void()> on_backtracking_signal;
+ XBT_DECLARE_ENUM_CLASS(ReductionMode, none, dpor);
+
+ ReductionMode reduction_mode_;
+ unsigned long backtrack_count_ = 0; // for statistics
+ unsigned long visited_states_count_ = 0; // for statistics
+
+ static xbt::signal<void(RemoteApp&)> on_exploration_start_signal;
+ static xbt::signal<void(RemoteApp&)> on_backtracking_signal;
- static xbt::signal<void(State*)> on_state_creation_signal;
+ static xbt::signal<void(State*, RemoteApp&)> on_state_creation_signal;
- static xbt::signal<void(State*)> on_restore_system_state_signal;
- static xbt::signal<void()> on_restore_initial_state_signal;
- static xbt::signal<void(Transition*)> on_transition_replay_signal;
- static xbt::signal<void(Transition*)> on_transition_execute_signal;
+ static xbt::signal<void(State*, RemoteApp&)> on_restore_system_state_signal;
+ static xbt::signal<void(RemoteApp&)> on_restore_initial_state_signal;
+ static xbt::signal<void(Transition*, RemoteApp&)> on_transition_replay_signal;
+ static xbt::signal<void(Transition*, RemoteApp&)> on_transition_execute_signal;
- static xbt::signal<void()> on_log_state_signal;
+ static xbt::signal<void(RemoteApp&)> on_log_state_signal;
public:
- explicit DFSExplorer(Session* session);
+ explicit DFSExplorer(const std::vector<char*>& args, bool with_dpor, bool need_memory_info = false);
void run() override;
RecordTrace get_record_trace() override;
std::vector<std::string> get_textual_trace() override;
void log_state() override;
/** Called once when the exploration starts */
- static void on_exploration_start(std::function<void()> const& f) { on_exploration_start_signal.connect(f); }
+ static void on_exploration_start(std::function<void(RemoteApp& remote_app)> const& f)
+ {
+ on_exploration_start_signal.connect(f);
+ }
/** Called each time that the exploration backtracks from a exploration end */
- static void on_backtracking(std::function<void()> const& f) { on_backtracking_signal.connect(f); }
+ static void on_backtracking(std::function<void(RemoteApp& remote_app)> const& f)
+ {
+ on_backtracking_signal.connect(f);
+ }
/** Called each time that a new state is create */
- static void on_state_creation(std::function<void(State*)> const& f) { on_state_creation_signal.connect(f); }
+ static void on_state_creation(std::function<void(State*, RemoteApp& remote_app)> const& f)
+ {
+ on_state_creation_signal.connect(f);
+ }
/** Called when rollbacking directly onto a previously checkpointed state */
- static void on_restore_system_state(std::function<void(State*)> const& f)
+ static void on_restore_system_state(std::function<void(State*, RemoteApp& remote_app)> const& f)
{
on_restore_system_state_signal.connect(f);
}
/** Called when the state to which we backtrack was not checkpointed state, forcing us to restore the initial state
* before replaying some transitions */
- static void on_restore_initial_state(std::function<void()> const& f) { on_restore_initial_state_signal.connect(f); }
+ static void on_restore_initial_state(std::function<void(RemoteApp& remote_app)> const& f)
+ {
+ on_restore_initial_state_signal.connect(f);
+ }
/** Called when replaying a transition that was previously executed, to reach a backtracked state */
- static void on_transition_replay(std::function<void(Transition*)> const& f)
+ static void on_transition_replay(std::function<void(Transition*, RemoteApp& remote_app)> const& f)
{
on_transition_replay_signal.connect(f);
}
/** Called when executing a new transition */
- static void on_transition_execute(std::function<void(Transition*)> const& f)
+ static void on_transition_execute(std::function<void(Transition*, RemoteApp& remote_app)> const& f)
{
on_transition_execute_signal.connect(f);
}
/** Called when displaying the statistics at the end of the exploration */
- static void on_log_state(std::function<void()> const& f) { on_log_state_signal.connect(f); }
+ static void on_log_state(std::function<void(RemoteApp&)> const& f) { on_log_state_signal.connect(f); }
private:
void check_non_termination(const State* current_state);
void backtrack();
- void restore_state();
/** Stack representing the position in the exploration graph */
- std::list<std::unique_ptr<State>> stack_;
+ stack_t stack_;
+#if SIMGRID_HAVE_STATEFUL_MC
VisitedStates visited_states_;
std::unique_ptr<VisitedState> visited_state_;
+#else
+ void* visited_state_ = nullptr; /* The code uses it to detect whether we are doing stateful MC */
+#endif
+
+ /** Opened states are states that still contains todo actors.
+ * When backtracking, we pick a state from it*/
+ std::multiset<std::shared_ptr<State>, OpenedStatesCompare> opened_states_;
+
+ /** Change current stack_ value to correspond to the one we would have
+ * had if we executed transition to get to state. This is required when
+ * backtracking, and achieved thanks to the fact states save their parent.*/
+ void restore_stack(std::shared_ptr<State> state);
+
+ RecordTrace get_record_trace_of_stack(stack_t stack);
};
-} // namespace mc
-} // namespace simgrid
+} // namespace simgrid::mc
#endif
