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