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 int send_res = instance_->channel_.send(message);
71 xbt_assert(send_res == 0, "Could not send the initial message with addresses.");
73 instance_->handle_messages();
74 return instance_.get();
77 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
79 bool deadlock = false;
80 if (not simix_global->process_list.empty()) {
82 for (auto const& kv : simix_global->process_list)
83 if (simgrid::mc::actor_is_enabled(kv.second)) {
90 s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
91 int send_res = channel_.send(answer);
92 xbt_assert(send_res == 0, "Could not send response");
94 void AppSide::handle_simcall_execute(const s_mc_message_simcall_handle_t* message) const
96 kernel::actor::ActorImpl* process = kernel::actor::ActorImpl::by_pid(message->aid_);
97 xbt_assert(process != nullptr, "Invalid pid %lu", message->aid_);
98 process->simcall_handle(message->times_considered_);
99 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send MESSAGE_WAITING to model-checker");
102 void AppSide::handle_actor_enabled(const s_mc_message_actor_enabled_t* msg) const
104 bool res = simgrid::mc::actor_is_enabled(kernel::actor::ActorImpl::by_pid(msg->aid));
105 s_mc_message_int_t answer{MessageType::ACTOR_ENABLED_REPLY, res};
106 channel_.send(answer);
109 #define assert_msg_size(_name_, _type_) \
110 xbt_assert(received_size == sizeof(_type_), "Unexpected size for " _name_ " (%zd != %zu)", received_size, \
113 void AppSide::handle_messages() const
115 while (true) { // Until we get a CONTINUE message
116 XBT_DEBUG("Waiting messages from model-checker");
118 std::array<char, MC_MESSAGE_LENGTH> message_buffer;
119 ssize_t received_size = channel_.receive(message_buffer.data(), message_buffer.size());
121 xbt_assert(received_size >= 0, "Could not receive commands from the model-checker");
123 const s_mc_message_t* message = (s_mc_message_t*)message_buffer.data();
124 switch (message->type) {
125 case MessageType::DEADLOCK_CHECK:
126 assert_msg_size("DEADLOCK_CHECK", s_mc_message_t);
127 handle_deadlock_check(message);
130 case MessageType::CONTINUE:
131 assert_msg_size("MESSAGE_CONTINUE", s_mc_message_t);
134 case MessageType::SIMCALL_HANDLE:
135 assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t);
136 handle_simcall_execute((s_mc_message_simcall_handle_t*)message_buffer.data());
139 case MessageType::SIMCALL_IS_VISIBLE: {
140 assert_msg_size("SIMCALL_IS_VISIBLE", s_mc_message_simcall_is_visible_t);
141 auto msg_simcall = (s_mc_message_simcall_is_visible_t*)message_buffer.data();
142 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
143 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
144 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
145 bool value = actor->simcall_.observer_->is_visible();
148 s_mc_message_simcall_is_visible_answer_t answer{MessageType::SIMCALL_IS_VISIBLE_ANSWER, value};
149 int send_res = channel_.send(answer);
150 xbt_assert(send_res == 0, "Could not send response");
154 case MessageType::SIMCALL_TO_STRING: {
155 assert_msg_size("SIMCALL_TO_STRING", s_mc_message_simcall_to_string_t);
156 auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
157 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
158 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
159 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
160 std::string value = actor->simcall_.observer_->to_string(msg_simcall->time_considered);
163 s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
164 value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
165 int send_res = channel_.send(answer);
166 xbt_assert(send_res == 0, "Could not send response");
170 case MessageType::SIMCALL_DOT_LABEL: {
171 assert_msg_size("SIMCALL_DOT_LABEL", s_mc_message_simcall_to_string_t);
172 auto msg_simcall = (s_mc_message_simcall_to_string_t*)message_buffer.data();
173 const kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(msg_simcall->aid);
174 xbt_assert(actor != nullptr, "Invalid pid %d", msg_simcall->aid);
175 xbt_assert(actor->simcall_.observer_, "The transition of %s has no observer", actor->get_cname());
176 std::string value = actor->simcall_.observer_->dot_label();
179 s_mc_message_simcall_to_string_answer_t answer{MessageType::SIMCALL_TO_STRING_ANSWER, {0}};
180 value.copy(answer.value, (sizeof answer.value) - 1); // last byte was set to '\0' by initialization above
181 int send_res = channel_.send(answer);
182 xbt_assert(send_res == 0, "Could not send response");
186 case MessageType::ACTOR_ENABLED:
187 assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
188 handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
191 case MessageType::FINALIZE: {
192 assert_msg_size("FINALIZE", s_mc_message_int_t);
193 bool terminate_asap = ((s_mc_message_int_t*)message_buffer.data())->value;
194 XBT_DEBUG("Finalize (terminate = %d)", (int)terminate_asap);
195 if (not terminate_asap) {
196 if (XBT_LOG_ISENABLED(mc_client, xbt_log_priority_debug))
197 simix_global->display_all_actor_status();
199 XBT_DEBUG("Smpi_enabled: %d", (int)smpi_enabled());
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 xbt_assert(channel_.send(MessageType::ASSERTION_FAILED) == 0, "Could not send assertion to model-checker");
233 this->handle_messages();
236 void AppSide::ignore_memory(void* addr, std::size_t size) const
238 s_mc_message_ignore_memory_t message;
239 message.type = MessageType::IGNORE_MEMORY;
240 message.addr = (std::uintptr_t)addr;
242 xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_MEMORY message to model-checker");
245 void AppSide::ignore_heap(void* address, std::size_t size) const
247 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
249 s_mc_message_ignore_heap_t message;
250 message.type = MessageType::IGNORE_HEAP;
251 message.address = address;
253 message.block = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
254 if (heap->heapinfo[message.block].type == 0) {
255 message.fragment = -1;
256 heap->heapinfo[message.block].busy_block.ignore++;
258 message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
259 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
262 xbt_assert(channel_.send(message) == 0, "Could not send ignored region to MCer");
265 void AppSide::unignore_heap(void* address, std::size_t size) const
267 s_mc_message_ignore_memory_t message;
268 message.type = MessageType::UNIGNORE_HEAP;
269 message.addr = (std::uintptr_t)address;
271 xbt_assert(channel_.send(message) == 0, "Could not send IGNORE_HEAP message to model-checker");
274 void AppSide::declare_symbol(const char* name, int* value) const
276 s_mc_message_register_symbol_t message;
277 message.type = MessageType::REGISTER_SYMBOL;
278 xbt_assert(strlen(name) + 1 <= message.name.size(), "Symbol is too long");
279 strncpy(message.name.data(), name, message.name.size());
280 message.callback = nullptr;
281 message.data = value;
282 xbt_assert(channel_.send(message) == 0, "Could send REGISTER_SYMBOL message to model-checker");
285 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
287 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
289 s_stack_region_t region;
290 memset(®ion, 0, sizeof(region));
291 region.address = stack;
292 region.context = context;
294 region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
296 s_mc_message_stack_region_t message;
297 message.type = MessageType::STACK_REGION;
298 message.stack_region = region;
299 xbt_assert(channel_.send(message) == 0, "Could not send STACK_REGION to model-checker");
302 } // namespace simgrid