-/* Copyright (c) 2008-2022. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2008-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/mc_config.hpp"
#include "src/mc/mc_exit.hpp"
#include "src/mc/mc_private.hpp"
-#include "src/mc/remote/RemoteProcess.hpp"
+#include "src/mc/sosp/RemoteProcessMemory.hpp"
#include "src/mc/transition/TransitionComm.hpp"
#include "xbt/automaton.hpp"
#include "xbt/system_error.hpp"
::simgrid::mc::ModelChecker* mc_model_checker = nullptr;
-#ifdef __linux__
-# define WAITPID_CHECKED_FLAGS __WALL
-#else
-# define WAITPID_CHECKED_FLAGS 0
-#endif
-
namespace simgrid::mc {
-ModelChecker::ModelChecker(std::unique_ptr<RemoteProcess> 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<simgrid::mc::ModelChecker*>(arg);
- if (events == EV_READ) {
- std::array<char, MC_MESSAGE_LENGTH> 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_process_->pid();
-
- 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()) {
- 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));
-
- 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);
-#elif defined BSD
- ptrace(PT_CONTINUE, pid, (caddr_t)1, 0);
-#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 = {
- 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()
-{
- 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");
-}
-
-void ModelChecker::shutdown()
-{
- XBT_DEBUG("Shutting down model-checker");
-
- RemoteProcess& process = get_remote_process();
- if (process.running()) {
- XBT_DEBUG("Killing process");
- finalize_app(true);
- kill(process.pid(), SIGKILL);
- process.terminate();
- }
-}
-
-void ModelChecker::resume()
+ModelChecker::ModelChecker(std::unique_ptr<RemoteProcessMemory> remote_memory)
+ : remote_process_memory_(std::move(remote_memory))
{
- if (checker_side_.get_channel().send(MessageType::CONTINUE) != 0)
- throw xbt::errno_error();
- remote_process_->clear_cache();
-}
-
-static void MC_report_crash(Exploration* explorer, int status)
-{
- 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 (not xbt_log_no_loc)
- XBT_INFO("%s core dump was generated by the system.", WCOREDUMP(status) ? "A" : "No");
- 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();
- }
- }
}
bool ModelChecker::handle_message(const char* buffer, ssize_t size)
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);
+ get_remote_process_memory().init(message.mmalloc_default_mdp);
break;
}
region.fragment = message.fragment;
region.address = message.address;
region.size = message.size;
- get_remote_process().ignore_heap(region);
+ get_remote_process_memory().ignore_heap(region);
break;
}
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);
+ get_remote_process_memory().unignore_heap((void*)(std::uintptr_t)message.addr, message.size);
break;
}
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);
+ this->get_remote_process_memory().ignore_region(message.addr, message.size);
break;
}
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);
+ this->get_remote_process_memory().stack_areas().push_back(message.stack_region);
} break;
case MessageType::REGISTER_SYMBOL: {
xbt_assert(not message.callback, "Support for client-side function proposition is not implemented.");
XBT_DEBUG("Received symbol: %s", message.name.data());
- LivenessChecker::automaton_register_symbol(get_remote_process(), message.name.data(), remote((int*)message.data));
+ LivenessChecker::automaton_register_symbol(get_remote_process_memory(), message.name.data(),
+ remote((int*)message.data));
break;
}
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 : 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);
+ exploration_->report_assertion_failure();
+ break;
default:
xbt_die("Unexpected message from model-checked application");
return true;
}
-/** Terminate the model-checker application */
-void ModelChecker::exit(int status)
-{
- shutdown();
- ::exit(status);
-}
-
-void ModelChecker::handle_waitpid()
+void ModelChecker::handle_waitpid(pid_t pid_to_wait)
{
XBT_DEBUG("Check for wait event");
int status;
pid_t pid;
while ((pid = waitpid(-1, &status, WNOHANG)) != 0) {
if (pid == -1) {
- if (errno == ECHILD) {
- // No more children:
- xbt_assert(not this->get_remote_process().running(), "Inconsistent state");
+ if (errno == ECHILD) { // No more children:
+ xbt_assert(not this->get_remote_process_memory().running(), "Inconsistent state");
break;
} else {
XBT_ERROR("Could not wait for pid");
}
}
- if (pid == this->get_remote_process().pid()) {
+ if (pid == pid_to_wait) {
// From PTRACE_O_TRACEEXIT:
#ifdef __linux__
if (status>>8 == (SIGTRAP | (PTRACE_EVENT_EXIT<<8))) {
- xbt_assert(ptrace(PTRACE_GETEVENTMSG, remote_process_->pid(), 0, &status) != -1, "Could not get exit status");
- if (WIFSIGNALED(status)) {
- MC_report_crash(exploration_, status);
- this->get_remote_process().terminate();
- this->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH);
- }
+ unsigned long eventmsg;
+ xbt_assert(ptrace(PTRACE_GETEVENTMSG, pid_to_wait, 0, &eventmsg) != -1, "Could not get exit status");
+ status = static_cast<int>(eventmsg);
+ if (WIFSIGNALED(status))
+ exploration_->report_crash(status);
}
#endif
- // We don't care about signals, just reinject them:
+ // We don't care about non-lethal signals, just reinject them:
if (WIFSTOPPED(status)) {
XBT_DEBUG("Stopped with signal %i", (int) WSTOPSIG(status));
errno = 0;
#ifdef __linux__
- ptrace(PTRACE_CONT, remote_process_->pid(), 0, WSTOPSIG(status));
+ ptrace(PTRACE_CONT, pid_to_wait, 0, WSTOPSIG(status));
#elif defined BSD
- ptrace(PT_CONTINUE, remote_process_->pid(), (caddr_t)1, WSTOPSIG(status));
+ ptrace(PT_CONTINUE, pid_to_wait, (caddr_t)1, WSTOPSIG(status));
#endif
xbt_assert(errno == 0, "Could not PTRACE_CONT");
}
else if (WIFSIGNALED(status)) {
- MC_report_crash(exploration_, status);
- this->get_remote_process().terminate();
- this->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH);
+ exploration_->report_crash(status);
} else if (WIFEXITED(status)) {
XBT_DEBUG("Child process is over");
- this->get_remote_process().terminate();
+ this->get_remote_process_memory().terminate();
}
}
}
}
-void ModelChecker::wait_for_requests()
-{
- this->resume();
- if (this->get_remote_process().running())
- checker_side_.dispatch();
-}
-
-Transition* ModelChecker::handle_simcall(aid_t aid, int times_considered, bool new_transition)
-{
- s_mc_message_simcall_execute_t m;
- memset(&m, 0, sizeof(m));
- m.type = MessageType::SIMCALL_EXECUTE;
- m.aid_ = aid;
- m.times_considered_ = times_considered;
- checker_side_.get_channel().send(m);
-
- 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(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));
-
- 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 simgrid::mc