src/mc/remote/AppSide.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/remote/AppSide.hpp"
   7 #include "simgrid/s4u/Host.hpp"
   8 #include "src/internal_config.h"
   9 #include "src/kernel/EngineImpl.hpp"
  10 #include "src/kernel/actor/ActorImpl.hpp"
  11 #include "src/kernel/actor/SimcallObserver.hpp"
  12 #include "src/mc/mc_base.hpp"
  13 #include "src/mc/mc_config.hpp"
  14 #include "src/mc/mc_environ.h"
  15 #if SIMGRID_HAVE_STATEFUL_MC
  16 #include "src/mc/sosp/RemoteProcessMemory.hpp"
  17 #endif
  18 #if HAVE_SMPI
  19 #include "src/smpi/include/private.hpp"
  20 #endif
  21 #include "src/sthread/sthread.h"
  22 #include "src/xbt/coverage.h"
  23 #include "xbt/str.h"
  24 #include <simgrid/modelchecker.h>
  25
  26 #include <cerrno>
  27 #include <cinttypes>
  28 #include <cstdio> // setvbuf
  29 #include <cstdlib>
  30 #include <memory>
  31 #include <numeric>
  32 #include <sys/ptrace.h>
  33 #include <sys/socket.h>
  34 #include <sys/types.h>
  35 #include <sys/un.h>
  36 #include <sys/wait.h>
  37
  38 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  39 XBT_LOG_EXTERNAL_CATEGORY(mc_global);
  40
  41 namespace simgrid::mc {
  42
  43 std::unique_ptr<AppSide> AppSide::instance_;
  44
  45 AppSide* AppSide::get()
  46 {
  47   // Only initialize the MC world once
  48   if (instance_ != nullptr)
  49     return instance_.get();
  50
  51   if (std::getenv(MC_ENV_SOCKET_FD) == nullptr) // We are not in MC mode: don't initialize the MC world
  52     return nullptr;
  53
  54   XBT_DEBUG("Initialize the MC world. %s=%s", MC_ENV_NEED_PTRACE, std::getenv(MC_ENV_NEED_PTRACE));
  55
  56   simgrid::mc::set_model_checking_mode(ModelCheckingMode::APP_SIDE);
  57
  58   setvbuf(stdout, nullptr, _IOLBF, 0);
  59
  60   // Fetch socket from MC_ENV_SOCKET_FD:
  61   const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
  62   int fd             = xbt_str_parse_int(fd_env, "Not a number in variable '" MC_ENV_SOCKET_FD "'");
  63   XBT_DEBUG("Model-checked application found socket FD %i", fd);
  64
  65   instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
  66
  67   // Wait for the model-checker:
  68   if (getenv(MC_ENV_NEED_PTRACE) != nullptr) {
  69     errno = 0;
  70 #if defined __linux__
  71     ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
  72 #elif defined BSD
  73     ptrace(PT_TRACE_ME, 0, nullptr, 0);
  74 #else
  75     xbt_die("no ptrace equivalent coded for this platform, please don't use the liveness checker here.");
  76 #endif
  77
  78     xbt_assert(errno == 0 && raise(SIGSTOP) == 0, "Could not wait for the model-checker (errno = %d: %s)", errno,
  79                strerror(errno));
  80   }
  81
  82   instance_->handle_messages();
  83   return instance_.get();
  84 }
  85
  86 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
  87 {
  88   const auto* engine     = kernel::EngineImpl::get_instance();
  89   const auto& actor_list = engine->get_actor_list();
  90   bool deadlock = not actor_list.empty() && std::none_of(begin(actor_list), end(actor_list), [](const auto& kv) {
  91     return mc::actor_is_enabled(kv.second);
  92   });
  93
  94   if (deadlock) {
  95     XBT_CINFO(mc_global, "**************************");
  96     XBT_CINFO(mc_global, "*** DEADLOCK DETECTED ***");
  97     XBT_CINFO(mc_global, "**************************");
  98     engine->display_all_actor_status();
  99   }
 100   // Send result:
 101   s_mc_message_int_t answer = {};
 102   answer.type  = MessageType::DEADLOCK_CHECK_REPLY;
 103   answer.value = deadlock;
 104   xbt_assert(channel_.send(answer) == 0, "Could not send response: %s", strerror(errno));
 105 }
 106 void AppSide::handle_simcall_execute(const s_mc_message_simcall_execute_t* message) const
 107 {
 108   kernel::actor::ActorImpl* actor = kernel::EngineImpl::get_instance()->get_actor_by_pid(message->aid_);
 109   xbt_assert(actor != nullptr, "Invalid pid %ld", message->aid_);
 110
 111   // The client may send some messages to the server while processing the transition
 112   actor->simcall_handle(message->times_considered_);
 113   // Say the server that the transition is over and that it should proceed
 114   xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker: %s",
 115              strerror(errno));
 116
 117   // Finish the RPC from the server: return a serialized observer, to build a Transition on Checker side
 118   s_mc_message_simcall_execute_answer_t answer = {};
 119   answer.type                                  = MessageType::SIMCALL_EXECUTE_REPLY;
 120   std::stringstream stream;
 121   if (actor->simcall_.observer_ != nullptr) {
 122     actor->simcall_.observer_->serialize(stream);
 123   } else {
 124     stream << (short)mc::Transition::Type::UNKNOWN;
 125   }
 126   std::string str = stream.str();
 127   xbt_assert(str.size() + 1 <= answer.buffer.size(),
 128              "The serialized simcall is too large for the buffer. Please fix the code.");
 129   strncpy(answer.buffer.data(), str.c_str(), answer.buffer.size() - 1);
 130   answer.buffer.back() = '\0';
 131
 132   XBT_DEBUG("send SIMCALL_EXECUTE_ANSWER(%s) ~> '%s'", actor->get_cname(), str.c_str());
 133   xbt_assert(channel_.send(answer) == 0, "Could not send response: %s", strerror(errno));
 134 }
 135
 136 void AppSide::handle_finalize(const s_mc_message_int_t* msg) const
 137 {
 138   bool terminate_asap = msg->value;
 139   XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
 140   if (not terminate_asap) {
 141     if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
 142       kernel::EngineImpl::get_instance()->display_all_actor_status();
 143 #if HAVE_SMPI
 144     XBT_DEBUG("Smpi_enabled: %d", SMPI_is_inited());
 145     if (SMPI_is_inited())
 146       SMPI_finalize();
 147 #endif
 148   }
 149   coverage_checkpoint();
 150   xbt_assert(channel_.send(MessageType::FINALIZE_REPLY) == 0, "Could not answer to FINALIZE: %s", strerror(errno));
 151   std::fflush(stdout);
 152   if (terminate_asap)
 153     ::_Exit(0);
 154 }
 155 void AppSide::handle_fork(const s_mc_message_int_t* msg)
 156 {
 157   int status;
 158   int pid;
 159   /* Reap any zombie child, saving its status for later use in AppSide::handle_wait_child() */
 160   while ((pid = waitpid(-1, &status, WNOHANG)) > 0)
 161     child_statuses_[pid] = status;
 162
 163   pid = fork();
 164   xbt_assert(pid >= 0, "Could not fork application sub-process: %s.", strerror(errno));
 165
 166   if (pid == 0) { // Child
 167     int sock = socket(AF_UNIX,
 168 #ifdef __APPLE__
 169                       SOCK_STREAM, /* Mac OSX does not have AF_UNIX + SOCK_SEQPACKET, even if that's faster*/
 170 #else
 171                       SOCK_SEQPACKET,
 172 #endif
 173                       0);
 174
 175     struct sockaddr_un addr = {};
 176     addr.sun_family         = AF_UNIX;
 177     snprintf(addr.sun_path, 64, "/tmp/simgrid-mc-%" PRIu64, msg->value);
 178     auto addr_size = offsetof(struct sockaddr_un, sun_path) + strlen(addr.sun_path);
 179
 180     xbt_assert(connect(sock, (struct sockaddr*)&addr, addr_size) >= 0,
 181                "Cannot connect to Checker on %s: %s.", addr.sun_path, strerror(errno));
 182
 183     channel_.reset_socket(sock);
 184
 185     s_mc_message_int_t answer = {};
 186     answer.type               = MessageType::FORK_REPLY;
 187     answer.value              = getpid();
 188     xbt_assert(channel_.send(answer) == 0, "Could not send response to WAIT_CHILD_REPLY: %s", strerror(errno));
 189   } else {
 190     XBT_VERB("App %d forks subprocess %d.", getpid(), pid);
 191   }
 192 }
 193 void AppSide::handle_wait_child(const s_mc_message_int_t* msg)
 194 {
 195   int status;
 196   errno = 0;
 197   if (auto search = child_statuses_.find(msg->value); search != child_statuses_.end()) {
 198     status = search->second;
 199     child_statuses_.erase(search); // We only need this info once
 200   } else {
 201     waitpid(msg->value, &status, 0);
 202   }
 203   xbt_assert(errno == 0, "Cannot wait on behalf of the checker: %s.", strerror(errno));
 204
 205   s_mc_message_int_t answer = {};
 206   answer.type               = MessageType::WAIT_CHILD_REPLY;
 207   answer.value              = status;
 208   xbt_assert(channel_.send(answer) == 0, "Could not send response to WAIT_CHILD: %s", strerror(errno));
 209 }
 210 void AppSide::handle_need_meminfo()
 211 {
 212 #if SIMGRID_HAVE_STATEFUL_MC
 213   this->need_memory_info_                  = true;
 214   s_mc_message_need_meminfo_reply_t answer = {};
 215   answer.type                              = MessageType::NEED_MEMINFO_REPLY;
 216   answer.mmalloc_default_mdp               = mmalloc_get_current_heap();
 217   xbt_assert(channel_.send(answer) == 0, "Could not send response to the request for meminfo: %s", strerror(errno));
 218 #else
 219   xbt_die("SimGrid was compiled without MC suppport, so liveness and similar features are not available.");
 220 #endif
 221 }
 222 void AppSide::handle_actors_status() const
 223 {
 224   auto const& actor_list = kernel::EngineImpl::get_instance()->get_actor_list();
 225   XBT_DEBUG("Serialize the actors to answer ACTORS_STATUS from the checker. %zu actors to go.", actor_list.size());
 226
 227   std::vector<s_mc_message_actors_status_one_t> status;
 228   for (auto const& [aid, actor] : actor_list) {
 229     s_mc_message_actors_status_one_t one = {};
 230     one.type                             = MessageType::ACTORS_STATUS_REPLY_TRANSITION;
 231     one.aid                              = aid;
 232     one.enabled                          = mc::actor_is_enabled(actor);
 233     one.max_considered                   = actor->simcall_.observer_->get_max_consider();
 234     status.push_back(one);
 235   }
 236
 237   struct s_mc_message_actors_status_answer_t answer = {};
 238   answer.type                                       = MessageType::ACTORS_STATUS_REPLY_COUNT;
 239   answer.count                                      = static_cast<int>(status.size());
 240
 241   xbt_assert(channel_.send(answer) == 0, "Could not send ACTORS_STATUS_REPLY msg: %s", strerror(errno));
 242   if (answer.count > 0) {
 243     size_t size = status.size() * sizeof(s_mc_message_actors_status_one_t);
 244     xbt_assert(channel_.send(status.data(), size) == 0, "Could not send ACTORS_STATUS_REPLY data: %s", strerror(errno));
 245   }
 246
 247   // Serialize each transition to describe what each actor is doing
 248   XBT_DEBUG("Deliver ACTOR_TRANSITION_PROBE payload");
 249   for (const auto& actor_status : status) {
 250     const auto& actor        = actor_list.at(actor_status.aid);
 251     const int max_considered = actor_status.max_considered;
 252
 253     for (int times_considered = 0; times_considered < max_considered; times_considered++) {
 254       std::stringstream stream;
 255       s_mc_message_simcall_probe_one_t probe;
 256       probe.type = MessageType::ACTORS_STATUS_REPLY_SIMCALL;
 257
 258       if (actor->simcall_.observer_ != nullptr) {
 259         actor->simcall_.observer_->prepare(times_considered);
 260         actor->simcall_.observer_->serialize(stream);
 261       } else {
 262         stream << (short)mc::Transition::Type::UNKNOWN;
 263       }
 264
 265       std::string str = stream.str();
 266       xbt_assert(str.size() + 1 <= probe.buffer.size(),
 267                  "The serialized transition is too large for the buffer. Please fix the code.");
 268       strncpy(probe.buffer.data(), str.c_str(), probe.buffer.size() - 1);
 269       probe.buffer.back() = '\0';
 270
 271       xbt_assert(channel_.send(probe) == 0, "Could not send ACTOR_TRANSITION_PROBE payload: %s", strerror(errno));
 272     }
 273     // NOTE: We do NOT need to reset `times_considered` for each actor's
 274     // simcall observer here to the "original" value (i.e. the value BEFORE
 275     // multiple prepare() calls were made for serialization purposes) since
 276     // each SIMCALL_EXECUTE provides a `times_considered` to be used to prepare
 277     // the transition before execution.
 278   }
 279 }
 280 void AppSide::handle_actors_maxpid() const
 281 {
 282   s_mc_message_int_t answer = {};
 283   answer.type               = MessageType::ACTORS_MAXPID_REPLY;
 284   answer.value              = kernel::actor::ActorImpl::get_maxpid();
 285   xbt_assert(channel_.send(answer) == 0, "Could not send response: %s", strerror(errno));
 286 }
 287
 288 #define assert_msg_size(_name_, _type_)                                                                                \
 289   xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size,            \
 290              sizeof(_type_))
 291
 292 void AppSide::handle_messages()
 293 {
 294   while (true) { // Until we get a CONTINUE message
 295     XBT_DEBUG("Waiting messages from the model-checker");
 296
 297     std::array<char, MC_MESSAGE_LENGTH> message_buffer;
 298     ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
 299
 300     if (received_size == 0) {
 301       XBT_DEBUG("Socket closed on the Checker side, bailing out.");
 302       ::_Exit(0); // Nobody's listening to that process anymore => exit as quickly as possible.
 303     }
 304     xbt_assert(received_size >= 0, "Could not receive commands from the model-checker: %s", strerror(errno));
 305     xbt_assert(static_cast<size_t>(received_size) >= sizeof(s_mc_message_t), "Cannot handle short message (size=%zd)",
 306                received_size);
 307
 308     const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
 309     switch (message->type) {
 310       case MessageType::CONTINUE:
 311         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 312         return;
 313
 314       case MessageType::DEADLOCK_CHECK:
 315         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 316         handle_deadlock_check(message);
 317         break;
 318
 319       case MessageType::SIMCALL_EXECUTE:
 320         assert_msg_size("SIMCALL_EXECUTE", s_mc_message_simcall_execute_t);
 321         handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data());
 322         break;
 323
 324       case MessageType::FINALIZE:
 325         assert_msg_size("FINALIZE", s_mc_message_int_t);
 326         handle_finalize((s_mc_message_int_t*)message_buffer.data());
 327         break;
 328
 329       case MessageType::FORK:
 330         assert_msg_size("FORK", s_mc_message_int_t);
 331         handle_fork((s_mc_message_int_t*)message_buffer.data());
 332         break;
 333
 334       case MessageType::WAIT_CHILD:
 335         assert_msg_size("WAIT_CHILD", s_mc_message_int_t);
 336         handle_wait_child((s_mc_message_int_t*)message_buffer.data());
 337         break;
 338
 339       case MessageType::NEED_MEMINFO:
 340         assert_msg_size("NEED_MEMINFO", s_mc_message_t);
 341         handle_need_meminfo();
 342         break;
 343
 344       case MessageType::ACTORS_STATUS:
 345         assert_msg_size("ACTORS_STATUS", s_mc_message_t);
 346         handle_actors_status();
 347         break;
 348
 349       case MessageType::ACTORS_MAXPID:
 350         assert_msg_size("ACTORS_MAXPID", s_mc_message_t);
 351         handle_actors_maxpid();
 352         break;
 353
 354       default:
 355         xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
 356         break;
 357     }
 358   }
 359 }
 360
 361 void AppSide::main_loop()
 362 {
 363   simgrid::mc::processes_time.resize(simgrid::kernel::actor::ActorImpl::get_maxpid());
 364   MC_ignore_heap(simgrid::mc::processes_time.data(),
 365                  simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0]));
 366
 367   sthread_disable();
 368   coverage_checkpoint();
 369   sthread_enable();
 370   while (true) {
 371     simgrid::mc::execute_actors();
 372     xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker: %s",
 373                strerror(errno));
 374     this->handle_messages();
 375   }
 376 }
 377
 378 void AppSide::report_assertion_failure()
 379 {
 380   xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker: %s",
 381              strerror(errno));
 382   this->handle_messages();
 383 }
 384
 385 void AppSide::ignore_memory(void* addr, std::size_t size) const
 386 {
 387   if (not MC_is_active() || not need_memory_info_)
 388     return;
 389
 390 #if SIMGRID_HAVE_STATEFUL_MC
 391   s_mc_message_ignore_memory_t message = {};
 392   message.type = MessageType::IGNORE_MEMORY;
 393   message.addr = (std::uintptr_t)addr;
 394   message.size = size;
 395   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker: %s", strerror(errno));
 396 #else
 397   xbt_die("Cannot really call ignore_heap() in non-SIMGRID_MC mode.");
 398 #endif
 399 }
 400
 401 void AppSide::ignore_heap(void* address, std::size_t size) const
 402 {
 403   if (not MC_is_active() || not need_memory_info_)
 404     return;
 405
 406 #if SIMGRID_HAVE_STATEFUL_MC
 407   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 408
 409   s_mc_message_ignore_heap_t message = {};
 410   message.type    = MessageType::IGNORE_HEAP;
 411   message.address = address;
 412   message.size    = size;
 413   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 414   if (heap->heapinfo[message.block].type == 0) {
 415     message.fragment = -1;
 416     heap->heapinfo[message.block].busy_block.ignore++;
 417   } else {
 418     message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
 419     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 420   }
 421
 422   xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer: %s", strerror(errno));
 423 #else
 424   xbt_die("Cannot really call ignore_heap() in non-SIMGRID_MC mode.");
 425 #endif
 426 }
 427
 428 void AppSide::unignore_heap(void* address, std::size_t size) const
 429 {
 430   if (not MC_is_active() || not need_memory_info_)
 431     return;
 432
 433 #if SIMGRID_HAVE_STATEFUL_MC
 434   s_mc_message_ignore_memory_t message = {};
 435   message.type = MessageType::UNIGNORE_HEAP;
 436   message.addr = (std::uintptr_t)address;
 437   message.size = size;
 438   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker: %s", strerror(errno));
 439 #else
 440   xbt_die("Cannot really call unignore_heap() in non-SIMGRID_MC mode.");
 441 #endif
 442 }
 443
 444 void AppSide::declare_symbol(const char* name, int* value) const
 445 {
 446   if (not MC_is_active() || not need_memory_info_) {
 447     XBT_CRITICAL("Ignore AppSide::declare_symbol(%s)", name);
 448     return;
 449   }
 450
 451 #if SIMGRID_HAVE_STATEFUL_MC
 452   s_mc_message_register_symbol_t message = {};
 453   message.type = MessageType::REGISTER_SYMBOL;
 454   xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
 455   strncpy(message.name.data(), name, message.name.size() - 1);
 456   message.callback = nullptr;
 457   message.data     = value;
 458   xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker: %s", strerror(errno));
 459 #else
 460   xbt_die("Cannot really call declare_symbol() in non-SIMGRID_MC mode.");
 461 #endif
 462 }
 463
 464 /** Register a stack in the model checker
 465  *
 466  *  The stacks are allocated in the heap. The MC handle them specifically
 467  *  when we analyze/compare the content of the heap so it must be told where
 468  *  they are with this function.
 469  */
 470 #if HAVE_UCONTEXT_H /* Apple don't want us to use ucontexts */
 471 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
 472 {
 473   if (not MC_is_active() || not need_memory_info_)
 474     return;
 475
 476 #if SIMGRID_HAVE_STATEFUL_MC
 477   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 478
 479   s_stack_region_t region = {};
 480   region.address = stack;
 481   region.context = context;
 482   region.size    = size;
 483   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 484
 485   s_mc_message_stack_region_t message = {};
 486   message.type         = MessageType::STACK_REGION;
 487   message.stack_region = region;
 488   xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker: %s", strerror(errno));
 489 #else
 490   xbt_die("Cannot really call declare_stack() in non-SIMGRID_MC mode.");
 491 #endif
 492 }
 493 #endif
 494
 495 } // namespace simgrid::mc