src/mc/checker/SafetyChecker.cpp

   1 /* Copyright (c) 2016-2020. 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/Session.hpp"
  17 #include "src/mc/Transition.hpp"
  18 #include "src/mc/VisitedState.hpp"
  19 #include "src/mc/checker/SafetyChecker.hpp"
  20 #include "src/mc/mc_config.hpp"
  21 #include "src/mc/mc_exit.hpp"
  22 #include "src/mc/mc_private.hpp"
  23 #include "src/mc/mc_record.hpp"
  24 #include "src/mc/mc_request.hpp"
  25 #include "src/mc/mc_smx.hpp"
  26 #include "src/mc/mc_api.hpp"
  27
  28 #include "src/xbt/mmalloc/mmprivate.h"
  29
  30 using mcapi = simgrid::mc::mc_api;
  31
  32 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_safety, mc, "Logging specific to MC safety verification ");
  33
  34 namespace simgrid {
  35 namespace mc {
  36
  37 void SafetyChecker::check_non_termination(const State* current_state)
  38 {
  39   for (auto state = stack_.rbegin(); state != stack_.rend(); ++state)
  40     if (mcapi::get().snapshot_equal((*state)->system_state_.get(), current_state->system_state_.get())) {
  41       XBT_INFO("Non-progressive cycle: state %d -> state %d", (*state)->num_, current_state->num_);
  42       XBT_INFO("******************************************");
  43       XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
  44       XBT_INFO("******************************************");
  45       XBT_INFO("Counter-example execution trace:");
  46       auto checker = mcapi::get().mc_get_checker();
  47       for (auto const& s : checker->get_textual_trace())
  48         XBT_INFO("  %s", s.c_str());
  49       mcapi::get().mc_dump_record_path();
  50       mcapi::get().s_log_state();
  51
  52       throw TerminationError();
  53     }
  54 }
  55
  56 RecordTrace SafetyChecker::get_record_trace() // override
  57 {
  58   RecordTrace res;
  59   for (auto const& state : stack_)
  60     res.push_back(state->get_transition());
  61   return res;
  62 }
  63
  64 std::vector<std::string> SafetyChecker::get_textual_trace() // override
  65 {
  66   std::vector<std::string> trace;
  67   for (auto const& state : stack_) {
  68     int value         = state->transition_.argument_;
  69     smx_simcall_t req = &state->executed_req_;
  70     if (req)
  71       trace.push_back(mcapi::get().request_to_string(req, value, RequestType::executed));
  72   }
  73   return trace;
  74 }
  75
  76 void SafetyChecker::log_state() // override
  77 {
  78   XBT_INFO("Expanded states = %lu", expanded_states_count_);
  79   XBT_INFO("Visited states = %lu", mcapi::get().mc_get_visited_states());
  80   XBT_INFO("Executed transitions = %lu", mcapi::get().mc_get_executed_trans());
  81 }
  82
  83 void SafetyChecker::run()
  84 {
  85   /* This function runs the DFS algorithm the state space.
  86    * We do so iteratively instead of recursively, dealing with the call stack manually.
  87    * This allows one to explore the call stack at will. */
  88
  89   while (not stack_.empty()) {
  90     /* Get current state */
  91     State* state = stack_.back().get();
  92
  93     XBT_DEBUG("**************************************************");
  94     XBT_VERB("Exploration depth=%zu (state=%p, num %d)(%zu interleave)", stack_.size(), state, state->num_,
  95              state->interleave_size());
  96
  97     mcapi::get().mc_inc_visited_states();
  98
  99     // Backtrack if we reached the maximum depth
 100     if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
 101       XBT_WARN("/!\\ Max depth reached ! /!\\ ");
 102       this->backtrack();
 103       continue;
 104     }
 105
 106     // Backtrack if we are revisiting a state we saw previously
 107     if (visited_state_ != nullptr) {
 108       XBT_DEBUG("State already visited (equal to state %d), exploration stopped on this path.",
 109                 visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num);
 110
 111       visited_state_ = nullptr;
 112       this->backtrack();
 113       continue;
 114     }
 115
 116     // Search an enabled transition in the current state; backtrack if the interleave set is empty
 117     // get_request also sets state.transition to be the one corresponding to the returned req
 118     smx_simcall_t req = mcapi::get().mc_state_choose_request(state);
 119     // req is now the transition of the process that was selected to be executed
 120
 121     if (req == nullptr) {
 122       XBT_DEBUG("There are no more processes to interleave. (depth %zu)", stack_.size() + 1);
 123
 124       this->backtrack();
 125       continue;
 126     }
 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", mcapi::get().request_to_string(req, state->transition_.argument_, RequestType::simix).c_str());
 131
 132     std::string req_str;
 133     if (dot_output != nullptr)
 134       req_str = mcapi::get().request_get_dot_output(req, state->transition_.argument_);
 135
 136     mcapi::get().mc_inc_executed_trans();
 137
 138     /* Actually answer the request: let execute the selected request (MCed does one step) */
 139     mcapi::get().execute(state->transition_);
 140
 141     /* Create the new expanded state (copy the state of MCed into our MCer data) */
 142     ++expanded_states_count_;
 143     auto next_state = std::make_unique<State>(expanded_states_count_);
 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 = mcapi::get().mc_get_remote_simulation().actors();
 156       for (auto& remoteActor : actors) {
 157         auto actor = remoteActor.copy.get_buffer();
 158         if (mcapi::get().actor_is_enabled(actor->get_pid())) {
 159           next_state->add_interleaving_set(actor);
 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   mcapi::get().s_log_state();
 178 }
 179
 180 void SafetyChecker::backtrack()
 181 {
 182   stack_.pop_back();
 183
 184   /* Check for deadlocks */
 185   if (mcapi::get().mc_check_deadlock()) {
 186     mcapi::get().mc_show_deadlock();
 187     throw DeadlockError();
 188   }
 189
 190   /* Traverse the stack backwards until a state with a non empty interleave set is found, deleting all the states that
 191    *  have it empty in the way. For each deleted state, check if the request that has generated it (from its
 192    *  predecessor state), depends on any other previous request executed before it. If it does then add it to the
 193    *  interleave set of the state that executed that previous request. */
 194
 195   while (not stack_.empty()) {
 196     std::unique_ptr<State> state = std::move(stack_.back());
 197     stack_.pop_back();
 198     if (reductionMode_ == ReductionMode::dpor) {
 199       smx_simcall_t req = &state->internal_req_;
 200       if (req->call_ == SIMCALL_MUTEX_LOCK || req->call_ == SIMCALL_MUTEX_TRYLOCK)
 201         xbt_die("Mutex is currently not supported with DPOR,  use --cfg=model-check/reduction:none");
 202
 203       const kernel::actor::ActorImpl* issuer = mcapi::get().mc_smx_simcall_get_issuer(req);
 204       for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
 205         State* prev_state = i->get();
 206         if (mcapi::get().request_depend(req, &prev_state->internal_req_)) {
 207           if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
 208             XBT_DEBUG("Dependent Transitions:");
 209             int value              = prev_state->transition_.argument_;
 210             smx_simcall_t prev_req = &prev_state->executed_req_;
 211             XBT_DEBUG("%s (state=%d)", mcapi::get().request_to_string(prev_req, value, RequestType::internal).c_str(),
 212                       prev_state->num_);
 213             value    = state->transition_.argument_;
 214             prev_req = &state->executed_req_;
 215             XBT_DEBUG("%s (state=%d)", mcapi::get().request_to_string(prev_req, value, RequestType::executed).c_str(),
 216                       state->num_);
 217           }
 218
 219           if (not prev_state->actor_states_[issuer->get_pid()].is_done())
 220             prev_state->add_interleaving_set(issuer);
 221           else
 222             XBT_DEBUG("Process %p is in done set", req->issuer_);
 223           break;
 224         } else if (req->issuer_ == prev_state->internal_req_.issuer_) {
 225           XBT_DEBUG("Simcall %s and %s with same issuer", mcapi::get().simix_simcall_name(req->call_),
 226                     mcapi::get().simix_simcall_name(prev_state->internal_req_.call_));
 227           break;
 228         } else {
 229           const kernel::actor::ActorImpl* previous_issuer = mcapi::get().mc_smx_simcall_get_issuer(&prev_state->internal_req_);
 230           XBT_DEBUG("Simcall %s, process %ld (state %d) and simcall %s, process %ld (state %d) are independent",
 231                     mcapi::get().simix_simcall_name(req->call_), issuer->get_pid(), state->num_,
 232                     mcapi::get().simix_simcall_name(prev_state->internal_req_.call_), previous_issuer->get_pid(), prev_state->num_);
 233         }
 234       }
 235     }
 236
 237     if (state->interleave_size() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
 238       /* We found a back-tracking point, let's loop */
 239       XBT_DEBUG("Back-tracking to state %d at depth %zu", state->num_, stack_.size() + 1);
 240       stack_.push_back(std::move(state));
 241       this->restore_state();
 242       XBT_DEBUG("Back-tracking to state %d at depth %zu done", stack_.back()->num_, stack_.size());
 243       break;
 244     } else {
 245       XBT_DEBUG("Delete state %d at depth %zu", state->num_, stack_.size() + 1);
 246     }
 247   }
 248 }
 249
 250 void SafetyChecker::restore_state()
 251 {
 252   /* Intermediate backtracking */
 253   const State* last_state = stack_.back().get();
 254   if (last_state->system_state_) {
 255     last_state->system_state_->restore(&mcapi::get().mc_get_remote_simulation());
 256     return;
 257   }
 258
 259   /* Restore the initial state */
 260   mcapi::get().s_restore_initial_state();
 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())
 265       break;
 266     mcapi::get().execute(state->transition_);
 267     /* Update statistics */
 268     mcapi::get().mc_inc_visited_states();
 269     mcapi::get().mc_inc_executed_trans();
 270   }
 271 }
 272
 273 SafetyChecker::SafetyChecker(Session& s) : Checker(s)
 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("Check a safety property. Reduction is: %s.",
 285              (reductionMode_ == ReductionMode::none ? "none"
 286                                                     : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
 287
 288   mcapi::get().s_initialize();
 289
 290   XBT_DEBUG("Starting the safety algorithm");
 291
 292   ++expanded_states_count_;
 293   auto initial_state = std::make_unique<State>(expanded_states_count_);
 294
 295   XBT_DEBUG("**************************************************");
 296   XBT_DEBUG("Initial state");
 297
 298   /* Get an enabled actor and insert it in the interleave set of the initial state */
 299   auto actors = mcapi::get().get_actors();
 300   for (auto& actor : actors)
 301     if (mcapi::get().actor_is_enabled(actor.copy.get_buffer()->get_pid())) {
 302       initial_state->add_interleaving_set(actor.copy.get_buffer());
 303       if (reductionMode_ != ReductionMode::none)
 304         break;
 305     }
 306
 307   stack_.push_back(std::move(initial_state));
 308 }
 309
 310 Checker* createSafetyChecker(Session& s)
 311 {
 312   return new SafetyChecker(s);
 313 }
 314
 315 } // namespace mc
 316 } // namespace simgrid