1 /* Copyright (c) 2015-2021. 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 "src/internal_config.h"
8 #include "src/kernel/actor/ActorImpl.hpp"
9 #include "src/kernel/actor/SimcallObserver.hpp"
10 #include "src/mc/remote/RemoteProcess.hpp"
11 #include "xbt/coverage.h"
12 #include "xbt/xbt_modinter.h" /* mmalloc_preinit to get the default mmalloc arena address */
13 #include <simgrid/modelchecker.h>
19 #include <sys/ptrace.h>
20 #include <sys/socket.h>
21 #include <sys/types.h>
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
28 std::unique_ptr<AppSide> AppSide::instance_;
30 AppSide* AppSide::initialize()
32 if (not std::getenv(MC_ENV_SOCKET_FD)) // We are not in MC mode: don't initialize the MC world
35 // Do not break if we are called multiple times:
37 return instance_.get();
39 _sg_do_model_check = 1;
41 // Fetch socket from MC_ENV_SOCKET_FD:
42 const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
43 int fd = xbt_str_parse_int(fd_env, "Variable '" MC_ENV_SOCKET_FD "' should contain a number but contains '%s'");
44 XBT_DEBUG("Model-checked application found socket FD %i", fd);
46 // Check the socket type/validity:
48 socklen_t socklen = sizeof(type);
49 xbt_assert(getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) == 0, "Could not check socket type");
50 xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type);
51 XBT_DEBUG("Model-checked application found expected socket type");
53 instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
55 // Wait for the model-checker:
58 ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
60 ptrace(PT_TRACE_ME, 0, nullptr, 0);
62 #error "no ptrace equivalent coded for this platform"
64 xbt_assert(errno == 0 && raise(SIGSTOP) == 0, "Could not wait for the model-checker (errno = %d: %s)", errno,
67 s_mc_message_initial_addresses_t message{
68 MessageType::INITIAL_ADDRESSES, mmalloc_preinit(), simgrid::kernel::actor::get_maxpid_addr(),
69 simgrid::simix::simix_global_get_actors_addr(), simgrid::simix::simix_global_get_dead_actors_addr()};
70 xbt_assert(instance_->channel_.send(message) == 0, "Could not send the initial message with addresses.");
72 instance_->handle_messages();
73 return instance_.get();
76 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
78 bool deadlock = false;
79 if (not simix_global->process_list.empty()) {
81 for (auto const& kv : simix_global->process_list)
82 if (simgrid::mc::actor_is_enabled(kv.second)) {
89 s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
90 xbt_assert(channel_.send(answer) == 0, "Could not send response");
92 void AppSide::handle_simcall_execute(const s_mc_message_simcall_handle_t* message) const
94 kernel::actor::ActorImpl* process = kernel::actor::ActorImpl::by_pid(message->aid_);
95 xbt_assert(process != nullptr, "Invalid pid %lu", message->aid_);
96 process->simcall_handle(message->times_considered_);
97 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
100 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
102 bool res = simgrid::mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
103 s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
104 channel_.send(answer);
107 #define assert_msg_size(_name_, _type_) \
108 xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size, \
111 void AppSide::handle_messages() const
113 while (true) { // Until we get a CONTINUE message
114 XBT_DEBUG("Waiting messages from model-checker");
116 std::array<char, MC_MESSAGE_LENGTH> message_buffer;
117 ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
119 xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
121 const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
122 switch (message->type) {
123 case MessageType::DEADLOCK_CHECK:
124 assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
125 handle_deadlock_check(message);
128 case MessageType::CONTINUE:
129 assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
132 case MessageType::SIMCALL_HANDLE:
133 assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t);
134 handle_simcall_execute((s_mc_message_simcall_handle_t*)message_buffer.data());
137 case MessageType::SIMCALL_IS_VISIBLE: {
138 assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
139 auto msg_simcall = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
140 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
141 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
142 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
143 bool value = actor->simcall_.observer_->is_visible();
146 s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
147 xbt_assert(channel_.send(answer) == 0, "Could not send response");
151 case MessageType::SIMCALL_TO_STRING: {
152 assert_msg_size("SIMCALL_TO_STRING", s_mc_message_simcall_to_string_t);
153 auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
154 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
155 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
156 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
157 std::string value = actor->simcall_.observer_->to_string(msg_simcall->time_considered);
160 s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
161 value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
162 xbt_assert(channel_.send(answer) == 0, "Could not send response");
166 case MessageType::SIMCALL_DOT_LABEL: {
167 assert_msg_size("SIMCALL_DOT_LABEL", s_mc_message_simcall_to_string_t);
168 auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
169 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
170 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
171 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
172 std::string value = actor->simcall_.observer_->dot_label();
175 s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
176 value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
177 xbt_assert(channel_.send(answer) == 0, "Could not send response");
181 case MessageType::ACTOR_ENABLED:
182 assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
183 handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
186 case MessageType::FINALIZE: {
187 assert_msg_size("FINALIZE", s_mc_message_int_t);
188 bool terminate_asap = ((s_mc_message_int_t*)message_buffer.data())->value;
189 XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
190 if (not terminate_asap) {
191 if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
192 simix_global->display_all_actor_status();
194 XBT_DEBUG("Smpi_enabled: %d", (int)smpi_enabled());
199 coverage_checkpoint();
200 xbt_assert(channel_.send(MessageType::DEADLOCK_CHECK_REPLY) == 0, // DEADLOCK_CHECK_REPLY, really?
201 "Could not answer to FINALIZE");
208 xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
214 void AppSide::main_loop() const
216 coverage_checkpoint();
218 simgrid::mc::execute_actors();
219 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
220 this->handle_messages();
224 void AppSide::report_assertion_failure() const
226 xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
227 this->handle_messages();
230 void AppSide::ignore_memory(void* addr, std::size_t size) const
232 s_mc_message_ignore_memory_t message;
233 message.type = MessageType::IGNORE_MEMORY;
234 message.addr = (std::uintptr_t)addr;
236 xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
239 void AppSide::ignore_heap(void* address, std::size_t size) const
241 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
243 s_mc_message_ignore_heap_t message;
244 message.type = MessageType::IGNORE_HEAP;
245 message.address = address;
247 message.block = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
248 if (heap->heapinfo[message.block].type == 0) {
249 message.fragment = -1;
250 heap->heapinfo[message.block].busy_block.ignore++;
252 message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
253 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
256 xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer");
259 void AppSide::unignore_heap(void* address, std::size_t size) const
261 s_mc_message_ignore_memory_t message;
262 message.type = MessageType::UNIGNORE_HEAP;
263 message.addr = (std::uintptr_t)address;
265 xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
268 void AppSide::declare_symbol(const char* name, int* value) const
270 s_mc_message_register_symbol_t 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