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