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