Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use C++ constants when possible
[simgrid.git] / src / mc / mc_global.cpp
index 85a8ecd..b84e5eb 100644 (file)
@@ -1,86 +1,94 @@
-/* Copyright (c) 2008-2014. The SimGrid Team.
+/* Copyright (c) 2008-2015. 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 <cinttypes>
+#include <cassert>
+#include <cstddef>
+#include <cstdint>
 
-#include <assert.h>
-#include <string.h>
-#include <stdint.h>
+#include <vector>
 
 #include "mc_base.h"
 
-#ifndef _XBT_WIN32
+#include "mc/mc.h"
+
+#ifndef _WIN32
 #include <unistd.h>
 #include <sys/wait.h>
 #include <sys/time.h>
 #endif
 
-#include "simgrid/sg_config.h"
-#include "../surf/surf_private.h"
-#include "../simix/smx_private.h"
-#include "xbt/fifo.h"
-#include "xbt/automaton.h"
-#include "xbt/dict.h"
-#include "mc_record.h"
+#include <xbt/fifo.h>
+#include <xbt/automaton.h>
+
+#include "src/simix/smx_process_private.h"
 
-#ifdef HAVE_MC
-#include "mc_server.h"
+#if HAVE_MC
 #include <libunwind.h>
-#include <xbt/mmalloc.h>
-#include "../xbt/mmalloc/mmprivate.h"
-#include "mc_object_info.h"
-#include "mc_comm_pattern.h"
-#include "mc_request.h"
-#include "mc_safety.h"
-#include "mc_memory_map.h"
-#include "mc_snapshot.h"
-#include "mc_liveness.h"
-#include "mc_private.h"
-#include "mc_unw.h"
-#include "mc_smx.h"
-#include "mcer_ignore.h"
+#include "src/mc/mc_comm_pattern.h"
+#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"
 #endif
-#include "mc_record.h"
-#include "mc_protocol.h"
-#include "mc_client.h"
+
+#include "src/mc/mc_record.h"
+#include "src/mc/mc_protocol.h"
+#include "src/mc/mc_client.h"
 
 extern "C" {
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
                                 "Logging specific to MC (global)");
 
+}
+
 e_mc_mode_t mc_mode;
 
-double *mc_time = NULL;
+namespace simgrid {
+namespace mc {
+
+std::vector<double> processes_time;
 
-#ifdef HAVE_MC
+}
+}
+
+#if HAVE_MC
 int user_max_depth_reached = 0;
 
 /* MC global data structures */
-mc_state_t mc_current_state = NULL;
-char mc_replay_mode = FALSE;
+mc_state_t mc_current_state = nullptr;
+char mc_replay_mode = false;
 
-__thread mc_comparison_times_t mc_comp_times = NULL;
-__thread double mc_snapshot_comparison_time;
-mc_stats_t mc_stats = NULL;
-mc_global_t initial_global_state = NULL;
-xbt_fifo_t mc_stack = NULL;
+mc_stats_t mc_stats = nullptr;
+mc_global_t initial_global_state = nullptr;
+xbt_fifo_t mc_stack = nullptr;
 
 /* Liveness */
-xbt_automaton_t _mc_property_automaton = NULL;
+
+namespace simgrid {
+namespace mc {
+
+xbt_automaton_t property_automaton = nullptr;
+
+}
+}
 
 /* Dot output */
-FILE *dot_output = NULL;
+FILE *dot_output = nullptr;
 const char *colors[13];
 
 
 /*******************************  Initialisation of MC *******************************/
 /*********************************************************************************/
 
-static void MC_init_dot_output()
+void MC_init_dot_output()
 {                               /* FIXME : more colors */
 
   colors[0] = "blue";
@@ -99,7 +107,7 @@ static void MC_init_dot_output()
 
   dot_output = fopen(_sg_mc_dot_output_file, "w");
 
-  if (dot_output == NULL) {
+  if (dot_output == nullptr) {
     perror("Error open dot output file");
     xbt_abort();
   }
@@ -109,64 +117,24 @@ static void MC_init_dot_output()
 
 }
 
-#ifdef HAVE_MC
+#if HAVE_MC
 void MC_init()
 {
-  mc_time = xbt_new0(double, simix_process_maxpid);
+  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(mc_time, simix_process_maxpid * sizeof(double));
+    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) {
+    xbt_swag_foreach(process, simix_global->process_list)
       MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
-    }
   }
 }
 
-void MC_init_model_checker(pid_t pid, int socket)
-{
-  mc_model_checker = new simgrid::mc::ModelChecker(pid, socket);
-
-  mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
-
-  /* Initialize statistics */
-  mc_stats = xbt_new0(s_mc_stats_t, 1);
-  mc_stats->state_size = 1;
-
-  if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0'))
-    MC_init_dot_output();
-
-  /* Init parmap */
-  //parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
-
-  /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
-  MC_ignore_local_variable("e", "*");
-  MC_ignore_local_variable("__ex_cleanup", "*");
-  MC_ignore_local_variable("__ex_mctx_en", "*");
-  MC_ignore_local_variable("__ex_mctx_me", "*");
-  MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
-  MC_ignore_local_variable("_log_ev", "*");
-  MC_ignore_local_variable("_throw_ctx", "*");
-  MC_ignore_local_variable("ctx", "*");
-
-  MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
-  MC_ignore_local_variable("next_cont"
-    "ext", "smx_ctx_sysv_suspend_serial");
-  MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
-
-  /* Ignore local variable about time used for tracing */
-  MC_ignore_local_variable("start_time", "*");
-
-  /* Static variable used for tracing */
-  MCer_ignore_global_variable("counter");
-
-  /* SIMIX */
-  MCer_ignore_global_variable("smx_total_comms");
-}
 #endif
 
 /*******************************  Core of MC *******************************/
@@ -181,13 +149,12 @@ void MC_run()
 
 void MC_exit(void)
 {
-  xbt_free(mc_time);
-
+  simgrid::mc::processes_time.clear();
   MC_memory_exit();
   //xbt_abort();
 }
 
-#ifdef HAVE_MC
+#if HAVE_MC
 int MC_deadlock_check()
 {
   if (mc_mode == MC_MODE_SERVER) {
@@ -198,28 +165,25 @@ int MC_deadlock_check()
     ssize_t s = mc_model_checker->process().receive_message(message);
     if (s == -1)
       xbt_die("Could not receive message");
-    else if (s != sizeof(message) || message.type != MC_MESSAGE_DEADLOCK_CHECK_REPLY) {
+    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)
         );
-    }
-    else
-      return message.value;
+    return message.value;
   }
 
-  int deadlock = FALSE;
+  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 (MC_process_is_enabled(process)) {
-        deadlock = FALSE;
+    deadlock = true;
+    xbt_swag_foreach(process, simix_global->process_list)
+      if (simgrid::mc::process_is_enabled(process)) {
+        deadlock = false;
         break;
       }
-    }
   }
   return deadlock;
 }
@@ -235,7 +199,7 @@ void MC_replay(xbt_fifo_t stack)
 {
   int value, count = 1;
   char *req_str;
-  smx_simcall_t req = NULL, saved_req = NULL;
+  smx_simcall_t req = nullptr, saved_req = NULL;
   xbt_fifo_item_t item, start_item;
   mc_state_t state;
   
@@ -246,7 +210,7 @@ void MC_replay(xbt_fifo_t stack)
     start_item = xbt_fifo_get_first_item(stack);
     state = (mc_state_t)xbt_fifo_get_item_content(start_item);
     if(state->system_state){
-      MC_restore_snapshot(state->system_state);
+      simgrid::mc::restore_snapshot(state->system_state);
       if(_sg_mc_comms_determinism || _sg_mc_send_determinism) 
         MC_restore_communications_pattern(state);
       return;
@@ -255,7 +219,7 @@ void MC_replay(xbt_fifo_t stack)
 
 
   /* Restore the initial state */
-  MC_restore_snapshot(initial_global_state->snapshot);
+  simgrid::mc::restore_snapshot(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  */
 
@@ -289,7 +253,7 @@ void MC_replay(xbt_fifo_t stack)
 
       /* Debug information */
       if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
-        req_str = MC_request_to_string(req, value, MC_REQUEST_SIMIX);
+        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);
       }
@@ -299,12 +263,12 @@ void MC_replay(xbt_fifo_t stack)
       if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
         call = MC_get_call_type(req);
 
-      MC_simcall_handle(req, value);
+      simgrid::mc::handle_simcall(req, value);
 
       if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
-        MC_handle_comm_pattern(call, req, value, NULL, 1);
+        MC_handle_comm_pattern(call, req, value, nullptr, 1);
 
-      MC_wait_for_requests();
+      mc_model_checker->wait_for_requests();
 
       count++;
     }
@@ -321,9 +285,9 @@ void MC_replay(xbt_fifo_t stack)
 void MC_replay_liveness(xbt_fifo_t stack)
 {
   xbt_fifo_item_t item;
-  mc_pair_t pair = NULL;
-  mc_state_t state = NULL;
-  smx_simcall_t req = NULL, saved_req = NULL;
+  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;
 
@@ -332,22 +296,22 @@ void MC_replay_liveness(xbt_fifo_t stack)
   /* Intermediate backtracking */
   if(_sg_mc_checkpoint > 0) {
     item = xbt_fifo_get_first_item(stack);
-    pair = (mc_pair_t) xbt_fifo_get_item_content(item);
+    pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
     if(pair->graph_state->system_state){
-      MC_restore_snapshot(pair->graph_state->system_state);
+      simgrid::mc::restore_snapshot(pair->graph_state->system_state);
       return;
     }
   }
 
   /* Restore the initial state */
-  MC_restore_snapshot(initial_global_state->snapshot);
+  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 = (mc_pair_t) xbt_fifo_get_item_content(item);
+      pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
 
       state = (mc_state_t) pair->graph_state;
 
@@ -355,7 +319,7 @@ void MC_replay_liveness(xbt_fifo_t stack)
 
         saved_req = MC_state_get_executed_request(state, &value);
 
-        if (saved_req != NULL) {
+        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);
@@ -363,15 +327,15 @@ void MC_replay_liveness(xbt_fifo_t stack)
 
           /* Debug information */
           if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
-            req_str = MC_request_to_string(req, value, MC_REQUEST_SIMIX);
+            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);
           }
 
         }
 
-        MC_simcall_handle(req, value);
-        MC_wait_for_requests();
+        simgrid::mc::handle_simcall(req, value);
+        mc_model_checker->wait_for_requests();
       }
 
       /* Update statistics */
@@ -396,7 +360,7 @@ void MC_dump_stack_safety(xbt_fifo_t stack)
   
   mc_state_t state;
 
-  while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
+  while ((state = (mc_state_t) xbt_fifo_pop(stack)) != nullptr)
     MC_state_delete(state, !state->in_visited_states ? 1 : 0);
 }
 
@@ -407,14 +371,14 @@ void MC_show_stack_safety(xbt_fifo_t stack)
   mc_state_t state;
   xbt_fifo_item_t item;
   smx_simcall_t req;
-  char *req_str = NULL;
+  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 = MC_request_to_string(req, value, MC_REQUEST_EXECUTED);
+      req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
       XBT_INFO("%s", req_str);
       xbt_free(req_str);
     }
@@ -423,12 +387,12 @@ void MC_show_stack_safety(xbt_fifo_t stack)
 
 void MC_show_deadlock(smx_simcall_t req)
 {
-  /*char *req_str = NULL; */
+  /*char *req_str = nullptr; */
   XBT_INFO("**************************");
   XBT_INFO("*** DEAD-LOCK DETECTED ***");
   XBT_INFO("**************************");
   XBT_INFO("Locked request:");
-  /*req_str = MC_request_to_string(req);
+  /*req_str = simgrid::mc::request_to_string(req);
      XBT_INFO("%s", req_str);
      xbt_free(req_str); */
   XBT_INFO("Counter-example execution trace:");
@@ -445,33 +409,37 @@ void MC_show_non_termination(void){
   MC_print_statistics(mc_stats);
 }
 
+namespace simgrid {
+namespace mc {
 
-void MC_show_stack_liveness(xbt_fifo_t stack)
+void show_stack_liveness(xbt_fifo_t stack)
 {
   int value;
-  mc_pair_t pair;
+  simgrid::mc::Pair* pair;
   xbt_fifo_item_t item;
   smx_simcall_t req;
-  char *req_str = NULL;
+  char *req_str = nullptr;
 
   for (item = xbt_fifo_get_last_item(stack);
        item; item = xbt_fifo_get_prev_item(item)) {
-    pair = (mc_pair_t) xbt_fifo_get_item_content(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 = MC_request_to_string(req, value, MC_REQUEST_EXECUTED);
+      req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
       XBT_INFO("%s", req_str);
       xbt_free(req_str);
     }
   }
 }
 
-
-void MC_dump_stack_liveness(xbt_fifo_t stack)
+void dump_stack_liveness(xbt_fifo_t stack)
 {
-  mc_pair_t pair;
-  while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
-    MC_pair_delete(pair);
+  simgrid::mc::Pair* pair;
+  while ((pair = (simgrid::mc::Pair*) xbt_fifo_pop(stack)) != nullptr)
+    delete pair;
+}
+
+}
 }
 
 void MC_print_statistics(mc_stats_t stats)
@@ -498,55 +466,37 @@ void MC_print_statistics(mc_stats_t stats)
     XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
   }
   XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
-  if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0')) {
+  if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0')) {
     fprintf(dot_output, "}\n");
     fclose(dot_output);
   }
-  if (initial_global_state != NULL && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
+  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 (_sg_mc_comms_determinism)
       XBT_INFO("Recv-deterministic : %s", !initial_global_state->recv_deterministic ? "No" : "Yes");
   }
+  if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
+    int ret=system("free");
+    if(ret!=0)XBT_WARN("system call did not return 0, but %d",ret);
+  }
 }
 
 void MC_automaton_load(const char *file)
 {
-  if (_mc_property_automaton == NULL)
-    _mc_property_automaton = xbt_automaton_new();
-
-  xbt_automaton_load(_mc_property_automaton, file);
-}
-
-void MC_automaton_new_propositional_symbol(const char *id, int(*fct)(void))
-{
-  xbt_die("Support for client-side function proposition is not implemented: "
-    "use MC_automaton_new_propositional_symbol_pointer instead."
-  );
-}
+  if (simgrid::mc::property_automaton == nullptr)
+    simgrid::mc::property_automaton = xbt_automaton_new();
 
-void MC_automaton_new_propositional_symbol_pointer(const char *name, int* value)
-{
-  xbt_assert(mc_mode != MC_MODE_SERVER);
-  if (mc_mode != MC_MODE_CLIENT)
-    return;
-  s_mc_register_symbol_message_t message;
-  message.type = MC_MESSAGE_REGISTER_SYMBOL;
-  if (strlen(name) + 1 > sizeof(message.name))
-    xbt_die("Symbol is too long");
-  strncpy(message.name, name, sizeof(message.name));
-  message.callback = nullptr;
-  message.data = value;
-  MC_client_send_message(&message, sizeof(message));
+  xbt_automaton_load(simgrid::mc::property_automaton, file);
 }
 
 // TODO, fix cross-process access (this function is not used)
-void MC_dump_stacks(FILE* file)
+static void MC_dump_stacks(FILE* file)
 {
   int nstack = 0;
-  stack_region_t current_stack;
-  unsigned cursor;
-  xbt_dynar_foreach(stacks_areas, cursor, current_stack) {
-    unw_context_t * context = (unw_context_t *)current_stack->context;
+  for (auto const& stack : mc_model_checker->process().stack_areas()) {
+
+    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;
@@ -562,7 +512,7 @@ void MC_dump_stacks(FILE* file)
       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, rip, rsp);
+        nframe, name, (std::uint64_t) rip, (std::uint64_t) rsp);
 #else
       fprintf(file, "  %i: %s\n", nframe, name);
 #endif
@@ -576,22 +526,19 @@ void MC_dump_stacks(FILE* file)
 
 double MC_process_clock_get(smx_process_t process)
 {
-  if (mc_time) {
-    if (process != NULL)
-      return mc_time[process->pid];
-    else
-      return -1;
-  } else {
+  if (simgrid::mc::processes_time.empty())
     return 0;
-  }
+  if (process != nullptr)
+    return simgrid::mc::processes_time[process->pid];
+  return -1;
 }
 
 void MC_process_clock_add(smx_process_t process, double amount)
 {
-  mc_time[process->pid] += amount;
+  simgrid::mc::processes_time[process->pid] += amount;
 }
 
-#ifdef HAVE_MC
+#if HAVE_MC
 void MC_report_assertion_error(void)
 {
   XBT_INFO("**************************");
@@ -603,11 +550,23 @@ void MC_report_assertion_error(void)
   MC_print_statistics(mc_stats);
 }
 
-void MC_invalidate_cache(void)
+void MC_report_crash(int status)
 {
-  if (mc_model_checker)
-    mc_model_checker->process().cache_flags = 0;
+  XBT_INFO("**************************");
+  XBT_INFO("** CRASH IN THE PROGRAM **");
+  XBT_INFO("**************************");
+  if (WIFSIGNALED(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.");
+  XBT_INFO("Counter-example execution trace:");
+  MC_record_dump_path(mc_stack);
+  MC_dump_stack_safety(mc_stack);
+  MC_print_statistics(mc_stats);
 }
-#endif
 
-}
+#endif