src/mc/Session.cpp

   1 /* Copyright (c) 2015-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/mc/Session.hpp"
   7 #include "src/internal_config.h" // HAVE_SMPI
   8 #include "src/mc/explo/Exploration.hpp"
   9 #include "src/mc/mc_config.hpp"
  10 #if HAVE_SMPI
  11 #include "smpi/smpi.h"
  12 #include "src/smpi/include/private.hpp"
  13 #endif
  14 #include "src/mc/api/State.hpp"
  15 #include "src/mc/mc_exit.hpp"
  16 #include "src/mc/mc_private.hpp"
  17 #include "xbt/log.h"
  18 #include "xbt/system_error.hpp"
  19
  20 #include "signal.h"
  21 #include <array>
  22 #include <memory>
  23 #include <string>
  24
  25 #include <fcntl.h>
  26 #ifdef __linux__
  27 #include <sys/prctl.h>
  28 #endif
  29
  30 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_Session, mc, "Model-checker session");
  31 XBT_LOG_EXTERNAL_CATEGORY(mc_global);
  32
  33 namespace simgrid::mc {
  34
  35 template <class Code> void run_child_process(int socket, Code code)
  36 {
  37   /* On startup, simix_global_init() calls simgrid::mc::Client::initialize(), which checks whether the MC_ENV_SOCKET_FD
  38    * env variable is set. If so, MC mode is assumed, and the client is setup from its side
  39    */
  40
  41 #ifdef __linux__
  42   // Make sure we do not outlive our parent
  43   sigset_t mask;
  44   sigemptyset (&mask);
  45   xbt_assert(sigprocmask(SIG_SETMASK, &mask, nullptr) >= 0, "Could not unblock signals");
  46   xbt_assert(prctl(PR_SET_PDEATHSIG, SIGHUP) == 0, "Could not PR_SET_PDEATHSIG");
  47 #endif
  48
  49   // Remove CLOEXEC to pass the socket to the application
  50   int fdflags = fcntl(socket, F_GETFD, 0);
  51   xbt_assert(fdflags != -1 && fcntl(socket, F_SETFD, fdflags & ~FD_CLOEXEC) != -1,
  52              "Could not remove CLOEXEC for socket");
  53
  54   // Disable lazy relocation in the model-checked process to prevent the application from
  55   // modifying its .got.plt during snapshot.
  56   setenv("LC_BIND_NOW", "1", 1);
  57
  58   setenv(MC_ENV_SOCKET_FD, std::to_string(socket).c_str(), 1);
  59
  60   code();
  61 }
  62
  63 Session::Session(const std::function<void()>& code)
  64 {
  65 #if HAVE_SMPI
  66   smpi_init_options();//only performed once
  67   xbt_assert(smpi_cfg_privatization() != SmpiPrivStrategies::MMAP,
  68              "Please use the dlopen privatization schema when model-checking SMPI code");
  69 #endif
  70
  71   // Create an AF_LOCAL socketpair used for exchanging messages
  72   // between the model-checker process (ourselves) and the model-checked
  73   // process:
  74   int sockets[2];
  75   xbt_assert(socketpair(AF_LOCAL, SOCK_SEQPACKET | SOCK_CLOEXEC, 0, sockets) != -1, "Could not create socketpair");
  76
  77   pid_t pid = fork();
  78   xbt_assert(pid >= 0, "Could not fork model-checked process");
  79
  80   if (pid == 0) { // Child
  81     ::close(sockets[1]);
  82     run_child_process(sockets[0], code);
  83     DIE_IMPOSSIBLE;
  84   }
  85
  86   // Parent (model-checker):
  87   ::close(sockets[0]);
  88
  89   xbt_assert(mc_model_checker == nullptr, "Did you manage to start the MC twice in this process?");
  90
  91   auto process   = std::make_unique<simgrid::mc::RemoteProcess>(pid);
  92   model_checker_ = std::make_unique<simgrid::mc::ModelChecker>(std::move(process), sockets[1]);
  93
  94   mc_model_checker = model_checker_.get();
  95   model_checker_->start();
  96 }
  97
  98 Session::~Session()
  99 {
 100   this->close();
 101 }
 102
 103 /** The application must be stopped. */
 104 void Session::take_initial_snapshot()
 105 {
 106   xbt_assert(initial_snapshot_ == nullptr);
 107   model_checker_->wait_for_requests();
 108   initial_snapshot_ = std::make_shared<simgrid::mc::Snapshot>(0);
 109 }
 110
 111 void Session::restore_initial_state() const
 112 {
 113   this->initial_snapshot_->restore(&model_checker_->get_remote_process());
 114 }
 115
 116 void Session::log_state() const
 117 {
 118   model_checker_->get_exploration()->log_state();
 119
 120   if (not _sg_mc_dot_output_file.get().empty()) {
 121     fprintf(dot_output, "}\n");
 122     fclose(dot_output);
 123   }
 124   if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
 125     int ret=system("free");
 126     if (ret != 0)
 127       XBT_WARN("Call to system(free) did not return 0, but %d", ret);
 128   }
 129 }
 130
 131 void Session::close()
 132 {
 133   initial_snapshot_ = nullptr;
 134   if (model_checker_) {
 135     model_checker_->shutdown();
 136     model_checker_   = nullptr;
 137     mc_model_checker = nullptr;
 138   }
 139 }
 140
 141 bool Session::actor_is_enabled(aid_t pid) const
 142 {
 143   s_mc_message_actor_enabled_t msg;
 144   memset(&msg, 0, sizeof msg);
 145   msg.type = simgrid::mc::MessageType::ACTOR_ENABLED;
 146   msg.aid  = pid;
 147   model_checker_->channel().send(msg);
 148   std::array<char, MC_MESSAGE_LENGTH> buff;
 149   ssize_t received = model_checker_->channel().receive(buff.data(), buff.size(), true);
 150   xbt_assert(received == sizeof(s_mc_message_int_t), "Unexpected size in answer to ACTOR_ENABLED");
 151   return ((s_mc_message_int_t*)buff.data())->value;
 152 }
 153
 154 void Session::check_deadlock() const
 155 {
 156   xbt_assert(model_checker_->channel().send(MessageType::DEADLOCK_CHECK) == 0, "Could not check deadlock state");
 157   s_mc_message_int_t message;
 158   ssize_t s = model_checker_->channel().receive(message);
 159   xbt_assert(s != -1, "Could not receive message");
 160   xbt_assert(s == sizeof(message) && message.type == MessageType::DEADLOCK_CHECK_REPLY,
 161              "Received unexpected message %s (%i, size=%i) "
 162              "expected MessageType::DEADLOCK_CHECK_REPLY (%i, size=%i)",
 163              to_c_str(message.type), (int)message.type, (int)s, (int)MessageType::DEADLOCK_CHECK_REPLY,
 164              (int)sizeof(message));
 165
 166   if (message.value != 0) {
 167     XBT_CINFO(mc_global, "**************************");
 168     XBT_CINFO(mc_global, "*** DEADLOCK DETECTED ***");
 169     XBT_CINFO(mc_global, "**************************");
 170     XBT_CINFO(mc_global, "Counter-example execution trace:");
 171     for (auto const& frame : model_checker_->get_exploration()->get_textual_trace())
 172       XBT_CINFO(mc_global, "  %s", frame.c_str());
 173     XBT_CINFO(mc_global, "Path = %s", model_checker_->get_exploration()->get_record_trace().to_string().c_str());
 174     log_state();
 175     throw DeadlockError();
 176   }
 177 }
 178 } // namespace simgrid::mc