1 /* Copyright (c) 2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #include <system_error>
11 #include <sys/types.h>
13 #include <sys/socket.h>
14 #include <sys/signalfd.h>
18 #include "ModelChecker.hpp"
19 #include "mc_protocol.h"
20 #include "mc_server.h"
21 #include "mc_private.h"
22 #include "mc_ignore.h"
23 #include "mcer_ignore.h"
25 using simgrid::mc::remote;
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_server, mc, "MC server logic");
31 // HArdcoded index for now:
32 #define SOCKET_FD_INDEX 0
33 #define SIGNAL_FD_INDEX 1
35 mc_server_t mc_server;
37 struct mc_symbol_pointer_callback
43 static int mc_symbol_pointer_callback_evaluate(void* p)
45 struct mc_symbol_pointer_callback* callback = (struct mc_symbol_pointer_callback*) p;
47 callback->process->read_bytes(&value, sizeof(value), remote(callback->value));
51 s_mc_server::s_mc_server(pid_t pid, int socket)
54 this->socket = socket;
57 void s_mc_server::start()
59 /* Wait for the target process to initialize and exchange a HELLO messages
60 * before trying to look at its memory map.
62 int res = MC_protocol_hello(socket);
64 throw std::system_error(res, std::system_category());
66 // Block SIGCHLD (this will be handled with accept/signalfd):
69 sigaddset(&set, SIGCHLD);
70 if (sigprocmask(SIG_BLOCK, &set, NULL) == -1)
71 throw std::system_error(errno, std::system_category());
74 sigfillset(&full_set);
76 // Prepare data for poll:
78 struct pollfd* socket_pollfd = &fds[SOCKET_FD_INDEX];
79 socket_pollfd->fd = socket;
80 socket_pollfd->events = POLLIN;
81 socket_pollfd->revents = 0;
83 int signal_fd = signalfd(-1, &set, 0);
85 throw std::system_error(errno, std::system_category());
87 struct pollfd* signalfd_pollfd = &fds[SIGNAL_FD_INDEX];
88 signalfd_pollfd->fd = signal_fd;
89 signalfd_pollfd->events = POLLIN;
90 signalfd_pollfd->revents = 0;
93 void s_mc_server::shutdown()
95 XBT_DEBUG("Shuting down model-checker");
97 mc_process_t process = &mc_model_checker->process();
98 int status = process->status();
99 if (process->running()) {
100 XBT_DEBUG("Killing process");
101 kill(process->pid(), SIGTERM);
102 if (waitpid(process->pid(), &status, 0) == -1)
103 throw std::system_error(errno, std::system_category());
104 // TODO, handle the case when the process does not want to die with a timeout
105 process->terminate(status);
109 void s_mc_server::exit()
112 int status = mc_model_checker->process().status();
113 if (WIFEXITED(status))
114 ::exit(WEXITSTATUS(status));
115 else if (WIFSIGNALED(status)) {
116 // Try to uplicate the signal of the model-checked process.
117 // This is a temporary hack so we don't try too hard.
118 kill(mc_model_checker->process().pid(), WTERMSIG(status));
121 xbt_die("Unexpected status from model-checked process");
125 void s_mc_server::resume(mc_process_t process)
127 int res = process->send_message(MC_MESSAGE_CONTINUE);
129 throw std::system_error(res, std::system_category());
130 process->cache_flags = (mc_process_cache_flags_t) 0;
134 void throw_socket_error(int fd)
137 socklen_t errlen = sizeof(error);
138 if (getsockopt(fd, SOL_SOCKET, SO_ERROR, (void *)&error, &errlen) == -1)
140 throw std::system_error(error, std::system_category());
143 bool s_mc_server::handle_events()
145 char buffer[MC_MESSAGE_LENGTH];
146 struct pollfd* socket_pollfd = &fds[SOCKET_FD_INDEX];
147 struct pollfd* signalfd_pollfd = &fds[SIGNAL_FD_INDEX];
149 while(poll(fds, 2, -1) == -1) {
154 throw std::system_error(errno, std::system_category());
158 if (socket_pollfd->revents) {
159 if (socket_pollfd->revents & POLLIN) {
161 ssize_t size = MC_receive_message(socket_pollfd->fd, buffer, sizeof(buffer), MSG_DONTWAIT);
162 if (size == -1 && errno != EAGAIN)
163 throw std::system_error(errno, std::system_category());
165 s_mc_message_t base_message;
166 if (size < (ssize_t) sizeof(base_message))
167 xbt_die("Broken message");
168 memcpy(&base_message, buffer, sizeof(base_message));
170 switch(base_message.type) {
172 case MC_MESSAGE_IGNORE_HEAP:
174 s_mc_ignore_heap_message_t message;
175 if (size != sizeof(message))
176 xbt_die("Broken messsage");
177 memcpy(&message, buffer, sizeof(message));
178 mc_heap_ignore_region_t region = xbt_new(s_mc_heap_ignore_region_t, 1);
179 *region = message.region;
180 MC_heap_region_ignore_insert(region);
184 case MC_MESSAGE_UNIGNORE_HEAP:
186 s_mc_ignore_memory_message_t message;
187 if (size != sizeof(message))
188 xbt_die("Broken messsage");
189 memcpy(&message, buffer, sizeof(message));
190 MC_heap_region_ignore_remove(message.addr, message.size);
194 case MC_MESSAGE_IGNORE_MEMORY:
196 s_mc_ignore_memory_message_t message;
197 if (size != sizeof(message))
198 xbt_die("Broken messsage");
199 memcpy(&message, buffer, sizeof(message));
200 mc_model_checker->process().ignore_region(
201 (std::uint64_t)message.addr, message.size);
205 case MC_MESSAGE_STACK_REGION:
207 s_mc_stack_region_message_t message;
208 if (size != sizeof(message))
209 xbt_die("Broken messsage");
210 memcpy(&message, buffer, sizeof(message));
211 stack_region_t stack_region = xbt_new(s_stack_region_t, 1);
212 *stack_region = message.stack_region;
213 MC_stack_area_add(stack_region);
217 case MC_MESSAGE_REGISTER_SYMBOL:
219 s_mc_register_symbol_message_t message;
220 if (size != sizeof(message))
221 xbt_die("Broken message");
222 memcpy(&message, buffer, sizeof(message));
223 if (message.callback)
224 xbt_die("Support for callbacks/functions symbols not implemented in client/server mode.");
225 XBT_DEBUG("Received symbol: %s", message.name);
227 struct mc_symbol_pointer_callback* callback = xbt_new(struct mc_symbol_pointer_callback, 1);
228 callback->process = &mc_model_checker->process();
229 callback->value = message.data;
231 MC_automaton_new_propositional_symbol_callback(message.name,
232 mc_symbol_pointer_callback_evaluate, callback, free);
236 case MC_MESSAGE_WAITING:
239 case MC_MESSAGE_ASSERTION_FAILED:
240 MC_report_assertion_error();
245 xbt_die("Unexpected message from model-checked application");
250 if (socket_pollfd->revents & POLLERR) {
251 throw_socket_error(socket_pollfd->fd);
253 if (socket_pollfd->revents & POLLHUP)
254 xbt_die("Socket hang up?");
257 if (signalfd_pollfd->revents) {
258 if (signalfd_pollfd->revents & POLLIN) {
259 this->handle_signals();
262 if (signalfd_pollfd->revents & POLLERR) {
263 throw_socket_error(signalfd_pollfd->fd);
265 if (signalfd_pollfd->revents & POLLHUP)
266 xbt_die("Signalfd hang up?");
272 void s_mc_server::loop()
274 while (mc_model_checker->process().running())
275 this->handle_events();
278 void s_mc_server::handle_signals()
280 struct signalfd_siginfo info;
281 struct pollfd* signalfd_pollfd = &fds[SIGNAL_FD_INDEX];
283 ssize_t size = read(signalfd_pollfd->fd, &info, sizeof(info));
288 throw std::system_error(errno, std::system_category());
289 } else if (size != sizeof(info))
290 return throw std::runtime_error(
291 "Bad communication with model-checked application");
295 this->on_signal(&info);
298 void s_mc_server::handle_waitpid()
300 XBT_DEBUG("Check for wait event");
303 while ((pid = waitpid(-1, &status, WNOHANG)) != 0) {
305 if (errno == ECHILD) {
307 if (mc_model_checker->process().running())
308 xbt_die("Inconsistent state");
312 XBT_ERROR("Could not wait for pid");
313 throw std::system_error(errno, std::system_category());
317 if (pid == mc_model_checker->process().pid()) {
318 if (WIFEXITED(status) || WIFSIGNALED(status)) {
319 XBT_DEBUG("Child process is over");
320 mc_model_checker->process().terminate(status);
326 void s_mc_server::on_signal(const struct signalfd_siginfo* info)
328 switch(info->ssi_signo) {
330 this->handle_waitpid();
337 void MC_server_wait_client(mc_process_t process)
339 mc_server->resume(process);
340 while (mc_model_checker->process().running()) {
341 if (!mc_server->handle_events())
346 void MC_server_simcall_handle(mc_process_t process, unsigned long pid, int value)
348 s_mc_simcall_handle_message m;
349 memset(&m, 0, sizeof(m));
350 m.type = MC_MESSAGE_SIMCALL_HANDLE;
353 mc_model_checker->process().send_message(m);
354 process->cache_flags = (mc_process_cache_flags_t) 0;
355 while (mc_model_checker->process().running()) {
356 if (!mc_server->handle_events())
361 void MC_server_loop(mc_server_t server)