src/mc/remote/AppSide.cpp

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