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 #include <xbt/system_error.hpp>
  10
  11 #include <cstdlib>
  12 #include <cstring>
  13 #include <sys/socket.h>
  14 #include <sys/types.h>
  15
  16 // We won't need those once the separation MCer/MCed is complete:
  17 #include "src/mc/mc_smx.hpp"
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  20
  21 namespace simgrid {
  22 namespace mc {
  23
  24 std::unique_ptr<Client> Client::instance_;
  25
  26 Client* Client::initialize()
  27 {
  28   // We are not in MC mode:
  29   // TODO, handle this more gracefully.
  30   if (not std::getenv(MC_ENV_SOCKET_FD))
  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   char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
  41   if (not fd_env)
  42     xbt_die("No MC socket passed in the environment");
  43   int fd =
  44       xbt_str_parse_int(fd_env, bprintf("Variable %s should contain a number but contains '%%s'", MC_ENV_SOCKET_FD));
  45   XBT_DEBUG("Model-checked application found socket FD %i", fd);
  46
  47   // Check the socket type/validity:
  48   int type;
  49   socklen_t socklen = sizeof(type);
  50   if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0)
  51     xbt_die("Could not check socket type");
  52   if (type != SOCK_SEQPACKET)
  53     xbt_die("Unexpected socket type %i", type);
  54   XBT_DEBUG("Model-checked application found expected socket type");
  55
  56   instance_.reset(new simgrid::mc::Client(fd));
  57
  58   // Wait for the model-checker:
  59   if (raise(SIGSTOP) != 0)
  60     throw simgrid::xbt::errno_error("Could not wait for the model-checker");
  61
  62   instance_->handle_messages();
  63   return instance_.get();
  64 }
  65
  66 void Client::handle_deadlock_check(s_mc_message_t*)
  67 {
  68   bool deadlock = false;
  69   if (not simix_global->process_list.empty()) {
  70     deadlock = true;
  71     for (auto const& kv : simix_global->process_list)
  72       if (simgrid::mc::actor_is_enabled(kv.second)) {
  73         deadlock = false;
  74         break;
  75       }
  76   }
  77
  78   // Send result:
  79   s_mc_message_int_t answer{MC_MESSAGE_DEADLOCK_CHECK_REPLY, deadlock};
  80   xbt_assert(channel_.send(answer) == 0, "Could not send response");
  81 }
  82 void Client::handle_continue(s_mc_message_t*)
  83 {
  84   /* Nothing to do */
  85 }
  86 void Client::handle_simcall(s_mc_message_simcall_handle_t* message)
  87 {
  88   smx_actor_t process = SIMIX_process_from_PID(message->pid);
  89   if (not process)
  90     xbt_die("Invalid pid %lu", (unsigned long)message->pid);
  91   SIMIX_simcall_handle(&process->simcall, message->value);
  92   if (channel_.send(MC_MESSAGE_WAITING))
  93     xbt_die("Could not send MESSAGE_WAITING to model-checker");
  94 }
  95
  96 void Client::handle_actor_enabled(s_mc_message_actor_enabled_t* msg)
  97 {
  98   bool res = simgrid::mc::actor_is_enabled(SIMIX_process_from_PID(msg->aid));
  99   s_mc_message_int_t answer{MC_MESSAGE_ACTOR_ENABLED_REPLY, res};
 100   channel_.send(answer);
 101 }
 102
 103 void Client::handle_messages()
 104 {
 105   while (1) {
 106     XBT_DEBUG("Waiting messages from model-checker");
 107
 108     char message_buffer[MC_MESSAGE_LENGTH];
 109     ssize_t received_size = channel_.receive(&message_buffer, sizeof(message_buffer));
 110
 111     if (received_size < 0)
 112       xbt_die("Could not receive commands from the model-checker");
 113
 114     s_mc_message_t* message = (s_mc_message_t*)message_buffer;
 115     switch (message->type) {
 116
 117       case MC_MESSAGE_DEADLOCK_CHECK:
 118         xbt_assert(received_size == sizeof(s_mc_message_t), "Unexpected size for DEADLOCK_CHECK (%zd != %zu)",
 119                    received_size, sizeof(s_mc_message_t));
 120         handle_deadlock_check(message);
 121         break;
 122
 123       case MC_MESSAGE_CONTINUE:
 124         xbt_assert(received_size == sizeof(s_mc_message_t), "Unexpected size for MESSAGE_CONTINUE (%zd != %zu)",
 125                    received_size, sizeof(s_mc_message_t));
 126         handle_continue(message);
 127         return;
 128
 129       case MC_MESSAGE_SIMCALL_HANDLE:
 130         xbt_assert(received_size == sizeof(s_mc_message_simcall_handle_t),
 131                    "Unexpected size for SIMCALL_HANDLE (%zd != %zu)", received_size,
 132                    sizeof(s_mc_message_simcall_handle_t));
 133         handle_simcall((s_mc_message_simcall_handle_t*)message_buffer);
 134         break;
 135
 136       case MC_MESSAGE_ACTOR_ENABLED:
 137         xbt_assert(received_size == sizeof(s_mc_message_actor_enabled_t),
 138                    "Unexpected size for ACTOR_ENABLED (%zd != %zu)", received_size,
 139                    sizeof(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   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   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 }
 238 }