Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Initialize data members with class initializers, or initialization lists.
[simgrid.git] / src / mc / ModelChecker.cpp
index f160216..f5ef3b4 100644 (file)
@@ -1,36 +1,21 @@
-/* Copyright (c) 2008-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2008-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include <cassert>
-
-#include <sys/types.h>
-#include <sys/wait.h>
-#include <sys/socket.h>
-#include <sys/ptrace.h>
-
-#include <memory>
-#include <system_error>
-
-#include <xbt/log.h>
-#include <xbt/automaton.h>
-#include <xbt/automaton.hpp>
-#include <xbt/system_error.hpp>
-
-#include "simgrid/sg_config.h"
-
-#include "src/mc/ModelChecker.hpp"
 #include "src/mc/ModelChecker.hpp"
-#include "src/mc/PageStore.hpp"
+#include "src/mc/Session.hpp"
 #include "src/mc/Transition.hpp"
 #include "src/mc/checker/Checker.hpp"
-#include "src/mc/mc_exit.h"
-#include "src/mc/mc_ignore.h"
-#include "src/mc/mc_private.h"
-#include "src/mc/mc_record.h"
-#include "src/mc/remote/mc_protocol.h"
+#include "src/mc/mc_config.hpp"
+#include "src/mc/mc_exit.hpp"
+#include "src/mc/mc_private.hpp"
+#include "src/mc/remote/RemoteClient.hpp"
+#include "xbt/automaton.hpp"
+#include "xbt/system_error.hpp"
+
+#include <sys/ptrace.h>
+#include <sys/wait.h>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_ModelChecker, mc, "ModelChecker");
 
@@ -47,18 +32,10 @@ using simgrid::mc::remote;
 namespace simgrid {
 namespace mc {
 
-ModelChecker::ModelChecker(std::unique_ptr<Process> process) :
-  base_(nullptr),
-  socket_event_(nullptr),
-  signal_event_(nullptr),
-  page_store_(500),
-  process_(std::move(process)),
-  parent_snapshot_(nullptr)
-{
+ModelChecker::ModelChecker(std::unique_ptr<RemoteClient> process) : process_(std::move(process)) {}
 
-}
-
-ModelChecker::~ModelChecker() {
+ModelChecker::~ModelChecker()
+{
   if (socket_event_ != nullptr)
     event_free(socket_event_);
   if (signal_event_ != nullptr)
@@ -69,17 +46,12 @@ ModelChecker::~ModelChecker() {
 
 void ModelChecker::start()
 {
-  const pid_t pid = process_->pid();
-
   base_ = event_base_new();
   event_callback_fn event_callback = [](evutil_socket_t fd, short events, void *arg)
   {
     ((ModelChecker *)arg)->handle_events(fd, events);
   };
-  socket_event_ = event_new(base_,
-                            process_->getChannel().getSocket(),
-                            EV_READ|EV_PERSIST,
-                            event_callback, this);
+  socket_event_ = event_new(base_, process_->get_channel().get_socket(), EV_READ | EV_PERSIST, event_callback, this);
   event_add(socket_event_, NULL);
   signal_event_ = event_new(base_,
                             SIGCHLD,
@@ -91,13 +63,15 @@ void ModelChecker::start()
   int status;
 
   // The model-checked process SIGSTOP itself to signal it's ready:
+  const pid_t pid = process_->pid();
+
   pid_t res = waitpid(pid, &status, WAITPID_CHECKED_FLAGS);
-  if (res < 0 || !WIFSTOPPED(status) || WSTOPSIG(status) != SIGSTOP)
+  if (res < 0 || not WIFSTOPPED(status) || WSTOPSIG(status) != SIGSTOP)
     xbt_die("Could not wait model-checked process");
 
   process_->init();
 
-  if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0'))
+  if (not _sg_mc_dot_output_file.get().empty())
     MC_init_dot_output();
 
   setup_ignore();
@@ -114,17 +88,7 @@ void ModelChecker::start()
 
 static const std::pair<const char*, const char*> ignored_local_variables[] = {
   std::pair<const char*, const char*>{  "e", "*" },
-  std::pair<const char*, const char*>{ "__ex_cleanup", "*" },
-  std::pair<const char*, const char*>{ "__ex_mctx_en", "*" },
-  std::pair<const char*, const char*>{ "__ex_mctx_me", "*" },
-  std::pair<const char*, const char*>{ "__xbt_ex_ctx_ptr", "*" },
   std::pair<const char*, const char*>{ "_log_ev", "*" },
-  std::pair<const char*, const char*>{ "_throw_ctx", "*" },
-  std::pair<const char*, const char*>{ "ctx", "*" },
-
-  std::pair<const char*, const char*>{ "self", "simcall_BODY_mc_snapshot" },
-  std::pair<const char*, const char*>{ "next_context", "smx_ctx_sysv_suspend_serial" },
-  std::pair<const char*, const char*>{ "i", "smx_ctx_sysv_suspend_serial" },
 
   /* Ignore local variable about time used for tracing */
   std::pair<const char*, const char*>{ "start_time", "*" },
@@ -132,7 +96,7 @@ static const std::pair<const char*, const char*> ignored_local_variables[] = {
 
 void ModelChecker::setup_ignore()
 {
-  Process& process = this->process();
+  RemoteClient& process = this->process();
   for (std::pair<const char*, const char*> const& var :
       ignored_local_variables)
     process.ignore_local_variable(var.first, var.second);
@@ -145,19 +109,19 @@ void ModelChecker::shutdown()
 {
   XBT_DEBUG("Shuting down model-checker");
 
-  simgrid::mc::Process* process = &this->process();
+  RemoteClient* process = &this->process();
   if (process->running()) {
     XBT_DEBUG("Killing process");
-    kill(process->pid(), SIGTERM);
+    kill(process->pid(), SIGKILL);
     process->terminate();
   }
 }
 
-void ModelChecker::resume(simgrid::mc::Process& process)
+void ModelChecker::resume(RemoteClient& process)
 {
-  int res = process.getChannel().send(MC_MESSAGE_CONTINUE);
+  int res = process.get_channel().send(MC_MESSAGE_CONTINUE);
   if (res)
-    throw simgrid::xbt::errno_error();
+    throw xbt::errno_error();
   process.clear_cache();
 }
 
@@ -170,109 +134,98 @@ static void MC_report_crash(int status)
     XBT_INFO("From signal: %s", strsignal(WTERMSIG(status)));
   else if (WIFEXITED(status))
     XBT_INFO("From exit: %i", WEXITSTATUS(status));
-  if (WCOREDUMP(status))
-    XBT_INFO("A core dump was generated by the system.");
-  else
-    XBT_INFO("No core dump was generated by the system.");
+  if (not xbt_log_no_loc)
+    XBT_INFO("%s core dump was generated by the system.", WCOREDUMP(status) ? "A" : "No");
   XBT_INFO("Counter-example execution trace:");
-  simgrid::mc::dumpRecordPath();
-  for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
-    XBT_INFO("%s", s.c_str());
-  simgrid::mc::session->logState();
-  XBT_INFO("Stack trace:");
-  mc_model_checker->process().dumpStack();
+  for (auto const& s : mc_model_checker->getChecker()->get_textual_trace())
+    XBT_INFO("  %s", s.c_str());
+  dumpRecordPath();
+  session->log_state();
+  if (xbt_log_no_loc) {
+    XBT_INFO("Stack trace not displayed because you passed --log=no_loc");
+  } else {
+    XBT_INFO("Stack trace:");
+    mc_model_checker->process().dump_stack();
+  }
 }
 
-static void MC_report_assertion_error(void)
+static void MC_report_assertion_error()
 {
   XBT_INFO("**************************");
   XBT_INFO("*** PROPERTY NOT VALID ***");
   XBT_INFO("**************************");
   XBT_INFO("Counter-example execution trace:");
-  simgrid::mc::dumpRecordPath();
-  for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
-    XBT_INFO("%s", s.c_str());
-  simgrid::mc::session->logState();
+  for (auto const& s : mc_model_checker->getChecker()->get_textual_trace())
+    XBT_INFO("  %s", s.c_str());
+  dumpRecordPath();
+  session->log_state();
 }
 
 bool ModelChecker::handle_message(char* buffer, ssize_t size)
 {
   s_mc_message_t base_message;
-  if (size < (ssize_t) sizeof(base_message))
-    xbt_die("Broken message");
+  xbt_assert(size >= (ssize_t)sizeof(base_message), "Broken message");
   memcpy(&base_message, buffer, sizeof(base_message));
 
   switch(base_message.type) {
-
   case MC_MESSAGE_IGNORE_HEAP:
     {
-      s_mc_ignore_heap_message_t message;
-      if (size != sizeof(message))
-        xbt_die("Broken messsage");
-      memcpy(&message, buffer, sizeof(message));
-
-      IgnoredHeapRegion region;
-      region.block = message.block;
-      region.fragment = message.fragment;
-      region.address = message.address;
-      region.size = message.size;
-      process().ignore_heap(region);
-      break;
+    s_mc_message_ignore_heap_t message;
+    xbt_assert(size == sizeof(message), "Broken messsage");
+    memcpy(&message, buffer, sizeof(message));
+
+    IgnoredHeapRegion region;
+    region.block    = message.block;
+    region.fragment = message.fragment;
+    region.address  = message.address;
+    region.size     = message.size;
+    process().ignore_heap(region);
+    break;
     }
 
   case MC_MESSAGE_UNIGNORE_HEAP:
     {
-      s_mc_ignore_memory_message_t message;
-      if (size != sizeof(message))
-        xbt_die("Broken messsage");
-      memcpy(&message, buffer, sizeof(message));
-      process().unignore_heap(
-        (void *)(std::uintptr_t) message.addr, message.size);
-      break;
+    s_mc_message_ignore_memory_t message;
+    xbt_assert(size == sizeof(message), "Broken messsage");
+    memcpy(&message, buffer, sizeof(message));
+    process().unignore_heap((void*)(std::uintptr_t)message.addr, message.size);
+    break;
     }
 
   case MC_MESSAGE_IGNORE_MEMORY:
     {
-      s_mc_ignore_memory_message_t message;
-      if (size != sizeof(message))
-        xbt_die("Broken messsage");
-      memcpy(&message, buffer, sizeof(message));
-      this->process().ignore_region(message.addr, message.size);
-      break;
+    s_mc_message_ignore_memory_t message;
+    xbt_assert(size == sizeof(message), "Broken messsage");
+    memcpy(&message, buffer, sizeof(message));
+    this->process().ignore_region(message.addr, message.size);
+    break;
     }
 
   case MC_MESSAGE_STACK_REGION:
     {
-      s_mc_stack_region_message_t message;
-      if (size != sizeof(message))
-        xbt_die("Broken messsage");
-      memcpy(&message, buffer, sizeof(message));
-      this->process().stack_areas().push_back(message.stack_region);
+    s_mc_message_stack_region_t message;
+    xbt_assert(size == sizeof(message), "Broken messsage");
+    memcpy(&message, buffer, sizeof(message));
+    this->process().stack_areas().push_back(message.stack_region);
     }
     break;
 
   case MC_MESSAGE_REGISTER_SYMBOL:
     {
-      s_mc_register_symbol_message_t message;
-      if (size != sizeof(message))
-        xbt_die("Broken message");
-      memcpy(&message, buffer, sizeof(message));
-      if (message.callback)
-        xbt_die("Support for client-side function proposition is not implemented.");
-      XBT_DEBUG("Received symbol: %s", message.name);
-
-      if (simgrid::mc::property_automaton == nullptr)
-        simgrid::mc::property_automaton = xbt_automaton_new();
-
-      simgrid::mc::Process* process = &this->process();
-      simgrid::mc::RemotePtr<int> address
-        = simgrid::mc::remote((int*) message.data);
-      simgrid::xbt::add_proposition(simgrid::mc::property_automaton,
-        message.name,
-        [process, address]() { return process->read(address); }
-        );
-
-      break;
+    s_mc_message_register_symbol_t message;
+    xbt_assert(size == sizeof(message), "Broken message");
+    memcpy(&message, buffer, sizeof(message));
+    xbt_assert(not message.callback, "Support for client-side function proposition is not implemented.");
+    XBT_DEBUG("Received symbol: %s", message.name);
+
+    if (property_automaton == nullptr)
+      property_automaton = xbt_automaton_new();
+
+    RemoteClient* process  = &this->process();
+    RemotePtr<int> address = remote((int*)message.data);
+    xbt::add_proposition(property_automaton, message.name, [process, address]() { return process->read(address); });
+
+    break;
     }
 
   case MC_MESSAGE_WAITING:
@@ -281,11 +234,9 @@ bool ModelChecker::handle_message(char* buffer, ssize_t size)
   case MC_MESSAGE_ASSERTION_FAILED:
     MC_report_assertion_error();
     this->exit(SIMGRID_MC_EXIT_SAFETY);
-    break;
 
   default:
     xbt_die("Unexpected message from model-checked application");
-
   }
   return true;
 }
@@ -303,10 +254,10 @@ void ModelChecker::handle_events(int fd, short events)
 {
   if (events == EV_READ) {
     char buffer[MC_MESSAGE_LENGTH];
-    ssize_t size = process_->getChannel().receive(buffer, sizeof(buffer), false);
+    ssize_t size = process_->get_channel().receive(buffer, sizeof(buffer), false);
     if (size == -1 && errno != EAGAIN)
       throw simgrid::xbt::errno_error();
-    if (!handle_message(buffer, size)) {
+    if (not handle_message(buffer, size)) {
       event_base_loopbreak(base_);
     }
   }
@@ -333,10 +284,8 @@ void ModelChecker::handle_waitpid()
     if (pid == -1) {
       if (errno == ECHILD) {
         // No more children:
-        if (this->process().running())
-          xbt_die("Inconsistent state");
-        else
-          break;
+        xbt_assert(not this->process().running(), "Inconsistent state");
+        break;
       } else {
         XBT_ERROR("Could not wait for pid");
         throw simgrid::xbt::errno_error();
@@ -344,12 +293,10 @@ void ModelChecker::handle_waitpid()
     }
 
     if (pid == this->process().pid()) {
-
       // From PTRACE_O_TRACEEXIT:
 #ifdef __linux__
       if (status>>8 == (SIGTRAP | (PTRACE_EVENT_EXIT<<8))) {
-        if (ptrace(PTRACE_GETEVENTMSG, this->process().pid(), 0, &status) == -1)
-          xbt_die("Could not get exit status");
+        xbt_assert(ptrace(PTRACE_GETEVENTMSG, this->process().pid(), 0, &status) != -1, "Could not get exit status");
         if (WIFSIGNALED(status)) {
           MC_report_crash(status);
           mc_model_checker->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH);
@@ -366,11 +313,13 @@ void ModelChecker::handle_waitpid()
 #elif defined BSD
         ptrace(PT_CONTINUE, this->process().pid(), (caddr_t)1, WSTOPSIG(status));
 #endif
-        if (errno != 0)
-          xbt_die("Could not PTRACE_CONT");
+        xbt_assert(errno == 0, "Could not PTRACE_CONT");
       }
 
-      else if (WIFEXITED(status) || WIFSIGNALED(status)) {
+      else if (WIFSIGNALED(status)) {
+        MC_report_crash(status);
+        mc_model_checker->exit(SIMGRID_MC_EXIT_PROGRAM_CRASH);
+      } else if (WIFEXITED(status)) {
         XBT_DEBUG("Child process is over");
         this->process().terminate();
       }
@@ -380,30 +329,25 @@ void ModelChecker::handle_waitpid()
 
 void ModelChecker::on_signal(int signo)
 {
-  switch(signo) {
-  case SIGCHLD:
+  if (signo == SIGCHLD)
     this->handle_waitpid();
-    break;
-  default:
-    break;
-  }
 }
 
-void ModelChecker::wait_client(simgrid::mc::Process& process)
+void ModelChecker::wait_for_requests()
 {
-  this->resume(process);
+  this->resume(process());
   if (this->process().running())
     event_base_dispatch(base_);
 }
 
 void ModelChecker::handle_simcall(Transition const& transition)
 {
-  s_mc_simcall_handle_message m;
+  s_mc_message_simcall_handle_t m;
   memset(&m, 0, sizeof(m));
   m.type  = MC_MESSAGE_SIMCALL_HANDLE;
-  m.pid   = transition.pid;
-  m.value = transition.argument;
-  this->process_->getChannel().send(m);
+  m.pid   = transition.pid_;
+  m.value = transition.argument_;
+  this->process_->get_channel().send(m);
   this->process_->clear_cache();
   if (this->process_->running())
     event_base_dispatch(base_);
@@ -411,21 +355,18 @@ void ModelChecker::handle_simcall(Transition const& transition)
 
 bool ModelChecker::checkDeadlock()
 {
-  int res;
-  if ((res = this->process().getChannel().send(MC_MESSAGE_DEADLOCK_CHECK)))
-    xbt_die("Could not check deadlock state");
-  s_mc_int_message_t message;
-  ssize_t s = mc_model_checker->process().getChannel().receive(message);
-  if (s == -1)
-    xbt_die("Could not receive message");
-  if (s != sizeof(message) || message.type != MC_MESSAGE_DEADLOCK_CHECK_REPLY)
-    xbt_die("Received unexpected message %s (%i, size=%i) "
-      "expected MC_MESSAGE_DEADLOCK_CHECK_REPLY (%i, size=%i)",
-      MC_message_type_name(message.type), (int) message.type, (int) s,
-      (int) MC_MESSAGE_DEADLOCK_CHECK_REPLY, (int) sizeof(message)
-      );
+  int res = this->process().get_channel().send(MC_MESSAGE_DEADLOCK_CHECK);
+  xbt_assert(res == 0, "Could not check deadlock state");
+  s_mc_message_int_t message;
+  ssize_t s = mc_model_checker->process().get_channel().receive(message);
+  xbt_assert(s != -1, "Could not receive message");
+  xbt_assert(s == sizeof(message) && message.type == MC_MESSAGE_DEADLOCK_CHECK_REPLY,
+             "Received unexpected message %s (%i, size=%i) "
+             "expected MC_MESSAGE_DEADLOCK_CHECK_REPLY (%i, size=%i)",
+             MC_message_type_name(message.type), (int)message.type, (int)s, (int)MC_MESSAGE_DEADLOCK_CHECK_REPLY,
+             (int)sizeof(message));
   return message.value != 0;
 }
 
-}
-}
+} // namespace mc
+} // namespace simgrid