src/mc/remote/AppSide.cpp

   1 /* Copyright (c) 2015-2021. 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/actor/ActorImpl.hpp"
   9 #include <simgrid/modelchecker.h>
  10
  11 #include <cerrno>
  12 #include <cstdlib>
  13 #include <cstring>
  14 #include <memory>
  15 #include <sys/ptrace.h>
  16 #include <sys/socket.h>
  17 #include <sys/types.h>
  18
  19 // We won't need those once the separation MCer/MCed is complete:
  20 #include "src/mc/mc_smx.hpp"
  21
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  23
  24 namespace simgrid {
  25 namespace mc {
  26
  27 std::unique_ptr<AppSide> AppSide::instance_;
  28
  29 AppSide* AppSide::initialize()
  30 {
  31   if (not std::getenv(MC_ENV_SOCKET_FD)) // We are not in MC mode: don't initialize the MC world
  32     return nullptr;
  33
  34   // Do not break if we are called multiple times:
  35   if (instance_)
  36     return instance_.get();
  37
  38   _sg_do_model_check = 1;
  39
  40   // Fetch socket from MC_ENV_SOCKET_FD:
  41   const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
  42   int fd = xbt_str_parse_int(fd_env, "Variable '" MC_ENV_SOCKET_FD "' should contain a number but contains '%s'");
  43   XBT_DEBUG("Model-checked application found socket FD %i", fd);
  44
  45   // Check the socket type/validity:
  46   int type;
  47   socklen_t socklen = sizeof(type);
  48   if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0)
  49     xbt_die("Could not check socket type");
  50   xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type);
  51   XBT_DEBUG("Model-checked application found expected socket type");
  52
  53   instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
  54
  55   // Wait for the model-checker:
  56   errno = 0;
  57 #if defined __linux__
  58   ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
  59 #elif defined BSD
  60   ptrace(PT_TRACE_ME, 0, nullptr, 0);
  61 #else
  62 #error "no ptrace equivalent coded for this platform"
  63 #endif
  64   if (errno != 0 || raise(SIGSTOP) != 0)
  65     xbt_die("Could not wait for the model-checker (errno = %d: %s)", errno, strerror(errno));
  66
  67   instance_->handle_messages();
  68   return instance_.get();
  69 }
  70
  71 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
  72 {
  73   bool deadlock = false;
  74   if (not simix_global->process_list.empty()) {
  75     deadlock = true;
  76     for (auto const& kv : simix_global->process_list)
  77       if (simgrid::mc::actor_is_enabled(kv.second)) {
  78         deadlock = false;
  79         break;
  80       }
  81   }
  82
  83   // Send result:
  84   s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
  85   xbt_assert(channel_.send(answer) == 0, "Could not send response");
  86 }
  87 void AppSide::handle_continue(const s_mc_message_t*) const
  88 {
  89   /* Nothing to do */
  90 }
  91 void AppSide::handle_simcall(const s_mc_message_simcall_handle_t* message) const
  92 {
  93   kernel::actor::ActorImpl* process = kernel::actor::ActorImpl::by_PID(message->pid);
  94   xbt_assert(process != nullptr, "Invalid pid %lu", message->pid);
  95   process->simcall_handle(message->value);
  96   if (channel_.send(MessageType::WAITING))
  97     xbt_die("Could not send MESSAGE_WAITING to model-checker");
  98 }
  99
 100 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
 101 {
 102   bool res = simgrid::mc::actor_is_enabled(kernel::actor::ActorImpl::by_PID(msg->aid));
 103   s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
 104   channel_.send(answer);
 105 }
 106
 107 #define assert_msg_size(_name_, _type_)                                                                                \
 108   xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size,            \
 109              sizeof(_type_))
 110
 111 void AppSide::handle_messages() const
 112 {
 113   while (true) {
 114     XBT_DEBUG("Waiting messages from model-checker");
 115
 116     std::array<char, MC_MESSAGE_LENGTH> message_buffer;
 117     ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
 118
 119     xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
 120
 121     const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
 122     switch (message->type) {
 123       case MessageType::DEADLOCK_CHECK:
 124         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 125         handle_deadlock_check(message);
 126         break;
 127
 128       case MessageType::CONTINUE:
 129         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 130         handle_continue(message);
 131         return;
 132
 133       case MessageType::SIMCALL_HANDLE:
 134         assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t);
 135         handle_simcall((s_mc_message_simcall_handle_t*)message_buffer.data());
 136         break;
 137
 138       case MessageType::ACTOR_ENABLED:
 139         assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
 140         handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
 141         break;
 142
 143       default:
 144         xbt_die("Received unexpected message %s (%i)", MC_message_type_name(message->type),
 145                 static_cast<int>(message->type));
 146         break;
 147     }
 148   }
 149 }
 150
 151 void AppSide::main_loop() const
 152 {
 153   while (true) {
 154     simgrid::mc::wait_for_requests();
 155     xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
 156     this->handle_messages();
 157   }
 158 }
 159
 160 void AppSide::report_assertion_failure() const
 161 {
 162   if (channel_.send(MessageType::ASSERTION_FAILED))
 163     xbt_die("Could not send assertion to model-checker");
 164   this->handle_messages();
 165 }
 166
 167 void AppSide::ignore_memory(void* addr, std::size_t size) const
 168 {
 169   s_mc_message_ignore_memory_t message;
 170   message.type = MessageType::IGNORE_MEMORY;
 171   message.addr = (std::uintptr_t)addr;
 172   message.size = size;
 173   if (channel_.send(message))
 174     xbt_die("Could not send IGNORE_MEMORY message to model-checker");
 175 }
 176
 177 void AppSide::ignore_heap(void* address, std::size_t size) const
 178 {
 179   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 180
 181   s_mc_message_ignore_heap_t message;
 182   message.type    = MessageType::IGNORE_HEAP;
 183   message.address = address;
 184   message.size    = size;
 185   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 186   if (heap->heapinfo[message.block].type == 0) {
 187     message.fragment = -1;
 188     heap->heapinfo[message.block].busy_block.ignore++;
 189   } else {
 190     message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
 191     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 192   }
 193
 194   if (channel_.send(message))
 195     xbt_die("Could not send ignored region to MCer");
 196 }
 197
 198 void AppSide::unignore_heap(void* address, std::size_t size) const
 199 {
 200   s_mc_message_ignore_memory_t message;
 201   message.type = MessageType::UNIGNORE_HEAP;
 202   message.addr = (std::uintptr_t)address;
 203   message.size = size;
 204   if (channel_.send(message))
 205     xbt_die("Could not send IGNORE_HEAP message to model-checker");
 206 }
 207
 208 void AppSide::declare_symbol(const char* name, int* value) const
 209 {
 210   s_mc_message_register_symbol_t message;
 211   message.type = MessageType::REGISTER_SYMBOL;
 212   if (strlen(name) + 1 > message.name.size())
 213     xbt_die("Symbol is too long");
 214   strncpy(message.name.data(), name, message.name.size());
 215   message.callback = nullptr;
 216   message.data     = value;
 217   if (channel_.send(message))
 218     xbt_die("Could send REGISTER_SYMBOL message to model-checker");
 219 }
 220
 221 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
 222 {
 223   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 224
 225   s_stack_region_t region;
 226   memset(&region, 0, sizeof(region));
 227   region.address = stack;
 228   region.context = context;
 229   region.size    = size;
 230   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 231
 232   s_mc_message_stack_region_t message;
 233   message.type         = MessageType::STACK_REGION;
 234   message.stack_region = region;
 235   if (channel_.send(message))
 236     xbt_die("Could not send STACK_REGION to model-checker");
 237 }
 238 } // namespace mc
 239 } // namespace simgrid