src/mc/VisitedState.cpp

   1 /* Copyright (c) 2011-2022. 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 "src/mc/VisitedState.hpp"
   7 #include "src/mc/mc_private.hpp"
   8
   9 #include <unistd.h>
  10 #include <sys/wait.h>
  11 #include <memory>
  12 #include <boost/range/algorithm.hpp>
  13 #include "src/mc/api.hpp"
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_VisitedState, mc, "Logging specific to state equality detection mechanisms");
  16
  17 namespace simgrid::mc {
  18
  19 /** @brief Save the current state */
  20 VisitedState::VisitedState(unsigned long state_number, unsigned int actor_count)
  21     : actor_count_(actor_count), num(state_number)
  22 {
  23   this->heap_bytes_used = mc_model_checker->get_remote_process().get_remote_heap_bytes();
  24   this->system_state = std::make_shared<simgrid::mc::Snapshot>(state_number);
  25 }
  26
  27 void VisitedStates::prune()
  28 {
  29   while (states_.size() > (std::size_t)_sg_mc_max_visited_states) {
  30     XBT_DEBUG("Try to remove visited state (maximum number of stored states reached)");
  31     auto min_element = boost::range::min_element(
  32         states_, [](const std::unique_ptr<simgrid::mc::VisitedState>& a,
  33                     const std::unique_ptr<simgrid::mc::VisitedState>& b) { return a->num < b->num; });
  34     xbt_assert(min_element != states_.end());
  35     // and drop it:
  36     states_.erase(min_element);
  37     XBT_DEBUG("Remove visited state (maximum number of stored states reached)");
  38   }
  39 }
  40
  41 /** @brief Checks whether a given state has already been visited by the algorithm. */
  42 std::unique_ptr<simgrid::mc::VisitedState>
  43 VisitedStates::addVisitedState(unsigned long state_number, simgrid::mc::State* graph_state, bool compare_snapshots)
  44 {
  45   auto new_state = std::make_unique<simgrid::mc::VisitedState>(state_number, graph_state->get_actor_count());
  46   graph_state->set_system_state(new_state->system_state);
  47   XBT_DEBUG("Snapshot %p of visited state %ld (exploration stack state %ld)", new_state->system_state.get(),
  48             new_state->num, graph_state->get_num());
  49
  50   auto [range_begin, range_end] = boost::range::equal_range(states_, new_state.get(), Api::get().compare_pair());
  51
  52   if (compare_snapshots)
  53     for (auto i = range_begin; i != range_end; ++i) {
  54       auto& visited_state = *i;
  55       if (*visited_state->system_state.get() == *new_state->system_state.get()) {
  56         // The state has been visited:
  57
  58         std::unique_ptr<simgrid::mc::VisitedState> old_state =
  59           std::move(visited_state);
  60
  61         if (old_state->original_num == -1) // I'm the copy of an original process
  62           new_state->original_num = old_state->num;
  63         else // I'm the copy of a copy
  64           new_state->original_num = old_state->original_num;
  65
  66         XBT_DEBUG("State %ld already visited ! (equal to state %ld (state %ld in dot_output))", new_state->num,
  67                   old_state->num, new_state->original_num);
  68
  69         /* Replace the old state with the new one (with a bigger num)
  70            (when the max number of visited states is reached,  the oldest
  71            one is removed according to its number (= with the min number) */
  72         XBT_DEBUG("Replace visited state %ld with the new visited state %ld", old_state->num, new_state->num);
  73
  74         visited_state = std::move(new_state);
  75         return old_state;
  76       }
  77     }
  78
  79   XBT_DEBUG("Insert new visited state %ld (total : %lu)", new_state->num, (unsigned long)states_.size());
  80   states_.insert(range_begin, std::move(new_state));
  81   this->prune();
  82   return nullptr;
  83 }
  84
  85 } // namespace simgrid::mc