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