src/mc/VisitedState.cpp

   1 /* Copyright (c) 2011-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include <unistd.h>
   7 #include <sys/wait.h>
   8
   9 #include <memory>
  10
  11 #include <boost/range/algorithm.hpp>
  12
  13 #include "xbt/log.h"
  14 #include "xbt/sysdep.h"
  15
  16 #include "src/mc/VisitedState.hpp"
  17 #include "src/mc/mc_comm_pattern.hpp"
  18 #include "src/mc/mc_private.hpp"
  19 #include "src/mc/mc_smx.hpp"
  20 #include "src/mc/remote/RemoteClient.hpp"
  21
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_VisitedState, mc, "Logging specific to state equality detection mechanisms");
  23
  24 namespace simgrid {
  25 namespace mc {
  26
  27 static int snapshot_compare(simgrid::mc::VisitedState* state1, simgrid::mc::VisitedState* state2)
  28 {
  29   simgrid::mc::Snapshot* s1 = state1->system_state.get();
  30   simgrid::mc::Snapshot* s2 = state2->system_state.get();
  31   return snapshot_compare(s1, s2);
  32 }
  33
  34 /** @brief Save the current state */
  35 VisitedState::VisitedState(unsigned long state_number) : num(state_number)
  36 {
  37   simgrid::mc::RemoteClient* process = &(mc_model_checker->process());
  38   this->heap_bytes_used = mmalloc_get_bytes_used_remote(
  39     process->get_heap()->heaplimit,
  40     process->get_malloc_info());
  41
  42   this->actors_count = mc_model_checker->process().actors().size();
  43
  44   this->system_state = simgrid::mc::take_snapshot(state_number);
  45   this->original_num = -1;
  46 }
  47
  48 void VisitedStates::prune()
  49 {
  50   while (states_.size() > (std::size_t)_sg_mc_max_visited_states) {
  51     XBT_DEBUG("Try to remove visited state (maximum number of stored states reached)");
  52     auto min_element = boost::range::min_element(states_,
  53       [](std::unique_ptr<simgrid::mc::VisitedState>& a, std::unique_ptr<simgrid::mc::VisitedState>& b) {
  54         return a->num < b->num;
  55       });
  56     xbt_assert(min_element != states_.end());
  57     // and drop it:
  58     states_.erase(min_element);
  59     XBT_DEBUG("Remove visited state (maximum number of stored states reached)");
  60   }
  61 }
  62
  63 /** @brief Checks whether a given state has already been visited by the algorithm. */
  64 std::unique_ptr<simgrid::mc::VisitedState> VisitedStates::addVisitedState(
  65   unsigned long state_number, simgrid::mc::State* graph_state, bool compare_snpashots)
  66 {
  67   std::unique_ptr<simgrid::mc::VisitedState> new_state =
  68     std::unique_ptr<simgrid::mc::VisitedState>(new VisitedState(state_number));
  69   graph_state->system_state = new_state->system_state;
  70   XBT_DEBUG("Snapshot %p of visited state %d (exploration stack state %d)",
  71     new_state->system_state.get(), new_state->num, graph_state->num);
  72
  73   auto range =
  74       boost::range::equal_range(states_, new_state.get(), simgrid::mc::DerefAndCompareByActorsCountAndUsedHeap());
  75
  76   if (compare_snpashots)
  77     for (auto i = range.first; i != range.second; ++i) {
  78       auto& visited_state = *i;
  79       if (snapshot_compare(visited_state.get(), new_state.get()) == 0) {
  80         // The state has been visited:
  81
  82         std::unique_ptr<simgrid::mc::VisitedState> old_state =
  83           std::move(visited_state);
  84
  85         if (old_state->original_num == -1) // I'm the copy of an original process
  86           new_state->original_num = old_state->num;
  87         else // I'm the copy of a copy
  88           new_state->original_num = old_state->original_num;
  89
  90         if (dot_output == nullptr)
  91           XBT_DEBUG("State %d already visited ! (equal to state %d)",
  92                     new_state->num, old_state->num);
  93         else
  94           XBT_DEBUG("State %d already visited ! (equal to state %d (state %d in dot_output))",
  95                     new_state->num, old_state->num, new_state->original_num);
  96
  97         /* Replace the old state with the new one (with a bigger num)
  98            (when the max number of visited states is reached,  the oldest
  99            one is removed according to its number (= with the min number) */
 100         XBT_DEBUG("Replace visited state %d with the new visited state %d",
 101           old_state->num, new_state->num);
 102
 103         visited_state = std::move(new_state);
 104         return old_state;
 105       }
 106     }
 107
 108   XBT_DEBUG("Insert new visited state %d (total : %lu)", new_state->num, (unsigned long) states_.size());
 109   states_.insert(range.first, std::move(new_state));
 110   this->prune();
 111   return nullptr;
 112 }
 113
 114 }
 115 }