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