src/mc/checker/LivenessChecker.hpp

   1 /* Copyright (c) 2007-2021. 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 #ifndef SIMGRID_MC_LIVENESS_CHECKER_HPP
   8 #define SIMGRID_MC_LIVENESS_CHECKER_HPP
   9
  10 #include "src/mc/checker/Checker.hpp"
  11 #include "src/mc/mc_state.hpp"
  12 #include "xbt/automaton.hpp"
  13
  14 #include <list>
  15 #include <memory>
  16 #include <vector>
  17
  18 namespace simgrid {
  19 namespace mc {
  20
  21 class XBT_PRIVATE Pair {
  22 public:
  23   int num = 0;
  24   bool search_cycle = false;
  25   std::shared_ptr<State> graph_state    = nullptr; /* System state included */
  26   xbt_automaton_state_t automaton_state = nullptr;
  27   std::shared_ptr<const std::vector<int>> atomic_propositions;
  28   int requests = 0;
  29   int depth = 0;
  30   bool exploration_started = false;
  31
  32   explicit Pair(unsigned long expanded_pairs);
  33   ~Pair() = default;
  34
  35   Pair(Pair const&) = delete;
  36   Pair& operator=(Pair const&) = delete;
  37 };
  38
  39 class XBT_PRIVATE VisitedPair {
  40 public:
  41   int num;
  42   int other_num = 0; /* Dot output for */
  43   std::shared_ptr<State> graph_state = nullptr; /* System state included */
  44   xbt_automaton_state_t automaton_state;
  45   std::shared_ptr<const std::vector<int>> atomic_propositions;
  46   std::size_t heap_bytes_used = 0;
  47   int actors_count            = 0;
  48
  49   VisitedPair(int pair_num, xbt_automaton_state_t automaton_state,
  50               std::shared_ptr<const std::vector<int>> atomic_propositions, std::shared_ptr<State> graph_state);
  51   ~VisitedPair() = default;
  52 };
  53
  54 class XBT_PRIVATE LivenessChecker : public Checker {
  55 public:
  56   explicit LivenessChecker();
  57   ~LivenessChecker() override = default;
  58   void run() override;
  59   RecordTrace get_record_trace() override;
  60   std::vector<std::string> get_textual_trace() override;
  61   void log_state() override;
  62
  63 private:
  64   std::shared_ptr<const std::vector<int>> get_proposition_values() const;
  65   std::shared_ptr<VisitedPair> insert_acceptance_pair(Pair* pair);
  66   int insert_visited_pair(std::shared_ptr<VisitedPair> visited_pair, Pair* pair);
  67   void show_acceptance_cycle(std::size_t depth);
  68   void replay();
  69   void remove_acceptance_pair(int pair_num);
  70   void purge_visited_pairs();
  71   void backtrack();
  72   std::shared_ptr<Pair> create_pair(const Pair* pair, xbt_automaton_state_t state,
  73                                     std::shared_ptr<const std::vector<int>> propositions);
  74
  75   // A stack of (application_state, automaton_state) pairs for DFS exploration:
  76   std::list<std::shared_ptr<Pair>> exploration_stack_;
  77   std::list<std::shared_ptr<VisitedPair>> acceptance_pairs_;
  78   std::list<std::shared_ptr<VisitedPair>> visited_pairs_;
  79   unsigned long visited_pairs_count_   = 0;
  80   unsigned long expanded_pairs_count_  = 0;
  81   unsigned long expanded_states_count_ = 0;
  82   int previous_pair_                   = 0;
  83   std::string previous_request_;
  84 };
  85
  86 } // namespace mc
  87 } // namespace simgrid
  88
  89 #endif