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