src/mc/explo/DFSExplorer.cpp

   1 /* Copyright (c) 2016-2022. 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/sysdep.h"
  17
  18 #include <cassert>
  19 #include <cstdio>
  20
  21 #include <memory>
  22 #include <string>
  23 #include <vector>
  24
  25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dfs, mc, "DFS exploration algorithm of the model-checker");
  26
  27 namespace simgrid::mc {
  28
  29 xbt::signal<void()> DFSExplorer::on_exploration_start_signal;
  30 xbt::signal<void()> DFSExplorer::on_backtracking_signal;
  31
  32 xbt::signal<void(State*)> DFSExplorer::on_state_creation_signal;
  33
  34 xbt::signal<void(State*)> DFSExplorer::on_restore_system_state_signal;
  35 xbt::signal<void()> DFSExplorer::on_restore_initial_state_signal;
  36 xbt::signal<void(Transition*)> DFSExplorer::on_transition_replay_signal;
  37 xbt::signal<void(Transition*)> DFSExplorer::on_transition_execute_signal;
  38
  39 xbt::signal<void()> DFSExplorer::on_log_state_signal;
  40
  41 void DFSExplorer::check_non_termination(const State* current_state)
  42 {
  43   for (auto state = stack_.rbegin(); state != stack_.rend(); ++state)
  44     if (Api::get().snapshot_equal((*state)->get_system_state(), current_state->get_system_state())) {
  45       XBT_INFO("Non-progressive cycle: state %ld -> state %ld", (*state)->get_num(), current_state->get_num());
  46       XBT_INFO("******************************************");
  47       XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
  48       XBT_INFO("******************************************");
  49       XBT_INFO("Counter-example execution trace:");
  50       for (auto const& s : get_textual_trace())
  51         XBT_INFO("  %s", s.c_str());
  52       XBT_INFO("Path = %s", get_record_trace().to_string().c_str());
  53       log_state();
  54
  55       throw TerminationError();
  56     }
  57 }
  58
  59 RecordTrace DFSExplorer::get_record_trace() // override
  60 {
  61   RecordTrace res;
  62   for (auto const& state : stack_)
  63     res.push_back(state->get_transition());
  64   return res;
  65 }
  66
  67 std::vector<std::string> DFSExplorer::get_textual_trace() // override
  68 {
  69   std::vector<std::string> trace;
  70   for (auto const& state : stack_) {
  71     const auto* t = state->get_transition();
  72     trace.push_back(xbt::string_printf("%ld: %s", t->aid_, t->to_string().c_str()));
  73   }
  74   return trace;
  75 }
  76
  77 void DFSExplorer::log_state() // override
  78 {
  79   on_log_state_signal();
  80   XBT_INFO("DFS exploration ended. %ld unique states visited; %ld backtracks (%lu transition replays, %lu states "
  81            "visited overall)",
  82            State::get_expanded_states(), backtrack_count_, Api::get().mc_get_visited_states(),
  83            Transition::get_replayed_transitions());
  84 }
  85
  86 void DFSExplorer::run()
  87 {
  88   on_exploration_start_signal();
  89   /* This function runs the DFS algorithm the state space.
  90    * We do so iteratively instead of recursively, dealing with the call stack manually.
  91    * This allows one to explore the call stack at will. */
  92
  93   while (not stack_.empty()) {
  94     /* Get current state */
  95     State* state = stack_.back().get();
  96
  97     XBT_DEBUG("**************************************************");
  98     XBT_DEBUG("Exploration depth=%zu (state:%ld; %zu interleaves)", stack_.size(), state->get_num(),
  99               state->count_todo());
 100
 101     Api::get().mc_inc_visited_states();
 102
 103     // Backtrack if we reached the maximum depth
 104     if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
 105       if (reductionMode_ == ReductionMode::dpor) {
 106         XBT_ERROR("/!\\ Max depth of %d reached! THIS WILL PROBABLY BREAK the dpor reduction /!\\",
 107                   _sg_mc_max_depth.get());
 108         XBT_ERROR("/!\\ If bad things happen, disable dpor with --cfg=model-check/reduction:none /!\\");
 109       } else
 110         XBT_WARN("/!\\ Max depth reached ! /!\\ ");
 111       this->backtrack();
 112       continue;
 113     }
 114
 115     // Backtrack if we are revisiting a state we saw previously
 116     if (visited_state_ != nullptr) {
 117       XBT_DEBUG("State already visited (equal to state %ld), exploration stopped on this path.",
 118                 visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num);
 119
 120       visited_state_ = nullptr;
 121       this->backtrack();
 122       continue;
 123     }
 124
 125     // Search for the next transition
 126     int next = state->next_transition();
 127
 128     if (next < 0) { // If there is no more transition in the current state, backtrack.
 129       XBT_DEBUG("There remains %zu actors, but none to interleave (depth %zu).",
 130                 mc_model_checker->get_remote_process().actors().size(), stack_.size() + 1);
 131
 132       if (mc_model_checker->get_remote_process().actors().empty()) {
 133         mc_model_checker->finalize_app();
 134         XBT_VERB("Execution came to an end at %s (state: %ld, depth: %zu)", get_record_trace().to_string().c_str(),
 135                  state->get_num(), stack_.size());
 136       }
 137       this->backtrack();
 138       continue;
 139     }
 140
 141     /* Actually answer the request: let's execute the selected request (MCed does one step) */
 142     state->execute_next(next);
 143     on_transition_execute_signal(state->get_transition());
 144
 145     // If there are processes to interleave and the maximum depth has not been
 146     // reached then perform one step of the exploration algorithm.
 147     XBT_VERB("Execute %ld: %.60s (stack depth: %zu, state: %ld, %zu interleaves)", state->get_transition()->aid_,
 148              state->get_transition()->to_string().c_str(), stack_.size(), state->get_num(), state->count_todo());
 149
 150     std::string req_str;
 151     if (dot_output != nullptr)
 152       req_str = state->get_transition()->dot_string();
 153
 154     /* Create the new expanded state (copy the state of MCed into our MCer data) */
 155     auto next_state = std::make_unique<State>(get_session());
 156     on_state_creation_signal(next_state.get());
 157
 158     if (_sg_mc_termination)
 159       this->check_non_termination(next_state.get());
 160
 161     /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
 162     if (_sg_mc_max_visited_states > 0)
 163       visited_state_ = visited_states_.addVisitedState(next_state->get_num(), next_state.get(), true);
 164
 165     /* If this is a new state (or if we don't care about state-equality reduction) */
 166     if (visited_state_ == nullptr) {
 167       /* Get an enabled process and insert it in the interleave set of the next state */
 168       for (auto const& [aid, _] : next_state->get_actors_list()) {
 169         if (next_state->is_actor_enabled(aid)) {
 170           next_state->mark_todo(aid);
 171           if (reductionMode_ == ReductionMode::dpor)
 172             break; // With DPOR, we take the first enabled transition
 173         }
 174       }
 175
 176       if (dot_output != nullptr)
 177         std::fprintf(dot_output, "\"%ld\" -> \"%ld\" [%s];\n", state->get_num(), next_state->get_num(),
 178                      req_str.c_str());
 179
 180     } else if (dot_output != nullptr)
 181       std::fprintf(dot_output, "\"%ld\" -> \"%ld\" [%s];\n", state->get_num(),
 182                    visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num,
 183                    req_str.c_str());
 184
 185     stack_.push_back(std::move(next_state));
 186   }
 187
 188   log_state();
 189 }
 190
 191 void DFSExplorer::backtrack()
 192 {
 193   backtrack_count_++;
 194   XBT_VERB("Backtracking from %s", get_record_trace().to_string().c_str());
 195   on_backtracking_signal();
 196   stack_.pop_back();
 197
 198   get_session().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
 205   while (not stack_.empty()) {
 206     std::unique_ptr<State> state = std::move(stack_.back());
 207     stack_.pop_back();
 208     if (reductionMode_ == ReductionMode::dpor) {
 209       aid_t issuer_id = state->get_transition()->aid_;
 210       for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
 211         State* prev_state = i->get();
 212         if (state->get_transition()->aid_ == prev_state->get_transition()->aid_) {
 213           XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->get_transition()->to_string().c_str(),
 214                     prev_state->get_transition()->to_string().c_str(), issuer_id);
 215           break;
 216         } else if (prev_state->get_transition()->depends(state->get_transition())) {
 217           XBT_VERB("Dependent Transitions:");
 218           XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
 219           XBT_VERB("  %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
 220
 221           if (not prev_state->is_done(issuer_id))
 222             prev_state->mark_todo(issuer_id);
 223           else
 224             XBT_DEBUG("Actor %ld is in done set", issuer_id);
 225           break;
 226         } else {
 227           XBT_VERB("INDEPENDENT Transitions:");
 228           XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
 229           XBT_VERB("  %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
 230         }
 231       }
 232     }
 233
 234     if (state->count_todo() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
 235       /* We found a back-tracking point, let's loop */
 236       XBT_DEBUG("Back-tracking to state %ld at depth %zu", state->get_num(), stack_.size() + 1);
 237       stack_.push_back(
 238           std::move(state)); // Put it back on the stack from which it was removed earlier in this while loop
 239       this->restore_state();
 240       XBT_DEBUG("Back-tracking to state %ld at depth %zu done", stack_.back()->get_num(), stack_.size());
 241       break;
 242     } else {
 243       XBT_DEBUG("Delete state %ld at depth %zu", state->get_num(), stack_.size() + 1);
 244     }
 245   }
 246 }
 247
 248 void DFSExplorer::restore_state()
 249 {
 250   /* If asked to rollback on a state that has a snapshot, restore it */
 251   State* last_state = stack_.back().get();
 252   if (const auto* system_state = last_state->get_system_state()) {
 253     Api::get().restore_state(system_state);
 254     on_restore_system_state_signal(last_state);
 255     return;
 256   }
 257
 258   /* if no snapshot, we need to restore the initial state and replay the transitions */
 259   get_session().restore_initial_state();
 260   on_restore_initial_state_signal();
 261
 262   /* Traverse the stack from the state at position start and re-execute the transitions */
 263   for (std::unique_ptr<State> const& state : stack_) {
 264     if (state == stack_.back()) /* If we are arrived on the target state, don't replay the outgoing transition */
 265       break;
 266     state->get_transition()->replay();
 267     on_transition_replay_signal(state->get_transition());
 268     /* Update statistics */
 269     Api::get().mc_inc_visited_states();
 270   }
 271 }
 272
 273 DFSExplorer::DFSExplorer(Session* session) : Exploration(session)
 274 {
 275   reductionMode_ = reduction_mode;
 276   if (_sg_mc_termination)
 277     reductionMode_ = ReductionMode::none;
 278   else if (reductionMode_ == ReductionMode::unset)
 279     reductionMode_ = ReductionMode::dpor;
 280
 281   if (_sg_mc_termination)
 282     XBT_INFO("Check non progressive cycles");
 283   else
 284     XBT_INFO("Start a DFS exploration. Reduction is: %s.",
 285              (reductionMode_ == ReductionMode::none ? "none"
 286                                                     : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
 287
 288   get_session().take_initial_snapshot();
 289
 290   XBT_DEBUG("Starting the DFS exploration");
 291
 292   auto initial_state = std::make_unique<State>(get_session());
 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. %d 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 (reductionMode_ == 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(Session* session)
 313 {
 314   return new DFSExplorer(session);
 315 }
 316
 317 } // namespace simgrid::mc