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