1 /* Copyright (c) 2015-2022. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "src/mc/remote/AppSide.hpp"
7 #include "simgrid/s4u/Host.hpp"
8 #include "src/internal_config.h"
9 #include "src/kernel/EngineImpl.hpp"
10 #include "src/kernel/actor/ActorImpl.hpp"
11 #include "src/kernel/actor/SimcallObserver.hpp"
12 #include "src/mc/mc_base.hpp"
13 #include "src/mc/remote/RemoteProcess.hpp"
15 #include "src/smpi/include/private.hpp"
17 #include "xbt/coverage.h"
19 #include "xbt/xbt_modinter.h" /* mmalloc_preinit to get the default mmalloc arena address */
20 #include <simgrid/modelchecker.h>
23 #include <cstdio> // setvbuf
27 #include <sys/ptrace.h>
28 #include <sys/socket.h>
29 #include <sys/types.h>
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
33 namespace simgrid::mc {
35 std::unique_ptr<AppSide> AppSide::instance_;
37 AppSide* AppSide::initialize(xbt_dynar_t actors_addr)
39 if (not std::getenv(MC_ENV_SOCKET_FD)) // We are not in MC mode: don't initialize the MC world
42 // Do not break if we are called multiple times:
44 return instance_.get();
46 _sg_do_model_check = 1;
48 setvbuf(stdout, nullptr, _IOLBF, 0);
50 // Fetch socket from MC_ENV_SOCKET_FD:
51 const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
52 int fd = xbt_str_parse_int(fd_env, "Not a number in variable '" MC_ENV_SOCKET_FD "'");
53 XBT_DEBUG("Model-checked application found socket FD %i", fd);
55 // Check the socket type/validity:
57 socklen_t socklen = sizeof(type);
58 xbt_assert(getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) == 0, "Could not check socket type");
59 xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type);
60 XBT_DEBUG("Model-checked application found expected socket type");
62 instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
64 // Wait for the model-checker:
67 ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
69 ptrace(PT_TRACE_ME, 0, nullptr, 0);
71 #error "no ptrace equivalent coded for this platform"
73 xbt_assert(errno == 0 && raise(SIGSTOP) == 0, "Could not wait for the model-checker (errno = %d: %s)", errno,
76 s_mc_message_initial_addresses_t message{MessageType::INITIAL_ADDRESSES, mmalloc_get_current_heap(),
77 kernel::actor::ActorImpl::get_maxpid_addr(), actors_addr};
78 xbt_assert(instance_->channel_.send(message) == 0, "Could not send the initial message with addresses.");
80 instance_->handle_messages();
81 return instance_.get();
84 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
86 const auto& actor_list = kernel::EngineImpl::get_instance()->get_actor_list();
87 bool deadlock = not actor_list.empty() && std::none_of(begin(actor_list), end(actor_list), [](const auto& kv) {
88 return mc::actor_is_enabled(kv.second);
92 s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
93 xbt_assert(channel_.send(answer) == 0, "Could not send response");
95 void AppSide::handle_simcall_execute(const s_mc_message_simcall_execute_t* message) const
97 kernel::actor::ActorImpl* actor = kernel::EngineImpl::get_instance()->get_actor_by_pid(message->aid_);
98 xbt_assert(actor != nullptr, "Invalid pid %ld", message->aid_);
100 // The client may send some messages to the server while processing the transition
101 actor->simcall_handle(message->times_considered_);
102 // Say the server that the transition is over and that it should proceed
103 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
105 // Finish the RPC from the server: return a serialized observer, to build a Transition on Checker side
106 s_mc_message_simcall_execute_answer_t answer;
107 memset(&answer, 0, sizeof(answer));
108 answer.type = MessageType::SIMCALL_EXECUTE_ANSWER;
109 std::stringstream stream;
110 if (actor->simcall_.observer_ != nullptr) {
111 actor->simcall_.observer_->serialize(stream);
113 stream << (short)mc::Transition::Type::UNKNOWN;
115 std::string str = stream.str();
116 xbt_assert(str.size() + 1 <= answer.buffer.size(),
117 "The serialized simcall is too large for the buffer. Please fix the code.");
118 strncpy(answer.buffer.data(), str.c_str(), answer.buffer.size() - 1);
119 answer.buffer.back() = '\0';
121 XBT_DEBUG("send SIMCALL_EXECUTE_ANSWER(%s) ~> '%s'", actor->get_cname(), str.c_str());
122 xbt_assert(channel_.send(answer) == 0, "Could not send response");
125 void AppSide::handle_finalize(const s_mc_message_int_t* msg) const
127 bool terminate_asap = msg->value;
128 XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
129 if (not terminate_asap) {
130 if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
131 kernel::EngineImpl::get_instance()->display_all_actor_status();
133 XBT_DEBUG("Smpi_enabled: %d", SMPI_is_inited());
134 if (SMPI_is_inited())
138 coverage_checkpoint();
139 xbt_assert(channel_.send(MessageType::DEADLOCK_CHECK_REPLY) ==
140 0, // DEADLOCK_CHECK_REPLY because I'm too lazy to create another message type with no content (FIXME)
141 "Could not answer to FINALIZE");
146 void AppSide::handle_actors_status() const
148 auto const& actor_list = kernel::EngineImpl::get_instance()->get_actor_list();
149 int count = actor_list.size();
151 struct s_mc_message_actors_status_answer_t answer {
152 MessageType::ACTORS_STATUS_REPLY, count
154 s_mc_message_actors_status_one_t status[count];
156 for (auto const& [aid, actor] : actor_list) {
158 status[i].enabled = mc::actor_is_enabled(actor);
159 status[i].max_considered = actor->simcall_.observer_->get_max_consider();
162 xbt_assert(channel_.send(answer) == 0, "Could not send ACTORS_STATUS_REPLY msg");
163 xbt_assert(channel_.send(status, sizeof(status)) == 0, "Could not send ACTORS_STATUS_REPLY data");
166 #define assert_msg_size(_name_, _type_) \
167 xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size, \
170 void AppSide::handle_messages() const
172 while (true) { // Until we get a CONTINUE message
173 XBT_DEBUG("Waiting messages from model-checker");
175 std::array<char, MC_MESSAGE_LENGTH> message_buffer;
176 ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
178 xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
180 const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
181 switch (message->type) {
182 case MessageType::DEADLOCK_CHECK:
183 assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
184 handle_deadlock_check(message);
187 case MessageType::CONTINUE:
188 assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
191 case MessageType::SIMCALL_EXECUTE:
192 assert_msg_size("SIMCALL_EXECUTE", s_mc_message_simcall_execute_t);
193 handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data());
196 case MessageType::FINALIZE:
197 assert_msg_size("FINALIZE", s_mc_message_int_t);
198 handle_finalize((s_mc_message_int_t*)message_buffer.data());
201 case MessageType::ACTORS_STATUS:
202 assert_msg_size("ACTORS_STATUS", s_mc_message_t);
203 handle_actors_status();
207 xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
213 void AppSide::main_loop() const
215 simgrid::mc::processes_time.resize(simgrid::kernel::actor::ActorImpl::get_maxpid());
216 MC_ignore_heap(simgrid::mc::processes_time.data(),
217 simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0]));
219 coverage_checkpoint();
221 simgrid::mc::execute_actors();
222 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
223 this->handle_messages();
227 void AppSide::report_assertion_failure() const
229 xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
230 this->handle_messages();
233 void AppSide::ignore_memory(void* addr, std::size_t size) const
235 s_mc_message_ignore_memory_t message;
236 message.type = MessageType::IGNORE_MEMORY;
237 message.addr = (std::uintptr_t)addr;
239 xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
242 void AppSide::ignore_heap(void* address, std::size_t size) const
244 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
246 s_mc_message_ignore_heap_t message;
247 message.type = MessageType::IGNORE_HEAP;
248 message.address = address;
250 message.block = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
251 if (heap->heapinfo[message.block].type == 0) {
252 message.fragment = -1;
253 heap->heapinfo[message.block].busy_block.ignore++;
255 message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
256 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
259 xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer");
262 void AppSide::unignore_heap(void* address, std::size_t size) const
264 s_mc_message_ignore_memory_t message;
265 message.type = MessageType::UNIGNORE_HEAP;
266 message.addr = (std::uintptr_t)address;
268 xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
271 void AppSide::declare_symbol(const char* name, int* value) const
273 s_mc_message_register_symbol_t message;
274 memset(&message, 0, sizeof(message));
275 message.type = MessageType::REGISTER_SYMBOL;
276 xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
277 strncpy(message.name.data(), name, message.name.size());
278 message.callback = nullptr;
279 message.data = value;
280 xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
283 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
285 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
287 s_stack_region_t region;
288 memset(®ion, 0, sizeof(region));
289 region.address = stack;
290 region.context = context;
292 region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
294 s_mc_message_stack_region_t message;
295 message.type = MessageType::STACK_REGION;
296 message.stack_region = region;
297 xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
299 } // namespace simgrid::mc