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