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 <simgrid/modelchecker.h>
15 #include <sys/ptrace.h>
16 #include <sys/socket.h>
17 #include <sys/types.h>
19 // We won't need those once the separation MCer/MCed is complete:
20 #include "src/mc/mc_smx.hpp"
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 instance_->handle_messages();
68 return instance_.get();
71 void AppSide::handle_deadlock_check(const s_mc_message_t*) const
73 bool deadlock = false;
74 if (not simix_global->process_list.empty()) {
76 for (auto const& kv : simix_global->process_list)
77 if (simgrid::mc::actor_is_enabled(kv.second)) {
84 s_mc_message_int_t answer{MessageType::DEADLOCK_CHECK_REPLY, deadlock};
85 xbt_assert(channel_.send(answer) == 0, "Could not send response");
87 void AppSide::handle_continue(const s_mc_message_t*) const
91 void AppSide::handle_simcall(const s_mc_message_simcall_handle_t* message) const
93 kernel::actor::ActorImpl* process = kernel::actor::ActorImpl::by_PID(message->pid);
94 xbt_assert(process != nullptr, "Invalid pid %lu", message->pid);
95 process->simcall_handle(message->value);
96 if (channel_.send(MessageType::WAITING))
97 xbt_die("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
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);
130 handle_continue(message);
133 case MessageType::SIMCALL_HANDLE:
134 assert_msg_size("SIMCALL_HANDLE", s_mc_message_simcall_handle_t);
135 handle_simcall((s_mc_message_simcall_handle_t*)message_buffer.data());
138 case MessageType::ACTOR_ENABLED:
139 assert_msg_size("ACTOR_ENABLED", s_mc_message_actor_enabled_t);
140 handle_actor_enabled((s_mc_message_actor_enabled_t*)message_buffer.data());
144 xbt_die("Received unexpected message %s (%i)", to_c_str(message->type), static_cast<int>(message->type));
150 void AppSide::main_loop() const
153 simgrid::mc::wait_for_requests();
154 xbt_assert(channel_.send(MessageType::WAITING) == 0, "Could not send WAITING message to model-checker");
155 this->handle_messages();
159 void AppSide::report_assertion_failure() const
161 if (channel_.send(MessageType::ASSERTION_FAILED))
162 xbt_die("Could not send assertion to model-checker");
163 this->handle_messages();
166 void AppSide::ignore_memory(void* addr, std::size_t size) const
168 s_mc_message_ignore_memory_t message;
169 message.type = MessageType::IGNORE_MEMORY;
170 message.addr = (std::uintptr_t)addr;
172 if (channel_.send(message))
173 xbt_die("Could not send IGNORE_MEMORY message to model-checker");
176 void AppSide::ignore_heap(void* address, std::size_t size) const
178 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
180 s_mc_message_ignore_heap_t message;
181 message.type = MessageType::IGNORE_HEAP;
182 message.address = address;
184 message.block = ((char*)address - (char*)heap->heapbase) / BLOCKSIZE + 1;
185 if (heap->heapinfo[message.block].type == 0) {
186 message.fragment = -1;
187 heap->heapinfo[message.block].busy_block.ignore++;
189 message.fragment = (ADDR2UINT(address) % BLOCKSIZE) >> heap->heapinfo[message.block].type;
190 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
193 if (channel_.send(message))
194 xbt_die("Could not send ignored region to MCer");
197 void AppSide::unignore_heap(void* address, std::size_t size) const
199 s_mc_message_ignore_memory_t message;
200 message.type = MessageType::UNIGNORE_HEAP;
201 message.addr = (std::uintptr_t)address;
203 if (channel_.send(message))
204 xbt_die("Could not send IGNORE_HEAP message to model-checker");
207 void AppSide::declare_symbol(const char* name, int* value) const
209 s_mc_message_register_symbol_t message;
210 message.type = MessageType::REGISTER_SYMBOL;
211 if (strlen(name) + 1 > message.name.size())
212 xbt_die("Symbol is too long");
213 strncpy(message.name.data(), name, message.name.size());
214 message.callback = nullptr;
215 message.data = value;
216 if (channel_.send(message))
217 xbt_die("Could send REGISTER_SYMBOL message to model-checker");
220 void AppSide::declare_stack(void* stack, size_t size, ucontext_t* context) const
222 const s_xbt_mheap_t* heap = mmalloc_get_current_heap();
224 s_stack_region_t region;
225 memset(®ion, 0, sizeof(region));
226 region.address = stack;
227 region.context = context;
229 region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
231 s_mc_message_stack_region_t message;
232 message.type = MessageType::STACK_REGION;
233 message.stack_region = region;
234 if (channel_.send(message))
235 xbt_die("Could not send STACK_REGION to model-checker");
238 } // namespace simgrid