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_VERB("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     next_state = std::make_unique<State>(get_remote_app(), state);
 167     on_state_creation_signal(next_state.get(), get_remote_app());
 168
 169     /* Sleep set procedure:
 170      * adding the taken transition to the sleep set of the original state.
 171      * <!> Since the parent sleep set is used to compute the child sleep set, this need to be
 172      * done after next_state creation */
 173     XBT_DEBUG("Marking Transition >>%s<< of process %ld done and adding it to the sleep set",
 174               state->get_transition()->to_string().c_str(), state->get_transition()->aid_);
 175     state->add_sleep_set(state->get_transition()); // Actors are marked done when they are considerd in ActorState
 176
 177     /* DPOR persistent set procedure:
 178      * for each new transition considered, check if it depends on any other previous transition executed before it
 179      * on another process. If there exists one, find the more recent, and add its process to the interleave set.
 180      * If the process is not enabled at this  point, then add every enabled process to the interleave */
 181     if (reduction_mode_ == ReductionMode::dpor) {
 182       aid_t issuer_id   = state->get_transition()->aid_;
 183       stack_t tmp_stack;
 184       for (auto& state : stack_)
 185         tmp_stack.push_back(std::make_shared<State>(State(*state)));
 186       while (not tmp_stack.empty()) {
 187         State* prev_state = tmp_stack.back().get();
 188         if (state->get_transition()->aid_ == prev_state->get_transition()->aid_) {
 189           XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->get_transition()->to_string().c_str(),
 190                     prev_state->get_transition()->to_string().c_str(), issuer_id);
 191           tmp_stack.pop_back();
 192           continue;
 193         } else if (prev_state->get_transition()->depends(state->get_transition())) {
 194           XBT_VERB("Dependent Transitions:");
 195           XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
 196           XBT_VERB("  %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
 197
 198           if (prev_state->is_actor_enabled(issuer_id)) {
 199             if (not prev_state->is_actor_done(issuer_id)) {
 200               prev_state->consider_one(issuer_id);
 201               opened_states.emplace_back(tmp_stack);
 202             } else
 203               XBT_DEBUG("Actor %ld is already in done set: no need to explore it again", issuer_id);
 204           } else {
 205             XBT_DEBUG("Actor %ld is not enabled: DPOR may be failing. To stay sound, we are marking every enabled "
 206                       "transition as todo",
 207                       issuer_id);
 208             prev_state->consider_all();
 209             opened_states.emplace_back(tmp_stack);
 210           }
 211           break;
 212         } else {
 213           XBT_VERB("INDEPENDENT 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         tmp_stack.pop_back();
 218       }
 219     }
 220
 221     if (_sg_mc_termination)
 222       this->check_non_termination(next_state.get());
 223
 224     /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
 225     if (_sg_mc_max_visited_states > 0)
 226       visited_state_ = visited_states_.addVisitedState(next_state->get_num(), next_state.get(), get_remote_app());
 227
 228     stack_.push_back(std::move(next_state));
 229
 230     /* If this is a new state (or if we don't care about state-equality reduction) */
 231     if (visited_state_ == nullptr) {
 232       /* Get an enabled process and insert it in the interleave set of the next state */
 233       if (reduction_mode_ == ReductionMode::dpor)
 234         stack_.back()->consider_best(); // Take only one transition if DPOR: others may be considered later if required
 235       else {
 236         stack_.back()->consider_all();
 237         opened_states.emplace_back(stack_);
 238       }
 239       dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(), stack_.back()->get_num(),
 240                  state->get_transition()->dot_string().c_str());
 241     } else
 242       dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(),
 243                  visited_state_->original_num_ == -1 ? visited_state_->num_ : visited_state_->original_num_,
 244                  state->get_transition()->dot_string().c_str());
 245   }
 246
 247   log_state();
 248 }
 249
 250 void DFSExplorer::backtrack()
 251 {
 252   backtrack_count_++;
 253   XBT_VERB("Backtracking from %s", get_record_trace().to_string().c_str());
 254   on_backtracking_signal(get_remote_app());
 255   get_remote_app().check_deadlock();
 256
 257   // if no backtracking point, then set the stack_ to empty so we can end the exploration
 258   if (opened_states.size() == 0) {
 259     stack_ = std::list<std::shared_ptr<State>>();
 260     return;
 261   }
 262
 263   /* We may backtrack from somewhere either because it's leaf, or because every enabled process are in done/sleep set.
 264    * In the first case, we need to remove the last transition corresponding to the Finalize */
 265   if (stack_.back()->get_transition()->aid_ == 0)
 266     stack_.pop_back();
 267
 268   stack_t backtrack;
 269   double min_dist = std::numeric_limits<double>::infinity();
 270   aid_t min_aid   = -1;
 271   for (auto& stack : opened_states) {
 272     auto [aid, dist] = stack.back()->next_transition_guided();
 273     if (aid == -1)
 274       continue;
 275     if (dist < min_dist) {
 276       min_dist  = dist;
 277       min_aid   = aid;
 278       backtrack = stack;
 279     }
 280   }
 281
 282   if (min_aid == -1) {
 283     stack_ = std::list<std::shared_ptr<State>>();
 284     return;
 285   }
 286
 287   if (backtrack.back()->count_todo() <= 1)
 288     opened_states.pop_back();
 289
 290   /* If asked to rollback on a state that has a snapshot, restore it */
 291   State* last_state = backtrack.back().get();
 292   if (const auto* system_state = last_state->get_system_state()) {
 293     system_state->restore(*get_remote_app().get_remote_process_memory());
 294     on_restore_system_state_signal(last_state, get_remote_app());
 295     stack_ = backtrack;
 296     return;
 297   }
 298
 299   /* if no snapshot, we need to restore the initial state and replay the transitions */
 300   get_remote_app().restore_initial_state();
 301   on_restore_initial_state_signal(get_remote_app());
 302   /* Traverse the stack from the state at position start and re-execute the transitions */
 303   for (std::shared_ptr<State> const& state : backtrack) {
 304     if (state == backtrack.back()) /* If we are arrived on the target state, don't replay the outgoing transition */
 305       break;
 306     state->get_transition()->replay(get_remote_app());
 307     on_transition_replay_signal(state->get_transition(), get_remote_app());
 308     visited_states_count_++;
 309   }
 310   stack_ = backtrack;
 311   XBT_DEBUG(">> Backtracked to %s", get_record_trace().to_string().c_str());
 312 }
 313
 314 // DFSExplorer::DFSExplorer(const std::vector<char*>& args, bool with_dpor) : Exploration(args, _sg_mc_termination) //
 315 // UNCOMMENT TO ACTIVATE REFORKS
 316 DFSExplorer::DFSExplorer(const std::vector<char*>& args, bool with_dpor)
 317     : Exploration(args, true) // This version does not use reforks as it breaks
 318 {
 319   if (with_dpor)
 320     reduction_mode_ = ReductionMode::dpor;
 321   else
 322     reduction_mode_ = ReductionMode::none;
 323
 324   if (_sg_mc_termination) {
 325     if (with_dpor) {
 326       XBT_INFO("Check non progressive cycles (turning DPOR off)");
 327       reduction_mode_ = ReductionMode::none;
 328     } else {
 329       XBT_INFO("Check non progressive cycles");
 330     }
 331   } else
 332     XBT_INFO("Start a DFS exploration. Reduction is: %s.", to_c_str(reduction_mode_));
 333
 334   auto initial_state = std::make_unique<State>(get_remote_app());
 335
 336   XBT_DEBUG("**************************************************");
 337
 338   stack_.push_back(std::move(initial_state));
 339
 340   /* Get an enabled actor and insert it in the interleave set of the initial state */
 341   XBT_DEBUG("Initial state. %lu actors to consider", initial_state->get_actor_count());
 342   if (reduction_mode_ == ReductionMode::dpor)
 343     stack_.back()->consider_best();
 344   else {
 345     stack_.back()->consider_all();
 346     opened_states.emplace_back(stack_);
 347   }
 348 }
 349
 350 Exploration* create_dfs_exploration(const std::vector<char*>& args, bool with_dpor)
 351 {
 352   return new DFSExplorer(args, with_dpor);
 353 }
 354
 355 } // namespace simgrid::mc