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   xbt_assert(mc_model_checker == nullptr, "Did you manage to start the MC twice in this process?");
 127
 128   auto memory      = std::make_unique<simgrid::mc::RemoteProcessMemory>(pid);
 129   model_checker_   = std::make_unique<simgrid::mc::ModelChecker>(std::move(memory));
 130   mc_model_checker = model_checker_.get();
 131   checker_side_    = std::make_unique<simgrid::mc::CheckerSide>(sockets[1], model_checker_.get());
 132
 133   start();
 134
 135   /* Take the initial snapshot */
 136   wait_for_requests();
 137   initial_snapshot_ =
 138       std::make_shared<simgrid::mc::Snapshot>(0, page_store_, model_checker_->get_remote_process_memory());
 139 }
 140
 141 RemoteApp::~RemoteApp()
 142 {
 143   initial_snapshot_ = nullptr;
 144   if (model_checker_) {
 145     shutdown();
 146     model_checker_   = nullptr;
 147     mc_model_checker = nullptr;
 148   }
 149 }
 150 void RemoteApp::start()
 151 {
 152   XBT_DEBUG("Waiting for the model-checked process");
 153   int status;
 154
 155   // The model-checked process SIGSTOP itself to signal it's ready:
 156   const pid_t pid = get_remote_process_memory().pid();
 157
 158   xbt_assert(waitpid(pid, &status, WAITPID_CHECKED_FLAGS) == pid && WIFSTOPPED(status) && WSTOPSIG(status) == SIGSTOP,
 159              "Could not wait model-checked process");
 160
 161   errno = 0;
 162 #ifdef __linux__
 163   ptrace(PTRACE_SETOPTIONS, pid, nullptr, PTRACE_O_TRACEEXIT);
 164   ptrace(PTRACE_CONT, pid, 0, 0);
 165 #elif defined BSD
 166   ptrace(PT_CONTINUE, pid, (caddr_t)1, 0);
 167 #else
 168 #error "no ptrace equivalent coded for this platform"
 169 #endif
 170   xbt_assert(errno == 0,
 171              "Ptrace does not seem to be usable in your setup (errno: %d). "
 172              "If you run from within a docker, adding `--cap-add SYS_PTRACE` to the docker line may help. "
 173              "If it does not help, please report this bug.",
 174              errno);
 175 }
 176 void RemoteApp::restore_initial_state() const
 177 {
 178   this->initial_snapshot_->restore(model_checker_->get_remote_process_memory());
 179 }
 180
 181 unsigned long RemoteApp::get_maxpid() const
 182 {
 183   // note: we could maybe cache it and count the actor creation on checker side too.
 184   // But counting correctly accross state checkpoint/restore would be annoying.
 185
 186   checker_side_->get_channel().send(MessageType::ACTORS_MAXPID);
 187   s_mc_message_int_t answer;
 188   ssize_t answer_size = checker_side_->get_channel().receive(answer);
 189   xbt_assert(answer_size != -1, "Could not receive message");
 190   xbt_assert(answer_size == sizeof answer, "Broken message (size=%zd; expected %zu)", answer_size, sizeof answer);
 191   xbt_assert(answer.type == MessageType::ACTORS_MAXPID_REPLY,
 192              "Received unexpected message %s (%i); expected MessageType::ACTORS_MAXPID_REPLY (%i)",
 193              to_c_str(answer.type), (int)answer.type, (int)MessageType::ACTORS_MAXPID_REPLY);
 194
 195   return answer.value;
 196 }
 197
 198 void RemoteApp::get_actors_status(std::map<aid_t, ActorState>& whereto) const
 199 {
 200   // The messaging happens as follows:
 201   //
 202   // CheckerSide                  AppSide
 203   // send ACTORS_STATUS ---->
 204   //                    <----- send ACTORS_STATUS_REPLY
 205   //                    <----- send `N` `s_mc_message_actors_status_one_t` structs
 206   //                    <----- send `M` `s_mc_message_simcall_probe_one_t` structs
 207   checker_side_->get_channel().send(MessageType::ACTORS_STATUS);
 208
 209   s_mc_message_actors_status_answer_t answer;
 210   ssize_t answer_size = checker_side_->get_channel().receive(answer);
 211   xbt_assert(answer_size != -1, "Could not receive message");
 212   xbt_assert(answer_size == sizeof answer, "Broken message (size=%zd; expected %zu)", answer_size, sizeof answer);
 213   xbt_assert(answer.type == MessageType::ACTORS_STATUS_REPLY,
 214              "Received unexpected message %s (%i); expected MessageType::ACTORS_STATUS_REPLY (%i)",
 215              to_c_str(answer.type), (int)answer.type, (int)MessageType::ACTORS_STATUS_REPLY);
 216
 217   // Message sanity checks
 218   xbt_assert(answer.count >= 0, "Received an ACTOR_STATUS_REPLY message with an actor count of '%d' < 0", answer.count);
 219   xbt_assert(answer.transition_count >= 0, "Received an ACTOR_STATUS_REPLY message with transition_count '%d' < 0",
 220              answer.transition_count);
 221   xbt_assert(answer.transition_count == 0 || answer.count >= 0,
 222              "Received an ACTOR_STATUS_REPLY message with no actor data "
 223              "but with transition data nonetheless");
 224
 225   std::vector<s_mc_message_actors_status_one_t> status(answer.count);
 226   if (answer.count > 0) {
 227     size_t size      = status.size() * sizeof(s_mc_message_actors_status_one_t);
 228     ssize_t received = checker_side_->get_channel().receive(status.data(), size);
 229     xbt_assert(static_cast<size_t>(received) == size);
 230   }
 231
 232   // Ensures that each actor sends precisely `answer.transition_count` transitions. While technically
 233   // this doesn't catch the edge case where actor A sends 3 instead of 2 and actor B sends 2 instead
 234   // of 3 transitions, that is ignored here since that invariant needs to be enforced on the AppSide
 235   const auto expected_transitions = std::accumulate(
 236       status.begin(), status.end(), 0, [](int total, const auto& actor) { return total + actor.n_transitions; });
 237   xbt_assert(expected_transitions == answer.transition_count,
 238              "Expected to receive %d transition(s) but was only notified of %d by the app side", expected_transitions,
 239              answer.transition_count);
 240
 241   std::vector<s_mc_message_simcall_probe_one_t> probes(answer.transition_count);
 242   if (answer.transition_count > 0) {
 243     for (auto& probe : probes) {
 244       ssize_t received = checker_side_->get_channel().receive(probe);
 245       xbt_assert(received >= 0, "Could not receive response to ACTORS_PROBE message (%s)", strerror(errno));
 246       xbt_assert(static_cast<size_t>(received) == sizeof probe,
 247                  "Could not receive response to ACTORS_PROBE message (%zd bytes received != %zu bytes expected",
 248                  received, sizeof probe);
 249     }
 250   }
 251
 252   whereto.clear();
 253   std::move_iterator probes_iter(probes.begin());
 254
 255   for (const auto& actor : status) {
 256     xbt_assert(actor.n_transitions == 0 || actor.n_transitions == actor.max_considered,
 257                "If any transitions are serialized for an actor, it must match the "
 258                "total number of transitions that can be considered for the actor "
 259                "(currently %d), but only %d transition(s) was/were said to be encoded",
 260                actor.max_considered, actor.n_transitions);
 261
 262     std::vector<std::shared_ptr<Transition>> actor_transitions;
 263     for (int times_considered = 0; times_considered < actor.n_transitions; times_considered++, probes_iter++) {
 264       std::stringstream stream((*probes_iter).buffer.data());
 265       actor_transitions.emplace_back(deserialize_transition(actor.aid, times_considered, stream));
 266     }
 267
 268     XBT_DEBUG("Received %zu transitions for actor %ld", actor_transitions.size(), actor.aid);
 269     whereto.try_emplace(actor.aid, actor.aid, actor.enabled, actor.max_considered, std::move(actor_transitions));
 270   }
 271 }
 272
 273 void RemoteApp::check_deadlock() const
 274 {
 275   xbt_assert(checker_side_->get_channel().send(MessageType::DEADLOCK_CHECK) == 0, "Could not check deadlock state");
 276   s_mc_message_int_t message;
 277   ssize_t received = checker_side_->get_channel().receive(message);
 278   xbt_assert(received != -1, "Could not receive message");
 279   xbt_assert(received == sizeof message, "Broken message (size=%zd; expected %zu)", received, sizeof message);
 280   xbt_assert(message.type == MessageType::DEADLOCK_CHECK_REPLY,
 281              "Received unexpected message %s (%i); expected MessageType::DEADLOCK_CHECK_REPLY (%i)",
 282              to_c_str(message.type), (int)message.type, (int)MessageType::DEADLOCK_CHECK_REPLY);
 283
 284   if (message.value != 0) {
 285     XBT_CINFO(mc_global, "Counter-example execution trace:");
 286     for (auto const& frame : model_checker_->get_exploration()->get_textual_trace())
 287       XBT_CINFO(mc_global, "  %s", frame.c_str());
 288     XBT_INFO("You can debug the problem (and see the whole details) by rerunning out of simgrid-mc with "
 289              "--cfg=model-check/replay:'%s'",
 290              model_checker_->get_exploration()->get_record_trace().to_string().c_str());
 291     model_checker_->get_exploration()->log_state();
 292     throw DeadlockError();
 293   }
 294 }
 295
 296 void RemoteApp::wait_for_requests()
 297 {
 298   /* Resume the application */
 299   if (checker_side_->get_channel().send(MessageType::CONTINUE) != 0)
 300     throw xbt::errno_error();
 301   get_remote_process_memory().clear_cache();
 302
 303   if (this->get_remote_process_memory().running())
 304     checker_side_->dispatch_events();
 305 }
 306
 307 void RemoteApp::shutdown()
 308 {
 309   XBT_DEBUG("Shutting down model-checker");
 310
 311   RemoteProcessMemory& process = get_remote_process_memory();
 312   if (process.running()) {
 313     XBT_DEBUG("Killing process");
 314     finalize_app(true);
 315     kill(process.pid(), SIGKILL);
 316     process.terminate();
 317   }
 318 }
 319
 320 Transition* RemoteApp::handle_simcall(aid_t aid, int times_considered, bool new_transition)
 321 {
 322   s_mc_message_simcall_execute_t m = {};
 323   m.type                           = MessageType::SIMCALL_EXECUTE;
 324   m.aid_                           = aid;
 325   m.times_considered_              = times_considered;
 326   checker_side_->get_channel().send(m);
 327
 328   get_remote_process_memory().clear_cache();
 329   if (this->get_remote_process_memory().running())
 330     checker_side_->dispatch_events(); // The app may send messages while processing the transition
 331
 332   s_mc_message_simcall_execute_answer_t answer;
 333   ssize_t s = checker_side_->get_channel().receive(answer);
 334   xbt_assert(s != -1, "Could not receive message");
 335   xbt_assert(s == sizeof answer, "Broken message (size=%zd; expected %zu)", s, sizeof answer);
 336   xbt_assert(answer.type == MessageType::SIMCALL_EXECUTE_ANSWER,
 337              "Received unexpected message %s (%i); expected MessageType::SIMCALL_EXECUTE_ANSWER (%i)",
 338              to_c_str(answer.type), (int)answer.type, (int)MessageType::SIMCALL_EXECUTE_ANSWER);
 339
 340   if (new_transition) {
 341     std::stringstream stream(answer.buffer.data());
 342     return deserialize_transition(aid, times_considered, stream);
 343   } else
 344     return nullptr;
 345 }
 346
 347 void RemoteApp::finalize_app(bool terminate_asap)
 348 {
 349   s_mc_message_int_t m = {};
 350   m.type               = MessageType::FINALIZE;
 351   m.value              = terminate_asap;
 352   xbt_assert(checker_side_->get_channel().send(m) == 0, "Could not ask the app to finalize on need");
 353
 354   s_mc_message_t answer;
 355   ssize_t s = checker_side_->get_channel().receive(answer);
 356   xbt_assert(s != -1, "Could not receive answer to FINALIZE");
 357   xbt_assert(s == sizeof answer, "Broken message (size=%zd; expected %zu)", s, sizeof answer);
 358   xbt_assert(answer.type == MessageType::FINALIZE_REPLY,
 359              "Received unexpected message %s (%i); expected MessageType::FINALIZE_REPLY (%i)", to_c_str(answer.type),
 360              (int)answer.type, (int)MessageType::FINALIZE_REPLY);
 361 }
 362
 363 } // namespace simgrid::mc