Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2022.
[simgrid.git] / src / mc / checker / SafetyChecker.cpp
index 3a97114..b1af40f 100644 (file)
@@ -1,18 +1,8 @@
-/* Copyright (c) 2016-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2016-2022. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include <cassert>
-#include <cstdio>
-
-#include <memory>
-#include <string>
-#include <vector>
-
-#include <xbt/log.h>
-#include <xbt/sysdep.h>
-
 #include "src/mc/Session.hpp"
 #include "src/mc/Transition.hpp"
 #include "src/mc/VisitedState.hpp"
 #include "src/mc/mc_exit.hpp"
 #include "src/mc/mc_private.hpp"
 #include "src/mc/mc_record.hpp"
-#include "src/mc/mc_request.hpp"
-#include "src/mc/mc_smx.hpp"
-#include "src/mc/mc_api.hpp"
 
 #include "src/xbt/mmalloc/mmprivate.h"
+#include "xbt/log.h"
+#include "xbt/sysdep.h"
+
+#include <cassert>
+#include <cstdio>
 
-using mcapi = simgrid::mc::mc_api;
+#include <memory>
+#include <string>
+#include <vector>
+
+using api = simgrid::mc::Api;
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_safety, mc, "Logging specific to MC safety verification ");
 
@@ -37,17 +33,16 @@ namespace mc {
 void SafetyChecker::check_non_termination(const State* current_state)
 {
   for (auto state = stack_.rbegin(); state != stack_.rend(); ++state)
-    if (mcapi::get().snapshot_equal((*state)->system_state_.get(), current_state->system_state_.get())) {
+    if (api::get().snapshot_equal((*state)->system_state_.get(), current_state->system_state_.get())) {
       XBT_INFO("Non-progressive cycle: state %d -> state %d", (*state)->num_, current_state->num_);
       XBT_INFO("******************************************");
       XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
       XBT_INFO("******************************************");
       XBT_INFO("Counter-example execution trace:");
-      auto checker = mcapi::get().mc_get_checker();
-      for (auto const& s : checker->get_textual_trace())
+      for (auto const& s : get_textual_trace())
         XBT_INFO("  %s", s.c_str());
-      mcapi::get().mc_dump_record_path();
-      mcapi::get().s_log_state();
+      api::get().dump_record_path();
+      api::get().log_state();
 
       throw TerminationError();
     }
@@ -64,20 +59,16 @@ RecordTrace SafetyChecker::get_record_trace() // override
 std::vector<std::string> SafetyChecker::get_textual_trace() // override
 {
   std::vector<std::string> trace;
-  for (auto const& state : stack_) {
-    int value         = state->transition_.argument_;
-    smx_simcall_t req = &state->executed_req_;
-    if (req)
-      trace.push_back(mcapi::get().request_to_string(req, value, RequestType::executed));
-  }
+  for (auto const& state : stack_)
+    trace.push_back(state->transition_.textual);
   return trace;
 }
 
 void SafetyChecker::log_state() // override
 {
   XBT_INFO("Expanded states = %lu", expanded_states_count_);
-  XBT_INFO("Visited states = %lu", mcapi::get().mc_get_visited_states());
-  XBT_INFO("Executed transitions = %lu", mcapi::get().mc_get_executed_trans());
+  XBT_INFO("Visited states = %lu", api::get().mc_get_visited_states());
+  XBT_INFO("Executed transitions = %lu", api::get().mc_get_executed_trans());
 }
 
 void SafetyChecker::run()
@@ -92,13 +83,17 @@ void SafetyChecker::run()
 
     XBT_DEBUG("**************************************************");
     XBT_VERB("Exploration depth=%zu (state=%p, num %d)(%zu interleave)", stack_.size(), state, state->num_,
-             state->interleave_size());
+             state->count_todo());
 
-    mcapi::get().mc_inc_visited_states();
+    api::get().mc_inc_visited_states();
 
     // Backtrack if we reached the maximum depth
     if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
-      XBT_WARN("/!\\ Max depth reached ! /!\\ ");
+      if (reductionMode_ == ReductionMode::dpor) {
+        XBT_ERROR("/!\\ Max depth reached! THIS WILL PROBABLY BREAK the dpor reduction /!\\");
+        XBT_ERROR("/!\\ If bad things happen, disable dpor with --cfg=model-check/reduction:none /!\\");
+      } else
+        XBT_WARN("/!\\ Max depth reached ! /!\\ ");
       this->backtrack();
       continue;
     }
@@ -115,28 +110,31 @@ void SafetyChecker::run()
 
     // Search an enabled transition in the current state; backtrack if the interleave set is empty
     // get_request also sets state.transition to be the one corresponding to the returned req
-    smx_simcall_t req = mcapi::get().mc_state_choose_request(state);
+    smx_simcall_t req = api::get().mc_state_choose_request(state);
     // req is now the transition of the process that was selected to be executed
 
     if (req == nullptr) {
-      XBT_DEBUG("There are no more processes to interleave. (depth %zu)", stack_.size() + 1);
+      XBT_DEBUG("There remains %zu actors, but no more processes to interleave. (depth %zu)",
+                mc_model_checker->get_remote_process().actors().size(), stack_.size() + 1);
 
+      if (mc_model_checker->get_remote_process().actors().empty())
+        mc_model_checker->finalize_app();
       this->backtrack();
       continue;
     }
 
     // If there are processes to interleave and the maximum depth has not been
     // reached then perform one step of the exploration algorithm.
-    XBT_DEBUG("Execute: %s", mcapi::get().request_to_string(req, state->transition_.argument_, RequestType::simix).c_str());
+    XBT_DEBUG("Execute: %s", api::get().request_to_string(req, state->transition_.times_considered_).c_str());
 
     std::string req_str;
     if (dot_output != nullptr)
-      req_str = mcapi::get().request_get_dot_output(req, state->transition_.argument_);
+      req_str = api::get().request_get_dot_output(req, state->transition_.times_considered_);
 
-    mcapi::get().mc_inc_executed_trans();
+    api::get().mc_inc_executed_trans();
 
     /* Actually answer the request: let execute the selected request (MCed does one step) */
-    mcapi::get().execute(state->transition_);
+    api::get().execute(state->transition_, &state->executed_req_);
 
     /* Create the new expanded state (copy the state of MCed into our MCer data) */
     ++expanded_states_count_;
@@ -152,11 +150,11 @@ void SafetyChecker::run()
     /* If this is a new state (or if we don't care about state-equality reduction) */
     if (visited_state_ == nullptr) {
       /* Get an enabled process and insert it in the interleave set of the next state */
-      auto actors = mcapi::get().mc_get_remote_simulation().actors();
+      auto actors = api::get().get_actors();
       for (auto& remoteActor : actors) {
         auto actor = remoteActor.copy.get_buffer();
-        if (mcapi::get().actor_is_enabled(actor->get_pid())) {
-          next_state->add_interleaving_set(actor);
+        if (get_session().actor_is_enabled(actor->get_pid())) {
+          next_state->mark_todo(actor);
           if (reductionMode_ == ReductionMode::dpor)
             break; // With DPOR, we take the first enabled transition
         }
@@ -174,18 +172,14 @@ void SafetyChecker::run()
   }
 
   XBT_INFO("No property violation found.");
-  mcapi::get().s_log_state();
+  api::get().log_state();
 }
 
 void SafetyChecker::backtrack()
 {
   stack_.pop_back();
 
-  /* Check for deadlocks */
-  if (mcapi::get().mc_check_deadlock()) {
-    mcapi::get().mc_show_deadlock();
-    throw DeadlockError();
-  }
+  api::get().mc_check_deadlock();
 
   /* Traverse the stack backwards until a state with a non empty interleave set is found, deleting all the states that
    *  have it empty in the way. For each deleted state, check if the request that has generated it (from its
@@ -196,45 +190,39 @@ void SafetyChecker::backtrack()
     std::unique_ptr<State> state = std::move(stack_.back());
     stack_.pop_back();
     if (reductionMode_ == ReductionMode::dpor) {
-      smx_simcall_t req = &state->internal_req_;
-      if (req->call_ == SIMCALL_MUTEX_LOCK || req->call_ == SIMCALL_MUTEX_TRYLOCK)
-        xbt_die("Mutex is currently not supported with DPOR,  use --cfg=model-check/reduction:none");
-
-      const kernel::actor::ActorImpl* issuer = mcapi::get().mc_smx_simcall_get_issuer(req);
+      kernel::actor::ActorImpl* issuer = api::get().simcall_get_issuer(&state->executed_req_);
       for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
         State* prev_state = i->get();
-        if (mcapi::get().request_depend(req, &prev_state->internal_req_)) {
+        if (state->executed_req_.issuer_ == prev_state->executed_req_.issuer_) {
+          XBT_DEBUG("Simcall %s and %s with same issuer", SIMIX_simcall_name(state->executed_req_),
+                    SIMIX_simcall_name(prev_state->executed_req_));
+          break;
+        } else if (api::get().simcall_check_dependency(&state->internal_req_, &prev_state->internal_req_)) {
           if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
             XBT_DEBUG("Dependent Transitions:");
-            int value              = prev_state->transition_.argument_;
+            int value              = prev_state->transition_.times_considered_;
             smx_simcall_t prev_req = &prev_state->executed_req_;
-            XBT_DEBUG("%s (state=%d)", mcapi::get().request_to_string(prev_req, value, RequestType::internal).c_str(),
-                      prev_state->num_);
-            value    = state->transition_.argument_;
+            XBT_DEBUG("%s (state=%d)", api::get().request_to_string(prev_req, value).c_str(), prev_state->num_);
+            value    = state->transition_.times_considered_;
             prev_req = &state->executed_req_;
-            XBT_DEBUG("%s (state=%d)", mcapi::get().request_to_string(prev_req, value, RequestType::executed).c_str(),
-                      state->num_);
+            XBT_DEBUG("%s (state=%d)", api::get().request_to_string(prev_req, value).c_str(), state->num_);
           }
 
           if (not prev_state->actor_states_[issuer->get_pid()].is_done())
-            prev_state->add_interleaving_set(issuer);
+            prev_state->mark_todo(issuer);
           else
-            XBT_DEBUG("Process %p is in done set", req->issuer_);
-          break;
-        } else if (req->issuer_ == prev_state->internal_req_.issuer_) {
-          XBT_DEBUG("Simcall %s and %s with same issuer", mcapi::get().simix_simcall_name(req->call_),
-                    mcapi::get().simix_simcall_name(prev_state->internal_req_.call_));
+            XBT_DEBUG("Actor %s %ld is in done set", api::get().get_actor_name(issuer).c_str(), issuer->get_pid());
           break;
         } else {
-          const kernel::actor::ActorImpl* previous_issuer = mcapi::get().mc_smx_simcall_get_issuer(&prev_state->internal_req_);
+          const kernel::actor::ActorImpl* previous_issuer = api::get().simcall_get_issuer(&prev_state->executed_req_);
           XBT_DEBUG("Simcall %s, process %ld (state %d) and simcall %s, process %ld (state %d) are independent",
-                    mcapi::get().simix_simcall_name(req->call_), issuer->get_pid(), state->num_,
-                    mcapi::get().simix_simcall_name(prev_state->internal_req_.call_), previous_issuer->get_pid(), prev_state->num_);
+                    SIMIX_simcall_name(state->executed_req_), issuer->get_pid(), state->num_,
+                    SIMIX_simcall_name(prev_state->executed_req_), previous_issuer->get_pid(), prev_state->num_);
         }
       }
     }
 
-    if (state->interleave_size() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
+    if (state->count_todo() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
       /* We found a back-tracking point, let's loop */
       XBT_DEBUG("Back-tracking to state %d at depth %zu", state->num_, stack_.size() + 1);
       stack_.push_back(std::move(state));
@@ -252,25 +240,24 @@ void SafetyChecker::restore_state()
   /* Intermediate backtracking */
   const State* last_state = stack_.back().get();
   if (last_state->system_state_) {
-    last_state->system_state_->restore(&mcapi::get().mc_get_remote_simulation());
+    api::get().restore_state(last_state->system_state_);
     return;
   }
 
-  /* Restore the initial state */
-  mcapi::get().s_restore_initial_state();
+  get_session().restore_initial_state();
 
   /* Traverse the stack from the state at position start and re-execute the transitions */
   for (std::unique_ptr<State> const& state : stack_) {
     if (state == stack_.back())
       break;
-    mcapi::get().execute(state->transition_);
+    api::get().execute(state->transition_, &state->executed_req_);
     /* Update statistics */
-    mcapi::get().mc_inc_visited_states();
-    mcapi::get().mc_inc_executed_trans();
+    api::get().mc_inc_visited_states();
+    api::get().mc_inc_executed_trans();
   }
 }
 
-SafetyChecker::SafetyChecker(Session& s) : Checker(s)
+SafetyChecker::SafetyChecker(Session* session) : Checker(session)
 {
   reductionMode_ = reduction_mode;
   if (_sg_mc_termination)
@@ -284,8 +271,8 @@ SafetyChecker::SafetyChecker(Session& s) : Checker(s)
     XBT_INFO("Check a safety property. Reduction is: %s.",
              (reductionMode_ == ReductionMode::none ? "none"
                                                     : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
-  
-  mcapi::get().s_initialize();  
+
+  get_session().take_initial_snapshot();
 
   XBT_DEBUG("Starting the safety algorithm");
 
@@ -296,10 +283,10 @@ SafetyChecker::SafetyChecker(Session& s) : Checker(s)
   XBT_DEBUG("Initial state");
 
   /* Get an enabled actor and insert it in the interleave set of the initial state */
-  auto actors = mcapi::get().get_actors();
+  auto actors = api::get().get_actors();
   for (auto& actor : actors)
-    if (mcapi::get().actor_is_enabled(actor.copy.get_buffer()->get_pid())) {
-      initial_state->add_interleaving_set(actor.copy.get_buffer());
+    if (get_session().actor_is_enabled(actor.copy.get_buffer()->get_pid())) {
+      initial_state->mark_todo(actor.copy.get_buffer());
       if (reductionMode_ != ReductionMode::none)
         break;
     }
@@ -307,9 +294,9 @@ SafetyChecker::SafetyChecker(Session& s) : Checker(s)
   stack_.push_back(std::move(initial_state));
 }
 
-Checker* createSafetyChecker(Session& s)
+Checker* create_safety_checker(Session* session)
 {
-  return new SafetyChecker(s);
+  return new SafetyChecker(session);
 }
 
 } // namespace mc