src/mc/ModelChecker.cpp

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