1 /* Copyright (c) 2007-2023. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #ifndef SIMGRID_MC_LIVENESS_CHECKER_HPP
8 #define SIMGRID_MC_LIVENESS_CHECKER_HPP
10 #include "src/mc/api/State.hpp"
11 #include "src/mc/explo/Exploration.hpp"
12 #include "xbt/automaton.hpp"
18 namespace simgrid::mc {
20 class XBT_PRIVATE Pair {
23 bool search_cycle = false;
24 std::shared_ptr<State> app_state_ = nullptr; /* State of the application (including system state) */
25 xbt_automaton_state_t prop_state_ = nullptr; /* State of the property automaton */
26 std::shared_ptr<const std::vector<int>> atomic_propositions;
29 bool exploration_started = false;
31 explicit Pair(unsigned long expanded_pairs);
33 Pair(Pair const&) = delete;
34 Pair& operator=(Pair const&) = delete;
37 class XBT_PRIVATE VisitedPair {
40 int other_num = 0; /* Dot output for */
41 std::shared_ptr<State> app_state_ = nullptr; /* State of the application (including system state) */
42 xbt_automaton_state_t prop_state_; /* State of the property automaton */
43 std::shared_ptr<const std::vector<int>> atomic_propositions;
44 std::size_t heap_bytes_used = 0;
47 VisitedPair(int pair_num, xbt_automaton_state_t prop_state,
48 std::shared_ptr<const std::vector<int>> atomic_propositions, std::shared_ptr<State> app_state,
49 RemoteApp& remote_app);
52 class XBT_PRIVATE LivenessChecker : public Exploration {
54 explicit LivenessChecker(const std::vector<char*>& args);
55 ~LivenessChecker() override;
58 RecordTrace get_record_trace() override;
59 std::vector<std::string> get_textual_trace() override;
60 void log_state() override;
63 std::shared_ptr<const std::vector<int>> get_proposition_values() const;
64 std::shared_ptr<VisitedPair> insert_acceptance_pair(Pair* pair);
65 int insert_visited_pair(std::shared_ptr<VisitedPair> visited_pair, Pair* pair);
66 void show_acceptance_cycle(std::size_t depth);
68 void remove_acceptance_pair(int pair_num);
69 void purge_visited_pairs();
71 std::shared_ptr<Pair> create_pair(const Pair* pair, xbt_automaton_state_t state,
72 std::shared_ptr<const std::vector<int>> propositions);
74 // A stack of (application_state, automaton_state) pairs for DFS exploration:
75 std::list<std::shared_ptr<Pair>> exploration_stack_;
76 std::list<std::shared_ptr<VisitedPair>> acceptance_pairs_;
77 std::list<std::shared_ptr<VisitedPair>> visited_pairs_;
78 unsigned long visited_pairs_count_ = 0;
79 unsigned long expanded_pairs_count_ = 0;
80 int previous_pair_ = 0;
81 std::string previous_request_;
83 /* The property automaton must be a static because it's sometimes used before the explorer is even created.
85 * This can happen if some symbols are created during the application's initialization process, before the first
86 * decision point for the model-checker. Since the first snapshot is taken at the first decision point and since the
87 * explorer is created after the first snapshot, this may result in some symbols being registered even before the
88 * model-checker notices that this is a LivenessChecker to create.
90 * This situation is unfortunate, but I guess that it's the best I can achieve given the state of our initialization
93 static xbt_automaton_t property_automaton_;
94 bool evaluate_label(const xbt_automaton_exp_label* l, std::vector<int> const& values);
97 void automaton_load(const char* file) const;
98 std::vector<int> automaton_propositional_symbol_evaluate() const;
99 std::vector<xbt_automaton_state_t> get_automaton_state() const;
100 int compare_automaton_exp_label(const xbt_automaton_exp_label* l) const;
101 void set_property_automaton(xbt_automaton_state_t const& automaton_state) const;
102 xbt_automaton_exp_label_t get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const;
103 xbt_automaton_state_t get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const;
104 static void automaton_register_symbol(RemoteProcessMemory const& remote_process, const char* name,
105 RemotePtr<int> addr);
108 } // namespace simgrid::mc