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