src/mc/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 <cstdlib>
   8 #include <cerrno>
   9
  10 #include <sys/types.h>
  11 #include <sys/ptrace.h>
  12 #include <sys/socket.h>
  13
  14 #include <xbt/log.h>
  15 #include <xbt/sysdep.h>
  16 #include <xbt/mmalloc.h>
  17 #include <xbt/swag.h>
  18
  19 #include <simgrid/modelchecker.h>
  20
  21 #include "src/internal_config.h"
  22
  23 #include "src/mc/mc_protocol.h"
  24 #include "src/mc/Client.hpp"
  25 #include "src/mc/mc_request.h"
  26
  27 // We won't need those once the separation MCer/MCed is complete:
  28 #include "src/mc/mc_ignore.h"
  29 #include "src/mc/mc_smx.h"
  30
  31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  32
  33 namespace simgrid {
  34 namespace mc {
  35
  36 std::unique_ptr<Client> Client::client_;
  37
  38 Client* Client::initialize()
  39 {
  40   // We are not in MC mode:
  41   // TODO, handle this more gracefully.
  42   if (!getenv(MC_ENV_SOCKET_FD))
  43     return nullptr;
  44
  45   // Do not break if we are called multiple times:
  46   if (client_)
  47     return client_.get();
  48
  49   _sg_do_model_check = 1;
  50
  51   // Fetch socket from MC_ENV_SOCKET_FD:
  52   char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
  53   if (!fd_env)
  54     xbt_die("No MC socket passed in the environment");
  55   int fd = 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   if (ptrace(PTRACE_TRACEME, 0, nullptr, nullptr) == -1 || raise(SIGSTOP) != 0)
  71     xbt_die("Could not wait for the model-checker");
  72
  73   client_->handleMessages();
  74   return client_.get();
  75 }
  76
  77 void Client::handleMessages()
  78 {
  79   while (1) {
  80     XBT_DEBUG("Waiting messages from model-checker");
  81
  82     char message_buffer[MC_MESSAGE_LENGTH];
  83     ssize_t s;
  84
  85     if ((s = channel_.receive(&message_buffer, sizeof(message_buffer))) < 0)
  86       xbt_die("Could not receive commands from the model-checker");
  87
  88     s_mc_message_t message;
  89     if ((size_t) s < sizeof(message))
  90       xbt_die("Received message is too small");
  91     memcpy(&message, message_buffer, sizeof(message));
  92     switch (message.type) {
  93
  94     case MC_MESSAGE_DEADLOCK_CHECK:
  95       {
  96         // Check deadlock:
  97         bool deadlock = false;
  98         smx_process_t process;
  99         if (xbt_swag_size(simix_global->process_list)) {
 100           deadlock = true;
 101           xbt_swag_foreach(process, simix_global->process_list)
 102             if (simgrid::mc::process_is_enabled(process)) {
 103               deadlock = false;
 104               break;
 105             }
 106         }
 107
 108         // Send result:
 109         s_mc_int_message_t answer;
 110         answer.type = MC_MESSAGE_DEADLOCK_CHECK_REPLY;
 111         answer.value = deadlock;
 112         if (channel_.send(answer))
 113           xbt_die("Could not send response");
 114       }
 115       break;
 116
 117     case MC_MESSAGE_CONTINUE:
 118       return;
 119
 120     case MC_MESSAGE_SIMCALL_HANDLE:
 121       {
 122         s_mc_simcall_handle_message_t message;
 123         if (s != sizeof(message))
 124           xbt_die("Unexpected size for SIMCALL_HANDLE");
 125         memcpy(&message, message_buffer, sizeof(message));
 126         smx_process_t process = SIMIX_process_from_PID(message.pid);
 127         if (!process)
 128           xbt_die("Invalid pid %lu", (unsigned long) message.pid);
 129         SIMIX_simcall_handle(&process->simcall, message.value);
 130         if (channel_.send(MC_MESSAGE_WAITING))
 131           xbt_die("Could not send MESSAGE_WAITING to model-checker");
 132       }
 133       break;
 134
 135     case MC_MESSAGE_RESTORE:
 136       {
 137         s_mc_restore_message_t message;
 138         if (s != sizeof(message))
 139           xbt_die("Unexpected size for SIMCALL_HANDLE");
 140         memcpy(&message, message_buffer, sizeof(message));
 141         smpi_really_switch_data_segment(message.index);
 142       }
 143       break;
 144
 145     default:
 146       xbt_die("Received unexpected message %s (%i)",
 147         MC_message_type_name(message.type),
 148         message.type
 149       );
 150     }
 151   }
 152 }
 153
 154 void Client::mainLoop(void)
 155 {
 156   while (1) {
 157     simgrid::mc::wait_for_requests();
 158     if (channel_.send(MC_MESSAGE_WAITING))
 159       xbt_die("Could not send WAITING mesage to model-checker");
 160     this->handleMessages();
 161   }
 162 }
 163
 164 void Client::reportAssertionFailure(const char* description)
 165 {
 166   if (channel_.send(MC_MESSAGE_ASSERTION_FAILED))
 167     xbt_die("Could not send assertion to model-checker");
 168   this->handleMessages();
 169 }
 170
 171 void Client::ignoreMemory(void* addr, std::size_t size)
 172 {
 173   s_mc_ignore_memory_message_t message;
 174   message.type = MC_MESSAGE_IGNORE_MEMORY;
 175   message.addr = (std::uintptr_t) addr;
 176   message.size = size;
 177   if (channel_.send(message))
 178     xbt_die("Could not send IGNORE_MEMORY mesage to model-checker");
 179 }
 180
 181 void Client::ignoreHeap(void* address, std::size_t size)
 182 {
 183   xbt_mheap_t heap = mmalloc_get_current_heap();
 184
 185   s_mc_ignore_heap_message_t message;
 186   message.type = MC_MESSAGE_IGNORE_HEAP;
 187   message.address = address;
 188   message.size = size;
 189   message.block =
 190    ((char *) address -
 191     (char *) heap->heapbase) / BLOCKSIZE + 1;
 192   if (heap->heapinfo[message.block].type == 0) {
 193     message.fragment = -1;
 194     heap->heapinfo[message.block].busy_block.ignore++;
 195   } else {
 196     message.fragment =
 197         ((uintptr_t) (ADDR2UINT(address) % (BLOCKSIZE))) >>
 198         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_ignore_memory_message_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 mesasge to model-checker");
 214 }
 215
 216 void Client::declareSymbol(const char *name, int* value)
 217 {
 218   s_mc_register_symbol_message_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_process_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 =
 239       ((char *) stack -
 240        (char *) heap->heapbase) / BLOCKSIZE + 1;
 241 #if HAVE_SMPI
 242   if (smpi_privatize_global_variables && process)
 243     region.process_index = smpi_process_index_of_smx_process(process);
 244   else
 245 #endif
 246   region.process_index = -1;
 247
 248   s_mc_stack_region_message_t message;
 249   message.type = MC_MESSAGE_STACK_REGION;
 250   message.stack_region = region;
 251   if (channel_.send(message))
 252     xbt_die("Coule not send STACK_REGION to model-checker");
 253 }
 254
 255 }
 256 }