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/remote/RemoteProcess.hpp"
  15 #if HAVE_SMPI
  16 #include "src/smpi/include/private.hpp"
  17 #endif
  18 #include "src/sthread/sthread.h"
  19 #include "src/xbt/coverage.h"
  20 #include "xbt/str.h"
  21 #include <simgrid/modelchecker.h>
  22
  23 #include <cerrno>
  24 #include <cstdio> // setvbuf
  25 #include <cstdlib>
  26 #include <memory>
  27 #include <numeric>
  28 #include <sys/ptrace.h>
  29 #include <sys/socket.h>
  30 #include <sys/types.h>
  31
  32 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  33 XBT_LOG_EXTERNAL_CATEGORY(mc_global);
  34
  35 namespace simgrid::mc {
  36
  37 std::unique_ptr<AppSide> AppSide::instance_;
  38
  39 AppSide* AppSide::initialize()
  40 {
  41   if (not std::getenv(MC_ENV_SOCKET_FD)) // We are not in MC mode: don't initialize the MC world
  42     return nullptr;
  43
  44   // Do not break if we are called multiple times:
  45   if (instance_)
  46     return instance_.get();
  47
  48   simgrid::mc::cfg_do_model_check = true;
  49
  50   setvbuf(stdout, nullptr, _IOLBF, 0);
  51
  52   // Fetch socket from MC_ENV_SOCKET_FD:
  53   const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
  54   int fd             = xbt_str_parse_int(fd_env, "Not a number in variable '" MC_ENV_SOCKET_FD "'");
  55   XBT_DEBUG("Model-checked application found socket FD %i", fd);
  56
  57   // Check the socket type/validity:
  58   int type;
  59   socklen_t socklen = sizeof(type);
  60   xbt_assert(getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) == 0, "Could not check socket type");
  61   xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type);
  62   XBT_DEBUG("Model-checked application found expected socket type");
  63
  64   instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
  65
  66   // Wait for the model-checker:
  67   errno = 0;
  68 #if defined __linux__
  69   ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
  70 #elif defined BSD
  71   ptrace(PT_TRACE_ME, 0, nullptr, 0);
  72 #else
  73 #error "no ptrace equivalent coded for this platform"
  74 #endif
  75   xbt_assert(errno == 0 && raise(SIGSTOP) == 0, "Could not wait for the model-checker (errno = %d: %s)", errno,
  76              strerror(errno));
  77
  78   s_mc_message_initial_addresses_t message = {};
  79   message.type                = MessageType::INITIAL_ADDRESSES;
  80   message.mmalloc_default_mdp = mmalloc_get_current_heap();
  81   message.maxpid              = kernel::actor::ActorImpl::get_maxpid_addr();
  82   xbt_assert(instance_->channel_.send(message) == 0, "Could not send the initial message with addresses.");
  83
  84   instance_->handle_messages();
  85   return instance_.get();
  86 }
  87
  88 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
  89 {
  90   const auto* engine     = kernel::EngineImpl::get_instance();
  91   const auto& actor_list = engine->get_actor_list();
  92   bool deadlock = not actor_list.empty() && std::none_of(begin(actor_list), end(actor_list), [](const auto& kv) {
  93     return mc::actor_is_enabled(kv.second);
  94   });
  95
  96   if (deadlock) {
  97     XBT_CINFO(mc_global, "**************************");
  98     XBT_CINFO(mc_global, "*** DEADLOCK DETECTED ***");
  99     XBT_CINFO(mc_global, "**************************");
 100     engine->display_all_actor_status();
 101   }
 102   // Send result:
 103   s_mc_message_int_t answer = {};
 104   answer.type  = MessageType::DEADLOCK_CHECK_REPLY;
 105   answer.value = deadlock;
 106   xbt_assert(channel_.send(answer) == 0, "Could not send response");
 107 }
 108 void AppSide::handle_simcall_execute(const s_mc_message_simcall_execute_t* message) const
 109 {
 110   kernel::actor::ActorImpl* actor = kernel::EngineImpl::get_instance()->get_actor_by_pid(message->aid_);
 111   xbt_assert(actor != nullptr, "Invalid pid %ld", message->aid_);
 112
 113   // The client may send some messages to the server while processing the transition
 114   actor->simcall_handle(message->times_considered_);
 115   // Say the server that the transition is over and that it should proceed
 116   xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
 117
 118   // Finish the RPC from the server: return a serialized observer, to build a Transition on Checker side
 119   s_mc_message_simcall_execute_answer_t answer = {};
 120   answer.type = MessageType::SIMCALL_EXECUTE_ANSWER;
 121   std::stringstream stream;
 122   if (actor->simcall_.observer_ != nullptr) {
 123     actor->simcall_.observer_->serialize(stream);
 124   } else {
 125     stream << (short)mc::Transition::Type::UNKNOWN;
 126   }
 127   std::string str = stream.str();
 128   xbt_assert(str.size() + 1 <= answer.buffer.size(),
 129              "The serialized simcall is too large for the buffer. Please fix the code.");
 130   strncpy(answer.buffer.data(), str.c_str(), answer.buffer.size() - 1);
 131   answer.buffer.back() = '\0';
 132
 133   XBT_DEBUG("send SIMCALL_EXECUTE_ANSWER(%s) ~> '%s'", actor->get_cname(), str.c_str());
 134   xbt_assert(channel_.send(answer) == 0, "Could not send response");
 135 }
 136
 137 void AppSide::handle_finalize(const s_mc_message_int_t* msg) const
 138 {
 139   bool terminate_asap = msg->value;
 140   XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
 141   if (not terminate_asap) {
 142     if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
 143       kernel::EngineImpl::get_instance()->display_all_actor_status();
 144 #if HAVE_SMPI
 145     XBT_DEBUG("Smpi_enabled: %d", SMPI_is_inited());
 146     if (SMPI_is_inited())
 147       SMPI_finalize();
 148 #endif
 149   }
 150   coverage_checkpoint();
 151   xbt_assert(channel_.send(MessageType::FINALIZE_REPLY) == 0, "Could not answer to FINALIZE");
 152   std::fflush(stdout);
 153   if (terminate_asap)
 154     ::_Exit(0);
 155 }
 156 void AppSide::handle_actors_status() const
 157 {
 158   auto const& actor_list = kernel::EngineImpl::get_instance()->get_actor_list();
 159   const int num_actors   = actor_list.size();
 160   XBT_DEBUG("Serialize the actors to answer ACTORS_STATUS from the checker. %d actors to go.", num_actors);
 161
 162   std::vector<s_mc_message_actors_status_one_t> status(num_actors);
 163   int i                 = 0;
 164   int total_transitions = 0;
 165
 166   for (auto const& [aid, actor] : actor_list) {
 167     status[i].aid            = aid;
 168     status[i].enabled        = mc::actor_is_enabled(actor);
 169     status[i].max_considered = actor->simcall_.observer_->get_max_consider();
 170     status[i].n_transitions  = mc::actor_is_enabled(actor) ? status[i].max_considered : 0;
 171     total_transitions += status[i].n_transitions;
 172     i++;
 173   }
 174
 175   struct s_mc_message_actors_status_answer_t answer = {};
 176   answer.type             = MessageType::ACTORS_STATUS_REPLY;
 177   answer.count            = num_actors;
 178   answer.transition_count = total_transitions;
 179
 180   xbt_assert(channel_.send(answer) == 0, "Could not send ACTORS_STATUS_REPLY msg");
 181   if (answer.count > 0) {
 182     size_t size = status.size() * sizeof(s_mc_message_actors_status_one_t);
 183     xbt_assert(channel_.send(status.data(), size) == 0, "Could not send ACTORS_STATUS_REPLY data");
 184   }
 185
 186   // Serialize each transition to describe what each actor is doing
 187   if (total_transitions > 0) {
 188     std::vector<s_mc_message_simcall_probe_one_t> probes(total_transitions);
 189     auto probes_iter = probes.begin();
 190
 191     for (const auto& actor_status : status) {
 192       if (not actor_status.enabled)
 193         continue;
 194
 195       const auto& actor        = actor_list.at(actor_status.aid);
 196       const int max_considered = actor_status.max_considered;
 197
 198       for (int times_considered = 0; times_considered < max_considered; times_considered++, probes_iter++) {
 199         std::stringstream stream;
 200         s_mc_message_simcall_probe_one_t& probe = *probes_iter;
 201
 202         if (actor->simcall_.observer_ != nullptr) {
 203           actor->simcall_.observer_->prepare(times_considered);
 204           actor->simcall_.observer_->serialize(stream);
 205         } else {
 206           stream << (short)mc::Transition::Type::UNKNOWN;
 207         }
 208
 209         std::string str = stream.str();
 210         xbt_assert(str.size() + 1 <= probe.buffer.size(),
 211                    "The serialized transition is too large for the buffer. Please fix the code.");
 212         strncpy(probe.buffer.data(), str.c_str(), probe.buffer.size() - 1);
 213         probe.buffer.back() = '\0';
 214       }
 215       // NOTE: We do NOT need to reset `times_considered` for each actor's
 216       // simcall observer here to the "original" value (i.e. the value BEFORE
 217       // multiple prepare() calls were made for serialization purposes) since
 218       // each SIMCALL_EXECUTE provides a `times_considered` to be used to prepare
 219       // the transition before execution.
 220     }
 221     XBT_DEBUG("Deliver ACTOR_TRANSITION_PROBE payload");
 222
 223     for (const auto& probe : probes)
 224       xbt_assert(channel_.send(probe) == 0, "Could not send ACTOR_TRANSITION_PROBE payload");
 225   }
 226 }
 227
 228 #define assert_msg_size(_name_, _type_)                                                                                \
 229   xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size,            \
 230              sizeof(_type_))
 231
 232 void AppSide::handle_messages() const
 233 {
 234   while (true) { // Until we get a CONTINUE message
 235     XBT_DEBUG("Waiting messages from model-checker");
 236
 237     std::array<char, MC_MESSAGE_LENGTH> message_buffer;
 238     ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
 239
 240     xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
 241     xbt_assert(static_cast<size_t>(received_size) >= sizeof(s_mc_message_t), "Cannot handle short message (size=%zd)",
 242                received_size);
 243
 244     const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
 245     switch (message->type) {
 246       case MessageType::DEADLOCK_CHECK:
 247         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 248         handle_deadlock_check(message);
 249         break;
 250
 251       case MessageType::CONTINUE:
 252         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 253         return;
 254
 255       case MessageType::SIMCALL_EXECUTE:
 256         assert_msg_size("SIMCALL_EXECUTE", s_mc_message_simcall_execute_t);
 257         handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data());
 258         break;
 259
 260       case MessageType::FINALIZE:
 261         assert_msg_size("FINALIZE", s_mc_message_int_t);
 262         handle_finalize((s_mc_message_int_t*)message_buffer.data());
 263         break;
 264
 265       case MessageType::ACTORS_STATUS:
 266         assert_msg_size("ACTORS_STATUS", s_mc_message_t);
 267         handle_actors_status();
 268         break;
 269
 270       default:
 271         xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
 272         break;
 273     }
 274   }
 275 }
 276
 277 void AppSide::main_loop() const
 278 {
 279   simgrid::mc::processes_time.resize(simgrid::kernel::actor::ActorImpl::get_maxpid());
 280   MC_ignore_heap(simgrid::mc::processes_time.data(),
 281                  simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0]));
 282
 283   sthread_disable();
 284   coverage_checkpoint();
 285   sthread_enable();
 286   while (true) {
 287     simgrid::mc::execute_actors();
 288     xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
 289     this->handle_messages();
 290   }
 291 }
 292
 293 void AppSide::report_assertion_failure() const
 294 {
 295   xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
 296   this->handle_messages();
 297 }
 298
 299 void AppSide::ignore_memory(void* addr, std::size_t size) const
 300 {
 301   if (not MC_is_active())
 302     return;
 303
 304   s_mc_message_ignore_memory_t message = {};
 305   message.type = MessageType::IGNORE_MEMORY;
 306   message.addr = (std::uintptr_t)addr;
 307   message.size = size;
 308   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
 309 }
 310
 311 void AppSide::ignore_heap(void* address, std::size_t size) const
 312 {
 313   if (not MC_is_active())
 314     return;
 315
 316   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 317
 318   s_mc_message_ignore_heap_t message = {};
 319   message.type    = MessageType::IGNORE_HEAP;
 320   message.address = address;
 321   message.size    = size;
 322   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 323   if (heap->heapinfo[message.block].type == 0) {
 324     message.fragment = -1;
 325     heap->heapinfo[message.block].busy_block.ignore++;
 326   } else {
 327     message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
 328     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 329   }
 330
 331   xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer");
 332 }
 333
 334 void AppSide::unignore_heap(void* address, std::size_t size) const
 335 {
 336   if (not MC_is_active())
 337     return;
 338
 339   s_mc_message_ignore_memory_t message = {};
 340   message.type = MessageType::UNIGNORE_HEAP;
 341   message.addr = (std::uintptr_t)address;
 342   message.size = size;
 343   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
 344 }
 345
 346 void AppSide::declare_symbol(const char* name, int* value) const
 347 {
 348   if (not MC_is_active())
 349     return;
 350
 351   s_mc_message_register_symbol_t message = {};
 352   message.type = MessageType::REGISTER_SYMBOL;
 353   xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
 354   strncpy(message.name.data(), name, message.name.size() - 1);
 355   message.callback = nullptr;
 356   message.data     = value;
 357   xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
 358 }
 359
 360 /** Register a stack in the model checker
 361  *
 362  *  The stacks are allocated in the heap. The MC handle them specifically
 363  *  when we analyze/compare the content of the heap so it must be told where
 364  *  they are with this function.
 365  */
 366 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
 367 {
 368   if (not MC_is_active())
 369     return;
 370
 371   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 372
 373   s_stack_region_t region = {};
 374   region.address = stack;
 375   region.context = context;
 376   region.size    = size;
 377   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 378
 379   s_mc_message_stack_region_t message = {};
 380   message.type         = MessageType::STACK_REGION;
 381   message.stack_region = region;
 382   xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
 383 }
 384 } // namespace simgrid::mc