src/mc/explo/DFSExplorer.hpp

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