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 <memory>
  26 #include <string>
  27 #include <vector>
  28
  29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dfs, mc, "DFS exploration algorithm of the model-checker");
  30
  31 namespace simgrid::mc {
  32
  33 xbt::signal<void(RemoteApp&)> DFSExplorer::on_exploration_start_signal;
  34 xbt::signal<void(RemoteApp&)> DFSExplorer::on_backtracking_signal;
  35
  36 xbt::signal<void(State*, RemoteApp&)> DFSExplorer::on_state_creation_signal;
  37
  38 xbt::signal<void(State*, RemoteApp&)> DFSExplorer::on_restore_system_state_signal;
  39 xbt::signal<void(RemoteApp&)> DFSExplorer::on_restore_initial_state_signal;
  40 xbt::signal<void(Transition*, RemoteApp&)> DFSExplorer::on_transition_replay_signal;
  41 xbt::signal<void(Transition*, RemoteApp&)> DFSExplorer::on_transition_execute_signal;
  42
  43 xbt::signal<void(RemoteApp&)> DFSExplorer::on_log_state_signal;
  44
  45 void DFSExplorer::check_non_termination(const State* current_state)
  46 {
  47 #if SIMGRID_HAVE_STATEFUL_MC
  48   for (auto const& state : stack_) {
  49     if (state->get_system_state()->equals_to(*current_state->get_system_state(),
  50                                              *get_remote_app().get_remote_process_memory())) {
  51       XBT_INFO("Non-progressive cycle: state %ld -> state %ld", state->get_num(), current_state->get_num());
  52       XBT_INFO("******************************************");
  53       XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
  54       XBT_INFO("******************************************");
  55       XBT_INFO("Counter-example execution trace:");
  56       for (auto const& s : get_textual_trace())
  57         XBT_INFO("  %s", s.c_str());
  58       XBT_INFO("You can debug the problem (and see the whole details) by rerunning out of simgrid-mc with "
  59                "--cfg=model-check/replay:'%s'",
  60                get_record_trace().to_string().c_str());
  61       log_state();
  62
  63       throw TerminationError();
  64     }
  65   }
  66 #endif
  67 }
  68
  69 RecordTrace DFSExplorer::get_record_trace() // override
  70 {
  71   RecordTrace res;
  72   for (auto const& transition : stack_.back()->get_recipe())
  73     res.push_back(transition);
  74   res.push_back(stack_.back()->get_transition());
  75   return res;
  76 }
  77
  78 std::vector<std::string> DFSExplorer::get_textual_trace() // override
  79 {
  80   std::vector<std::string> trace;
  81   for (auto const& transition : stack_.back()->get_recipe()) {
  82     trace.push_back(xbt::string_printf("%ld: %s", transition->aid_, transition->to_string().c_str()));
  83   }
  84   trace.push_back(xbt::string_printf("%ld: %s", stack_.back()->get_transition()->aid_,
  85                                      stack_.back()->get_transition()->to_string().c_str()));
  86   return trace;
  87 }
  88
  89 void DFSExplorer::restore_stack(std::shared_ptr<State> state)
  90 {
  91   stack_.clear();
  92   auto current_state = state;
  93   stack_.emplace_front(current_state);
  94   // condition corresponds to reaching initial state
  95   while (current_state->get_parent_state() != nullptr) {
  96     current_state = current_state->get_parent_state();
  97     stack_.emplace_front(current_state);
  98   }
  99   XBT_DEBUG("Replaced stack by %s", get_record_trace().to_string().c_str());
 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, double> 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     state->execute_next(next, get_remote_app());
 179     on_transition_execute_signal(state->get_transition(), 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()->aid_,
 184              state->get_transition()->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()->to_string().c_str(), state->get_transition()->aid_);
 196     state->add_sleep_set(state->get_transition()); // 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()->aid_;
 204       stack_t tmp_stack = stack_;
 205       while (not tmp_stack.empty()) {
 206         if (State* prev_state = tmp_stack.back().get();
 207             state->get_transition()->aid_ == prev_state->get_transition()->aid_) {
 208           XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->get_transition()->to_string().c_str(),
 209                     prev_state->get_transition()->to_string().c_str(), issuer_id);
 210           tmp_stack.pop_back();
 211           continue;
 212         } else if (prev_state->get_transition()->depends(state->get_transition())) {
 213           XBT_VERB("Dependent Transitions:");
 214           XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
 215           XBT_VERB("  %s (state=%ld)", state->get_transition()->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(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(tmp_stack.back());
 230           }
 231           break;
 232         } else {
 233           XBT_VERB("INDEPENDENT Transitions:");
 234           XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
 235           XBT_VERB("  %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
 236         }
 237         tmp_stack.pop_back();
 238       }
 239     }
 240
 241     // Before leaving that state, if the transition we just took can be taken multiple times, we
 242     // need to give it to the opened states
 243     if (stack_.back()->count_todo_multiples() > 0)
 244       opened_states_.emplace(stack_.back());
 245
 246     if (_sg_mc_termination)
 247       this->check_non_termination(next_state.get());
 248
 249 #if SIMGRID_HAVE_STATEFUL_MC
 250     /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
 251     if (_sg_mc_max_visited_states > 0)
 252       visited_state_ = visited_states_.addVisitedState(next_state->get_num(), next_state.get(), get_remote_app());
 253 #endif
 254
 255     stack_.emplace_back(std::move(next_state));
 256
 257     /* If this is a new state (or if we don't care about state-equality reduction) */
 258     if (visited_state_ == nullptr) {
 259       /* Get an enabled process and insert it in the interleave set of the next state */
 260       if (reduction_mode_ == ReductionMode::dpor)
 261         stack_.back()->consider_best(); // Take only one transition if DPOR: others may be considered later if required
 262       else {
 263         stack_.back()->consider_all();
 264       }
 265
 266       dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(), stack_.back()->get_num(),
 267                  state->get_transition()->dot_string().c_str());
 268 #if SIMGRID_HAVE_STATEFUL_MC
 269     } else {
 270       dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(),
 271                  visited_state_->original_num_ == -1 ? visited_state_->num_ : visited_state_->original_num_,
 272                  state->get_transition()->dot_string().c_str());
 273 #endif
 274     }
 275   }
 276   log_state();
 277 }
 278
 279 void DFSExplorer::backtrack()
 280 {
 281   XBT_VERB("Backtracking from %s", get_record_trace().to_string().c_str());
 282   XBT_DEBUG("%lu alternatives are yet to be explored:", opened_states_.size());
 283
 284   on_backtracking_signal(get_remote_app());
 285   get_remote_app().check_deadlock();
 286
 287   // if no backtracking point, then set the stack_ to empty so we can end the exploration
 288   if (opened_states_.empty()) {
 289     XBT_DEBUG("No more opened point of exploration, the search will end");
 290     stack_.clear();
 291     return;
 292   }
 293
 294   // Take the point with smallest distance
 295   auto backtracking_point = opened_states_.extract(begin(opened_states_)).value();
 296
 297   // if the smallest distance corresponded to no enable actor, remove this and let the
 298   // exploration ask again for a backtrack
 299   if (backtracking_point->next_transition_guided().first == -1) {
 300     XBT_DEBUG("Best backtracking candidates has already been explored. Let's backtrack again");
 301     this->backtrack();
 302     return;
 303   }
 304
 305   // We found a real backtracking point, let's go to it
 306   backtrack_count_++;
 307   XBT_DEBUG("Backtracking to state#%ld", backtracking_point->get_num());
 308
 309 #if SIMGRID_HAVE_STATEFUL_MC
 310   /* If asked to rollback on a state that has a snapshot, restore it */
 311   if (const auto* system_state = backtracking_point->get_system_state()) {
 312     system_state->restore(*get_remote_app().get_remote_process_memory());
 313     on_restore_system_state_signal(backtracking_point.get(), get_remote_app());
 314     this->restore_stack(backtracking_point);
 315     return;
 316   }
 317 #endif
 318
 319   /* if no snapshot, we need to restore the initial state and replay the transitions */
 320   get_remote_app().restore_initial_state();
 321   on_restore_initial_state_signal(get_remote_app());
 322   /* Traverse the stack from the state at position start and re-execute the transitions */
 323   for (auto& state : backtracking_point->get_recipe()) {
 324     state->replay(get_remote_app());
 325     on_transition_replay_signal(state, get_remote_app());
 326     visited_states_count_++;
 327   }
 328   this->restore_stack(backtracking_point);
 329 }
 330
 331 DFSExplorer::DFSExplorer(const std::vector<char*>& args, bool with_dpor, bool need_memory_info)
 332     : Exploration(args, need_memory_info || _sg_mc_termination)
 333 {
 334   if (with_dpor)
 335     reduction_mode_ = ReductionMode::dpor;
 336   else
 337     reduction_mode_ = ReductionMode::none;
 338
 339   if (_sg_mc_termination) {
 340     if (with_dpor) {
 341       XBT_INFO("Check non progressive cycles (turning DPOR off)");
 342       reduction_mode_ = ReductionMode::none;
 343     } else {
 344       XBT_INFO("Check non progressive cycles");
 345     }
 346   } else
 347     XBT_INFO("Start a DFS exploration. Reduction is: %s.", to_c_str(reduction_mode_));
 348
 349   auto initial_state = std::make_shared<State>(get_remote_app());
 350
 351   XBT_DEBUG("**************************************************");
 352
 353   stack_.emplace_back(std::move(initial_state));
 354
 355   /* Get an enabled actor and insert it in the interleave set of the initial state */
 356   XBT_DEBUG("Initial state. %lu actors to consider", stack_.back()->get_actor_count());
 357   if (reduction_mode_ == ReductionMode::dpor)
 358     stack_.back()->consider_best();
 359   else {
 360     stack_.back()->consider_all();
 361   }
 362   if (stack_.back()->count_todo_multiples() > 1)
 363     opened_states_.emplace(stack_.back());
 364 }
 365
 366 Exploration* create_dfs_exploration(const std::vector<char*>& args, bool with_dpor)
 367 {
 368   return new DFSExplorer(args, with_dpor);
 369 }
 370
 371 } // namespace simgrid::mc