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