Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move the selection of the next transition to execute to mc::State
[simgrid.git] / src / mc / checker / CommunicationDeterminismChecker.cpp
index 979950c..3ac7e22 100644 (file)
@@ -1,19 +1,14 @@
-/* Copyright (c) 2008-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2008-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 "src/mc/checker/CommunicationDeterminismChecker.hpp"
 #include "src/kernel/activity/MailboxImpl.hpp"
+#include "src/mc/Session.hpp"
 #include "src/mc/mc_config.hpp"
 #include "src/mc/mc_exit.hpp"
 #include "src/mc/mc_private.hpp"
-#include "src/mc/mc_request.hpp"
-#include "src/mc/mc_smx.hpp"
-
-#if HAVE_SMPI
-#include "smpi_request.hpp"
-#endif
 
 #include <cstdint>
 
@@ -64,7 +59,8 @@ static void restore_communications_pattern(simgrid::mc::State* state)
   for (size_t i = 0; i < initial_communications_pattern.size(); i++)
     initial_communications_pattern[i].index_comm = state->communication_indices_[i];
 
-  for (unsigned long i = 0; i < api::get().get_maxpid(); i++)
+  const unsigned long maxpid = api::get().get_maxpid();
+  for (unsigned long i = 0; i < maxpid; i++)
     patterns_copy(incomplete_communications_pattern[i], state->incomplete_comm_pattern_[i]);
 }
 
@@ -111,24 +107,25 @@ static char* print_determinism_result(simgrid::mc::CommPatternDifference diff, a
 }
 
 static void update_comm_pattern(simgrid::mc::PatternCommunication* comm_pattern,
-                                const simgrid::kernel::activity::CommImpl* comm_addr)
+                                simgrid::mc::RemotePtr<simgrid::kernel::activity::CommImpl> const& comm_addr)
 {
   auto src_proc = api::get().get_src_actor(comm_addr);
   auto dst_proc = api::get().get_dst_actor(comm_addr);
   comm_pattern->src_proc = src_proc->get_pid();
   comm_pattern->dst_proc = dst_proc->get_pid();
-  comm_pattern->src_host = api::get().get_actor_host_name(src_proc);
-  comm_pattern->dst_host = api::get().get_actor_host_name(dst_proc);
+  comm_pattern->src_host = &api::get().get_actor_host_name(src_proc);
+  comm_pattern->dst_host = &api::get().get_actor_host_name(dst_proc);
 
-  if (comm_pattern->data.empty())
+  if (comm_pattern->data.empty()) {
     comm_pattern->data = api::get().get_pattern_comm_data(comm_addr);
+  }
 }
 
 namespace simgrid {
 namespace mc {
 
 void CommunicationDeterminismChecker::deterministic_comm_pattern(aid_t process, const PatternCommunication* comm,
-                                                                 int backtracking)
+                                                                 bool backtracking)
 {
   if (not backtracking) {
     PatternCommunicationList& list = initial_communications_pattern[process];
@@ -178,7 +175,7 @@ void CommunicationDeterminismChecker::deterministic_comm_pattern(aid_t process,
 
 /********** Non Static functions ***********/
 
-void CommunicationDeterminismChecker::get_comm_pattern(smx_simcall_t request, CallType call_type, int backtracking)
+void CommunicationDeterminismChecker::get_comm_pattern(smx_simcall_t request, CallType call_type, bool backtracking)
 {
   const smx_actor_t issuer                                     = api::get().simcall_get_issuer(request);
   const mc::PatternCommunicationList& initial_pattern          = initial_communications_pattern[issuer->get_pid()];
@@ -190,10 +187,10 @@ void CommunicationDeterminismChecker::get_comm_pattern(smx_simcall_t request, Ca
   if (call_type == CallType::SEND) {
     /* Create comm pattern */
     pattern->type      = PatternCommunicationType::send;
-    pattern->comm_addr = api::get().get_comm_isend_raw_addr(request).local();
-    pattern->rdv      = api::get().get_pattern_comm_rdv(pattern->comm_addr);
-    pattern->src_proc = api::get().get_pattern_comm_src_proc(pattern->comm_addr);
-    pattern->src_host = Api::get().get_actor_host_name(issuer);
+    pattern->comm_addr = api::get().get_comm_isend_raw_addr(request);
+    pattern->rdv       = api::get().get_pattern_comm_rdv(pattern->comm_addr);
+    pattern->src_proc  = api::get().get_pattern_comm_src_proc(pattern->comm_addr);
+    pattern->src_host  = &api::get().get_actor_host_name(issuer);
 
 #if HAVE_SMPI
     pattern->tag = api::get().get_smpi_request_tag(request, simgrid::simix::Simcall::COMM_ISEND);
@@ -216,15 +213,14 @@ void CommunicationDeterminismChecker::get_comm_pattern(smx_simcall_t request, Ca
 #endif
   } else if (call_type == CallType::RECV) {
     pattern->type = PatternCommunicationType::receive;
-    pattern->comm_addr = api::get().get_comm_isend_raw_addr(request).local();
+    pattern->comm_addr = api::get().get_comm_isend_raw_addr(request);
 
 #if HAVE_SMPI
     pattern->tag = api::get().get_smpi_request_tag(request, simgrid::simix::Simcall::COMM_IRECV);
 #endif
-    auto comm_addr = pattern->comm_addr;
-    pattern->rdv = api::get().get_pattern_comm_rdv(comm_addr);
-    pattern->dst_proc = api::get().get_pattern_comm_dst_proc(comm_addr);
-    pattern->dst_host = api::get().get_actor_host_name(issuer);
+    pattern->rdv = api::get().get_pattern_comm_rdv(pattern->comm_addr);
+    pattern->dst_proc = api::get().get_pattern_comm_dst_proc(pattern->comm_addr);
+    pattern->dst_host = &api::get().get_actor_host_name(issuer);
   } else
     xbt_die("Unexpected call_type %i", (int)call_type);
 
@@ -232,16 +228,15 @@ void CommunicationDeterminismChecker::get_comm_pattern(smx_simcall_t request, Ca
   incomplete_communications_pattern[issuer->get_pid()].push_back(pattern.release());
 }
 
-void CommunicationDeterminismChecker::complete_comm_pattern(const kernel::activity::CommImpl* comm_addr, aid_t issuer,
-                                                            int backtracking)
+void CommunicationDeterminismChecker::complete_comm_pattern(RemotePtr<kernel::activity::CommImpl> const& comm_addr,
+                                                            aid_t issuer, bool backtracking)
 {
   /* Complete comm pattern */
   std::vector<PatternCommunication*>& incomplete_pattern = incomplete_communications_pattern[issuer];
   auto current_comm_pattern =
       std::find_if(begin(incomplete_pattern), end(incomplete_pattern),
-                   [&comm_addr](const PatternCommunication* comm) { return api::get().comm_addr_equal(comm->comm_addr, comm_addr); });
-  if (current_comm_pattern == std::end(incomplete_pattern))
-    xbt_die("Corresponding communication not found!");
+                   [&comm_addr](const PatternCommunication* comm) { return (comm->comm_addr == comm_addr); });
+  xbt_assert(current_comm_pattern != std::end(incomplete_pattern), "Corresponding communication not found!");
 
   update_comm_pattern(*current_comm_pattern, comm_addr);
   std::unique_ptr<PatternCommunication> comm_pattern(*current_comm_pattern);
@@ -259,7 +254,7 @@ void CommunicationDeterminismChecker::complete_comm_pattern(const kernel::activi
   }
 }
 
-CommunicationDeterminismChecker::CommunicationDeterminismChecker() : Checker() {}
+CommunicationDeterminismChecker::CommunicationDeterminismChecker(Session* session) : Checker(session) {}
 
 CommunicationDeterminismChecker::~CommunicationDeterminismChecker() = default;
 
@@ -274,10 +269,8 @@ RecordTrace CommunicationDeterminismChecker::get_record_trace() // override
 std::vector<std::string> CommunicationDeterminismChecker::get_textual_trace() // override
 {
   std::vector<std::string> trace;
-  for (auto const& state : stack_) {
-    smx_simcall_t req = &state->executed_req_;
-    trace.push_back(api::get().request_to_string(req, state->transition_.argument_, RequestType::executed));
-  }
+  for (auto const& state : stack_)
+    trace.push_back(state->transition_.to_string());
   return trace;
 }
 
@@ -299,7 +292,7 @@ void CommunicationDeterminismChecker::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", api::get().mc_get_executed_trans());
+  XBT_INFO("Executed transitions = %lu", Transition::get_executed_transitions());
   XBT_INFO("Send-deterministic : %s", this->send_deterministic ? "Yes" : "No");
   if (_sg_mc_comms_determinism)
     XBT_INFO("Recv-deterministic : %s", this->recv_deterministic ? "Yes" : "No");
@@ -307,7 +300,7 @@ void CommunicationDeterminismChecker::log_state() // override
 
 void CommunicationDeterminismChecker::prepare()
 {
-  const auto maxpid = api::get().get_maxpid();
+  const unsigned long maxpid = api::get().get_maxpid();
 
   initial_communications_pattern.resize(maxpid);
   incomplete_communications_pattern.resize(maxpid);
@@ -317,18 +310,19 @@ void CommunicationDeterminismChecker::prepare()
 
   XBT_DEBUG("********* Start communication determinism verification *********");
 
-  /* Get an enabled actor and insert it in the interleave set of the initial state */
-  auto actors = api::get().get_actors();
-  for (auto& actor : actors)
-    if (api::get().actor_is_enabled(actor.copy.get_buffer()->get_pid()))
-      initial_state->add_interleaving_set(actor.copy.get_buffer());
+  /* Add all enabled actors to the interleave set of the initial state */
+  for (auto& act : api::get().get_actors()) {
+    auto actor = act.copy.get_buffer();
+    if (get_session().actor_is_enabled(actor->get_pid()))
+      initial_state->mark_todo(actor->get_pid());
+  }
 
   stack_.push_back(std::move(initial_state));
 }
 
 static inline bool all_communications_are_finished()
 {
-  auto maxpid = api::get().get_maxpid();
+  const unsigned long maxpid = api::get().get_maxpid();
   for (size_t current_actor = 1; current_actor < maxpid; current_actor++) {
     if (not incomplete_communications_pattern[current_actor].empty()) {
       XBT_DEBUG("Some communications are not finished, cannot stop the exploration! State not visited.");
@@ -343,18 +337,17 @@ void CommunicationDeterminismChecker::restoreState()
   /* Intermediate backtracking */
   State* last_state = stack_.back().get();
   if (last_state->system_state_) {
-    Api::get().restore_state(last_state->system_state_);
+    api::get().restore_state(last_state->system_state_);
     restore_communications_pattern(last_state);
     return;
   }
 
-  /* Restore the initial state */
-  api::get().restore_initial_state();
+  get_session().restore_initial_state();
 
-  unsigned long n = api::get().get_maxpid();
-  assert(n == incomplete_communications_pattern.size());
-  assert(n == initial_communications_pattern.size());
-  for (unsigned long j = 0; j < n; j++) {
+  const unsigned long maxpid = api::get().get_maxpid();
+  assert(maxpid == incomplete_communications_pattern.size());
+  assert(maxpid == initial_communications_pattern.size());
+  for (unsigned long j = 0; j < maxpid; j++) {
     incomplete_communications_pattern[j].clear();
     initial_communications_pattern[j].index_comm = 0;
   }
@@ -364,7 +357,7 @@ void CommunicationDeterminismChecker::restoreState()
     if (state == stack_.back())
       break;
 
-    int req_num                    = state->transition_.argument_;
+    int req_num                    = state->transition_.times_considered_;
     const s_smx_simcall* saved_req = &state->executed_req_;
     xbt_assert(saved_req);
 
@@ -376,17 +369,16 @@ void CommunicationDeterminismChecker::restoreState()
 
     /* TODO : handle test and testany simcalls */
     CallType call = MC_get_call_type(req);
-    api::get().handle_simcall(state->transition_);
+    state->transition_.replay();
     handle_comm_pattern(call, req, req_num, 1);
-    api::get().mc_wait_for_requests();
 
     /* Update statistics */
     api::get().mc_inc_visited_states();
-    api::get().mc_inc_executed_trans();
   }
 }
 
-void CommunicationDeterminismChecker::handle_comm_pattern(simgrid::mc::CallType call_type, smx_simcall_t req, int value, int backtracking)
+void CommunicationDeterminismChecker::handle_comm_pattern(simgrid::mc::CallType call_type, smx_simcall_t req, int value,
+                                                          bool backtracking)
 {
   using simgrid::mc::CallType;
   switch(call_type) {
@@ -398,9 +390,9 @@ void CommunicationDeterminismChecker::handle_comm_pattern(simgrid::mc::CallType
       break;
     case CallType::WAIT:
     case CallType::WAITANY: {
-      const simgrid::kernel::activity::CommImpl* comm_addr = nullptr;
+      RemotePtr<simgrid::kernel::activity::CommImpl> comm_addr;
       if (call_type == CallType::WAIT)
-        comm_addr = api::get().get_comm_wait_raw_addr(req);
+        comm_addr = remote(simcall_comm_wait__getraw__comm(req));
       else
         comm_addr = api::get().get_comm_waitany_raw_addr(req, value);
       auto simcall_issuer = api::get().simcall_get_issuer(req);
@@ -414,7 +406,6 @@ void CommunicationDeterminismChecker::handle_comm_pattern(simgrid::mc::CallType
 void CommunicationDeterminismChecker::real_run()
 {
   std::unique_ptr<VisitedState> visited_state = nullptr;
-  smx_simcall_t req                           = nullptr;
 
   while (not stack_.empty()) {
     /* Get current state */
@@ -422,41 +413,35 @@ void CommunicationDeterminismChecker::real_run()
 
     XBT_DEBUG("**************************************************");
     XBT_DEBUG("Exploration depth = %zu (state = %d, interleaved processes = %zu)", stack_.size(), cur_state->num_,
-              cur_state->interleave_size());
+              cur_state->count_todo());
 
     /* Update statistics */
     api::get().mc_inc_visited_states();
 
+    int next_transition = -1;
     if (stack_.size() <= (std::size_t)_sg_mc_max_depth)
-      req = api::get().mc_state_choose_request(cur_state);
-    else
-      req = nullptr;
+      next_transition = cur_state->next_transition();
 
-    if (req != nullptr && visited_state == nullptr) {
-      int req_num = cur_state->transition_.argument_;
+    if (next_transition >= 0 && visited_state == nullptr) {
+      cur_state->transition_.execute(cur_state, next_transition);
 
-      XBT_DEBUG("Execute: %s", api::get().request_to_string(req, req_num, RequestType::simix).c_str());
+      aid_t aid         = cur_state->transition_.aid_;
+      int req_num = cur_state->transition_.times_considered_;
+      smx_simcall_t req = &cur_state->executed_req_;
+
+      XBT_DEBUG("Execute: %s", cur_state->transition_.to_string().c_str());
 
       std::string req_str;
       if (dot_output != nullptr)
-        req_str = api::get().request_get_dot_output(req, req_num);
-
-      api::get().mc_inc_executed_trans();
+        req_str = api::get().request_get_dot_output(aid, req_num);
 
       /* TODO : handle test and testany simcalls */
       CallType call = CallType::NONE;
       if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
         call = MC_get_call_type(req);
 
-      /* Answer the request */
-      api::get().handle_simcall(cur_state->transition_);
-      /* After this call req is no longer useful */
-
       handle_comm_pattern(call, req, req_num, 0);
 
-      /* Wait for requests (schedules processes) */
-      api::get().mc_wait_for_requests();
-
       /* Create the new expanded state */
       ++expanded_states_count_;
       auto next_state = std::make_unique<State>(expanded_states_count_);
@@ -472,11 +457,12 @@ void CommunicationDeterminismChecker::real_run()
         visited_state = nullptr;
 
       if (visited_state == nullptr) {
-        /* Get enabled actors and insert them in the interleave set of the next state */
-        auto actors = api::get().get_actors();
-        for (auto& actor : actors)
-          if (api::get().actor_is_enabled(actor.copy.get_buffer()->get_pid()))
-            next_state->add_interleaving_set(actor.copy.get_buffer());
+        /* Add all enabled actors to the interleave set of the next state */
+        for (auto& act : api::get().get_actors()) {
+          auto actor = act.copy.get_buffer();
+          if (get_session().actor_is_enabled(actor->get_pid()))
+            next_state->mark_todo(actor->get_pid());
+        }
 
         if (dot_output != nullptr)
           fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", cur_state->num_, next_state->num_, req_str.c_str());
@@ -503,16 +489,12 @@ void CommunicationDeterminismChecker::real_run()
 
       visited_state = nullptr;
 
-      /* Check for deadlocks */
-      if (api::get().mc_check_deadlock()) {
-        api::get().mc_show_deadlock();
-        throw simgrid::mc::DeadlockError();
-      }
+      api::get().mc_check_deadlock();
 
       while (not stack_.empty()) {
         std::unique_ptr<State> state(std::move(stack_.back()));
         stack_.pop_back();
-        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));
@@ -535,15 +517,15 @@ void CommunicationDeterminismChecker::real_run()
 void CommunicationDeterminismChecker::run()
 {
   XBT_INFO("Check communication determinism");
-  api::get().session_initialize();
+  get_session().take_initial_snapshot();
 
   this->prepare();
   this->real_run();
 }
 
-Checker* createCommunicationDeterminismChecker()
+Checker* create_communication_determinism_checker(Session* session)
 {
-  return new CommunicationDeterminismChecker();
+  return new CommunicationDeterminismChecker(session);
 }
 
 } // namespace mc