src/mc/api/RemoteApp.cpp

   1 /* Copyright (c) 2015-2023. 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/api/RemoteApp.hpp"
   7 #include "src/mc/explo/Exploration.hpp"
   8 #include "src/mc/mc_config.hpp"
   9 #include "xbt/asserts.h"
  10 #include "src/mc/api/State.hpp"
  11 #include "src/mc/mc_config.hpp"
  12 #include "src/mc/mc_exit.hpp"
  13 #include "src/mc/mc_private.hpp"
  14 #include "xbt/log.h"
  15 #include "xbt/system_error.hpp"
  16 #include <signal.h>
  17
  18 #include <algorithm>
  19 #include <array>
  20 #include <boost/tokenizer.hpp>
  21 #include <memory>
  22 #include <numeric>
  23 #include <string>
  24
  25 #include <fcntl.h>
  26 #ifdef __linux__
  27 #include <sys/prctl.h>
  28 #endif
  29 #include <sys/ptrace.h>
  30 #include <sys/wait.h>
  31
  32 #ifdef __linux__
  33 #define WAITPID_CHECKED_FLAGS __WALL
  34 #else
  35 #define WAITPID_CHECKED_FLAGS 0
  36 #endif
  37
  38 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_Session, mc, "Model-checker session");
  39 XBT_LOG_EXTERNAL_CATEGORY(mc_global);
  40
  41 static simgrid::config::Flag<std::string> _sg_mc_setenv{
  42     "model-check/setenv", "Extra environment variables to pass to the child process (ex: 'AZE=aze;QWE=qwe').", "",
  43     [](std::string_view value) {
  44       xbt_assert(value.empty() || value.find('=', 0) != std::string_view::npos,
  45                  "The 'model-check/setenv' parameter must be like 'AZE=aze', but it does not contain an equal sign.");
  46     }};
  47
  48 namespace simgrid::mc {
  49
  50 XBT_ATTRIB_NORETURN static void run_child_process(int socket, const std::vector<char*>& args)
  51 {
  52   /* On startup, simix_global_init() calls simgrid::mc::Client::initialize(), which checks whether the MC_ENV_SOCKET_FD
  53    * env variable is set. If so, MC mode is assumed, and the client is setup from its side
  54    */
  55
  56 #ifdef __linux__
  57   // Make sure we do not outlive our parent
  58   sigset_t mask;
  59   sigemptyset(&mask);
  60   xbt_assert(sigprocmask(SIG_SETMASK, &mask, nullptr) >= 0, "Could not unblock signals");
  61   xbt_assert(prctl(PR_SET_PDEATHSIG, SIGHUP) == 0, "Could not PR_SET_PDEATHSIG");
  62 #endif
  63
  64   // Remove CLOEXEC to pass the socket to the application
  65   int fdflags = fcntl(socket, F_GETFD, 0);
  66   xbt_assert(fdflags != -1 && fcntl(socket, F_SETFD, fdflags & ~FD_CLOEXEC) != -1,
  67              "Could not remove CLOEXEC for socket");
  68
  69   setenv(MC_ENV_SOCKET_FD, std::to_string(socket).c_str(), 1);
  70
  71   /* Setup the tokenizer that parses the cfg:model-check/setenv parameter */
  72   using Tokenizer = boost::tokenizer<boost::char_separator<char>>;
  73   boost::char_separator<char> semicol_sep(";");
  74   boost::char_separator<char> equal_sep("=");
  75   Tokenizer token_vars(_sg_mc_setenv.get(), semicol_sep); /* Iterate over all FOO=foo parts */
  76   for (const auto& token : token_vars) {
  77     std::vector<std::string> kv;
  78     Tokenizer token_kv(token, equal_sep);
  79     for (const auto& t : token_kv) /* Iterate over 'FOO' and then 'foo' in that 'FOO=foo' */
  80       kv.push_back(t);
  81     xbt_assert(kv.size() == 2, "Parse error on 'model-check/setenv' value %s. Does it contain an equal sign?",
  82                token.c_str());
  83     XBT_INFO("setenv '%s'='%s'", kv[0].c_str(), kv[1].c_str());
  84     setenv(kv[0].c_str(), kv[1].c_str(), 1);
  85   }
  86
  87   /* And now, exec the child process */
  88   int i = 1;
  89   while (args[i] != nullptr && args[i][0] == '-')
  90     i++;
  91
  92   xbt_assert(args[i] != nullptr,
  93              "Unable to find a binary to exec on the command line. Did you only pass config flags?");
  94
  95   execvp(args[i], args.data() + i);
  96   XBT_CRITICAL("The model-checked process failed to exec(%s): %s.\n"
  97                "        Make sure that your binary exists on disk and is executable.",
  98                args[i], strerror(errno));
  99   if (strchr(args[i], '=') != nullptr)
 100     XBT_CRITICAL("If you want to pass environment variables to the application, please use --cfg=model-check/setenv:%s",
 101                  args[i]);
 102
 103   xbt_die("Aborting now.");
 104 }
 105
 106 RemoteApp::RemoteApp(const std::vector<char*>& args)
 107 {
 108   // Create an AF_LOCAL socketpair used for exchanging messages
 109   // between the model-checker process (ourselves) and the model-checked
 110   // process:
 111   int sockets[2];
 112   xbt_assert(socketpair(AF_LOCAL, SOCK_SEQPACKET | SOCK_CLOEXEC, 0, sockets) != -1, "Could not create socketpair");
 113
 114   pid_t pid = fork();
 115   xbt_assert(pid >= 0, "Could not fork model-checked process");
 116
 117   if (pid == 0) { // Child
 118     ::close(sockets[1]);
 119     run_child_process(sockets[0], args);
 120     DIE_IMPOSSIBLE;
 121   }
 122
 123   // Parent (model-checker):
 124   ::close(sockets[0]);
 125
 126   auto memory      = std::make_unique<simgrid::mc::RemoteProcessMemory>(pid);
 127   checker_side_    = std::make_unique<simgrid::mc::CheckerSide>(sockets[1], std::move(memory));
 128
 129   start();
 130
 131   /* Take the initial snapshot */
 132   wait_for_requests();
 133   initial_snapshot_ = std::make_shared<simgrid::mc::Snapshot>(0, page_store_, checker_side_->get_remote_memory());
 134 }
 135
 136 RemoteApp::~RemoteApp()
 137 {
 138   initial_snapshot_ = nullptr;
 139   shutdown();
 140 }
 141 void RemoteApp::start()
 142 {
 143   XBT_DEBUG("Waiting for the model-checked process");
 144   int status;
 145
 146   // The model-checked process SIGSTOP itself to signal it's ready:
 147   const pid_t pid = get_remote_process_memory().pid();
 148
 149   xbt_assert(waitpid(pid, &status, WAITPID_CHECKED_FLAGS) == pid && WIFSTOPPED(status) && WSTOPSIG(status) == SIGSTOP,
 150              "Could not wait model-checked process");
 151
 152   errno = 0;
 153 #ifdef __linux__
 154   ptrace(PTRACE_SETOPTIONS, pid, nullptr, PTRACE_O_TRACEEXIT);
 155   ptrace(PTRACE_CONT, pid, 0, 0);
 156 #elif defined BSD
 157   ptrace(PT_CONTINUE, pid, (caddr_t)1, 0);
 158 #else
 159 #error "no ptrace equivalent coded for this platform"
 160 #endif
 161   xbt_assert(errno == 0,
 162              "Ptrace does not seem to be usable in your setup (errno: %d). "
 163              "If you run from within a docker, adding `--cap-add SYS_PTRACE` to the docker line may help. "
 164              "If it does not help, please report this bug.",
 165              errno);
 166 }
 167 void RemoteApp::restore_initial_state() const
 168 {
 169   this->initial_snapshot_->restore(checker_side_->get_remote_memory());
 170 }
 171
 172 unsigned long RemoteApp::get_maxpid() const
 173 {
 174   // note: we could maybe cache it and count the actor creation on checker side too.
 175   // But counting correctly accross state checkpoint/restore would be annoying.
 176
 177   checker_side_->get_channel().send(MessageType::ACTORS_MAXPID);
 178   s_mc_message_int_t answer;
 179   ssize_t answer_size = checker_side_->get_channel().receive(answer);
 180   xbt_assert(answer_size != -1, "Could not receive message");
 181   xbt_assert(answer_size == sizeof answer, "Broken message (size=%zd; expected %zu)", answer_size, sizeof answer);
 182   xbt_assert(answer.type == MessageType::ACTORS_MAXPID_REPLY,
 183              "Received unexpected message %s (%i); expected MessageType::ACTORS_MAXPID_REPLY (%i)",
 184              to_c_str(answer.type), (int)answer.type, (int)MessageType::ACTORS_MAXPID_REPLY);
 185
 186   return answer.value;
 187 }
 188
 189 void RemoteApp::get_actors_status(std::map<aid_t, ActorState>& whereto) const
 190 {
 191   // The messaging happens as follows:
 192   //
 193   // CheckerSide                  AppSide
 194   // send ACTORS_STATUS ---->
 195   //                    <----- send ACTORS_STATUS_REPLY
 196   //                    <----- send `N` `s_mc_message_actors_status_one_t` structs
 197   //                    <----- send `M` `s_mc_message_simcall_probe_one_t` structs
 198   checker_side_->get_channel().send(MessageType::ACTORS_STATUS);
 199
 200   s_mc_message_actors_status_answer_t answer;
 201   ssize_t answer_size = checker_side_->get_channel().receive(answer);
 202   xbt_assert(answer_size != -1, "Could not receive message");
 203   xbt_assert(answer_size == sizeof answer, "Broken message (size=%zd; expected %zu)", answer_size, sizeof answer);
 204   xbt_assert(answer.type == MessageType::ACTORS_STATUS_REPLY,
 205              "Received unexpected message %s (%i); expected MessageType::ACTORS_STATUS_REPLY (%i)",
 206              to_c_str(answer.type), (int)answer.type, (int)MessageType::ACTORS_STATUS_REPLY);
 207
 208   // Message sanity checks
 209   xbt_assert(answer.count >= 0, "Received an ACTOR_STATUS_REPLY message with an actor count of '%d' < 0", answer.count);
 210   xbt_assert(answer.transition_count >= 0, "Received an ACTOR_STATUS_REPLY message with transition_count '%d' < 0",
 211              answer.transition_count);
 212   xbt_assert(answer.transition_count == 0 || answer.count >= 0,
 213              "Received an ACTOR_STATUS_REPLY message with no actor data "
 214              "but with transition data nonetheless");
 215
 216   std::vector<s_mc_message_actors_status_one_t> status(answer.count);
 217   if (answer.count > 0) {
 218     size_t size      = status.size() * sizeof(s_mc_message_actors_status_one_t);
 219     ssize_t received = checker_side_->get_channel().receive(status.data(), size);
 220     xbt_assert(static_cast<size_t>(received) == size);
 221   }
 222
 223   // Ensures that each actor sends precisely `answer.transition_count` transitions. While technically
 224   // this doesn't catch the edge case where actor A sends 3 instead of 2 and actor B sends 2 instead
 225   // of 3 transitions, that is ignored here since that invariant needs to be enforced on the AppSide
 226   const auto expected_transitions = std::accumulate(
 227       status.begin(), status.end(), 0, [](int total, const auto& actor) { return total + actor.n_transitions; });
 228   xbt_assert(expected_transitions == answer.transition_count,
 229              "Expected to receive %d transition(s) but was only notified of %d by the app side", expected_transitions,
 230              answer.transition_count);
 231
 232   std::vector<s_mc_message_simcall_probe_one_t> probes(answer.transition_count);
 233   if (answer.transition_count > 0) {
 234     for (auto& probe : probes) {
 235       ssize_t received = checker_side_->get_channel().receive(probe);
 236       xbt_assert(received >= 0, "Could not receive response to ACTORS_PROBE message (%s)", strerror(errno));
 237       xbt_assert(static_cast<size_t>(received) == sizeof probe,
 238                  "Could not receive response to ACTORS_PROBE message (%zd bytes received != %zu bytes expected",
 239                  received, sizeof probe);
 240     }
 241   }
 242
 243   whereto.clear();
 244   std::move_iterator probes_iter(probes.begin());
 245
 246   for (const auto& actor : status) {
 247     xbt_assert(actor.n_transitions == 0 || actor.n_transitions == actor.max_considered,
 248                "If any transitions are serialized for an actor, it must match the "
 249                "total number of transitions that can be considered for the actor "
 250                "(currently %d), but only %d transition(s) was/were said to be encoded",
 251                actor.max_considered, actor.n_transitions);
 252
 253     std::vector<std::shared_ptr<Transition>> actor_transitions;
 254     for (int times_considered = 0; times_considered < actor.n_transitions; times_considered++, probes_iter++) {
 255       std::stringstream stream((*probes_iter).buffer.data());
 256       actor_transitions.emplace_back(deserialize_transition(actor.aid, times_considered, stream));
 257     }
 258
 259     XBT_DEBUG("Received %zu transitions for actor %ld", actor_transitions.size(), actor.aid);
 260     whereto.try_emplace(actor.aid, actor.aid, actor.enabled, actor.max_considered, std::move(actor_transitions));
 261   }
 262 }
 263
 264 void RemoteApp::check_deadlock() const
 265 {
 266   xbt_assert(checker_side_->get_channel().send(MessageType::DEADLOCK_CHECK) == 0, "Could not check deadlock state");
 267   s_mc_message_int_t message;
 268   ssize_t received = checker_side_->get_channel().receive(message);
 269   xbt_assert(received != -1, "Could not receive message");
 270   xbt_assert(received == sizeof message, "Broken message (size=%zd; expected %zu)", received, sizeof message);
 271   xbt_assert(message.type == MessageType::DEADLOCK_CHECK_REPLY,
 272              "Received unexpected message %s (%i); expected MessageType::DEADLOCK_CHECK_REPLY (%i)",
 273              to_c_str(message.type), (int)message.type, (int)MessageType::DEADLOCK_CHECK_REPLY);
 274
 275   if (message.value != 0) {
 276     auto* explo = Exploration::get_instance();
 277     XBT_CINFO(mc_global, "Counter-example execution trace:");
 278     for (auto const& frame : explo->get_textual_trace())
 279       XBT_CINFO(mc_global, "  %s", frame.c_str());
 280     XBT_INFO("You can debug the problem (and see the whole details) by rerunning out of simgrid-mc with "
 281              "--cfg=model-check/replay:'%s'",
 282              explo->get_record_trace().to_string().c_str());
 283     explo->log_state();
 284     throw DeadlockError();
 285   }
 286 }
 287
 288 void RemoteApp::wait_for_requests()
 289 {
 290   /* Resume the application */
 291   if (checker_side_->get_channel().send(MessageType::CONTINUE) != 0)
 292     throw xbt::errno_error();
 293   get_remote_process_memory().clear_cache();
 294
 295   if (this->get_remote_process_memory().running())
 296     checker_side_->dispatch_events();
 297 }
 298
 299 void RemoteApp::shutdown()
 300 {
 301   XBT_DEBUG("Shutting down model-checker");
 302
 303   RemoteProcessMemory& process = get_remote_process_memory();
 304   if (process.running()) {
 305     XBT_DEBUG("Killing process");
 306     finalize_app(true);
 307     kill(process.pid(), SIGKILL);
 308     process.terminate();
 309   }
 310 }
 311
 312 Transition* RemoteApp::handle_simcall(aid_t aid, int times_considered, bool new_transition)
 313 {
 314   s_mc_message_simcall_execute_t m = {};
 315   m.type                           = MessageType::SIMCALL_EXECUTE;
 316   m.aid_                           = aid;
 317   m.times_considered_              = times_considered;
 318   checker_side_->get_channel().send(m);
 319
 320   get_remote_process_memory().clear_cache();
 321   if (this->get_remote_process_memory().running())
 322     checker_side_->dispatch_events(); // The app may send messages while processing the transition
 323
 324   s_mc_message_simcall_execute_answer_t answer;
 325   ssize_t s = checker_side_->get_channel().receive(answer);
 326   xbt_assert(s != -1, "Could not receive message");
 327   xbt_assert(s == sizeof answer, "Broken message (size=%zd; expected %zu)", s, sizeof answer);
 328   xbt_assert(answer.type == MessageType::SIMCALL_EXECUTE_ANSWER,
 329              "Received unexpected message %s (%i); expected MessageType::SIMCALL_EXECUTE_ANSWER (%i)",
 330              to_c_str(answer.type), (int)answer.type, (int)MessageType::SIMCALL_EXECUTE_ANSWER);
 331
 332   if (new_transition) {
 333     std::stringstream stream(answer.buffer.data());
 334     return deserialize_transition(aid, times_considered, stream);
 335   } else
 336     return nullptr;
 337 }
 338
 339 void RemoteApp::finalize_app(bool terminate_asap)
 340 {
 341   s_mc_message_int_t m = {};
 342   m.type               = MessageType::FINALIZE;
 343   m.value              = terminate_asap;
 344   xbt_assert(checker_side_->get_channel().send(m) == 0, "Could not ask the app to finalize on need");
 345
 346   s_mc_message_t answer;
 347   ssize_t s = checker_side_->get_channel().receive(answer);
 348   xbt_assert(s != -1, "Could not receive answer to FINALIZE");
 349   xbt_assert(s == sizeof answer, "Broken message (size=%zd; expected %zu)", s, sizeof answer);
 350   xbt_assert(answer.type == MessageType::FINALIZE_REPLY,
 351              "Received unexpected message %s (%i); expected MessageType::FINALIZE_REPLY (%i)", to_c_str(answer.type),
 352              (int)answer.type, (int)MessageType::FINALIZE_REPLY);
 353 }
 354
 355 } // namespace simgrid::mc