src/mc/VisitedState.cpp

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