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