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
  18 #include "src/internal_config.h"
  19
  20 #include "src/mc/mc_protocol.h"
  21 #include "src/mc/Client.hpp"
  22 #include "src/mc/mc_request.h"
  23
  24 // We won't need those once the separation MCer/MCed is complete:
  25 #include "src/mc/mc_ignore.h"
  26 #include "src/mc/mc_smx.h"
  27
  28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  29
  30 namespace simgrid {
  31 namespace mc {
  32
  33 std::unique_ptr<Client> Client::client_;
  34
  35 Client* Client::initialize()
  36 {
  37   // We are not in MC mode:
  38   // TODO, handle this more gracefully.
  39   if (!getenv(MC_ENV_SOCKET_FD))
  40     return nullptr;
  41
  42   // Do not break if we are called multiple times:
  43   if (client_)
  44     return client_.get();
  45
  46   // Check and set the mode:
  47   if (mc_mode != MC_MODE_NONE)
  48     abort();
  49   mc_mode = MC_MODE_CLIENT;
  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, NULL) == -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("%s received unexpected message %s (%i)",
 147         MC_mode_name(mc_mode),
 148         MC_message_type_name(message.type),
 149         message.type
 150       );
 151     }
 152   }
 153 }
 154
 155 void Client::mainLoop(void)
 156 {
 157   while (1) {
 158     if (channel_.send(MC_MESSAGE_WAITING))
 159       xbt_die("Could not send WAITING mesage to model-checker");
 160     this->handleMessages();
 161     simgrid::mc::wait_for_requests();
 162   }
 163 }
 164
 165 void Client::reportAssertionFailure(const char* description)
 166 {
 167   if (channel_.send(MC_MESSAGE_ASSERTION_FAILED))
 168     xbt_die("Could not send assertion to model-checker");
 169   this->handleMessages();
 170 }
 171
 172 void Client::ignoreMemory(void* addr, std::size_t size)
 173 {
 174   s_mc_ignore_memory_message_t message;
 175   message.type = MC_MESSAGE_IGNORE_MEMORY;
 176   message.addr = (std::uintptr_t) addr;
 177   message.size = size;
 178   if (channel_.send(message))
 179     xbt_die("Could not send IGNORE_MEMORY mesage to model-checker");
 180 }
 181
 182 void Client::ignoreHeap(void* address, std::size_t size)
 183 {
 184   xbt_mheap_t heap = mmalloc_get_current_heap();
 185
 186   s_mc_ignore_heap_message_t message;
 187   message.type = MC_MESSAGE_IGNORE_HEAP;
 188   message.address = address;
 189   message.size = size;
 190   message.block =
 191    ((char *) address -
 192     (char *) heap->heapbase) / BLOCKSIZE + 1;
 193   if (heap->heapinfo[message.block].type == 0) {
 194     message.fragment = -1;
 195     heap->heapinfo[message.block].busy_block.ignore++;
 196   } else {
 197     message.fragment =
 198         ((uintptr_t) (ADDR2UINT(address) % (BLOCKSIZE))) >>
 199         heap->heapinfo[message.block].type;
 200     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 201   }
 202
 203   if (channel_.send(message))
 204     xbt_die("Could not send ignored region to MCer");
 205 }
 206
 207 void Client::unignoreHeap(void* address, std::size_t size)
 208 {
 209   s_mc_ignore_memory_message_t message;
 210   message.type = MC_MESSAGE_UNIGNORE_HEAP;
 211   message.addr = (std::uintptr_t) address;
 212   message.size = size;
 213   if (channel_.send(message))
 214     xbt_die("Could not send IGNORE_HEAP mesasge to model-checker");
 215 }
 216
 217 void Client::declareSymbol(const char *name, int* value)
 218 {
 219   s_mc_register_symbol_message_t message;
 220   message.type = MC_MESSAGE_REGISTER_SYMBOL;
 221   if (strlen(name) + 1 > sizeof(message.name))
 222     xbt_die("Symbol is too long");
 223   strncpy(message.name, name, sizeof(message.name));
 224   message.callback = nullptr;
 225   message.data = value;
 226   if (channel_.send(message))
 227     xbt_die("Could send REGISTER_SYMBOL message to model-checker");
 228 }
 229
 230 void Client::declareStack(void *stack, size_t size, smx_process_t process, ucontext_t* context)
 231 {
 232   xbt_mheap_t heap = mmalloc_get_current_heap();
 233
 234   s_stack_region_t region;
 235   memset(&region, 0, sizeof(region));
 236   region.address = stack;
 237   region.context = context;
 238   region.size = size;
 239   region.block =
 240       ((char *) stack -
 241        (char *) heap->heapbase) / BLOCKSIZE + 1;
 242 #if HAVE_SMPI
 243   if (smpi_privatize_global_variables && process)
 244     region.process_index = smpi_process_index_of_smx_process(process);
 245   else
 246 #endif
 247   region.process_index = -1;
 248
 249   s_mc_stack_region_message_t message;
 250   message.type = MC_MESSAGE_STACK_REGION;
 251   message.stack_region = region;
 252   if (channel_.send(message))
 253     xbt_die("Coule not send STACK_REGION to model-checker");
 254 }
 255
 256 }
 257 }