src/mc/checker/SafetyChecker.cpp

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