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