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