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/Session.hpp"
   7 #include "src/mc/Transition.hpp"
   8 #include "src/mc/VisitedState.hpp"
   9 #include "src/mc/checker/SafetyChecker.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 %d -> state %d", (*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       api::get().dump_record_path();
  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->transition_.textual);
  64   return trace;
  65 }
  66
  67 void SafetyChecker::log_state() // override
  68 {
  69   XBT_INFO("Expanded states = %lu", expanded_states_count_);
  70   XBT_INFO("Visited states = %lu", api::get().mc_get_visited_states());
  71   XBT_INFO("Executed transitions = %lu", api::get().mc_get_executed_trans());
  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 %d)(%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 %d), 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 an enabled transition in the current state; backtrack if the interleave set is empty
 113     // get_request also sets state.transition to be the one corresponding to the returned req
 114     smx_simcall_t req = api::get().mc_state_choose_request(state);
 115     // req is now the transition of the process that was selected to be executed
 116
 117     if (req == nullptr) {
 118       XBT_DEBUG("There remains %zu actors, but none to interleave (depth %zu).",
 119                 mc_model_checker->get_remote_process().actors().size(), stack_.size() + 1);
 120
 121       if (mc_model_checker->get_remote_process().actors().empty())
 122         mc_model_checker->finalize_app();
 123       this->backtrack();
 124       continue;
 125     }
 126
 127     // If there are processes to interleave and the maximum depth has not been
 128     // reached then perform one step of the exploration algorithm.
 129     XBT_DEBUG("Execute: %s", api::get().request_to_string(req, state->transition_.times_considered_).c_str());
 130
 131     std::string req_str;
 132     if (dot_output != nullptr)
 133       req_str = api::get().request_get_dot_output(req, state->transition_.times_considered_);
 134
 135     api::get().mc_inc_executed_trans();
 136
 137     /* Actually answer the request: let execute the selected request (MCed does one step) */
 138     auto remote_observer = api::get().execute(state->transition_, &state->executed_req_);
 139
 140     /* Create the new expanded state (copy the state of MCed into our MCer data) */
 141     ++expanded_states_count_;
 142     auto next_state = std::make_unique<State>(expanded_states_count_);
 143     next_state->remote_observer_ = remote_observer;
 144
 145     if (_sg_mc_termination)
 146       this->check_non_termination(next_state.get());
 147
 148     /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
 149     if (_sg_mc_max_visited_states > 0)
 150       visited_state_ = visited_states_.addVisitedState(expanded_states_count_, next_state.get(), true);
 151
 152     /* If this is a new state (or if we don't care about state-equality reduction) */
 153     if (visited_state_ == nullptr) {
 154       /* Get an enabled process and insert it in the interleave set of the next state */
 155       auto actors = api::get().get_actors();
 156       for (auto& remoteActor : actors) {
 157         auto actor = remoteActor.copy.get_buffer();
 158         if (get_session().actor_is_enabled(actor->get_pid())) {
 159           next_state->mark_todo(actor->get_pid());
 160           if (reductionMode_ == ReductionMode::dpor)
 161             break; // With DPOR, we take the first enabled transition
 162         }
 163       }
 164
 165       if (dot_output != nullptr)
 166         std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_, next_state->num_, req_str.c_str());
 167
 168     } else if (dot_output != nullptr)
 169       std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_,
 170                    visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num,
 171                    req_str.c_str());
 172
 173     stack_.push_back(std::move(next_state));
 174   }
 175
 176   XBT_INFO("No property violation found.");
 177   api::get().log_state();
 178 }
 179
 180 void SafetyChecker::backtrack()
 181 {
 182   stack_.pop_back();
 183
 184   api::get().mc_check_deadlock();
 185
 186   /* Traverse the stack backwards until a state with a non empty interleave set is found, deleting all the states that
 187    *  have it empty in the way. For each deleted state, check if the request that has generated it (from its
 188    *  predecessor state), depends on any other previous request executed before it. If it does then add it to the
 189    *  interleave set of the state that executed that previous request. */
 190
 191   while (not stack_.empty()) {
 192     std::unique_ptr<State> state = std::move(stack_.back());
 193     stack_.pop_back();
 194     if (reductionMode_ == ReductionMode::dpor) {
 195       aid_t issuer_id = state->transition_.aid_;
 196       for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
 197         State* prev_state = i->get();
 198         if (state->transition_.aid_ == prev_state->transition_.aid_) {
 199           XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->transition_.textual.c_str(),
 200                     prev_state->transition_.textual.c_str(), issuer_id);
 201           break;
 202         } else if (api::get().requests_are_dependent(prev_state->remote_observer_, state->remote_observer_)) {
 203           if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
 204             XBT_DEBUG("Dependent Transitions:");
 205             XBT_DEBUG("  %s (state=%d)", prev_state->transition_.textual.c_str(), prev_state->num_);
 206             XBT_DEBUG("  %s (state=%d)", state->transition_.textual.c_str(), state->num_);
 207           }
 208
 209           if (not prev_state->actor_states_[issuer_id].is_done())
 210             prev_state->mark_todo(issuer_id);
 211           else
 212             XBT_DEBUG("Actor %ld is in done set", issuer_id);
 213           break;
 214         } else {
 215           if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
 216             XBT_DEBUG("INDEPENDENT Transitions:");
 217             XBT_DEBUG("  %s (state=%d)", prev_state->transition_.textual.c_str(), prev_state->num_);
 218             XBT_DEBUG("  %s (state=%d)", state->transition_.textual.c_str(), state->num_);
 219           }
 220         }
 221       }
 222     }
 223
 224     if (state->count_todo() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
 225       /* We found a back-tracking point, let's loop */
 226       XBT_DEBUG("Back-tracking to state %d at depth %zu", state->num_, stack_.size() + 1);
 227       stack_.push_back(std::move(state));
 228       this->restore_state();
 229       XBT_DEBUG("Back-tracking to state %d at depth %zu done", stack_.back()->num_, stack_.size());
 230       break;
 231     } else {
 232       XBT_DEBUG("Delete state %d at depth %zu", state->num_, stack_.size() + 1);
 233     }
 234   }
 235 }
 236
 237 void SafetyChecker::restore_state()
 238 {
 239   /* Intermediate backtracking */
 240   const State* last_state = stack_.back().get();
 241   if (last_state->system_state_) {
 242     api::get().restore_state(last_state->system_state_);
 243     return;
 244   }
 245
 246   get_session().restore_initial_state();
 247
 248   /* Traverse the stack from the state at position start and re-execute the transitions */
 249   for (std::unique_ptr<State> const& state : stack_) {
 250     if (state == stack_.back())
 251       break;
 252     api::get().execute(state->transition_, &state->executed_req_);
 253     /* Update statistics */
 254     api::get().mc_inc_visited_states();
 255     api::get().mc_inc_executed_trans();
 256   }
 257 }
 258
 259 SafetyChecker::SafetyChecker(Session* session) : Checker(session)
 260 {
 261   reductionMode_ = reduction_mode;
 262   if (_sg_mc_termination)
 263     reductionMode_ = ReductionMode::none;
 264   else if (reductionMode_ == ReductionMode::unset)
 265     reductionMode_ = ReductionMode::dpor;
 266
 267   if (_sg_mc_termination)
 268     XBT_INFO("Check non progressive cycles");
 269   else
 270     XBT_INFO("Check a safety property. Reduction is: %s.",
 271              (reductionMode_ == ReductionMode::none ? "none"
 272                                                     : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
 273
 274   get_session().take_initial_snapshot();
 275
 276   XBT_DEBUG("Starting the safety algorithm");
 277
 278   ++expanded_states_count_;
 279   auto initial_state = std::make_unique<State>(expanded_states_count_);
 280
 281   XBT_DEBUG("**************************************************");
 282
 283   /* Get an enabled actor and insert it in the interleave set of the initial state */
 284   auto actors = api::get().get_actors();
 285   XBT_DEBUG("Initial state. %zu actors to consider", actors.size());
 286   for (auto& actor : actors) {
 287     aid_t aid = actor.copy.get_buffer()->get_pid();
 288     if (get_session().actor_is_enabled(aid)) {
 289       initial_state->mark_todo(aid);
 290       if (reductionMode_ == ReductionMode::dpor) {
 291         XBT_DEBUG("Actor %ld is TODO, DPOR is ON so let's go for this one.", aid);
 292         break;
 293       }
 294       XBT_DEBUG("Actor %ld is TODO", aid);
 295     }
 296   }
 297
 298   stack_.push_back(std::move(initial_state));
 299 }
 300
 301 Checker* create_safety_checker(Session* session)
 302 {
 303   return new SafetyChecker(session);
 304 }
 305
 306 } // namespace mc
 307 } // namespace simgrid