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