Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines.
[simgrid.git] / src / mc / Session.cpp
index 8c0926e..3bd3c48 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2015-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2015-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,11 +6,19 @@
 #include "src/mc/Session.hpp"
 #include "src/mc/checker/Checker.hpp"
 #include "src/mc/mc_config.hpp"
+#include "src/internal_config.h" // HAVE_SMPI
+#if HAVE_SMPI
+#include "smpi/smpi.h"
+#endif
 #include "src/mc/mc_private.hpp"
 #include "src/mc/mc_state.hpp"
 #include "xbt/log.h"
 #include "xbt/system_error.hpp"
 
+#include <array>
+#include <memory>
+#include <string>
+
 #include <fcntl.h>
 #ifdef __linux__
 #include <sys/prctl.h>
@@ -21,82 +29,68 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_Session, mc, "Model-checker session");
 namespace simgrid {
 namespace mc {
 
-static void setup_child_environment(int socket)
+template <class Code> void run_child_process(int socket, Code code)
 {
+  /* On startup, simix_global_init() calls simgrid::mc::Client::initialize(), which checks whether the MC_ENV_SOCKET_FD
+   * env variable is set. If so, MC mode is assumed, and the client is setup from its side
+   */
+
 #ifdef __linux__
-  // Make sure we do not outlive our parent:
+  // Make sure we do not outlive our parent
   sigset_t mask;
   sigemptyset (&mask);
   xbt_assert(sigprocmask(SIG_SETMASK, &mask, nullptr) >= 0, "Could not unblock signals");
   xbt_assert(prctl(PR_SET_PDEATHSIG, SIGHUP) == 0, "Could not PR_SET_PDEATHSIG");
 #endif
 
-  // Remove CLOEXEC in order to pass the socket to the exec-ed program:
+  // Remove CLOEXEC to pass the socket to the application
   int fdflags = fcntl(socket, F_GETFD, 0);
   xbt_assert(fdflags != -1 && fcntl(socket, F_SETFD, fdflags & ~FD_CLOEXEC) != -1,
              "Could not remove CLOEXEC for socket");
 
-  // Set environment:
-  setenv(MC_ENV_VARIABLE, "1", 1);
-
-  // Disable lazy relocation in the model-checked process.
-  // We don't want the model-checked process to modify its .got.plt during
-  // snapshot.
+  // Disable lazy relocation in the model-checked process to prevent the application from
+  // modifying its .got.plt during snapshot.
   setenv("LC_BIND_NOW", "1", 1);
 
-  char buffer[64];
-  int res = std::snprintf(buffer, sizeof(buffer), "%i", socket);
-  xbt_assert((size_t)res < sizeof(buffer) && res != -1);
-  setenv(MC_ENV_SOCKET_FD, buffer, 1);
-}
-
-/** Execute some code in a forked process */
-template<class F>
-static inline
-pid_t do_fork(F code)
-{
-  pid_t pid = fork();
-  xbt_assert(pid >= 0, "Could not fork model-checked process");
-  if (pid != 0)
-    return pid;
+  setenv(MC_ENV_SOCKET_FD, std::to_string(socket).c_str(), 1);
 
-  // Child-process:
   code();
-  _exit(EXIT_SUCCESS);
 }
 
 Session::Session(const std::function<void()>& code)
 {
 #if HAVE_SMPI
-  xbt_assert(smpi_privatize_global_variables != SmpiPrivStrategies::MMAP,
+  smpi_init_options();//only performed once
+  xbt_assert(smpi_cfg_privatization() != SmpiPrivStrategies::MMAP,
              "Please use the dlopen privatization schema when model-checking SMPI code");
 #endif
 
-  // Create a AF_LOCAL socketpair used for exchanging messages
+  // Create an AF_LOCAL socketpair used for exchanging messages
   // between the model-checker process (ourselves) and the model-checked
   // process:
-  int res;
   int sockets[2];
-  res = socketpair(AF_LOCAL, SOCK_SEQPACKET | SOCK_CLOEXEC, 0, sockets);
-  if (res == -1)
-    throw simgrid::xbt::errno_error("Could not create socketpair");
+  int res = socketpair(AF_LOCAL, SOCK_SEQPACKET | SOCK_CLOEXEC, 0, sockets);
+  xbt_assert(res != -1, "Could not create socketpair");
 
-  pid_t pid = do_fork([sockets, &code] {
+  pid_t pid = fork();
+  xbt_assert(pid >= 0, "Could not fork model-checked process");
+
+  if (pid == 0) { // Child
     ::close(sockets[1]);
-    setup_child_environment(sockets[0]);
-    code();
-    xbt_die("The model-checked process failed to exec()");
-  });
+    run_child_process(sockets[0], code);
+    DIE_IMPOSSIBLE;
+  }
 
   // Parent (model-checker):
   ::close(sockets[0]);
 
-  std::unique_ptr<simgrid::mc::RemoteClient> process(new simgrid::mc::RemoteClient(pid, sockets[1]));
-  model_checker_.reset(new simgrid::mc::ModelChecker(std::move(process)));
+  xbt_assert(mc_model_checker == nullptr, "Did you manage to start the MC twice in this process?");
+
+  auto process = std::make_unique<simgrid::mc::RemoteSimulation>(pid);
+  model_checker_ = std::make_unique<simgrid::mc::ModelChecker>(std::move(process), sockets[1]);
 
-  xbt_assert(mc_model_checker == nullptr);
   mc_model_checker = model_checker_.get();
-  mc_model_checker->start();
+  model_checker_->start();
 }
 
 Session::~Session()
@@ -104,27 +98,28 @@ Session::~Session()
   this->close();
 }
 
+/** Take the initial snapshot of the application, that must be stopped. */
 void Session::initialize()
 {
   xbt_assert(initial_snapshot_ == nullptr);
-  mc_model_checker->wait_for_requests();
+  model_checker_->wait_for_requests();
   initial_snapshot_ = std::make_shared<simgrid::mc::Snapshot>(0);
 }
 
-void Session::execute(Transition const& transition)
+void Session::execute(Transition const& transition) const
 {
   model_checker_->handle_simcall(transition);
   model_checker_->wait_for_requests();
 }
 
-void Session::restore_initial_state()
+void Session::restore_initial_state() const
 {
-  this->initial_snapshot_->restore(&mc_model_checker->process());
+  this->initial_snapshot_->restore(&model_checker_->get_remote_simulation());
 }
 
-void Session::log_state()
+void Session::log_state() const
 {
-  mc_model_checker->getChecker()->log_state();
+  model_checker_->getChecker()->log_state();
 
   if (not _sg_mc_dot_output_file.get().empty()) {
     fprintf(dot_output, "}\n");
@@ -132,7 +127,8 @@ void Session::log_state()
   }
   if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
     int ret=system("free");
-    if(ret!=0)XBT_WARN("system call did not return 0, but %d",ret);
+    if (ret != 0)
+      XBT_WARN("Call to system(free) did not return 0, but %d", ret);
   }
 }
 
@@ -146,6 +142,16 @@ void Session::close()
   }
 }
 
+bool Session::actor_is_enabled(aid_t pid) const
+{
+  s_mc_message_actor_enabled_t msg{simgrid::mc::MessageType::ACTOR_ENABLED, pid};
+  model_checker_->channel().send(msg);
+  std::array<char, MC_MESSAGE_LENGTH> buff;
+  ssize_t received = model_checker_->channel().receive(buff.data(), buff.size(), true);
+  xbt_assert(received == sizeof(s_mc_message_int_t), "Unexpected size in answer to ACTOR_ENABLED");
+  return ((s_mc_message_int_t*)buff.data())->value;
+}
+
 simgrid::mc::Session* session;
 
 }