src/mc/remote/Client.cpp

   1 /* Copyright (c) 2015-2019. 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   char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
  42   if (not fd_env)
  43     xbt_die("No MC socket passed in the environment");
  44   int fd =
  45       xbt_str_parse_int(fd_env, bprintf("Variable %s should contain a number but contains '%%s'", MC_ENV_SOCKET_FD));
  46   XBT_DEBUG("Model-checked application found socket FD %i", fd);
  47
  48   // Check the socket type/validity:
  49   int type;
  50   socklen_t socklen = sizeof(type);
  51   if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0)
  52     xbt_die("Could not check socket type");
  53   if (type != SOCK_SEQPACKET)
  54     xbt_die("Unexpected socket type %i", type);
  55   XBT_DEBUG("Model-checked application found expected socket type");
  56
  57   instance_.reset(new simgrid::mc::Client(fd));
  58
  59   // Wait for the model-checker:
  60   errno = 0;
  61 #if defined __linux__
  62   ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
  63 #elif defined BSD
  64   ptrace(PT_TRACE_ME, 0, nullptr, 0);
  65 #else
  66 #error "no ptrace equivalent coded for this platform"
  67 #endif
  68   if (errno != 0 || raise(SIGSTOP) != 0)
  69     xbt_die("Could not wait for the model-checker (errno = %d: %s)", errno, strerror(errno));
  70
  71   instance_->handleMessages();
  72   return instance_.get();
  73 }
  74
  75 void Client::handleDeadlockCheck(s_mc_message_t*)
  76 {
  77   bool deadlock = false;
  78   if (not simix_global->process_list.empty()) {
  79     deadlock = true;
  80     for (auto const& kv : simix_global->process_list)
  81       if (simgrid::mc::actor_is_enabled(kv.second)) {
  82         deadlock = false;
  83         break;
  84       }
  85   }
  86
  87   // Send result:
  88   s_mc_message_int_t answer{MC_MESSAGE_DEADLOCK_CHECK_REPLY, deadlock};
  89   xbt_assert(channel_.send(answer) == 0, "Could not send response");
  90 }
  91 void Client::handleContinue(s_mc_message_t*)
  92 {
  93   /* Nothing to do */
  94 }
  95 void Client::handleSimcall(s_mc_message_simcall_handle_t* message)
  96 {
  97   smx_actor_t process = SIMIX_process_from_PID(message->pid);
  98   if (not process)
  99     xbt_die("Invalid pid %lu", (unsigned long)message->pid);
 100   SIMIX_simcall_handle(&process->simcall, message->value);
 101   if (channel_.send(MC_MESSAGE_WAITING))
 102     xbt_die("Could not send MESSAGE_WAITING to model-checker");
 103 }
 104
 105 void Client::handleActorEnabled(s_mc_message_actor_enabled_t* msg)
 106 {
 107   bool res = simgrid::mc::actor_is_enabled(SIMIX_process_from_PID(msg->aid));
 108   s_mc_message_int_t answer{MC_MESSAGE_ACTOR_ENABLED_REPLY, res};
 109   channel_.send(answer);
 110 }
 111
 112 void Client::handleMessages()
 113 {
 114   while (1) {
 115     XBT_DEBUG("Waiting messages from model-checker");
 116
 117     char message_buffer[MC_MESSAGE_LENGTH];
 118     ssize_t received_size = channel_.receive(&message_buffer, sizeof(message_buffer));
 119
 120     if (received_size < 0)
 121       xbt_die("Could not receive commands from the model-checker");
 122
 123     s_mc_message_t* message = (s_mc_message_t*)message_buffer;
 124     switch (message->type) {
 125
 126       case MC_MESSAGE_DEADLOCK_CHECK:
 127         xbt_assert(received_size == sizeof(s_mc_message_t), "Unexpected size for DEADLOCK_CHECK (%zd != %zu)",
 128                    received_size, sizeof(s_mc_message_t));
 129         handleDeadlockCheck(message);
 130         break;
 131
 132       case MC_MESSAGE_CONTINUE:
 133         xbt_assert(received_size == sizeof(s_mc_message_t), "Unexpected size for MESSAGE_CONTINUE (%zd != %zu)",
 134                    received_size, sizeof(s_mc_message_t));
 135         handleContinue(message);
 136         return;
 137
 138       case MC_MESSAGE_SIMCALL_HANDLE:
 139         xbt_assert(received_size == sizeof(s_mc_message_simcall_handle_t),
 140                    "Unexpected size for SIMCALL_HANDLE (%zd != %zu)", received_size,
 141                    sizeof(s_mc_message_simcall_handle_t));
 142         handleSimcall((s_mc_message_simcall_handle_t*)message_buffer);
 143         break;
 144
 145       case MC_MESSAGE_ACTOR_ENABLED:
 146         xbt_assert(received_size == sizeof(s_mc_message_actor_enabled_t),
 147                    "Unexpected size for ACTOR_ENABLED (%zd != %zu)", received_size,
 148                    sizeof(s_mc_message_actor_enabled_t));
 149         handleActorEnabled((s_mc_message_actor_enabled_t*)message_buffer);
 150         break;
 151
 152       default:
 153         xbt_die("Received unexpected message %s (%i)", MC_message_type_name(message->type), message->type);
 154         break;
 155     }
 156   }
 157 }
 158
 159 void Client::mainLoop()
 160 {
 161   while (1) {
 162     simgrid::mc::wait_for_requests();
 163     xbt_assert(channel_.send(MC_MESSAGE_WAITING) == 0, "Could not send WAITING message to model-checker");
 164     this->handleMessages();
 165   }
 166 }
 167
 168 void Client::reportAssertionFailure()
 169 {
 170   if (channel_.send(MC_MESSAGE_ASSERTION_FAILED))
 171     xbt_die("Could not send assertion to model-checker");
 172   this->handleMessages();
 173 }
 174
 175 void Client::ignoreMemory(void* addr, std::size_t size)
 176 {
 177   s_mc_message_ignore_memory_t message;
 178   message.type = MC_MESSAGE_IGNORE_MEMORY;
 179   message.addr = (std::uintptr_t)addr;
 180   message.size = size;
 181   if (channel_.send(message))
 182     xbt_die("Could not send IGNORE_MEMORY mesage to model-checker");
 183 }
 184
 185 void Client::ignoreHeap(void* address, std::size_t size)
 186 {
 187   xbt_mheap_t heap = mmalloc_get_current_heap();
 188
 189   s_mc_message_ignore_heap_t message;
 190   message.type    = MC_MESSAGE_IGNORE_HEAP;
 191   message.address = address;
 192   message.size    = size;
 193   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 194   if (heap->heapinfo[message.block].type == 0) {
 195     message.fragment = -1;
 196     heap->heapinfo[message.block].busy_block.ignore++;
 197   } else {
 198     message.fragment = ((uintptr_t)(ADDR2UINT(address) % (BLOCKSIZE))) >> heap->heapinfo[message.block].type;
 199     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 200   }
 201
 202   if (channel_.send(message))
 203     xbt_die("Could not send ignored region to MCer");
 204 }
 205
 206 void Client::unignoreHeap(void* address, std::size_t size)
 207 {
 208   s_mc_message_ignore_memory_t message;
 209   message.type = MC_MESSAGE_UNIGNORE_HEAP;
 210   message.addr = (std::uintptr_t)address;
 211   message.size = size;
 212   if (channel_.send(message))
 213     xbt_die("Could not send IGNORE_HEAP message to model-checker");
 214 }
 215
 216 void Client::declareSymbol(const char* name, int* value)
 217 {
 218   s_mc_message_register_symbol_t message;
 219   message.type = MC_MESSAGE_REGISTER_SYMBOL;
 220   if (strlen(name) + 1 > sizeof(message.name))
 221     xbt_die("Symbol is too long");
 222   strncpy(message.name, name, sizeof(message.name));
 223   message.callback = nullptr;
 224   message.data     = value;
 225   if (channel_.send(message))
 226     xbt_die("Could send REGISTER_SYMBOL message to model-checker");
 227 }
 228
 229 void Client::declareStack(void* stack, size_t size, smx_actor_t process, ucontext_t* context)
 230 {
 231   xbt_mheap_t heap = mmalloc_get_current_heap();
 232
 233   s_stack_region_t region;
 234   memset(&region, 0, sizeof(region));
 235   region.address = stack;
 236   region.context = context;
 237   region.size    = size;
 238   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 239 #if HAVE_SMPI
 240   if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP && process)
 241     region.process_index = process->get_pid() - 1;
 242   else
 243 #endif
 244     region.process_index = -1;
 245
 246   s_mc_message_stack_region_t message;
 247   message.type         = MC_MESSAGE_STACK_REGION;
 248   message.stack_region = region;
 249   if (channel_.send(message))
 250     xbt_die("Could not send STACK_REGION to model-checker");
 251 }
 252 }
 253 }