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 "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/remote/RemoteProcess.hpp"
  14 #if HAVE_SMPI
  15 #include "src/smpi/include/private.hpp"
  16 #endif
  17 #include "xbt/coverage.h"
  18 #include "xbt/str.h"
  19 #include "xbt/xbt_modinter.h" /* mmalloc_preinit to get the default mmalloc arena address */
  20 #include <simgrid/modelchecker.h>
  21
  22 #include <cerrno>
  23 #include <cstdio> // setvbuf
  24 #include <cstdlib>
  25 #include <cstring>
  26 #include <memory>
  27 #include <sys/ptrace.h>
  28 #include <sys/socket.h>
  29 #include <sys/types.h>
  30
  31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  32
  33 namespace simgrid {
  34 namespace mc {
  35
  36 std::unique_ptr<AppSide> AppSide::instance_;
  37
  38 AppSide* AppSide::initialize()
  39 {
  40   if (not std::getenv(MC_ENV_SOCKET_FD)) // We are not in MC mode: don't initialize the MC world
  41     return nullptr;
  42
  43   // Do not break if we are called multiple times:
  44   if (instance_)
  45     return instance_.get();
  46
  47   _sg_do_model_check = 1;
  48
  49   setvbuf(stdout, nullptr, _IOLBF, 0);
  50
  51   // Fetch socket from MC_ENV_SOCKET_FD:
  52   const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
  53   int fd             = xbt_str_parse_int(fd_env, "Not a number in variable '" MC_ENV_SOCKET_FD "'");
  54   XBT_DEBUG("Model-checked application found socket FD %i", fd);
  55
  56   // Check the socket type/validity:
  57   int type;
  58   socklen_t socklen = sizeof(type);
  59   xbt_assert(getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) == 0, "Could not check socket type");
  60   xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type);
  61   XBT_DEBUG("Model-checked application found expected socket type");
  62
  63   instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
  64
  65   // Wait for the model-checker:
  66   errno = 0;
  67 #if defined __linux__
  68   ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
  69 #elif defined BSD
  70   ptrace(PT_TRACE_ME, 0, nullptr, 0);
  71 #else
  72 #error "no ptrace equivalent coded for this platform"
  73 #endif
  74   xbt_assert(errno == 0 && raise(SIGSTOP) == 0, "Could not wait for the model-checker (errno = %d: %s)", errno,
  75              strerror(errno));
  76
  77   s_mc_message_initial_addresses_t message{MessageType::INITIAL_ADDRESSES, mmalloc_preinit(),
  78                                            kernel::actor::get_maxpid_addr(), kernel::get_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_execute_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
 101   // The client may send some messages to the server while processing the transition
 102   actor->simcall_handle(message->times_considered_);
 103   // Say the server that the transition is over and that it should proceed
 104   xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
 105
 106   // Finish the RPC from the server: return a serialized observer, to build a Transition on Checker side
 107   s_mc_message_simcall_execute_answer_t answer;
 108   memset(&answer, 0, sizeof(answer));
 109   answer.type = MessageType::SIMCALL_EXECUTE_ANSWER;
 110   std::stringstream stream;
 111   if (actor->simcall_.observer_ != nullptr) {
 112     actor->simcall_.observer_->serialize(stream);
 113   } else {
 114     stream << (short)mc::Transition::Type::UNKNOWN;
 115   }
 116   std::string str = stream.str();
 117   xbt_assert(str.size() + 1 <= answer.buffer.size(),
 118              "The serialized simcall is too large for the buffer. Please fix the code.");
 119   strncpy(answer.buffer.data(), str.c_str(), answer.buffer.size() - 1);
 120   answer.buffer.back() = '\0';
 121
 122   XBT_DEBUG("send SIMCALL_EXECUTE_ANSWER(%s) ~> '%s'", actor->get_cname(), str.c_str());
 123   xbt_assert(channel_.send(answer) == 0, "Could not send response");
 124 }
 125
 126 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
 127 {
 128   bool res = mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
 129   s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
 130   XBT_DEBUG("Actor %ld %s enabled", msg->aid, (res ? "IS" : "is NOT"));
 131   xbt_assert(channel_.send(answer) == 0, "Could not send ACTOR_ENABLED_REPLY");
 132 }
 133
 134 void AppSide::handle_finalize(const s_mc_message_int_t* msg) const
 135 {
 136   bool terminate_asap = msg->value;
 137   XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
 138   if (not terminate_asap) {
 139     if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
 140       kernel::EngineImpl::get_instance()->display_all_actor_status();
 141 #if HAVE_SMPI
 142     XBT_DEBUG("Smpi_enabled: %d", (int)smpi_enabled());
 143     if (smpi_enabled())
 144       SMPI_finalize();
 145 #endif
 146   }
 147   coverage_checkpoint();
 148   xbt_assert(channel_.send(MessageType::DEADLOCK_CHECK_REPLY) == 0, // DEADLOCK_CHECK_REPLY, really?
 149              "Could not answer to FINALIZE");
 150   std::fflush(stdout);
 151   if (terminate_asap)
 152     ::_Exit(0);
 153 }
 154
 155 #define assert_msg_size(_name_, _type_)                                                                                \
 156   xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size,            \
 157              sizeof(_type_))
 158
 159 void AppSide::handle_messages() const
 160 {
 161   while (true) { // Until we get a CONTINUE message
 162     XBT_DEBUG("Waiting messages from model-checker");
 163
 164     std::array<char, MC_MESSAGE_LENGTH> message_buffer;
 165     ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
 166
 167     xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
 168
 169     const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
 170     switch (message->type) {
 171       case MessageType::DEADLOCK_CHECK:
 172         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 173         handle_deadlock_check(message);
 174         break;
 175
 176       case MessageType::CONTINUE:
 177         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 178         return;
 179
 180       case MessageType::SIMCALL_EXECUTE:
 181         assert_msg_size("SIMCALL_EXECUTE", s_mc_message_simcall_execute_t);
 182         handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data());
 183         break;
 184
 185       case MessageType::ACTOR_ENABLED:
 186         assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
 187         handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
 188         break;
 189
 190       case MessageType::FINALIZE:
 191         assert_msg_size("FINALIZE", s_mc_message_int_t);
 192         handle_finalize((s_mc_message_int_t*)message_buffer.data());
 193         break;
 194
 195       default:
 196         xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
 197         break;
 198     }
 199   }
 200 }
 201
 202 void AppSide::main_loop() const
 203 {
 204   coverage_checkpoint();
 205   while (true) {
 206     simgrid::mc::execute_actors();
 207     xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
 208     this->handle_messages();
 209   }
 210 }
 211
 212 void AppSide::report_assertion_failure() const
 213 {
 214   xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
 215   this->handle_messages();
 216 }
 217
 218 void AppSide::ignore_memory(void* addr, std::size_t size) const
 219 {
 220   s_mc_message_ignore_memory_t message;
 221   message.type = MessageType::IGNORE_MEMORY;
 222   message.addr = (std::uintptr_t)addr;
 223   message.size = size;
 224   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
 225 }
 226
 227 void AppSide::ignore_heap(void* address, std::size_t size) const
 228 {
 229   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 230
 231   s_mc_message_ignore_heap_t message;
 232   message.type    = MessageType::IGNORE_HEAP;
 233   message.address = address;
 234   message.size    = size;
 235   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 236   if (heap->heapinfo[message.block].type == 0) {
 237     message.fragment = -1;
 238     heap->heapinfo[message.block].busy_block.ignore++;
 239   } else {
 240     message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
 241     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 242   }
 243
 244   xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer");
 245 }
 246
 247 void AppSide::unignore_heap(void* address, std::size_t size) const
 248 {
 249   s_mc_message_ignore_memory_t message;
 250   message.type = MessageType::UNIGNORE_HEAP;
 251   message.addr = (std::uintptr_t)address;
 252   message.size = size;
 253   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
 254 }
 255
 256 void AppSide::declare_symbol(const char* name, int* value) const
 257 {
 258   s_mc_message_register_symbol_t message;
 259   memset(&message, 0, sizeof(message));
 260   message.type = MessageType::REGISTER_SYMBOL;
 261   xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
 262   strncpy(message.name.data(), name, message.name.size());
 263   message.callback = nullptr;
 264   message.data     = value;
 265   xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
 266 }
 267
 268 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
 269 {
 270   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 271
 272   s_stack_region_t region;
 273   memset(&region, 0, sizeof(region));
 274   region.address = stack;
 275   region.context = context;
 276   region.size    = size;
 277   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 278
 279   s_mc_message_stack_region_t message;
 280   message.type         = MessageType::STACK_REGION;
 281   message.stack_region = region;
 282   xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
 283 }
 284 } // namespace mc
 285 } // namespace simgrid