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) {
  97     if (stack_.empty()) {
  98       execution_seq_ = sdpor::Execution();
  99     } else {
 100       execution_seq_ = execution_seq_.get_prefix_up_to(stack_.size() - 1);
 101     }
 102     XBT_DEBUG("Additionally replaced corresponding SDPOR execution stack");
 103   }
 104 }
 105
 106 void DFSExplorer::log_state() // override
 107 {
 108   on_log_state_signal(get_remote_app());
 109   XBT_INFO("DFS exploration ended. %ld unique states visited; %lu backtracks (%lu transition replays, %lu states "
 110            "visited overall)",
 111            State::get_expanded_states(), backtrack_count_, visited_states_count_,
 112            Transition::get_replayed_transitions());
 113   Exploration::log_state();
 114 }
 115
 116 void DFSExplorer::run()
 117 {
 118   on_exploration_start_signal(get_remote_app());
 119   /* This function runs the DFS algorithm the state space.
 120    * We do so iteratively instead of recursively, dealing with the call stack manually.
 121    * This allows one to explore the call stack at will. */
 122
 123   while (not stack_.empty()) {
 124     /* Get current state */
 125     auto state = stack_.back();
 126
 127     XBT_DEBUG("**************************************************");
 128     XBT_DEBUG("Exploration depth=%zu (state:#%ld; %zu interleaves todo)", stack_.size(), state->get_num(),
 129               state->count_todo());
 130
 131     visited_states_count_++;
 132
 133     // Backtrack if we reached the maximum depth
 134     if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
 135       if (reduction_mode_ == ReductionMode::dpor) {
 136         XBT_ERROR("/!\\ Max depth of %d reached! THIS WILL PROBABLY BREAK the dpor reduction /!\\",
 137                   _sg_mc_max_depth.get());
 138         XBT_ERROR("/!\\ If bad things happen, disable dpor with --cfg=model-check/reduction:none /!\\");
 139       } else
 140         XBT_WARN("/!\\ Max depth reached ! /!\\ ");
 141       this->backtrack();
 142       continue;
 143     }
 144
 145 #if SIMGRID_HAVE_STATEFUL_MC
 146     // Backtrack if we are revisiting a state we saw previously while applying state-equality reduction
 147     if (visited_state_ != nullptr) {
 148       XBT_DEBUG("State already visited (equal to state %ld), exploration stopped on this path.",
 149                 visited_state_->original_num_ == -1 ? visited_state_->num_ : visited_state_->original_num_);
 150
 151       visited_state_ = nullptr;
 152       this->backtrack();
 153       continue;
 154     }
 155 #endif
 156
 157     // Search for the next transition
 158     // next_transition returns a pair<aid_t, int> in case we want to consider multiple state (eg. during backtrack)
 159     auto [next, _] = state->next_transition_guided();
 160
 161     if (next < 0) { // If there is no more transition in the current state, backtrack.
 162       XBT_VERB("%lu actors remain, but none of them need to be interleaved (depth %zu).", state->get_actor_count(),
 163                stack_.size() + 1);
 164
 165       if (state->get_actor_count() == 0) {
 166         get_remote_app().finalize_app();
 167         XBT_VERB("Execution came to an end at %s (state: %ld, depth: %zu)", get_record_trace().to_string().c_str(),
 168                  state->get_num(), stack_.size());
 169       }
 170
 171       this->backtrack();
 172       continue;
 173     }
 174
 175     if (_sg_mc_sleep_set && XBT_LOG_ISENABLED(mc_dfs, xbt_log_priority_verbose)) {
 176       XBT_VERB("Sleep set actually containing:");
 177       for (auto& [aid, transition] : state->get_sleep_set())
 178         XBT_VERB("  <%ld,%s>", aid, transition.to_string().c_str());
 179     }
 180
 181     /* Actually answer the request: let's execute the selected request (MCed does one step) */
 182     const auto executed_transition = state->execute_next(next, get_remote_app());
 183     on_transition_execute_signal(state->get_transition_out().get(), get_remote_app());
 184
 185     // If there are processes to interleave and the maximum depth has not been
 186     // reached then perform one step of the exploration algorithm.
 187     XBT_VERB("Execute %ld: %.60s (stack depth: %zu, state: %ld, %zu interleaves)", state->get_transition_out()->aid_,
 188              state->get_transition_out()->to_string().c_str(), stack_.size(), state->get_num(), state->count_todo());
 189
 190     /* Create the new expanded state (copy the state of MCed into our MCer data) */
 191     auto next_state = std::make_shared<State>(get_remote_app(), state);
 192     on_state_creation_signal(next_state.get(), get_remote_app());
 193
 194     /* Sleep set procedure:
 195      * adding the taken transition to the sleep set of the original state.
 196      * <!> Since the parent sleep set is used to compute the child sleep set, this need to be
 197      * done after next_state creation */
 198     XBT_DEBUG("Marking Transition >>%s<< of process %ld done and adding it to the sleep set",
 199               state->get_transition_out()->to_string().c_str(), state->get_transition_out()->aid_);
 200     state->add_sleep_set(state->get_transition_out()); // Actors are marked done when they are considerd in ActorState
 201
 202     /* DPOR persistent set procedure:
 203      * for each new transition considered, check if it depends on any other previous transition executed before it
 204      * on another process. If there exists one, find the more recent, and add its process to the interleave set.
 205      * If the process is not enabled at this  point, then add every enabled process to the interleave */
 206     if (reduction_mode_ == ReductionMode::dpor) {
 207       aid_t issuer_id   = state->get_transition_out()->aid_;
 208       stack_t tmp_stack = stack_;
 209       while (not tmp_stack.empty()) {
 210         if (const State* prev_state = tmp_stack.back().get();
 211             state->get_transition_out()->aid_ == prev_state->get_transition_out()->aid_) {
 212           XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->get_transition_out()->to_string().c_str(),
 213                     prev_state->get_transition_out()->to_string().c_str(), issuer_id);
 214           tmp_stack.pop_back();
 215           continue;
 216         } else if (prev_state->get_transition_out()->depends(state->get_transition_out().get())) {
 217           XBT_VERB("Dependent Transitions:");
 218           XBT_VERB("  %s (state=%ld)", prev_state->get_transition_out()->to_string().c_str(), prev_state->get_num());
 219           XBT_VERB("  %s (state=%ld)", state->get_transition_out()->to_string().c_str(), state->get_num());
 220
 221           if (prev_state->is_actor_enabled(issuer_id)) {
 222             if (not prev_state->is_actor_done(issuer_id)) {
 223               prev_state->consider_one(issuer_id);
 224               opened_states_.emplace_back(tmp_stack.back());
 225             } else
 226               XBT_DEBUG("Actor %ld is already in done set: no need to explore it again", issuer_id);
 227           } else {
 228             XBT_DEBUG("Actor %ld is not enabled: DPOR may be failing. To stay sound, we are marking every enabled "
 229                       "transition as todo",
 230                       issuer_id);
 231             // If we ended up marking at least a transition, explore it at some point
 232             if (prev_state->consider_all() > 0)
 233               opened_states_.emplace_back(tmp_stack.back());
 234           }
 235           break;
 236         } else {
 237           XBT_VERB("INDEPENDENT Transitions:");
 238           XBT_VERB("  %s (state=%ld)", prev_state->get_transition_out()->to_string().c_str(), prev_state->get_num());
 239           XBT_VERB("  %s (state=%ld)", state->get_transition_out()->to_string().c_str(), state->get_num());
 240         }
 241         tmp_stack.pop_back();
 242       }
 243     } else if (reduction_mode_ == ReductionMode::sdpor) {
 244       /**
 245        * SDPOR Source Set Procedure:
 246        *
 247        * Find "reversible races" in the current execution with respect
 248        * to the latest action `p`. For each such race, determine one thread
 249        * not contained in the backtrack set at the "race point" `r` which
 250        * "represents" the trace formed by first executing everything after
 251        * `r` and then `p` to flip the race
 252        */
 253       execution_seq_.push_transition(executed_transition.get());
 254
 255       xbt_assert(execution_seq_.get_latest_event_handle().has_value(),
 256                  "No events are contained in the SDPOR/OPDPOR execution "
 257                  "even though one was just added");
 258       const aid_t p       = executed_transition->aid_;
 259       const auto next_E_p = execution_seq_.get_latest_event_handle().value();
 260
 261       for (const auto racing_event_handle : execution_seq_.get_racing_events_of(next_E_p)) {
 262         // To determine if the race is reversible, we have to ensure
 263         // that actor `p` running `next_E_p` (viz. the event such that
 264         // `racing_event -> (E_p) next_E_p` and no other event
 265         // "happens-between" the two) is enabled in any equivalent
 266         // execution where `racing_event` happens before `next_E_p`.
 267         //
 268         // Importantly, it is equivalent to checking if in ANY
 269         // such equivalent execution sequence where `racing_event`
 270         // happens-before `next_E_p` that `p` is enabled in `pre(racing_event, E.p)`.
 271         // Thus it suffices to check THIS execution
 272         //
 273         // If the actor `p` is not enabled at s_[E'], it is not a *reversible* race
 274         const std::shared_ptr<State> prev_state = stack_[racing_event_handle];
 275         if (prev_state->is_actor_enabled(p)) {
 276           // NOTE: To incorporate the idea of attempting to select the "best"
 277           // backtrack point into SDPOR, instead of selecting the `first` initial,
 278           // we should instead compute all choices and decide which is bes
 279           const std::optional<aid_t> q =
 280               execution_seq_.get_first_ssdpor_initial_from(racing_event_handle, prev_state->get_backtrack_set());
 281           if (q.has_value()) {
 282             prev_state->consider_one(q.value());
 283             opened_states_.emplace_back(std::move(prev_state));
 284           }
 285         }
 286       }
 287     }
 288
 289     // Before leaving that state, if the transition we just took can be taken multiple times, we
 290     // need to give it to the opened states
 291     if (stack_.back()->count_todo_multiples() > 0)
 292       opened_states_.emplace_back(stack_.back());
 293
 294     if (_sg_mc_termination)
 295       this->check_non_termination(next_state.get());
 296
 297 #if SIMGRID_HAVE_STATEFUL_MC
 298     /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction)
 299      */
 300     if (_sg_mc_max_visited_states > 0)
 301       visited_state_ = visited_states_.addVisitedState(next_state->get_num(), next_state.get(), get_remote_app());
 302 #endif
 303
 304     stack_.emplace_back(std::move(next_state));
 305
 306     /* If this is a new state (or if we don't care about state-equality reduction) */
 307     if (visited_state_ == nullptr) {
 308       /* Get an enabled process and insert it in the interleave set of the next state */
 309       if (reduction_mode_ == ReductionMode::dpor)
 310         stack_.back()->consider_best(); // Take only one transition if DPOR: others may be considered later if required
 311       else {
 312         stack_.back()->consider_all();
 313       }
 314
 315       dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(), stack_.back()->get_num(),
 316                  state->get_transition_out()->dot_string().c_str());
 317 #if SIMGRID_HAVE_STATEFUL_MC
 318     } else {
 319       dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(),
 320                  visited_state_->original_num_ == -1 ? visited_state_->num_ : visited_state_->original_num_,
 321                  state->get_transition_out()->dot_string().c_str());
 322 #endif
 323     }
 324   }
 325   log_state();
 326 }
 327
 328 std::shared_ptr<State> DFSExplorer::best_opened_state()
 329 {
 330   int best_prio = 0; // cache the value for the best priority found so far (initialized to silence gcc)
 331   auto best     = end(opened_states_);   // iterator to the state to explore having the best priority
 332   auto valid    = begin(opened_states_); // iterator marking the limit between states still to explore, and already
 333                                          // explored ones
 334
 335   // Keep only still non-explored states (aid != -1), and record the one with the best (greater) priority.
 336   for (auto current = begin(opened_states_); current != end(opened_states_); ++current) {
 337     auto [aid, prio] = (*current)->next_transition_guided();
 338     if (aid == -1)
 339       continue;
 340     if (valid != current)
 341       *valid = std::move(*current);
 342     if (best == end(opened_states_) || prio > best_prio) {
 343       best_prio = prio;
 344       best      = valid;
 345     }
 346     ++valid;
 347   }
 348
 349   std::shared_ptr<State> best_state;
 350   if (best < valid) {
 351     // There are non-explored states, and one of them has the best priority.  Remove it from opened_states_ before
 352     // returning.
 353     best_state = std::move(*best);
 354     --valid;
 355     if (best != valid)
 356       *best = std::move(*valid);
 357   }
 358   opened_states_.erase(valid, end(opened_states_));
 359
 360   return best_state;
 361 }
 362
 363 void DFSExplorer::backtrack()
 364 {
 365   XBT_VERB("Backtracking from %s", get_record_trace().to_string().c_str());
 366   XBT_DEBUG("%lu alternatives are yet to be explored:", opened_states_.size());
 367
 368   on_backtracking_signal(get_remote_app());
 369   get_remote_app().check_deadlock();
 370
 371   // Take the point with smallest distance
 372   auto backtracking_point = best_opened_state();
 373
 374   // if no backtracking point, then set the stack_ to empty so we can end the exploration
 375   if (not backtracking_point) {
 376     XBT_DEBUG("No more opened point of exploration, the search will end");
 377     stack_.clear();
 378     return;
 379   }
 380
 381   // We found a backtracking point, let's go to it
 382   backtrack_count_++;
 383   XBT_DEBUG("Backtracking to state#%ld", backtracking_point->get_num());
 384
 385 #if SIMGRID_HAVE_STATEFUL_MC
 386   /* If asked to rollback on a state that has a snapshot, restore it */
 387   if (const auto* system_state = backtracking_point->get_system_state()) {
 388     system_state->restore(*get_remote_app().get_remote_process_memory());
 389     on_restore_system_state_signal(backtracking_point.get(), get_remote_app());
 390     this->restore_stack(backtracking_point);
 391     return;
 392   }
 393 #endif
 394
 395   // Search how to restore the backtracking point
 396   State* init_state = nullptr;
 397   std::deque<Transition*> replay_recipe;
 398   for (auto* s = backtracking_point.get(); s != nullptr; s = s->get_parent_state().get()) {
 399 #if SIMGRID_HAVE_STATEFUL_MC
 400     if (s->get_system_state() != nullptr) { // Found a state that I can restore
 401       init_state = s;
 402       break;
 403     }
 404 #endif
 405     if (s->get_transition_in() != nullptr) // The root has no transition_in
 406       replay_recipe.push_front(s->get_transition_in().get());
 407   }
 408
 409   // Restore the init_state, if any
 410   if (init_state != nullptr) {
 411 #if SIMGRID_HAVE_STATEFUL_MC
 412     const auto* system_state = init_state->get_system_state();
 413     system_state->restore(*get_remote_app().get_remote_process_memory());
 414     on_restore_system_state_signal(init_state, get_remote_app());
 415 #endif
 416   } else { // Restore the initial state if no intermediate state was found
 417     get_remote_app().restore_initial_state();
 418     on_restore_initial_state_signal(get_remote_app());
 419   }
 420
 421   /* if no snapshot, we need to restore the initial state and replay the transitions */
 422   /* Traverse the stack from the state at position start and re-execute the transitions */
 423   for (auto& transition : replay_recipe) {
 424     transition->replay(get_remote_app());
 425     on_transition_replay_signal(transition, get_remote_app());
 426     visited_states_count_++;
 427   }
 428   this->restore_stack(backtracking_point);
 429 }
 430
 431 DFSExplorer::DFSExplorer(const std::vector<char*>& args, bool with_dpor, bool need_memory_info)
 432     : Exploration(args, need_memory_info || _sg_mc_termination
 433 #if SIMGRID_HAVE_STATEFUL_MC
 434                             || _sg_mc_checkpoint > 0
 435 #endif
 436       )
 437 {
 438   if (with_dpor)
 439     reduction_mode_ = ReductionMode::dpor;
 440   else
 441     reduction_mode_ = ReductionMode::none;
 442
 443   if (_sg_mc_termination) {
 444     if (with_dpor) {
 445       XBT_INFO("Check non progressive cycles (turning DPOR off)");
 446       reduction_mode_ = ReductionMode::none;
 447     } else {
 448       XBT_INFO("Check non progressive cycles");
 449     }
 450   } else
 451     XBT_INFO("Start a DFS exploration. Reduction is: %s.", to_c_str(reduction_mode_));
 452
 453   auto initial_state = std::make_shared<State>(get_remote_app());
 454
 455   XBT_DEBUG("**************************************************");
 456
 457   stack_.emplace_back(std::move(initial_state));
 458
 459   /* Get an enabled actor and insert it in the interleave set of the initial state */
 460   XBT_DEBUG("Initial state. %lu actors to consider", stack_.back()->get_actor_count());
 461   if (reduction_mode_ == ReductionMode::dpor)
 462     stack_.back()->consider_best();
 463   else {
 464     stack_.back()->consider_all();
 465   }
 466   if (stack_.back()->count_todo_multiples() > 1)
 467     opened_states_.emplace_back(stack_.back());
 468 }
 469
 470 Exploration* create_dfs_exploration(const std::vector<char*>& args, bool with_dpor)
 471 {
 472   return new DFSExplorer(args, with_dpor);
 473 }
 474
 475 } // namespace simgrid::mc