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 "src/xbt_modinter.h" /* mmalloc_preinit to get the default mmalloc arena address */
12 #include <simgrid/modelchecker.h>
18 #include <sys/ptrace.h>
19 #include <sys/socket.h>
20 #include <sys/types.h>
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
27 std::unique_ptr<AppSide> AppSide::instance_;
29 AppSide* AppSide::initialize()
31 if (not std::getenv(MC_ENV_SOCKET_FD)) // We are not in MC mode: don't initialize the MC world
34 // Do not break if we are called multiple times:
36 return instance_.get();
38 _sg_do_model_check = 1;
40 // Fetch socket from MC_ENV_SOCKET_FD:
41 const char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
42 int fd = xbt_str_parse_int(fd_env, "Variable '" MC_ENV_SOCKET_FD "' should contain a number but contains '%s'");
43 XBT_DEBUG("Model-checked application found socket FD %i", fd);
45 // Check the socket type/validity:
47 socklen_t socklen = sizeof(type);
48 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0)
49 xbt_die("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 if (errno != 0 || raise(SIGSTOP) != 0)
65 xbt_die("Could not wait for the model-checker (errno = %d: %s)", errno, strerror(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->pid_);
95 xbt_assert(process != nullptr, "Invalid pid %lu", message->pid_);
96 process->simcall_handle(message->times_considered_);
97 if (channel_.send(MessageType::WAITING))
98 xbt_die("Could not send MESSAGE_WAITING to model-checker");
101 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
103 bool res = simgrid::mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
104 s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
105 channel_.send(answer);
108 #define assert_msg_size(_name_, _type_) \
109 xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size, \
112 void AppSide::handle_messages() const
114 while (true) { // Until we get a CONTINUE message
115 XBT_DEBUG("Waiting messages from model-checker");
117 std::array<char, MC_MESSAGE_LENGTH> message_buffer;
118 ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
120 xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
122 const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
123 switch (message->type) {
124 case MessageType::DEADLOCK_CHECK:
125 assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
126 handle_deadlock_check(message);
129 case MessageType::CONTINUE:
130 assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
133 case MessageType::SIMCALL_HANDLE:
134 assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t);
135 handle_simcall_execute((s_mc_message_simcall_handle_t*)message_buffer.data());
138 case MessageType::SIMCALL_IS_VISIBLE: {
139 assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
140 auto msg_simcall = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
141 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
142 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
143 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
144 bool value = actor->simcall_.observer_->is_visible();
147 s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
148 xbt_assert(channel_.send(answer) == 0, "Could not send response");
152 case MessageType::SIMCALL_TO_STRING: {
153 assert_msg_size("SIMCALL_TO_STRING", s_mc_message_simcall_to_string_t);
154 auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
155 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
156 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
157 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
158 std::string value = actor->simcall_.observer_->to_string(msg_simcall->time_considered);
161 s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
162 value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
163 xbt_assert(channel_.send(answer) == 0, "Could not send response");
167 case MessageType::SIMCALL_DOT_LABEL: {
168 assert_msg_size("SIMCALL_DOT_LABEL", s_mc_message_simcall_to_string_t);
169 auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
170 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
171 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
172 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
173 std::string value = actor->simcall_.observer_->dot_label();
176 s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
177 value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
178 xbt_assert(channel_.send(answer) == 0, "Could not send response");
182 case MessageType::ACTOR_ENABLED:
183 assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
184 handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
187 case MessageType::FINALIZE: {
189 XBT_INFO("Finalize. Smpi_enabled: %d", (int)smpi_enabled());
190 simix_global->display_all_actor_status();
194 s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, 0};
195 xbt_assert(channel_.send(answer) == 0, "Could answer to FINALIZE");
200 xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
206 void AppSide::main_loop() const
209 simgrid::mc::execute_actors();
210 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
211 this->handle_messages();
215 void AppSide::report_assertion_failure() const
217 if (channel_.send(MessageType::ASSERTION_FAILED))
218 xbt_die("Could not send assertion to model-checker");
219 this->handle_messages();
222 void AppSide::ignore_memory(void* addr, std::size_t size) const
224 s_mc_message_ignore_memory_t message;
225 message.type = MessageType::IGNORE_MEMORY;
226 message.addr = (std::uintptr_t)addr;
228 if (channel_.send(message))
229 xbt_die("Could not send IGNORE_MEMORY message to model-checker");
232 void AppSide::ignore_heap(void* address, std::size_t size) const
234 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
236 s_mc_message_ignore_heap_t message;
237 message.type = MessageType::IGNORE_HEAP;
238 message.address = address;
240 message.block = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
241 if (heap->heapinfo[message.block].type == 0) {
242 message.fragment = -1;
243 heap->heapinfo[message.block].busy_block.ignore++;
245 message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
246 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
249 if (channel_.send(message))
250 xbt_die("Could not send ignored region to MCer");
253 void AppSide::unignore_heap(void* address, std::size_t size) const
255 s_mc_message_ignore_memory_t message;
256 message.type = MessageType::UNIGNORE_HEAP;
257 message.addr = (std::uintptr_t)address;
259 if (channel_.send(message))
260 xbt_die("Could not send IGNORE_HEAP message to model-checker");
263 void AppSide::declare_symbol(const char* name, int* value) const
265 s_mc_message_register_symbol_t message;
266 message.type = MessageType::REGISTER_SYMBOL;
267 if (strlen(name) + 1 > message.name.size())
268 xbt_die("Symbol is too long");
269 strncpy(message.name.data(), name, message.name.size());
270 message.callback = nullptr;
271 message.data = value;
272 if (channel_.send(message))
273 xbt_die("Could send REGISTER_SYMBOL message to model-checker");
276 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
278 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
280 s_stack_region_t region;
281 memset(®ion, 0, sizeof(region));
282 region.address = stack;
283 region.context = context;
285 region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
287 s_mc_message_stack_region_t message;
288 message.type = MessageType::STACK_REGION;
289 message.stack_region = region;
290 if (channel_.send(message))
291 xbt_die("Could not send STACK_REGION to model-checker");
294 } // namespace simgrid