src/mc/remote/AppSide.cpp

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