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");
36 std::unique_ptr<AppSide> AppSide::instance_;
38 AppSide* AppSide::initialize()
40 if (not std::getenv(MC_ENV_SOCKET_FD)) // We are not in MC mode: don't initialize the MC world
43 // Do not break if we are called multiple times:
45 return instance_.get();
47 _sg_do_model_check = 1;
49 setvbuf(stdout, nullptr, _IOLBF, 0);
51 // Fetch socket from MC_ENV_SOCKET_FD:
52 const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
53 int fd = xbt_str_parse_int(fd_env, "Not a number in variable '" MC_ENV_SOCKET_FD "'");
54 XBT_DEBUG("Model-checked application found socket FD %i", fd);
56 // Check the socket type/validity:
58 socklen_t socklen = sizeof(type);
59 xbt_assert(getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) == 0, "Could not check socket type");
60 xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type);
61 XBT_DEBUG("Model-checked application found expected socket type");
63 instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
65 // Wait for the model-checker:
68 ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
70 ptrace(PT_TRACE_ME, 0, nullptr, 0);
72 #error "no ptrace equivalent coded for this platform"
74 xbt_assert(errno == 0 && raise(SIGSTOP) == 0, "Could not wait for the model-checker (errno = %d: %s)", errno,
77 s_mc_message_initial_addresses_t message{MessageType::INITIAL_ADDRESSES, mmalloc_preinit(),
78 kernel::actor::get_maxpid_addr(), kernel::get_actors_addr(),
79 kernel::get_dead_actors_addr()};
80 xbt_assert(instance_->channel_.send(message) == 0, "Could not send the initial message with addresses.");
82 instance_->handle_messages();
83 return instance_.get();
86 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
88 const auto& actor_list = kernel::EngineImpl::get_instance()->get_actor_list();
89 bool deadlock = not actor_list.empty() && std::none_of(begin(actor_list), end(actor_list), [](const auto& kv) {
90 return mc::actor_is_enabled(kv.second);
94 s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
95 xbt_assert(channel_.send(answer) == 0, "Could not send response");
97 void AppSide::handle_simcall_execute(const s_mc_message_simcall_execute_t* message) const
99 kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(message->aid_);
100 xbt_assert(actor != nullptr, "Invalid pid %ld", message->aid_);
102 // Finish the RPC from the server: return a serialized observer, to build a Transition on Checker side
103 s_mc_message_simcall_execute_answer_t answer;
104 memset(&answer, 0, sizeof(answer));
105 answer.type = MessageType::SIMCALL_EXECUTE_ANSWER;
106 if (actor->simcall_.observer_ != nullptr) {
107 std::stringstream stream;
108 actor->simcall_.observer_->serialize(answer.simcall, stream);
109 xbt_assert(stream.str().size() < sizeof(answer.buffer),
110 "The serialized simcall is too large for the buffer. Please fix the code.");
111 strncpy(answer.buffer, stream.str().c_str(), SIMCALL_SERIALIZATION_BUFFER_SIZE);
113 answer.simcall = mc::Transition::Type::UNKNOWN;
116 XBT_DEBUG("send SIMCALL_EXECUTE_ANSWER(%s) ~> %s '%s'", actor->get_cname(), mc::Transition::to_c_str(answer.simcall),
118 xbt_assert(channel_.send(answer) == 0, "Could not send response");
120 // The client may send some messages to the server while processing the transition
121 actor->simcall_handle(message->times_considered_);
123 // Say the server that the transition is over and that it should proceed
124 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
127 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
129 bool res = mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
130 s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
131 XBT_DEBUG("Actor %ld %s enabled", msg->aid, (res ? "IS" : "is NOT"));
132 xbt_assert(channel_.send(answer) == 0, "Could not send ACTOR_ENABLED_REPLY");
135 #define assert_msg_size(_name_, _type_) \
136 xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size, \
139 void AppSide::handle_messages() const
141 while (true) { // Until we get a CONTINUE message
142 XBT_DEBUG("Waiting messages from model-checker");
144 std::array<char, MC_MESSAGE_LENGTH> message_buffer;
145 ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
147 xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
149 const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
150 switch (message->type) {
151 case MessageType::DEADLOCK_CHECK:
152 assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
153 handle_deadlock_check(message);
156 case MessageType::CONTINUE:
157 assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
160 case MessageType::SIMCALL_EXECUTE:
161 assert_msg_size("SIMCALL_EXECUTE", s_mc_message_simcall_execute_t);
162 handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data());
165 case MessageType::SIMCALL_IS_VISIBLE: {
166 assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
167 auto msg_simcall = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
168 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
169 xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
170 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
171 bool value = actor->simcall_.observer_->is_visible();
174 s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
175 xbt_assert(channel_.send(answer) == 0, "Could not send response");
179 case MessageType::ACTOR_ENABLED:
180 assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
181 handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
184 case MessageType::FINALIZE: {
185 assert_msg_size("FINALIZE", s_mc_message_int_t);
186 bool terminate_asap = ((s_mc_message_int_t*)message_buffer.data())->value;
187 XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
188 if (not terminate_asap) {
189 if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
190 kernel::EngineImpl::get_instance()->display_all_actor_status();
192 XBT_DEBUG("Smpi_enabled: %d", (int)smpi_enabled());
197 coverage_checkpoint();
198 xbt_assert(channel_.send(MessageType::DEADLOCK_CHECK_REPLY) == 0, // DEADLOCK_CHECK_REPLY, really?
199 "Could not answer to FINALIZE");
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 coverage_checkpoint();
217 simgrid::mc::execute_actors();
218 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
219 this->handle_messages();
223 void AppSide::report_assertion_failure() const
225 xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
226 this->handle_messages();
229 void AppSide::ignore_memory(void* addr, std::size_t size) const
231 s_mc_message_ignore_memory_t message;
232 message.type = MessageType::IGNORE_MEMORY;
233 message.addr = (std::uintptr_t)addr;
235 xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
238 void AppSide::ignore_heap(void* address, std::size_t size) const
240 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
242 s_mc_message_ignore_heap_t message;
243 message.type = MessageType::IGNORE_HEAP;
244 message.address = address;
246 message.block = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
247 if (heap->heapinfo[message.block].type == 0) {
248 message.fragment = -1;
249 heap->heapinfo[message.block].busy_block.ignore++;
251 message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
252 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
255 xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer");
258 void AppSide::unignore_heap(void* address, std::size_t size) const
260 s_mc_message_ignore_memory_t message;
261 message.type = MessageType::UNIGNORE_HEAP;
262 message.addr = (std::uintptr_t)address;
264 xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
267 void AppSide::declare_symbol(const char* name, int* value) const
269 s_mc_message_register_symbol_t message;
270 memset(&message, 0, sizeof(message));
271 message.type = MessageType::REGISTER_SYMBOL;
272 xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
273 strncpy(message.name.data(), name, message.name.size());
274 message.callback = nullptr;
275 message.data = value;
276 xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
279 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
281 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
283 s_stack_region_t region;
284 memset(®ion, 0, sizeof(region));
285 region.address = stack;
286 region.context = context;
288 region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
290 s_mc_message_stack_region_t message;
291 message.type = MessageType::STACK_REGION;
292 message.stack_region = region;
293 xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
296 } // namespace simgrid