-/* Copyright (c) 2015-2022. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2015-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/kernel/actor/ActorImpl.hpp"
#include "src/kernel/actor/SimcallObserver.hpp"
#include "src/mc/mc_base.hpp"
-#include "src/mc/remote/RemoteProcess.hpp"
+#include "src/mc/mc_config.hpp"
+#include "src/mc/sosp/RemoteProcessMemory.hpp"
#if HAVE_SMPI
#include "src/smpi/include/private.hpp"
#endif
-#include "xbt/coverage.h"
+#include "src/sthread/sthread.h"
+#include "src/xbt/coverage.h"
#include "xbt/str.h"
-#include "xbt/xbt_modinter.h" /* mmalloc_preinit to get the default mmalloc arena address */
#include <simgrid/modelchecker.h>
#include <cerrno>
#include <cstdio> // setvbuf
#include <cstdlib>
-#include <cstring>
#include <memory>
+#include <numeric>
#include <sys/ptrace.h>
#include <sys/socket.h>
#include <sys/types.h>
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
+XBT_LOG_EXTERNAL_CATEGORY(mc_global);
-namespace simgrid {
-namespace mc {
+namespace simgrid::mc {
std::unique_ptr<AppSide> AppSide::instance_;
-AppSide* AppSide::initialize(xbt_dynar_t actors_addr)
+AppSide* AppSide::initialize()
{
if (not std::getenv(MC_ENV_SOCKET_FD)) // We are not in MC mode: don't initialize the MC world
return nullptr;
if (instance_)
return instance_.get();
- _sg_do_model_check = 1;
+ simgrid::mc::model_checking_mode = ModelCheckingMode::APP_SIDE;
setvbuf(stdout, nullptr, _IOLBF, 0);
instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
// Wait for the model-checker:
- errno = 0;
+ if (getenv("MC_NEED_PTRACE") != nullptr) {
+ errno = 0;
#if defined __linux__
- ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
+ ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
#elif defined BSD
- ptrace(PT_TRACE_ME, 0, nullptr, 0);
+ ptrace(PT_TRACE_ME, 0, nullptr, 0);
#else
-#error "no ptrace equivalent coded for this platform"
+ xbt_die("no ptrace equivalent coded for this platform, please don't use the liveness checker here.");
#endif
- xbt_assert(errno == 0 && raise(SIGSTOP) == 0, "Could not wait for the model-checker (errno = %d: %s)", errno,
- strerror(errno));
- s_mc_message_initial_addresses_t message{MessageType::INITIAL_ADDRESSES, mmalloc_preinit(),
- kernel::actor::ActorImpl::get_maxpid_addr(), actors_addr};
- xbt_assert(instance_->channel_.send(message) == 0, "Could not send the initial message with addresses.");
+ xbt_assert(errno == 0 && raise(SIGSTOP) == 0, "Could not wait for the model-checker (errno = %d: %s)", errno,
+ strerror(errno));
+ }
instance_->handle_messages();
return instance_.get();
void AppSide::handle_deadlock_check(const s_mc_message_t*) const
{
- const auto& actor_list = kernel::EngineImpl::get_instance()->get_actor_list();
+ const auto* engine = kernel::EngineImpl::get_instance();
+ const auto& actor_list = engine->get_actor_list();
bool deadlock = not actor_list.empty() && std::none_of(begin(actor_list), end(actor_list), [](const auto& kv) {
return mc::actor_is_enabled(kv.second);
});
+ if (deadlock) {
+ XBT_CINFO(mc_global, "**************************");
+ XBT_CINFO(mc_global, "*** DEADLOCK DETECTED ***");
+ XBT_CINFO(mc_global, "**************************");
+ engine->display_all_actor_status();
+ }
// Send result:
- s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
+ s_mc_message_int_t answer = {};
+ answer.type = MessageType::DEADLOCK_CHECK_REPLY;
+ answer.value = deadlock;
xbt_assert(channel_.send(answer) == 0, "Could not send response");
}
void AppSide::handle_simcall_execute(const s_mc_message_simcall_execute_t* message) const
xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
// Finish the RPC from the server: return a serialized observer, to build a Transition on Checker side
- s_mc_message_simcall_execute_answer_t answer;
- memset(&answer, 0, sizeof(answer));
+ s_mc_message_simcall_execute_answer_t answer = {};
answer.type = MessageType::SIMCALL_EXECUTE_ANSWER;
std::stringstream stream;
if (actor->simcall_.observer_ != nullptr) {
xbt_assert(channel_.send(answer) == 0, "Could not send response");
}
-void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
-{
- bool res = mc::actor_is_enabled(kernel::EngineImpl::get_instance()->get_actor_by_pid(msg->aid));
- s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
- xbt_assert(channel_.send(answer) == 0, "Could not send ACTOR_ENABLED_REPLY");
-}
-
void AppSide::handle_finalize(const s_mc_message_int_t* msg) const
{
bool terminate_asap = msg->value;
if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
kernel::EngineImpl::get_instance()->display_all_actor_status();
#if HAVE_SMPI
- XBT_DEBUG("Smpi_enabled: %d", (int)smpi_enabled());
- if (smpi_enabled())
+ XBT_DEBUG("Smpi_enabled: %d", SMPI_is_inited());
+ if (SMPI_is_inited())
SMPI_finalize();
#endif
}
coverage_checkpoint();
- xbt_assert(channel_.send(MessageType::DEADLOCK_CHECK_REPLY) == 0, // DEADLOCK_CHECK_REPLY, really?
- "Could not answer to FINALIZE");
+ xbt_assert(channel_.send(MessageType::FINALIZE_REPLY) == 0, "Could not answer to FINALIZE");
std::fflush(stdout);
if (terminate_asap)
::_Exit(0);
}
+void AppSide::handle_need_meminfo()
+{
+ this->need_memory_info_ = true;
+ s_mc_message_need_meminfo_reply_t answer = {};
+ answer.type = MessageType::NEED_MEMINFO_REPLY;
+ answer.mmalloc_default_mdp = mmalloc_get_current_heap();
+ xbt_assert(channel_.send(answer) == 0, "Could not send response to the request for meminfo.");
+}
+void AppSide::handle_actors_status() const
+{
+ auto const& actor_list = kernel::EngineImpl::get_instance()->get_actor_list();
+ XBT_DEBUG("Serialize the actors to answer ACTORS_STATUS from the checker. %zu actors to go.", actor_list.size());
+
+ std::vector<s_mc_message_actors_status_one_t> status;
+ for (auto const& [aid, actor] : actor_list)
+ status.emplace_back(s_mc_message_actors_status_one_t{aid, mc::actor_is_enabled(actor),
+ actor->simcall_.observer_->get_max_consider()});
+
+ struct s_mc_message_actors_status_answer_t answer = {};
+ answer.type = MessageType::ACTORS_STATUS_REPLY;
+ answer.count = static_cast<int>(status.size());
+
+ xbt_assert(channel_.send(answer) == 0, "Could not send ACTORS_STATUS_REPLY msg");
+ if (answer.count > 0) {
+ size_t size = status.size() * sizeof(s_mc_message_actors_status_one_t);
+ xbt_assert(channel_.send(status.data(), size) == 0, "Could not send ACTORS_STATUS_REPLY data");
+ }
+
+ // Serialize each transition to describe what each actor is doing
+ XBT_DEBUG("Deliver ACTOR_TRANSITION_PROBE payload");
+ for (const auto& actor_status : status) {
+ if (not actor_status.enabled)
+ continue;
+
+ const auto& actor = actor_list.at(actor_status.aid);
+ const int max_considered = actor_status.max_considered;
+
+ for (int times_considered = 0; times_considered < max_considered; times_considered++) {
+ std::stringstream stream;
+ s_mc_message_simcall_probe_one_t probe;
+
+ if (actor->simcall_.observer_ != nullptr) {
+ actor->simcall_.observer_->prepare(times_considered);
+ actor->simcall_.observer_->serialize(stream);
+ } else {
+ stream << (short)mc::Transition::Type::UNKNOWN;
+ }
+
+ std::string str = stream.str();
+ xbt_assert(str.size() + 1 <= probe.buffer.size(),
+ "The serialized transition is too large for the buffer. Please fix the code.");
+ strncpy(probe.buffer.data(), str.c_str(), probe.buffer.size() - 1);
+ probe.buffer.back() = '\0';
+
+ xbt_assert(channel_.send(probe) == 0, "Could not send ACTOR_TRANSITION_PROBE payload");
+ }
+ // NOTE: We do NOT need to reset `times_considered` for each actor's
+ // simcall observer here to the "original" value (i.e. the value BEFORE
+ // multiple prepare() calls were made for serialization purposes) since
+ // each SIMCALL_EXECUTE provides a `times_considered` to be used to prepare
+ // the transition before execution.
+ }
+}
+void AppSide::handle_actors_maxpid() const
+{
+ s_mc_message_int_t answer = {};
+ answer.type = MessageType::ACTORS_MAXPID_REPLY;
+ answer.value = kernel::actor::ActorImpl::get_maxpid();
+ xbt_assert(channel_.send(answer) == 0, "Could not send response");
+}
#define assert_msg_size(_name_, _type_) \
xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size, \
sizeof(_type_))
-void AppSide::handle_messages() const
+void AppSide::handle_messages()
{
while (true) { // Until we get a CONTINUE message
XBT_DEBUG("Waiting messages from model-checker");
std::array<char, MC_MESSAGE_LENGTH> message_buffer;
ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
+ if (received_size == 0) {
+ XBT_DEBUG("Socket closed on the Checker side, bailing out.");
+ ::_Exit(0); // Nobody's listening to that process anymore => exit as quickly as possible.
+ }
xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
+ xbt_assert(static_cast<size_t>(received_size) >= sizeof(s_mc_message_t), "Cannot handle short message (size=%zd)",
+ received_size);
const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
switch (message->type) {
handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data());
break;
- case MessageType::ACTOR_ENABLED:
- assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
- handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
- break;
-
case MessageType::FINALIZE:
assert_msg_size("FINALIZE", s_mc_message_int_t);
handle_finalize((s_mc_message_int_t*)message_buffer.data());
break;
+ case MessageType::NEED_MEMINFO:
+ assert_msg_size("NEED_MEMINFO", s_mc_message_t);
+ handle_need_meminfo();
+ break;
+
+ case MessageType::ACTORS_STATUS:
+ assert_msg_size("ACTORS_STATUS", s_mc_message_t);
+ handle_actors_status();
+ break;
+
+ case MessageType::ACTORS_MAXPID:
+ assert_msg_size("ACTORS_MAXPID", s_mc_message_t);
+ handle_actors_maxpid();
+ break;
+
default:
xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
break;
}
}
-void AppSide::main_loop() const
+void AppSide::main_loop()
{
simgrid::mc::processes_time.resize(simgrid::kernel::actor::ActorImpl::get_maxpid());
MC_ignore_heap(simgrid::mc::processes_time.data(),
simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0]));
+ sthread_disable();
coverage_checkpoint();
+ sthread_enable();
while (true) {
simgrid::mc::execute_actors();
xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
}
}
-void AppSide::report_assertion_failure() const
+void AppSide::report_assertion_failure()
{
xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
this->handle_messages();
void AppSide::ignore_memory(void* addr, std::size_t size) const
{
- s_mc_message_ignore_memory_t message;
+ if (not MC_is_active() || not need_memory_info_)
+ return;
+
+ s_mc_message_ignore_memory_t message = {};
message.type = MessageType::IGNORE_MEMORY;
message.addr = (std::uintptr_t)addr;
message.size = size;
void AppSide::ignore_heap(void* address, std::size_t size) const
{
+ if (not MC_is_active() || not need_memory_info_)
+ return;
+
const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
- s_mc_message_ignore_heap_t message;
+ s_mc_message_ignore_heap_t message = {};
message.type = MessageType::IGNORE_HEAP;
message.address = address;
message.size = size;
void AppSide::unignore_heap(void* address, std::size_t size) const
{
- s_mc_message_ignore_memory_t message;
+ if (not MC_is_active() || not need_memory_info_)
+ return;
+
+ s_mc_message_ignore_memory_t message = {};
message.type = MessageType::UNIGNORE_HEAP;
message.addr = (std::uintptr_t)address;
message.size = size;
void AppSide::declare_symbol(const char* name, int* value) const
{
- s_mc_message_register_symbol_t message;
- memset(&message, 0, sizeof(message));
+ if (not MC_is_active() || not need_memory_info_) {
+ XBT_CRITICAL("Ignore AppSide::declare_symbol(%s)", name);
+ return;
+ }
+
+ s_mc_message_register_symbol_t message = {};
message.type = MessageType::REGISTER_SYMBOL;
xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
- strncpy(message.name.data(), name, message.name.size());
+ strncpy(message.name.data(), name, message.name.size() - 1);
message.callback = nullptr;
message.data = value;
xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
}
+/** Register a stack in the model checker
+ *
+ * The stacks are allocated in the heap. The MC handle them specifically
+ * when we analyze/compare the content of the heap so it must be told where
+ * they are with this function.
+ */
void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
{
+ if (not MC_is_active() || not need_memory_info_)
+ return;
+
const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
- s_stack_region_t region;
- memset(®ion, 0, sizeof(region));
+ s_stack_region_t region = {};
region.address = stack;
region.context = context;
region.size = size;
region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
- s_mc_message_stack_region_t message;
+ s_mc_message_stack_region_t message = {};
message.type = MessageType::STACK_REGION;
message.stack_region = region;
xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
}
-} // namespace mc
-} // namespace simgrid
+} // namespace simgrid::mc
