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