Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix two minor bugs in the ODPOR implementation
[simgrid.git] / src / mc / explo / DFSExplorer.cpp
1 /* Copyright (c) 2016-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 #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"
12
13 #if SIMGRID_HAVE_STATEFUL_MC
14 #include "src/mc/VisitedState.hpp"
15 #endif
16
17 #include "src/xbt/mmalloc/mmprivate.h"
18 #include "xbt/log.h"
19 #include "xbt/string.hpp"
20 #include "xbt/sysdep.h"
21
22 #include <cassert>
23 #include <cstdio>
24
25 #include <algorithm>
26 #include <memory>
27 #include <string>
28 #include <unordered_set>
29 #include <vector>
30
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dfs, mc, "DFS exploration algorithm of the model-checker");
32
33 namespace simgrid::mc {
34
35 xbt::signal<void(RemoteApp&)> DFSExplorer::on_exploration_start_signal;
36 xbt::signal<void(RemoteApp&)> DFSExplorer::on_backtracking_signal;
37
38 xbt::signal<void(State*, RemoteApp&)> DFSExplorer::on_state_creation_signal;
39
40 xbt::signal<void(State*, RemoteApp&)> DFSExplorer::on_restore_system_state_signal;
41 xbt::signal<void(RemoteApp&)> DFSExplorer::on_restore_initial_state_signal;
42 xbt::signal<void(Transition*, RemoteApp&)> DFSExplorer::on_transition_replay_signal;
43 xbt::signal<void(Transition*, RemoteApp&)> DFSExplorer::on_transition_execute_signal;
44
45 xbt::signal<void(RemoteApp&)> DFSExplorer::on_log_state_signal;
46
47 void DFSExplorer::check_non_termination(const State* current_state)
48 {
49 #if SIMGRID_HAVE_STATEFUL_MC
50   for (auto const& state : stack_) {
51     if (state->get_system_state()->equals_to(*current_state->get_system_state(),
52                                              *get_remote_app().get_remote_process_memory())) {
53       XBT_INFO("Non-progressive cycle: state %ld -> state %ld", state->get_num(), current_state->get_num());
54       XBT_INFO("******************************************");
55       XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
56       XBT_INFO("******************************************");
57       XBT_INFO("Counter-example execution trace:");
58       for (auto const& s : get_textual_trace())
59         XBT_INFO("  %s", s.c_str());
60       XBT_INFO("You can debug the problem (and see the whole details) by rerunning out of simgrid-mc with "
61                "--cfg=model-check/replay:'%s'",
62                get_record_trace().to_string().c_str());
63       log_state();
64
65       throw McError(ExitStatus::NON_TERMINATION);
66     }
67   }
68 #endif
69 }
70
71 RecordTrace DFSExplorer::get_record_trace() // override
72 {
73   RecordTrace res;
74
75   if (const auto trans = stack_.back()->get_transition_out(); trans != nullptr)
76     res.push_back(trans.get());
77   for (const auto* state = stack_.back().get(); state != nullptr; state = state->get_parent_state().get())
78     if (state->get_transition_in() != nullptr)
79       res.push_front(state->get_transition_in().get());
80
81   return res;
82 }
83
84 void DFSExplorer::restore_stack(std::shared_ptr<State> state)
85 {
86   stack_.clear();
87   auto current_state = state;
88   stack_.emplace_front(current_state);
89   // condition corresponds to reaching initial state
90   while (current_state->get_parent_state() != nullptr) {
91     current_state = current_state->get_parent_state();
92     stack_.emplace_front(current_state);
93   }
94   XBT_DEBUG("Replaced stack by %s", get_record_trace().to_string().c_str());
95
96   if (reduction_mode_ == ReductionMode::sdpor || reduction_mode_ == ReductionMode::odpor) {
97     execution_seq_ = odpor::Execution();
98
99     // NOTE: The outgoing transition for the top-most
100     // state of the  stack refers to that which was taken
101     // as part of the last trace explored by the algorithm.
102     // Thus, only the sequence of transitions leading up to,
103     // but not including, the last state must be included
104     // when reconstructing the Exploration for SDPOR.
105     for (auto iter = stack_.begin(); iter != stack_.end() - 1 and iter != stack_.end(); ++iter) {
106       const auto& state = *(iter);
107       execution_seq_.push_transition(state->get_transition_out());
108     }
109   }
110   XBT_DEBUG("Additionally replaced corresponding SDPOR execution stack");
111 }
112
113 void DFSExplorer::log_state() // override
114 {
115   on_log_state_signal(get_remote_app());
116   XBT_INFO("DFS exploration ended. %ld unique states visited; %lu backtracks (%lu transition replays, %lu states "
117            "visited overall)",
118            State::get_expanded_states(), backtrack_count_, visited_states_count_,
119            Transition::get_replayed_transitions());
120   Exploration::log_state();
121 }
122
123 void DFSExplorer::run()
124 {
125   on_exploration_start_signal(get_remote_app());
126   /* This function runs the DFS algorithm the state space.
127    * We do so iteratively instead of recursively, dealing with the call stack manually.
128    * This allows one to explore the call stack at will. */
129
130   while (not stack_.empty()) {
131     /* Get current state */
132     auto state = stack_.back();
133
134     XBT_DEBUG("**************************************************");
135     XBT_DEBUG("Exploration depth=%zu (state:#%ld; %zu interleaves todo)", stack_.size(), state->get_num(),
136               state->count_todo());
137
138     visited_states_count_++;
139
140     // Backtrack if we reached the maximum depth
141     if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
142       if (reduction_mode_ == ReductionMode::dpor) {
143         XBT_ERROR("/!\\ Max depth of %d reached! THIS WILL PROBABLY BREAK the dpor reduction /!\\",
144                   _sg_mc_max_depth.get());
145         XBT_ERROR("/!\\ If bad things happen, disable dpor with --cfg=model-check/reduction:none /!\\");
146       } else if (reduction_mode_ == ReductionMode::sdpor || reduction_mode_ == ReductionMode::odpor) {
147         XBT_ERROR("/!\\ Max depth of %d reached! THIS **WILL** BREAK the reduction, which is not sound "
148                   "when stopping at a fixed depth /!\\",
149                   _sg_mc_max_depth.get());
150         XBT_ERROR("/!\\ If bad things happen, disable dpor with --cfg=model-check/reduction:none /!\\");
151       } else {
152         XBT_WARN("/!\\ Max depth reached ! /!\\ ");
153       }
154       this->backtrack();
155       continue;
156     }
157
158 #if SIMGRID_HAVE_STATEFUL_MC
159     // Backtrack if we are revisiting a state we saw previously while applying state-equality reduction
160     if (visited_state_ != nullptr) {
161       XBT_DEBUG("State already visited (equal to state %ld), exploration stopped on this path.",
162                 visited_state_->original_num_ == -1 ? visited_state_->num_ : visited_state_->original_num_);
163
164       visited_state_ = nullptr;
165       this->backtrack();
166       continue;
167     }
168 #endif
169
170     if (reduction_mode_ == ReductionMode::odpor) {
171       // In the case of ODPOR, the wakeup tree for this
172       // state may be empty if we're exploring new territory
173       // (rather than following the partial execution of a
174       // wakeup tree). This corresponds to lines 9 to 13 of
175       // the ODPOR pseudocode
176       //
177       // INVARIANT: The execution sequence should be consistent
178       // with the state when seeding the tree. If the sequence
179       // gets out of sync with the state, selection will not
180       // work as we intend
181       state->seed_wakeup_tree_if_needed(execution_seq_);
182     }
183
184     // Search for the next transition
185     // next_transition returns a pair<aid_t, int>
186     // in case we want to consider multiple states (eg. during backtrack)
187     const aid_t next = reduction_mode_ == ReductionMode::odpor ? state->next_odpor_transition()
188                                                                : std::get<0>(state->next_transition_guided());
189     xbt_assert(!state->is_actor_sleeping(next),
190                "We decided to schedule an actor (%ld) that is in the sleep set "
191                "of the current state. By definition, this should be impossible; "
192                "and yet it happened, somehow...",
193                next);
194
195     if (next < 0) { // If there is no more transition in the current state, backtrack.
196       XBT_VERB("%lu actors remain, but none of them need to be interleaved (depth %zu).", state->get_actor_count(),
197                stack_.size() + 1);
198
199       if (state->get_actor_count() == 0) {
200         get_remote_app().finalize_app();
201         XBT_VERB("Execution came to an end at %s (state: %ld, depth: %zu)", get_record_trace().to_string().c_str(),
202                  state->get_num(), stack_.size());
203       }
204
205       this->backtrack();
206       continue;
207     }
208
209     if (_sg_mc_sleep_set && XBT_LOG_ISENABLED(mc_dfs, xbt_log_priority_verbose)) {
210       XBT_VERB("Sleep set actually containing:");
211       for (auto& [aid, transition] : state->get_sleep_set())
212         XBT_VERB("  <%ld,%s>", aid, transition.to_string().c_str());
213     }
214
215     /* Actually answer the request: let's execute the selected request (MCed does one step) */
216     const auto executed_transition = state->execute_next(next, get_remote_app());
217     on_transition_execute_signal(state->get_transition_out().get(), get_remote_app());
218
219     // If there are processes to interleave and the maximum depth has not been
220     // reached then perform one step of the exploration algorithm.
221     XBT_VERB("Execute %ld: %.60s (stack depth: %zu, state: %ld, %zu interleaves)", state->get_transition_out()->aid_,
222              state->get_transition_out()->to_string().c_str(), stack_.size(), state->get_num(), state->count_todo());
223
224     /* Create the new expanded state (copy the state of MCed into our MCer data) */
225     auto next_state = std::make_shared<State>(get_remote_app(), state);
226     on_state_creation_signal(next_state.get(), get_remote_app());
227
228     if (reduction_mode_ == ReductionMode::odpor) {
229       // With ODPOR, after taking a step forward, we must
230       // assign a copy of that subtree to the next state.
231       //
232       // NOTE: We only add actions to the sleep set AFTER
233       // we've regenerated states. We must perform the search
234       // fully down a single path before we consider adding
235       // any elements to the sleep set according to the pseudocode
236       next_state->sprout_tree_from_parent_state();
237     } else {
238       /* Sleep set procedure:
239        * adding the taken transition to the sleep set of the original state.
240        * <!> Since the parent sleep set is used to compute the child sleep set, this need to be
241        * done after next_state creation */
242       XBT_DEBUG("Marking Transition >>%s<< of process %ld done and adding it to the sleep set",
243                 state->get_transition_out()->to_string().c_str(), state->get_transition_out()->aid_);
244       state->add_sleep_set(
245           state->get_transition_out()); // Actors are marked done when they are considered in ActorState
246     }
247
248     /* DPOR persistent set procedure:
249      * for each new transition considered, check if it depends on any other previous transition executed before it
250      * on another process. If there exists one, find the more recent, and add its process to the interleave set.
251      * If the process is not enabled at this  point, then add every enabled process to the interleave */
252     if (reduction_mode_ == ReductionMode::dpor) {
253       aid_t issuer_id   = state->get_transition_out()->aid_;
254       stack_t tmp_stack = stack_;
255       while (not tmp_stack.empty()) {
256         if (const State* prev_state = tmp_stack.back().get();
257             state->get_transition_out()->aid_ == prev_state->get_transition_out()->aid_) {
258           XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->get_transition_out()->to_string().c_str(),
259                     prev_state->get_transition_out()->to_string().c_str(), issuer_id);
260           tmp_stack.pop_back();
261           continue;
262         } else if (prev_state->get_transition_out()->depends(state->get_transition_out().get())) {
263           XBT_VERB("Dependent Transitions:");
264           XBT_VERB("  %s (state=%ld)", prev_state->get_transition_out()->to_string().c_str(), prev_state->get_num());
265           XBT_VERB("  %s (state=%ld)", state->get_transition_out()->to_string().c_str(), state->get_num());
266
267           if (prev_state->is_actor_enabled(issuer_id)) {
268             if (not prev_state->is_actor_done(issuer_id)) {
269               prev_state->consider_one(issuer_id);
270               opened_states_.emplace_back(tmp_stack.back());
271             } else
272               XBT_DEBUG("Actor %ld is already in done set: no need to explore it again", issuer_id);
273           } else {
274             XBT_DEBUG("Actor %ld is not enabled: DPOR may be failing. To stay sound, we are marking every enabled "
275                       "transition as todo",
276                       issuer_id);
277             // If we ended up marking at least a transition, explore it at some point
278             if (prev_state->consider_all() > 0)
279               opened_states_.emplace_back(tmp_stack.back());
280           }
281           break;
282         } else {
283           XBT_VERB("INDEPENDENT Transitions:");
284           XBT_VERB("  %s (state=%ld)", prev_state->get_transition_out()->to_string().c_str(), prev_state->get_num());
285           XBT_VERB("  %s (state=%ld)", state->get_transition_out()->to_string().c_str(), state->get_num());
286         }
287         tmp_stack.pop_back();
288       }
289     } else if (reduction_mode_ == ReductionMode::sdpor) {
290       /**
291        * SDPOR Source Set Procedure:
292        *
293        * Find "reversible races" in the current execution `E` with respect
294        * to the latest action `p`. For each such race, determine one thread
295        * not contained in the backtrack set at the "race point" `r` which
296        * "represents" the trace formed by first executing everything after
297        * `r` that doesn't depend on it (`v := notdep(r, E)`) and then `p` to
298        * flip the race.
299        *
300        * The intuition is that some subsequence of `v` may enable `p`, so
301        * we want to be sure that search "in that direction"
302        */
303       execution_seq_.push_transition(std::move(executed_transition));
304       xbt_assert(execution_seq_.get_latest_event_handle().has_value(),
305                  "No events are contained in the SDPOR/OPDPOR execution "
306                  "even though one was just added");
307
308       const auto next_E_p = execution_seq_.get_latest_event_handle().value();
309       for (const auto racing_event_handle : execution_seq_.get_reversible_races_of(next_E_p)) {
310         const std::shared_ptr<State> prev_state = stack_[racing_event_handle];
311         // NOTE: To incorporate the idea of attempting to select the "best"
312         // backtrack point into SDPOR, instead of selecting the `first` initial,
313         // we should instead compute all choices and decide which is best
314         if (const auto q =
315                 execution_seq_.get_first_sdpor_initial_from(racing_event_handle, prev_state->get_backtrack_set());
316             q.has_value()) {
317           prev_state->consider_one(q.value());
318           opened_states_.emplace_back(std::move(prev_state));
319         }
320       }
321     } else if (reduction_mode_ == ReductionMode::odpor) {
322       // In the case of ODPOR, we simply observe the transition that was executed
323       // until we've reached a maximal trace
324       execution_seq_.push_transition(std::move(executed_transition));
325     }
326
327     // Before leaving that state, if the transition we just took can be taken multiple times, we
328     // need to give it to the opened states
329     if (stack_.back()->count_todo_multiples() > 0)
330       opened_states_.emplace_back(stack_.back());
331
332     if (_sg_mc_termination)
333       this->check_non_termination(next_state.get());
334
335 #if SIMGRID_HAVE_STATEFUL_MC
336     /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction)
337      */
338     if (_sg_mc_max_visited_states > 0)
339       visited_state_ = visited_states_.addVisitedState(next_state->get_num(), next_state.get(), get_remote_app());
340 #endif
341
342     stack_.emplace_back(std::move(next_state));
343
344     /* If this is a new state (or if we don't care about state-equality reduction) */
345     if (visited_state_ == nullptr) {
346       /* Get an enabled process and insert it in the interleave set of the next state */
347       if (reduction_mode_ == ReductionMode::dpor)
348         stack_.back()->consider_best(); // Take only one transition if DPOR: others may be considered later if required
349       else {
350         stack_.back()->consider_all();
351       }
352
353       dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(), stack_.back()->get_num(),
354                  state->get_transition_out()->dot_string().c_str());
355 #if SIMGRID_HAVE_STATEFUL_MC
356     } else {
357       dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(),
358                  visited_state_->original_num_ == -1 ? visited_state_->num_ : visited_state_->original_num_,
359                  state->get_transition_out()->dot_string().c_str());
360 #endif
361     }
362   }
363   log_state();
364 }
365
366 std::shared_ptr<State> DFSExplorer::best_opened_state()
367 {
368   int best_prio = 0; // cache the value for the best priority found so far (initialized to silence gcc)
369   auto best     = end(opened_states_);   // iterator to the state to explore having the best priority
370   auto valid    = begin(opened_states_); // iterator marking the limit between states still to explore, and already
371                                          // explored ones
372
373   // Keep only still non-explored states (aid != -1), and record the one with the best (greater) priority.
374   for (auto current = begin(opened_states_); current != end(opened_states_); ++current) {
375     auto [aid, prio] = (*current)->next_transition_guided();
376     if (aid == -1)
377       continue;
378     if (valid != current)
379       *valid = std::move(*current);
380     if (best == end(opened_states_) || prio > best_prio) {
381       best_prio = prio;
382       best      = valid;
383     }
384     ++valid;
385   }
386
387   std::shared_ptr<State> best_state;
388   if (best < valid) {
389     // There are non-explored states, and one of them has the best priority.  Remove it from opened_states_ before
390     // returning.
391     best_state = std::move(*best);
392     --valid;
393     if (best != valid)
394       *best = std::move(*valid);
395   }
396   opened_states_.erase(valid, end(opened_states_));
397
398   return best_state;
399 }
400
401 std::shared_ptr<State> DFSExplorer::next_odpor_state()
402 {
403   for (auto iter = stack_.rbegin(); iter != stack_.rend(); ++iter) {
404     const auto& state = *iter;
405     state->do_odpor_backtrack_cleanup();
406     if (!state->has_empty_tree()) {
407       return state;
408     }
409   }
410   xbt_die("There are no more states for ODPOR");
411   return nullptr;
412 }
413
414 void DFSExplorer::backtrack()
415 {
416   if (const auto last_event = execution_seq_.get_latest_event_handle();
417       reduction_mode_ == ReductionMode::odpor and last_event.has_value()) {
418     /**
419      * ODPOR Race Detection Procedure:
420      *
421      * For each reversible race in the current execution, we
422      * note if there are any continuations `C` equivalent to that which
423      * would reverse the race that have already either a) been searched by ODPOR or
424      * b) been *noted* to be searched by the wakeup tree at the
425      * appropriate reversal point, either as `C` directly or
426      * an as equivalent to `C` ("eventually looks like C", viz. the `~_E`
427      * relation)
428      */
429     for (auto e_prime = static_cast<odpor::Execution::EventHandle>(0); e_prime <= last_event.value(); ++e_prime) {
430       for (const auto e : execution_seq_.get_reversible_races_of(e_prime)) {
431         XBT_DEBUG("ODPOR: Reversible race detected between events `%u` and `%u`", e, e_prime);
432         State& prev_state = *stack_[e];
433         if (const auto v = execution_seq_.get_odpor_extension_from(e, e_prime, prev_state); v.has_value()) {
434           XBT_DEBUG("ODPOR: Reversible race unaccounted for in the wakeup tree for "
435                     "the execution prior to event `%u`, inserting a sequence",
436                     e);
437           prev_state.mark_path_interesting_for_odpor(v.value(), execution_seq_.get_prefix_before(e));
438         }
439       }
440     }
441   }
442
443   XBT_VERB("Backtracking from %s", get_record_trace().to_string().c_str());
444   XBT_DEBUG("%lu alternatives are yet to be explored:", opened_states_.size());
445
446   on_backtracking_signal(get_remote_app());
447   get_remote_app().check_deadlock();
448
449   // Take the point with smallest distance
450   auto backtracking_point = reduction_mode_ == ReductionMode::odpor ? next_odpor_state() : best_opened_state();
451
452   // if no backtracking point, then set the stack_ to empty so we can end the exploration
453   if (not backtracking_point) {
454     XBT_DEBUG("No more opened point of exploration, the search will end");
455     stack_.clear();
456     return;
457   }
458
459   // We found a backtracking point, let's go to it
460   backtrack_count_++;
461   XBT_DEBUG("Backtracking to state#%ld", backtracking_point->get_num());
462
463 #if SIMGRID_HAVE_STATEFUL_MC
464   /* If asked to rollback on a state that has a snapshot, restore it */
465   if (const auto* system_state = backtracking_point->get_system_state()) {
466     system_state->restore(*get_remote_app().get_remote_process_memory());
467     on_restore_system_state_signal(backtracking_point.get(), get_remote_app());
468     this->restore_stack(backtracking_point);
469     return;
470   }
471 #endif
472
473   // Search how to restore the backtracking point
474   State* init_state = nullptr;
475   std::deque<Transition*> replay_recipe;
476   for (auto* s = backtracking_point.get(); s != nullptr; s = s->get_parent_state().get()) {
477 #if SIMGRID_HAVE_STATEFUL_MC
478     if (s->get_system_state() != nullptr) { // Found a state that I can restore
479       init_state = s;
480       break;
481     }
482 #endif
483     if (s->get_transition_in() != nullptr) // The root has no transition_in
484       replay_recipe.push_front(s->get_transition_in().get());
485   }
486
487   // Restore the init_state, if any
488   if (init_state != nullptr) {
489 #if SIMGRID_HAVE_STATEFUL_MC
490     const auto* system_state = init_state->get_system_state();
491     system_state->restore(*get_remote_app().get_remote_process_memory());
492     on_restore_system_state_signal(init_state, get_remote_app());
493 #endif
494   } else { // Restore the initial state if no intermediate state was found
495     get_remote_app().restore_initial_state();
496     on_restore_initial_state_signal(get_remote_app());
497   }
498
499   /* if no snapshot, we need to restore the initial state and replay the transitions */
500   /* Traverse the stack from the state at position start and re-execute the transitions */
501   for (auto& transition : replay_recipe) {
502     transition->replay(get_remote_app());
503     on_transition_replay_signal(transition, get_remote_app());
504     visited_states_count_++;
505   }
506   this->restore_stack(backtracking_point);
507 }
508
509 DFSExplorer::DFSExplorer(const std::vector<char*>& args, ReductionMode mode, bool need_memory_info)
510     : Exploration(args, need_memory_info || _sg_mc_termination
511 #if SIMGRID_HAVE_STATEFUL_MC
512                             || _sg_mc_checkpoint > 0
513 #endif
514                   )
515     , reduction_mode_(mode)
516 {
517   if (_sg_mc_termination) {
518     if (mode != ReductionMode::none) {
519       XBT_INFO("Check non progressive cycles (turning DPOR off)");
520       reduction_mode_ = ReductionMode::none;
521     } else {
522       XBT_INFO("Check non progressive cycles");
523     }
524   } else
525     XBT_INFO("Start a DFS exploration. Reduction is: %s.", to_c_str(reduction_mode_));
526
527   auto initial_state = std::make_shared<State>(get_remote_app());
528
529   XBT_DEBUG("**************************************************");
530
531   stack_.emplace_back(std::move(initial_state));
532
533   /* Get an enabled actor and insert it in the interleave set of the initial state */
534   XBT_DEBUG("Initial state. %lu actors to consider", stack_.back()->get_actor_count());
535   if (reduction_mode_ == ReductionMode::dpor)
536     stack_.back()->consider_best();
537   else {
538     stack_.back()->consider_all();
539   }
540   if (stack_.back()->count_todo_multiples() > 1)
541     opened_states_.emplace_back(stack_.back());
542 }
543
544 Exploration* create_dfs_exploration(const std::vector<char*>& args, ReductionMode mode)
545 {
546   return new DFSExplorer(args, mode);
547 }
548
549 } // namespace simgrid::mc