src/mc/remote/AppSide.cpp

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