1 /* Copyright (c) 2008-2019. 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/ModelChecker.hpp"
7 #include "src/mc/Session.hpp"
8 #include "src/mc/Transition.hpp"
9 #include "src/mc/checker/Checker.hpp"
10 #include "src/mc/mc_config.hpp"
11 #include "src/mc/mc_exit.hpp"
12 #include "src/mc/mc_private.hpp"
13 #include "src/mc/remote/RemoteClient.hpp"
14 #include "xbt/automaton.hpp"
15 #include "xbt/system_error.hpp"
17 #include <sys/ptrace.h>
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_ModelChecker, mc, "ModelChecker");
22 ::simgrid::mc::ModelChecker* mc_model_checker = nullptr;
24 using simgrid::mc::remote;
27 # define WAITPID_CHECKED_FLAGS __WALL
29 # define WAITPID_CHECKED_FLAGS 0
35 ModelChecker::ModelChecker(std::unique_ptr<RemoteClient> process)
37 , socket_event_(nullptr)
38 , signal_event_(nullptr)
40 , process_(std::move(process))
45 ModelChecker::~ModelChecker() {
46 if (socket_event_ != nullptr)
47 event_free(socket_event_);
48 if (signal_event_ != nullptr)
49 event_free(signal_event_);
51 event_base_free(base_);
54 void ModelChecker::start()
56 base_ = event_base_new();
57 event_callback_fn event_callback = [](evutil_socket_t fd, short events, void *arg)
59 ((ModelChecker *)arg)->handle_events(fd, events);
61 socket_event_ = event_new(base_, process_->get_channel().get_socket(), EV_READ | EV_PERSIST, event_callback, this);
62 event_add(socket_event_, NULL);
63 signal_event_ = event_new(base_,
66 event_callback, this);
67 event_add(signal_event_, NULL);
69 XBT_DEBUG("Waiting for the model-checked process");
72 // The model-checked process SIGSTOP itself to signal it's ready:
73 const pid_t pid = process_->pid();
75 pid_t res = waitpid(pid, &status, WAITPID_CHECKED_FLAGS);
76 if (res < 0 || not WIFSTOPPED(status) || WSTOPSIG(status) != SIGSTOP)
77 xbt_die("Could not wait model-checked process");
81 if (not _sg_mc_dot_output_file.get().empty())
87 ptrace(PTRACE_SETOPTIONS, pid, nullptr, PTRACE_O_TRACEEXIT);
88 ptrace(PTRACE_CONT, pid, 0, 0);
90 ptrace(PT_CONTINUE, pid, (caddr_t)1, 0);
92 # error "no ptrace equivalent coded for this platform"
96 static const std::pair<const char*, const char*> ignored_local_variables[] = {
97 std::pair<const char*, const char*>{ "e", "*" },
98 std::pair<const char*, const char*>{ "_log_ev", "*" },
100 /* Ignore local variable about time used for tracing */
101 std::pair<const char*, const char*>{ "start_time", "*" },
104 void ModelChecker::setup_ignore()
106 RemoteClient& process = this->process();
107 for (std::pair<const char*, const char*> const& var :
108 ignored_local_variables)
109 process.ignore_local_variable(var.first, var.second);
111 /* Static variable used for tracing */
112 process.ignore_global_variable("counter");
115 void ModelChecker::shutdown()
117 XBT_DEBUG("Shuting down model-checker");
119 simgrid::mc::RemoteClient* process = &this->process();
120 if (process->running()) {
121 XBT_DEBUG("Killing process");
122 kill(process->pid(), SIGKILL);
123 process->terminate();
127 void ModelChecker::resume(simgrid::mc::RemoteClient& process)
129 int res = process.get_channel().send(MC_MESSAGE_CONTINUE);
131 throw simgrid::xbt::errno_error();
132 process.clear_cache();
135 static void MC_report_crash(int status)
137 XBT_INFO("**************************");
138 XBT_INFO("** CRASH IN THE PROGRAM **");
139 XBT_INFO("**************************");
140 if (WIFSIGNALED(status))
141 XBT_INFO("From signal: %s", strsignal(WTERMSIG(status)));
142 else if (WIFEXITED(status))
143 XBT_INFO("From exit: %i", WEXITSTATUS(status));
144 if (not xbt_log_no_loc)
145 XBT_INFO("%s core dump was generated by the system.", WCOREDUMP(status) ? "A" : "No");
146 XBT_INFO("Counter-example execution trace:");
147 for (auto const& s : mc_model_checker->getChecker()->get_textual_trace())
148 XBT_INFO(" %s", s.c_str());
149 simgrid::mc::dumpRecordPath();
150 simgrid::mc::session->log_state();
151 if (xbt_log_no_loc) {
152 XBT_INFO("Stack trace not displayed because you passed --log=no_loc");
154 XBT_INFO("Stack trace:");
155 mc_model_checker->process().dump_stack();
159 static void MC_report_assertion_error()
161 XBT_INFO("**************************");
162 XBT_INFO("*** PROPERTY NOT VALID ***");
163 XBT_INFO("**************************");
164 XBT_INFO("Counter-example execution trace:");
165 for (auto const& s : mc_model_checker->getChecker()->get_textual_trace())
166 XBT_INFO(" %s", s.c_str());
167 simgrid::mc::dumpRecordPath();
168 simgrid::mc::session->log_state();
171 bool ModelChecker::handle_message(char* buffer, ssize_t size)
173 s_mc_message_t base_message;
174 if (size < (ssize_t) sizeof(base_message))
175 xbt_die("Broken message");
176 memcpy(&base_message, buffer, sizeof(base_message));
178 switch(base_message.type) {
180 case MC_MESSAGE_IGNORE_HEAP:
182 s_mc_message_ignore_heap_t message;
183 if (size != sizeof(message))
184 xbt_die("Broken messsage");
185 memcpy(&message, buffer, sizeof(message));
187 IgnoredHeapRegion region;
188 region.block = message.block;
189 region.fragment = message.fragment;
190 region.address = message.address;
191 region.size = message.size;
192 process().ignore_heap(region);
196 case MC_MESSAGE_UNIGNORE_HEAP:
198 s_mc_message_ignore_memory_t message;
199 if (size != sizeof(message))
200 xbt_die("Broken messsage");
201 memcpy(&message, buffer, sizeof(message));
202 process().unignore_heap((void*)(std::uintptr_t)message.addr, message.size);
206 case MC_MESSAGE_IGNORE_MEMORY:
208 s_mc_message_ignore_memory_t message;
209 if (size != sizeof(message))
210 xbt_die("Broken messsage");
211 memcpy(&message, buffer, sizeof(message));
212 this->process().ignore_region(message.addr, message.size);
216 case MC_MESSAGE_STACK_REGION:
218 s_mc_message_stack_region_t message;
219 if (size != sizeof(message))
220 xbt_die("Broken messsage");
221 memcpy(&message, buffer, sizeof(message));
222 this->process().stack_areas().push_back(message.stack_region);
226 case MC_MESSAGE_REGISTER_SYMBOL:
228 s_mc_message_register_symbol_t message;
229 if (size != sizeof(message))
230 xbt_die("Broken message");
231 memcpy(&message, buffer, sizeof(message));
232 if (message.callback)
233 xbt_die("Support for client-side function proposition is not implemented.");
234 XBT_DEBUG("Received symbol: %s", message.name);
236 if (simgrid::mc::property_automaton == nullptr)
237 simgrid::mc::property_automaton = xbt_automaton_new();
239 simgrid::mc::RemoteClient* process = &this->process();
240 simgrid::mc::RemotePtr<int> address = simgrid::mc::remote((int*)message.data);
241 simgrid::xbt::add_proposition(simgrid::mc::property_automaton, message.name,
242 [process, address]() { return process->read(address); });
247 case MC_MESSAGE_WAITING:
250 case MC_MESSAGE_ASSERTION_FAILED:
251 MC_report_assertion_error();
252 this->exit(SIMGRID_MC_EXIT_SAFETY);
255 xbt_die("Unexpected message from model-checked application");
261 /** Terminate the model-checker application */
262 void ModelChecker::exit(int status)
264 // TODO, terminate the model checker politely instead of exiting rudely
265 if (process().running())
266 kill(process().pid(), SIGKILL);
270 void ModelChecker::handle_events(int fd, short events)
272 if (events == EV_READ) {
273 char buffer[MC_MESSAGE_LENGTH];
274 ssize_t size = process_->get_channel().receive(buffer, sizeof(buffer), false);
275 if (size == -1 && errno != EAGAIN)
276 throw simgrid::xbt::errno_error();
277 if (not handle_message(buffer, size)) {
278 event_base_loopbreak(base_);
281 else if (events == EV_SIGNAL) {
285 xbt_die("Unexpected event");
289 void ModelChecker::loop()
291 if (this->process().running())
292 event_base_dispatch(base_);
295 void ModelChecker::handle_waitpid()
297 XBT_DEBUG("Check for wait event");
300 while ((pid = waitpid(-1, &status, WNOHANG)) != 0) {
302 if (errno == ECHILD) {
304 if (this->process().running())
305 xbt_die("Inconsistent state");
309 XBT_ERROR("Could not wait for pid");
310 throw simgrid::xbt::errno_error();
314 if (pid == this->process().pid()) {
316 // From PTRACE_O_TRACEEXIT:
318 if (status>>8 == (SIGTRAP | (PTRACE_EVENT_EXIT<<8))) {
319 if (ptrace(PTRACE_GETEVENTMSG, this->process().pid(), 0, &status) == -1)
320 xbt_die("Could not get exit status");
321 if (WIFSIGNALED(status)) {
322 MC_report_crash(status);
323 mc_model_checker->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH);
328 // We don't care about signals, just reinject them:
329 if (WIFSTOPPED(status)) {
330 XBT_DEBUG("Stopped with signal %i", (int) WSTOPSIG(status));
333 ptrace(PTRACE_CONT, this->process().pid(), 0, WSTOPSIG(status));
335 ptrace(PT_CONTINUE, this->process().pid(), (caddr_t)1, WSTOPSIG(status));
338 xbt_die("Could not PTRACE_CONT");
341 else if (WIFSIGNALED(status)) {
342 MC_report_crash(status);
343 mc_model_checker->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH);
344 } else if (WIFEXITED(status)) {
345 XBT_DEBUG("Child process is over");
346 this->process().terminate();
352 void ModelChecker::on_signal(int signo)
354 if (signo == SIGCHLD)
355 this->handle_waitpid();
358 void ModelChecker::wait_for_requests()
360 this->resume(process());
361 if (this->process().running())
362 event_base_dispatch(base_);
365 void ModelChecker::handle_simcall(Transition const& transition)
367 s_mc_message_simcall_handle_t m;
368 memset(&m, 0, sizeof(m));
369 m.type = MC_MESSAGE_SIMCALL_HANDLE;
370 m.pid = transition.pid_;
371 m.value = transition.argument_;
372 this->process_->get_channel().send(m);
373 this->process_->clear_cache();
374 if (this->process_->running())
375 event_base_dispatch(base_);
378 bool ModelChecker::checkDeadlock()
381 if ((res = this->process().get_channel().send(MC_MESSAGE_DEADLOCK_CHECK)))
382 xbt_die("Could not check deadlock state");
383 s_mc_message_int_t message;
384 ssize_t s = mc_model_checker->process().get_channel().receive(message);
386 xbt_die("Could not receive message");
387 if (s != sizeof(message) || message.type != MC_MESSAGE_DEADLOCK_CHECK_REPLY)
388 xbt_die("Received unexpected message %s (%i, size=%i) "
389 "expected MC_MESSAGE_DEADLOCK_CHECK_REPLY (%i, size=%i)",
390 MC_message_type_name(message.type), (int) message.type, (int) s,
391 (int) MC_MESSAGE_DEADLOCK_CHECK_REPLY, (int) sizeof(message)
393 return message.value != 0;