-/* Copyright (c) 2015-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2015-2021. 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/remote/AppSide.hpp"
#include "src/internal_config.h"
+#include "src/kernel/EngineImpl.hpp"
+#include "src/kernel/actor/ActorImpl.hpp"
+#include "src/kernel/actor/SimcallObserver.hpp"
+#include "src/mc/mc_base.hpp"
+#include "src/mc/remote/RemoteProcess.hpp"
+#if HAVE_SMPI
+#include "src/smpi/include/private.hpp"
+#endif
+#include "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 <sys/ptrace.h>
#include <sys/socket.h>
#include <sys/types.h>
-// We won't need those once the separation MCer/MCed is complete:
-#include "src/mc/mc_smx.hpp"
-
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
namespace simgrid {
_sg_do_model_check = 1;
+ setvbuf(stdout, nullptr, _IOLBF, 0);
+
// Fetch socket from MC_ENV_SOCKET_FD:
const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
- int fd = xbt_str_parse_int(fd_env, "Variable '" MC_ENV_SOCKET_FD "' should contain a number but contains '%s'");
+ int fd = xbt_str_parse_int(fd_env, "Not a number in variable '" MC_ENV_SOCKET_FD "'");
XBT_DEBUG("Model-checked application found socket FD %i", fd);
// Check the socket type/validity:
int type;
socklen_t socklen = sizeof(type);
- if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0)
- xbt_die("Could not check socket type");
+ xbt_assert(getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) == 0, "Could not check socket type");
xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type);
XBT_DEBUG("Model-checked application found expected socket type");
- instance_.reset(new simgrid::mc::AppSide(fd));
+ instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
// Wait for the model-checker:
errno = 0;
#else
#error "no ptrace equivalent coded for this platform"
#endif
- if (errno != 0 || raise(SIGSTOP) != 0)
- xbt_die("Could not wait for the model-checker (errno = %d: %s)", errno, strerror(errno));
+ 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::get_maxpid_addr(), simix::simix_global_get_actors_addr(),
+ simix::simix_global_get_dead_actors_addr()};
+ xbt_assert(instance_->channel_.send(message) == 0, "Could not send the initial message with addresses.");
instance_->handle_messages();
return instance_.get();
void AppSide::handle_deadlock_check(const s_mc_message_t*) const
{
- bool deadlock = false;
- if (not simix_global->process_list.empty()) {
- deadlock = true;
- for (auto const& kv : simix_global->process_list)
- if (simgrid::mc::actor_is_enabled(kv.second)) {
- deadlock = false;
- break;
- }
- }
+ const auto& actor_list = kernel::EngineImpl::get_instance()->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);
+ });
// Send result:
- s_mc_message_int_t answer{MC_MESSAGE_DEADLOCK_CHECK_REPLY, deadlock};
+ s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
xbt_assert(channel_.send(answer) == 0, "Could not send response");
}
-void AppSide::handle_continue(const s_mc_message_t*) const
-{
- /* Nothing to do */
-}
-void AppSide::handle_simcall(const s_mc_message_simcall_handle_t* message) const
+void AppSide::handle_simcall_execute(const s_mc_message_simcall_handle_t* message) const
{
- smx_actor_t process = SIMIX_process_from_PID(message->pid);
- xbt_assert(process != nullptr, "Invalid pid %lu", message->pid);
- process->simcall_handle(message->value);
- if (channel_.send(MC_MESSAGE_WAITING))
- xbt_die("Could not send MESSAGE_WAITING to model-checker");
+ kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(message->aid_);
+ xbt_assert(actor != nullptr, "Invalid pid %ld", message->aid_);
+ if (actor->simcall_.observer_ != nullptr)
+ actor->observer_stack_.push_back(actor->simcall_.observer_->clone());
+ actor->simcall_handle(message->times_considered_);
+ xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
}
void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
{
- bool res = simgrid::mc::actor_is_enabled(SIMIX_process_from_PID(msg->aid));
- s_mc_message_int_t answer{MC_MESSAGE_ACTOR_ENABLED_REPLY, res};
- channel_.send(answer);
+ bool res = mc::actor_is_enabled(kernel::actor::ActorImpl::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");
}
#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()
+void AppSide::handle_messages() const
{
- while (true) {
+ while (true) { // Until we get a CONTINUE message
XBT_DEBUG("Waiting messages from model-checker");
- char message_buffer[MC_MESSAGE_LENGTH];
- ssize_t received_size = channel_.receive(&message_buffer, sizeof(message_buffer));
+ std::array<char, MC_MESSAGE_LENGTH> message_buffer;
+ ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
- const s_mc_message_t* message = (s_mc_message_t*)message_buffer;
+ const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
switch (message->type) {
- case MC_MESSAGE_DEADLOCK_CHECK:
+ case MessageType::DEADLOCK_CHECK:
assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
handle_deadlock_check(message);
break;
- case MC_MESSAGE_CONTINUE:
+ case MessageType::CONTINUE:
assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
- handle_continue(message);
return;
- case MC_MESSAGE_SIMCALL_HANDLE:
+ case MessageType::SIMCALL_HANDLE:
assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t);
- handle_simcall((s_mc_message_simcall_handle_t*)message_buffer);
+ handle_simcall_execute((s_mc_message_simcall_handle_t*)message_buffer.data());
break;
- case MC_MESSAGE_ACTOR_ENABLED:
+ case MessageType::SIMCALL_IS_VISIBLE: {
+ assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
+ auto msg_simcall = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
+ const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
+ xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
+ xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
+ bool value = actor->simcall_.observer_->is_visible();
+
+ // Send result:
+ s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
+ xbt_assert(channel_.send(answer) == 0, "Could not send response");
+ break;
+ }
+
+ case MessageType::SIMCALL_TO_STRING: {
+ assert_msg_size("SIMCALL_TO_STRING", s_mc_message_simcall_to_string_t);
+ auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
+ const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
+ xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
+ xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
+ std::string value = actor->simcall_.observer_->to_string(msg_simcall->time_considered);
+
+ // Send result:
+ s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
+ value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
+ xbt_assert(channel_.send(answer) == 0, "Could not send response");
+ break;
+ }
+
+ case MessageType::SIMCALL_DOT_LABEL: {
+ assert_msg_size("SIMCALL_DOT_LABEL", s_mc_message_simcall_to_string_t);
+ auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
+ const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
+ xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
+ xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
+ std::string value = actor->simcall_.observer_->dot_label();
+
+ // Send result:
+ s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
+ value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
+ xbt_assert(channel_.send(answer) == 0, "Could not send response");
+ 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);
+ 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);
+ bool terminate_asap = ((s_mc_message_int_t*)message_buffer.data())->value;
+ XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
+ if (not terminate_asap) {
+ 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())
+ SMPI_finalize();
+#endif
+ }
+ coverage_checkpoint();
+ xbt_assert(channel_.send(MessageType::DEADLOCK_CHECK_REPLY) == 0, // DEADLOCK_CHECK_REPLY, really?
+ "Could not answer to FINALIZE");
+ std::fflush(stdout);
+ if (terminate_asap)
+ ::_Exit(0);
+ break;
+ }
+
default:
- xbt_die("Received unexpected message %s (%i)", MC_message_type_name(message->type), message->type);
+ xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
break;
}
}
}
-void AppSide::main_loop()
+void AppSide::main_loop() const
{
+ coverage_checkpoint();
while (true) {
- simgrid::mc::wait_for_requests();
- xbt_assert(channel_.send(MC_MESSAGE_WAITING) == 0, "Could not send WAITING message to model-checker");
+ simgrid::mc::execute_actors();
+ xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
this->handle_messages();
}
}
-void AppSide::report_assertion_failure()
+void AppSide::report_assertion_failure() const
{
- if (channel_.send(MC_MESSAGE_ASSERTION_FAILED))
- xbt_die("Could not send assertion to model-checker");
+ 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;
- message.type = MC_MESSAGE_IGNORE_MEMORY;
+ message.type = MessageType::IGNORE_MEMORY;
message.addr = (std::uintptr_t)addr;
message.size = size;
- if (channel_.send(message))
- xbt_die("Could not send IGNORE_MEMORY message to model-checker");
+ xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
}
void AppSide::ignore_heap(void* address, std::size_t size) const
const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
s_mc_message_ignore_heap_t message;
- message.type = MC_MESSAGE_IGNORE_HEAP;
+ message.type = MessageType::IGNORE_HEAP;
message.address = address;
message.size = size;
message.block = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
message.fragment = -1;
heap->heapinfo[message.block].busy_block.ignore++;
} else {
- message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
+ message.fragment = address ? (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type : 0;
heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
}
- if (channel_.send(message))
- xbt_die("Could not send ignored region to MCer");
+ xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer");
}
void AppSide::unignore_heap(void* address, std::size_t size) const
{
s_mc_message_ignore_memory_t message;
- message.type = MC_MESSAGE_UNIGNORE_HEAP;
+ message.type = MessageType::UNIGNORE_HEAP;
message.addr = (std::uintptr_t)address;
message.size = size;
- if (channel_.send(message))
- xbt_die("Could not send IGNORE_HEAP message to model-checker");
+ xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
}
void AppSide::declare_symbol(const char* name, int* value) const
{
s_mc_message_register_symbol_t message;
- message.type = MC_MESSAGE_REGISTER_SYMBOL;
- if (strlen(name) + 1 > sizeof(message.name))
- xbt_die("Symbol is too long");
- strncpy(message.name, name, sizeof(message.name));
+ 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());
message.callback = nullptr;
message.data = value;
- if (channel_.send(message))
- xbt_die("Could send REGISTER_SYMBOL message to model-checker");
+ xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
}
void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
s_mc_message_stack_region_t message;
- message.type = MC_MESSAGE_STACK_REGION;
+ message.type = MessageType::STACK_REGION;
message.stack_region = region;
- if (channel_.send(message))
- xbt_die("Could not send STACK_REGION to model-checker");
+ xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
}
} // namespace mc
} // namespace simgrid
