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 / SafetyChecker.cpp
index 9848af7..182ff28 100644 (file)
@@ -5,9 +5,10 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include <cassert>
-
 #include <cstdio>
 
+#include <list>
+
 #include <xbt/log.h>
 #include <xbt/dynar.h>
 #include <xbt/dynar.hpp>
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_safety, mc,
                                 "Logging specific to MC safety verification ");
 
+/** Stack (of `simgrid::mc::State*`) representing the current position of the
+ *  the MC in the exploration graph
+ *
+ *  It is managed by its head (`xbt_fifo_shift` and `xbt_fifo_unshift`).
+ */
+XBT_PRIVATE static std::list<simgrid::mc::State*> mc_stack;
+
 namespace simgrid {
 namespace mc {
 
@@ -53,46 +61,33 @@ static int snapshot_compare(simgrid::mc::State* state1, simgrid::mc::State* stat
   return snapshot_compare(num1, s1, num2, s2);
 }
 
-static int is_exploration_stack_state(simgrid::mc::State* current_state){
-
-  xbt_fifo_item_t item;
-  simgrid::mc::State* stack_state;
-  for(item = xbt_fifo_get_first_item(mc_stack); item != nullptr; item = xbt_fifo_get_next_item(item)) {
-    stack_state = (simgrid::mc::State*) xbt_fifo_get_item_content(item);
-    if(snapshot_compare(stack_state, current_state) == 0){
-      XBT_INFO("Non-progressive cycle : state %d -> state %d", stack_state->num, current_state->num);
+static int is_exploration_stack_state(simgrid::mc::State* current_state)
+{
+  for (auto i = mc_stack.rbegin(); i != mc_stack.rend(); ++i)
+    if(snapshot_compare(*i, current_state) == 0){
+      XBT_INFO("Non-progressive cycle : state %d -> state %d", (*i)->num, current_state->num);
       return 1;
     }
-  }
   return 0;
 }
 
 RecordTrace SafetyChecker::getRecordTrace() // override
 {
   RecordTrace res;
-
-  xbt_fifo_item_t start = xbt_fifo_get_last_item(mc_stack);
-  for (xbt_fifo_item_t item = start; item; item = xbt_fifo_get_prev_item(item)) {
-
-    // Find (pid, value):
-    simgrid::mc::State* state = (simgrid::mc::State*) xbt_fifo_get_item_content(item);
+  for (simgrid::mc::State* state : mc_stack) {
     int value = 0;
     smx_simcall_t saved_req = MC_state_get_executed_request(state, &value);
     const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
     const int pid = issuer->pid;
-
     res.push_back(RecordTraceElement(pid, value));
   }
-
   return res;
 }
 
 std::vector<std::string> SafetyChecker::getTextualTrace() // override
 {
   std::vector<std::string> trace;
-  for (xbt_fifo_item_t item = xbt_fifo_get_last_item(mc_stack);
-       item; item = xbt_fifo_get_prev_item(item)) {
-    simgrid::mc::State* state = (simgrid::mc::State*)xbt_fifo_get_item_content(item);
+  for (simgrid::mc::State* state : mc_stack) {
     int value;
     smx_simcall_t req = MC_state_get_executed_request(state, &value);
     if (req) {
@@ -112,21 +107,20 @@ int SafetyChecker::run()
   char *req_str = nullptr;
   int value;
   smx_simcall_t req = nullptr;
-  simgrid::mc::State* state = nullptr;
   simgrid::mc::State* prev_state = nullptr;
   simgrid::mc::State* next_state = nullptr;
   xbt_fifo_item_t item = nullptr;
   std::unique_ptr<simgrid::mc::VisitedState> visited_state = nullptr;
 
-  while (xbt_fifo_size(mc_stack) > 0) {
+  while (!mc_stack.empty()) {
 
     /* Get current state */
-    state = (simgrid::mc::State*)xbt_fifo_get_item_content(xbt_fifo_get_first_item(mc_stack));
+    simgrid::mc::State* state = mc_stack.back();
 
     XBT_DEBUG("**************************************************");
     XBT_DEBUG
-        ("Exploration depth=%d (state=%p, num %d)(%u interleave, user_max_depth %d)",
-         xbt_fifo_size(mc_stack), state, state->num,
+        ("Exploration depth=%zi (state=%p, num %d)(%u interleave, user_max_depth %d)",
+         mc_stack.size(), state, state->num,
          MC_state_interleave_size(state), user_max_depth_reached);
 
     /* Update statistics */
@@ -134,7 +128,7 @@ int SafetyChecker::run()
 
     /* If there are processes to interleave and the maximum depth has not been reached
        then perform one step of the exploration algorithm */
-    if (xbt_fifo_size(mc_stack) <= _sg_mc_max_depth && !user_max_depth_reached
+    if (mc_stack.size() <= _sg_mc_max_depth && !user_max_depth_reached
         && (req = MC_state_get_request(state, &value)) && visited_state == nullptr) {
 
       req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
@@ -178,8 +172,7 @@ int SafetyChecker::run()
       } else if (dot_output != nullptr)
         std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num, visited_state->other_num == -1 ? visited_state->num : visited_state->other_num, req_str);
 
-
-      xbt_fifo_unshift(mc_stack, next_state);
+      mc_stack.push_back(next_state);
 
       if (dot_output != nullptr)
         xbt_free(req_str);
@@ -189,7 +182,9 @@ int SafetyChecker::run()
       /* The interleave set is empty or the maximum depth is reached, let's back-track */
     } else {
 
-      if ((xbt_fifo_size(mc_stack) > _sg_mc_max_depth) || user_max_depth_reached || visited_state != nullptr) {
+      if (mc_stack.size() > _sg_mc_max_depth
+          || user_max_depth_reached
+          || visited_state != nullptr) {
 
         if (user_max_depth_reached && visited_state == nullptr)
           XBT_DEBUG("User max depth reached !");
@@ -199,11 +194,13 @@ int SafetyChecker::run()
           XBT_DEBUG("State already visited (equal to state %d), exploration stopped on this path.", visited_state->other_num == -1 ? visited_state->num : visited_state->other_num);
 
       } else
-        XBT_DEBUG("There are no more processes to interleave. (depth %d)", xbt_fifo_size(mc_stack) + 1);
+        XBT_DEBUG("There are no more processes to interleave. (depth %zi)",
+          mc_stack.size() + 1);
 
       /* Trash the current state, no longer needed */
-      xbt_fifo_shift(mc_stack);
-      XBT_DEBUG("Delete state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
+      mc_stack.pop_back();
+      XBT_DEBUG("Delete state %d at depth %zi",
+        state->num, mc_stack.size() + 1);
       MC_state_delete(state, !state->in_visited_states ? 1 : 0);
 
       visited_state = nullptr;
@@ -221,14 +218,17 @@ int SafetyChecker::run()
          executed before it. If it does then add it to the interleave set of the
          state that executed that previous request. */
 
-      while ((state = (simgrid::mc::State*) xbt_fifo_shift(mc_stack))) {
+      while (!mc_stack.empty()) {
+        state = mc_stack.back();
+        mc_stack.pop_back();
         if (reductionMode_ == simgrid::mc::ReductionMode::dpor) {
           req = MC_state_get_internal_request(state);
           if (req->call == SIMCALL_MUTEX_LOCK || req->call == SIMCALL_MUTEX_TRYLOCK)
             xbt_die("Mutex is currently not supported with DPOR, "
               "use --cfg=model-check/reduction:none");
           const smx_process_t issuer = MC_smx_simcall_get_issuer(req);
-          xbt_fifo_foreach(mc_stack, item, prev_state, simgrid::mc::State*) {
+          for (auto i = mc_stack.rbegin(); i != mc_stack.rend(); ++i) {
+            simgrid::mc::State* prev_state = *i;
             if (reductionMode_ != simgrid::mc::ReductionMode::none
                 && simgrid::mc::request_depend(req, MC_state_get_internal_request(prev_state))) {
               if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
@@ -268,15 +268,19 @@ int SafetyChecker::run()
           }
         }
 
-        if (MC_state_interleave_size(state) && xbt_fifo_size(mc_stack) < _sg_mc_max_depth) {
+        if (MC_state_interleave_size(state)
+            && mc_stack.size() < _sg_mc_max_depth) {
           /* We found a back-tracking point, let's loop */
-          XBT_DEBUG("Back-tracking to state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
-          xbt_fifo_unshift(mc_stack, state);
-          MC_replay(mc_stack);
-          XBT_DEBUG("Back-tracking to state %d at depth %d done", state->num, xbt_fifo_size(mc_stack));
+          XBT_DEBUG("Back-tracking to state %d at depth %zi",
+            state->num, mc_stack.size() + 1);
+          mc_stack.push_back(state);
+          simgrid::mc::replay(mc_stack);
+          XBT_DEBUG("Back-tracking to state %d at depth %zi done",
+            state->num, mc_stack.size());
           break;
         } else {
-          XBT_DEBUG("Delete state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
+          XBT_DEBUG("Delete state %d at depth %zi",
+            state->num, mc_stack.size() + 1);
           MC_state_delete(state, !state->in_visited_states ? 1 : 0);
         }
       }
@@ -306,7 +310,7 @@ void SafetyChecker::init()
   XBT_DEBUG("Starting the safety algorithm");
 
   /* Create exploration stack */
-  mc_stack = xbt_fifo_new();
+  mc_stack.clear();
 
   simgrid::mc::visited_states.clear();
 
@@ -326,7 +330,7 @@ void SafetyChecker::init()
         break;
     }
 
-  xbt_fifo_unshift(mc_stack, initial_state);
+  mc_stack.push_back(initial_state);
 
   /* Save the initial state */
   initial_global_state = std::unique_ptr<s_mc_global_t>(new s_mc_global_t());