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