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_fork_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     std::copy_n(begin(msg->socket_name), MC_SOCKET_NAME_LEN, addr.sun_path);
 178
 179     xbt_assert(connect(sock, (struct sockaddr*)&addr, sizeof addr) >= 0, "Cannot connect to Checker on %c%s: %s.",
 180                (addr.sun_path[0] ? addr.sun_path[0] : '@'), addr.sun_path + 1, strerror(errno));
 181
 182     channel_.reset_socket(sock);
 183
 184     s_mc_message_int_t answer = {};
 185     answer.type               = MessageType::FORK_REPLY;
 186     answer.value              = getpid();
 187     xbt_assert(channel_.send(answer) == 0, "Could not send response to WAIT_CHILD_REPLY: %s", strerror(errno));
 188   } else {
 189     XBT_VERB("App %d forks subprocess %d.", getpid(), pid);
 190   }
 191 }
 192 void AppSide::handle_wait_child(const s_mc_message_int_t* msg)
 193 {
 194   int status;
 195   errno = 0;
 196   if (auto search = child_statuses_.find(msg->value); search != child_statuses_.end()) {
 197     status = search->second;
 198     child_statuses_.erase(search); // We only need this info once
 199   } else {
 200     waitpid(msg->value, &status, 0);
 201   }
 202   xbt_assert(errno == 0, "Cannot wait on behalf of the checker: %s.", strerror(errno));
 203
 204   s_mc_message_int_t answer = {};
 205   answer.type               = MessageType::WAIT_CHILD_REPLY;
 206   answer.value              = status;
 207   xbt_assert(channel_.send(answer) == 0, "Could not send response to WAIT_CHILD: %s", strerror(errno));
 208 }
 209 void AppSide::handle_need_meminfo()
 210 {
 211 #if SIMGRID_HAVE_STATEFUL_MC
 212   this->need_memory_info_                  = true;
 213   s_mc_message_need_meminfo_reply_t answer = {};
 214   answer.type                              = MessageType::NEED_MEMINFO_REPLY;
 215   answer.mmalloc_default_mdp               = mmalloc_get_current_heap();
 216   xbt_assert(channel_.send(answer) == 0, "Could not send response to the request for meminfo: %s", strerror(errno));
 217 #else
 218   xbt_die("SimGrid was compiled without MC suppport, so liveness and similar features are not available.");
 219 #endif
 220 }
 221 void AppSide::handle_actors_status() const
 222 {
 223   auto const& actor_list = kernel::EngineImpl::get_instance()->get_actor_list();
 224   XBT_DEBUG("Serialize the actors to answer ACTORS_STATUS from the checker. %zu actors to go.", actor_list.size());
 225
 226   std::vector<s_mc_message_actors_status_one_t> status;
 227   for (auto const& [aid, actor] : actor_list) {
 228     s_mc_message_actors_status_one_t one = {};
 229     one.type                             = MessageType::ACTORS_STATUS_REPLY_TRANSITION;
 230     one.aid                              = aid;
 231     one.enabled                          = mc::actor_is_enabled(actor);
 232     one.max_considered                   = actor->simcall_.observer_->get_max_consider();
 233     status.push_back(one);
 234   }
 235
 236   struct s_mc_message_actors_status_answer_t answer = {};
 237   answer.type                                       = MessageType::ACTORS_STATUS_REPLY_COUNT;
 238   answer.count                                      = static_cast<int>(status.size());
 239
 240   xbt_assert(channel_.send(answer) == 0, "Could not send ACTORS_STATUS_REPLY msg: %s", strerror(errno));
 241   if (answer.count > 0) {
 242     size_t size = status.size() * sizeof(s_mc_message_actors_status_one_t);
 243     xbt_assert(channel_.send(status.data(), size) == 0, "Could not send ACTORS_STATUS_REPLY data: %s", strerror(errno));
 244   }
 245
 246   // Serialize each transition to describe what each actor is doing
 247   XBT_DEBUG("Deliver ACTOR_TRANSITION_PROBE payload");
 248   for (const auto& actor_status : status) {
 249     const auto& actor        = actor_list.at(actor_status.aid);
 250     const int max_considered = actor_status.max_considered;
 251
 252     for (int times_considered = 0; times_considered < max_considered; times_considered++) {
 253       std::stringstream stream;
 254       s_mc_message_simcall_probe_one_t probe;
 255       probe.type = MessageType::ACTORS_STATUS_REPLY_SIMCALL;
 256
 257       if (actor->simcall_.observer_ != nullptr) {
 258         actor->simcall_.observer_->prepare(times_considered);
 259         actor->simcall_.observer_->serialize(stream);
 260       } else {
 261         stream << (short)mc::Transition::Type::UNKNOWN;
 262       }
 263
 264       std::string str = stream.str();
 265       xbt_assert(str.size() + 1 <= probe.buffer.size(),
 266                  "The serialized transition is too large for the buffer. Please fix the code.");
 267       strncpy(probe.buffer.data(), str.c_str(), probe.buffer.size() - 1);
 268       probe.buffer.back() = '\0';
 269
 270       xbt_assert(channel_.send(probe) == 0, "Could not send ACTOR_TRANSITION_PROBE payload: %s", strerror(errno));
 271     }
 272     // NOTE: We do NOT need to reset `times_considered` for each actor's
 273     // simcall observer here to the "original" value (i.e. the value BEFORE
 274     // multiple prepare() calls were made for serialization purposes) since
 275     // each SIMCALL_EXECUTE provides a `times_considered` to be used to prepare
 276     // the transition before execution.
 277   }
 278 }
 279 void AppSide::handle_actors_maxpid() const
 280 {
 281   s_mc_message_int_t answer = {};
 282   answer.type               = MessageType::ACTORS_MAXPID_REPLY;
 283   answer.value              = kernel::actor::ActorImpl::get_maxpid();
 284   xbt_assert(channel_.send(answer) == 0, "Could not send response: %s", strerror(errno));
 285 }
 286
 287 #define assert_msg_size(_name_, _type_)                                                                                \
 288   xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size,            \
 289              sizeof(_type_))
 290
 291 void AppSide::handle_messages()
 292 {
 293   while (true) { // Until we get a CONTINUE message
 294     XBT_DEBUG("Waiting messages from the model-checker");
 295
 296     std::array<char, MC_MESSAGE_LENGTH> message_buffer;
 297     ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
 298
 299     if (received_size == 0) {
 300       XBT_DEBUG("Socket closed on the Checker side, bailing out.");
 301       ::_Exit(0); // Nobody's listening to that process anymore => exit as quickly as possible.
 302     }
 303     xbt_assert(received_size >= 0, "Could not receive commands from the model-checker: %s", strerror(errno));
 304     xbt_assert(static_cast<size_t>(received_size) >= sizeof(s_mc_message_t), "Cannot handle short message (size=%zd)",
 305                received_size);
 306
 307     const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
 308     switch (message->type) {
 309       case MessageType::CONTINUE:
 310         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 311         return;
 312
 313       case MessageType::DEADLOCK_CHECK:
 314         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 315         handle_deadlock_check(message);
 316         break;
 317
 318       case MessageType::SIMCALL_EXECUTE:
 319         assert_msg_size("SIMCALL_EXECUTE", s_mc_message_simcall_execute_t);
 320         handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data());
 321         break;
 322
 323       case MessageType::FINALIZE:
 324         assert_msg_size("FINALIZE", s_mc_message_int_t);
 325         handle_finalize((s_mc_message_int_t*)message_buffer.data());
 326         break;
 327
 328       case MessageType::FORK:
 329         assert_msg_size("FORK", s_mc_message_fork_t);
 330         handle_fork((s_mc_message_fork_t*)message_buffer.data());
 331         break;
 332
 333       case MessageType::WAIT_CHILD:
 334         assert_msg_size("WAIT_CHILD", s_mc_message_int_t);
 335         handle_wait_child((s_mc_message_int_t*)message_buffer.data());
 336         break;
 337
 338       case MessageType::NEED_MEMINFO:
 339         assert_msg_size("NEED_MEMINFO", s_mc_message_t);
 340         handle_need_meminfo();
 341         break;
 342
 343       case MessageType::ACTORS_STATUS:
 344         assert_msg_size("ACTORS_STATUS", s_mc_message_t);
 345         handle_actors_status();
 346         break;
 347
 348       case MessageType::ACTORS_MAXPID:
 349         assert_msg_size("ACTORS_MAXPID", s_mc_message_t);
 350         handle_actors_maxpid();
 351         break;
 352
 353       default:
 354         xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
 355         break;
 356     }
 357   }
 358 }
 359
 360 void AppSide::main_loop()
 361 {
 362   simgrid::mc::processes_time.resize(simgrid::kernel::actor::ActorImpl::get_maxpid());
 363   MC_ignore_heap(simgrid::mc::processes_time.data(),
 364                  simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0]));
 365
 366   sthread_disable();
 367   coverage_checkpoint();
 368   sthread_enable();
 369   while (true) {
 370     simgrid::mc::execute_actors();
 371     xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker: %s",
 372                strerror(errno));
 373     this->handle_messages();
 374   }
 375 }
 376
 377 void AppSide::report_assertion_failure()
 378 {
 379   xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker: %s",
 380              strerror(errno));
 381   this->handle_messages();
 382 }
 383
 384 void AppSide::ignore_memory(void* addr, std::size_t size) const
 385 {
 386   if (not MC_is_active() || not need_memory_info_)
 387     return;
 388
 389 #if SIMGRID_HAVE_STATEFUL_MC
 390   s_mc_message_ignore_memory_t message = {};
 391   message.type = MessageType::IGNORE_MEMORY;
 392   message.addr = (std::uintptr_t)addr;
 393   message.size = size;
 394   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker: %s", strerror(errno));
 395 #else
 396   xbt_die("Cannot really call ignore_heap() in non-SIMGRID_MC mode.");
 397 #endif
 398 }
 399
 400 void AppSide::ignore_heap(void* address, std::size_t size) const
 401 {
 402   if (not MC_is_active() || not need_memory_info_)
 403     return;
 404
 405 #if SIMGRID_HAVE_STATEFUL_MC
 406   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 407
 408   s_mc_message_ignore_heap_t message = {};
 409   message.type    = MessageType::IGNORE_HEAP;
 410   message.address = address;
 411   message.size    = size;
 412   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 413   if (heap->heapinfo[message.block].type == 0) {
 414     message.fragment = -1;
 415     heap->heapinfo[message.block].busy_block.ignore++;
 416   } else {
 417     message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
 418     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 419   }
 420
 421   xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer: %s", strerror(errno));
 422 #else
 423   xbt_die("Cannot really call ignore_heap() in non-SIMGRID_MC mode.");
 424 #endif
 425 }
 426
 427 void AppSide::unignore_heap(void* address, std::size_t size) const
 428 {
 429   if (not MC_is_active() || not need_memory_info_)
 430     return;
 431
 432 #if SIMGRID_HAVE_STATEFUL_MC
 433   s_mc_message_ignore_memory_t message = {};
 434   message.type = MessageType::UNIGNORE_HEAP;
 435   message.addr = (std::uintptr_t)address;
 436   message.size = size;
 437   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker: %s", strerror(errno));
 438 #else
 439   xbt_die("Cannot really call unignore_heap() in non-SIMGRID_MC mode.");
 440 #endif
 441 }
 442
 443 void AppSide::declare_symbol(const char* name, int* value) const
 444 {
 445   if (not MC_is_active() || not need_memory_info_) {
 446     XBT_CRITICAL("Ignore AppSide::declare_symbol(%s)", name);
 447     return;
 448   }
 449
 450 #if SIMGRID_HAVE_STATEFUL_MC
 451   s_mc_message_register_symbol_t message = {};
 452   message.type = MessageType::REGISTER_SYMBOL;
 453   xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
 454   strncpy(message.name.data(), name, message.name.size() - 1);
 455   message.callback = nullptr;
 456   message.data     = value;
 457   xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker: %s", strerror(errno));
 458 #else
 459   xbt_die("Cannot really call declare_symbol() in non-SIMGRID_MC mode.");
 460 #endif
 461 }
 462
 463 /** Register a stack in the model checker
 464  *
 465  *  The stacks are allocated in the heap. The MC handle them specifically
 466  *  when we analyze/compare the content of the heap so it must be told where
 467  *  they are with this function.
 468  */
 469 #if HAVE_UCONTEXT_H /* Apple don't want us to use ucontexts */
 470 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
 471 {
 472   if (not MC_is_active() || not need_memory_info_)
 473     return;
 474
 475 #if SIMGRID_HAVE_STATEFUL_MC
 476   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 477
 478   s_stack_region_t region = {};
 479   region.address = stack;
 480   region.context = context;
 481   region.size    = size;
 482   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 483
 484   s_mc_message_stack_region_t message = {};
 485   message.type         = MessageType::STACK_REGION;
 486   message.stack_region = region;
 487   xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker: %s", strerror(errno));
 488 #else
 489   xbt_die("Cannot really call declare_stack() in non-SIMGRID_MC mode.");
 490 #endif
 491 }
 492 #endif
 493
 494 } // namespace simgrid::mc