Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Move heap_ignore to Process
[simgrid.git] / src / mc / ModelChecker.cpp
1 /* Copyright (c) 2008-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include <cassert>
8
9 #include <poll.h>
10 #include <sys/types.h>
11 #include <sys/wait.h>
12 #include <sys/socket.h>
13 #include <sys/signalfd.h>
14 #include <sys/ptrace.h>
15
16 #include <memory>
17 #include <system_error>
18
19 #include <xbt/log.h>
20 #include <xbt/automaton.h>
21 #include <xbt/automaton.hpp>
22
23 #include "simgrid/sg_config.h"
24
25 #include "ModelChecker.hpp"
26 #include "PageStore.hpp"
27 #include "ModelChecker.hpp"
28 #include "mc_protocol.h"
29 #include "mc_private.h"
30 #include "mc_ignore.h"
31 #include "mc_exit.h"
32 #include "src/mc/mc_liveness.h"
33
34 extern "C" {
35
36 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_ModelChecker, mc, "ModelChecker");
37
38 }
39
40 ::simgrid::mc::ModelChecker* mc_model_checker = nullptr;
41
42 using simgrid::mc::remote;
43
44 // Hardcoded index for now:
45 #define SOCKET_FD_INDEX 0
46 #define SIGNAL_FD_INDEX 1
47
48 namespace simgrid {
49 namespace mc {
50
51 ModelChecker::ModelChecker(pid_t pid, int socket) :
52   pid_(pid), socket_(socket),
53   hostnames_(xbt_dict_new()),
54   page_store_(500),
55   parent_snapshot_(nullptr)
56 {
57 }
58
59 ModelChecker::~ModelChecker()
60 {
61   xbt_dict_free(&this->hostnames_);
62 }
63
64 const char* ModelChecker::get_host_name(const char* hostname)
65 {
66   // Lookup the host name in the dictionary (or create it):
67   xbt_dictelm_t elt = xbt_dict_get_elm_or_null(this->hostnames_, hostname);
68   if (!elt) {
69     xbt_dict_set(this->hostnames_, hostname, nullptr, nullptr);
70     elt = xbt_dict_get_elm_or_null(this->hostnames_, hostname);
71     assert(elt);
72   }
73   return elt->key;
74 }
75
76 void ModelChecker::start()
77 {
78   // Block SIGCHLD (this will be handled with accept/signalfd):
79   sigset_t set;
80   sigemptyset(&set);
81   sigaddset(&set, SIGCHLD);
82   if (sigprocmask(SIG_BLOCK, &set, nullptr) == -1)
83     throw std::system_error(errno, std::system_category());
84
85   sigset_t full_set;
86   sigfillset(&full_set);
87
88   // Prepare data for poll:
89
90   struct pollfd* socket_pollfd = &fds_[SOCKET_FD_INDEX];
91   socket_pollfd->fd = socket_;
92   socket_pollfd->events = POLLIN;
93   socket_pollfd->revents = 0;
94
95   int signal_fd = signalfd(-1, &set, 0);
96   if (signal_fd == -1)
97     throw std::system_error(errno, std::system_category());
98
99   struct pollfd* signalfd_pollfd = &fds_[SIGNAL_FD_INDEX];
100   signalfd_pollfd->fd = signal_fd;
101   signalfd_pollfd->events = POLLIN;
102   signalfd_pollfd->revents = 0;
103
104   XBT_DEBUG("Waiting for the model-checked process");
105   int status;
106
107   // The model-checked process SIGSTOP itself to signal it's ready:
108   pid_t res = waitpid(pid_, &status, __WALL);
109   if (res < 0 || !WIFSTOPPED(status) || WSTOPSIG(status) != SIGSTOP)
110     xbt_die("Could not wait model-checked process");
111
112   assert(process_ == nullptr);
113   process_ = std::unique_ptr<Process>(new Process(pid_, socket_));
114   // TODO, avoid direct dependency on sg_cfg
115   process_->privatized(sg_cfg_get_boolean("smpi/privatize_global_variables"));
116
117   /* Initialize statistics */
118   mc_stats = xbt_new0(s_mc_stats_t, 1);
119   mc_stats->state_size = 1;
120
121   if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0'))
122     MC_init_dot_output();
123
124   /* Init parmap */
125   //parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
126
127   setup_ignore();
128
129   ptrace(PTRACE_SETOPTIONS, pid_, nullptr, PTRACE_O_TRACEEXIT);
130   ptrace(PTRACE_CONT, pid_, 0, 0);
131 }
132
133 void ModelChecker::setup_ignore()
134 {
135   /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
136   MC_ignore_local_variable("e", "*");
137   MC_ignore_local_variable("__ex_cleanup", "*");
138   MC_ignore_local_variable("__ex_mctx_en", "*");
139   MC_ignore_local_variable("__ex_mctx_me", "*");
140   MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
141   MC_ignore_local_variable("_log_ev", "*");
142   MC_ignore_local_variable("_throw_ctx", "*");
143   MC_ignore_local_variable("ctx", "*");
144
145   MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
146   MC_ignore_local_variable("next_cont"
147     "ext", "smx_ctx_sysv_suspend_serial");
148   MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
149
150   /* Ignore local variable about time used for tracing */
151   MC_ignore_local_variable("start_time", "*");
152
153   /* Static variable used for tracing */
154   this->process().ignore_global_variable("counter");
155
156   /* SIMIX */
157   this->process().ignore_global_variable("smx_total_comms");
158 }
159
160 void ModelChecker::shutdown()
161 {
162   XBT_DEBUG("Shuting down model-checker");
163
164   simgrid::mc::Process* process = &this->process();
165   if (process->running()) {
166     XBT_DEBUG("Killing process");
167     kill(process->pid(), SIGTERM);
168     process->terminate();
169   }
170 }
171
172 void ModelChecker::resume(simgrid::mc::Process& process)
173 {
174   int res = process.send_message(MC_MESSAGE_CONTINUE);
175   if (res)
176     throw std::system_error(res, std::system_category());
177   process.cache_flags = (mc_process_cache_flags_t) 0;
178 }
179
180 static
181 void throw_socket_error(int fd)
182 {
183   int error = 0;
184   socklen_t errlen = sizeof(error);
185   if (getsockopt(fd, SOL_SOCKET, SO_ERROR, (void *)&error, &errlen) == -1)
186     error = errno;
187   throw std::system_error(error, std::system_category());
188 }
189
190 bool ModelChecker::handle_message(char* buffer, ssize_t size)
191 {
192   s_mc_message_t base_message;
193   if (size < (ssize_t) sizeof(base_message))
194     xbt_die("Broken message");
195   memcpy(&base_message, buffer, sizeof(base_message));
196
197   switch(base_message.type) {
198
199   case MC_MESSAGE_IGNORE_HEAP:
200     {
201       s_mc_ignore_heap_message_t message;
202       if (size != sizeof(message))
203         xbt_die("Broken messsage");
204       memcpy(&message, buffer, sizeof(message));
205
206       IgnoredHeapRegion region;
207       region.block = message.block;
208       region.fragment = message.fragment;
209       region.address = message.address;
210       region.size = message.size;
211       process().ignore_heap(region);
212       break;
213     }
214
215   case MC_MESSAGE_UNIGNORE_HEAP:
216     {
217       s_mc_ignore_memory_message_t message;
218       if (size != sizeof(message))
219         xbt_die("Broken messsage");
220       memcpy(&message, buffer, sizeof(message));
221       process().unignore_heap(
222         (void *)(std::uintptr_t) message.addr, message.size);
223       break;
224     }
225
226   case MC_MESSAGE_IGNORE_MEMORY:
227     {
228       s_mc_ignore_memory_message_t message;
229       if (size != sizeof(message))
230         xbt_die("Broken messsage");
231       memcpy(&message, buffer, sizeof(message));
232       this->process().ignore_region(message.addr, message.size);
233       break;
234     }
235
236   case MC_MESSAGE_STACK_REGION:
237     {
238       s_mc_stack_region_message_t message;
239       if (size != sizeof(message))
240         xbt_die("Broken messsage");
241       memcpy(&message, buffer, sizeof(message));
242       this->process().stack_areas().push_back(message.stack_region);
243     }
244     break;
245
246   case MC_MESSAGE_REGISTER_SYMBOL:
247     {
248       s_mc_register_symbol_message_t message;
249       if (size != sizeof(message))
250         xbt_die("Broken message");
251       memcpy(&message, buffer, sizeof(message));
252       if (message.callback)
253         xbt_die("Support for client-side function proposition is not implemented.");
254       XBT_DEBUG("Received symbol: %s", message.name);
255
256       if (_mc_property_automaton == nullptr)
257         _mc_property_automaton = xbt_automaton_new();
258
259       simgrid::mc::Process* process = &this->process();
260       simgrid::mc::remote_ptr<int> address
261         = simgrid::mc::remote((int*) message.data);
262       simgrid::xbt::add_proposition(_mc_property_automaton,
263         message.name,
264         [process, address]() { return process->read(address); }
265         );
266
267       break;
268     }
269
270   case MC_MESSAGE_WAITING:
271     return false;
272
273   case MC_MESSAGE_ASSERTION_FAILED:
274     MC_report_assertion_error();
275     ::exit(SIMGRID_MC_EXIT_SAFETY);
276     break;
277
278   default:
279     xbt_die("Unexpected message from model-checked application");
280
281   }
282   return true;
283 }
284
285 bool ModelChecker::handle_events()
286 {
287   char buffer[MC_MESSAGE_LENGTH];
288   struct pollfd* socket_pollfd = &fds_[SOCKET_FD_INDEX];
289   struct pollfd* signalfd_pollfd = &fds_[SIGNAL_FD_INDEX];
290
291   while(poll(fds_, 2, -1) == -1) {
292     switch(errno) {
293     case EINTR:
294       continue;
295     default:
296       throw std::system_error(errno, std::system_category());
297     }
298   }
299
300   if (socket_pollfd->revents) {
301     if (socket_pollfd->revents & POLLIN) {
302       ssize_t size = MC_receive_message(socket_pollfd->fd, buffer, sizeof(buffer), MSG_DONTWAIT);
303       if (size == -1 && errno != EAGAIN)
304         throw std::system_error(errno, std::system_category());
305       return handle_message(buffer, size);
306     }
307     if (socket_pollfd->revents & POLLERR) {
308       throw_socket_error(socket_pollfd->fd);
309     }
310     if (socket_pollfd->revents & POLLHUP)
311       xbt_die("Socket hang up?");
312   }
313
314   if (signalfd_pollfd->revents) {
315     if (signalfd_pollfd->revents & POLLIN) {
316       this->handle_signals();
317       return true;
318     }
319     if (signalfd_pollfd->revents & POLLERR) {
320       throw_socket_error(signalfd_pollfd->fd);
321     }
322     if (signalfd_pollfd->revents & POLLHUP)
323       xbt_die("Signalfd hang up?");
324   }
325
326   return true;
327 }
328
329 void ModelChecker::loop()
330 {
331   while (this->process().running())
332     this->handle_events();
333 }
334
335 void ModelChecker::handle_signals()
336 {
337   struct signalfd_siginfo info;
338   struct pollfd* signalfd_pollfd = &fds_[SIGNAL_FD_INDEX];
339   while (1) {
340     ssize_t size = read(signalfd_pollfd->fd, &info, sizeof(info));
341     if (size == -1) {
342       if (errno == EINTR)
343         continue;
344       else
345         throw std::system_error(errno, std::system_category());
346     } else if (size != sizeof(info))
347         return throw std::runtime_error(
348           "Bad communication with model-checked application");
349     else
350       break;
351   }
352   this->on_signal(&info);
353 }
354
355 void ModelChecker::handle_waitpid()
356 {
357   XBT_DEBUG("Check for wait event");
358   int status;
359   pid_t pid;
360   while ((pid = waitpid(-1, &status, WNOHANG)) != 0) {
361     if (pid == -1) {
362       if (errno == ECHILD) {
363         // No more children:
364         if (this->process().running())
365           xbt_die("Inconsistent state");
366         else
367           break;
368       } else {
369         XBT_ERROR("Could not wait for pid");
370         throw std::system_error(errno, std::system_category());
371       }
372     }
373
374     if (pid == this->process().pid()) {
375
376       // From PTRACE_O_TRACEEXIT:
377       if (status>>8 == (SIGTRAP | (PTRACE_EVENT_EXIT<<8))) {
378         if (ptrace(PTRACE_GETEVENTMSG, pid_, 0, &status) == -1)
379           xbt_die("Could not get exit status");
380         if (WIFSIGNALED(status)) {
381           MC_report_crash(status);
382           ::exit(SIMGRID_MC_EXIT_PROGRAM_CRASH);
383         }
384       }
385
386       // We don't care about signals, just reinject them:
387       if (WIFSTOPPED(status)) {
388         XBT_DEBUG("Stopped with signal %i", (int) WSTOPSIG(status));
389         if (ptrace(PTRACE_CONT, pid_, 0, WSTOPSIG(status)) == -1)
390           xbt_die("Could not PTRACE_CONT");
391       }
392
393       else if (WIFEXITED(status) || WIFSIGNALED(status)) {
394         XBT_DEBUG("Child process is over");
395         this->process().terminate();
396       }
397     }
398   }
399 }
400
401 void ModelChecker::on_signal(const struct signalfd_siginfo* info)
402 {
403   switch(info->ssi_signo) {
404   case SIGCHLD:
405     this->handle_waitpid();
406     break;
407   default:
408     break;
409   }
410 }
411
412 void ModelChecker::wait_client(simgrid::mc::Process& process)
413 {
414   this->resume(process);
415   while (this->process().running()) {
416     if (!this->handle_events())
417       return;
418   }
419 }
420
421 void ModelChecker::simcall_handle(simgrid::mc::Process& process, unsigned long pid, int value)
422 {
423   s_mc_simcall_handle_message m;
424   memset(&m, 0, sizeof(m));
425   m.type  = MC_MESSAGE_SIMCALL_HANDLE;
426   m.pid   = pid;
427   m.value = value;
428   process.send_message(m);
429   process.cache_flags = (mc_process_cache_flags_t) 0;
430   while (process.running()) {
431     if (!this->handle_events())
432       return;
433   }
434 }
435
436 }
437 }