X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2f531aa69f09fed380e2e212df5822874aab5e58..403af5e6247ce6452b721f418a5b41e4548efac4:/src/mc/ModelChecker.cpp diff --git a/src/mc/ModelChecker.cpp b/src/mc/ModelChecker.cpp index 92be55851a..53ebd7efbd 100644 --- a/src/mc/ModelChecker.cpp +++ b/src/mc/ModelChecker.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2008-2015. The SimGrid Team. +/* Copyright (c) 2008-2017. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it @@ -6,185 +6,193 @@ #include -#include #include #include #include -#include #include #include #include -#include -#include -#include +#include "xbt/automaton.h" +#include "xbt/automaton.hpp" +#include "xbt/log.h" +#include "xbt/system_error.hpp" #include "simgrid/sg_config.h" -#include "ModelChecker.hpp" -#include "PageStore.hpp" -#include "ModelChecker.hpp" -#include "mc_protocol.h" -#include "mc_private.h" -#include "mc_ignore.h" -#include "mc_exit.h" -#include "src/mc/mc_liveness.h" - -extern "C" { +#include "src/mc/ModelChecker.hpp" +#include "src/mc/ModelChecker.hpp" +#include "src/mc/PageStore.hpp" +#include "src/mc/Transition.hpp" +#include "src/mc/checker/Checker.hpp" +#include "src/mc/mc_exit.hpp" +#include "src/mc/mc_private.hpp" +#include "src/mc/mc_record.hpp" +#include "src/mc/remote/mc_protocol.h" XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_ModelChecker, mc, "ModelChecker"); -} - ::simgrid::mc::ModelChecker* mc_model_checker = nullptr; +extern std::string _sg_mc_dot_output_file; using simgrid::mc::remote; -// Hardcoded index for now: -#define SOCKET_FD_INDEX 0 -#define SIGNAL_FD_INDEX 1 +#ifdef __linux__ +# define WAITPID_CHECKED_FLAGS __WALL +#else +# define WAITPID_CHECKED_FLAGS 0 +#endif namespace simgrid { namespace mc { -ModelChecker::ModelChecker(pid_t pid, int socket) : - pid_(pid), socket_(socket), - hostnames_(xbt_dict_new()), - page_store_(500), - parent_snapshot_(nullptr) +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() -{ - xbt_dict_free(&this->hostnames_); } -const char* ModelChecker::get_host_name(const char* hostname) -{ - // Lookup the host name in the dictionary (or create it): - xbt_dictelm_t elt = xbt_dict_get_elm_or_null(this->hostnames_, hostname); - if (!elt) { - xbt_dict_set(this->hostnames_, hostname, nullptr, nullptr); - elt = xbt_dict_get_elm_or_null(this->hostnames_, hostname); - assert(elt); - } - return elt->key; +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() { - // Block SIGCHLD (this will be handled with accept/signalfd): - sigset_t set; - sigemptyset(&set); - sigaddset(&set, SIGCHLD); - if (sigprocmask(SIG_BLOCK, &set, nullptr) == -1) - throw std::system_error(errno, std::system_category()); - - sigset_t full_set; - sigfillset(&full_set); - - // Prepare data for poll: - - struct pollfd* socket_pollfd = &fds_[SOCKET_FD_INDEX]; - socket_pollfd->fd = socket_; - socket_pollfd->events = POLLIN; - socket_pollfd->revents = 0; - - int signal_fd = signalfd(-1, &set, 0); - if (signal_fd == -1) - throw std::system_error(errno, std::system_category()); - - struct pollfd* signalfd_pollfd = &fds_[SIGNAL_FD_INDEX]; - signalfd_pollfd->fd = signal_fd; - signalfd_pollfd->events = POLLIN; - signalfd_pollfd->revents = 0; + 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); XBT_DEBUG("Waiting for the model-checked process"); int status; // The model-checked process SIGSTOP itself to signal it's ready: - pid_t res = waitpid(pid_, &status, __WALL); - if (res < 0 || !WIFSTOPPED(status) || WSTOPSIG(status) != SIGSTOP) + 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"); - assert(process_ == nullptr); - process_ = std::unique_ptr(new Process(pid_, socket_)); - // TODO, avoid direct dependency on sg_cfg - process_->privatized(sg_cfg_get_boolean("smpi/privatize_global_variables")); - - /* Initialize statistics */ - mc_stats = xbt_new0(s_mc_stats_t, 1); - mc_stats->state_size = 1; + process_->init(); - if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0')) + if (not _sg_mc_dot_output_file.empty()) MC_init_dot_output(); - /* Init parmap */ - //parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT); - setup_ignore(); - ptrace(PTRACE_SETOPTIONS, pid_, nullptr, PTRACE_O_TRACEEXIT); - ptrace(PTRACE_CONT, pid_, 0, 0); +#ifdef __linux__ + ptrace(PTRACE_SETOPTIONS, pid, nullptr, PTRACE_O_TRACEEXIT); + ptrace(PTRACE_CONT, pid, 0, 0); +#elif defined BSD + ptrace(PT_CONTINUE, pid, (caddr_t)1, 0); +#else +# error "no ptrace equivalent coded for this platform" +#endif } -void ModelChecker::setup_ignore() -{ - /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */ - MC_ignore_local_variable("e", "*"); - MC_ignore_local_variable("__ex_cleanup", "*"); - MC_ignore_local_variable("__ex_mctx_en", "*"); - MC_ignore_local_variable("__ex_mctx_me", "*"); - MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*"); - MC_ignore_local_variable("_log_ev", "*"); - MC_ignore_local_variable("_throw_ctx", "*"); - MC_ignore_local_variable("ctx", "*"); - - MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot"); - MC_ignore_local_variable("next_cont" - "ext", "smx_ctx_sysv_suspend_serial"); - MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial"); +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 */ - MC_ignore_local_variable("start_time", "*"); + std::pair{ "start_time", "*" }, +}; - /* Static variable used for tracing */ - this->process().ignore_global_variable("counter"); +void ModelChecker::setup_ignore() +{ + RemoteClient& process = this->process(); + for (std::pair const& var : + ignored_local_variables) + process.ignore_local_variable(var.first, var.second); - /* SIMIX */ - this->process().ignore_global_variable("smx_total_comms"); + /* Static variable used for tracing */ + process.ignore_global_variable("counter"); } void ModelChecker::shutdown() { XBT_DEBUG("Shuting down model-checker"); - simgrid::mc::Process* process = &this->process(); + simgrid::mc::RemoteClient* process = &this->process(); 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(simgrid::mc::RemoteClient& process) { - int res = process.send_message(MC_MESSAGE_CONTINUE); + int res = process.getChannel().send(MC_MESSAGE_CONTINUE); if (res) - throw std::system_error(res, std::system_category()); - process.cache_flags = (mc_process_cache_flags_t) 0; + throw simgrid::xbt::errno_error(); + process.clear_cache(); } -static -void throw_socket_error(int fd) +static void MC_report_crash(int status) { - int error = 0; - socklen_t errlen = sizeof(error); - if (getsockopt(fd, SOL_SOCKET, SO_ERROR, (void *)&error, &errlen) == -1) - error = errno; - throw std::system_error(error, std::system_category()); + XBT_INFO("**************************"); + XBT_INFO("** CRASH IN THE PROGRAM **"); + XBT_INFO("**************************"); + if (WIFSIGNALED(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."); + XBT_INFO("Counter-example execution trace:"); + simgrid::mc::dumpRecordPath(); + for (auto const& 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(); +} + +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 const& s : mc_model_checker->getChecker()->getTextualTrace()) + XBT_INFO("%s", s.c_str()); + simgrid::mc::session->logState(); } bool ModelChecker::handle_message(char* buffer, ssize_t size) @@ -198,73 +206,69 @@ bool ModelChecker::handle_message(char* buffer, ssize_t size) case MC_MESSAGE_IGNORE_HEAP: { - s_mc_ignore_heap_message_t message; - if (size != sizeof(message)) - xbt_die("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; + s_mc_message_ignore_heap_t message; + if (size != sizeof(message)) + xbt_die("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 MC_MESSAGE_UNIGNORE_HEAP: { - s_mc_ignore_memory_message_t message; - if (size != sizeof(message)) - xbt_die("Broken messsage"); - memcpy(&message, buffer, sizeof(message)); - process().unignore_heap( - (void *)(std::uintptr_t) message.addr, message.size); - break; + s_mc_message_ignore_memory_t message; + if (size != sizeof(message)) + xbt_die("Broken messsage"); + memcpy(&message, buffer, sizeof(message)); + process().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"); - memcpy(&message, buffer, sizeof(message)); - this->process().ignore_region(message.addr, message.size); - break; + s_mc_message_ignore_memory_t message; + if (size != sizeof(message)) + xbt_die("Broken messsage"); + memcpy(&message, buffer, sizeof(message)); + this->process().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"); - memcpy(&message, buffer, sizeof(message)); - this->process().stack_areas().push_back(message.stack_region); + s_mc_message_stack_region_t message; + if (size != sizeof(message)) + xbt_die("Broken messsage"); + memcpy(&message, buffer, sizeof(message)); + this->process().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"); - memcpy(&message, buffer, sizeof(message)); - if (message.callback) - xbt_die("Support for client-side function proposition is not implemented."); - XBT_DEBUG("Received symbol: %s", message.name); - - if (_mc_property_automaton == nullptr) - _mc_property_automaton = xbt_automaton_new(); - - simgrid::mc::Process* process = &this->process(); - simgrid::mc::remote_ptr address - = simgrid::mc::remote((int*) message.data); - simgrid::xbt::add_proposition(_mc_property_automaton, - message.name, - [process, address]() { return process->read(address); } - ); - - break; + s_mc_message_register_symbol_t message; + if (size != sizeof(message)) + xbt_die("Broken message"); + memcpy(&message, buffer, sizeof(message)); + if (message.callback) + xbt_die("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(); + + simgrid::mc::RemoteClient* 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); }); + + break; } case MC_MESSAGE_WAITING: @@ -272,7 +276,7 @@ bool ModelChecker::handle_message(char* buffer, ssize_t size) case MC_MESSAGE_ASSERTION_FAILED: MC_report_assertion_error(); - ::exit(SIMGRID_MC_EXIT_SAFETY); + this->exit(SIMGRID_MC_EXIT_SAFETY); break; default: @@ -282,74 +286,38 @@ bool ModelChecker::handle_message(char* buffer, ssize_t size) return true; } -bool ModelChecker::handle_events() +/** Terminate the model-checker application */ +void ModelChecker::exit(int status) { - char buffer[MC_MESSAGE_LENGTH]; - struct pollfd* socket_pollfd = &fds_[SOCKET_FD_INDEX]; - struct pollfd* signalfd_pollfd = &fds_[SIGNAL_FD_INDEX]; - - while(poll(fds_, 2, -1) == -1) { - switch(errno) { - case EINTR: - continue; - default: - throw std::system_error(errno, std::system_category()); - } - } + // TODO, terminate the model checker politely instead of exiting rudely + if (process().running()) + kill(process().pid(), SIGKILL); + ::exit(status); +} - if (socket_pollfd->revents) { - if (socket_pollfd->revents & POLLIN) { - ssize_t size = MC_receive_message(socket_pollfd->fd, buffer, sizeof(buffer), MSG_DONTWAIT); - if (size == -1 && errno != EAGAIN) - throw std::system_error(errno, std::system_category()); - return handle_message(buffer, size); - } - if (socket_pollfd->revents & POLLERR) { - throw_socket_error(socket_pollfd->fd); +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 (not handle_message(buffer, size)) { + event_base_loopbreak(base_); } - if (socket_pollfd->revents & POLLHUP) - xbt_die("Socket hang up?"); } - - if (signalfd_pollfd->revents) { - if (signalfd_pollfd->revents & POLLIN) { - this->handle_signals(); - return true; - } - if (signalfd_pollfd->revents & POLLERR) { - throw_socket_error(signalfd_pollfd->fd); - } - if (signalfd_pollfd->revents & POLLHUP) - xbt_die("Signalfd hang up?"); + else if (events == EV_SIGNAL) { + on_signal(fd); + } + else { + xbt_die("Unexpected event"); } - - return true; } void ModelChecker::loop() { - while (this->process().running()) - this->handle_events(); -} - -void ModelChecker::handle_signals() -{ - struct signalfd_siginfo info; - struct pollfd* signalfd_pollfd = &fds_[SIGNAL_FD_INDEX]; - while (1) { - ssize_t size = read(signalfd_pollfd->fd, &info, sizeof(info)); - if (size == -1) { - if (errno == EINTR) - continue; - else - throw std::system_error(errno, std::system_category()); - } else if (size != sizeof(info)) - return throw std::runtime_error( - "Bad communication with model-checked application"); - else - break; - } - this->on_signal(&info); + if (this->process().running()) + event_base_dispatch(base_); } void ModelChecker::handle_waitpid() @@ -367,26 +335,34 @@ void ModelChecker::handle_waitpid() break; } else { XBT_ERROR("Could not wait for pid"); - throw std::system_error(errno, std::system_category()); + throw simgrid::xbt::errno_error(); } } if (pid == this->process().pid()) { // From PTRACE_O_TRACEEXIT: +#ifdef __linux__ if (status>>8 == (SIGTRAP | (PTRACE_EVENT_EXIT<<8))) { - if (ptrace(PTRACE_GETEVENTMSG, pid_, 0, &status) == -1) + if (ptrace(PTRACE_GETEVENTMSG, this->process().pid(), 0, &status) == -1) xbt_die("Could not get exit status"); if (WIFSIGNALED(status)) { MC_report_crash(status); - ::exit(SIMGRID_MC_EXIT_PROGRAM_CRASH); + mc_model_checker->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH); } } +#endif // We don't care about signals, just reinject them: if (WIFSTOPPED(status)) { XBT_DEBUG("Stopped with signal %i", (int) WSTOPSIG(status)); - if (ptrace(PTRACE_CONT, pid_, 0, WSTOPSIG(status)) == -1) + errno = 0; +#ifdef __linux__ + ptrace(PTRACE_CONT, this->process().pid(), 0, WSTOPSIG(status)); +#elif defined BSD + ptrace(PT_CONTINUE, this->process().pid(), (caddr_t)1, WSTOPSIG(status)); +#endif + if (errno != 0) xbt_die("Could not PTRACE_CONT"); } @@ -398,39 +374,48 @@ void ModelChecker::handle_waitpid() } } -void ModelChecker::on_signal(const struct signalfd_siginfo* info) +void ModelChecker::on_signal(int signo) { - switch(info->ssi_signo) { - case SIGCHLD: + if (signo == SIGCHLD) this->handle_waitpid(); - break; - default: - break; - } } -void ModelChecker::wait_client(simgrid::mc::Process& process) +void ModelChecker::wait_for_requests() { - this->resume(process); - while (this->process().running()) { - if (!this->handle_events()) - return; - } + this->resume(process()); + if (this->process().running()) + event_base_dispatch(base_); } -void ModelChecker::simcall_handle(simgrid::mc::Process& process, unsigned long pid, int value) +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 = pid; - m.value = value; - process.send_message(m); - process.cache_flags = (mc_process_cache_flags_t) 0; - while (process.running()) { - if (!this->handle_events()) - return; - } + 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_); +} + +bool ModelChecker::checkDeadlock() +{ + int res; + if ((res = this->process().getChannel().send(MC_MESSAGE_DEADLOCK_CHECK))) + xbt_die("Could not check deadlock state"); + s_mc_message_int_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) + ); + return message.value != 0; } }