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/VisitedState.hpp"
   8 #include "src/mc/mc_config.hpp"
   9 #include "src/mc/mc_exit.hpp"
  10 #include "src/mc/mc_private.hpp"
  11 #include "src/mc/mc_record.hpp"
  12 #include "src/mc/transition/Transition.hpp"
  13
  14 #include "src/xbt/mmalloc/mmprivate.h"
  15 #include "xbt/log.h"
  16 #include "xbt/string.hpp"
  17 #include "xbt/sysdep.h"
  18
  19 #include <cassert>
  20 #include <cstdio>
  21
  22 #include <memory>
  23 #include <string>
  24 #include <vector>
  25
  26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dfs, mc, "DFS exploration algorithm of the model-checker");
  27
  28 namespace simgrid::mc {
  29
  30 xbt::signal<void(RemoteApp&)> DFSExplorer::on_exploration_start_signal;
  31 xbt::signal<void(RemoteApp&)> DFSExplorer::on_backtracking_signal;
  32
  33 xbt::signal<void(State*, RemoteApp&)> DFSExplorer::on_state_creation_signal;
  34
  35 xbt::signal<void(State*, RemoteApp&)> DFSExplorer::on_restore_system_state_signal;
  36 xbt::signal<void(RemoteApp&)> DFSExplorer::on_restore_initial_state_signal;
  37 xbt::signal<void(Transition*, RemoteApp&)> DFSExplorer::on_transition_replay_signal;
  38 xbt::signal<void(Transition*, RemoteApp&)> DFSExplorer::on_transition_execute_signal;
  39
  40 xbt::signal<void(RemoteApp&)> DFSExplorer::on_log_state_signal;
  41
  42 void DFSExplorer::check_non_termination(const State* current_state)
  43 {
  44   for (auto const& state : stack_) {
  45     if (state->get_system_state()->equals_to(*current_state->get_system_state(),
  46                                              get_remote_app().get_remote_process_memory())) {
  47       XBT_INFO("Non-progressive cycle: state %ld -> state %ld", state->get_num(), current_state->get_num());
  48       XBT_INFO("******************************************");
  49       XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
  50       XBT_INFO("******************************************");
  51       XBT_INFO("Counter-example execution trace:");
  52       for (auto const& s : get_textual_trace())
  53         XBT_INFO("  %s", s.c_str());
  54       XBT_INFO("You can debug the problem (and see the whole details) by rerunning out of simgrid-mc with "
  55                "--cfg=model-check/replay:'%s'",
  56                get_record_trace().to_string().c_str());
  57       log_state();
  58
  59       throw TerminationError();
  60     }
  61   }
  62 }
  63
  64 RecordTrace DFSExplorer::get_record_trace() // override
  65 {
  66   RecordTrace res;
  67   for (auto const& state : stack_)
  68     res.push_back(state->get_transition());
  69   return res;
  70 }
  71
  72 std::vector<std::string> DFSExplorer::get_textual_trace() // override
  73 {
  74   std::vector<std::string> trace;
  75   for (auto const& state : stack_) {
  76     const auto* t = state->get_transition();
  77     trace.push_back(xbt::string_printf("%ld: %s", t->aid_, t->to_string().c_str()));
  78   }
  79   return trace;
  80 }
  81
  82 void DFSExplorer::log_state() // override
  83 {
  84   on_log_state_signal(get_remote_app());
  85   XBT_INFO("DFS exploration ended. %ld unique states visited; %lu backtracks (%lu transition replays, %lu states "
  86            "visited overall)",
  87            State::get_expanded_states(), backtrack_count_, visited_states_count_,
  88            Transition::get_replayed_transitions());
  89   Exploration::log_state();
  90 }
  91
  92 void DFSExplorer::run()
  93 {
  94   on_exploration_start_signal(get_remote_app());
  95   /* This function runs the DFS algorithm the state space.
  96    * We do so iteratively instead of recursively, dealing with the call stack manually.
  97    * This allows one to explore the call stack at will. */
  98
  99   while (not stack_.empty()) {
 100     /* Get current state */
 101     State* state = stack_.back().get();
 102
 103     XBT_DEBUG("**************************************************");
 104     XBT_DEBUG("Exploration depth=%zu (state:#%ld; %zu interleaves todo)", stack_.size(), state->get_num(),
 105               state->count_todo());
 106
 107     visited_states_count_++;
 108
 109     // Backtrack if we reached the maximum depth
 110     if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
 111       if (reduction_mode_ == ReductionMode::dpor) {
 112         XBT_ERROR("/!\\ Max depth of %d reached! THIS WILL PROBABLY BREAK the dpor reduction /!\\",
 113                   _sg_mc_max_depth.get());
 114         XBT_ERROR("/!\\ If bad things happen, disable dpor with --cfg=model-check/reduction:none /!\\");
 115       } else
 116         XBT_WARN("/!\\ Max depth reached ! /!\\ ");
 117       this->backtrack();
 118       continue;
 119     }
 120
 121     // Backtrack if we are revisiting a state we saw previously while applying state-equality reduction
 122     if (visited_state_ != nullptr) {
 123       XBT_DEBUG("State already visited (equal to state %ld), exploration stopped on this path.",
 124                 visited_state_->original_num_ == -1 ? visited_state_->num_ : visited_state_->original_num_);
 125
 126       visited_state_ = nullptr;
 127       this->backtrack();
 128       continue;
 129     }
 130
 131     // Search for the next transition
 132     // next_transition returns a pair<aid_t, double> in case we want to consider multiple state
 133     auto [next, _] = state->next_transition_guided();
 134
 135     if (next < 0) { // If there is no more transition in the current state, backtrack.
 136       XBT_DEBUG("There remains %lu actors, but none to interleave (depth %zu).", state->get_actor_count(),
 137                 stack_.size() + 1);
 138
 139       if (state->get_actor_count() == 0) {
 140         get_remote_app().finalize_app();
 141         XBT_VERB("Execution came to an end at %s (state: %ld, depth: %zu)", get_record_trace().to_string().c_str(),
 142                  state->get_num(), stack_.size());
 143       }
 144
 145       this->backtrack();
 146       continue;
 147     }
 148
 149     if (_sg_mc_sleep_set && XBT_LOG_ISENABLED(mc_dfs, xbt_log_priority_verbose)) {
 150       XBT_VERB("Sleep set actually containing:");
 151       for (auto& [aid, transition] : state->get_sleep_set())
 152         XBT_VERB("  <%ld,%s>", aid, transition.to_string().c_str());
 153     }
 154
 155     /* Actually answer the request: let's execute the selected request (MCed does one step) */
 156     state->execute_next(next, get_remote_app());
 157     on_transition_execute_signal(state->get_transition(), get_remote_app());
 158
 159     // If there are processes to interleave and the maximum depth has not been
 160     // reached then perform one step of the exploration algorithm.
 161     XBT_VERB("Execute %ld: %.60s (stack depth: %zu, state: %ld, %zu interleaves)", state->get_transition()->aid_,
 162              state->get_transition()->to_string().c_str(), stack_.size(), state->get_num(), state->count_todo());
 163
 164     /* Create the new expanded state (copy the state of MCed into our MCer data) */
 165     std::unique_ptr<State> next_state;
 166
 167     next_state = std::make_unique<State>(get_remote_app(), state);
 168     on_state_creation_signal(next_state.get(), get_remote_app());
 169
 170     /* Sleep set procedure:
 171      * adding the taken transition to the sleep set of the original state.
 172      * <!> Since the parent sleep set is used to compute the child sleep set, this need to be
 173      * done after next_state creation */
 174     XBT_DEBUG("Marking Transition >>%s<< of process %ld done and adding it to the sleep set",
 175               state->get_transition()->to_string().c_str(), state->get_transition()->aid_);
 176     state->add_sleep_set(state->get_transition()); // Actors are marked done when they are considerd in ActorState
 177
 178     /* DPOR persistent set procedure:
 179      * for each new transition considered, check if it depends on any other previous transition executed before it
 180      * on another process. If there exists one, find the more recent, and add its process to the interleave set.
 181      * If the process is not enabled at this  point, then add every enabled process to the interleave */
 182     if (reduction_mode_ == ReductionMode::dpor) {
 183       aid_t issuer_id = state->get_transition()->aid_;
 184       for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
 185         State* prev_state = i->get();
 186         if (state->get_transition()->aid_ == prev_state->get_transition()->aid_) {
 187           XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->get_transition()->to_string().c_str(),
 188                     prev_state->get_transition()->to_string().c_str(), issuer_id);
 189           continue;
 190         } else if (prev_state->get_transition()->depends(state->get_transition())) {
 191           XBT_VERB("Dependent Transitions:");
 192           XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
 193           XBT_VERB("  %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
 194
 195           if (prev_state->is_actor_enabled(issuer_id)) {
 196             if (not prev_state->is_actor_done(issuer_id))
 197               prev_state->consider_one(issuer_id);
 198             else
 199               XBT_DEBUG("Actor %ld is already in done set: no need to explore it again", issuer_id);
 200           } else {
 201             XBT_DEBUG("Actor %ld is not enabled: DPOR may be failing. To stay sound, we are marking every enabled "
 202                       "transition as todo",
 203                       issuer_id);
 204             prev_state->consider_all();
 205           }
 206           break;
 207         } else {
 208           XBT_VERB("INDEPENDENT Transitions:");
 209           XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
 210           XBT_VERB("  %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
 211         }
 212       }
 213     }
 214
 215     if (_sg_mc_termination)
 216       this->check_non_termination(next_state.get());
 217
 218     /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
 219     if (_sg_mc_max_visited_states > 0)
 220       visited_state_ = visited_states_.addVisitedState(next_state->get_num(), next_state.get(), get_remote_app());
 221
 222     /* If this is a new state (or if we don't care about state-equality reduction) */
 223     if (visited_state_ == nullptr) {
 224       /* Get an enabled process and insert it in the interleave set of the next state */
 225       if (reduction_mode_ == ReductionMode::dpor)
 226         next_state->consider_best(); // Take only one transition if DPOR: others may be considered later if required
 227       else
 228         next_state->consider_all();
 229
 230       dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(), next_state->get_num(),
 231                  state->get_transition()->dot_string().c_str());
 232     } else
 233       dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(),
 234                  visited_state_->original_num_ == -1 ? visited_state_->num_ : visited_state_->original_num_,
 235                  state->get_transition()->dot_string().c_str());
 236
 237     stack_.push_back(std::move(next_state));
 238   }
 239
 240   log_state();
 241 }
 242
 243 void DFSExplorer::backtrack()
 244 {
 245   backtrack_count_++;
 246   XBT_VERB("Backtracking from %s", get_record_trace().to_string().c_str());
 247   on_backtracking_signal(get_remote_app());
 248   get_remote_app().check_deadlock();
 249
 250   /* We may backtrack from somewhere either because it's leaf, or because every enabled process are in done/sleep set.
 251    * In the first case, we need to remove the last transition corresponding to the Finalize */
 252   if (stack_.back()->get_transition()->aid_ == 0)
 253     stack_.pop_back();
 254
 255   /* Traverse the stack backwards until a state with a non empty interleave set is found, deleting all the states that
 256    *  have it empty in the way. */
 257   bool found_backtracking_point = false;
 258   while (not stack_.empty() && not found_backtracking_point) {
 259     std::unique_ptr<State> state = std::move(stack_.back());
 260
 261     stack_.pop_back();
 262
 263
 264     if (state->count_todo() == 0) { // Empty interleaving set: exploration at this level is over
 265       XBT_DEBUG("Delete state %ld at depth %zu", state->get_num(), stack_.size() + 1);
 266
 267     } else {
 268       XBT_DEBUG("Back-tracking to state %ld at depth %zu: %lu transitions left to be explored", state->get_num(),
 269                 stack_.size() + 1, state->count_todo());
 270       stack_.push_back(
 271           std::move(state)); // Put it back on the stack so we can explore the next transition of the interleave
 272       found_backtracking_point = true;
 273     }
 274   }
 275
 276   if (found_backtracking_point) {
 277     /* If asked to rollback on a state that has a snapshot, restore it */
 278     State* last_state = stack_.back().get();
 279     if (const auto* system_state = last_state->get_system_state()) {
 280       system_state->restore(get_remote_app().get_remote_process_memory());
 281       on_restore_system_state_signal(last_state, get_remote_app());
 282       return;
 283     }
 284
 285     /* if no snapshot, we need to restore the initial state and replay the transitions */
 286     get_remote_app().restore_initial_state();
 287     on_restore_initial_state_signal(get_remote_app());
 288
 289     /* Traverse the stack from the state at position start and re-execute the transitions */
 290     for (std::unique_ptr<State> const& state : stack_) {
 291       if (state == stack_.back()) /* If we are arrived on the target state, don't replay the outgoing transition */
 292         break;
 293       state->get_transition()->replay(get_remote_app());
 294       on_transition_replay_signal(state->get_transition(), get_remote_app());
 295       visited_states_count_++;
 296     }
 297   } // If no backtracing point, then the stack is empty and the exploration is over
 298 }
 299
 300 DFSExplorer::DFSExplorer(const std::vector<char*>& args, bool with_dpor) : Exploration(args, true)
 301 {
 302   if (with_dpor)
 303     reduction_mode_ = ReductionMode::dpor;
 304   else
 305     reduction_mode_ = ReductionMode::none;
 306
 307   if (_sg_mc_termination) {
 308     if (with_dpor) {
 309       XBT_INFO("Check non progressive cycles (turning DPOR off)");
 310       reduction_mode_ = ReductionMode::none;
 311     } else {
 312       XBT_INFO("Check non progressive cycles");
 313     }
 314   } else
 315     XBT_INFO("Start a DFS exploration. Reduction is: %s.", to_c_str(reduction_mode_));
 316
 317   auto initial_state = std::make_unique<State>(get_remote_app());
 318
 319   XBT_DEBUG("**************************************************");
 320
 321   /* Get an enabled actor and insert it in the interleave set of the initial state */
 322   XBT_DEBUG("Initial state. %lu actors to consider", initial_state->get_actor_count());
 323   if (reduction_mode_ == ReductionMode::dpor)
 324     initial_state->consider_best();
 325   else
 326     initial_state->consider_all();
 327
 328   stack_.push_back(std::move(initial_state));
 329 }
 330
 331 Exploration* create_dfs_exploration(const std::vector<char*>& args, bool with_dpor)
 332 {
 333   return new DFSExplorer(args, with_dpor);
 334 }
 335
 336 } // namespace simgrid::mc