Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Type consistency.
[simgrid.git] / src / mc / explo / DFSExplorer.cpp
index aede648..03122f3 100644 (file)
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dfs, mc, "DFS exploration algorithm of the model-checker");
 
-namespace simgrid {
-namespace mc {
+namespace simgrid::mc {
 
-xbt::signal<void()> DFSExplorer::on_exploration_start_signal;
-xbt::signal<void()> DFSExplorer::on_backtracking_signal;
+xbt::signal<void(RemoteApp&)> DFSExplorer::on_exploration_start_signal;
+xbt::signal<void(RemoteApp&)> DFSExplorer::on_backtracking_signal;
 
-xbt::signal<void(State*)> DFSExplorer::on_state_creation_signal;
+xbt::signal<void(State*, RemoteApp&)> DFSExplorer::on_state_creation_signal;
 
-xbt::signal<void(State*)> DFSExplorer::on_restore_system_state_signal;
-xbt::signal<void()> DFSExplorer::on_restore_initial_state_signal;
-xbt::signal<void(Transition*)> DFSExplorer::on_transition_replay_signal;
-xbt::signal<void(Transition*)> DFSExplorer::on_transition_execute_signal;
+xbt::signal<void(State*, RemoteApp&)> DFSExplorer::on_restore_system_state_signal;
+xbt::signal<void(RemoteApp&)> DFSExplorer::on_restore_initial_state_signal;
+xbt::signal<void(Transition*, RemoteApp&)> DFSExplorer::on_transition_replay_signal;
+xbt::signal<void(Transition*, RemoteApp&)> DFSExplorer::on_transition_execute_signal;
 
-xbt::signal<void()> DFSExplorer::on_log_state_signal;
+xbt::signal<void(RemoteApp&)> DFSExplorer::on_log_state_signal;
 
 void DFSExplorer::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 %ld -> state %ld", (*state)->num_, current_state->num_);
+    if (*(*state)->get_system_state() == *current_state->get_system_state()) {
+      XBT_INFO("Non-progressive cycle: state %ld -> state %ld", (*state)->get_num(), current_state->get_num());
       XBT_INFO("******************************************");
       XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
       XBT_INFO("******************************************");
@@ -68,23 +67,25 @@ RecordTrace DFSExplorer::get_record_trace() // override
 std::vector<std::string> DFSExplorer::get_textual_trace() // override
 {
   std::vector<std::string> trace;
-  for (auto const& state : stack_)
-    trace.push_back(state->get_transition()->to_string());
+  for (auto const& state : stack_) {
+    const auto* t = state->get_transition();
+    trace.push_back(xbt::string_printf("%ld: %s", t->aid_, t->to_string().c_str()));
+  }
   return trace;
 }
 
 void DFSExplorer::log_state() // override
 {
-  on_log_state_signal();
+  on_log_state_signal(get_remote_app());
   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(),
+           State::get_expanded_states(), backtrack_count_, mc_model_checker->get_visited_states(),
            Transition::get_replayed_transitions());
 }
 
 void DFSExplorer::run()
 {
-  on_exploration_start_signal();
+  on_exploration_start_signal(get_remote_app());
   /* 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. */
@@ -94,13 +95,14 @@ void DFSExplorer::run()
     State* state = stack_.back().get();
 
     XBT_DEBUG("**************************************************");
-    XBT_DEBUG("Exploration depth=%zu (state:%ld; %zu interleaves)", stack_.size(), state->num_, state->count_todo());
+    XBT_DEBUG("Exploration depth=%zu (state:%ld; %zu interleaves)", stack_.size(), state->get_num(),
+              state->count_todo());
 
-    Api::get().mc_inc_visited_states();
+    mc_model_checker->inc_visited_states();
 
     // Backtrack if we reached the maximum depth
     if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
-      if (reductionMode_ == ReductionMode::dpor) {
+      if (reduction_mode_ == ReductionMode::dpor) {
         XBT_ERROR("/!\\ Max depth of %d reached! THIS WILL PROBABLY BREAK the dpor reduction /!\\",
                   _sg_mc_max_depth.get());
         XBT_ERROR("/!\\ If bad things happen, disable dpor with --cfg=model-check/reduction:none /!\\");
@@ -121,62 +123,59 @@ void DFSExplorer::run()
     }
 
     // Search for the next transition
-    int next = state->next_transition();
+    aid_t 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);
+      XBT_DEBUG("There remains %lu actors, but none to interleave (depth %zu).", state->get_actor_count(),
+                stack_.size() + 1);
 
-      if (mc_model_checker->get_remote_process().actors().empty())
+      if (state->get_actor_count() == 0) {
         mc_model_checker->finalize_app();
+        XBT_VERB("Execution came to an end at %s (state: %ld, depth: %zu)", get_record_trace().to_string().c_str(),
+                 state->get_num(), stack_.size());
+      }
       this->backtrack();
       continue;
     }
 
     /* 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());
+    on_transition_execute_signal(state->get_transition(), get_remote_app());
 
     // If there are processes to interleave and the maximum depth has not been
     // reached then perform one step of the exploration algorithm.
     XBT_VERB("Execute %ld: %.60s (stack depth: %zu, state: %ld, %zu interleaves)", state->get_transition()->aid_,
-             state->get_transition()->to_string().c_str(), stack_.size(), state->num_, state->count_todo());
-
-    std::string req_str;
-    if (dot_output != nullptr)
-      req_str = state->get_transition()->dot_string();
+             state->get_transition()->to_string().c_str(), stack_.size(), state->get_num(), state->count_todo());
 
     /* Create the new expanded state (copy the state of MCed into our MCer data) */
-    auto next_state = std::make_unique<State>();
-    on_state_creation_signal(next_state.get());
+    auto next_state = std::make_unique<State>(get_remote_app());
+    on_state_creation_signal(next_state.get(), get_remote_app());
 
     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(next_state->num_, next_state.get(), true);
+      visited_state_ = visited_states_.addVisitedState(next_state->get_num(), next_state.get());
 
     /* 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 = Api::get().get_actors();
-      for (auto& remoteActor : actors) {
-        auto actor = remoteActor.copy.get_buffer();
-        if (get_session().actor_is_enabled(actor->get_pid())) {
-          next_state->mark_todo(actor->get_pid());
-          if (reductionMode_ == ReductionMode::dpor)
+      for (auto const& [aid, _] : next_state->get_actors_list()) {
+        if (next_state->is_actor_enabled(aid)) {
+          next_state->mark_todo(aid);
+          if (reduction_mode_ == ReductionMode::dpor)
             break; // With DPOR, we take the first enabled transition
         }
       }
 
-      if (dot_output != nullptr)
-        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, "\"%ld\" -> \"%ld\" [%s];\n", state->num_,
-                   visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num,
-                   req_str.c_str());
+      mc_model_checker->dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(), next_state->get_num(),
+                                   state->get_transition()->dot_string().c_str());
+    } else
+      mc_model_checker->dot_output("\"%ld\" -> \"%ld\" [%s];\n", state->get_num(),
+                                   visited_state_->original_num == -1 ? visited_state_->num
+                                                                      : visited_state_->original_num,
+                                   state->get_transition()->dot_string().c_str());
 
     stack_.push_back(std::move(next_state));
   }
@@ -188,20 +187,20 @@ void DFSExplorer::backtrack()
 {
   backtrack_count_++;
   XBT_VERB("Backtracking from %s", get_record_trace().to_string().c_str());
-  on_backtracking_signal();
+  on_backtracking_signal(get_remote_app());
   stack_.pop_back();
 
-  get_session().check_deadlock();
+  get_remote_app().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
    *  predecessor state), depends on any other previous request executed before it. If it does then add it to the
    *  interleave set of the state that executed that previous request. */
-
-  while (not stack_.empty()) {
+  bool found_backtracking_point = false;
+  while (not stack_.empty() && not found_backtracking_point) {
     std::unique_ptr<State> state = std::move(stack_.back());
     stack_.pop_back();
-    if (reductionMode_ == ReductionMode::dpor) {
+    if (reduction_mode_ == ReductionMode::dpor) {
       aid_t issuer_id = state->get_transition()->aid_;
       for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
         State* prev_state = i->get();
@@ -211,92 +210,84 @@ void DFSExplorer::backtrack()
           break;
         } 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_);
+          XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
+          XBT_VERB("  %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
 
-          if (not prev_state->actor_states_[issuer_id].is_done())
+          if (not prev_state->is_done(issuer_id))
             prev_state->mark_todo(issuer_id);
           else
             XBT_DEBUG("Actor %ld is in done set", issuer_id);
           break;
         } else {
           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_);
+          XBT_VERB("  %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
+          XBT_VERB("  %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_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 %ld at depth %zu", state->num_, stack_.size() + 1);
-      stack_.push_back(
-          std::move(state)); // Put it back on the stack from which it was removed earlier in this while loop
-      this->restore_state();
-      XBT_DEBUG("Back-tracking to state %ld at depth %zu done", stack_.back()->num_, stack_.size());
-      break;
+    if (state->count_todo() == 0) { // Empty interleaving set
+      XBT_DEBUG("Delete state %ld at depth %zu", state->get_num(), stack_.size() + 1);
+
     } else {
-      XBT_DEBUG("Delete state %ld at depth %zu", state->num_, stack_.size() + 1);
+      XBT_DEBUG("Back-tracking to state %ld at depth %zu", state->get_num(), stack_.size() + 1);
+      stack_.push_back(std::move(state)); // Put it back on the stack
+      found_backtracking_point = true;
     }
   }
-}
 
-void DFSExplorer::restore_state()
-{
-  /* 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 (found_backtracking_point) {
+    /* If asked to rollback on a state that has a snapshot, restore it */
+    State* last_state = stack_.back().get();
+    if (const auto* system_state = last_state->get_system_state()) {
+      system_state->restore(&get_remote_app().get_remote_process());
+      on_restore_system_state_signal(last_state, get_remote_app());
+      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 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();
-  }
+    /* if no snapshot, we need to restore the initial state and replay the transitions */
+    get_remote_app().restore_initial_state();
+    on_restore_initial_state_signal(get_remote_app());
+
+    /* 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 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(), get_remote_app());
+      /* Update statistics */
+      mc_model_checker->inc_visited_states();
+    }
+  } // If no backtracing point, then the stack is empty and the exploration is over
 }
 
-DFSExplorer::DFSExplorer(Session* session) : Exploration(session)
+DFSExplorer::DFSExplorer(const std::vector<char*>& args, bool with_dpor) : Exploration(args)
 {
-  reductionMode_ = reduction_mode;
-  if (_sg_mc_termination)
-    reductionMode_ = ReductionMode::none;
-  else if (reductionMode_ == ReductionMode::unset)
-    reductionMode_ = ReductionMode::dpor;
-
-  if (_sg_mc_termination)
-    XBT_INFO("Check non progressive cycles");
+  if (with_dpor)
+    reduction_mode_ = ReductionMode::dpor;
   else
-    XBT_INFO("Start a DFS exploration. Reduction is: %s.",
-             (reductionMode_ == ReductionMode::none ? "none"
-                                                    : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
-
-  get_session().take_initial_snapshot();
+    reduction_mode_ = ReductionMode::none;
 
-  XBT_DEBUG("Starting the DFS exploration");
+  if (_sg_mc_termination) {
+    if (with_dpor) {
+      XBT_INFO("Check non progressive cycles (turning DPOR off)");
+      reduction_mode_ = ReductionMode::none;
+    } else {
+      XBT_INFO("Check non progressive cycles");
+    }
+  } else
+    XBT_INFO("Start a DFS exploration. Reduction is: %s.", to_c_str(reduction_mode_));
 
-  auto initial_state = std::make_unique<State>();
+  auto initial_state = std::make_unique<State>(get_remote_app());
 
   XBT_DEBUG("**************************************************");
 
   /* Get an enabled actor and insert it in the interleave set of the initial state */
-  auto actors = Api::get().get_actors();
-  XBT_DEBUG("Initial state. %zu actors to consider", actors.size());
-  for (auto& actor : actors) {
-    aid_t aid = actor.copy.get_buffer()->get_pid();
-    if (get_session().actor_is_enabled(aid)) {
+  XBT_DEBUG("Initial state. %lu actors to consider", initial_state->get_actor_count());
+  for (auto const& [aid, _] : initial_state->get_actors_list()) {
+    if (initial_state->is_actor_enabled(aid)) {
       initial_state->mark_todo(aid);
-      if (reductionMode_ == ReductionMode::dpor) {
+      if (reduction_mode_ == ReductionMode::dpor) {
         XBT_DEBUG("Actor %ld is TODO, DPOR is ON so let's go for this one.", aid);
         break;
       }
@@ -307,10 +298,9 @@ DFSExplorer::DFSExplorer(Session* session) : Exploration(session)
   stack_.push_back(std::move(initial_state));
 }
 
-Exploration* create_dfs_exploration(Session* session)
+Exploration* create_dfs_exploration(const std::vector<char*>& args, bool with_dpor)
 {
-  return new DFSExplorer(session);
+  return new DFSExplorer(args, with_dpor);
 }
 
-} // namespace mc
-} // namespace simgrid
+} // namespace simgrid::mc