1 /* Copyright (c) 2016-2023. The SimGrid Team. All rights reserved. */
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. */
6 #include "src/mc/explo/DFSExplorer.hpp"
7 #include "src/mc/mc_config.hpp"
8 #include "src/mc/mc_exit.hpp"
9 #include "src/mc/mc_private.hpp"
10 #include "src/mc/mc_record.hpp"
11 #include "src/mc/transition/Transition.hpp"
13 #if SIMGRID_HAVE_STATEFUL_MC
14 #include "src/mc/VisitedState.hpp"
17 #include "src/xbt/mmalloc/mmprivate.h"
19 #include "xbt/string.hpp"
20 #include "xbt/sysdep.h"
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dfs, mc, "DFS exploration algorithm of the model-checker");
31 namespace simgrid::mc {
33 xbt::signal<void(RemoteApp&)> DFSExplorer::on_exploration_start_signal;
34 xbt::signal<void(RemoteApp&)> DFSExplorer::on_backtracking_signal;
36 xbt::signal<void(State*, RemoteApp&)> DFSExplorer::on_state_creation_signal;
38 xbt::signal<void(State*, RemoteApp&)> DFSExplorer::on_restore_system_state_signal;
39 xbt::signal<void(RemoteApp&)> DFSExplorer::on_restore_initial_state_signal;
40 xbt::signal<void(Transition*, RemoteApp&)> DFSExplorer::on_transition_replay_signal;
41 xbt::signal<void(Transition*, RemoteApp&)> DFSExplorer::on_transition_execute_signal;
43 xbt::signal<void(RemoteApp&)> DFSExplorer::on_log_state_signal;
45 void DFSExplorer::check_non_termination(const State* current_state)
47 #if SIMGRID_HAVE_STATEFUL_MC
48 for (auto const& state : stack_) {
49 if (state->get_system_state()->equals_to(*current_state->get_system_state(),
50 *get_remote_app().get_remote_process_memory())) {
51 XBT_INFO("Non-progressive cycle: state %ld -> state %ld", state->get_num(), current_state->get_num());
52 XBT_INFO("******************************************");
53 XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
54 XBT_INFO("******************************************");
55 XBT_INFO("Counter-example execution trace:");
56 for (auto const& s : get_textual_trace())
57 XBT_INFO(" %s", s.c_str());
58 XBT_INFO("You can debug the problem (and see the whole details) by rerunning out of simgrid-mc with "
59 "--cfg=model-check/replay:'%s'",
60 get_record_trace().to_string().c_str());
63 throw TerminationError();
69 RecordTrace DFSExplorer::get_record_trace() // override
72 for (auto const& transition : stack_.back()->get_recipe())
73 res.push_back(transition);
74 res.push_back(stack_.back()->get_transition());
78 std::vector<std::string> DFSExplorer::get_textual_trace() // override
80 std::vector<std::string> trace;
81 for (auto const& transition : stack_.back()->get_recipe()) {
82 trace.push_back(xbt::string_printf("%ld: %s", transition->aid_, transition->to_string().c_str()));
84 trace.push_back(xbt::string_printf("%ld: %s", stack_.back()->get_transition()->aid_,
85 stack_.back()->get_transition()->to_string().c_str()));
89 void DFSExplorer::restore_stack(std::shared_ptr<State> state)
92 stack_ = std::list<std::shared_ptr<State>>();
93 std::shared_ptr<State> current_state(state);
94 stack_.push_front(std::shared_ptr<State>(current_state));
95 // condition corresponds to reaching initial state
96 while (current_state->get_parent_state() != nullptr) {
97 current_state = current_state->get_parent_state();
98 stack_.push_front(std::shared_ptr<State>(current_state));
100 XBT_DEBUG("Replaced stack by %s", get_record_trace().to_string().c_str());
103 void DFSExplorer::log_state() // override
105 on_log_state_signal(get_remote_app());
106 XBT_INFO("DFS exploration ended. %ld unique states visited; %lu backtracks (%lu transition replays, %lu states "
108 State::get_expanded_states(), backtrack_count_, visited_states_count_,
109 Transition::get_replayed_transitions());
110 Exploration::log_state();
113 void DFSExplorer::run()
115 on_exploration_start_signal(get_remote_app());
116 /* This function runs the DFS algorithm the state space.
117 * We do so iteratively instead of recursively, dealing with the call stack manually.
118 * This allows one to explore the call stack at will. */
120 while (not stack_.empty()) {
121 /* Get current state */
122 std::shared_ptr<State> state(stack_.back());
124 XBT_DEBUG("**************************************************");
125 XBT_DEBUG("Exploration depth=%zu (state:#%ld; %zu interleaves todo)", stack_.size(), state->get_num(),
126 state->count_todo());
128 visited_states_count_++;
130 // Backtrack if we reached the maximum depth
131 if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
132 if (reduction_mode_ == ReductionMode::dpor) {
133 XBT_ERROR("/!\\ Max depth of %d reached! THIS WILL PROBABLY BREAK the dpor reduction /!\\",
134 _sg_mc_max_depth.get());
135 XBT_ERROR("/!\\ If bad things happen, disable dpor with --cfg=model-check/reduction:none /!\\");
137 XBT_WARN("/!\\ Max depth reached ! /!\\ ");
142 #if SIMGRID_HAVE_STATEFUL_MC
143 // Backtrack if we are revisiting a state we saw previously while applying state-equality reduction
144 if (visited_state_ != nullptr) {
145 XBT_DEBUG("State already visited (equal to state %ld), exploration stopped on this path.",
146 visited_state_->original_num_ == -1 ? visited_state_->num_ : visited_state_->original_num_);
148 visited_state_ = nullptr;
154 // Search for the next transition
155 // next_transition returns a pair<aid_t, double> in case we want to consider multiple state (eg. during backtrack)
156 auto [next, _] = state->next_transition_guided();
158 if (next < 0) { // If there is no more transition in the current state, backtrack.
159 XBT_VERB("%lu actors remain, but none of them need to be interleaved (depth %zu).", state->get_actor_count(),
162 if (state->get_actor_count() == 0) {
163 get_remote_app().finalize_app();
164 XBT_VERB("Execution came to an end at %s (state: %ld, depth: %zu)", get_record_trace().to_string().c_str(),
165 state->get_num(), stack_.size());
172 if (_sg_mc_sleep_set && XBT_LOG_ISENABLED(mc_dfs, xbt_log_priority_verbose)) {
173 XBT_VERB("Sleep set actually containing:");
174 for (auto& [aid, transition] : state->get_sleep_set())
175 XBT_VERB(" <%ld,%s>", aid, transition.to_string().c_str());
178 /* Actually answer the request: let's execute the selected request (MCed does one step) */
179 state->execute_next(next, get_remote_app());
180 on_transition_execute_signal(state->get_transition(), get_remote_app());
182 // If there are processes to interleave and the maximum depth has not been
183 // reached then perform one step of the exploration algorithm.
184 XBT_VERB("Execute %ld: %.60s (stack depth: %zu, state: %ld, %zu interleaves)", state->get_transition()->aid_,
185 state->get_transition()->to_string().c_str(), stack_.size(), state->get_num(), state->count_todo());
187 /* Create the new expanded state (copy the state of MCed into our MCer data) */
188 std::shared_ptr<State> next_state = std::make_shared<State>(get_remote_app(), state);
189 on_state_creation_signal(next_state.get(), get_remote_app());
191 /* Sleep set procedure:
192 * adding the taken transition to the sleep set of the original state.
193 * <!> Since the parent sleep set is used to compute the child sleep set, this need to be
194 * done after next_state creation */
195 XBT_DEBUG("Marking Transition >>%s<< of process %ld done and adding it to the sleep set",
196 state->get_transition()->to_string().c_str(), state->get_transition()->aid_);
197 state->add_sleep_set(state->get_transition()); // Actors are marked done when they are considerd in ActorState
199 /* DPOR persistent set procedure:
200 * for each new transition considered, check if it depends on any other previous transition executed before it
201 * on another process. If there exists one, find the more recent, and add its process to the interleave set.
202 * If the process is not enabled at this point, then add every enabled process to the interleave */
203 if (reduction_mode_ == ReductionMode::dpor) {
204 aid_t issuer_id = state->get_transition()->aid_;
205 stack_t tmp_stack = std::list(stack_);
206 while (not tmp_stack.empty()) {
207 State* prev_state = tmp_stack.back().get();
208 if (state->get_transition()->aid_ == prev_state->get_transition()->aid_) {
209 XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->get_transition()->to_string().c_str(),
210 prev_state->get_transition()->to_string().c_str(), issuer_id);
211 tmp_stack.pop_back();
213 } else if (prev_state->get_transition()->depends(state->get_transition())) {
214 XBT_VERB("Dependent Transitions:");
215 XBT_VERB(" %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
216 XBT_VERB(" %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
218 if (prev_state->is_actor_enabled(issuer_id)) {
219 if (not prev_state->is_actor_done(issuer_id)) {
220 prev_state->consider_one(issuer_id);
221 opened_states_.push(std::shared_ptr<State>(tmp_stack.back()));
223 XBT_DEBUG("Actor %ld is already in done set: no need to explore it again", issuer_id);
225 XBT_DEBUG("Actor %ld is not enabled: DPOR may be failing. To stay sound, we are marking every enabled "
226 "transition as todo",
228 // If we ended up marking at least a transition, explore it at some point
229 if (prev_state->consider_all() > 0)
230 opened_states_.push(std::shared_ptr<State>(tmp_stack.back()));
234 XBT_VERB("INDEPENDENT Transitions:");
235 XBT_VERB(" %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
236 XBT_VERB(" %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
238 tmp_stack.pop_back();
242 // Before leaving that state, if the transition we just took can be taken multiple times, we
243 // need to give it to the opened states
244 if (stack_.back()->count_todo_multiples() > 0)
245 opened_states_.push(std::shared_ptr<State>(stack_.back()));
247 if (_sg_mc_termination)
248 this->check_non_termination(next_state.get());
250 #if SIMGRID_HAVE_STATEFUL_MC
251 /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
252 if (_sg_mc_max_visited_states > 0)
253 visited_state_ = visited_states_.addVisitedState(next_state->get_num(), next_state.get(), get_remote_app());
256 stack_.push_back(std::move(next_state));
258 /* If this is a new state (or if we don't care about state-equality reduction) */
259 if (visited_state_ == nullptr) {
260 /* Get an enabled process and insert it in the interleave set of the next state */
261 if (reduction_mode_ == ReductionMode::dpor)
262 stack_.back()->consider_best(); // Take only one transition if DPOR: others may be considered later if required
264 stack_.back()->consider_all();
267 dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(), stack_.back()->get_num(),
268 state->get_transition()->dot_string().c_str());
269 #if SIMGRID_HAVE_STATEFUL_MC
271 dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(),
272 visited_state_->original_num_ == -1 ? visited_state_->num_ : visited_state_->original_num_,
273 state->get_transition()->dot_string().c_str());
280 void DFSExplorer::backtrack()
282 XBT_VERB("Backtracking from %s", get_record_trace().to_string().c_str());
283 XBT_DEBUG("%lu alternatives are yet to be explored:", opened_states_.size());
285 on_backtracking_signal(get_remote_app());
286 get_remote_app().check_deadlock();
288 // if no backtracking point, then set the stack_ to empty so we can end the exploration
289 if (opened_states_.empty()) {
290 XBT_DEBUG("No more opened point of exploration, the search will end");
291 stack_ = std::list<std::shared_ptr<State>>();
295 std::shared_ptr<State> backtracking_point = opened_states_.top(); // Take the point with smallest distance
296 opened_states_.pop();
298 // if the smallest distance corresponded to no enable actor, remove this and let the
299 // exploration ask again for a backtrack
300 if (backtracking_point->next_transition_guided().first == -1) {
301 XBT_DEBUG("Best backtracking candidates has already been explored. Let's backtrack again");
306 // We found a real backtracking point, let's go to it
308 XBT_DEBUG("Backtracking to state#%ld", backtracking_point->get_num());
310 #if SIMGRID_HAVE_STATEFUL_MC
311 /* If asked to rollback on a state that has a snapshot, restore it */
312 if (const auto* system_state = backtracking_point->get_system_state()) {
313 system_state->restore(*get_remote_app().get_remote_process_memory());
314 on_restore_system_state_signal(backtracking_point.get(), get_remote_app());
315 this->restore_stack(backtracking_point);
320 /* if no snapshot, we need to restore the initial state and replay the transitions */
321 get_remote_app().restore_initial_state();
322 on_restore_initial_state_signal(get_remote_app());
323 /* Traverse the stack from the state at position start and re-execute the transitions */
324 for (auto& state : backtracking_point->get_recipe()) {
325 state->replay(get_remote_app());
326 on_transition_replay_signal(state, get_remote_app());
327 visited_states_count_++;
329 this->restore_stack(backtracking_point);
332 DFSExplorer::DFSExplorer(const std::vector<char*>& args, bool with_dpor, bool need_memory_info)
333 : Exploration(args, need_memory_info || _sg_mc_termination)
336 reduction_mode_ = ReductionMode::dpor;
338 reduction_mode_ = ReductionMode::none;
340 if (_sg_mc_termination) {
342 XBT_INFO("Check non progressive cycles (turning DPOR off)");
343 reduction_mode_ = ReductionMode::none;
345 XBT_INFO("Check non progressive cycles");
348 XBT_INFO("Start a DFS exploration. Reduction is: %s.", to_c_str(reduction_mode_));
350 auto initial_state = std::make_shared<State>(get_remote_app());
352 XBT_DEBUG("**************************************************");
354 stack_.push_back(std::move(initial_state));
356 /* Get an enabled actor and insert it in the interleave set of the initial state */
357 XBT_DEBUG("Initial state. %lu actors to consider", stack_.back()->get_actor_count());
358 if (reduction_mode_ == ReductionMode::dpor)
359 stack_.back()->consider_best();
361 stack_.back()->consider_all();
363 if (stack_.back()->count_todo_multiples() > 1)
364 opened_states_.push(std::shared_ptr<State>(stack_.back()));
367 Exploration* create_dfs_exploration(const std::vector<char*>& args, bool with_dpor)
369 return new DFSExplorer(args, with_dpor);
372 } // namespace simgrid::mc