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 "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, "Not a number in variable '" MC_ENV_SOCKET_FD "'");
  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(), kernel::get_actors_addr(),
  78                                            kernel::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 = not actor_list.empty() && std::none_of(begin(actor_list), end(actor_list), [](const auto& kv) {
  89     return mc::actor_is_enabled(kv.second);
  90   });
  91
  92   // Send result:
  93   s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
  94   xbt_assert(channel_.send(answer) == 0, "Could not send response");
  95 }
  96 void AppSide::handle_simcall_execute(const s_mc_message_simcall_execute_t* message) const
  97 {
  98   kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(message->aid_);
  99   xbt_assert(actor != nullptr, "Invalid pid %ld", message->aid_);
 100   simgrid::kernel::actor::SimcallObserver* observer = nullptr;
 101   if (actor->simcall_.observer_ != nullptr) {
 102     observer = actor->simcall_.observer_->clone();
 103     actor->observer_stack_.push_back(observer);
 104   }
 105   // Finish the RPC from the server: we need to return a pointer to the observer, saved in a stable storage
 106   s_mc_message_simcall_execute_answer_t answer{MessageType::SIMCALL_EXECUTE_ANSWER, observer};
 107   XBT_DEBUG("send SIMCALL_EXECUTE_ANSWER(%p)", observer);
 108   xbt_assert(channel_.send(answer) == 0, "Could not send response");
 109
 110   // The client may send some messages to the server while processing the transition
 111   actor->simcall_handle(message->times_considered_);
 112
 113   // Say the server that the transition is over and that it should proceed
 114   xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
 115 }
 116
 117 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
 118 {
 119   bool res = mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
 120   s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
 121   XBT_DEBUG("Actor %ld %s enabled", msg->aid, (res ? "IS" : "is NOT"));
 122   xbt_assert(channel_.send(answer) == 0, "Could not send ACTOR_ENABLED_REPLY");
 123 }
 124
 125 #define assert_msg_size(_name_, _type_)                                                                                \
 126   xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size,            \
 127              sizeof(_type_))
 128
 129 void AppSide::handle_messages() const
 130 {
 131   while (true) { // Until we get a CONTINUE message
 132     XBT_DEBUG("Waiting messages from model-checker");
 133
 134     std::array<char, MC_MESSAGE_LENGTH> message_buffer;
 135     ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
 136
 137     xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
 138
 139     const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
 140     switch (message->type) {
 141       case MessageType::DEADLOCK_CHECK:
 142         assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
 143         handle_deadlock_check(message);
 144         break;
 145
 146       case MessageType::CONTINUE:
 147         assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
 148         return;
 149
 150       case MessageType::SIMCALL_EXECUTE:
 151         assert_msg_size("SIMCALL_EXECUTE", s_mc_message_simcall_execute_t);
 152         handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data());
 153         break;
 154
 155       case MessageType::SIMCALL_IS_VISIBLE: {
 156         assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
 157         auto msg_simcall                = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
 158         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
 159         xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
 160         xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
 161         bool value = actor->simcall_.observer_->is_visible();
 162
 163         // Send result:
 164         s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
 165         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 166         break;
 167       }
 168
 169       case MessageType::SIMCALL_TO_STRING: {
 170         assert_msg_size("SIMCALL_TO_STRING", s_mc_message_simcall_to_string_t);
 171         auto msg_simcall                = (s_mc_message_simcall_to_string_t*)message_buffer.data();
 172         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
 173         xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
 174         xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
 175         std::string value = actor->simcall_.observer_->to_string(msg_simcall->time_considered);
 176
 177         // Send result:
 178         s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
 179         value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
 180         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 181         break;
 182       }
 183
 184       case MessageType::SIMCALLS_DEPENDENT: {
 185         assert_msg_size("SIMCALLS_DEPENDENT", s_mc_message_simcalls_dependent_t);
 186         auto msg_simcalls = (s_mc_message_simcalls_dependent_t*)message_buffer.data();
 187         auto* obs1        = msg_simcalls->obs1;
 188         auto* obs2        = msg_simcalls->obs2;
 189         bool res          = true;
 190
 191         if (obs1 != nullptr && obs2 != nullptr)
 192           res = obs1->depends(obs2);
 193
 194         XBT_DEBUG("return SIMCALLS_DEPENDENT(%s, %s) = %s", obs1->to_string(0).c_str(), obs2->to_string(0).c_str(),
 195                   (res ? "true" : "false"));
 196
 197         // Send result:
 198         s_mc_message_simcalls_dependent_answer_t answer{MessageType::SIMCALLS_DEPENDENT_ANSWER, {0}};
 199         answer.value = res;
 200         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 201         break;
 202       }
 203
 204       case MessageType::SIMCALL_DOT_LABEL: {
 205         assert_msg_size("SIMCALL_DOT_LABEL", s_mc_message_simcall_to_string_t);
 206         auto msg_simcall                = (s_mc_message_simcall_to_string_t*)message_buffer.data();
 207         const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
 208         xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
 209         xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
 210         std::string value = actor->simcall_.observer_->dot_label(msg_simcall->time_considered);
 211
 212         // Send result:
 213         s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
 214         value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
 215         xbt_assert(channel_.send(answer) == 0, "Could not send response");
 216         break;
 217       }
 218
 219       case MessageType::ACTOR_ENABLED:
 220         assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
 221         handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
 222         break;
 223
 224       case MessageType::FINALIZE: {
 225         assert_msg_size("FINALIZE", s_mc_message_int_t);
 226         bool terminate_asap = ((s_mc_message_int_t*)message_buffer.data())->value;
 227         XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
 228         if (not terminate_asap) {
 229           if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
 230             kernel::EngineImpl::get_instance()->display_all_actor_status();
 231 #if HAVE_SMPI
 232           XBT_DEBUG("Smpi_enabled: %d", (int)smpi_enabled());
 233           if (smpi_enabled())
 234             SMPI_finalize();
 235 #endif
 236         }
 237         coverage_checkpoint();
 238         xbt_assert(channel_.send(MessageType::DEADLOCK_CHECK_REPLY) == 0, // DEADLOCK_CHECK_REPLY, really?
 239                    "Could not answer to FINALIZE");
 240         std::fflush(stdout);
 241         if (terminate_asap)
 242           ::_Exit(0);
 243         break;
 244       }
 245
 246       default:
 247         xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
 248         break;
 249     }
 250   }
 251 }
 252
 253 void AppSide::main_loop() const
 254 {
 255   coverage_checkpoint();
 256   while (true) {
 257     simgrid::mc::execute_actors();
 258     xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
 259     this->handle_messages();
 260   }
 261 }
 262
 263 void AppSide::report_assertion_failure() const
 264 {
 265   xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
 266   this->handle_messages();
 267 }
 268
 269 void AppSide::ignore_memory(void* addr, std::size_t size) const
 270 {
 271   s_mc_message_ignore_memory_t message;
 272   message.type = MessageType::IGNORE_MEMORY;
 273   message.addr = (std::uintptr_t)addr;
 274   message.size = size;
 275   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
 276 }
 277
 278 void AppSide::ignore_heap(void* address, std::size_t size) const
 279 {
 280   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 281
 282   s_mc_message_ignore_heap_t message;
 283   message.type    = MessageType::IGNORE_HEAP;
 284   message.address = address;
 285   message.size    = size;
 286   message.block   = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
 287   if (heap->heapinfo[message.block].type == 0) {
 288     message.fragment = -1;
 289     heap->heapinfo[message.block].busy_block.ignore++;
 290   } else {
 291     message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
 292     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
 293   }
 294
 295   xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer");
 296 }
 297
 298 void AppSide::unignore_heap(void* address, std::size_t size) const
 299 {
 300   s_mc_message_ignore_memory_t message;
 301   message.type = MessageType::UNIGNORE_HEAP;
 302   message.addr = (std::uintptr_t)address;
 303   message.size = size;
 304   xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
 305 }
 306
 307 void AppSide::declare_symbol(const char* name, int* value) const
 308 {
 309   s_mc_message_register_symbol_t message;
 310   memset(&message, 0, sizeof(message));
 311   message.type = MessageType::REGISTER_SYMBOL;
 312   xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
 313   strncpy(message.name.data(), name, message.name.size());
 314   message.callback = nullptr;
 315   message.data     = value;
 316   xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
 317 }
 318
 319 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
 320 {
 321   const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
 322
 323   s_stack_region_t region;
 324   memset(&region, 0, sizeof(region));
 325   region.address = stack;
 326   region.context = context;
 327   region.size    = size;
 328   region.block   = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
 329
 330   s_mc_message_stack_region_t message;
 331   message.type         = MessageType::STACK_REGION;
 332   message.stack_region = region;
 333   xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
 334 }
 335 } // namespace mc
 336 } // namespace simgrid