Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics
[simgrid.git] / src / mc / checker / CommunicationDeterminismChecker.cpp
index e64020d..9c179ab 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2008-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2008-2021. 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. */
@@ -6,20 +6,13 @@
 #include "src/mc/checker/CommunicationDeterminismChecker.hpp"
 #include "src/kernel/activity/MailboxImpl.hpp"
 #include "src/mc/Session.hpp"
-#include "src/mc/mc_api.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>
 
-using mcapi = simgrid::mc::mc_api;
+using api = simgrid::mc::Api;
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_comm_determinism, mc, "Logging specific to MC communication determinism detection");
 
@@ -66,20 +59,21 @@ 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 < mcapi::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]);
 }
 
-static char* print_determinism_result(simgrid::mc::CommPatternDifference diff, int process,
+static char* print_determinism_result(simgrid::mc::CommPatternDifference diff, aid_t process,
                                       const simgrid::mc::PatternCommunication* comm, unsigned int cursor)
 {
   char* type;
   char* res;
 
   if (comm->type == simgrid::mc::PatternCommunicationType::send)
-    type = bprintf("The send communications pattern of the process %d is different!", process - 1);
+    type = bprintf("The send communications pattern of the process %ld is different!", process - 1);
   else
-    type = bprintf("The recv communications pattern of the process %d is different!", process - 1);
+    type = bprintf("The recv communications pattern of the process %ld is different!", process - 1);
 
   using simgrid::mc::CommPatternDifference;
   switch (diff) {
@@ -113,23 +107,24 @@ static char* print_determinism_result(simgrid::mc::CommPatternDifference diff, i
 }
 
 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 = mcapi::get().get_src_actor(comm_addr);
-  auto dst_proc = mcapi::get().get_dst_actor(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 = mcapi::get().get_actor_host_name(src_proc);
-  comm_pattern->dst_host = mcapi::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())
-    comm_pattern->data = mcapi::get().get_pattern_comm_data(comm_addr);
+  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(int process, const PatternCommunication* comm,
+void CommunicationDeterminismChecker::deterministic_comm_pattern(aid_t process, const PatternCommunication* comm,
                                                                  int backtracking)
 {
   if (not backtracking) {
@@ -155,8 +150,8 @@ void CommunicationDeterminismChecker::deterministic_comm_pattern(int process, co
         XBT_INFO("%s", this->send_diff);
         xbt_free(this->send_diff);
         this->send_diff = nullptr;
-        mcapi::get().log_state();
-        mcapi::get().mc_exit(SIMGRID_MC_EXIT_NON_DETERMINISM);
+        api::get().log_state();
+        api::get().mc_exit(SIMGRID_MC_EXIT_NON_DETERMINISM);
       } else if (_sg_mc_comms_determinism && (not this->send_deterministic && not this->recv_deterministic)) {
         XBT_INFO("****************************************************");
         XBT_INFO("***** Non-deterministic communications pattern *****");
@@ -171,8 +166,8 @@ void CommunicationDeterminismChecker::deterministic_comm_pattern(int process, co
           xbt_free(this->recv_diff);
           this->recv_diff = nullptr;
         }
-        mcapi::get().log_state();
-        mcapi::get().mc_exit(SIMGRID_MC_EXIT_NON_DETERMINISM);
+        api::get().log_state();
+        api::get().mc_exit(SIMGRID_MC_EXIT_NON_DETERMINISM);
       }
     }
   }
@@ -182,7 +177,7 @@ void CommunicationDeterminismChecker::deterministic_comm_pattern(int process, co
 
 void CommunicationDeterminismChecker::get_comm_pattern(smx_simcall_t request, CallType call_type, int backtracking)
 {
-  const smx_actor_t issuer                                     = mcapi::get().simcall_get_issuer(request);
+  const smx_actor_t issuer                                     = api::get().simcall_get_issuer(request);
   const mc::PatternCommunicationList& initial_pattern          = initial_communications_pattern[issuer->get_pid()];
   const std::vector<PatternCommunication*>& incomplete_pattern = incomplete_communications_pattern[issuer->get_pid()];
 
@@ -192,18 +187,18 @@ 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 = mcapi::get().get_comm_isend_raw_addr(request);
-    pattern->rdv      = mcapi::get().get_pattern_comm_rdv(pattern->comm_addr);
-    pattern->src_proc = mcapi::get().get_pattern_comm_src_proc(pattern->comm_addr);
-    pattern->src_host = mc_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 = mcapi::get().get_smpi_request_tag(request, simgrid::simix::Simcall::COMM_ISEND);
+    pattern->tag = api::get().get_smpi_request_tag(request, simgrid::simix::Simcall::COMM_ISEND);
 #endif
-    pattern->data = mcapi::get().get_pattern_comm_data(pattern->comm_addr);
+    pattern->data = api::get().get_pattern_comm_data(pattern->comm_addr);
 
 #if HAVE_SMPI
-    auto send_detached = mcapi::get().check_send_request_detached(request);
+    auto send_detached = api::get().check_send_request_detached(request);
     if (send_detached) {
       if (this->initial_communications_pattern_done) {
         /* Evaluate comm determinism */
@@ -218,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 = mcapi::get().get_comm_isend_raw_addr(request);
+    pattern->comm_addr = api::get().get_comm_isend_raw_addr(request);
 
 #if HAVE_SMPI
-    pattern->tag = mcapi::get().get_smpi_request_tag(request, simgrid::simix::Simcall::COMM_IRECV);
+    pattern->tag = api::get().get_smpi_request_tag(request, simgrid::simix::Simcall::COMM_IRECV);
 #endif
-    auto comm_addr = pattern->comm_addr;
-    pattern->rdv = mcapi::get().get_pattern_comm_rdv(comm_addr);
-    pattern->dst_proc = mcapi::get().get_pattern_comm_dst_proc(comm_addr);
-    pattern->dst_host = mcapi::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);
 
@@ -234,20 +228,20 @@ 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,
-                                                            unsigned int issuer, int backtracking)
+void CommunicationDeterminismChecker::complete_comm_pattern(RemotePtr<kernel::activity::CommImpl> const& comm_addr, aid_t issuer,
+                                                            int 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 mcapi::get().comm_addr_equal(comm->comm_addr, comm_addr); });
+                   [&comm_addr](const PatternCommunication* comm) { return (comm->comm_addr == comm_addr); });
   if (current_comm_pattern == std::end(incomplete_pattern))
     xbt_die("Corresponding communication not found!");
 
   update_comm_pattern(*current_comm_pattern, comm_addr);
   std::unique_ptr<PatternCommunication> comm_pattern(*current_comm_pattern);
-  XBT_DEBUG("Remove incomplete comm pattern for process %u at cursor %zd", issuer,
+  XBT_DEBUG("Remove incomplete comm pattern for process %ld at cursor %zd", issuer,
             std::distance(begin(incomplete_pattern), current_comm_pattern));
   incomplete_pattern.erase(current_comm_pattern);
 
@@ -261,7 +255,7 @@ void CommunicationDeterminismChecker::complete_comm_pattern(const kernel::activi
   }
 }
 
-CommunicationDeterminismChecker::CommunicationDeterminismChecker(Session& s) : Checker(s) {}
+CommunicationDeterminismChecker::CommunicationDeterminismChecker(Session* session) : Checker(session) {}
 
 CommunicationDeterminismChecker::~CommunicationDeterminismChecker() = default;
 
@@ -278,7 +272,7 @@ std::vector<std::string> CommunicationDeterminismChecker::get_textual_trace() //
   std::vector<std::string> trace;
   for (auto const& state : stack_) {
     smx_simcall_t req = &state->executed_req_;
-    trace.push_back(mcapi::get().request_to_string(req, state->transition_.argument_, RequestType::executed));
+    trace.push_back(api::get().request_to_string(req, state->transition_.times_considered_));
   }
   return trace;
 }
@@ -300,8 +294,8 @@ void CommunicationDeterminismChecker::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());
   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");
@@ -309,7 +303,7 @@ void CommunicationDeterminismChecker::log_state() // override
 
 void CommunicationDeterminismChecker::prepare()
 {
-  const auto maxpid = mcapi::get().get_maxpid();
+  const unsigned long maxpid = api::get().get_maxpid();
 
   initial_communications_pattern.resize(maxpid);
   incomplete_communications_pattern.resize(maxpid);
@@ -319,18 +313,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 = mcapi::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());
+  /* 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 (api::get().actor_is_enabled(actor->get_pid()))
+      initial_state->mark_todo(actor);
+  }
 
   stack_.push_back(std::move(initial_state));
 }
 
 static inline bool all_communications_are_finished()
 {
-  auto maxpid = mcapi::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.");
@@ -345,18 +340,17 @@ void CommunicationDeterminismChecker::restoreState()
   /* Intermediate backtracking */
   State* last_state = stack_.back().get();
   if (last_state->system_state_) {
-    mc_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 */
-  mcapi::get().restore_initial_state();
+  session->restore_initial_state();
 
-  unsigned long n = mcapi::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;
   }
@@ -366,25 +360,25 @@ 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);
 
     /* because we got a copy of the executed request, we have to fetch the
        real one, pointed by the request field of the issuer process */
 
-    const smx_actor_t issuer = mcapi::get().simcall_get_issuer(saved_req);
+    const smx_actor_t issuer = api::get().simcall_get_issuer(saved_req);
     smx_simcall_t req        = &issuer->simcall_;
 
     /* TODO : handle test and testany simcalls */
     CallType call = MC_get_call_type(req);
-    mcapi::get().handle_simcall(state->transition_);
+    api::get().handle_simcall(state->transition_);
     handle_comm_pattern(call, req, req_num, 1);
-    mcapi::get().mc_wait_for_requests();
+    api::get().mc_wait_for_requests();
 
     /* 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();
   }
 }
 
@@ -400,12 +394,12 @@ void CommunicationDeterminismChecker::handle_comm_pattern(simgrid::mc::CallType
       break;
     case CallType::WAIT:
     case CallType::WAITANY: {
-      simgrid::kernel::activity::CommImpl* comm_addr = nullptr;
+      RemotePtr<simgrid::kernel::activity::CommImpl> comm_addr;
       if (call_type == CallType::WAIT)
-        comm_addr = mcapi::get().get_comm_wait_raw_addr(req);
+        comm_addr = remote(simcall_comm_wait__getraw__comm(req));
       else
-        comm_addr = mcapi::get().get_comm_waitany_raw_addr(req, value);
-      auto simcall_issuer = mcapi::get().simcall_get_issuer(req);
+        comm_addr = api::get().get_comm_waitany_raw_addr(req, value);
+      auto simcall_issuer = api::get().simcall_get_issuer(req);
       complete_comm_pattern(comm_addr, simcall_issuer->get_pid(), backtracking);
     } break;
   default:
@@ -424,26 +418,26 @@ 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 */
-    mcapi::get().mc_inc_visited_states();
+    api::get().mc_inc_visited_states();
 
     if (stack_.size() <= (std::size_t)_sg_mc_max_depth)
-      req = mcapi::get().mc_state_choose_request(cur_state);
+      req = api::get().mc_state_choose_request(cur_state);
     else
       req = nullptr;
 
     if (req != nullptr && visited_state == nullptr) {
-      int req_num = cur_state->transition_.argument_;
+      int req_num = cur_state->transition_.times_considered_;
 
-      XBT_DEBUG("Execute: %s", mcapi::get().request_to_string(req, req_num, RequestType::simix).c_str());
+      XBT_DEBUG("Execute: %s", api::get().request_to_string(req, req_num).c_str());
 
       std::string req_str;
       if (dot_output != nullptr)
-        req_str = mcapi::get().request_get_dot_output(req, req_num);
+        req_str = api::get().request_get_dot_output(req, req_num);
 
-      mcapi::get().mc_inc_executed_trans();
+      api::get().mc_inc_executed_trans();
 
       /* TODO : handle test and testany simcalls */
       CallType call = CallType::NONE;
@@ -451,13 +445,13 @@ void CommunicationDeterminismChecker::real_run()
         call = MC_get_call_type(req);
 
       /* Answer the request */
-      mcapi::get().handle_simcall(cur_state->transition_);
+      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) */
-      mcapi::get().mc_wait_for_requests();
+      api::get().mc_wait_for_requests();
 
       /* Create the new expanded state */
       ++expanded_states_count_;
@@ -474,11 +468,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 = mcapi::get().get_actors();
-        for (auto& actor : actors)
-          if (mcapi::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 (api::get().actor_is_enabled(actor->get_pid()))
+            next_state->mark_todo(actor);
+        }
 
         if (dot_output != nullptr)
           fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", cur_state->num_, next_state->num_, req_str.c_str());
@@ -505,16 +500,12 @@ void CommunicationDeterminismChecker::real_run()
 
       visited_state = nullptr;
 
-      /* Check for deadlocks */
-      if (mcapi::get().mc_check_deadlock()) {
-        mcapi::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));
@@ -531,21 +522,21 @@ void CommunicationDeterminismChecker::real_run()
     }
   }
 
-  mcapi::get().log_state();
+  api::get().log_state();
 }
 
 void CommunicationDeterminismChecker::run()
 {
   XBT_INFO("Check communication determinism");
-  mcapi::get().session_initialize();
+  get_session()->take_initial_snapshot();
 
   this->prepare();
   this->real_run();
 }
 
-Checker* createCommunicationDeterminismChecker(Session& s)
+Checker* createCommunicationDeterminismChecker(Session* session)
 {
-  return new CommunicationDeterminismChecker(s);
+  return new CommunicationDeterminismChecker(session);
 }
 
 } // namespace mc