src/mc/remote/Client.cpp

   1 /* Copyright (c) 2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <cerrno>
   8 #include <cstdlib>
   9
  10 #include <sys/ptrace.h>
  11 #include <sys/socket.h>
  12 #include <sys/types.h>
  13
  14 #include <xbt/log.h>
  15 #include <xbt/mmalloc.h>
  16 #include <xbt/swag.h>
  17 #include <xbt/sysdep.h>
  18
  19 #include <simgrid/modelchecker.h>
  20
  21 #include "src/internal_config.h"
  22
  23 #include "src/mc/mc_request.h"
  24 #include "src/mc/remote/Client.hpp"
  25 #include "src/mc/remote/mc_protocol.h"
  26
  27 // We won't need those once the separation MCer/MCed is complete:
  28 #include "src/mc/mc_smx.h"
  29
  30 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  31
  32 namespace simgrid {
  33 namespace mc {
  34
  35 std::unique_ptr<Client> Client::client_;
  36
  37 Client* Client::initialize()
  38 {
  39   // We are not in MC mode:
  40   // TODO, handle this more gracefully.
  41   if (not std::getenv(MC_ENV_SOCKET_FD))
  42     return nullptr;
  43
  44   // Do not break if we are called multiple times:
  45   if (client_)
  46     return client_.get();
  47
  48   _sg_do_model_check = 1;
  49
  50   // Fetch socket from MC_ENV_SOCKET_FD:
  51   char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
  52   if (not fd_env)
  53     xbt_die("No MC socket passed in the environment");
  54   int fd =
  55       xbt_str_parse_int(fd_env, bprintf("Variable %s should contain a number but contains '%%s'", MC_ENV_SOCKET_FD));
  56   XBT_DEBUG("Model-checked application found socket FD %i", fd);
  57
  58   // Check the socket type/validity:
  59   int type;
  60   socklen_t socklen = sizeof(type);
  61   if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0)
  62     xbt_die("Could not check socket type");
  63   if (type != SOCK_DGRAM)
  64     xbt_die("Unexpected socket type %i", type);
  65   XBT_DEBUG("Model-checked application found expected socket type");
  66
  67   client_ = std::unique_ptr<Client>(new simgrid::mc::Client(fd));
  68
  69   // Wait for the model-checker:
  70   errno = 0;
  71 #if defined __linux__
  72   ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
  73 #elif defined BSD
  74   ptrace(PT_TRACE_ME, 0, nullptr, 0);
  75 #else
  76 #error "no ptrace equivalent coded for this platform"
  77 #endif
  78   if (errno != 0 || raise(SIGSTOP) != 0)
  79     xbt_die("Could not wait for the model-checker");
  80
  81   client_->handleMessages();
  82   return client_.get();
  83 }
  84
  85 void Client::handleMessages()
  86 {
  87   while (1) {
  88     XBT_DEBUG("Waiting messages from model-checker");
  89
  90     char message_buffer[MC_MESSAGE_LENGTH];
  91     ssize_t received_size;
  92
  93     if ((received_size = channel_.receive(&message_buffer, sizeof(message_buffer))) < 0)
  94       xbt_die("Could not receive commands from the model-checker");
  95
  96     s_mc_message_t message;
  97     if ((size_t)received_size < sizeof(message))
  98       xbt_die("Received message is too small");
  99     memcpy(&message, message_buffer, sizeof(message));
 100     switch (message.type) {
 101
 102       case MC_MESSAGE_DEADLOCK_CHECK: {
 103         // Check deadlock:
 104         bool deadlock = false;
 105         if (not simix_global->process_list.empty()) {
 106           deadlock = true;
 107           for (auto kv : simix_global->process_list)
 108             if (simgrid::mc::actor_is_enabled(kv.second)) {
 109               deadlock = false;
 110               break;
 111             }
 112         }
 113
 114         // Send result:
 115         s_mc_int_message_t answer;
 116         answer.type  = MC_MESSAGE_DEADLOCK_CHECK_REPLY;
 117         answer.value = deadlock;
 118         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 119       } break;
 120
 121       case MC_MESSAGE_CONTINUE:
 122         return;
 123
 124       case MC_MESSAGE_SIMCALL_HANDLE: {
 125         s_mc_simcall_handle_message_t message;
 126         if (received_size != sizeof(message))
 127           xbt_die("Unexpected size for SIMCALL_HANDLE");
 128         memcpy(&message, message_buffer, sizeof(message));
 129         smx_actor_t process = SIMIX_process_from_PID(message.pid);
 130         if (not process)
 131           xbt_die("Invalid pid %lu", (unsigned long)message.pid);
 132         SIMIX_simcall_handle(&process->simcall, message.value);
 133         if (channel_.send(MC_MESSAGE_WAITING))
 134           xbt_die("Could not send MESSAGE_WAITING to model-checker");
 135       } break;
 136
 137       case MC_MESSAGE_RESTORE: {
 138         s_mc_restore_message_t message;
 139         if (received_size != sizeof(message))
 140           xbt_die("Unexpected size for SIMCALL_HANDLE");
 141         memcpy(&message, message_buffer, sizeof(message));
 142 #if HAVE_SMPI
 143         smpi_really_switch_data_segment(message.index);
 144 #endif
 145       } break;
 146
 147       default:
 148         xbt_die("Received unexpected message %s (%i)", MC_message_type_name(message.type), message.type);
 149     }
 150   }
 151 }
 152
 153 void Client::mainLoop()
 154 {
 155   while (1) {
 156     simgrid::mc::wait_for_requests();
 157     xbt_assert(channel_.send(MC_MESSAGE_WAITING) == 0, "Could not send WAITING message to model-checker");
 158     this->handleMessages();
 159   }
 160 }
 161
 162 void Client::reportAssertionFailure(const char* description)
 163 {
 164   if (channel_.send(MC_MESSAGE_ASSERTION_FAILED))
 165     xbt_die("Could not send assertion to model-checker");
 166   this->handleMessages();
 167 }
 168
 169 void Client::ignoreMemory(void* addr, std::size_t size)
 170 {
 171   s_mc_ignore_memory_message_t message;
 172   message.type = MC_MESSAGE_IGNORE_MEMORY;
 173   message.addr = (std::uintptr_t)addr;
 174   message.size = size;
 175   if (channel_.send(message))
 176     xbt_die("Could not send IGNORE_MEMORY mesage to model-checker");
 177 }
 178
 179 void Client::ignoreHeap(void* address, std::size_t size)
 180 {
 181   xbt_mheap_t heap = mmalloc_get_current_heap();
 182
 183   s_mc_ignore_heap_message_t message;
 184   message.type    = MC_MESSAGE_IGNORE_HEAP;
 185   message.address = address;
 186   message.size    = size;
 187   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 188   if (heap->heapinfo[message.block].type == 0) {
 189     message.fragment = -1;
 190     heap->heapinfo[message.block].busy_block.ignore++;
 191   } else {
 192     message.fragment = ((uintptr_t)(ADDR2UINT(address) % (BLOCKSIZE))) >> heap->heapinfo[message.block].type;
 193     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 194   }
 195
 196   if (channel_.send(message))
 197     xbt_die("Could not send ignored region to MCer");
 198 }
 199
 200 void Client::unignoreHeap(void* address, std::size_t size)
 201 {
 202   s_mc_ignore_memory_message_t message;
 203   message.type = MC_MESSAGE_UNIGNORE_HEAP;
 204   message.addr = (std::uintptr_t)address;
 205   message.size = size;
 206   if (channel_.send(message))
 207     xbt_die("Could not send IGNORE_HEAP message to model-checker");
 208 }
 209
 210 void Client::declareSymbol(const char* name, int* value)
 211 {
 212   s_mc_register_symbol_message_t message;
 213   message.type = MC_MESSAGE_REGISTER_SYMBOL;
 214   if (strlen(name) + 1 > sizeof(message.name))
 215     xbt_die("Symbol is too long");
 216   strncpy(message.name, name, sizeof(message.name));
 217   message.callback = nullptr;
 218   message.data     = value;
 219   if (channel_.send(message))
 220     xbt_die("Could send REGISTER_SYMBOL message to model-checker");
 221 }
 222
 223 void Client::declareStack(void* stack, size_t size, smx_actor_t process, ucontext_t* context)
 224 {
 225   xbt_mheap_t heap = mmalloc_get_current_heap();
 226
 227   s_stack_region_t region;
 228   memset(&region, 0, sizeof(region));
 229   region.address = stack;
 230   region.context = context;
 231   region.size    = size;
 232   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 233 #if HAVE_SMPI
 234   if (smpi_privatize_global_variables == SMPI_PRIVATIZE_MMAP && process)
 235     region.process_index = process->pid - 1;
 236   else
 237 #endif
 238     region.process_index = -1;
 239
 240   s_mc_stack_region_message_t message;
 241   message.type         = MC_MESSAGE_STACK_REGION;
 242   message.stack_region = region;
 243   if (channel_.send(message))
 244     xbt_die("Could not send STACK_REGION to model-checker");
 245 }
 246 }
 247 }