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