1 /* Copyright (c) 2007-2023. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #ifndef SIMGRID_MC_UDPOR_CHECKER_HPP
8 #define SIMGRID_MC_UDPOR_CHECKER_HPP
10 #include "src/mc/explo/Exploration.hpp"
11 #include "src/mc/explo/udpor/Configuration.hpp"
12 #include "src/mc/explo/udpor/EventSet.hpp"
13 #include "src/mc/explo/udpor/Unfolding.hpp"
14 #include "src/mc/explo/udpor/UnfoldingEvent.hpp"
15 #include "src/mc/mc_record.hpp"
20 namespace simgrid::mc::udpor {
23 * @brief Performs exploration of a concurrent system via the
26 * The `UdporChecker` implementation is based primarily off three papers,
27 * herein referred to as [1], [2], and [3] respectively, as well as the
28 * current implementation of `tiny_simgrid`:
30 * 1. "Unfolding-based Partial Order Reduction" by Rodriguez et al.
31 * 2. Quasi-Optimal Partial Order Reduction by Nguyen et al.
32 * 3. The Anh Pham's Thesis "Exploration efficace de l'espace ..."
34 class XBT_PRIVATE UdporChecker : public Exploration {
36 explicit UdporChecker(const std::vector<char*>& args);
39 RecordTrace get_record_trace() override;
40 std::vector<std::string> get_textual_trace() override;
42 inline std::unique_ptr<State> get_current_state() { return std::make_unique<State>(get_remote_app()); }
46 * @brief The "relevant" portions of the unfolding that must be kept around to ensure that
47 * UDPOR properly searches the state space
49 * The set `U` is a global variable which is maintained by UDPOR
50 * to keep track of "just enough" information about the unfolding
51 * to compute *alternatives* (see the paper for more details).
53 * @invariant: When a new event is created by UDPOR, it is inserted into
54 * this set. All new events that are created by UDPOR have causes that
55 * also exist in U and are valid for the duration of the search.
57 * If an event is discarded instead of moved from set `U` to set `G`,
58 * the event and its contents will be discarded.
63 * @brief The "irrelevant" portions of the unfolding that do not need to be kept
64 * around to ensure that UDPOR functions correctly
66 * The set `G` is another global variable maintained by the UDPOR algorithm which
67 * is used to keep track of all events which used to be important to UDPOR
71 /// @brief UDPOR's current "view" of the program it is exploring
72 Unfolding unfolding = Unfolding();
75 * @brief A collection of specialized functions which can incrementally
76 * compute the extension of a configuration based on the action taken
78 using ExtensionFunction = std::function<EventSet(const Configuration&, const std::shared_ptr<Transition>)>;
79 std::unordered_map<Transition::Type, ExtensionFunction> incremental_extension_functions =
80 std::unordered_map<Transition::Type, ExtensionFunction>();
83 * @brief Explores the unfolding of the concurrent system
84 * represented by the ModelChecker instance "mcmodel_checker"
86 * This function performs the actual search following the
87 * UDPOR algorithm according to [1].
89 * @param C the current configuration from which UDPOR will be used
90 * to explore expansions of the concurrent system being modeled
91 * @param D the set of events that should not be considered by UDPOR
92 * while performing its searches, in order to avoid sleep-set blocked
93 * executions. See [1] for more details
94 * @param A the set of events to "guide" UDPOR in the correct direction
95 * when it returns back to a node in the unfolding and must decide among
96 * events to select from `ex(C)`. See [1] for more details
97 * @param stateC the state of the program after having executed `C`,
98 * viz. `state(C)` using the notation of [1]
100 * TODO: Add the optimization where we can check if e == e_prior
101 * to prevent repeated work when computing ex(C)
103 void explore(const Configuration& C, EventSet D, EventSet A, std::unique_ptr<State> stateC, EventSet prev_exC);
106 * @brief Identifies the next event from the unfolding of the concurrent system
107 * that should next be explored as an extension of a configuration with
108 * enabled events `enC`
110 * @param A The set of events `A` maintained by the UDPOR algorithm to help
111 * determine how events should be selected. See the original paper [1] for more details
113 * @param enC The set `enC` of enabled events from the extension set `exC` used
114 * by the UDPOR algorithm to select new events to search. See the original
115 * paper [1] for more details
117 const UnfoldingEvent* select_next_unfolding_event(const EventSet& A, const EventSet& enC);
120 * @brief Computes the sets `ex(C)` and `en(C)` of the given configuration
121 * `C` as an incremental computation from the the previous computation of `ex(C)`
123 * A central component to UDPOR is the computation of the set `ex(C)`. The
124 * extension set `ex(C)` of a configuration `C` is defined as the set of events
125 * outside of `C` whose full dependency chain is contained in `C` (see [1]
128 * In general, computing `ex(C)` is very expensive. In paper [3], The Anh Pham
129 * shows a method of incremental computation of the set `ex(C)` under the
130 * conclusions afforded under the computation model in consideration, of which
131 * SimGrid is apart, which allow for `ex(C)` to be computed much more efficiently.
132 * Intuitively, the idea is to take advantage of the fact that you can avoid a lot
133 * of repeated computation by exploiting the aforementioned properties (in [3]) in
134 * what is effectively a dynamic programming optimization. See [3] for more details
136 * @param C the configuration based on which the two sets `ex(C)` and `en(C)` are
138 * @param stateC the state of the program after having executed C (viz. `state(C)`)
139 * @param prev_exC the previous value of `ex(C)`, viz. that which was computed for
140 * the configuration `C' := C - {e}`
141 * @returns the extension set `ex(C)` of `C`
143 EventSet compute_exC(const Configuration& C, const State& stateC, const EventSet& prev_exC);
146 * @brief Computes a portion of the extension set of a configuration given
147 * some action `action`
149 EventSet compute_exC_by_enumeration(const Configuration& C, const std::shared_ptr<Transition> action);
151 EventSet compute_enC(const Configuration& C, const EventSet& exC) const;
156 EventSet compute_partial_alternative(const EventSet& D, const Configuration& C, const unsigned k) const;
161 void move_to_stateCe(State& stateC, const UnfoldingEvent& e);
164 * @brief Creates a new snapshot of the state of the progam undergoing
167 * @returns the handle used to uniquely identify this state later in the
168 * exploration of the unfolding. You provide this handle to an event in the
169 * unfolding to regenerate past states
171 std::unique_ptr<State> record_current_state();
176 void restore_program_state_to(const State& stateC);
181 void clean_up_explore(const UnfoldingEvent* e, const Configuration& C, const EventSet& D);
183 } // namespace simgrid::mc::udpor