X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/799a432e8ac74a0a84feb8dbf7a78a14068050b3..a3bd84b0137a58fad3300f954dbc43328ff1410e:/src/mc/ModelChecker.cpp diff --git a/src/mc/ModelChecker.cpp b/src/mc/ModelChecker.cpp index d00907cc6a..a7f0a6d057 100644 --- a/src/mc/ModelChecker.cpp +++ b/src/mc/ModelChecker.cpp @@ -1,19 +1,22 @@ -/* Copyright (c) 2008-2020. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2008-2022. 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/ModelChecker.hpp" #include "src/mc/Session.hpp" -#include "src/mc/Transition.hpp" +#include "src/mc/api/Transition.hpp" +#include "src/mc/api/TransitionComm.hpp" #include "src/mc/checker/Checker.hpp" #include "src/mc/mc_config.hpp" #include "src/mc/mc_exit.hpp" #include "src/mc/mc_private.hpp" -#include "src/mc/remote/RemoteClientMemory.hpp" +#include "src/mc/remote/RemoteProcess.hpp" #include "xbt/automaton.hpp" #include "xbt/system_error.hpp" +#include +#include #include #include @@ -32,25 +35,41 @@ using simgrid::mc::remote; namespace simgrid { namespace mc { -ModelChecker::ModelChecker(std::unique_ptr process) : process_(std::move(process)) {} +ModelChecker::ModelChecker(std::unique_ptr remote_simulation, int sockfd) + : checker_side_(sockfd), remote_process_(std::move(remote_simulation)) +{ +} void ModelChecker::start() { - event_loop_.start(process_->get_channel().get_socket(), [](evutil_socket_t sig, short events, void* arg) { - ((ModelChecker*)arg)->handle_events(sig, events); - }); + checker_side_.start( + [](evutil_socket_t sig, short events, void* arg) { + auto mc = static_cast(arg); + if (events == EV_READ) { + std::array buffer; + ssize_t size = mc->checker_side_.get_channel().receive(buffer.data(), buffer.size(), false); + if (size == -1 && errno != EAGAIN) + throw simgrid::xbt::errno_error(); + + if (not mc->handle_message(buffer.data(), size)) + mc->checker_side_.break_loop(); + } else if (events == EV_SIGNAL) { + if (sig == SIGCHLD) + mc->handle_waitpid(); + } else { + xbt_die("Unexpected event"); + } + }, + this); XBT_DEBUG("Waiting for the model-checked process"); int status; // The model-checked process SIGSTOP itself to signal it's ready: - const pid_t pid = process_->pid(); + const pid_t pid = remote_process_->pid(); - pid_t res = waitpid(pid, &status, WAITPID_CHECKED_FLAGS); - if (res < 0 || not WIFSTOPPED(status) || WSTOPSIG(status) != SIGSTOP) - xbt_die("Could not wait model-checked process"); - - process_->init(); + xbt_assert(waitpid(pid, &status, WAITPID_CHECKED_FLAGS) == pid && WIFSTOPPED(status) && WSTOPSIG(status) == SIGSTOP, + "Could not wait model-checked process"); if (not _sg_mc_dot_output_file.get().empty()) MC_init_dot_output(); @@ -67,19 +86,18 @@ void ModelChecker::start() #endif } -static const std::pair ignored_local_variables[] = { - std::pair{ "e", "*" }, - std::pair{ "_log_ev", "*" }, +static constexpr auto ignored_local_variables = { + std::make_pair("e", "*"), + std::make_pair("_log_ev", "*"), - /* Ignore local variable about time used for tracing */ - std::pair{ "start_time", "*" }, + /* Ignore local variable about time used for tracing */ + std::make_pair("start_time", "*"), }; void ModelChecker::setup_ignore() { - RemoteClientMemory& process = this->process(); - for (std::pair const& var : - ignored_local_variables) + const RemoteProcess& process = this->get_remote_process(); + for (auto const& var : ignored_local_variables) process.ignore_local_variable(var.first, var.second); /* Static variable used for tracing */ @@ -88,22 +106,23 @@ void ModelChecker::setup_ignore() void ModelChecker::shutdown() { - XBT_DEBUG("Shuting down model-checker"); + XBT_DEBUG("Shutting down model-checker"); - RemoteClientMemory* process = &this->process(); - if (process->running()) { + RemoteProcess& process = get_remote_process(); + if (process.running()) { XBT_DEBUG("Killing process"); - kill(process->pid(), SIGKILL); - process->terminate(); + finalize_app(true); + kill(process.pid(), SIGKILL); + process.terminate(); } } -void ModelChecker::resume(RemoteClientMemory& process) +void ModelChecker::resume() { - int res = process.get_channel().send(MC_MESSAGE_CONTINUE); + int res = checker_side_.get_channel().send(MessageType::CONTINUE); if (res) throw xbt::errno_error(); - process.clear_cache(); + remote_process_->clear_cache(); } static void MC_report_crash(int status) @@ -121,27 +140,15 @@ static void MC_report_crash(int status) for (auto const& s : mc_model_checker->getChecker()->get_textual_trace()) XBT_INFO(" %s", s.c_str()); dumpRecordPath(); - session->log_state(); + session_singleton->log_state(); if (xbt_log_no_loc) { XBT_INFO("Stack trace not displayed because you passed --log=no_loc"); } else { XBT_INFO("Stack trace:"); - mc_model_checker->process().dump_stack(); + mc_model_checker->get_remote_process().dump_stack(); } } -static void MC_report_assertion_error() -{ - XBT_INFO("**************************"); - XBT_INFO("*** PROPERTY NOT VALID ***"); - XBT_INFO("**************************"); - XBT_INFO("Counter-example execution trace:"); - for (auto const& s : mc_model_checker->getChecker()->get_textual_trace()) - XBT_INFO(" %s", s.c_str()); - dumpRecordPath(); - session->log_state(); -} - bool ModelChecker::handle_message(const char* buffer, ssize_t size) { s_mc_message_t base_message; @@ -149,75 +156,87 @@ bool ModelChecker::handle_message(const char* buffer, ssize_t size) memcpy(&base_message, buffer, sizeof(base_message)); switch(base_message.type) { - case MC_MESSAGE_IGNORE_HEAP: - { - s_mc_message_ignore_heap_t message; - xbt_assert(size == sizeof(message), "Broken messsage"); - memcpy(&message, buffer, sizeof(message)); - - IgnoredHeapRegion region; - region.block = message.block; - region.fragment = message.fragment; - region.address = message.address; - region.size = message.size; - process().ignore_heap(region); - break; - } + case MessageType::INITIAL_ADDRESSES: { + s_mc_message_initial_addresses_t message; + xbt_assert(size == sizeof(message), "Broken message. Got %d bytes instead of %d.", (int)size, (int)sizeof(message)); + memcpy(&message, buffer, sizeof(message)); - case MC_MESSAGE_UNIGNORE_HEAP: - { - s_mc_message_ignore_memory_t message; - xbt_assert(size == sizeof(message), "Broken messsage"); - memcpy(&message, buffer, sizeof(message)); - process().unignore_heap((void*)(std::uintptr_t)message.addr, message.size); - break; + get_remote_process().init(message.mmalloc_default_mdp, message.maxpid, message.actors, message.dead_actors); + break; } - case MC_MESSAGE_IGNORE_MEMORY: - { - s_mc_message_ignore_memory_t message; - xbt_assert(size == sizeof(message), "Broken messsage"); - memcpy(&message, buffer, sizeof(message)); - this->process().ignore_region(message.addr, message.size); - break; + case MessageType::IGNORE_HEAP: { + s_mc_message_ignore_heap_t message; + xbt_assert(size == sizeof(message), "Broken message"); + memcpy(&message, buffer, sizeof(message)); + + IgnoredHeapRegion region; + region.block = message.block; + region.fragment = message.fragment; + region.address = message.address; + region.size = message.size; + get_remote_process().ignore_heap(region); + break; } - case MC_MESSAGE_STACK_REGION: - { - s_mc_message_stack_region_t message; - xbt_assert(size == sizeof(message), "Broken messsage"); - memcpy(&message, buffer, sizeof(message)); - this->process().stack_areas().push_back(message.stack_region); + case MessageType::UNIGNORE_HEAP: { + s_mc_message_ignore_memory_t message; + xbt_assert(size == sizeof(message), "Broken message"); + memcpy(&message, buffer, sizeof(message)); + get_remote_process().unignore_heap((void*)(std::uintptr_t)message.addr, message.size); + break; } - break; - - case MC_MESSAGE_REGISTER_SYMBOL: - { - s_mc_message_register_symbol_t message; - xbt_assert(size == sizeof(message), "Broken message"); - memcpy(&message, buffer, sizeof(message)); - xbt_assert(not message.callback, "Support for client-side function proposition is not implemented."); - XBT_DEBUG("Received symbol: %s", message.name); - if (property_automaton == nullptr) - property_automaton = xbt_automaton_new(); - - RemoteClientMemory* process = &this->process(); - RemotePtr address = remote((int*)message.data); - xbt::add_proposition(property_automaton, message.name, [process, address]() { return process->read(address); }); + case MessageType::IGNORE_MEMORY: { + s_mc_message_ignore_memory_t message; + xbt_assert(size == sizeof(message), "Broken message"); + memcpy(&message, buffer, sizeof(message)); + this->get_remote_process().ignore_region(message.addr, message.size); + break; + } - break; + case MessageType::STACK_REGION: { + s_mc_message_stack_region_t message; + xbt_assert(size == sizeof(message), "Broken message"); + memcpy(&message, buffer, sizeof(message)); + this->get_remote_process().stack_areas().push_back(message.stack_region); + } break; + + case MessageType::REGISTER_SYMBOL: { + s_mc_message_register_symbol_t message; + xbt_assert(size == sizeof(message), "Broken message"); + memcpy(&message, buffer, sizeof(message)); + xbt_assert(not message.callback, "Support for client-side function proposition is not implemented."); + XBT_DEBUG("Received symbol: %s", message.name.data()); + + if (property_automaton == nullptr) + property_automaton = xbt_automaton_new(); + + const RemoteProcess* process = &this->get_remote_process(); + RemotePtr address = remote((int*)message.data); + xbt::add_proposition(property_automaton, message.name.data(), + [process, address]() { return process->read(address); }); + + break; } - case MC_MESSAGE_WAITING: - return false; + case MessageType::WAITING: + return false; + + case MessageType::ASSERTION_FAILED: + XBT_INFO("**************************"); + XBT_INFO("*** PROPERTY NOT VALID ***"); + XBT_INFO("**************************"); + XBT_INFO("Counter-example execution trace:"); + for (auto const& s : getChecker()->get_textual_trace()) + XBT_INFO(" %s", s.c_str()); + dumpRecordPath(); + session_singleton->log_state(); - case MC_MESSAGE_ASSERTION_FAILED: - MC_report_assertion_error(); - this->exit(SIMGRID_MC_EXIT_SAFETY); + this->exit(SIMGRID_MC_EXIT_SAFETY); - default: - xbt_die("Unexpected message from model-checked application"); + default: + xbt_die("Unexpected message from model-checked application"); } return true; } @@ -225,32 +244,10 @@ bool ModelChecker::handle_message(const char* buffer, ssize_t size) /** Terminate the model-checker application */ void ModelChecker::exit(int status) { - // TODO, terminate the model checker politely instead of exiting rudely - if (process().running()) - kill(process().pid(), SIGKILL); + shutdown(); ::exit(status); } -void ModelChecker::handle_events(int sig, short events) -{ - if (events == EV_READ) { - char buffer[MC_MESSAGE_LENGTH]; - ssize_t size = process_->get_channel().receive(buffer, sizeof(buffer), false); - if (size == -1 && errno != EAGAIN) - throw simgrid::xbt::errno_error(); - - if (not handle_message(buffer, size)) - event_loop_.break_loop(); - } - else if (events == EV_SIGNAL) { - if (sig == SIGCHLD) - this->handle_waitpid(); - } - else { - xbt_die("Unexpected event"); - } -} - void ModelChecker::handle_waitpid() { XBT_DEBUG("Check for wait event"); @@ -260,7 +257,7 @@ void ModelChecker::handle_waitpid() if (pid == -1) { if (errno == ECHILD) { // No more children: - xbt_assert(not this->process().running(), "Inconsistent state"); + xbt_assert(not this->get_remote_process().running(), "Inconsistent state"); break; } else { XBT_ERROR("Could not wait for pid"); @@ -268,14 +265,15 @@ void ModelChecker::handle_waitpid() } } - if (pid == this->process().pid()) { + if (pid == this->get_remote_process().pid()) { // From PTRACE_O_TRACEEXIT: #ifdef __linux__ if (status>>8 == (SIGTRAP | (PTRACE_EVENT_EXIT<<8))) { - xbt_assert(ptrace(PTRACE_GETEVENTMSG, this->process().pid(), 0, &status) != -1, "Could not get exit status"); + xbt_assert(ptrace(PTRACE_GETEVENTMSG, remote_process_->pid(), 0, &status) != -1, "Could not get exit status"); if (WIFSIGNALED(status)) { MC_report_crash(status); - mc_model_checker->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH); + this->get_remote_process().terminate(); + this->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH); } } #endif @@ -285,19 +283,20 @@ void ModelChecker::handle_waitpid() XBT_DEBUG("Stopped with signal %i", (int) WSTOPSIG(status)); errno = 0; #ifdef __linux__ - ptrace(PTRACE_CONT, this->process().pid(), 0, WSTOPSIG(status)); + ptrace(PTRACE_CONT, remote_process_->pid(), 0, WSTOPSIG(status)); #elif defined BSD - ptrace(PT_CONTINUE, this->process().pid(), (caddr_t)1, WSTOPSIG(status)); + ptrace(PT_CONTINUE, remote_process_->pid(), (caddr_t)1, WSTOPSIG(status)); #endif xbt_assert(errno == 0, "Could not PTRACE_CONT"); } else if (WIFSIGNALED(status)) { MC_report_crash(status); - mc_model_checker->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH); + this->get_remote_process().terminate(); + this->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH); } else if (WIFEXITED(status)) { XBT_DEBUG("Child process is over"); - this->process().terminate(); + this->get_remote_process().terminate(); } } } @@ -305,35 +304,109 @@ void ModelChecker::handle_waitpid() void ModelChecker::wait_for_requests() { - this->resume(process()); - if (this->process().running()) - event_loop_.dispatch(); + this->resume(); + if (this->get_remote_process().running()) + checker_side_.dispatch(); } -void ModelChecker::handle_simcall(Transition const& transition) +Transition* ModelChecker::handle_simcall(Transition const& transition, bool new_transition) { - s_mc_message_simcall_handle_t m; + s_mc_message_simcall_execute_t m; memset(&m, 0, sizeof(m)); - m.type = MC_MESSAGE_SIMCALL_HANDLE; - m.pid = transition.pid_; - m.value = transition.argument_; - this->process_->get_channel().send(m); - this->process_->clear_cache(); - if (this->process_->running()) - event_loop_.dispatch(); + m.type = MessageType::SIMCALL_EXECUTE; + m.aid_ = transition.aid_; + m.times_considered_ = transition.times_considered_; + checker_side_.get_channel().send(m); + + s_mc_message_simcall_execute_answer_t answer; + ssize_t s = checker_side_.get_channel().receive(answer); + xbt_assert(s != -1, "Could not receive message"); + xbt_assert(s == sizeof(answer) && answer.type == MessageType::SIMCALL_EXECUTE_ANSWER, + "Received unexpected message %s (%i, size=%i) " + "expected MessageType::SIMCALL_EXECUTE_ANSWER (%i, size=%i)", + to_c_str(answer.type), (int)answer.type, (int)s, (int)MessageType::SIMCALL_EXECUTE_ANSWER, + (int)sizeof(answer)); + + this->remote_process_->clear_cache(); + if (this->remote_process_->running()) + checker_side_.dispatch(); // The app may send messages while processing the transition + + if (new_transition) + return recv_transition(transition.aid_, transition.times_considered_, answer.simcall, answer.buffer); + else + return nullptr; +} +bool ModelChecker::simcall_is_visible(aid_t aid) +{ + xbt_assert(mc_model_checker != nullptr, "This should be called from the checker side"); + + s_mc_message_simcall_is_visible_t m; + memset(&m, 0, sizeof(m)); + m.type = MessageType::SIMCALL_IS_VISIBLE; + m.aid = aid; + checker_side_.get_channel().send(m); + + s_mc_message_simcall_is_visible_answer_t answer; + ssize_t s = checker_side_.get_channel().receive(answer); + xbt_assert(s != -1, "Could not receive message"); + xbt_assert(s == sizeof(answer) && answer.type == MessageType::SIMCALL_IS_VISIBLE_ANSWER, + "Received unexpected message %s (%i, size=%i) " + "expected MessageType::SIMCALL_IS_VISIBLE_ANSWER (%i, size=%i)", + to_c_str(answer.type), (int)answer.type, (int)s, (int)MessageType::SIMCALL_IS_VISIBLE_ANSWER, + (int)sizeof(answer)); + + XBT_DEBUG("is_visible(%ld) is returning %s", aid, answer.value ? "true" : "false"); + + this->remote_process_->clear_cache(); + return answer.value; +} + +std::string ModelChecker::simcall_dot_label(aid_t aid, int times_considered) +{ + xbt_assert(mc_model_checker != nullptr, "This should be called from the checker side"); + + s_mc_message_simcall_to_string_t m; + memset(&m, 0, sizeof(m)); + m.type = MessageType::SIMCALL_DOT_LABEL; + m.aid = aid; + m.time_considered = times_considered; + checker_side_.get_channel().send(m); + + s_mc_message_simcall_to_string_answer_t answer; + ssize_t s = checker_side_.get_channel().receive(answer); + xbt_assert(s != -1, "Could not receive message"); + xbt_assert(s == sizeof(answer) && answer.type == MessageType::SIMCALL_DOT_LABEL_ANSWER, + "Received unexpected message %s (%i, size=%i) " + "expected MessageType::SIMCALL_TO_STRING_ANSWER (%i, size=%i)", + to_c_str(answer.type), (int)answer.type, (int)s, (int)MessageType::SIMCALL_DOT_LABEL_ANSWER, + (int)sizeof(answer)); + + XBT_DEBUG("dot_label(%ld) is returning %s", aid, answer.value); + return answer.value; +} + +void ModelChecker::finalize_app(bool terminate_asap) +{ + s_mc_message_int_t m; + memset(&m, 0, sizeof m); + m.type = MessageType::FINALIZE; + m.value = terminate_asap; + xbt_assert(checker_side_.get_channel().send(m) == 0, "Could not ask the app to finalize on need"); + + s_mc_message_t answer; + xbt_assert(checker_side_.get_channel().receive(answer) != -1, "Could not receive answer to FINALIZE"); } bool ModelChecker::checkDeadlock() { - int res = this->process().get_channel().send(MC_MESSAGE_DEADLOCK_CHECK); - xbt_assert(res == 0, "Could not check deadlock state"); + xbt_assert(checker_side_.get_channel().send(MessageType::DEADLOCK_CHECK) == 0, "Could not check deadlock state"); s_mc_message_int_t message; - ssize_t s = mc_model_checker->process().get_channel().receive(message); + ssize_t s = checker_side_.get_channel().receive(message); xbt_assert(s != -1, "Could not receive message"); - xbt_assert(s == sizeof(message) && message.type == MC_MESSAGE_DEADLOCK_CHECK_REPLY, + xbt_assert(s == sizeof(message) && message.type == MessageType::DEADLOCK_CHECK_REPLY, "Received unexpected message %s (%i, size=%i) " - "expected MC_MESSAGE_DEADLOCK_CHECK_REPLY (%i, size=%i)", - MC_message_type_name(message.type), (int)message.type, (int)s, (int)MC_MESSAGE_DEADLOCK_CHECK_REPLY, + "expected MessageType::DEADLOCK_CHECK_REPLY (%i, size=%i)", + to_c_str(message.type), (int)message.type, (int)s, (int)MessageType::DEADLOCK_CHECK_REPLY, (int)sizeof(message)); return message.value != 0; }