X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/95f6f24c739bd20e274a8af9b9e998dff826986d..754db84445c812d3480832460e90a112b77648d0:/src/mc/api/RemoteApp.cpp?ds=sidebyside diff --git a/src/mc/api/RemoteApp.cpp b/src/mc/api/RemoteApp.cpp index 6b53a00f39..fc496adfd8 100644 --- a/src/mc/api/RemoteApp.cpp +++ b/src/mc/api/RemoteApp.cpp @@ -4,14 +4,9 @@ * under the terms of the license (GNU LGPL) which comes with this package. */ #include "src/mc/api/RemoteApp.hpp" -#include "src/internal_config.h" // HAVE_SMPI #include "src/mc/explo/Exploration.hpp" #include "src/mc/mc_config.hpp" #include "xbt/asserts.h" -#if HAVE_SMPI -#include "smpi/smpi.h" -#include "src/smpi/include/private.hpp" -#endif #include "src/mc/api/State.hpp" #include "src/mc/mc_config.hpp" #include "src/mc/mc_exit.hpp" @@ -22,136 +17,65 @@ #include #include -#include +#include #include #include #include - -#include -#ifdef __linux__ -#include -#endif +#include +#include +#include XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_Session, mc, "Model-checker session"); XBT_LOG_EXTERNAL_CATEGORY(mc_global); -static simgrid::config::Flag _sg_mc_setenv{ - "model-check/setenv", "Extra environment variables to pass to the child process (ex: 'AZE=aze;QWE=qwe').", "", - [](std::string_view value) { - xbt_assert(value.empty() || value.find('=', 0) != std::string_view::npos, - "The 'model-check/setenv' parameter must be like 'AZE=aze', but it does not contain an equal sign."); - }}; - namespace simgrid::mc { -XBT_ATTRIB_NORETURN static void run_child_process(int socket, const std::vector& args) +static char master_socket_name[65] = {}; +static void cleanup_master_socket() { - /* On startup, simix_global_init() calls simgrid::mc::Client::initialize(), which checks whether the MC_ENV_SOCKET_FD - * env variable is set. If so, MC mode is assumed, and the client is setup from its side - */ - -#ifdef __linux__ - // Make sure we do not outlive our parent - sigset_t mask; - sigemptyset(&mask); - xbt_assert(sigprocmask(SIG_SETMASK, &mask, nullptr) >= 0, "Could not unblock signals"); - xbt_assert(prctl(PR_SET_PDEATHSIG, SIGHUP) == 0, "Could not PR_SET_PDEATHSIG"); -#endif - - // Remove CLOEXEC to pass the socket to the application - int fdflags = fcntl(socket, F_GETFD, 0); - xbt_assert(fdflags != -1 && fcntl(socket, F_SETFD, fdflags & ~FD_CLOEXEC) != -1, - "Could not remove CLOEXEC for socket"); - - setenv(MC_ENV_SOCKET_FD, std::to_string(socket).c_str(), 1); - - /* Setup the tokenizer that parses the cfg:model-check/setenv parameter */ - using Tokenizer = boost::tokenizer>; - boost::char_separator semicol_sep(";"); - boost::char_separator equal_sep("="); - Tokenizer token_vars(_sg_mc_setenv.get(), semicol_sep); /* Iterate over all FOO=foo parts */ - for (const auto& token : token_vars) { - std::vector kv; - Tokenizer token_kv(token, equal_sep); - for (const auto& t : token_kv) /* Iterate over 'FOO' and then 'foo' in that 'FOO=foo' */ - kv.push_back(t); - xbt_assert(kv.size() == 2, "Parse error on 'model-check/setenv' value %s. Does it contain an equal sign?", - token.c_str()); - XBT_INFO("setenv '%s'='%s'", kv[0].c_str(), kv[1].c_str()); - setenv(kv[0].c_str(), kv[1].c_str(), 1); - } - - /* And now, exec the child process */ - int i = 1; - while (args[i] != nullptr && args[i][0] == '-') - i++; - - xbt_assert(args[i] != nullptr, - "Unable to find a binary to exec on the command line. Did you only pass config flags?"); - - execvp(args[i], args.data() + i); - XBT_CRITICAL("The model-checked process failed to exec(%s): %s.\n" - " Make sure that your binary exists on disk and is executable.", - args[i], strerror(errno)); - if (strchr(args[i], '=') != nullptr) - XBT_CRITICAL("If you want to pass environment variables to the application, please use --cfg=model-check/setenv:%s", - args[i]); - - xbt_die("Aborting now."); + if (master_socket_name[0] != '\0') + unlink(master_socket_name); + master_socket_name[0] = '\0'; } -RemoteApp::RemoteApp(const std::vector& args) +RemoteApp::RemoteApp(const std::vector& args, bool need_memory_introspection) : app_args_(args) { -#if HAVE_SMPI - smpi_init_options(); // only performed once - xbt_assert(smpi_cfg_privatization() != SmpiPrivStrategies::MMAP, - "Please use the dlopen privatization schema when model-checking SMPI code"); -#endif - - // Create an AF_LOCAL socketpair used for exchanging messages - // between the model-checker process (ourselves) and the model-checked - // process: - int sockets[2]; - xbt_assert(socketpair(AF_LOCAL, SOCK_SEQPACKET | SOCK_CLOEXEC, 0, sockets) != -1, "Could not create socketpair"); - - pid_t pid = fork(); - xbt_assert(pid >= 0, "Could not fork model-checked process"); - - if (pid == 0) { // Child - ::close(sockets[1]); - run_child_process(sockets[0], args); - DIE_IMPOSSIBLE; + if (need_memory_introspection) { + checker_side_ = std::make_unique(app_args_, need_memory_introspection); + initial_snapshot_ = std::make_shared(0, page_store_, *checker_side_->get_remote_memory()); + } else { + master_socket_ = socket(AF_LOCAL, SOCK_SEQPACKET | SOCK_CLOEXEC, 0); + xbt_assert(master_socket_ != -1, "Cannot create the master socket: %s", strerror(errno)); + + struct sockaddr_un serv_addr = {}; + serv_addr.sun_family = AF_LOCAL; + snprintf(serv_addr.sun_path, 64, "/tmp/simgrid-mc-%d", getpid()); + strcpy(master_socket_name, serv_addr.sun_path); + auto addr_size = offsetof(struct sockaddr_un, sun_path) + strlen(serv_addr.sun_path); + + xbt_assert(bind(master_socket_, (struct sockaddr*)&serv_addr, addr_size) >= 0, + "Cannot bind the master socket to %s: %s.", serv_addr.sun_path, strerror(errno)); + atexit(cleanup_master_socket); + + xbt_assert(listen(master_socket_, SOMAXCONN) >= 0, "Cannot listen to the master socket: %s.", strerror(errno)); + + application_factory_ = std::make_unique(app_args_, need_memory_introspection); + checker_side_ = application_factory_->clone(master_socket_); } - - // Parent (model-checker): - ::close(sockets[0]); - - xbt_assert(mc_model_checker == nullptr, "Did you manage to start the MC twice in this process?"); - - auto process = std::make_unique(pid); - model_checker_ = std::make_unique(std::move(process), sockets[1]); - - mc_model_checker = model_checker_.get(); - model_checker_->start(); - - /* Take the initial snapshot */ - wait_for_requests(); - initial_snapshot_ = std::make_shared(0, page_store_); } RemoteApp::~RemoteApp() { initial_snapshot_ = nullptr; - if (model_checker_) { - shutdown(); - model_checker_ = nullptr; - mc_model_checker = nullptr; - } + checker_side_ = nullptr; } -void RemoteApp::restore_initial_state() const +void RemoteApp::restore_initial_state() { - this->initial_snapshot_->restore(&model_checker_->get_remote_process_memory()); + if (initial_snapshot_ == nullptr) { // No memory introspection + checker_side_ = application_factory_->clone(master_socket_); + } else + initial_snapshot_->restore(*checker_side_->get_remote_memory()); } unsigned long RemoteApp::get_maxpid() const @@ -159,9 +83,9 @@ unsigned long RemoteApp::get_maxpid() const // note: we could maybe cache it and count the actor creation on checker side too. // But counting correctly accross state checkpoint/restore would be annoying. - model_checker_->get_channel().send(MessageType::ACTORS_MAXPID); + checker_side_->get_channel().send(MessageType::ACTORS_MAXPID); s_mc_message_int_t answer; - ssize_t answer_size = model_checker_->get_channel().receive(answer); + ssize_t answer_size = checker_side_->get_channel().receive(answer); xbt_assert(answer_size != -1, "Could not receive message"); xbt_assert(answer_size == sizeof answer, "Broken message (size=%zd; expected %zu)", answer_size, sizeof answer); xbt_assert(answer.type == MessageType::ACTORS_MAXPID_REPLY, @@ -177,67 +101,44 @@ void RemoteApp::get_actors_status(std::map& whereto) const // // CheckerSide AppSide // send ACTORS_STATUS ----> - // <----- send ACTORS_STATUS_REPLY - // <----- send `N` `s_mc_message_actors_status_one_t` structs - // <----- send `M` `s_mc_message_simcall_probe_one_t` structs - model_checker_->get_channel().send(MessageType::ACTORS_STATUS); + // <----- send ACTORS_STATUS_REPLY_COUNT + // <----- send `N` ACTORS_STATUS_REPLY_TRANSITION (s_mc_message_actors_status_one_t) + // <----- send `M` ACTORS_STATUS_REPLY_SIMCALL (s_mc_message_simcall_probe_one_t) + checker_side_->get_channel().send(MessageType::ACTORS_STATUS); s_mc_message_actors_status_answer_t answer; - ssize_t answer_size = model_checker_->get_channel().receive(answer); + ssize_t answer_size = checker_side_->get_channel().receive(answer); xbt_assert(answer_size != -1, "Could not receive message"); xbt_assert(answer_size == sizeof answer, "Broken message (size=%zd; expected %zu)", answer_size, sizeof answer); - xbt_assert(answer.type == MessageType::ACTORS_STATUS_REPLY, - "Received unexpected message %s (%i); expected MessageType::ACTORS_STATUS_REPLY (%i)", - to_c_str(answer.type), (int)answer.type, (int)MessageType::ACTORS_STATUS_REPLY); + xbt_assert(answer.type == MessageType::ACTORS_STATUS_REPLY_COUNT, + "Received unexpected message %s (%i); expected MessageType::ACTORS_STATUS_REPLY_COUNT (%i)", + to_c_str(answer.type), (int)answer.type, (int)MessageType::ACTORS_STATUS_REPLY_COUNT); // Message sanity checks - xbt_assert(answer.count >= 0, "Received an ACTOR_STATUS_REPLY message with an actor count of '%d' < 0", answer.count); - xbt_assert(answer.transition_count >= 0, "Received an ACTOR_STATUS_REPLY message with transition_count '%d' < 0", - answer.transition_count); - xbt_assert(answer.transition_count == 0 || answer.count >= 0, - "Received an ACTOR_STATUS_REPLY message with no actor data " - "but with transition data nonetheless"); + xbt_assert(answer.count >= 0, "Received an ACTORS_STATUS_REPLY_COUNT message with an actor count of '%d' < 0", + answer.count); std::vector status(answer.count); if (answer.count > 0) { size_t size = status.size() * sizeof(s_mc_message_actors_status_one_t); - ssize_t received = model_checker_->get_channel().receive(status.data(), size); + ssize_t received = checker_side_->get_channel().receive(status.data(), size); xbt_assert(static_cast(received) == size); } - // Ensures that each actor sends precisely `answer.transition_count` transitions. While technically - // this doesn't catch the edge case where actor A sends 3 instead of 2 and actor B sends 2 instead - // of 3 transitions, that is ignored here since that invariant needs to be enforced on the AppSide - const auto expected_transitions = std::accumulate( - status.begin(), status.end(), 0, [](int total, const auto& actor) { return total + actor.n_transitions; }); - xbt_assert(expected_transitions == answer.transition_count, - "Expected to receive %d transition(s) but was only notified of %d by the app side", expected_transitions, - answer.transition_count); - - std::vector probes(answer.transition_count); - if (answer.transition_count > 0) { - for (auto& probe : probes) { - ssize_t received = model_checker_->get_channel().receive(probe); + whereto.clear(); + + for (const auto& actor : status) { + std::vector> actor_transitions; + int n_transitions = actor.enabled ? actor.max_considered : 0; + for (int times_considered = 0; times_considered < n_transitions; times_considered++) { + s_mc_message_simcall_probe_one_t probe; + ssize_t received = checker_side_->get_channel().receive(probe); xbt_assert(received >= 0, "Could not receive response to ACTORS_PROBE message (%s)", strerror(errno)); xbt_assert(static_cast(received) == sizeof probe, "Could not receive response to ACTORS_PROBE message (%zd bytes received != %zu bytes expected", received, sizeof probe); - } - } - - whereto.clear(); - std::move_iterator probes_iter(probes.begin()); - - for (const auto& actor : status) { - xbt_assert(actor.n_transitions == 0 || actor.n_transitions == actor.max_considered, - "If any transitions are serialized for an actor, it must match the " - "total number of transitions that can be considered for the actor " - "(currently %d), but only %d transition(s) was/were said to be encoded", - actor.max_considered, actor.n_transitions); - std::vector> actor_transitions; - for (int times_considered = 0; times_considered < actor.n_transitions; times_considered++, probes_iter++) { - std::stringstream stream((*probes_iter).buffer.data()); + std::stringstream stream(probe.buffer.data()); actor_transitions.emplace_back(deserialize_transition(actor.aid, times_considered, stream)); } @@ -248,9 +149,9 @@ void RemoteApp::get_actors_status(std::map& whereto) const void RemoteApp::check_deadlock() const { - xbt_assert(model_checker_->get_channel().send(MessageType::DEADLOCK_CHECK) == 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 received = model_checker_->get_channel().receive(message); + ssize_t received = checker_side_->get_channel().receive(message); xbt_assert(received != -1, "Could not receive message"); xbt_assert(received == sizeof message, "Broken message (size=%zd; expected %zu)", received, sizeof message); xbt_assert(message.type == MessageType::DEADLOCK_CHECK_REPLY, @@ -258,55 +159,54 @@ void RemoteApp::check_deadlock() const to_c_str(message.type), (int)message.type, (int)MessageType::DEADLOCK_CHECK_REPLY); if (message.value != 0) { + auto* explo = Exploration::get_instance(); XBT_CINFO(mc_global, "Counter-example execution trace:"); - for (auto const& frame : model_checker_->get_exploration()->get_textual_trace()) + for (auto const& frame : explo->get_textual_trace()) XBT_CINFO(mc_global, " %s", frame.c_str()); XBT_INFO("You can debug the problem (and see the whole details) by rerunning out of simgrid-mc with " "--cfg=model-check/replay:'%s'", - model_checker_->get_exploration()->get_record_trace().to_string().c_str()); - model_checker_->get_exploration()->log_state(); + explo->get_record_trace().to_string().c_str()); + explo->log_state(); throw DeadlockError(); } } void RemoteApp::wait_for_requests() { - /* Resume the application */ - if (model_checker_->get_channel().send(MessageType::CONTINUE) != 0) - throw xbt::errno_error(); - get_remote_process_memory().clear_cache(); - - if (this->get_remote_process_memory().running()) - model_checker_->channel_handle_events(); + checker_side_->wait_for_requests(); } -void RemoteApp::shutdown() +Transition* RemoteApp::handle_simcall(aid_t aid, int times_considered, bool new_transition) { - XBT_DEBUG("Shutting down model-checker"); - - RemoteProcessMemory& process = get_remote_process_memory(); - if (process.running()) { - XBT_DEBUG("Killing process"); - finalize_app(true); - kill(process.pid(), SIGKILL); - process.terminate(); - } + s_mc_message_simcall_execute_t m = {}; + m.type = MessageType::SIMCALL_EXECUTE; + m.aid_ = aid; + m.times_considered_ = times_considered; + checker_side_->get_channel().send(m); + + if (auto* memory = get_remote_process_memory(); memory != nullptr) + memory->clear_cache(); + if (checker_side_->running()) + checker_side_->dispatch_events(); // 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 > 0 && answer.type == MessageType::SIMCALL_EXECUTE_REPLY, + "%d Received unexpected message %s (%i); expected MessageType::SIMCALL_EXECUTE_REPLY (%i)", getpid(), + to_c_str(answer.type), (int)answer.type, (int)MessageType::SIMCALL_EXECUTE_REPLY); + xbt_assert(s == sizeof answer, "Broken message (size=%zd; expected %zu)", s, sizeof answer); + + if (new_transition) { + std::stringstream stream(answer.buffer.data()); + return deserialize_transition(aid, times_considered, stream); + } else + return nullptr; } void RemoteApp::finalize_app(bool terminate_asap) { - s_mc_message_int_t m = {}; - m.type = MessageType::FINALIZE; - m.value = terminate_asap; - xbt_assert(model_checker_->get_channel().send(m) == 0, "Could not ask the app to finalize on need"); - - s_mc_message_t answer; - ssize_t s = model_checker_->get_channel().receive(answer); - xbt_assert(s != -1, "Could not receive answer to FINALIZE"); - xbt_assert(s == sizeof answer, "Broken message (size=%zd; expected %zu)", s, sizeof answer); - xbt_assert(answer.type == MessageType::FINALIZE_REPLY, - "Received unexpected message %s (%i); expected MessageType::FINALIZE_REPLY (%i)", to_c_str(answer.type), - (int)answer.type, (int)MessageType::FINALIZE_REPLY); + checker_side_->finalize(terminate_asap); } } // namespace simgrid::mc