src/mc/remote/Client.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/Client.hpp"
   7 #include "src/internal_config.h"
   8 #include <simgrid/modelchecker.h>
   9
  10 #include <cerrno>
  11 #include <cstdlib>
  12 #include <cstring>
  13 #include <sys/ptrace.h>
  14 #include <sys/socket.h>
  15 #include <sys/types.h>
  16
  17 // We won't need those once the separation MCer/MCed is complete:
  18 #include "src/mc/mc_smx.hpp"
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  21
  22 namespace simgrid {
  23 namespace mc {
  24
  25 std::unique_ptr<Client> Client::instance_;
  26
  27 Client* Client::initialize()
  28 {
  29   // We are not in MC mode:
  30   // TODO, handle this more gracefully.
  31   if (not std::getenv(MC_ENV_SOCKET_FD))
  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_.reset(new simgrid::mc::Client(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 Client::handle_deadlock_check(const s_mc_message_t*)
  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{MC_MESSAGE_DEADLOCK_CHECK_REPLY, deadlock};
  85   xbt_assert(channel_.send(answer) == 0, "Could not send response");
  86 }
  87 void Client::handle_continue(const s_mc_message_t*)
  88 {
  89   /* Nothing to do */
  90 }
  91 void Client::handle_simcall(const s_mc_message_simcall_handle_t* message)
  92 {
  93   smx_actor_t process = SIMIX_process_from_PID(message->pid);
  94   xbt_assert(process != nullptr, "Invalid pid %lu", message->pid);
  95   process->simcall_handle(message->value);
  96   if (channel_.send(MC_MESSAGE_WAITING))
  97     xbt_die("Could not send MESSAGE_WAITING to model-checker");
  98 }
  99
 100 void Client::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg)
 101 {
 102   bool res = simgrid::mc::actor_is_enabled(SIMIX_process_from_PID(msg->aid));
 103   s_mc_message_int_t answer{MC_MESSAGE_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 Client::handle_messages()
 112 {
 113   while (1) {
 114     XBT_DEBUG("Waiting messages from model-checker");
 115
 116     char message_buffer[MC_MESSAGE_LENGTH];
 117     ssize_t received_size = channel_.receive(&message_buffer, sizeof(message_buffer));
 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;
 122     switch (message->type) {
 123       case MC_MESSAGE_DEADLOCK_CHECK:
 124         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 125         handle_deadlock_check(message);
 126         break;
 127
 128       case MC_MESSAGE_CONTINUE:
 129         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 130         handle_continue(message);
 131         return;
 132
 133       case MC_MESSAGE_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);
 136         break;
 137
 138       case MC_MESSAGE_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);
 141         break;
 142
 143       default:
 144         xbt_die("Received unexpected message %s (%i)", MC_message_type_name(message->type), message->type);
 145         break;
 146     }
 147   }
 148 }
 149
 150 void Client::main_loop()
 151 {
 152   while (1) {
 153     simgrid::mc::wait_for_requests();
 154     xbt_assert(channel_.send(MC_MESSAGE_WAITING) == 0, "Could not send WAITING message to model-checker");
 155     this->handle_messages();
 156   }
 157 }
 158
 159 void Client::report_assertion_failure()
 160 {
 161   if (channel_.send(MC_MESSAGE_ASSERTION_FAILED))
 162     xbt_die("Could not send assertion to model-checker");
 163   this->handle_messages();
 164 }
 165
 166 void Client::ignore_memory(void* addr, std::size_t size)
 167 {
 168   s_mc_message_ignore_memory_t message;
 169   message.type = MC_MESSAGE_IGNORE_MEMORY;
 170   message.addr = (std::uintptr_t)addr;
 171   message.size = size;
 172   if (channel_.send(message))
 173     xbt_die("Could not send IGNORE_MEMORY mesage to model-checker");
 174 }
 175
 176 void Client::ignore_heap(void* address, std::size_t size)
 177 {
 178   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 179
 180   s_mc_message_ignore_heap_t message;
 181   message.type    = MC_MESSAGE_IGNORE_HEAP;
 182   message.address = address;
 183   message.size    = size;
 184   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 185   if (heap->heapinfo[message.block].type == 0) {
 186     message.fragment = -1;
 187     heap->heapinfo[message.block].busy_block.ignore++;
 188   } else {
 189     message.fragment = ((uintptr_t)(ADDR2UINT(address) % (BLOCKSIZE))) >> heap->heapinfo[message.block].type;
 190     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 191   }
 192
 193   if (channel_.send(message))
 194     xbt_die("Could not send ignored region to MCer");
 195 }
 196
 197 void Client::unignore_heap(void* address, std::size_t size)
 198 {
 199   s_mc_message_ignore_memory_t message;
 200   message.type = MC_MESSAGE_UNIGNORE_HEAP;
 201   message.addr = (std::uintptr_t)address;
 202   message.size = size;
 203   if (channel_.send(message))
 204     xbt_die("Could not send IGNORE_HEAP message to model-checker");
 205 }
 206
 207 void Client::declare_symbol(const char* name, int* value)
 208 {
 209   s_mc_message_register_symbol_t message;
 210   message.type = MC_MESSAGE_REGISTER_SYMBOL;
 211   if (strlen(name) + 1 > sizeof(message.name))
 212     xbt_die("Symbol is too long");
 213   strncpy(message.name, name, sizeof(message.name));
 214   message.callback = nullptr;
 215   message.data     = value;
 216   if (channel_.send(message))
 217     xbt_die("Could send REGISTER_SYMBOL message to model-checker");
 218 }
 219
 220 void Client::declare_stack(void* stack, size_t size, ucontext_t* context)
 221 {
 222   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 223
 224   s_stack_region_t region;
 225   memset(&region, 0, sizeof(region));
 226   region.address = stack;
 227   region.context = context;
 228   region.size    = size;
 229   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 230
 231   s_mc_message_stack_region_t message;
 232   message.type         = MC_MESSAGE_STACK_REGION;
 233   message.stack_region = region;
 234   if (channel_.send(message))
 235     xbt_die("Could not send STACK_REGION to model-checker");
 236 }
 237 } // namespace mc
 238 } // namespace simgrid