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