X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a36e8044de323971221f5da46773d54e312d3b3c..fd52ffa61dfc8d90d4a042240a3e389f0b86ca98:/src/mc/ModelChecker.cpp diff --git a/src/mc/ModelChecker.cpp b/src/mc/ModelChecker.cpp index af0c6668cb..93400edaf8 100644 --- a/src/mc/ModelChecker.cpp +++ b/src/mc/ModelChecker.cpp @@ -1,36 +1,22 @@ -/* Copyright (c) 2008-2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2008-2020. 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 - -#include -#include -#include -#include - -#include -#include - -#include -#include -#include -#include - -#include "simgrid/sg_config.h" - -#include "src/mc/ModelChecker.hpp" -#include "src/mc/PageStore.hpp" #include "src/mc/ModelChecker.hpp" -#include "src/mc/mc_protocol.h" -#include "src/mc/mc_private.h" -#include "src/mc/mc_ignore.h" -#include "src/mc/mc_exit.h" -#include "src/mc/mc_record.h" +#include "src/mc/Session.hpp" #include "src/mc/Transition.hpp" -#include "src/mc/Checker.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/RemoteSimulation.hpp" +#include "xbt/automaton.hpp" +#include "xbt/system_error.hpp" + +#include +#include +#include XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_ModelChecker, mc, "ModelChecker"); @@ -47,57 +33,44 @@ using simgrid::mc::remote; namespace simgrid { namespace mc { -ModelChecker::ModelChecker(std::unique_ptr process) : - base_(nullptr), - socket_event_(nullptr), - signal_event_(nullptr), - page_store_(500), - process_(std::move(process)), - parent_snapshot_(nullptr) +ModelChecker::ModelChecker(std::unique_ptr remote_simulation, int sockfd) + : checker_side_(sockfd), remote_simulation_(std::move(remote_simulation)) { - -} - -ModelChecker::~ModelChecker() { - if (socket_event_ != nullptr) - event_free(socket_event_); - if (signal_event_ != nullptr) - event_free(signal_event_); - if (base_ != nullptr) - event_base_free(base_); } void ModelChecker::start() { - const pid_t pid = process_->pid(); - - base_ = event_base_new(); - event_callback_fn event_callback = [](evutil_socket_t fd, short events, void *arg) - { - ((ModelChecker *)arg)->handle_events(fd, events); - }; - socket_event_ = event_new(base_, - process_->getChannel().getSocket(), - EV_READ|EV_PERSIST, - event_callback, this); - event_add(socket_event_, NULL); - signal_event_ = event_new(base_, - SIGCHLD, - EV_SIGNAL|EV_PERSIST, - event_callback, this); - event_add(signal_event_, NULL); + 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"); + } + }); 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 = remote_simulation_->pid(); + pid_t res = waitpid(pid, &status, WAITPID_CHECKED_FLAGS); - if (res < 0 || !WIFSTOPPED(status) || WSTOPSIG(status) != SIGSTOP) + if (res < 0 || not WIFSTOPPED(status) || WSTOPSIG(status) != SIGSTOP) xbt_die("Could not wait model-checked process"); - process_->init(); + remote_simulation_->init(); - if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0')) + if (not _sg_mc_dot_output_file.get().empty()) MC_init_dot_output(); setup_ignore(); @@ -112,29 +85,18 @@ void ModelChecker::start() #endif } -static const std::pair ignored_local_variables[] = { - std::pair{ "e", "*" }, - std::pair{ "__ex_cleanup", "*" }, - std::pair{ "__ex_mctx_en", "*" }, - std::pair{ "__ex_mctx_me", "*" }, - std::pair{ "__xbt_ex_ctx_ptr", "*" }, - std::pair{ "_log_ev", "*" }, - std::pair{ "_throw_ctx", "*" }, - std::pair{ "ctx", "*" }, - - std::pair{ "self", "simcall_BODY_mc_snapshot" }, - std::pair{ "next_context", "smx_ctx_sysv_suspend_serial" }, - std::pair{ "i", "smx_ctx_sysv_suspend_serial" }, - - /* Ignore local variable about time used for tracing */ - std::pair{ "start_time", "*" }, +static constexpr auto ignored_local_variables = { + std::make_pair("e", "*"), + std::make_pair("_log_ev", "*"), + + /* Ignore local variable about time used for tracing */ + std::make_pair("start_time", "*"), }; void ModelChecker::setup_ignore() { - Process& process = this->process(); - for (std::pair const& var : - ignored_local_variables) + const RemoteSimulation& process = this->get_remote_simulation(); + for (auto const& var : ignored_local_variables) process.ignore_local_variable(var.first, var.second); /* Static variable used for tracing */ @@ -143,34 +105,24 @@ void ModelChecker::setup_ignore() void ModelChecker::shutdown() { - XBT_DEBUG("Shuting down model-checker"); + XBT_DEBUG("Shutting down model-checker"); - simgrid::mc::Process* process = &this->process(); + RemoteSimulation* process = &this->get_remote_simulation(); if (process->running()) { XBT_DEBUG("Killing process"); - kill(process->pid(), SIGTERM); + kill(process->pid(), SIGKILL); process->terminate(); } } -void ModelChecker::resume(simgrid::mc::Process& process) +void ModelChecker::resume(RemoteSimulation& process) { - int res = process.getChannel().send(MC_MESSAGE_CONTINUE); + int res = checker_side_.get_channel().send(MessageType::CONTINUE); if (res) - throw simgrid::xbt::errno_error(); + throw xbt::errno_error(); process.clear_cache(); } -static -void throw_socket_error(int fd) -{ - int error = 0; - socklen_t errlen = sizeof(error); - if (getsockopt(fd, SOL_SOCKET, SO_ERROR, (void *)&error, &errlen) == -1) - error = errno; - throw simgrid::xbt::errno_error(); -} - static void MC_report_crash(int status) { XBT_INFO("**************************"); @@ -180,122 +132,103 @@ static void MC_report_crash(int status) XBT_INFO("From signal: %s", strsignal(WTERMSIG(status))); else if (WIFEXITED(status)) XBT_INFO("From exit: %i", WEXITSTATUS(status)); - if (WCOREDUMP(status)) - XBT_INFO("A core dump was generated by the system."); - else - XBT_INFO("No core dump was generated by the system."); + if (not xbt_log_no_loc) + XBT_INFO("%s core dump was generated by the system.", WCOREDUMP(status) ? "A" : "No"); XBT_INFO("Counter-example execution trace:"); - simgrid::mc::dumpRecordPath(); - for (auto& s : mc_model_checker->getChecker()->getTextualTrace()) - XBT_INFO("%s", s.c_str()); - simgrid::mc::session->logState(); - XBT_INFO("Stack trace:"); - mc_model_checker->process().dumpStack(); + for (auto const& s : mc_model_checker->getChecker()->get_textual_trace()) + XBT_INFO(" %s", s.c_str()); + dumpRecordPath(); + session->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->get_remote_simulation().dump_stack(); + } } -static void MC_report_assertion_error(void) +static void MC_report_assertion_error() { XBT_INFO("**************************"); XBT_INFO("*** PROPERTY NOT VALID ***"); XBT_INFO("**************************"); XBT_INFO("Counter-example execution trace:"); - simgrid::mc::dumpRecordPath(); - for (auto& s : mc_model_checker->getChecker()->getTextualTrace()) - XBT_INFO("%s", s.c_str()); - simgrid::mc::session->logState(); + 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(char* buffer, ssize_t size) +bool ModelChecker::handle_message(const char* buffer, ssize_t size) { s_mc_message_t base_message; - if (size < (ssize_t) sizeof(base_message)) - xbt_die("Broken message"); + xbt_assert(size >= (ssize_t)sizeof(base_message), "Broken message"); memcpy(&base_message, buffer, sizeof(base_message)); switch(base_message.type) { - - case MC_MESSAGE_IGNORE_HEAP: - { - s_mc_ignore_heap_message_t message; - if (size != sizeof(message)) - xbt_die("Broken messsage"); + 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.block = message.block; region.fragment = message.fragment; - region.address = message.address; - region.size = message.size; - process().ignore_heap(region); + region.address = message.address; + region.size = message.size; + get_remote_simulation().ignore_heap(region); break; } - case MC_MESSAGE_UNIGNORE_HEAP: - { - s_mc_ignore_memory_message_t message; - if (size != sizeof(message)) - xbt_die("Broken messsage"); + case MessageType::UNIGNORE_HEAP: { + s_mc_message_ignore_memory_t message; + xbt_assert(size == sizeof(message), "Broken message"); memcpy(&message, buffer, sizeof(message)); - process().unignore_heap( - (void *)(std::uintptr_t) message.addr, message.size); + get_remote_simulation().unignore_heap((void*)(std::uintptr_t)message.addr, message.size); break; } - case MC_MESSAGE_IGNORE_MEMORY: - { - s_mc_ignore_memory_message_t message; - if (size != sizeof(message)) - xbt_die("Broken messsage"); + case MessageType::IGNORE_MEMORY: { + s_mc_message_ignore_memory_t message; + xbt_assert(size == sizeof(message), "Broken message"); memcpy(&message, buffer, sizeof(message)); - this->process().ignore_region(message.addr, message.size); + this->get_remote_simulation().ignore_region(message.addr, message.size); break; } - case MC_MESSAGE_STACK_REGION: - { - s_mc_stack_region_message_t message; - if (size != sizeof(message)) - xbt_die("Broken messsage"); + case MessageType::STACK_REGION: { + s_mc_message_stack_region_t message; + xbt_assert(size == sizeof(message), "Broken message"); memcpy(&message, buffer, sizeof(message)); - this->process().stack_areas().push_back(message.stack_region); - } - break; + this->get_remote_simulation().stack_areas().push_back(message.stack_region); + } break; - case MC_MESSAGE_REGISTER_SYMBOL: - { - s_mc_register_symbol_message_t message; - if (size != sizeof(message)) - xbt_die("Broken message"); + case MessageType::REGISTER_SYMBOL: { + s_mc_message_register_symbol_t message; + xbt_assert(size == sizeof(message), "Broken message"); memcpy(&message, buffer, sizeof(message)); - if (message.callback) - xbt_die("Support for client-side function proposition is not implemented."); + xbt_assert(not message.callback, "Support for client-side function proposition is not implemented."); XBT_DEBUG("Received symbol: %s", message.name); - if (simgrid::mc::property_automaton == nullptr) - simgrid::mc::property_automaton = xbt_automaton_new(); + if (property_automaton == nullptr) + property_automaton = xbt_automaton_new(); - simgrid::mc::Process* process = &this->process(); - simgrid::mc::RemotePtr address - = simgrid::mc::remote((int*) message.data); - simgrid::xbt::add_proposition(simgrid::mc::property_automaton, - message.name, - [process, address]() { return process->read(address); } - ); + const RemoteSimulation* process = &this->get_remote_simulation(); + RemotePtr address = remote((int*)message.data); + xbt::add_proposition(property_automaton, message.name, [process, address]() { return process->read(address); }); break; } - case MC_MESSAGE_WAITING: - return false; + case MessageType::WAITING: + return false; - case MC_MESSAGE_ASSERTION_FAILED: - MC_report_assertion_error(); - this->exit(SIMGRID_MC_EXIT_SAFETY); - break; - - default: - xbt_die("Unexpected message from model-checked application"); + case MessageType::ASSERTION_FAILED: + MC_report_assertion_error(); + this->exit(SIMGRID_MC_EXIT_SAFETY); + default: + xbt_die("Unexpected message from model-checked application"); } return true; } @@ -304,36 +237,11 @@ bool ModelChecker::handle_message(char* buffer, ssize_t size) void ModelChecker::exit(int status) { // TODO, terminate the model checker politely instead of exiting rudely - if (process().running()) - kill(process().pid(), SIGKILL); + if (get_remote_simulation().running()) + kill(get_remote_simulation().pid(), SIGKILL); ::exit(status); } -void ModelChecker::handle_events(int fd, short events) -{ - if (events == EV_READ) { - char buffer[MC_MESSAGE_LENGTH]; - ssize_t size = process_->getChannel().receive(buffer, sizeof(buffer), false); - if (size == -1 && errno != EAGAIN) - throw simgrid::xbt::errno_error(); - if (!handle_message(buffer, size)) { - event_base_loopbreak(base_); - } - } - else if (events == EV_SIGNAL) { - on_signal(fd); - } - else { - xbt_die("Unexpected event"); - } -} - -void ModelChecker::loop() -{ - if (this->process().running()) - event_base_dispatch(base_); -} - void ModelChecker::handle_waitpid() { XBT_DEBUG("Check for wait event"); @@ -343,23 +251,20 @@ void ModelChecker::handle_waitpid() if (pid == -1) { if (errno == ECHILD) { // No more children: - if (this->process().running()) - xbt_die("Inconsistent state"); - else - break; + xbt_assert(not this->get_remote_simulation().running(), "Inconsistent state"); + break; } else { XBT_ERROR("Could not wait for pid"); throw simgrid::xbt::errno_error(); } } - if (pid == this->process().pid()) { - + if (pid == this->get_remote_simulation().pid()) { // From PTRACE_O_TRACEEXIT: #ifdef __linux__ if (status>>8 == (SIGTRAP | (PTRACE_EVENT_EXIT<<8))) { - if (ptrace(PTRACE_GETEVENTMSG, this->process().pid(), 0, &status) == -1) - xbt_die("Could not get exit status"); + xbt_assert(ptrace(PTRACE_GETEVENTMSG, remote_simulation_->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); @@ -372,70 +277,58 @@ 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_simulation_->pid(), 0, WSTOPSIG(status)); #elif defined BSD - ptrace(PT_CONTINUE, this->process().pid(), (caddr_t)1, WSTOPSIG(status)); + ptrace(PT_CONTINUE, remote_simulation_->pid(), (caddr_t)1, WSTOPSIG(status)); #endif - if (errno != 0) - xbt_die("Could not PTRACE_CONT"); + xbt_assert(errno == 0, "Could not PTRACE_CONT"); } - else if (WIFEXITED(status) || WIFSIGNALED(status)) { + else if (WIFSIGNALED(status)) { + MC_report_crash(status); + mc_model_checker->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH); + } else if (WIFEXITED(status)) { XBT_DEBUG("Child process is over"); - this->process().terminate(); + this->get_remote_simulation().terminate(); } } } } -void ModelChecker::on_signal(int signo) -{ - switch(signo) { - case SIGCHLD: - this->handle_waitpid(); - break; - default: - break; - } -} - -void ModelChecker::wait_client(simgrid::mc::Process& process) +void ModelChecker::wait_for_requests() { - this->resume(process); - if (this->process().running()) - event_base_dispatch(base_); + this->resume(get_remote_simulation()); + if (this->get_remote_simulation().running()) + checker_side_.dispatch(); } void ModelChecker::handle_simcall(Transition const& transition) { - s_mc_simcall_handle_message m; + s_mc_message_simcall_handle_t m; memset(&m, 0, sizeof(m)); - m.type = MC_MESSAGE_SIMCALL_HANDLE; - m.pid = transition.pid; - m.value = transition.argument; - this->process_->getChannel().send(m); - this->process_->clear_cache(); - if (this->process_->running()) - event_base_dispatch(base_); + m.type = MessageType::SIMCALL_HANDLE; + m.pid = transition.pid_; + m.value = transition.argument_; + checker_side_.get_channel().send(m); + this->remote_simulation_->clear_cache(); + if (this->remote_simulation_->running()) + checker_side_.dispatch(); } bool ModelChecker::checkDeadlock() { - int res; - if ((res = this->process().getChannel().send(MC_MESSAGE_DEADLOCK_CHECK))) - xbt_die("Could not check deadlock state"); - s_mc_int_message_t message; - ssize_t s = mc_model_checker->process().getChannel().receive(message); - if (s == -1) - xbt_die("Could not receive message"); - if (s != sizeof(message) || message.type != MC_MESSAGE_DEADLOCK_CHECK_REPLY) - xbt_die("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, (int) sizeof(message) - ); + int res = checker_side_.get_channel().send(MessageType::DEADLOCK_CHECK); + xbt_assert(res == 0, "Could not check deadlock state"); + s_mc_message_int_t 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 == MessageType::DEADLOCK_CHECK_REPLY, + "Received unexpected message %s (%i, size=%i) " + "expected MessageType::DEADLOCK_CHECK_REPLY (%i, size=%i)", + MC_message_type_name(message.type), (int)message.type, (int)s, (int)MessageType::DEADLOCK_CHECK_REPLY, + (int)sizeof(message)); return message.value != 0; } -} -} +} // namespace mc +} // namespace simgrid