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/kernel/actor/SimcallObserver.hpp"
  10 #include "src/mc/remote/RemoteProcess.hpp"
  11 #include "xbt/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   int send_res = instance_->channel_.send(message);
  71   xbt_assert(send_res == 0, "Could not send the initial message with addresses.");
  72
  73   instance_->handle_messages();
  74   return instance_.get();
  75 }
  76
  77 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
  78 {
  79   bool deadlock = false;
  80   if (not simix_global->process_list.empty()) {
  81     deadlock = true;
  82     for (auto const& kv : simix_global->process_list)
  83       if (simgrid::mc::actor_is_enabled(kv.second)) {
  84         deadlock = false;
  85         break;
  86       }
  87   }
  88
  89   // Send result:
  90   s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
  91   int send_res = channel_.send(answer);
  92   xbt_assert(send_res == 0, "Could not send response");
  93 }
  94 void AppSide::handle_simcall_execute(const s_mc_message_simcall_handle_t* message) const
  95 {
  96   kernel::actor::ActorImpl* process = kernel::actor::ActorImpl::by_pid(message->pid_);
  97   xbt_assert(process != nullptr, "Invalid pid %lu", message->pid_);
  98   process->simcall_handle(message->times_considered_);
  99   if (channel_.send(MessageType::WAITING))
 100     xbt_die("Could not send MESSAGE_WAITING to model-checker");
 101 }
 102
 103 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
 104 {
 105   bool res = simgrid::mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
 106   s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
 107   channel_.send(answer);
 108 }
 109
 110 #define assert_msg_size(_name_, _type_)                                                                                \
 111   xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size,            \
 112              sizeof(_type_))
 113
 114 void AppSide::handle_messages() const
 115 {
 116   while (true) { // Until we get a CONTINUE message
 117     XBT_DEBUG("Waiting messages from model-checker");
 118
 119     std::array<char, MC_MESSAGE_LENGTH> message_buffer;
 120     ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
 121
 122     xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
 123
 124     const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
 125     switch (message->type) {
 126       case MessageType::DEADLOCK_CHECK:
 127         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 128         handle_deadlock_check(message);
 129         break;
 130
 131       case MessageType::CONTINUE:
 132         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 133         return;
 134
 135       case MessageType::SIMCALL_HANDLE:
 136         assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t);
 137         handle_simcall_execute((s_mc_message_simcall_handle_t*)message_buffer.data());
 138         break;
 139
 140       case MessageType::SIMCALL_IS_VISIBLE: {
 141         assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
 142         auto msg_simcall                = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
 143         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
 144         xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
 145         xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
 146         bool value = actor->simcall_.observer_->is_visible();
 147
 148         // Send result:
 149         s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
 150         int send_res = channel_.send(answer);
 151         xbt_assert(send_res == 0, "Could not send response");
 152         break;
 153       }
 154
 155       case MessageType::SIMCALL_TO_STRING: {
 156         assert_msg_size("SIMCALL_TO_STRING", s_mc_message_simcall_to_string_t);
 157         auto msg_simcall                = (s_mc_message_simcall_to_string_t*)message_buffer.data();
 158         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
 159         xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
 160         xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
 161         std::string value = actor->simcall_.observer_->to_string(msg_simcall->time_considered);
 162
 163         // Send result:
 164         s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
 165         value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
 166         int send_res = channel_.send(answer);
 167         xbt_assert(send_res == 0, "Could not send response");
 168         break;
 169       }
 170
 171       case MessageType::SIMCALL_DOT_LABEL: {
 172         assert_msg_size("SIMCALL_DOT_LABEL", s_mc_message_simcall_to_string_t);
 173         auto msg_simcall                = (s_mc_message_simcall_to_string_t*)message_buffer.data();
 174         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
 175         xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
 176         xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
 177         std::string value = actor->simcall_.observer_->dot_label();
 178
 179         // Send result:
 180         s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
 181         value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
 182         int send_res = channel_.send(answer);
 183         xbt_assert(send_res == 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       case MessageType::FINALIZE: {
 193 #if HAVE_SMPI
 194         XBT_INFO("Finalize. Smpi_enabled: %d", (int)smpi_enabled());
 195         simix_global->display_all_actor_status();
 196         if (smpi_enabled())
 197           SMPI_finalize();
 198 #endif
 199         int send_res = channel_.send(MessageType::DEADLOCK_CHECK_REPLY); // really?
 200         xbt_assert(send_res == 0, "Could not answer to FINALIZE");
 201         break;
 202       }
 203
 204       default:
 205         xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
 206         break;
 207     }
 208   }
 209 }
 210
 211 void AppSide::main_loop() const
 212 {
 213   while (true) {
 214     simgrid::mc::execute_actors();
 215     int send_res = channel_.send(MessageType::WAITING);
 216     xbt_assert(send_res == 0, "Could not send WAITING message to model-checker");
 217     this->handle_messages();
 218   }
 219 }
 220
 221 void AppSide::report_assertion_failure() const
 222 {
 223   if (channel_.send(MessageType::ASSERTION_FAILED))
 224     xbt_die("Could not send assertion to model-checker");
 225   this->handle_messages();
 226 }
 227
 228 void AppSide::ignore_memory(void* addr, std::size_t size) const
 229 {
 230   s_mc_message_ignore_memory_t message;
 231   message.type = MessageType::IGNORE_MEMORY;
 232   message.addr = (std::uintptr_t)addr;
 233   message.size = size;
 234   if (channel_.send(message))
 235     xbt_die("Could not send IGNORE_MEMORY message to model-checker");
 236 }
 237
 238 void AppSide::ignore_heap(void* address, std::size_t size) const
 239 {
 240   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 241
 242   s_mc_message_ignore_heap_t message;
 243   message.type    = MessageType::IGNORE_HEAP;
 244   message.address = address;
 245   message.size    = size;
 246   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 247   if (heap->heapinfo[message.block].type == 0) {
 248     message.fragment = -1;
 249     heap->heapinfo[message.block].busy_block.ignore++;
 250   } else {
 251     message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
 252     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 253   }
 254
 255   if (channel_.send(message))
 256     xbt_die("Could not send ignored region to MCer");
 257 }
 258
 259 void AppSide::unignore_heap(void* address, std::size_t size) const
 260 {
 261   s_mc_message_ignore_memory_t message;
 262   message.type = MessageType::UNIGNORE_HEAP;
 263   message.addr = (std::uintptr_t)address;
 264   message.size = size;
 265   if (channel_.send(message))
 266     xbt_die("Could not send IGNORE_HEAP message to model-checker");
 267 }
 268
 269 void AppSide::declare_symbol(const char* name, int* value) const
 270 {
 271   s_mc_message_register_symbol_t message;
 272   message.type = MessageType::REGISTER_SYMBOL;
 273   if (strlen(name) + 1 > message.name.size())
 274     xbt_die("Symbol is too long");
 275   strncpy(message.name.data(), name, message.name.size());
 276   message.callback = nullptr;
 277   message.data     = value;
 278   if (channel_.send(message))
 279     xbt_die("Could send REGISTER_SYMBOL message to model-checker");
 280 }
 281
 282 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
 283 {
 284   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 285
 286   s_stack_region_t region;
 287   memset(&region, 0, sizeof(region));
 288   region.address = stack;
 289   region.context = context;
 290   region.size    = size;
 291   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 292
 293   s_mc_message_stack_region_t message;
 294   message.type         = MessageType::STACK_REGION;
 295   message.stack_region = region;
 296   if (channel_.send(message))
 297     xbt_die("Could not send STACK_REGION to model-checker");
 298 }
 299 } // namespace mc
 300 } // namespace simgrid