src/mc/explo/DFSExplorer.hpp

   1 /* Copyright (c) 2008-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_SAFETY_CHECKER_HPP
   7 #define SIMGRID_MC_SAFETY_CHECKER_HPP
   8
   9 #include "src/mc/VisitedState.hpp"
  10 #include "src/mc/explo/Exploration.hpp"
  11 #include "src/mc/mc_safety.hpp"
  12
  13 #include <list>
  14 #include <memory>
  15 #include <string>
  16 #include <vector>
  17
  18 namespace simgrid::mc {
  19
  20 class XBT_PRIVATE DFSExplorer : public Exploration {
  21   ReductionMode reductionMode_ = ReductionMode::unset;
  22   long backtrack_count_        = 0;
  23
  24   static xbt::signal<void(RemoteApp&)> on_exploration_start_signal;
  25   static xbt::signal<void(RemoteApp&)> on_backtracking_signal;
  26
  27   static xbt::signal<void(State*, RemoteApp&)> on_state_creation_signal;
  28
  29   static xbt::signal<void(State*, RemoteApp&)> on_restore_system_state_signal;
  30   static xbt::signal<void(RemoteApp&)> on_restore_initial_state_signal;
  31   static xbt::signal<void(Transition*, RemoteApp&)> on_transition_replay_signal;
  32   static xbt::signal<void(Transition*, RemoteApp&)> on_transition_execute_signal;
  33
  34   static xbt::signal<void(RemoteApp&)> on_log_state_signal;
  35
  36 public:
  37   explicit DFSExplorer(RemoteApp& remote_app);
  38   void run() override;
  39   RecordTrace get_record_trace() override;
  40   std::vector<std::string> get_textual_trace() override;
  41   void log_state() override;
  42
  43   /** Called once when the exploration starts */
  44   static void on_exploration_start(std::function<void(RemoteApp& remote_app)> const& f)
  45   {
  46     on_exploration_start_signal.connect(f);
  47   }
  48   /** Called each time that the exploration backtracks from a exploration end */
  49   static void on_backtracking(std::function<void(RemoteApp& remote_app)> const& f)
  50   {
  51     on_backtracking_signal.connect(f);
  52   }
  53   /** Called each time that a new state is create */
  54   static void on_state_creation(std::function<void(State*, RemoteApp& remote_app)> const& f)
  55   {
  56     on_state_creation_signal.connect(f);
  57   }
  58   /** Called when rollbacking directly onto a previously checkpointed state */
  59   static void on_restore_system_state(std::function<void(State*, RemoteApp& remote_app)> const& f)
  60   {
  61     on_restore_system_state_signal.connect(f);
  62   }
  63   /** Called when the state to which we backtrack was not checkpointed state, forcing us to restore the initial state
  64    * before replaying some transitions */
  65   static void on_restore_initial_state(std::function<void(RemoteApp& remote_app)> const& f)
  66   {
  67     on_restore_initial_state_signal.connect(f);
  68   }
  69   /** Called when replaying a transition that was previously executed, to reach a backtracked state */
  70   static void on_transition_replay(std::function<void(Transition*, RemoteApp& remote_app)> const& f)
  71   {
  72     on_transition_replay_signal.connect(f);
  73   }
  74   /** Called when executing a new transition */
  75   static void on_transition_execute(std::function<void(Transition*, RemoteApp& remote_app)> const& f)
  76   {
  77     on_transition_execute_signal.connect(f);
  78   }
  79   /** Called when displaying the statistics at the end of the exploration */
  80   static void on_log_state(std::function<void(RemoteApp&)> const& f) { on_log_state_signal.connect(f); }
  81
  82 private:
  83   void check_non_termination(const State* current_state);
  84   void backtrack();
  85   void restore_state();
  86
  87   /** Stack representing the position in the exploration graph */
  88   std::list<std::unique_ptr<State>> stack_;
  89   VisitedStates visited_states_;
  90   std::unique_ptr<VisitedState> visited_state_;
  91 };
  92
  93 } // namespace simgrid::mc
  94
  95 #endif