X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/fd52ffa61dfc8d90d4a042240a3e389f0b86ca98..fa22f462594acff6e8eaab9fb39453ae1927e51c:/src/mc/remote/AppSide.cpp diff --git a/src/mc/remote/AppSide.cpp b/src/mc/remote/AppSide.cpp index 829a2c7276..8813a4f832 100644 --- a/src/mc/remote/AppSide.cpp +++ b/src/mc/remote/AppSide.cpp @@ -1,27 +1,38 @@ -/* Copyright (c) 2015-2020. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2015-2023. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ #include "src/mc/remote/AppSide.hpp" +#include "simgrid/s4u/Host.hpp" #include "src/internal_config.h" +#include "src/kernel/EngineImpl.hpp" +#include "src/kernel/actor/ActorImpl.hpp" +#include "src/kernel/actor/SimcallObserver.hpp" +#include "src/mc/mc_base.hpp" +#include "src/mc/mc_config.hpp" +#include "src/mc/sosp/RemoteProcessMemory.hpp" +#if HAVE_SMPI +#include "src/smpi/include/private.hpp" +#endif +#include "src/sthread/sthread.h" +#include "src/xbt/coverage.h" +#include "xbt/str.h" #include #include +#include // setvbuf #include -#include #include +#include #include #include #include -// We won't need those once the separation MCer/MCed is complete: -#include "src/mc/mc_smx.hpp" - XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic"); +XBT_LOG_EXTERNAL_CATEGORY(mc_global); -namespace simgrid { -namespace mc { +namespace simgrid::mc { std::unique_ptr AppSide::instance_; @@ -34,34 +45,38 @@ AppSide* AppSide::initialize() if (instance_) return instance_.get(); - _sg_do_model_check = 1; + simgrid::mc::model_checking_mode = ModelCheckingMode::APP_SIDE; + + setvbuf(stdout, nullptr, _IOLBF, 0); // Fetch socket from MC_ENV_SOCKET_FD: const char* fd_env = std::getenv(MC_ENV_SOCKET_FD); - int fd = xbt_str_parse_int(fd_env, "Variable '" MC_ENV_SOCKET_FD "' should contain a number but contains '%s'"); + int fd = xbt_str_parse_int(fd_env, "Not a number in variable '" MC_ENV_SOCKET_FD "'"); XBT_DEBUG("Model-checked application found socket FD %i", fd); // Check the socket type/validity: int type; socklen_t socklen = sizeof(type); - if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0) - xbt_die("Could not check socket type"); + xbt_assert(getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) == 0, "Could not check socket type"); xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type); XBT_DEBUG("Model-checked application found expected socket type"); instance_ = std::make_unique(fd); // Wait for the model-checker: - errno = 0; + if (getenv("MC_NEED_PTRACE") != nullptr) { + errno = 0; #if defined __linux__ - ptrace(PTRACE_TRACEME, 0, nullptr, nullptr); + ptrace(PTRACE_TRACEME, 0, nullptr, nullptr); #elif defined BSD - ptrace(PT_TRACE_ME, 0, nullptr, 0); + ptrace(PT_TRACE_ME, 0, nullptr, 0); #else -#error "no ptrace equivalent coded for this platform" + xbt_die("no ptrace equivalent coded for this platform, please don't use the liveness checker here."); #endif - if (errno != 0 || raise(SIGSTOP) != 0) - xbt_die("Could not wait for the model-checker (errno = %d: %s)", errno, strerror(errno)); + + xbt_assert(errno == 0 && raise(SIGSTOP) == 0, "Could not wait for the model-checker (errno = %d: %s)", errno, + strerror(errno)); + } instance_->handle_messages(); return instance_.get(); @@ -69,53 +84,162 @@ AppSide* AppSide::initialize() void AppSide::handle_deadlock_check(const s_mc_message_t*) const { - bool deadlock = false; - if (not simix_global->process_list.empty()) { - deadlock = true; - for (auto const& kv : simix_global->process_list) - if (simgrid::mc::actor_is_enabled(kv.second)) { - deadlock = false; - break; - } + const auto* engine = kernel::EngineImpl::get_instance(); + const auto& actor_list = engine->get_actor_list(); + bool deadlock = not actor_list.empty() && std::none_of(begin(actor_list), end(actor_list), [](const auto& kv) { + return mc::actor_is_enabled(kv.second); + }); + + if (deadlock) { + XBT_CINFO(mc_global, "**************************"); + XBT_CINFO(mc_global, "*** DEADLOCK DETECTED ***"); + XBT_CINFO(mc_global, "**************************"); + engine->display_all_actor_status(); } - // Send result: - s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock}; + s_mc_message_int_t answer = {}; + answer.type = MessageType::DEADLOCK_CHECK_REPLY; + answer.value = deadlock; + xbt_assert(channel_.send(answer) == 0, "Could not send response"); +} +void AppSide::handle_simcall_execute(const s_mc_message_simcall_execute_t* message) const +{ + kernel::actor::ActorImpl* actor = kernel::EngineImpl::get_instance()->get_actor_by_pid(message->aid_); + xbt_assert(actor != nullptr, "Invalid pid %ld", message->aid_); + + // The client may send some messages to the server while processing the transition + actor->simcall_handle(message->times_considered_); + // Say the server that the transition is over and that it should proceed + xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker"); + + // Finish the RPC from the server: return a serialized observer, to build a Transition on Checker side + s_mc_message_simcall_execute_answer_t answer = {}; + answer.type = MessageType::SIMCALL_EXECUTE_ANSWER; + std::stringstream stream; + if (actor->simcall_.observer_ != nullptr) { + actor->simcall_.observer_->serialize(stream); + } else { + stream << (short)mc::Transition::Type::UNKNOWN; + } + std::string str = stream.str(); + xbt_assert(str.size() + 1 <= answer.buffer.size(), + "The serialized simcall is too large for the buffer. Please fix the code."); + strncpy(answer.buffer.data(), str.c_str(), answer.buffer.size() - 1); + answer.buffer.back() = '\0'; + + XBT_DEBUG("send SIMCALL_EXECUTE_ANSWER(%s) ~> '%s'", actor->get_cname(), str.c_str()); xbt_assert(channel_.send(answer) == 0, "Could not send response"); } -void AppSide::handle_continue(const s_mc_message_t*) const + +void AppSide::handle_finalize(const s_mc_message_int_t* msg) const { - /* Nothing to do */ + bool terminate_asap = msg->value; + XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap); + if (not terminate_asap) { + if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug)) + kernel::EngineImpl::get_instance()->display_all_actor_status(); +#if HAVE_SMPI + XBT_DEBUG("Smpi_enabled: %d", SMPI_is_inited()); + if (SMPI_is_inited()) + SMPI_finalize(); +#endif + } + coverage_checkpoint(); + xbt_assert(channel_.send(MessageType::FINALIZE_REPLY) == 0, "Could not answer to FINALIZE"); + std::fflush(stdout); + if (terminate_asap) + ::_Exit(0); } -void AppSide::handle_simcall(const s_mc_message_simcall_handle_t* message) const +void AppSide::handle_need_meminfo() { - smx_actor_t process = SIMIX_process_from_PID(message->pid); - xbt_assert(process != nullptr, "Invalid pid %lu", message->pid); - process->simcall_handle(message->value); - if (channel_.send(MessageType::WAITING)) - xbt_die("Could not send MESSAGE_WAITING to model-checker"); + this->need_memory_info_ = true; + s_mc_message_need_meminfo_reply_t answer = {}; + answer.type = MessageType::NEED_MEMINFO_REPLY; + answer.mmalloc_default_mdp = mmalloc_get_current_heap(); + xbt_assert(channel_.send(answer) == 0, "Could not send response to the request for meminfo."); } +void AppSide::handle_actors_status() const +{ + auto const& actor_list = kernel::EngineImpl::get_instance()->get_actor_list(); + XBT_DEBUG("Serialize the actors to answer ACTORS_STATUS from the checker. %zu actors to go.", actor_list.size()); + + std::vector status; + for (auto const& [aid, actor] : actor_list) + status.emplace_back(s_mc_message_actors_status_one_t{aid, mc::actor_is_enabled(actor), + actor->simcall_.observer_->get_max_consider()}); + + struct s_mc_message_actors_status_answer_t answer = {}; + answer.type = MessageType::ACTORS_STATUS_REPLY; + answer.count = static_cast(status.size()); + + xbt_assert(channel_.send(answer) == 0, "Could not send ACTORS_STATUS_REPLY msg"); + if (answer.count > 0) { + size_t size = status.size() * sizeof(s_mc_message_actors_status_one_t); + xbt_assert(channel_.send(status.data(), size) == 0, "Could not send ACTORS_STATUS_REPLY data"); + } + + // Serialize each transition to describe what each actor is doing + XBT_DEBUG("Deliver ACTOR_TRANSITION_PROBE payload"); + for (const auto& actor_status : status) { + if (not actor_status.enabled) + continue; + + const auto& actor = actor_list.at(actor_status.aid); + const int max_considered = actor_status.max_considered; + + for (int times_considered = 0; times_considered < max_considered; times_considered++) { + std::stringstream stream; + s_mc_message_simcall_probe_one_t probe; -void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const + if (actor->simcall_.observer_ != nullptr) { + actor->simcall_.observer_->prepare(times_considered); + actor->simcall_.observer_->serialize(stream); + } else { + stream << (short)mc::Transition::Type::UNKNOWN; + } + + std::string str = stream.str(); + xbt_assert(str.size() + 1 <= probe.buffer.size(), + "The serialized transition is too large for the buffer. Please fix the code."); + strncpy(probe.buffer.data(), str.c_str(), probe.buffer.size() - 1); + probe.buffer.back() = '\0'; + + xbt_assert(channel_.send(probe) == 0, "Could not send ACTOR_TRANSITION_PROBE payload"); + } + // NOTE: We do NOT need to reset `times_considered` for each actor's + // simcall observer here to the "original" value (i.e. the value BEFORE + // multiple prepare() calls were made for serialization purposes) since + // each SIMCALL_EXECUTE provides a `times_considered` to be used to prepare + // the transition before execution. + } +} +void AppSide::handle_actors_maxpid() const { - bool res = simgrid::mc::actor_is_enabled(SIMIX_process_from_PID(msg->aid)); - s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res}; - channel_.send(answer); + s_mc_message_int_t answer = {}; + answer.type = MessageType::ACTORS_MAXPID_REPLY; + answer.value = kernel::actor::ActorImpl::get_maxpid(); + xbt_assert(channel_.send(answer) == 0, "Could not send response"); } #define assert_msg_size(_name_, _type_) \ xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size, \ sizeof(_type_)) -void AppSide::handle_messages() const +void AppSide::handle_messages() { - while (true) { + while (true) { // Until we get a CONTINUE message XBT_DEBUG("Waiting messages from model-checker"); std::array message_buffer; ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size()); + if (received_size == 0) { + XBT_DEBUG("Socket closed on the Checker side, bailing out."); + ::_Exit(0); // Nobody's listening to that process anymore => exit as quickly as possible. + } xbt_assert(received_size >= 0, "Could not receive commands from the model-checker"); + xbt_assert(static_cast(received_size) >= sizeof(s_mc_message_t), "Cannot handle short message (size=%zd)", + received_size); const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data(); switch (message->type) { @@ -126,58 +250,82 @@ void AppSide::handle_messages() const case MessageType::CONTINUE: assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t); - handle_continue(message); return; - case MessageType::SIMCALL_HANDLE: - assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t); - handle_simcall((s_mc_message_simcall_handle_t*)message_buffer.data()); + case MessageType::SIMCALL_EXECUTE: + assert_msg_size("SIMCALL_EXECUTE", s_mc_message_simcall_execute_t); + handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data()); + break; + + case MessageType::FINALIZE: + assert_msg_size("FINALIZE", s_mc_message_int_t); + handle_finalize((s_mc_message_int_t*)message_buffer.data()); break; - case MessageType::ACTOR_ENABLED: - assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t); - handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data()); + case MessageType::NEED_MEMINFO: + assert_msg_size("NEED_MEMINFO", s_mc_message_t); + handle_need_meminfo(); + break; + + case MessageType::ACTORS_STATUS: + assert_msg_size("ACTORS_STATUS", s_mc_message_t); + handle_actors_status(); + break; + + case MessageType::ACTORS_MAXPID: + assert_msg_size("ACTORS_MAXPID", s_mc_message_t); + handle_actors_maxpid(); break; default: - xbt_die("Received unexpected message %s (%i)", MC_message_type_name(message->type), - static_cast(message->type)); + xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast(message->type)); break; } } } -void AppSide::main_loop() const +void AppSide::main_loop() { + simgrid::mc::processes_time.resize(simgrid::kernel::actor::ActorImpl::get_maxpid()); + MC_ignore_heap(simgrid::mc::processes_time.data(), + simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0])); + + sthread_disable(); + coverage_checkpoint(); + sthread_enable(); while (true) { - simgrid::mc::wait_for_requests(); + simgrid::mc::execute_actors(); xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker"); this->handle_messages(); } } -void AppSide::report_assertion_failure() const +void AppSide::report_assertion_failure() { - if (channel_.send(MessageType::ASSERTION_FAILED)) - xbt_die("Could not send assertion to model-checker"); + xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker"); this->handle_messages(); } void AppSide::ignore_memory(void* addr, std::size_t size) const { - s_mc_message_ignore_memory_t message; + if (not MC_is_active() || not need_memory_info_) + return; + + s_mc_message_ignore_memory_t message = {}; message.type = MessageType::IGNORE_MEMORY; message.addr = (std::uintptr_t)addr; message.size = size; - if (channel_.send(message)) - xbt_die("Could not send IGNORE_MEMORY message to model-checker"); + xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker"); } void AppSide::ignore_heap(void* address, std::size_t size) const { + if (not MC_is_active() || not need_memory_info_) + return; + const s_xbt_mheap_t* heap = mmalloc_get_current_heap(); - s_mc_message_ignore_heap_t message; + s_mc_message_ignore_heap_t message = {}; message.type = MessageType::IGNORE_HEAP; message.address = address; message.size = size; @@ -190,49 +338,59 @@ void AppSide::ignore_heap(void* address, std::size_t size) const heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++; } - if (channel_.send(message)) - xbt_die("Could not send ignored region to MCer"); + xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer"); } void AppSide::unignore_heap(void* address, std::size_t size) const { - s_mc_message_ignore_memory_t message; + if (not MC_is_active() || not need_memory_info_) + return; + + s_mc_message_ignore_memory_t message = {}; message.type = MessageType::UNIGNORE_HEAP; message.addr = (std::uintptr_t)address; message.size = size; - if (channel_.send(message)) - xbt_die("Could not send IGNORE_HEAP message to model-checker"); + xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker"); } void AppSide::declare_symbol(const char* name, int* value) const { - s_mc_message_register_symbol_t message; + if (not MC_is_active() || not need_memory_info_) { + XBT_CRITICAL("Ignore AppSide::declare_symbol(%s)", name); + return; + } + + s_mc_message_register_symbol_t message = {}; message.type = MessageType::REGISTER_SYMBOL; - if (strlen(name) + 1 > sizeof(message.name)) - xbt_die("Symbol is too long"); - strncpy(message.name, name, sizeof(message.name)); + xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long"); + strncpy(message.name.data(), name, message.name.size() - 1); message.callback = nullptr; message.data = value; - if (channel_.send(message)) - xbt_die("Could send REGISTER_SYMBOL message to model-checker"); + xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker"); } +/** Register a stack in the model checker + * + * The stacks are allocated in the heap. The MC handle them specifically + * when we analyze/compare the content of the heap so it must be told where + * they are with this function. + */ void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const { + if (not MC_is_active() || not need_memory_info_) + return; + const s_xbt_mheap_t* heap = mmalloc_get_current_heap(); - s_stack_region_t region; - memset(®ion, 0, sizeof(region)); + s_stack_region_t region = {}; region.address = stack; region.context = context; region.size = size; region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1; - s_mc_message_stack_region_t message; + s_mc_message_stack_region_t message = {}; message.type = MessageType::STACK_REGION; message.stack_region = region; - if (channel_.send(message)) - xbt_die("Could not send STACK_REGION to model-checker"); + xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker"); } -} // namespace mc -} // namespace simgrid +} // namespace simgrid::mc