Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use a portable name for SIGABRT
[simgrid.git] / src / mc / explo / Exploration.cpp
index e23d38c..061a9b4 100644 (file)
@@ -1,26 +1,63 @@
-/* Copyright (c) 2016-2022. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2016-2023. 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 "src/mc/explo/Exploration.hpp"
 #include "src/mc/mc_config.hpp"
+#include "src/mc/mc_exit.hpp"
 #include "src/mc/mc_private.hpp"
+#include "src/mc/sosp/RemoteProcessMemory.hpp"
+
+#include <sys/wait.h>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_explo, mc, "Generic exploration algorithm of the model-checker");
 
 namespace simgrid::mc {
 
-Exploration::Exploration(const std::vector<char*>& args) : remote_app_(std::make_unique<RemoteApp>(args))
+static simgrid::config::Flag<std::string> cfg_dot_output_file{
+    "model-check/dot-output", "Name of dot output file corresponding to graph state", ""};
+
+Exploration* Exploration::instance_ = nullptr; // singleton instance
+
+Exploration::Exploration(const std::vector<char*>& args, bool need_memory_introspection)
+    : remote_app_(std::make_unique<RemoteApp>(args, need_memory_introspection))
+{
+  xbt_assert(instance_ == nullptr, "Cannot have more than one exploration instance");
+  instance_ = this;
+
+  if (not cfg_dot_output_file.get().empty()) {
+    dot_output_ = fopen(cfg_dot_output_file.get().c_str(), "w");
+    xbt_assert(dot_output_ != nullptr, "Error open dot output file: %s", strerror(errno));
+
+    fprintf(dot_output_, "digraph graphname{\n fixedsize=true; rankdir=TB; ranksep=.25; edge [fontsize=12]; node "
+                         "[fontsize=10, shape=circle,width=.5 ]; graph [resolution=20, fontsize=10];\n");
+  }
+}
+
+Exploration::~Exploration()
+{
+  if (dot_output_ != nullptr)
+    fclose(dot_output_);
+  instance_ = nullptr;
+}
+
+void Exploration::dot_output(const char* fmt, ...)
 {
-  mc_model_checker->set_exploration(this);
+  if (dot_output_ != nullptr) {
+    va_list ap;
+    va_start(ap, fmt);
+    vfprintf(dot_output_, fmt, ap);
+    va_end(ap);
+    fflush(dot_output_);
+  }
 }
 
 void Exploration::log_state()
 {
-  if (not _sg_mc_dot_output_file.get().empty()) {
-    mc_model_checker->dot_output("}\n");
-    mc_model_checker->dot_output_close();
+  if (not cfg_dot_output_file.get().empty()) {
+    dot_output("}\n");
+    fclose(dot_output_);
   }
   if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")) {
     int ret = system("free");
@@ -29,4 +66,57 @@ void Exploration::log_state()
   }
 }
 
+XBT_ATTRIB_NORETURN void Exploration::report_crash(int status)
+{
+  XBT_INFO("**************************");
+  XBT_INFO("** CRASH IN THE PROGRAM **");
+  XBT_INFO("**************************");
+  if (WIFSIGNALED(status)) // FreeBSD use "Abort trap" as a strsignal for SIGABRT that is part of our tests
+    XBT_INFO("From signal: %s", WTERMSIG(status) == SIGABRT ? "Aborted" : strsignal(WTERMSIG(status)));
+  else if (WIFEXITED(status))
+    XBT_INFO("From exit: %i", WEXITSTATUS(status));
+  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:");
+  for (auto const& s : get_textual_trace())
+    XBT_INFO("  %s", s.c_str());
+  XBT_INFO("You can debug the problem (and see the whole details) by rerunning out of simgrid-mc with "
+           "--cfg=model-check/replay:'%s'",
+           get_record_trace().to_string().c_str());
+  log_state();
+  if (xbt_log_no_loc) {
+    XBT_INFO("Stack trace not displayed because you passed --log=no_loc");
+  } else {
+    const auto* memory = get_remote_app().get_remote_process_memory();
+    if (memory) {
+      XBT_INFO("Stack trace:");
+      memory->dump_stack();
+    } else {
+      XBT_INFO("Stack trace not shown because there is no memory introspection.");
+    }
+  }
+
+  system_exit(SIMGRID_MC_EXIT_PROGRAM_CRASH);
+}
+XBT_ATTRIB_NORETURN void Exploration::report_assertion_failure()
+{
+  XBT_INFO("**************************");
+  XBT_INFO("*** PROPERTY NOT VALID ***");
+  XBT_INFO("**************************");
+  XBT_INFO("Counter-example execution trace:");
+  for (auto const& s : get_textual_trace())
+    XBT_INFO("  %s", s.c_str());
+  XBT_INFO("You can debug the problem (and see the whole details) by rerunning out of simgrid-mc with "
+           "--cfg=model-check/replay:'%s'",
+           get_record_trace().to_string().c_str());
+  log_state();
+  system_exit(SIMGRID_MC_EXIT_SAFETY);
+}
+
+void Exploration::system_exit(int status) const
+{
+  ::exit(status);
+}
+
 }; // namespace simgrid::mc