src/mc/remote/CheckerSide.cpp

   1 /* Copyright (c) 2007-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/remote/CheckerSide.hpp"
   7 #include "src/mc/explo/Exploration.hpp"
   8 #include "xbt/config.hpp"
   9 #include "xbt/system_error.hpp"
  10
  11 #if SIMGRID_HAVE_STATEFUL_MC
  12 #include "src/mc/explo/LivenessChecker.hpp"
  13 #include "src/mc/sosp/RemoteProcessMemory.hpp"
  14 #endif
  15
  16 #ifdef __linux__
  17 #include <sys/prctl.h>
  18 #endif
  19
  20 #include <boost/tokenizer.hpp>
  21 #include <csignal>
  22 #include <fcntl.h>
  23 #include <sys/ptrace.h>
  24 #include <sys/wait.h>
  25
  26 #ifdef __linux__
  27 #define WAITPID_CHECKED_FLAGS __WALL
  28 #else
  29 #define WAITPID_CHECKED_FLAGS 0
  30 #endif
  31
  32 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkerside, mc, "MC communication with the application");
  33
  34 static simgrid::config::Flag<std::string> _sg_mc_setenv{
  35     "model-check/setenv", "Extra environment variables to pass to the child process (ex: 'AZE=aze;QWE=qwe').", "",
  36     [](std::string_view value) {
  37       xbt_assert(value.empty() || value.find('=', 0) != std::string_view::npos,
  38                  "The 'model-check/setenv' parameter must be like 'AZE=aze', but it does not contain an equal sign.");
  39     }};
  40
  41 namespace simgrid::mc {
  42
  43 XBT_ATTRIB_NORETURN static void run_child_process(int socket, const std::vector<char*>& args, bool need_ptrace)
  44 {
  45   /* On startup, simix_global_init() calls simgrid::mc::Client::initialize(), which checks whether the MC_ENV_SOCKET_FD
  46    * env variable is set. If so, MC mode is assumed, and the client is setup from its side
  47    */
  48
  49 #ifdef __linux__
  50   // Make sure we do not outlive our parent
  51   sigset_t mask;
  52   sigemptyset(&mask);
  53   xbt_assert(sigprocmask(SIG_SETMASK, &mask, nullptr) >= 0, "Could not unblock signals");
  54   xbt_assert(prctl(PR_SET_PDEATHSIG, SIGHUP) == 0, "Could not PR_SET_PDEATHSIG");
  55 #endif
  56
  57   setenv(MC_ENV_SOCKET_FD, std::to_string(socket).c_str(), 1);
  58   if (need_ptrace)
  59     setenv("MC_NEED_PTRACE", "1", 1);
  60
  61   /* Setup the tokenizer that parses the cfg:model-check/setenv parameter */
  62   using Tokenizer = boost::tokenizer<boost::char_separator<char>>;
  63   boost::char_separator<char> semicol_sep(";");
  64   boost::char_separator<char> equal_sep("=");
  65   Tokenizer token_vars(_sg_mc_setenv.get(), semicol_sep); /* Iterate over all FOO=foo parts */
  66   for (const auto& token : token_vars) {
  67     std::vector<std::string> kv;
  68     Tokenizer token_kv(token, equal_sep);
  69     for (const auto& t : token_kv) /* Iterate over 'FOO' and then 'foo' in that 'FOO=foo' */
  70       kv.push_back(t);
  71     xbt_assert(kv.size() == 2, "Parse error on 'model-check/setenv' value %s. Does it contain an equal sign?",
  72                token.c_str());
  73     XBT_INFO("setenv '%s'='%s'", kv[0].c_str(), kv[1].c_str());
  74     setenv(kv[0].c_str(), kv[1].c_str(), 1);
  75   }
  76
  77   /* And now, exec the child process */
  78   int i = 1;
  79   while (args[i] != nullptr && args[i][0] == '-')
  80     i++;
  81
  82   xbt_assert(args[i] != nullptr,
  83              "Unable to find a binary to exec on the command line. Did you only pass config flags?");
  84
  85   execvp(args[i], args.data() + i);
  86   XBT_CRITICAL("The model-checked process failed to exec(%s): %s.\n"
  87                "        Make sure that your binary exists on disk and is executable.",
  88                args[i], strerror(errno));
  89   if (strchr(args[i], '=') != nullptr)
  90     XBT_CRITICAL("If you want to pass environment variables to the application, please use --cfg=model-check/setenv:%s",
  91                  args[i]);
  92
  93   xbt_die("Aborting now.");
  94 }
  95
  96 static void wait_application_process(pid_t pid)
  97 {
  98   XBT_DEBUG("Waiting for the model-checked process");
  99   int status;
 100
 101   // The model-checked process SIGSTOP itself to signal it's ready:
 102   xbt_assert(waitpid(pid, &status, WAITPID_CHECKED_FLAGS) == pid && WIFSTOPPED(status) && WSTOPSIG(status) == SIGSTOP,
 103              "Could not wait model-checked process");
 104
 105   errno = 0;
 106 #ifdef __linux__
 107   ptrace(PTRACE_SETOPTIONS, pid, nullptr, PTRACE_O_TRACEEXIT);
 108   ptrace(PTRACE_CONT, pid, 0, 0);
 109 #elif defined BSD
 110   ptrace(PT_CONTINUE, pid, (caddr_t)1, 0);
 111 #else
 112   xbt_die("no ptrace equivalent coded for this platform, stateful model-checking is impossible.");
 113 #endif
 114   xbt_assert(errno == 0,
 115              "Ptrace does not seem to be usable in your setup (errno: %d). "
 116              "If you run from within a docker, adding `--cap-add SYS_PTRACE` to the docker line may help. "
 117              "If it does not help, please report this bug.",
 118              errno);
 119   XBT_DEBUG("%d ptrace correctly setup.", getpid());
 120 }
 121
 122 void CheckerSide::setup_events(bool socket_only)
 123 {
 124   auto* base = event_base_new();
 125   base_.reset(base);
 126
 127   socket_event_ = event_new(
 128       base, get_channel().get_socket(), EV_READ | EV_PERSIST,
 129       [](evutil_socket_t, short events, void* arg) {
 130         auto checker = static_cast<simgrid::mc::CheckerSide*>(arg);
 131         if (events == EV_READ) {
 132           do {
 133
 134             std::array<char, MC_MESSAGE_LENGTH> buffer;
 135             ssize_t size = checker->get_channel().receive(buffer.data(), buffer.size(), MSG_DONTWAIT);
 136             if (size == -1) {
 137               XBT_ERROR("Channel::receive failure: %s", strerror(errno));
 138               if (errno != EAGAIN)
 139                 throw simgrid::xbt::errno_error();
 140             }
 141
 142             if (size == 0) // The app closed the socket. It must be dead by now.
 143               checker->handle_waitpid();
 144             else if (not checker->handle_message(buffer.data(), size)) {
 145               checker->break_loop();
 146               break;
 147             }
 148           } while (checker->get_channel().has_pending_data());
 149         } else {
 150           xbt_die("Unexpected event");
 151         }
 152       },
 153       this);
 154   event_add(socket_event_, nullptr);
 155
 156   if (socket_only) {
 157     signal_event_ = nullptr;
 158   } else {
 159     signal_event_ = event_new(
 160         base, SIGCHLD, EV_SIGNAL | EV_PERSIST,
 161         [](evutil_socket_t sig, short events, void* arg) {
 162           auto checker = static_cast<simgrid::mc::CheckerSide*>(arg);
 163           if (events == EV_SIGNAL) {
 164             if (sig == SIGCHLD)
 165               checker->handle_waitpid();
 166             else
 167               xbt_die("Unexpected signal: %d", sig);
 168           } else {
 169             xbt_die("Unexpected event");
 170           }
 171         },
 172         this);
 173     event_add(signal_event_, nullptr);
 174   }
 175 }
 176
 177 /* When this constructor is called, no other checkerside exists */
 178 CheckerSide::CheckerSide(const std::vector<char*>& args, bool need_memory_info) : running_(true)
 179 {
 180   XBT_DEBUG("Create a CheckerSide. Needs_meminfo: %s", need_memory_info ? "YES" : "no");
 181
 182   // Create an AF_UNIX socketpair used for exchanging messages between the model-checker process (ancestor)
 183   // and the application process (child)
 184   int sockets[2];
 185   xbt_assert(socketpair(AF_UNIX, SOCK_STREAM, 0, sockets) != -1, "Could not create socketpair: %s", strerror(errno));
 186
 187   pid_ = fork();
 188   xbt_assert(pid_ >= 0, "Could not fork application process");
 189
 190   if (pid_ == 0) { // Child
 191     ::close(sockets[1]);
 192     run_child_process(sockets[0], args, need_memory_info); // We need ptrace if we need the mem info
 193     DIE_IMPOSSIBLE;
 194   }
 195
 196   // Parent (model-checker):
 197   ::close(sockets[0]);
 198   channel_.reset_socket(sockets[1]);
 199
 200   setup_events(false); /* we need a signal handler too */
 201   if (need_memory_info) {
 202 #if SIMGRID_HAVE_STATEFUL_MC
 203     // setup ptrace and sync with the app
 204     wait_application_process(pid_);
 205
 206     // Request the initial memory on need
 207     channel_.send(MessageType::NEED_MEMINFO);
 208     s_mc_message_need_meminfo_reply_t answer;
 209     ssize_t answer_size = channel_.receive(answer);
 210     xbt_assert(answer_size != -1, "Could not receive message");
 211     xbt_assert(answer.type == MessageType::NEED_MEMINFO_REPLY,
 212                "The received message is not the NEED_MEMINFO_REPLY I was expecting but of type %s",
 213                to_c_str(answer.type));
 214     xbt_assert(answer_size == sizeof answer, "Broken message (size=%zd; expected %zu)", answer_size, sizeof answer);
 215
 216     /* We now have enough info to create the memory address space */
 217     remote_memory_ = std::make_unique<simgrid::mc::RemoteProcessMemory>(pid_, answer.mmalloc_default_mdp);
 218 #else
 219     xbt_die("Cannot introspect memory without MC support");
 220 #endif
 221   }
 222
 223   wait_for_requests();
 224 }
 225
 226 CheckerSide::~CheckerSide()
 227 {
 228   event_del(socket_event_);
 229   event_free(socket_event_);
 230   if (signal_event_ != nullptr) {
 231     event_del(signal_event_);
 232     event_free(signal_event_);
 233   }
 234 }
 235
 236 /* This constructor is called when cloning a checkerside to get its application to fork away */
 237 CheckerSide::CheckerSide(int socket, CheckerSide* child_checker)
 238     : channel_(socket, child_checker->channel_), running_(true), child_checker_(child_checker)
 239 {
 240   setup_events(true); // We already have a signal handled in that case
 241
 242   s_mc_message_int_t answer;
 243   ssize_t s = get_channel().receive(answer);
 244   xbt_assert(s != -1, "Could not receive answer to FORK_REPLY");
 245   xbt_assert(s == sizeof answer, "Broken message (size=%zd; expected %zu)", s, sizeof answer);
 246   xbt_assert(answer.type == MessageType::FORK_REPLY,
 247              "Received unexpected message %s (%i); expected MessageType::FORK_REPLY (%i)", to_c_str(answer.type),
 248              (int)answer.type, (int)MessageType::FORK_REPLY);
 249   pid_ = answer.value;
 250
 251   wait_for_requests();
 252 }
 253
 254 std::unique_ptr<CheckerSide> CheckerSide::clone(int master_socket)
 255 {
 256   s_mc_message_int_t m = {};
 257   m.type               = MessageType::FORK;
 258   m.value              = getpid();
 259   xbt_assert(get_channel().send(m) == 0, "Could not ask the app to fork on need.");
 260
 261   int sock = accept(master_socket, nullptr /* I know who's connecting*/, nullptr);
 262   xbt_assert(sock > 0, "Cannot accept the incomming connection of the forked app: %s.", strerror(errno));
 263
 264   return std::make_unique<CheckerSide>(sock, this);
 265 }
 266
 267 void CheckerSide::finalize(bool terminate_asap)
 268 {
 269   s_mc_message_int_t m = {};
 270   m.type               = MessageType::FINALIZE;
 271   m.value              = terminate_asap;
 272   xbt_assert(get_channel().send(m) == 0, "Could not ask the app to finalize on need");
 273
 274   s_mc_message_t answer;
 275   ssize_t s = get_channel().receive(answer);
 276   xbt_assert(s != -1, "Could not receive answer to FINALIZE");
 277   xbt_assert(s == sizeof answer, "Broken message (size=%zd; expected %zu)", s, sizeof answer);
 278   xbt_assert(answer.type == MessageType::FINALIZE_REPLY,
 279              "Received unexpected message %s (%i); expected MessageType::FINALIZE_REPLY (%i)", to_c_str(answer.type),
 280              (int)answer.type, (int)MessageType::FINALIZE_REPLY);
 281 }
 282
 283 void CheckerSide::dispatch_events()
 284 {
 285   event_base_dispatch(base_.get());
 286 }
 287
 288 void CheckerSide::break_loop() const
 289 {
 290   event_base_loopbreak(base_.get());
 291 }
 292
 293 bool CheckerSide::handle_message(const char* buffer, ssize_t size)
 294 {
 295   s_mc_message_t base_message;
 296   ssize_t consumed;
 297   xbt_assert(size >= (ssize_t)sizeof(base_message), "Broken message. Got only %ld bytes.", size);
 298   memcpy(&base_message, buffer, sizeof(base_message));
 299
 300   switch (base_message.type) {
 301     case MessageType::IGNORE_HEAP: {
 302       consumed = sizeof(s_mc_message_ignore_heap_t);
 303 #if SIMGRID_HAVE_STATEFUL_MC
 304       if (remote_memory_ != nullptr) {
 305         s_mc_message_ignore_heap_t message;
 306         xbt_assert(size >= static_cast<ssize_t>(sizeof(message)), "Broken message");
 307         memcpy(&message, buffer, sizeof(message));
 308
 309         IgnoredHeapRegion region;
 310         region.block    = message.block;
 311         region.fragment = message.fragment;
 312         region.address  = message.address;
 313         region.size     = message.size;
 314         get_remote_memory()->ignore_heap(region);
 315       } else
 316 #endif
 317         XBT_INFO("Ignoring a IGNORE_HEAP message because we don't need to introspect memory.");
 318       break;
 319     }
 320
 321     case MessageType::UNIGNORE_HEAP: {
 322       consumed = sizeof(s_mc_message_ignore_memory_t);
 323 #if SIMGRID_HAVE_STATEFUL_MC
 324       if (remote_memory_ != nullptr) {
 325         s_mc_message_ignore_memory_t message;
 326         xbt_assert(size == static_cast<ssize_t>(sizeof(message)), "Broken message");
 327         memcpy(&message, buffer, sizeof(message));
 328         get_remote_memory()->unignore_heap((void*)message.addr, message.size);
 329       } else
 330 #endif
 331         XBT_INFO("Ignoring an UNIGNORE_HEAP message because we don't need to introspect memory.");
 332       break;
 333     }
 334
 335     case MessageType::IGNORE_MEMORY: {
 336       consumed = sizeof(s_mc_message_ignore_memory_t);
 337 #if SIMGRID_HAVE_STATEFUL_MC
 338       if (remote_memory_ != nullptr) {
 339         s_mc_message_ignore_memory_t message;
 340         xbt_assert(size >= static_cast<ssize_t>(sizeof(message)), "Broken message");
 341         memcpy(&message, buffer, sizeof(message));
 342         get_remote_memory()->ignore_region(message.addr, message.size);
 343       } else
 344 #endif
 345         XBT_INFO("Ignoring an IGNORE_MEMORY message because we don't need to introspect memory.");
 346       break;
 347     }
 348
 349     case MessageType::STACK_REGION: {
 350       consumed = sizeof(s_mc_message_stack_region_t);
 351 #if SIMGRID_HAVE_STATEFUL_MC
 352       if (remote_memory_ != nullptr) {
 353         s_mc_message_stack_region_t message;
 354         xbt_assert(size >= static_cast<ssize_t>(sizeof(message)), "Broken message");
 355         memcpy(&message, buffer, sizeof(message));
 356         get_remote_memory()->stack_areas().push_back(message.stack_region);
 357       } else
 358 #endif
 359         XBT_INFO("Ignoring an STACK_REGION message because we don't need to introspect memory.");
 360       break;
 361     }
 362
 363     case MessageType::REGISTER_SYMBOL: {
 364       consumed = sizeof(s_mc_message_register_symbol_t);
 365 #if SIMGRID_HAVE_STATEFUL_MC
 366       s_mc_message_register_symbol_t message;
 367       xbt_assert(size >= static_cast<ssize_t>(sizeof(message)), "Broken message");
 368       memcpy(&message, buffer, sizeof(message));
 369       xbt_assert(not message.callback, "Support for client-side function proposition is not implemented.");
 370       XBT_DEBUG("Received symbol: %s", message.name.data());
 371
 372       LivenessChecker::automaton_register_symbol(*get_remote_memory(), message.name.data(), remote((int*)message.data));
 373 #else
 374       xbt_die("Please don't use liveness properties when MC is compiled out.");
 375 #endif
 376       break;
 377     }
 378
 379     case MessageType::WAITING:
 380       consumed = sizeof(s_mc_message_t);
 381       if (size > consumed) {
 382         XBT_DEBUG("%d reinject %d bytes after a %s message", getpid(), (int)(size - consumed),
 383                   to_c_str(base_message.type));
 384         channel_.reinject(&buffer[consumed], size - consumed);
 385       }
 386
 387       return false;
 388
 389     case MessageType::ASSERTION_FAILED:
 390       consumed = sizeof(s_mc_message_t);
 391       Exploration::get_instance()->report_assertion_failure();
 392       break;
 393
 394     default:
 395       xbt_die("Unexpected message from the application");
 396   }
 397   if (size > consumed) {
 398     XBT_DEBUG("%d reinject %d bytes after a %s message", getpid(), (int)(size - consumed), to_c_str(base_message.type));
 399     channel_.reinject(&buffer[consumed], size - consumed);
 400   }
 401   return true;
 402 }
 403
 404 void CheckerSide::wait_for_requests()
 405 {
 406   XBT_DEBUG("Resume the application");
 407   if (get_channel().send(MessageType::CONTINUE) != 0)
 408     throw xbt::errno_error();
 409   clear_memory_cache();
 410
 411   if (running())
 412     dispatch_events();
 413 }
 414
 415 void CheckerSide::clear_memory_cache()
 416 {
 417 #if SIMGRID_HAVE_STATEFUL_MC
 418   if (remote_memory_)
 419     remote_memory_->clear_cache();
 420 #endif
 421 }
 422
 423 void CheckerSide::handle_dead_child(int status)
 424 {
 425   // From PTRACE_O_TRACEEXIT:
 426 #ifdef __linux__
 427   if (status >> 8 == (SIGTRAP | (PTRACE_EVENT_EXIT << 8))) {
 428     unsigned long eventmsg;
 429     xbt_assert(ptrace(PTRACE_GETEVENTMSG, pid_, 0, &eventmsg) != -1, "Could not get exit status");
 430     status = static_cast<int>(eventmsg);
 431     if (WIFSIGNALED(status)) {
 432       this->terminate();
 433       Exploration::get_instance()->report_crash(status);
 434     }
 435   }
 436 #endif
 437
 438   // We don't care about non-lethal signals, just reinject them:
 439   if (WIFSTOPPED(status)) {
 440     XBT_DEBUG("Stopped with signal %i", (int)WSTOPSIG(status));
 441     errno = 0;
 442 #ifdef __linux__
 443     ptrace(PTRACE_CONT, pid_, 0, WSTOPSIG(status));
 444 #elif defined BSD
 445     ptrace(PT_CONTINUE, pid_, (caddr_t)1, WSTOPSIG(status));
 446 #endif
 447     xbt_assert(errno == 0, "Could not PTRACE_CONT: %s", strerror(errno));
 448   }
 449
 450   else if (WIFSIGNALED(status)) {
 451     this->terminate();
 452     Exploration::get_instance()->report_crash(status);
 453   } else if (WIFEXITED(status)) {
 454     XBT_DEBUG("Child process is over");
 455     this->terminate();
 456   }
 457 }
 458
 459 void CheckerSide::handle_waitpid()
 460 {
 461   XBT_DEBUG("%d checks for wait event. %s", getpid(),
 462             child_checker_ == nullptr ? "Wait directly." : "Ask our proxy to wait for its child.");
 463
 464   if (child_checker_ == nullptr) { // Wait directly
 465     int status;
 466     pid_t pid;
 467     while ((pid = waitpid(-1, &status, WNOHANG)) != 0) {
 468       if (pid == -1) {
 469         if (errno == ECHILD) { // No more children:
 470           xbt_assert(not this->running(), "Inconsistent state");
 471           break;
 472         } else {
 473           xbt_die("Could not wait for pid: %s", strerror(errno));
 474         }
 475       }
 476
 477       if (pid == get_pid())
 478         handle_dead_child(status);
 479     }
 480
 481   } else { // Ask our proxy to wait for us
 482
 483     s_mc_message_int_t request = {};
 484     request.type               = MessageType::WAIT_CHILD;
 485     request.value              = pid_;
 486     xbt_assert(child_checker_->get_channel().send(request) == 0,
 487                "Could not ask my child to waitpid its child for me: %s", strerror(errno));
 488
 489     s_mc_message_int_t answer;
 490     ssize_t answer_size = child_checker_->get_channel().receive(answer);
 491     xbt_assert(answer_size != -1, "Could not receive message");
 492     xbt_assert(answer.type == MessageType::WAIT_CHILD_REPLY,
 493                "The received message is not the WAIT_CHILD_REPLY I was expecting but of type %s",
 494                to_c_str(answer.type));
 495     xbt_assert(answer_size == sizeof answer, "Broken message (size=%zd; expected %zu)", answer_size, sizeof answer);
 496     handle_dead_child(answer.value);
 497   }
 498 }
 499 } // namespace simgrid::mc