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