src/mc/remote/AppSide.cpp

   1 /* Copyright (c) 2015-2021. 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/AppSide.hpp"
   7 #include "src/internal_config.h"
   8 #include "src/kernel/actor/ActorImpl.hpp"
   9 #include "src/mc/checker/SimcallInspector.hpp"
  10 #include <simgrid/modelchecker.h>
  11
  12 #include <cerrno>
  13 #include <cstdlib>
  14 #include <cstring>
  15 #include <memory>
  16 #include <sys/ptrace.h>
  17 #include <sys/socket.h>
  18 #include <sys/types.h>
  19
  20 // We won't need those once the separation MCer/MCed is complete:
  21 #include "src/mc/mc_smx.hpp"
  22
  23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
  24
  25 namespace simgrid {
  26 namespace mc {
  27
  28 std::unique_ptr<AppSide> AppSide::instance_;
  29
  30 AppSide* AppSide::initialize()
  31 {
  32   if (not std::getenv(MC_ENV_SOCKET_FD)) // We are not in MC mode: don't initialize the MC world
  33     return nullptr;
  34
  35   // Do not break if we are called multiple times:
  36   if (instance_)
  37     return instance_.get();
  38
  39   _sg_do_model_check = 1;
  40
  41   // Fetch socket from MC_ENV_SOCKET_FD:
  42   const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
  43   int fd = xbt_str_parse_int(fd_env, "Variable '" MC_ENV_SOCKET_FD "' should contain a number but contains '%s'");
  44   XBT_DEBUG("Model-checked application found socket FD %i", fd);
  45
  46   // Check the socket type/validity:
  47   int type;
  48   socklen_t socklen = sizeof(type);
  49   if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0)
  50     xbt_die("Could not check socket type");
  51   xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type);
  52   XBT_DEBUG("Model-checked application found expected socket type");
  53
  54   instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
  55
  56   // Wait for the model-checker:
  57   errno = 0;
  58 #if defined __linux__
  59   ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
  60 #elif defined BSD
  61   ptrace(PT_TRACE_ME, 0, nullptr, 0);
  62 #else
  63 #error "no ptrace equivalent coded for this platform"
  64 #endif
  65   if (errno != 0 || raise(SIGSTOP) != 0)
  66     xbt_die("Could not wait for the model-checker (errno = %d: %s)", errno, strerror(errno));
  67
  68   instance_->handle_messages();
  69   return instance_.get();
  70 }
  71
  72 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
  73 {
  74   bool deadlock = false;
  75   if (not simix_global->process_list.empty()) {
  76     deadlock = true;
  77     for (auto const& kv : simix_global->process_list)
  78       if (simgrid::mc::actor_is_enabled(kv.second)) {
  79         deadlock = false;
  80         break;
  81       }
  82   }
  83
  84   // Send result:
  85   s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
  86   xbt_assert(channel_.send(answer) == 0, "Could not send response");
  87 }
  88 void AppSide::handle_continue(const s_mc_message_t*) const
  89 {
  90   /* Nothing to do */
  91 }
  92 void AppSide::handle_simcall(const s_mc_message_simcall_handle_t* message) const
  93 {
  94   kernel::actor::ActorImpl* process = kernel::actor::ActorImpl::by_PID(message->pid_);
  95   xbt_assert(process != nullptr, "Invalid pid %lu", message->pid_);
  96   process->simcall_handle(message->times_considered_);
  97   if (channel_.send(MessageType::WAITING))
  98     xbt_die("Could not send MESSAGE_WAITING to model-checker");
  99 }
 100
 101 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
 102 {
 103   bool res = simgrid::mc::actor_is_enabled(kernel::actor::ActorImpl::by_PID(msg->aid));
 104   s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
 105   channel_.send(answer);
 106 }
 107
 108 #define assert_msg_size(_name_, _type_)                                                                                \
 109   xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size,            \
 110              sizeof(_type_))
 111
 112 void AppSide::handle_messages() const
 113 {
 114   while (true) {
 115     XBT_DEBUG("Waiting messages from model-checker");
 116
 117     std::array<char, MC_MESSAGE_LENGTH> message_buffer;
 118     ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
 119
 120     xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
 121
 122     const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
 123     switch (message->type) {
 124       case MessageType::DEADLOCK_CHECK:
 125         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 126         handle_deadlock_check(message);
 127         break;
 128
 129       case MessageType::CONTINUE:
 130         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 131         handle_continue(message);
 132         return;
 133
 134       case MessageType::SIMCALL_HANDLE:
 135         assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t);
 136         handle_simcall((s_mc_message_simcall_handle_t*)message_buffer.data());
 137         break;
 138
 139       case MessageType::SIMCALL_IS_VISIBLE: {
 140         assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
 141         auto msg_simcall                = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
 142         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_PID(msg_simcall->aid);
 143         xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
 144         xbt_assert(actor->simcall_.inspector_, "The transition of %s has no inspector", actor->get_cname());
 145         bool value = actor->simcall_.inspector_->is_visible();
 146
 147         // Send result:
 148         s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
 149         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 150         break;
 151       }
 152
 153       case MessageType::SIMCALL_TO_STRING: {
 154         assert_msg_size("SIMCALL_TO_STRING", s_mc_message_simcall_to_string_t);
 155         auto msg_simcall                = (s_mc_message_simcall_to_string_t*)message_buffer.data();
 156         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_PID(msg_simcall->aid);
 157         xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
 158         xbt_assert(actor->simcall_.inspector_, "The transition of %s has no inspector", actor->get_cname());
 159         std::string value = actor->simcall_.inspector_->to_string(msg_simcall->time_considered);
 160
 161         // Send result:
 162         s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
 163         value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
 164         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 165         break;
 166       }
 167
 168       case MessageType::SIMCALL_DOT_LABEL: {
 169         assert_msg_size("SIMCALL_DOT_LABEL", s_mc_message_simcall_to_string_t);
 170         auto msg_simcall                = (s_mc_message_simcall_to_string_t*)message_buffer.data();
 171         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_PID(msg_simcall->aid);
 172         xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
 173         xbt_assert(actor->simcall_.inspector_, "The transition of %s has no inspector", actor->get_cname());
 174         std::string value = actor->simcall_.inspector_->dot_label();
 175
 176         // Send result:
 177         s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
 178         value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
 179         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 180         break;
 181       }
 182
 183       case MessageType::ACTOR_ENABLED:
 184         assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
 185         handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
 186         break;
 187
 188       default:
 189         xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
 190         break;
 191     }
 192   }
 193 }
 194
 195 void AppSide::main_loop() const
 196 {
 197   while (true) {
 198     simgrid::mc::wait_for_requests();
 199     xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
 200     this->handle_messages();
 201   }
 202 }
 203
 204 void AppSide::report_assertion_failure() const
 205 {
 206   if (channel_.send(MessageType::ASSERTION_FAILED))
 207     xbt_die("Could not send assertion to model-checker");
 208   this->handle_messages();
 209 }
 210
 211 void AppSide::ignore_memory(void* addr, std::size_t size) const
 212 {
 213   s_mc_message_ignore_memory_t message;
 214   message.type = MessageType::IGNORE_MEMORY;
 215   message.addr = (std::uintptr_t)addr;
 216   message.size = size;
 217   if (channel_.send(message))
 218     xbt_die("Could not send IGNORE_MEMORY message to model-checker");
 219 }
 220
 221 void AppSide::ignore_heap(void* address, std::size_t size) const
 222 {
 223   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 224
 225   s_mc_message_ignore_heap_t message;
 226   message.type    = MessageType::IGNORE_HEAP;
 227   message.address = address;
 228   message.size    = size;
 229   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 230   if (heap->heapinfo[message.block].type == 0) {
 231     message.fragment = -1;
 232     heap->heapinfo[message.block].busy_block.ignore++;
 233   } else {
 234     message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
 235     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 236   }
 237
 238   if (channel_.send(message))
 239     xbt_die("Could not send ignored region to MCer");
 240 }
 241
 242 void AppSide::unignore_heap(void* address, std::size_t size) const
 243 {
 244   s_mc_message_ignore_memory_t message;
 245   message.type = MessageType::UNIGNORE_HEAP;
 246   message.addr = (std::uintptr_t)address;
 247   message.size = size;
 248   if (channel_.send(message))
 249     xbt_die("Could not send IGNORE_HEAP message to model-checker");
 250 }
 251
 252 void AppSide::declare_symbol(const char* name, int* value) const
 253 {
 254   s_mc_message_register_symbol_t message;
 255   message.type = MessageType::REGISTER_SYMBOL;
 256   if (strlen(name) + 1 > message.name.size())
 257     xbt_die("Symbol is too long");
 258   strncpy(message.name.data(), name, message.name.size());
 259   message.callback = nullptr;
 260   message.data     = value;
 261   if (channel_.send(message))
 262     xbt_die("Could send REGISTER_SYMBOL message to model-checker");
 263 }
 264
 265 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
 266 {
 267   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 268
 269   s_stack_region_t region;
 270   memset(&region, 0, sizeof(region));
 271   region.address = stack;
 272   region.context = context;
 273   region.size    = size;
 274   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 275
 276   s_mc_message_stack_region_t message;
 277   message.type         = MessageType::STACK_REGION;
 278   message.stack_region = region;
 279   if (channel_.send(message))
 280     xbt_die("Could not send STACK_REGION to model-checker");
 281 }
 282 } // namespace mc
 283 } // namespace simgrid