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 actor->simcall_.observer_->serialize(answer.simcall, answer.buffer);
108 XBT_DEBUG("send SIMCALL_EXECUTE_ANSWER(%s) ~> %s '%s'", actor->get_cname(),
109 simgrid::kernel::actor::SimcallObserver::to_c_str(answer.simcall), answer.buffer);
110 xbt_assert(channel_.send(answer) == 0, "Could not send response");
112 // The client may send some messages to the server while processing the transition
113 actor->simcall_handle(message->times_considered_);
115 // Say the server that the transition is over and that it should proceed
116 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
119 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
121 bool res = mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
122 s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
123 XBT_DEBUG("Actor %ld %s enabled", msg->aid, (res ? "IS" : "is NOT"));
124 xbt_assert(channel_.send(answer) == 0, "Could not send ACTOR_ENABLED_REPLY");
127 #define assert_msg_size(_name_, _type_) \
128 xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size, \
131 void AppSide::handle_messages() const
133 while (true) { // Until we get a CONTINUE message
134 XBT_DEBUG("Waiting messages from model-checker");
136 std::array<char, MC_MESSAGE_LENGTH> message_buffer;
137 ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
139 xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
141 const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
142 switch (message->type) {
143 case MessageType::DEADLOCK_CHECK:
144 assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
145 handle_deadlock_check(message);
148 case MessageType::CONTINUE:
149 assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
152 case MessageType::SIMCALL_EXECUTE:
153 assert_msg_size("SIMCALL_EXECUTE", s_mc_message_simcall_execute_t);
154 handle_simcall_execute((s_mc_message_simcall_execute_t*)message_buffer.data());
157 case MessageType::SIMCALL_IS_VISIBLE: {
158 assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
159 auto msg_simcall = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
160 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
161 xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
162 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
163 bool value = actor->simcall_.observer_->is_visible();
166 s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
167 xbt_assert(channel_.send(answer) == 0, "Could not send response");
171 case MessageType::SIMCALL_DOT_LABEL: {
172 assert_msg_size("SIMCALL_DOT_LABEL", s_mc_message_simcall_to_string_t);
173 auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
174 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
175 xbt_assert(actor != nullptr, "Invalid pid %ld", msg_simcall->aid);
176 std::string value = "";
177 if (actor->simcall_.observer_ != nullptr)
178 value = actor->simcall_.observer_->dot_label(msg_simcall->time_considered);
180 value = "UNIMPLEMENTED";
183 s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_DOT_LABEL_ANSWER, {0}};
184 value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
185 xbt_assert(channel_.send(answer) == 0, "Could not send response");
189 case MessageType::ACTOR_ENABLED:
190 assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
191 handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
194 case MessageType::FINALIZE: {
195 assert_msg_size("FINALIZE", s_mc_message_int_t);
196 bool terminate_asap = ((s_mc_message_int_t*)message_buffer.data())->value;
197 XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
198 if (not terminate_asap) {
199 if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
200 kernel::EngineImpl::get_instance()->display_all_actor_status();
202 XBT_DEBUG("Smpi_enabled: %d", (int)smpi_enabled());
207 coverage_checkpoint();
208 xbt_assert(channel_.send(MessageType::DEADLOCK_CHECK_REPLY) == 0, // DEADLOCK_CHECK_REPLY, really?
209 "Could not answer to FINALIZE");
217 xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
223 void AppSide::main_loop() const
225 coverage_checkpoint();
227 simgrid::mc::execute_actors();
228 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
229 this->handle_messages();
233 void AppSide::report_assertion_failure() const
235 xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
236 this->handle_messages();
239 void AppSide::ignore_memory(void* addr, std::size_t size) const
241 s_mc_message_ignore_memory_t message;
242 message.type = MessageType::IGNORE_MEMORY;
243 message.addr = (std::uintptr_t)addr;
245 xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
248 void AppSide::ignore_heap(void* address, std::size_t size) const
250 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
252 s_mc_message_ignore_heap_t message;
253 message.type = MessageType::IGNORE_HEAP;
254 message.address = address;
256 message.block = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
257 if (heap->heapinfo[message.block].type == 0) {
258 message.fragment = -1;
259 heap->heapinfo[message.block].busy_block.ignore++;
261 message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
262 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
265 xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer");
268 void AppSide::unignore_heap(void* address, std::size_t size) const
270 s_mc_message_ignore_memory_t message;
271 message.type = MessageType::UNIGNORE_HEAP;
272 message.addr = (std::uintptr_t)address;
274 xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
277 void AppSide::declare_symbol(const char* name, int* value) const
279 s_mc_message_register_symbol_t message;
280 memset(&message, 0, sizeof(message));
281 message.type = MessageType::REGISTER_SYMBOL;
282 xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
283 strncpy(message.name.data(), name, message.name.size());
284 message.callback = nullptr;
285 message.data = value;
286 xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
289 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
291 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
293 s_stack_region_t region;
294 memset(®ion, 0, sizeof(region));
295 region.address = stack;
296 region.context = context;
298 region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
300 s_mc_message_stack_region_t message;
301 message.type = MessageType::STACK_REGION;
302 message.stack_region = region;
303 xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
306 } // namespace simgrid