src/mc/simgrid_mc.cpp

   1 /* Copyright (c) 2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <exception>
   8
   9 #include <cstdlib>
  10 #include <cstdio>
  11 #include <cstring>
  12
  13 #include <utility>
  14
  15 #include <signal.h>
  16 #include <poll.h>
  17
  18 #include <unistd.h>
  19
  20 #include <sys/types.h>
  21 #include <sys/socket.h>
  22 #include <sys/wait.h>
  23 #include <sys/ptrace.h>
  24
  25 #ifdef __linux__
  26 #include <sys/prctl.h>
  27 #endif
  28
  29 #include <xbt/log.h>
  30 #include <xbt/sysdep.h>
  31 #include <xbt/system_error.hpp>
  32
  33 #include "simgrid/sg_config.h"
  34 #include "src/xbt_modinter.h"
  35
  36 #include "src/mc/mc_base.h"
  37 #include "src/mc/mc_private.h"
  38 #include "src/mc/mc_protocol.h"
  39 #include "src/mc/mc_safety.h"
  40 #include "src/mc/mc_comm_pattern.h"
  41 #include "src/mc/mc_liveness.h"
  42 #include "src/mc/mc_exit.h"
  43
  44 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_main, mc, "Entry point for simgrid-mc");
  45
  46 /** Execute some code in a forked process */
  47 template<class F>
  48 static inline
  49 pid_t do_fork(F f)
  50 {
  51   pid_t pid = fork();
  52   if (pid < 0)
  53     throw simgrid::xbt::errno_error(errno, "Could not fork model-checked process");
  54   if (pid != 0)
  55     return pid;
  56
  57   // Child-process:
  58   try {
  59     f();
  60     std::exit(EXIT_SUCCESS);
  61   }
  62   catch(...) {
  63     // The callback should catch exceptions:
  64     abort();
  65   }
  66 }
  67
  68 static
  69 int exec_model_checked(int socket, char** argv)
  70 {
  71   XBT_DEBUG("Inside the child process PID=%i", (int) getpid());
  72
  73 #ifdef __linux__
  74   // Make sure we do not outlive our parent:
  75   sigset_t mask;
  76   sigemptyset (&mask);
  77   if (sigprocmask(SIG_SETMASK, &mask, nullptr) < 0)
  78     throw simgrid::xbt::errno_error(errno, "Could not unblock signals");
  79   if (prctl(PR_SET_PDEATHSIG, SIGHUP) != 0)
  80     throw simgrid::xbt::errno_error(errno, "Could not PR_SET_PDEATHSIG");
  81 #endif
  82
  83   int res;
  84
  85   // Remove CLOEXEC in order to pass the socket to the exec-ed program:
  86   int fdflags = fcntl(socket, F_GETFD, 0);
  87   if (fdflags == -1 || fcntl(socket, F_SETFD, fdflags & ~FD_CLOEXEC) == -1)
  88     throw simgrid::xbt::errno_error(errno, "Could not remove CLOEXEC for socket");
  89
  90   // Set environment:
  91   setenv(MC_ENV_VARIABLE, "1", 1);
  92
  93   // Disable lazy relocation in the model-checked process.
  94   // We don't want the model-checked process to modify its .got.plt during
  95   // snapshot.
  96   setenv("LC_BIND_NOW", "1", 1);
  97
  98   char buffer[64];
  99   res = std::snprintf(buffer, sizeof(buffer), "%i", socket);
 100   if ((size_t) res >= sizeof(buffer) || res == -1)
 101     std::abort();
 102   setenv(MC_ENV_SOCKET_FD, buffer, 1);
 103
 104   execvp(argv[1], argv+1);
 105
 106   XBT_ERROR("Could not run the model-checked program");
 107   // This is the value used by system() and popen() in this case:
 108   return 127;
 109 }
 110
 111 static
 112 std::pair<pid_t, int> create_model_checked(char** argv)
 113 {
 114   // Create a AF_LOCAL socketpair used for exchanging messages
 115   // bewteen the model-checker process (ourselves) and the model-checked
 116   // process:
 117   int res;
 118   int sockets[2];
 119   res = socketpair(AF_LOCAL, SOCK_DGRAM | SOCK_CLOEXEC, 0, sockets);
 120   if (res == -1)
 121     throw simgrid::xbt::errno_error(errno, "Could not create socketpair");
 122
 123   pid_t pid = do_fork([&] {
 124     close(sockets[1]);
 125     int res = exec_model_checked(sockets[0], argv);
 126     XBT_DEBUG("Error in the child process creation");
 127     exit(res);
 128   });
 129
 130   // Parent (model-checker):
 131   close(sockets[0]);
 132   return std::make_pair(pid, sockets[1]);
 133 }
 134
 135 static
 136 char** argvdup(int argc, char** argv)
 137 {
 138   char** argv_copy = xbt_new(char*, argc+1);
 139   std::memcpy(argv_copy, argv, sizeof(char*) * argc);
 140   argv_copy[argc] = nullptr;
 141   return argv_copy;
 142 }
 143
 144 int main(int argc, char** argv)
 145 {
 146   try {
 147     if (argc < 2)
 148       xbt_die("Missing arguments.\n");
 149
 150     _sg_do_model_check = 1;
 151
 152     // The initialisation function can touch argv.
 153     // We need to keep the original parameters in order to pass them to the
 154     // model-checked process so we make a copy of them:
 155     int argc_copy = argc;
 156     char** argv_copy = argvdup(argc, argv);
 157     xbt_log_init(&argc_copy, argv_copy);
 158     sg_config_init(&argc_copy, argv_copy);
 159
 160     int sock;
 161     pid_t model_checked_pid;
 162     std::tie(model_checked_pid, sock) = create_model_checked(argv);
 163     XBT_DEBUG("Inside the parent process");
 164     if (mc_model_checker)
 165       xbt_die("MC server already present");
 166
 167     mc_mode = MC_MODE_SERVER;
 168     std::unique_ptr<simgrid::mc::Process> process(new simgrid::mc::Process(model_checked_pid, sock));
 169     process->privatized(sg_cfg_get_boolean("smpi/privatize_global_variables"));
 170     mc_model_checker = new simgrid::mc::ModelChecker(std::move(process));
 171     mc_model_checker->start();
 172     int res = 0;
 173     if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
 174       res = MC_modelcheck_comm_determinism();
 175     else if (!_sg_mc_property_file || _sg_mc_property_file[0] == '\0')
 176       res = MC_modelcheck_safety();
 177     else
 178       res = MC_modelcheck_liveness();
 179     mc_model_checker->shutdown();
 180     return res;
 181   }
 182   catch(std::exception& e) {
 183     XBT_ERROR("Exception: %s", e.what());
 184     return SIMGRID_MC_EXIT_ERROR;
 185   }
 186   catch(...) {
 187     XBT_ERROR("Unknown exception");
 188     return SIMGRID_MC_EXIT_ERROR;
 189   }
 190 }