X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b5f291a286dc3084e91889db196fa6e1f69fc4b8..d75fff3ccf9a0caf5d851cfd9dee6a2a0fe47864:/src/mc/ModelChecker.cpp diff --git a/src/mc/ModelChecker.cpp b/src/mc/ModelChecker.cpp index e5c642f89f..17e2bce738 100644 --- a/src/mc/ModelChecker.cpp +++ b/src/mc/ModelChecker.cpp @@ -1,20 +1,21 @@ -/* 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/checker/Checker.hpp" +#include "src/mc/explo/Exploration.hpp" +#include "src/mc/explo/LivenessChecker.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 "src/mc/remote/RemoteProcess.hpp" +#include "src/mc/transition/TransitionComm.hpp" #include "xbt/automaton.hpp" #include "xbt/system_error.hpp" #include +#include #include #include @@ -22,59 +23,61 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_ModelChecker, mc, "ModelChecker"); ::simgrid::mc::ModelChecker* mc_model_checker = nullptr; -using simgrid::mc::remote; - #ifdef __linux__ # define WAITPID_CHECKED_FLAGS __WALL #else # define WAITPID_CHECKED_FLAGS 0 #endif -namespace simgrid { -namespace mc { +namespace simgrid::mc { -ModelChecker::ModelChecker(std::unique_ptr remote_simulation, int sockfd) - : checker_side_(sockfd), remote_simulation_(std::move(remote_simulation)) +ModelChecker::ModelChecker(std::unique_ptr remote_simulation, int sockfd) + : checker_side_(sockfd), remote_process_(std::move(remote_simulation)) { } void ModelChecker::start() { - 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"); - } - }); + 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 = remote_simulation_->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"); + xbt_assert(waitpid(pid, &status, WAITPID_CHECKED_FLAGS) == pid && WIFSTOPPED(status) && WSTOPSIG(status) == SIGSTOP, + "Could not wait model-checked process"); - remote_simulation_->init(); + if (not _sg_mc_dot_output_file.get().empty()) { + dot_output_ = fopen(_sg_mc_dot_output_file.get().c_str(), "w"); + xbt_assert(dot_output_ != nullptr, "Error open dot output file: %s", strerror(errno)); - if (not _sg_mc_dot_output_file.get().empty()) - MC_init_dot_output(); + fprintf(dot_output_, "digraph graphname{\n fixedsize=true; rankdir=TB; ranksep=.25; edge [fontsize=12]; node " + "[fontsize=10, shape=circle,width=.5 ]; graph [resolution=20, fontsize=10];\n"); + } setup_ignore(); + errno = 0; #ifdef __linux__ ptrace(PTRACE_SETOPTIONS, pid, nullptr, PTRACE_O_TRACEEXIT); ptrace(PTRACE_CONT, pid, 0, 0); @@ -83,6 +86,21 @@ void ModelChecker::start() #else # error "no ptrace equivalent coded for this platform" #endif + xbt_assert(errno == 0, + "Ptrace does not seem to be usable in your setup (errno: %d). " + "If you run from within a docker, adding `--cap-add SYS_PTRACE` to the docker line may help. " + "If it does not help, please report this bug.", + errno); +} + +void ModelChecker::dot_output(const char* fmt, ...) +{ + if (dot_output_ != nullptr) { + va_list ap; + va_start(ap, fmt); + vfprintf(dot_output_, fmt, ap); + va_end(ap); + } } static constexpr auto ignored_local_variables = { @@ -95,9 +113,9 @@ static constexpr auto ignored_local_variables = { void ModelChecker::setup_ignore() { - const RemoteSimulation& process = this->get_remote_simulation(); - for (auto const& var : ignored_local_variables) - process.ignore_local_variable(var.first, var.second); + const RemoteProcess& process = this->get_remote_process(); + for (auto const& [var, frame] : ignored_local_variables) + process.ignore_local_variable(var, frame); /* Static variable used for tracing */ process.ignore_global_variable("counter"); @@ -107,23 +125,23 @@ void ModelChecker::shutdown() { XBT_DEBUG("Shutting down model-checker"); - RemoteSimulation* process = &this->get_remote_simulation(); - 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(RemoteSimulation& process) +void ModelChecker::resume() { - int res = checker_side_.get_channel().send(MessageType::CONTINUE); - if (res) + if (checker_side_.get_channel().send(MessageType::CONTINUE) != 0) throw xbt::errno_error(); - process.clear_cache(); + remote_process_->clear_cache(); } -static void MC_report_crash(int status) +static void MC_report_crash(Exploration* explorer, int status) { XBT_INFO("**************************"); XBT_INFO("** CRASH IN THE PROGRAM **"); @@ -134,31 +152,21 @@ static void MC_report_crash(int status) XBT_INFO("From exit: %i", WEXITSTATUS(status)); 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:"); - 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(); + if (explorer) { + XBT_INFO("Counter-example execution trace:"); + for (auto const& s : explorer->get_textual_trace()) + XBT_INFO(" %s", s.c_str()); + XBT_INFO("Path = %s", explorer->get_record_trace().to_string().c_str()); + explorer->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_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; @@ -166,6 +174,15 @@ bool ModelChecker::handle_message(const char* buffer, ssize_t size) memcpy(&base_message, buffer, sizeof(base_message)); switch(base_message.type) { + 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)); + + get_remote_process().init(message.mmalloc_default_mdp, message.maxpid); + break; + } + case MessageType::IGNORE_HEAP: { s_mc_message_ignore_heap_t message; xbt_assert(size == sizeof(message), "Broken message"); @@ -176,7 +193,7 @@ bool ModelChecker::handle_message(const char* buffer, ssize_t size) region.fragment = message.fragment; region.address = message.address; region.size = message.size; - get_remote_simulation().ignore_heap(region); + get_remote_process().ignore_heap(region); break; } @@ -184,7 +201,7 @@ bool ModelChecker::handle_message(const char* buffer, ssize_t size) s_mc_message_ignore_memory_t message; xbt_assert(size == sizeof(message), "Broken message"); memcpy(&message, buffer, sizeof(message)); - get_remote_simulation().unignore_heap((void*)(std::uintptr_t)message.addr, message.size); + get_remote_process().unignore_heap((void*)(std::uintptr_t)message.addr, message.size); break; } @@ -192,7 +209,7 @@ bool ModelChecker::handle_message(const char* buffer, ssize_t size) s_mc_message_ignore_memory_t message; xbt_assert(size == sizeof(message), "Broken message"); memcpy(&message, buffer, sizeof(message)); - this->get_remote_simulation().ignore_region(message.addr, message.size); + this->get_remote_process().ignore_region(message.addr, message.size); break; } @@ -200,7 +217,7 @@ bool ModelChecker::handle_message(const char* buffer, ssize_t size) s_mc_message_stack_region_t message; xbt_assert(size == sizeof(message), "Broken message"); memcpy(&message, buffer, sizeof(message)); - this->get_remote_simulation().stack_areas().push_back(message.stack_region); + this->get_remote_process().stack_areas().push_back(message.stack_region); } break; case MessageType::REGISTER_SYMBOL: { @@ -210,14 +227,7 @@ bool ModelChecker::handle_message(const char* buffer, ssize_t size) 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 RemoteSimulation* process = &this->get_remote_simulation(); - RemotePtr address = remote((int*)message.data); - xbt::add_proposition(property_automaton, message.name.data(), - [process, address]() { return process->read(address); }); - + LivenessChecker::automaton_register_symbol(get_remote_process(), message.name.data(), remote((int*)message.data)); break; } @@ -225,7 +235,15 @@ bool ModelChecker::handle_message(const char* buffer, ssize_t size) return false; case MessageType::ASSERTION_FAILED: - MC_report_assertion_error(); + XBT_INFO("**************************"); + XBT_INFO("*** PROPERTY NOT VALID ***"); + XBT_INFO("**************************"); + XBT_INFO("Counter-example execution trace:"); + for (auto const& s : get_exploration()->get_textual_trace()) + XBT_INFO(" %s", s.c_str()); + XBT_INFO("Path = %s", get_exploration()->get_record_trace().to_string().c_str()); + exploration_->log_state(); + this->exit(SIMGRID_MC_EXIT_SAFETY); default: @@ -237,9 +255,7 @@ 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 (get_remote_simulation().running()) - kill(get_remote_simulation().pid(), SIGKILL); + shutdown(); ::exit(status); } @@ -252,7 +268,7 @@ void ModelChecker::handle_waitpid() if (pid == -1) { if (errno == ECHILD) { // No more children: - xbt_assert(not this->get_remote_simulation().running(), "Inconsistent state"); + xbt_assert(not this->get_remote_process().running(), "Inconsistent state"); break; } else { XBT_ERROR("Could not wait for pid"); @@ -260,15 +276,15 @@ void ModelChecker::handle_waitpid() } } - if (pid == this->get_remote_simulation().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, remote_simulation_->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); + MC_report_crash(exploration_, status); + this->get_remote_process().terminate(); + this->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH); } } #endif @@ -278,19 +294,20 @@ void ModelChecker::handle_waitpid() XBT_DEBUG("Stopped with signal %i", (int) WSTOPSIG(status)); errno = 0; #ifdef __linux__ - ptrace(PTRACE_CONT, remote_simulation_->pid(), 0, WSTOPSIG(status)); + ptrace(PTRACE_CONT, remote_process_->pid(), 0, WSTOPSIG(status)); #elif defined BSD - ptrace(PT_CONTINUE, remote_simulation_->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); + MC_report_crash(exploration_, status); + this->get_remote_process().terminate(); + this->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH); } else if (WIFEXITED(status)) { XBT_DEBUG("Child process is over"); - this->get_remote_simulation().terminate(); + this->get_remote_process().terminate(); } } } @@ -298,38 +315,54 @@ void ModelChecker::handle_waitpid() void ModelChecker::wait_for_requests() { - this->resume(get_remote_simulation()); - if (this->get_remote_simulation().running()) + this->resume(); + if (this->get_remote_process().running()) checker_side_.dispatch(); } -void ModelChecker::handle_simcall(Transition const& transition) +Transition* ModelChecker::handle_simcall(aid_t aid, int times_considered, bool new_transition) { - s_mc_message_simcall_handle_t m; + s_mc_message_simcall_execute_t m; memset(&m, 0, sizeof(m)); - m.type = MessageType::SIMCALL_HANDLE; - m.pid = transition.pid_; - m.value = transition.argument_; + m.type = MessageType::SIMCALL_EXECUTE; + m.aid_ = aid; + m.times_considered_ = times_considered; checker_side_.get_channel().send(m); - this->remote_simulation_->clear_cache(); - if (this->remote_simulation_->running()) - checker_side_.dispatch(); -} -bool ModelChecker::checkDeadlock() -{ - 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); + this->remote_process_->clear_cache(); + if (this->remote_process_->running()) + checker_side_.dispatch(); // The app may send messages while processing the transition + + 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(message) && message.type == MessageType::DEADLOCK_CHECK_REPLY, + xbt_assert(s == sizeof(answer) && answer.type == MessageType::SIMCALL_EXECUTE_ANSWER, "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; + "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)); + + if (new_transition) { + std::stringstream stream(answer.buffer.data()); + return deserialize_transition(aid, times_considered, stream); + } else + return nullptr; +} + +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; + ssize_t s = checker_side_.get_channel().receive(answer); + xbt_assert(s != -1, "Could not receive answer to FINALIZE"); + xbt_assert(s == sizeof(answer) && answer.type == MessageType::FINALIZE_REPLY, + "Received unexpected message %s (%i, size=%i) expected MessageType::FINALIZE_REPLY (%i, size=%i)", + to_c_str(answer.type), (int)answer.type, (int)s, (int)MessageType::FINALIZE_REPLY, (int)sizeof(answer)); } -} // namespace mc -} // namespace simgrid +} // namespace simgrid::mc