Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Use std::list instead of xbt_fifo for mc_stack
[simgrid.git] / src / mc / mc_global.cpp
index d47939e..9d7073c 100644 (file)
@@ -9,6 +9,8 @@
 #include <cstddef>
 #include <cstdint>
 
+#include <cxxabi.h>
+
 #include <vector>
 
 #include "mc_base.h"
@@ -21,9 +23,6 @@
 #include <sys/time.h>
 #endif
 
-#include <xbt/fifo.h>
-#include <xbt/automaton.h>
-
 #include "src/simix/smx_process_private.h"
 
 #if HAVE_MC
 #include "src/mc/mc_request.h"
 #include "src/mc/mc_safety.h"
 #include "src/mc/mc_snapshot.h"
-#include "src/mc/mc_liveness.h"
 #include "src/mc/mc_private.h"
 #include "src/mc/mc_unw.h"
 #include "src/mc/mc_smx.h"
+#include "src/mc/Checker.hpp"
 #endif
 
 #include "src/mc/mc_record.h"
 #include "src/mc/mc_protocol.h"
 #include "src/mc/Client.hpp"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
-                                "Logging specific to MC (global)");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc, "Logging specific to MC (global)");
 
 e_mc_mode_t mc_mode;
 
@@ -59,18 +57,17 @@ std::vector<double> processes_time;
 int user_max_depth_reached = 0;
 
 /* MC global data structures */
-mc_state_t mc_current_state = nullptr;
+simgrid::mc::State* mc_current_state = nullptr;
 char mc_replay_mode = false;
 
 mc_stats_t mc_stats = nullptr;
-mc_global_t initial_global_state = nullptr;
-xbt_fifo_t mc_stack = nullptr;
 
 /* Liveness */
 
 namespace simgrid {
 namespace mc {
 
+std::unique_ptr<s_mc_global_t> initial_global_state = nullptr;
 xbt_automaton_t property_automaton = nullptr;
 
 }
@@ -78,29 +75,13 @@ xbt_automaton_t property_automaton = nullptr;
 
 /* Dot output */
 FILE *dot_output = nullptr;
-const char *colors[13];
 
 
 /*******************************  Initialisation of MC *******************************/
 /*********************************************************************************/
 
 void MC_init_dot_output()
-{                               /* FIXME : more colors */
-
-  colors[0] = "blue";
-  colors[1] = "red";
-  colors[2] = "green3";
-  colors[3] = "goldenrod";
-  colors[4] = "brown";
-  colors[5] = "purple";
-  colors[6] = "magenta";
-  colors[7] = "turquoise4";
-  colors[8] = "gray25";
-  colors[9] = "forestgreen";
-  colors[10] = "hotpink";
-  colors[11] = "lightblue";
-  colors[12] = "tan";
-
+{
   dot_output = fopen(_sg_mc_dot_output_file, "w");
 
   if (dot_output == nullptr) {
@@ -113,77 +94,23 @@ void MC_init_dot_output()
 
 }
 
-#if HAVE_MC
-void MC_init()
-{
-  simgrid::mc::processes_time.resize(simix_process_maxpid);
-
-  if (_sg_mc_visited > 0 || _sg_mc_liveness  || _sg_mc_termination || mc_mode == MC_MODE_SERVER) {
-    /* Those requests are handled on the client side and propagated by message
-     * to the server: */
-
-    MC_ignore_heap(simgrid::mc::processes_time.data(),
-      simix_process_maxpid * sizeof(double));
-
-    smx_process_t process;
-    xbt_swag_foreach(process, simix_global->process_list)
-      MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
-  }
-}
-
-#endif
-
 /*******************************  Core of MC *******************************/
 /**************************************************************************/
 
 void MC_run()
 {
-  mc_mode = MC_MODE_CLIENT;
-  MC_init();
+  simgrid::mc::processes_time.resize(simix_process_maxpid);
+  MC_ignore_heap(simgrid::mc::processes_time.data(),
+    simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0]));
+  smx_process_t process;
+  xbt_swag_foreach(process, simix_global->process_list)
+    MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
   simgrid::mc::Client::get()->mainLoop();
-}
-
-void MC_exit(void)
-{
   simgrid::mc::processes_time.clear();
-  MC_memory_exit();
-  //xbt_abort();
 }
 
-#if HAVE_MC
-int MC_deadlock_check()
-{
-  if (mc_mode == MC_MODE_SERVER) {
-    int res;
-    if ((res = mc_model_checker->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("%s received unexpected message %s (%i, size=%i) "
-        "expected MC_MESSAGE_DEADLOCK_CHECK_REPLY (%i, size=%i)",
-        MC_mode_name(mc_mode),
-        MC_message_type_name(message.type), (int) message.type, (int) s,
-        (int) MC_MESSAGE_DEADLOCK_CHECK_REPLY, (int) sizeof(message)
-        );
-    return message.value;
-  }
-
-  bool deadlock = false;
-  smx_process_t process;
-  if (xbt_swag_size(simix_global->process_list)) {
-    deadlock = true;
-    xbt_swag_foreach(process, simix_global->process_list)
-      if (simgrid::mc::process_is_enabled(process)) {
-        deadlock = false;
-        break;
-      }
-  }
-  return deadlock;
-}
-#endif
+namespace simgrid {
+namespace mc {
 
 /**
  * \brief Re-executes from the state at position start all the transitions indicated by
@@ -191,21 +118,14 @@ int MC_deadlock_check()
  * \param stack The stack with the transitions to execute.
  * \param start Start index to begin the re-execution.
  */
-void MC_replay(xbt_fifo_t stack)
+void replay(std::list<simgrid::mc::State*> const& stack)
 {
-  int value, count = 1;
-  char *req_str;
-  smx_simcall_t req = nullptr, saved_req = NULL;
-  xbt_fifo_item_t item, start_item;
-  mc_state_t state;
-  
   XBT_DEBUG("**** Begin Replay ****");
 
   /* Intermediate backtracking */
   if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
-    start_item = xbt_fifo_get_first_item(stack);
-    state = (mc_state_t)xbt_fifo_get_item_content(start_item);
-    if(state->system_state){
+    simgrid::mc::State* state = stack.back();
+    if (state->system_state) {
       simgrid::mc::restore_snapshot(state->system_state);
       if(_sg_mc_comms_determinism || _sg_mc_send_determinism) 
         MC_restore_communications_pattern(state);
@@ -215,12 +135,10 @@ void MC_replay(xbt_fifo_t stack)
 
 
   /* Restore the initial state */
-  simgrid::mc::restore_snapshot(initial_global_state->snapshot);
+  simgrid::mc::restore_snapshot(simgrid::mc::initial_global_state->snapshot);
   /* At the moment of taking the snapshot the raw heap was set, so restoring
    * it will set it back again, we have to unset it to continue  */
 
-  start_item = xbt_fifo_get_last_item(stack);
-
   if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
     // int n = xbt_dynar_length(incomplete_communications_pattern);
     unsigned n = MC_smx_get_maxpid();
@@ -232,24 +150,26 @@ void MC_replay(xbt_fifo_t stack)
     }
   }
 
+  int count = 1;
+
   /* Traverse the stack from the state at position start and re-execute the transitions */
-  for (item = start_item;
-       item != xbt_fifo_get_first_item(stack);
-       item = xbt_fifo_get_prev_item(item)) {
+  for (simgrid::mc::State* state : stack) {
+    if (state == stack.back())
+      break;
 
-    state = (mc_state_t) xbt_fifo_get_item_content(item);
-    saved_req = MC_state_get_executed_request(state, &value);
+    int value;
+    smx_simcall_t saved_req = MC_state_get_executed_request(state, &value);
     
     if (saved_req) {
       /* because we got a copy of the executed request, we have to fetch the  
          real one, pointed by the request field of the issuer process */
 
       const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
-      req = &issuer->simcall;
+      smx_simcall_t req = &issuer->simcall;
 
       /* Debug information */
       if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
-        req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
+        char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
         XBT_DEBUG("Replay: %s (%p)", req_str, state);
         xbt_free(req_str);
       }
@@ -278,179 +198,35 @@ void MC_replay(xbt_fifo_t stack)
   XBT_DEBUG("**** End Replay ****");
 }
 
-void MC_replay_liveness(xbt_fifo_t stack)
-{
-  xbt_fifo_item_t item;
-  simgrid::mc::Pair* pair = nullptr;
-  mc_state_t state = nullptr;
-  smx_simcall_t req = nullptr, saved_req = NULL;
-  int value, depth = 1;
-  char *req_str;
-
-  XBT_DEBUG("**** Begin Replay ****");
-
-  /* Intermediate backtracking */
-  if(_sg_mc_checkpoint > 0) {
-    item = xbt_fifo_get_first_item(stack);
-    pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
-    if(pair->graph_state->system_state){
-      simgrid::mc::restore_snapshot(pair->graph_state->system_state);
-      return;
-    }
-  }
-
-  /* Restore the initial state */
-  simgrid::mc::restore_snapshot(initial_global_state->snapshot);
-
-    /* Traverse the stack from the initial state and re-execute the transitions */
-    for (item = xbt_fifo_get_last_item(stack);
-         item != xbt_fifo_get_first_item(stack);
-         item = xbt_fifo_get_prev_item(item)) {
-
-      pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
-
-      state = (mc_state_t) pair->graph_state;
-
-      if (pair->exploration_started) {
-
-        saved_req = MC_state_get_executed_request(state, &value);
-
-        if (saved_req != nullptr) {
-          /* because we got a copy of the executed request, we have to fetch the
-             real one, pointed by the request field of the issuer process */
-          const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
-          req = &issuer->simcall;
-
-          /* Debug information */
-          if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
-            req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
-            XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
-            xbt_free(req_str);
-          }
-
-        }
-
-        simgrid::mc::handle_simcall(req, value);
-        mc_model_checker->wait_for_requests();
-      }
-
-      /* Update statistics */
-      mc_stats->visited_pairs++;
-      mc_stats->executed_transitions++;
-
-      depth++;
-      
-    }
-
-  XBT_DEBUG("**** End Replay ****");
 }
-
-/**
- * \brief Dumps the contents of a model-checker's stack and shows the actual
- *        execution trace
- * \param stack The stack to dump
- */
-void MC_dump_stack_safety(xbt_fifo_t stack)
-{
-  MC_show_stack_safety(stack);
-  
-  mc_state_t state;
-
-  while ((state = (mc_state_t) xbt_fifo_pop(stack)) != nullptr)
-    MC_state_delete(state, !state->in_visited_states ? 1 : 0);
 }
 
-
-void MC_show_stack_safety(xbt_fifo_t stack)
+void MC_show_deadlock(void)
 {
-  int value;
-  mc_state_t state;
-  xbt_fifo_item_t item;
-  smx_simcall_t req;
-  char *req_str = nullptr;
-
-  for (item = xbt_fifo_get_last_item(stack);
-       item; item = xbt_fifo_get_prev_item(item)) {
-    state = (mc_state_t)xbt_fifo_get_item_content(item);
-    req = MC_state_get_executed_request(state, &value);
-    if (req) {
-      req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
-      XBT_INFO("%s", req_str);
-      xbt_free(req_str);
-    }
-  }
-}
-
-void MC_show_deadlock(smx_simcall_t req)
-{
-  /*char *req_str = nullptr; */
   XBT_INFO("**************************");
   XBT_INFO("*** DEAD-LOCK DETECTED ***");
   XBT_INFO("**************************");
-  XBT_INFO("Locked request:");
-  /*req_str = simgrid::mc::request_to_string(req);
-     XBT_INFO("%s", req_str);
-     xbt_free(req_str); */
   XBT_INFO("Counter-example execution trace:");
-  MC_dump_stack_safety(mc_stack);
+  for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
+    XBT_INFO("%s", s.c_str());
   MC_print_statistics(mc_stats);
 }
 
-void MC_show_non_termination(void){
-  XBT_INFO("******************************************");
-  XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
-  XBT_INFO("******************************************");
-  XBT_INFO("Counter-example execution trace:");
-  MC_dump_stack_safety(mc_stack);
-  MC_print_statistics(mc_stats);
-}
-
-namespace simgrid {
-namespace mc {
-
-void show_stack_liveness(xbt_fifo_t stack)
-{
-  int value;
-  simgrid::mc::Pair* pair;
-  xbt_fifo_item_t item;
-  smx_simcall_t req;
-  char *req_str = nullptr;
-
-  for (item = xbt_fifo_get_last_item(stack);
-       item; item = xbt_fifo_get_prev_item(item)) {
-    pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
-    req = MC_state_get_executed_request(pair->graph_state, &value);
-    if (req && req->call != SIMCALL_NONE) {
-      req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
-      XBT_INFO("%s", req_str);
-      xbt_free(req_str);
-    }
-  }
-}
-
-void dump_stack_liveness(xbt_fifo_t stack)
-{
-  simgrid::mc::Pair* pair;
-  while ((pair = (simgrid::mc::Pair*) xbt_fifo_pop(stack)) != nullptr)
-    delete pair;
-}
-
-}
-}
-
 void MC_print_statistics(mc_stats_t stats)
 {
   if(_sg_mc_comms_determinism) {
-    if (!initial_global_state->recv_deterministic && initial_global_state->send_deterministic){
+    if (!simgrid::mc::initial_global_state->recv_deterministic &&
+        simgrid::mc::initial_global_state->send_deterministic){
       XBT_INFO("******************************************************");
       XBT_INFO("**** Only-send-deterministic communication pattern ****");
       XBT_INFO("******************************************************");
-      XBT_INFO("%s", initial_global_state->recv_diff);
-    }else if(!initial_global_state->send_deterministic && initial_global_state->recv_deterministic) {
+      XBT_INFO("%s", simgrid::mc::initial_global_state->recv_diff);
+    }else if(!simgrid::mc::initial_global_state->send_deterministic &&
+        simgrid::mc::initial_global_state->recv_deterministic) {
       XBT_INFO("******************************************************");
       XBT_INFO("**** Only-recv-deterministic communication pattern ****");
       XBT_INFO("******************************************************");
-      XBT_INFO("%s", initial_global_state->send_diff);
+      XBT_INFO("%s", simgrid::mc::initial_global_state->send_diff);
     }
   }
 
@@ -466,10 +242,13 @@ void MC_print_statistics(mc_stats_t stats)
     fprintf(dot_output, "}\n");
     fclose(dot_output);
   }
-  if (initial_global_state != nullptr && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
-    XBT_INFO("Send-deterministic : %s", !initial_global_state->send_deterministic ? "No" : "Yes");
+  if (simgrid::mc::initial_global_state != nullptr
+      && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
+    XBT_INFO("Send-deterministic : %s",
+      !simgrid::mc::initial_global_state->send_deterministic ? "No" : "Yes");
     if (_sg_mc_comms_determinism)
-      XBT_INFO("Recv-deterministic : %s", !initial_global_state->recv_deterministic ? "No" : "Yes");
+      XBT_INFO("Recv-deterministic : %s",
+        !simgrid::mc::initial_global_state->recv_deterministic ? "No" : "Yes");
   }
   if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
     int ret=system("free");
@@ -485,37 +264,56 @@ void MC_automaton_load(const char *file)
   xbt_automaton_load(simgrid::mc::property_automaton, file);
 }
 
-// TODO, fix cross-process access (this function is not used)
-static void MC_dump_stacks(FILE* file)
+namespace simgrid {
+namespace mc {
+
+void dumpStack(FILE* file, unw_cursor_t cursor)
 {
-  int nstack = 0;
-  for (auto const& stack : mc_model_checker->process().stack_areas()) {
+  int nframe = 0;
+  char buffer[100];
+
+  unw_word_t off;
+  do {
+    const char * name = !unw_get_proc_name(&cursor, buffer, 100, &off) ? buffer : "?";
+
+    int status;
+
+    // Demangle C++ names:
+    char* realname = abi::__cxa_demangle(name, 0, 0, &status);
 
-    xbt_die("Fix cross-process access to the context");
-    unw_context_t * context = (unw_context_t *)stack.context;
-    fprintf(file, "Stack %i:\n", nstack);
-
-    int nframe = 0;
-    char buffer[100];
-    unw_cursor_t c;
-    unw_init_local (&c, context);
-    unw_word_t off;
-    do {
-      const char * name = !unw_get_proc_name(&c, buffer, 100, &off) ? buffer : "?";
 #if defined(__x86_64__)
-      unw_word_t rip = 0;
-      unw_word_t rsp = 0;
-      unw_get_reg(&c, UNW_X86_64_RIP, &rip);
-      unw_get_reg(&c, UNW_X86_64_RSP, &rsp);
-      fprintf(file, "  %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
-        nframe, name, (std::uint64_t) rip, (std::uint64_t) rsp);
+    unw_word_t rip = 0;
+    unw_word_t rsp = 0;
+    unw_get_reg(&cursor, UNW_X86_64_RIP, &rip);
+    unw_get_reg(&cursor, UNW_X86_64_RSP, &rsp);
+    fprintf(file, "  %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
+      nframe, realname ? realname : name, (std::uint64_t) rip, (std::uint64_t) rsp);
 #else
-      fprintf(file, "  %i: %s\n", nframe, name);
+    fprintf(file, "  %i: %s\n", nframe, realname ? realname : name);
 #endif
-      ++nframe;
-    } while(unw_step(&c));
 
-    ++nstack;
+    free(realname);
+    ++nframe;
+  } while(unw_step(&cursor));
+}
+
+}
+}
+
+static void MC_dump_stacks(FILE* file)
+{
+  int nstack = 0;
+  for (auto const& stack : mc_model_checker->process().stack_areas()) {
+    fprintf(file, "Stack %i:\n", nstack++);
+
+    simgrid::mc::UnwindContext context;
+    unw_context_t raw_context =
+      mc_model_checker->process().read<unw_context_t>(
+        simgrid::mc::remote((unw_context_t *)stack.context));
+    context.initialize(&mc_model_checker->process(), &raw_context);
+
+    unw_cursor_t cursor = context.cursor();
+    simgrid::mc::dumpStack(file, cursor);
   }
 }
 #endif
@@ -541,8 +339,9 @@ void MC_report_assertion_error(void)
   XBT_INFO("*** PROPERTY NOT VALID ***");
   XBT_INFO("**************************");
   XBT_INFO("Counter-example execution trace:");
-  MC_record_dump_path(mc_stack);
-  MC_dump_stack_safety(mc_stack);
+  simgrid::mc::dumpRecordPath();
+  for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
+    XBT_INFO("%s", s.c_str());
   MC_print_statistics(mc_stats);
 }
 
@@ -560,9 +359,12 @@ void MC_report_crash(int status)
   else
     XBT_INFO("No core dump was generated by the system.");
   XBT_INFO("Counter-example execution trace:");
-  MC_record_dump_path(mc_stack);
-  MC_dump_stack_safety(mc_stack);
+  simgrid::mc::dumpRecordPath();
+  for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
+    XBT_INFO("%s", s.c_str());
   MC_print_statistics(mc_stats);
+  XBT_INFO("Stack trace:");
+  mc_model_checker->process().dumpStack();
 }
 
 #endif