Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
2d6a04b526b53fdf16496d1211ea64936972a32a
[simgrid.git] / src / mc / ModelChecker.cpp
1 /* Copyright (c) 2008-2019. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include <cassert>
7
8 #include <sys/types.h>
9 #include <sys/wait.h>
10 #include <sys/socket.h>
11 #include <sys/ptrace.h>
12
13 #include <memory>
14 #include <system_error>
15
16 #include "xbt/automaton.h"
17 #include "xbt/automaton.hpp"
18 #include "xbt/log.h"
19 #include "xbt/system_error.hpp"
20
21 #include "simgrid/sg_config.hpp"
22
23 #include "src/mc/ModelChecker.hpp"
24 #include "src/mc/Transition.hpp"
25 #include "src/mc/checker/Checker.hpp"
26 #include "src/mc/mc_exit.hpp"
27 #include "src/mc/mc_private.hpp"
28 #include "src/mc/mc_record.hpp"
29 #include "src/mc/remote/RemoteClient.hpp"
30 #include "src/mc/remote/mc_protocol.h"
31 #include "src/mc/sosp/PageStore.hpp"
32
33 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_ModelChecker, mc, "ModelChecker");
34
35 ::simgrid::mc::ModelChecker* mc_model_checker = nullptr;
36
37 using simgrid::mc::remote;
38
39 #ifdef __linux__
40 # define WAITPID_CHECKED_FLAGS __WALL
41 #else
42 # define WAITPID_CHECKED_FLAGS 0
43 #endif
44
45 namespace simgrid {
46 namespace mc {
47
48 ModelChecker::ModelChecker(std::unique_ptr<RemoteClient> process)
49     : base_(nullptr)
50     , socket_event_(nullptr)
51     , signal_event_(nullptr)
52     , page_store_(500)
53     , process_(std::move(process))
54     , parent_snapshot_(nullptr)
55 {
56
57 }
58
59 ModelChecker::~ModelChecker() {
60   if (socket_event_ != nullptr)
61     event_free(socket_event_);
62   if (signal_event_ != nullptr)
63     event_free(signal_event_);
64   if (base_ != nullptr)
65     event_base_free(base_);
66 }
67
68 void ModelChecker::start()
69 {
70   const pid_t pid = process_->pid();
71
72   base_ = event_base_new();
73   event_callback_fn event_callback = [](evutil_socket_t fd, short events, void *arg)
74   {
75     ((ModelChecker *)arg)->handle_events(fd, events);
76   };
77   socket_event_ = event_new(base_,
78                             process_->getChannel().getSocket(),
79                             EV_READ|EV_PERSIST,
80                             event_callback, this);
81   event_add(socket_event_, NULL);
82   signal_event_ = event_new(base_,
83                             SIGCHLD,
84                             EV_SIGNAL|EV_PERSIST,
85                             event_callback, this);
86   event_add(signal_event_, NULL);
87
88   XBT_DEBUG("Waiting for the model-checked process");
89   int status;
90
91   // The model-checked process SIGSTOP itself to signal it's ready:
92   pid_t res = waitpid(pid, &status, WAITPID_CHECKED_FLAGS);
93   if (res < 0 || not WIFSTOPPED(status) || WSTOPSIG(status) != SIGSTOP)
94     xbt_die("Could not wait model-checked process");
95
96   process_->init();
97
98   if (not _sg_mc_dot_output_file.get().empty())
99     MC_init_dot_output();
100
101   setup_ignore();
102
103 #ifdef __linux__
104   ptrace(PTRACE_SETOPTIONS, pid, nullptr, PTRACE_O_TRACEEXIT);
105   ptrace(PTRACE_CONT, pid, 0, 0);
106 #elif defined BSD
107   ptrace(PT_CONTINUE, pid, (caddr_t)1, 0);
108 #else
109 # error "no ptrace equivalent coded for this platform"
110 #endif
111 }
112
113 static const std::pair<const char*, const char*> ignored_local_variables[] = {
114   std::pair<const char*, const char*>{  "e", "*" },
115   std::pair<const char*, const char*>{ "_log_ev", "*" },
116
117   /* Ignore local variable about time used for tracing */
118   std::pair<const char*, const char*>{ "start_time", "*" },
119 };
120
121 void ModelChecker::setup_ignore()
122 {
123   RemoteClient& process = this->process();
124   for (std::pair<const char*, const char*> const& var :
125       ignored_local_variables)
126     process.ignore_local_variable(var.first, var.second);
127
128   /* Static variable used for tracing */
129   process.ignore_global_variable("counter");
130 }
131
132 void ModelChecker::shutdown()
133 {
134   XBT_DEBUG("Shuting down model-checker");
135
136   simgrid::mc::RemoteClient* process = &this->process();
137   if (process->running()) {
138     XBT_DEBUG("Killing process");
139     kill(process->pid(), SIGKILL);
140     process->terminate();
141   }
142 }
143
144 void ModelChecker::resume(simgrid::mc::RemoteClient& process)
145 {
146   int res = process.getChannel().send(MC_MESSAGE_CONTINUE);
147   if (res)
148     throw simgrid::xbt::errno_error();
149   process.clear_cache();
150 }
151
152 static void MC_report_crash(int status)
153 {
154   XBT_INFO("**************************");
155   XBT_INFO("** CRASH IN THE PROGRAM **");
156   XBT_INFO("**************************");
157   if (WIFSIGNALED(status))
158     XBT_INFO("From signal: %s", strsignal(WTERMSIG(status)));
159   else if (WIFEXITED(status))
160     XBT_INFO("From exit: %i", WEXITSTATUS(status));
161   if (WCOREDUMP(status))
162     XBT_INFO("A core dump was generated by the system.");
163   else
164     XBT_INFO("No core dump was generated by the system.");
165   XBT_INFO("Counter-example execution trace:");
166   simgrid::mc::dumpRecordPath();
167   for (auto const& s : mc_model_checker->getChecker()->getTextualTrace())
168     XBT_INFO("%s", s.c_str());
169   simgrid::mc::session->logState();
170   XBT_INFO("Stack trace:");
171   mc_model_checker->process().dumpStack();
172 }
173
174 static void MC_report_assertion_error()
175 {
176   XBT_INFO("**************************");
177   XBT_INFO("*** PROPERTY NOT VALID ***");
178   XBT_INFO("**************************");
179   XBT_INFO("Counter-example execution trace:");
180   simgrid::mc::dumpRecordPath();
181   for (auto const& s : mc_model_checker->getChecker()->getTextualTrace())
182     XBT_INFO("%s", s.c_str());
183   simgrid::mc::session->logState();
184 }
185
186 bool ModelChecker::handle_message(char* buffer, ssize_t size)
187 {
188   s_mc_message_t base_message;
189   if (size < (ssize_t) sizeof(base_message))
190     xbt_die("Broken message");
191   memcpy(&base_message, buffer, sizeof(base_message));
192
193   switch(base_message.type) {
194
195   case MC_MESSAGE_IGNORE_HEAP:
196     {
197     s_mc_message_ignore_heap_t message;
198     if (size != sizeof(message))
199       xbt_die("Broken messsage");
200     memcpy(&message, buffer, sizeof(message));
201
202     IgnoredHeapRegion region;
203     region.block    = message.block;
204     region.fragment = message.fragment;
205     region.address  = message.address;
206     region.size     = message.size;
207     process().ignore_heap(region);
208     break;
209     }
210
211   case MC_MESSAGE_UNIGNORE_HEAP:
212     {
213     s_mc_message_ignore_memory_t message;
214     if (size != sizeof(message))
215       xbt_die("Broken messsage");
216     memcpy(&message, buffer, sizeof(message));
217     process().unignore_heap((void*)(std::uintptr_t)message.addr, message.size);
218     break;
219     }
220
221   case MC_MESSAGE_IGNORE_MEMORY:
222     {
223     s_mc_message_ignore_memory_t message;
224     if (size != sizeof(message))
225       xbt_die("Broken messsage");
226     memcpy(&message, buffer, sizeof(message));
227     this->process().ignore_region(message.addr, message.size);
228     break;
229     }
230
231   case MC_MESSAGE_STACK_REGION:
232     {
233     s_mc_message_stack_region_t message;
234     if (size != sizeof(message))
235       xbt_die("Broken messsage");
236     memcpy(&message, buffer, sizeof(message));
237     this->process().stack_areas().push_back(message.stack_region);
238     }
239     break;
240
241   case MC_MESSAGE_REGISTER_SYMBOL:
242     {
243     s_mc_message_register_symbol_t message;
244     if (size != sizeof(message))
245       xbt_die("Broken message");
246     memcpy(&message, buffer, sizeof(message));
247     if (message.callback)
248       xbt_die("Support for client-side function proposition is not implemented.");
249     XBT_DEBUG("Received symbol: %s", message.name);
250
251     if (simgrid::mc::property_automaton == nullptr)
252       simgrid::mc::property_automaton = xbt_automaton_new();
253
254     simgrid::mc::RemoteClient* process  = &this->process();
255     simgrid::mc::RemotePtr<int> address = simgrid::mc::remote((int*)message.data);
256     simgrid::xbt::add_proposition(simgrid::mc::property_automaton, message.name,
257                                   [process, address]() { return process->read(address); });
258
259     break;
260     }
261
262   case MC_MESSAGE_WAITING:
263     return false;
264
265   case MC_MESSAGE_ASSERTION_FAILED:
266     MC_report_assertion_error();
267     this->exit(SIMGRID_MC_EXIT_SAFETY);
268
269   default:
270     xbt_die("Unexpected message from model-checked application");
271
272   }
273   return true;
274 }
275
276 /** Terminate the model-checker application */
277 void ModelChecker::exit(int status)
278 {
279   // TODO, terminate the model checker politely instead of exiting rudely
280   if (process().running())
281     kill(process().pid(), SIGKILL);
282   ::exit(status);
283 }
284
285 void ModelChecker::handle_events(int fd, short events)
286 {
287   if (events == EV_READ) {
288     char buffer[MC_MESSAGE_LENGTH];
289     ssize_t size = process_->getChannel().receive(buffer, sizeof(buffer), false);
290     if (size == -1 && errno != EAGAIN)
291       throw simgrid::xbt::errno_error();
292     if (not handle_message(buffer, size)) {
293       event_base_loopbreak(base_);
294     }
295   }
296   else if (events == EV_SIGNAL) {
297     on_signal(fd);
298   }
299   else {
300     xbt_die("Unexpected event");
301   }
302 }
303
304 void ModelChecker::loop()
305 {
306   if (this->process().running())
307     event_base_dispatch(base_);
308 }
309
310 void ModelChecker::handle_waitpid()
311 {
312   XBT_DEBUG("Check for wait event");
313   int status;
314   pid_t pid;
315   while ((pid = waitpid(-1, &status, WNOHANG)) != 0) {
316     if (pid == -1) {
317       if (errno == ECHILD) {
318         // No more children:
319         if (this->process().running())
320           xbt_die("Inconsistent state");
321         else
322           break;
323       } else {
324         XBT_ERROR("Could not wait for pid");
325         throw simgrid::xbt::errno_error();
326       }
327     }
328
329     if (pid == this->process().pid()) {
330
331       // From PTRACE_O_TRACEEXIT:
332 #ifdef __linux__
333       if (status>>8 == (SIGTRAP | (PTRACE_EVENT_EXIT<<8))) {
334         if (ptrace(PTRACE_GETEVENTMSG, this->process().pid(), 0, &status) == -1)
335           xbt_die("Could not get exit status");
336         if (WIFSIGNALED(status)) {
337           MC_report_crash(status);
338           mc_model_checker->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH);
339         }
340       }
341 #endif
342
343       // We don't care about signals, just reinject them:
344       if (WIFSTOPPED(status)) {
345         XBT_DEBUG("Stopped with signal %i", (int) WSTOPSIG(status));
346         errno = 0;
347 #ifdef __linux__
348         ptrace(PTRACE_CONT, this->process().pid(), 0, WSTOPSIG(status));
349 #elif defined BSD
350         ptrace(PT_CONTINUE, this->process().pid(), (caddr_t)1, WSTOPSIG(status));
351 #endif
352         if (errno != 0)
353           xbt_die("Could not PTRACE_CONT");
354       }
355
356       else if (WIFEXITED(status) || WIFSIGNALED(status)) {
357         XBT_DEBUG("Child process is over");
358         this->process().terminate();
359       }
360     }
361   }
362 }
363
364 void ModelChecker::on_signal(int signo)
365 {
366   if (signo == SIGCHLD)
367     this->handle_waitpid();
368 }
369
370 void ModelChecker::wait_for_requests()
371 {
372   this->resume(process());
373   if (this->process().running())
374     event_base_dispatch(base_);
375 }
376
377 void ModelChecker::handle_simcall(Transition const& transition)
378 {
379   s_mc_message_simcall_handle_t m;
380   memset(&m, 0, sizeof(m));
381   m.type  = MC_MESSAGE_SIMCALL_HANDLE;
382   m.pid   = transition.pid;
383   m.value = transition.argument;
384   this->process_->getChannel().send(m);
385   this->process_->clear_cache();
386   if (this->process_->running())
387     event_base_dispatch(base_);
388 }
389
390 bool ModelChecker::checkDeadlock()
391 {
392   int res;
393   if ((res = this->process().getChannel().send(MC_MESSAGE_DEADLOCK_CHECK)))
394     xbt_die("Could not check deadlock state");
395   s_mc_message_int_t message;
396   ssize_t s = mc_model_checker->process().getChannel().receive(message);
397   if (s == -1)
398     xbt_die("Could not receive message");
399   if (s != sizeof(message) || message.type != MC_MESSAGE_DEADLOCK_CHECK_REPLY)
400     xbt_die("Received unexpected message %s (%i, size=%i) "
401       "expected MC_MESSAGE_DEADLOCK_CHECK_REPLY (%i, size=%i)",
402       MC_message_type_name(message.type), (int) message.type, (int) s,
403       (int) MC_MESSAGE_DEADLOCK_CHECK_REPLY, (int) sizeof(message)
404       );
405   return message.value != 0;
406 }
407
408 }
409 }