Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
MC: move the reversible_race logic to the Transition class
[simgrid.git] / src / mc / explo / UdporChecker.hpp
index 471d8a2..02f2a8e 100644 (file)
@@ -7,6 +7,7 @@
 #ifndef SIMGRID_MC_UDPOR_CHECKER_HPP
 #define SIMGRID_MC_UDPOR_CHECKER_HPP
 
+#include "src/mc/api/State.hpp"
 #include "src/mc/explo/Exploration.hpp"
 #include "src/mc/explo/udpor/Configuration.hpp"
 #include "src/mc/explo/udpor/EventSet.hpp"
@@ -15,6 +16,7 @@
 #include "src/mc/mc_record.hpp"
 
 #include <functional>
+#include <list>
 #include <optional>
 
 namespace simgrid::mc::udpor {
@@ -28,7 +30,7 @@ namespace simgrid::mc::udpor {
  * current implementation of `tiny_simgrid`:
  *
  * 1. "Unfolding-based Partial Order Reduction" by Rodriguez et al.
- * 2. Quasi-Optimal Partial Order Reduction by Nguyen et al.
+ * 2. "Quasi-Optimal Partial Order Reduction" by Nguyen et al.
  * 3. The Anh Pham's Thesis "Exploration efficace de l'espace ..."
  */
 class XBT_PRIVATE UdporChecker : public Exploration {
@@ -37,58 +39,15 @@ public:
 
   void run() override;
   RecordTrace get_record_trace() override;
-  std::vector<std::string> get_textual_trace() override;
-
-  inline std::unique_ptr<State> get_current_state() { return std::make_unique<State>(get_remote_app()); }
+  std::unique_ptr<State> get_current_state() { return std::make_unique<State>(get_remote_app()); }
 
 private:
-  /**
-   * The total number of events created whilst exploring the unfolding
-   */
-  /* FIXME: private fields are not used
-    uint32_t nb_events = 0;
-    uint32_t nb_traces = 0;
-  */
-
-  /**
-   * @brief The "relevant" portions of the unfolding that must be kept around to ensure that
-   * UDPOR properly searches the state space
-   *
-   * The set `U` is a global variable which is maintained by UDPOR
-   * to keep track of "just enough" information about the unfolding
-   * to compute *alternatives* (see the paper for more details).
-   *
-   * @invariant: When a new event is created by UDPOR, it is inserted into
-   * this set. All new events that are created by UDPOR have causes that
-   * also exist in U and are valid for the duration of the search.
-   *
-   * If an event is discarded instead of moved from set `U` to set `G`,
-   * the event and its contents will be discarded.
-   */
-  EventSet U;
-
-  /**
-   * @brief The "irrelevant" portions of the unfolding that do not need to be kept
-   * around to ensure that UDPOR functions correctly
-   *
-   * The set `G` is another global variable maintained by the UDPOR algorithm which
-   * is used to keep track of all events which used to be important to UDPOR
-   */
-  EventSet G;
-
-  /// @brief UDPOR's current "view" of the program it is exploring
   Unfolding unfolding = Unfolding();
 
-  using ExtensionFunction = std::function<EventSet(const Configuration&, const Transition&)>;
+  // The current sequence of states that the checker has
+  // visited in order to reach the current configuration
+  std::list<std::unique_ptr<State>> state_stack;
 
-  /**
-   * @brief A collection of specialized functions which can incrementally
-   * compute the extension of a configuration based on the action taken
-   */
-  std::unordered_map<Transition::Type, ExtensionFunction> incremental_extension_functions =
-      std::unordered_map<Transition::Type, ExtensionFunction>();
-
-private:
   /**
    * @brief Explores the unfolding of the concurrent system
    * represented by the ModelChecker instance "mcmodel_checker"
@@ -104,13 +63,11 @@ private:
    * @param A the set of events to "guide" UDPOR in the correct direction
    * when it returns back to a node in the unfolding and must decide among
    * events to select from `ex(C)`. See [1] for more details
-   * @param stateC the state of the program after having executed `C`,
-   * viz. `state(C)`  using the notation of [1]
    *
    * TODO: Add the optimization where we can check if e == e_prior
    * to prevent repeated work when computing ex(C)
    */
-  void explore(Configuration C, EventSet D, EventSet A, std::unique_ptr<State> stateC, EventSet prev_exC);
+  void explore(const Configuration& C, EventSet D, EventSet A, EventSet prev_exC);
 
   /**
    * @brief Identifies the next event from the unfolding of the concurrent system
@@ -141,47 +98,53 @@ private:
    * SimGrid is apart, which allow for `ex(C)` to be computed much more efficiently.
    * Intuitively, the idea is to take advantage of the fact that you can avoid a lot
    * of repeated computation by exploiting the aforementioned properties (in [3]) in
-   * what is effectively a dynamic programming optimization. See [3] for more details
+   * what is akin to a dynamic programming optimization. See [3] for more details
    *
    * @param C the configuration based on which the two sets `ex(C)` and `en(C)` are
    * computed
    * @param stateC the state of the program after having executed C (viz. `state(C)`)
    * @param prev_exC the previous value of `ex(C)`, viz. that which was computed for
    * the configuration `C' := C - {e}`
-   * @returns a tuple containing the pair of sets `ex(C)` and `en(C)` respectively
+   * @returns the extension set `ex(C)` of `C`
    */
-  std::tuple<EventSet, EventSet> compute_extension(const Configuration& C, const State& stateC,
-                                                   const EventSet& prev_exC) const;
-
-  EventSet compute_extension_by_enumeration(const Configuration& C, const Transition& action) const;
+  EventSet compute_exC(const Configuration& C, const State& stateC, const EventSet& prev_exC);
+  EventSet compute_enC(const Configuration& C, const EventSet& exC) const;
 
   /**
    *
    */
-  EventSet compute_partial_alternative(const EventSet& D, const Configuration& C, const unsigned k) const;
+  void move_to_stateCe(State* stateC, UnfoldingEvent* e);
 
   /**
-   *
-   */
-  void move_to_stateCe(State& stateC, const UnfoldingEvent& e);
-
-  /**
-   * @brief Creates a new snapshot of the state of the progam undergoing
-   * model checking
-   *
-   * @returns the handle used to uniquely identify this state later in the
-   * exploration of the unfolding. You provide this handle to an event in the
-   * unfolding to regenerate past states
+   * @brief Creates a new snapshot of the state of the application
+   * as it currently looks
    */
   std::unique_ptr<State> record_current_state();
 
   /**
-   *
+   * @brief Move the application side into the state at the top of the
+   * state stack provided
+   *
+   * As UDPOR performs its search, it moves the application-side along with
+   * it so that the application is always providing the checker with
+   * the correct information about what each actor is running (and whether
+   * those actors are enabled) at the state reached by the configuration it
+   * decides to search.
+   *
+   * When UDPOR decides to "backtrack" (e.g. after reaching a configuration
+   * whose en(C) is empty), before it attempts to continue the search by taking
+   * a different path from a configuration it visited in the past, it must ensure
+   * that the application-side has moved back into `state(C)`.
+   *
+   * The search may have moved the application arbitrarily deep into its execution,
+   * and the search may backtrack arbitrarily closer to the beginning of the execution.
+   * The UDPOR implementation in SimGrid ensures that the stack is updated appropriately,
+   * but the process must still be regenerated.
    */
-  void restore_program_state_to(const State& stateC);
+  void restore_program_state_with_current_stack();
 
   /**
-   *
+   * @brief Perform the functionality of the `Remove(e, C, D)` function in [1]
    */
   void clean_up_explore(const UnfoldingEvent* e, const Configuration& C, const EventSet& D);
 };