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   std::string str = stream.str();
 113   xbt_assert(str.size() + 1 <= answer.buffer.size(),
 114              "The serialized simcall is too large for the buffer. Please fix the code.");
 115   strncpy(answer.buffer.data(), str.c_str(), answer.buffer.size() - 1);
 116   answer.buffer.back() = '\0';
 117
 118   XBT_DEBUG("send SIMCALL_EXECUTE_ANSWER(%s) ~> '%s'", actor->get_cname(), str.c_str());
 119   xbt_assert(channel_.send(answer) == 0, "Could not send response");
 120
 121   // The client may send some messages to the server while processing the transition
 122   actor->simcall_handle(message->times_considered_);
 123
 124   // Say the server that the transition is over and that it should proceed
 125   xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
 126 }
 127
 128 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
 129 {
 130   bool res = mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
 131   s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
 132   XBT_DEBUG("Actor %ld %s enabled", msg->aid, (res ? "IS" : "is NOT"));
 133   xbt_assert(channel_.send(answer) == 0, "Could not send ACTOR_ENABLED_REPLY");
 134 }
 135
 136 #define assert_msg_size(_name_, _type_)                                                                                \
 137   xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size,            \
 138              sizeof(_type_))
 139
 140 void AppSide::handle_messages() const
 141 {
 142   while (true) { // Until we get a CONTINUE message
 143     XBT_DEBUG("Waiting messages from model-checker");
 144
 145     std::array<char, MC_MESSAGE_LENGTH> message_buffer;
 146     ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
 147
 148     xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
 149
 150     const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
 151     switch (message->type) {
 152       case MessageType::DEADLOCK_CHECK:
 153         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 154         handle_deadlock_check(message);
 155         break;
 156
 157       case MessageType::CONTINUE:
 158         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 159         return;
 160
 161       case MessageType::SIMCALL_EXECUTE:
 162         assert_msg_size("SIMCALL_EXECUTE", s_mc_message_simcall_execute_t);
 163         handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data());
 164         break;
 165
 166       case MessageType::SIMCALL_IS_VISIBLE: {
 167         assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
 168         auto msg_simcall                = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
 169         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
 170         xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
 171         xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
 172         bool value = actor->simcall_.observer_->is_visible();
 173
 174         // Send result:
 175         s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
 176         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 177         break;
 178       }
 179
 180       case MessageType::ACTOR_ENABLED:
 181         assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
 182         handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
 183         break;
 184
 185       case MessageType::FINALIZE: {
 186         assert_msg_size("FINALIZE", s_mc_message_int_t);
 187         bool terminate_asap = ((s_mc_message_int_t*)message_buffer.data())->value;
 188         XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
 189         if (not terminate_asap) {
 190           if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
 191             kernel::EngineImpl::get_instance()->display_all_actor_status();
 192 #if HAVE_SMPI
 193           XBT_DEBUG("Smpi_enabled: %d", (int)smpi_enabled());
 194           if (smpi_enabled())
 195             SMPI_finalize();
 196 #endif
 197         }
 198         coverage_checkpoint();
 199         xbt_assert(channel_.send(MessageType::DEADLOCK_CHECK_REPLY) == 0, // DEADLOCK_CHECK_REPLY, really?
 200                    "Could not answer to FINALIZE");
 201         std::fflush(stdout);
 202         if (terminate_asap)
 203           ::_Exit(0);
 204         break;
 205       }
 206
 207       default:
 208         xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
 209         break;
 210     }
 211   }
 212 }
 213
 214 void AppSide::main_loop() const
 215 {
 216   coverage_checkpoint();
 217   while (true) {
 218     simgrid::mc::execute_actors();
 219     xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
 220     this->handle_messages();
 221   }
 222 }
 223
 224 void AppSide::report_assertion_failure() const
 225 {
 226   xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
 227   this->handle_messages();
 228 }
 229
 230 void AppSide::ignore_memory(void* addr, std::size_t size) const
 231 {
 232   s_mc_message_ignore_memory_t message;
 233   message.type = MessageType::IGNORE_MEMORY;
 234   message.addr = (std::uintptr_t)addr;
 235   message.size = size;
 236   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
 237 }
 238
 239 void AppSide::ignore_heap(void* address, std::size_t size) const
 240 {
 241   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 242
 243   s_mc_message_ignore_heap_t message;
 244   message.type    = MessageType::IGNORE_HEAP;
 245   message.address = address;
 246   message.size    = size;
 247   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 248   if (heap->heapinfo[message.block].type == 0) {
 249     message.fragment = -1;
 250     heap->heapinfo[message.block].busy_block.ignore++;
 251   } else {
 252     message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
 253     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 254   }
 255
 256   xbt_assert(channel_.send(message) == 0, "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   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
 266 }
 267
 268 void AppSide::declare_symbol(const char* name, int* value) const
 269 {
 270   s_mc_message_register_symbol_t message;
 271   memset(&message, 0, sizeof(message));
 272   message.type = MessageType::REGISTER_SYMBOL;
 273   xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
 274   strncpy(message.name.data(), name, message.name.size());
 275   message.callback = nullptr;
 276   message.data     = value;
 277   xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
 278 }
 279
 280 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
 281 {
 282   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 283
 284   s_stack_region_t region;
 285   memset(&region, 0, sizeof(region));
 286   region.address = stack;
 287   region.context = context;
 288   region.size    = size;
 289   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 290
 291   s_mc_message_stack_region_t message;
 292   message.type         = MessageType::STACK_REGION;
 293   message.stack_region = region;
 294   xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
 295 }
 296 } // namespace mc
 297 } // namespace simgrid