src/mc/remote/AppSide.cpp

   1 /* Copyright (c) 2015-2022. 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 "src/internal_config.h"
   8 #include "src/kernel/EngineImpl.hpp"
   9 #include "src/kernel/actor/ActorImpl.hpp"
  10 #include "src/kernel/actor/SimcallObserver.hpp"
  11 #include "src/mc/mc_base.hpp"
  12 #include "src/mc/remote/RemoteProcess.hpp"
  13 #if HAVE_SMPI
  14 #include "src/smpi/include/private.hpp"
  15 #endif
  16 #include "xbt/coverage.h"
  17 #include "xbt/str.h"
  18 #include "xbt/xbt_modinter.h" /* mmalloc_preinit to get the default mmalloc arena address */
  19 #include <simgrid/modelchecker.h>
  20
  21 #include <cerrno>
  22 #include <cstdio> // setvbuf
  23 #include <cstdlib>
  24 #include <cstring>
  25 #include <memory>
  26 #include <sys/ptrace.h>
  27 #include <sys/socket.h>
  28 #include <sys/types.h>
  29
  30 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  31
  32 namespace simgrid {
  33 namespace mc {
  34
  35 std::unique_ptr<AppSide> AppSide::instance_;
  36
  37 AppSide* AppSide::initialize()
  38 {
  39   if (not std::getenv(MC_ENV_SOCKET_FD)) // We are not in MC mode: don't initialize the MC world
  40     return nullptr;
  41
  42   // Do not break if we are called multiple times:
  43   if (instance_)
  44     return instance_.get();
  45
  46   _sg_do_model_check = 1;
  47
  48   setvbuf(stdout, nullptr, _IOLBF, 0);
  49
  50   // Fetch socket from MC_ENV_SOCKET_FD:
  51   const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
  52   int fd             = xbt_str_parse_int(fd_env, "Not a number in variable '" MC_ENV_SOCKET_FD "'");
  53   XBT_DEBUG("Model-checked application found socket FD %i", fd);
  54
  55   // Check the socket type/validity:
  56   int type;
  57   socklen_t socklen = sizeof(type);
  58   xbt_assert(getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) == 0, "Could not check socket type");
  59   xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type);
  60   XBT_DEBUG("Model-checked application found expected socket type");
  61
  62   instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
  63
  64   // Wait for the model-checker:
  65   errno = 0;
  66 #if defined __linux__
  67   ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
  68 #elif defined BSD
  69   ptrace(PT_TRACE_ME, 0, nullptr, 0);
  70 #else
  71 #error "no ptrace equivalent coded for this platform"
  72 #endif
  73   xbt_assert(errno == 0 && raise(SIGSTOP) == 0, "Could not wait for the model-checker (errno = %d: %s)", errno,
  74              strerror(errno));
  75
  76   s_mc_message_initial_addresses_t message{MessageType::INITIAL_ADDRESSES, mmalloc_preinit(),
  77                                            kernel::actor::get_maxpid_addr(), kernel::get_actors_addr(),
  78                                            kernel::get_dead_actors_addr()};
  79   xbt_assert(instance_->channel_.send(message) == 0, "Could not send the initial message with addresses.");
  80
  81   instance_->handle_messages();
  82   return instance_.get();
  83 }
  84
  85 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
  86 {
  87   const auto& actor_list = kernel::EngineImpl::get_instance()->get_actor_list();
  88   bool deadlock = not actor_list.empty() && std::none_of(begin(actor_list), end(actor_list), [](const auto& kv) {
  89     return mc::actor_is_enabled(kv.second);
  90   });
  91
  92   // Send result:
  93   s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
  94   xbt_assert(channel_.send(answer) == 0, "Could not send response");
  95 }
  96 void AppSide::handle_simcall_execute(const s_mc_message_simcall_handle_t* message) const
  97 {
  98   kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(message->aid_);
  99   xbt_assert(actor != nullptr, "Invalid pid %ld", message->aid_);
 100   if (actor->simcall_.observer_ != nullptr)
 101     actor->observer_stack_.push_back(actor->simcall_.observer_->clone());
 102   actor->simcall_handle(message->times_considered_);
 103   xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
 104 }
 105
 106 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
 107 {
 108   bool res = mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
 109   s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
 110   xbt_assert(channel_.send(answer) == 0, "Could not send ACTOR_ENABLED_REPLY");
 111 }
 112
 113 #define assert_msg_size(_name_, _type_)                                                                                \
 114   xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size,            \
 115              sizeof(_type_))
 116
 117 void AppSide::handle_messages() const
 118 {
 119   while (true) { // Until we get a CONTINUE message
 120     XBT_DEBUG("Waiting messages from model-checker");
 121
 122     std::array<char, MC_MESSAGE_LENGTH> message_buffer;
 123     ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
 124
 125     xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
 126
 127     const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
 128     switch (message->type) {
 129       case MessageType::DEADLOCK_CHECK:
 130         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 131         handle_deadlock_check(message);
 132         break;
 133
 134       case MessageType::CONTINUE:
 135         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 136         return;
 137
 138       case MessageType::SIMCALL_HANDLE:
 139         assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t);
 140         handle_simcall_execute((s_mc_message_simcall_handle_t*)message_buffer.data());
 141         break;
 142
 143       case MessageType::SIMCALL_IS_VISIBLE: {
 144         assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
 145         auto msg_simcall                = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
 146         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
 147         xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
 148         xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
 149         bool value = actor->simcall_.observer_->is_visible();
 150
 151         // Send result:
 152         s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
 153         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 154         break;
 155       }
 156
 157       case MessageType::SIMCALL_TO_STRING: {
 158         assert_msg_size("SIMCALL_TO_STRING", s_mc_message_simcall_to_string_t);
 159         auto msg_simcall                = (s_mc_message_simcall_to_string_t*)message_buffer.data();
 160         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
 161         xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
 162         xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
 163         std::string value = actor->simcall_.observer_->to_string(msg_simcall->time_considered);
 164
 165         // Send result:
 166         s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
 167         value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
 168         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 169         break;
 170       }
 171
 172       case MessageType::SIMCALL_DOT_LABEL: {
 173         assert_msg_size("SIMCALL_DOT_LABEL", s_mc_message_simcall_to_string_t);
 174         auto msg_simcall                = (s_mc_message_simcall_to_string_t*)message_buffer.data();
 175         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
 176         xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
 177         xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
 178         std::string value = actor->simcall_.observer_->dot_label();
 179
 180         // Send result:
 181         s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
 182         value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
 183         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 184         break;
 185       }
 186
 187       case MessageType::ACTOR_ENABLED:
 188         assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
 189         handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
 190         break;
 191
 192       case MessageType::FINALIZE: {
 193         assert_msg_size("FINALIZE", s_mc_message_int_t);
 194         bool terminate_asap = ((s_mc_message_int_t*)message_buffer.data())->value;
 195         XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
 196         if (not terminate_asap) {
 197           if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
 198             kernel::EngineImpl::get_instance()->display_all_actor_status();
 199 #if HAVE_SMPI
 200           XBT_DEBUG("Smpi_enabled: %d", (int)smpi_enabled());
 201           if (smpi_enabled())
 202             SMPI_finalize();
 203 #endif
 204         }
 205         coverage_checkpoint();
 206         xbt_assert(channel_.send(MessageType::DEADLOCK_CHECK_REPLY) == 0, // DEADLOCK_CHECK_REPLY, really?
 207                    "Could not answer to FINALIZE");
 208         std::fflush(stdout);
 209         if (terminate_asap)
 210           ::_Exit(0);
 211         break;
 212       }
 213
 214       default:
 215         xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
 216         break;
 217     }
 218   }
 219 }
 220
 221 void AppSide::main_loop() const
 222 {
 223   coverage_checkpoint();
 224   while (true) {
 225     simgrid::mc::execute_actors();
 226     xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
 227     this->handle_messages();
 228   }
 229 }
 230
 231 void AppSide::report_assertion_failure() const
 232 {
 233   xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
 234   this->handle_messages();
 235 }
 236
 237 void AppSide::ignore_memory(void* addr, std::size_t size) const
 238 {
 239   s_mc_message_ignore_memory_t message;
 240   message.type = MessageType::IGNORE_MEMORY;
 241   message.addr = (std::uintptr_t)addr;
 242   message.size = size;
 243   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
 244 }
 245
 246 void AppSide::ignore_heap(void* address, std::size_t size) const
 247 {
 248   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 249
 250   s_mc_message_ignore_heap_t message;
 251   message.type    = MessageType::IGNORE_HEAP;
 252   message.address = address;
 253   message.size    = size;
 254   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 255   if (heap->heapinfo[message.block].type == 0) {
 256     message.fragment = -1;
 257     heap->heapinfo[message.block].busy_block.ignore++;
 258   } else {
 259     message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
 260     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 261   }
 262
 263   xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer");
 264 }
 265
 266 void AppSide::unignore_heap(void* address, std::size_t size) const
 267 {
 268   s_mc_message_ignore_memory_t message;
 269   message.type = MessageType::UNIGNORE_HEAP;
 270   message.addr = (std::uintptr_t)address;
 271   message.size = size;
 272   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
 273 }
 274
 275 void AppSide::declare_symbol(const char* name, int* value) const
 276 {
 277   s_mc_message_register_symbol_t message;
 278   message.type = MessageType::REGISTER_SYMBOL;
 279   xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
 280   strncpy(message.name.data(), name, message.name.size());
 281   message.callback = nullptr;
 282   message.data     = value;
 283   xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
 284 }
 285
 286 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
 287 {
 288   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 289
 290   s_stack_region_t region;
 291   memset(&region, 0, sizeof(region));
 292   region.address = stack;
 293   region.context = context;
 294   region.size    = size;
 295   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 296
 297   s_mc_message_stack_region_t message;
 298   message.type         = MessageType::STACK_REGION;
 299   message.stack_region = region;
 300   xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
 301 }
 302 } // namespace mc
 303 } // namespace simgrid