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 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0)
50 xbt_die("Could not check socket type");
51 xbt_assert(type == SOCK_SEQPACKET, "Unexpected socket type %i", type);
52 XBT_DEBUG("Model-checked application found expected socket type");
54 instance_ = std::make_unique<simgrid::mc::AppSide>(fd);
56 // Wait for the model-checker:
59 ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
61 ptrace(PT_TRACE_ME, 0, nullptr, 0);
63 #error "no ptrace equivalent coded for this platform"
65 if (errno != 0 || raise(SIGSTOP) != 0)
66 xbt_die("Could not wait for the model-checker (errno = %d: %s)", errno, strerror(errno));
68 s_mc_message_initial_addresses_t message{
69 MessageType::INITIAL_ADDRESSES, mmalloc_preinit(), simgrid::kernel::actor::get_maxpid_addr(),
70 simgrid::simix::simix_global_get_actors_addr(), simgrid::simix::simix_global_get_dead_actors_addr()};
71 int send_res = instance_->channel_.send(message);
72 xbt_assert(send_res == 0, "Could not send the initial message with addresses.");
74 instance_->handle_messages();
75 return instance_.get();
78 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
80 bool deadlock = false;
81 if (not simix_global->process_list.empty()) {
83 for (auto const& kv : simix_global->process_list)
84 if (simgrid::mc::actor_is_enabled(kv.second)) {
91 s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
92 int send_res = channel_.send(answer);
93 xbt_assert(send_res == 0, "Could not send response");
95 void AppSide::handle_simcall_execute(const s_mc_message_simcall_handle_t* message) const
97 kernel::actor::ActorImpl* process = kernel::actor::ActorImpl::by_pid(message->pid_);
98 xbt_assert(process != nullptr, "Invalid pid %lu", message->pid_);
99 process->simcall_handle(message->times_considered_);
100 if (channel_.send(MessageType::WAITING))
101 xbt_die("Could not send MESSAGE_WAITING to model-checker");
104 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
106 bool res = simgrid::mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
107 s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
108 channel_.send(answer);
111 #define assert_msg_size(_name_, _type_) \
112 xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size, \
115 void AppSide::handle_messages() const
117 while (true) { // Until we get a CONTINUE message
118 XBT_DEBUG("Waiting messages from model-checker");
120 std::array<char, MC_MESSAGE_LENGTH> message_buffer;
121 ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
123 xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
125 const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
126 switch (message->type) {
127 case MessageType::DEADLOCK_CHECK:
128 assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
129 handle_deadlock_check(message);
132 case MessageType::CONTINUE:
133 assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
136 case MessageType::SIMCALL_HANDLE:
137 assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t);
138 handle_simcall_execute((s_mc_message_simcall_handle_t*)message_buffer.data());
141 case MessageType::SIMCALL_IS_VISIBLE: {
142 assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
143 auto msg_simcall = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
144 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
145 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
146 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
147 bool value = actor->simcall_.observer_->is_visible();
150 s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
151 int send_res = channel_.send(answer);
152 xbt_assert(send_res == 0, "Could not send response");
156 case MessageType::SIMCALL_TO_STRING: {
157 assert_msg_size("SIMCALL_TO_STRING", s_mc_message_simcall_to_string_t);
158 auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
159 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
160 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
161 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
162 std::string value = actor->simcall_.observer_->to_string(msg_simcall->time_considered);
165 s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
166 value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
167 int send_res = channel_.send(answer);
168 xbt_assert(send_res == 0, "Could not send response");
172 case MessageType::SIMCALL_DOT_LABEL: {
173 assert_msg_size("SIMCALL_DOT_LABEL", s_mc_message_simcall_to_string_t);
174 auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
175 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
176 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
177 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
178 std::string value = actor->simcall_.observer_->dot_label();
181 s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
182 value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
183 int send_res = channel_.send(answer);
184 xbt_assert(send_res == 0, "Could not send response");
188 case MessageType::ACTOR_ENABLED:
189 assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
190 handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
193 case MessageType::FINALIZE: {
194 assert_msg_size("FINALIZE", s_mc_message_int_t);
195 bool terminate_asap = ((s_mc_message_int_t*)message_buffer.data())->value;
197 if (not terminate_asap) {
198 XBT_INFO("Finalize. Smpi_enabled: %d", (int)smpi_enabled());
199 simix_global->display_all_actor_status();
204 coverage_checkpoint();
205 int send_res = channel_.send(MessageType::DEADLOCK_CHECK_REPLY); // really?
206 xbt_assert(send_res == 0, "Could not answer to FINALIZE");
213 xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
219 void AppSide::main_loop() const
221 coverage_checkpoint();
223 simgrid::mc::execute_actors();
224 int send_res = channel_.send(MessageType::WAITING);
225 xbt_assert(send_res == 0, "Could not send WAITING message to model-checker");
226 this->handle_messages();
230 void AppSide::report_assertion_failure() const
232 if (channel_.send(MessageType::ASSERTION_FAILED))
233 xbt_die("Could not send assertion to model-checker");
234 this->handle_messages();
237 void AppSide::ignore_memory(void* addr, std::size_t size) const
239 s_mc_message_ignore_memory_t message;
240 message.type = MessageType::IGNORE_MEMORY;
241 message.addr = (std::uintptr_t)addr;
243 if (channel_.send(message))
244 xbt_die("Could not send IGNORE_MEMORY message to model-checker");
247 void AppSide::ignore_heap(void* address, std::size_t size) const
249 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
251 s_mc_message_ignore_heap_t message;
252 message.type = MessageType::IGNORE_HEAP;
253 message.address = address;
255 message.block = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
256 if (heap->heapinfo[message.block].type == 0) {
257 message.fragment = -1;
258 heap->heapinfo[message.block].busy_block.ignore++;
260 message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
261 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
264 if (channel_.send(message))
265 xbt_die("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 if (channel_.send(message))
275 xbt_die("Could not send IGNORE_HEAP message to model-checker");
278 void AppSide::declare_symbol(const char* name, int* value) const
280 s_mc_message_register_symbol_t message;
281 message.type = MessageType::REGISTER_SYMBOL;
282 if (strlen(name) + 1 > message.name.size())
283 xbt_die("Symbol is too long");
284 strncpy(message.name.data(), name, message.name.size());
285 message.callback = nullptr;
286 message.data = value;
287 if (channel_.send(message))
288 xbt_die("Could send REGISTER_SYMBOL message to model-checker");
291 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
293 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
295 s_stack_region_t region;
296 memset(®ion, 0, sizeof(region));
297 region.address = stack;
298 region.context = context;
300 region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
302 s_mc_message_stack_region_t message;
303 message.type = MessageType::STACK_REGION;
304 message.stack_region = region;
305 if (channel_.send(message))
306 xbt_die("Could not send STACK_REGION to model-checker");
309 } // namespace simgrid