Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Split TransitionAny and TransitionRandom to their own files
[simgrid.git] / src / mc / checker / SafetyChecker.cpp
index de95bdd..3713b93 100644 (file)
@@ -3,14 +3,14 @@
 /* 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 "src/mc/checker/SafetyChecker.hpp"
 #include "src/mc/Session.hpp"
-#include "src/mc/Transition.hpp"
 #include "src/mc/VisitedState.hpp"
-#include "src/mc/checker/SafetyChecker.hpp"
 #include "src/mc/mc_config.hpp"
 #include "src/mc/mc_exit.hpp"
 #include "src/mc/mc_private.hpp"
 #include "src/mc/mc_record.hpp"
+#include "src/mc/transition/Transition.hpp"
 
 #include "src/xbt/mmalloc/mmprivate.h"
 #include "xbt/log.h"
@@ -30,18 +30,30 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_safety, mc, "Logging specific to MC safety ve
 namespace simgrid {
 namespace mc {
 
+xbt::signal<void()> SafetyChecker::on_exploration_start_signal;
+xbt::signal<void()> SafetyChecker::on_backtracking_signal;
+
+xbt::signal<void(State*)> SafetyChecker::on_state_creation_signal;
+
+xbt::signal<void(State*)> SafetyChecker::on_restore_system_state_signal;
+xbt::signal<void()> SafetyChecker::on_restore_initial_state_signal;
+xbt::signal<void(Transition*)> SafetyChecker::on_transition_replay_signal;
+xbt::signal<void(Transition*)> SafetyChecker::on_transition_execute_signal;
+
+xbt::signal<void()> SafetyChecker::on_log_state_signal;
+
 void SafetyChecker::check_non_termination(const State* current_state)
 {
   for (auto state = stack_.rbegin(); state != stack_.rend(); ++state)
     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("Non-progressive cycle: state %ld -> state %ld", (*state)->num_, current_state->num_);
       XBT_INFO("******************************************");
       XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
       XBT_INFO("******************************************");
       XBT_INFO("Counter-example execution trace:");
       for (auto const& s : get_textual_trace())
         XBT_INFO("  %s", s.c_str());
-      api::get().dump_record_path();
+      XBT_INFO("Path = %s", get_record_trace().to_string().c_str());
       api::get().log_state();
 
       throw TerminationError();
@@ -52,7 +64,7 @@ RecordTrace SafetyChecker::get_record_trace() // override
 {
   RecordTrace res;
   for (auto const& state : stack_)
-    res.push_back(*state->get_transition());
+    res.push_back(state->get_transition());
   return res;
 }
 
@@ -66,13 +78,16 @@ std::vector<std::string> SafetyChecker::get_textual_trace() // override
 
 void SafetyChecker::log_state() // override
 {
-  XBT_INFO("Expanded states = %lu", expanded_states_count_);
-  XBT_INFO("Visited states = %lu", api::get().mc_get_visited_states());
-  XBT_INFO("Executed transitions = %lu", Transition::get_executed_transitions());
+  on_log_state_signal();
+  XBT_INFO("DFS exploration ended. %ld unique states visited; %ld backtracks (%lu transition replays, %lu states "
+           "visited overall)",
+           State::get_expanded_states(), backtrack_count_, api::get().mc_get_visited_states(),
+           Transition::get_replayed_transitions());
 }
 
 void SafetyChecker::run()
 {
+  on_exploration_start_signal();
   /* This function runs the DFS algorithm the state space.
    * We do so iteratively instead of recursively, dealing with the call stack manually.
    * This allows one to explore the call stack at will. */
@@ -82,7 +97,7 @@ void SafetyChecker::run()
     State* state = stack_.back().get();
 
     XBT_DEBUG("**************************************************");
-    XBT_VERB("Exploration depth=%zu (state=%p, num %d)(%zu interleave)", stack_.size(), state, state->num_,
+    XBT_VERB("Exploration depth=%zu (state=%p, num %ld)(%zu interleave)", stack_.size(), state, state->num_,
              state->count_todo());
 
     api::get().mc_inc_visited_states();
@@ -101,7 +116,7 @@ void SafetyChecker::run()
 
     // Backtrack if we are revisiting a state we saw previously
     if (visited_state_ != nullptr) {
-      XBT_DEBUG("State already visited (equal to state %d), exploration stopped on this path.",
+      XBT_DEBUG("State already visited (equal to state %ld), exploration stopped on this path.",
                 visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num);
 
       visited_state_ = nullptr;
@@ -113,7 +128,6 @@ void SafetyChecker::run()
     int next = state->next_transition();
 
     if (next < 0) { // If there is no more transition in the current state, backtrack.
-
       XBT_DEBUG("There remains %zu actors, but none to interleave (depth %zu).",
                 mc_model_checker->get_remote_process().actors().size(), stack_.size() + 1);
 
@@ -123,8 +137,9 @@ void SafetyChecker::run()
       continue;
     }
 
-    /* Actually answer the request: let execute the selected request (MCed does one step) */
-    auto remote_observer = state->execute_next(next);
+    /* Actually answer the request: let's execute the selected request (MCed does one step) */
+    state->execute_next(next);
+    on_transition_execute_signal(state->get_transition());
 
     // If there are processes to interleave and the maximum depth has not been
     // reached then perform one step of the exploration algorithm.
@@ -132,20 +147,18 @@ void SafetyChecker::run()
 
     std::string req_str;
     if (dot_output != nullptr)
-      req_str =
-          api::get().request_get_dot_output(state->get_transition()->aid_, state->get_transition()->times_considered_);
+      req_str = api::get().request_get_dot_output(state->get_transition());
 
     /* Create the new expanded state (copy the state of MCed into our MCer data) */
-    ++expanded_states_count_;
-    auto next_state = std::make_unique<State>(expanded_states_count_);
-    next_state->remote_observer_ = remote_observer;
+    auto next_state = std::make_unique<State>();
+    on_state_creation_signal(next_state.get());
 
     if (_sg_mc_termination)
       this->check_non_termination(next_state.get());
 
     /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
     if (_sg_mc_max_visited_states > 0)
-      visited_state_ = visited_states_.addVisitedState(expanded_states_count_, next_state.get(), true);
+      visited_state_ = visited_states_.addVisitedState(next_state->num_, next_state.get(), true);
 
     /* If this is a new state (or if we don't care about state-equality reduction) */
     if (visited_state_ == nullptr) {
@@ -161,22 +174,24 @@ void SafetyChecker::run()
       }
 
       if (dot_output != nullptr)
-        std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_, next_state->num_, req_str.c_str());
+        std::fprintf(dot_output, "\"%ld\" -> \"%ld\" [%s];\n", state->num_, next_state->num_, req_str.c_str());
 
     } else if (dot_output != nullptr)
-      std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_,
+      std::fprintf(dot_output, "\"%ld\" -> \"%ld\" [%s];\n", state->num_,
                    visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num,
                    req_str.c_str());
 
     stack_.push_back(std::move(next_state));
   }
 
-  XBT_INFO("No property violation found.");
   api::get().log_state();
 }
 
 void SafetyChecker::backtrack()
 {
+  backtrack_count_++;
+  XBT_VERB("Backtracking from %s", get_record_trace().to_string().c_str());
+  on_backtracking_signal();
   stack_.pop_back();
 
   api::get().mc_check_deadlock();
@@ -197,12 +212,10 @@ void SafetyChecker::backtrack()
           XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->get_transition()->to_string().c_str(),
                     prev_state->get_transition()->to_string().c_str(), issuer_id);
           break;
-        } else if (api::get().requests_are_dependent(prev_state->remote_observer_, state->remote_observer_)) {
-          if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
-            XBT_DEBUG("Dependent Transitions:");
-            XBT_DEBUG("  %s (state=%d)", prev_state->get_transition()->to_string().c_str(), prev_state->num_);
-            XBT_DEBUG("  %s (state=%d)", state->get_transition()->to_string().c_str(), state->num_);
-          }
+        } else if (prev_state->get_transition()->depends(state->get_transition())) {
+          XBT_VERB("Dependent Transitions:");
+          XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->num_);
+          XBT_VERB("  %s (state=%ld)", state->get_transition()->to_string().c_str(), state->num_);
 
           if (not prev_state->actor_states_[issuer_id].is_done())
             prev_state->mark_todo(issuer_id);
@@ -210,44 +223,46 @@ void SafetyChecker::backtrack()
             XBT_DEBUG("Actor %ld is in done set", issuer_id);
           break;
         } else {
-          if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
-            XBT_DEBUG("INDEPENDENT Transitions:");
-            XBT_DEBUG("  %s (state=%d)", prev_state->get_transition()->to_string().c_str(), prev_state->num_);
-            XBT_DEBUG("  %s (state=%d)", state->get_transition()->to_string().c_str(), state->num_);
-          }
+          XBT_VERB("INDEPENDENT Transitions:");
+          XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->num_);
+          XBT_VERB("  %s (state=%ld)", state->get_transition()->to_string().c_str(), state->num_);
         }
       }
     }
 
     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);
+      XBT_DEBUG("Back-tracking to state %ld at depth %zu", state->num_, stack_.size() + 1);
       stack_.push_back(std::move(state));
       this->restore_state();
-      XBT_DEBUG("Back-tracking to state %d at depth %zu done", stack_.back()->num_, stack_.size());
+      XBT_DEBUG("Back-tracking to state %ld at depth %zu done", stack_.back()->num_, stack_.size());
       break;
     } else {
-      XBT_DEBUG("Delete state %d at depth %zu", state->num_, stack_.size() + 1);
+      XBT_DEBUG("Delete state %ld at depth %zu", state->num_, stack_.size() + 1);
     }
   }
 }
 
 void SafetyChecker::restore_state()
 {
-  /* Intermediate backtracking */
-  const State* last_state = stack_.back().get();
+  /* If asked to rollback on a state that has a snapshot, restore it */
+  State* last_state = stack_.back().get();
   if (last_state->system_state_) {
     api::get().restore_state(last_state->system_state_);
+    on_restore_system_state_signal(last_state);
     return;
   }
 
+  /* if no snapshot, we need to restore the initial state and replay the transitions */
   get_session().restore_initial_state();
+  on_restore_initial_state_signal();
 
   /* 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())
+    if (state == stack_.back()) // If we are arrived on the target state, don't replay the outgoing transition *.
       break;
     state->get_transition()->replay();
+    on_transition_replay_signal(state->get_transition());
     /* Update statistics */
     api::get().mc_inc_visited_states();
   }
@@ -264,7 +279,7 @@ SafetyChecker::SafetyChecker(Session* session) : Checker(session)
   if (_sg_mc_termination)
     XBT_INFO("Check non progressive cycles");
   else
-    XBT_INFO("Check a safety property. Reduction is: %s.",
+    XBT_INFO("Start a DFS exploration. Reduction is: %s.",
              (reductionMode_ == ReductionMode::none ? "none"
                                                     : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
 
@@ -272,8 +287,7 @@ SafetyChecker::SafetyChecker(Session* session) : Checker(session)
 
   XBT_DEBUG("Starting the safety algorithm");
 
-  ++expanded_states_count_;
-  auto initial_state = std::make_unique<State>(expanded_states_count_);
+  auto initial_state = std::make_unique<State>();
 
   XBT_DEBUG("**************************************************");