1 /* Copyright (c) 2011-2022. The SimGrid Team. All rights reserved. */
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. */
6 #include "src/mc/VisitedState.hpp"
7 #include "src/mc/mc_private.hpp"
12 #include <boost/range/algorithm.hpp>
13 #include "src/mc/api.hpp"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_VisitedState, mc, "Logging specific to state equality detection mechanisms");
17 namespace simgrid::mc {
19 /** @brief Save the current state */
20 VisitedState::VisitedState(unsigned long state_number) : num(state_number)
22 this->heap_bytes_used = Api::get().get_remote_heap_bytes();
23 this->actors_count = mc_model_checker->get_remote_process().actors().size();
24 this->system_state = std::make_shared<simgrid::mc::Snapshot>(state_number);
27 void VisitedStates::prune()
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());
36 states_.erase(min_element);
37 XBT_DEBUG("Remove visited state (maximum number of stored states reached)");
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)
45 auto new_state = std::make_unique<simgrid::mc::VisitedState>(state_number);
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());
50 auto [range_begin, range_end] = boost::range::equal_range(states_, new_state.get(), Api::get().compare_pair());
52 if (compare_snapshots)
53 for (auto i = range_begin; i != range_end; ++i) {
54 auto& visited_state = *i;
55 if (Api::get().snapshot_equal(visited_state->system_state.get(), new_state->system_state.get())) {
56 // The state has been visited:
58 std::unique_ptr<simgrid::mc::VisitedState> old_state =
59 std::move(visited_state);
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;
66 if (dot_output == nullptr)
67 XBT_DEBUG("State %ld already visited ! (equal to state %ld)", new_state->num, old_state->num);
69 XBT_DEBUG("State %ld already visited ! (equal to state %ld (state %ld in dot_output))", new_state->num,
70 old_state->num, new_state->original_num);
72 /* Replace the old state with the new one (with a bigger num)
73 (when the max number of visited states is reached, the oldest
74 one is removed according to its number (= with the min number) */
75 XBT_DEBUG("Replace visited state %ld with the new visited state %ld", old_state->num, new_state->num);
77 visited_state = std::move(new_state);
82 XBT_DEBUG("Insert new visited state %ld (total : %lu)", new_state->num, (unsigned long)states_.size());
83 states_.insert(range_begin, std::move(new_state));
88 } // namespace simgrid::mc