1 /* Copyright (c) 2011-2023. 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/explo/LivenessChecker.hpp"
7 #include "src/mc/api/RemoteApp.hpp"
8 #include "src/mc/mc_config.hpp"
9 #include "src/mc/mc_exit.hpp"
10 #include "src/mc/mc_private.hpp"
12 #include <boost/range/algorithm.hpp>
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_liveness, mc, "Logging specific to algorithms for liveness properties verification");
17 /********* Static functions *********/
19 namespace simgrid::mc {
21 VisitedPair::VisitedPair(int pair_num, xbt_automaton_state_t prop_state,
22 std::shared_ptr<const std::vector<int>> atomic_propositions, std::shared_ptr<State> app_state,
23 RemoteApp& remote_app)
24 : num(pair_num), prop_state_(prop_state)
26 auto* memory = remote_app.get_remote_process_memory();
27 this->app_state_ = std::move(app_state);
28 if (not this->app_state_->get_system_state())
29 this->app_state_->set_system_state(std::make_shared<Snapshot>(pair_num, remote_app.get_page_store(), *memory));
30 this->heap_bytes_used = memory->get_remote_heap_bytes();
31 this->actor_count_ = app_state_->get_actor_count();
33 this->atomic_propositions = std::move(atomic_propositions);
36 bool LivenessChecker::evaluate_label(const xbt_automaton_exp_label* l, std::vector<int> const& values)
39 case xbt_automaton_exp_label::AUT_OR:
40 return evaluate_label(l->u.or_and.left_exp, values) || evaluate_label(l->u.or_and.right_exp, values);
41 case xbt_automaton_exp_label::AUT_AND:
42 return evaluate_label(l->u.or_and.left_exp, values) && evaluate_label(l->u.or_and.right_exp, values);
43 case xbt_automaton_exp_label::AUT_NOT:
44 return not evaluate_label(l->u.exp_not, values);
45 case xbt_automaton_exp_label::AUT_PREDICAT:
46 return values.at(compare_automaton_exp_label(l)) != 0;
47 case xbt_automaton_exp_label::AUT_ONE:
50 xbt_die("Unexpected value for automaton");
54 Pair::Pair(unsigned long expanded_pairs) : num(expanded_pairs) {}
56 std::shared_ptr<const std::vector<int>> LivenessChecker::get_proposition_values() const
58 auto values = automaton_propositional_symbol_evaluate();
59 return std::make_shared<const std::vector<int>>(std::move(values));
62 std::shared_ptr<VisitedPair> LivenessChecker::insert_acceptance_pair(simgrid::mc::Pair* pair)
64 auto new_pair = std::make_shared<VisitedPair>(pair->num, pair->prop_state_, pair->atomic_propositions,
65 pair->app_state_, get_remote_app());
68 res_end] = boost::range::equal_range(acceptance_pairs_, new_pair.get(), [](auto const& a, auto const& b) {
69 return std::make_pair(a->actor_count_, a->heap_bytes_used) < std::make_pair(b->actor_count_, b->heap_bytes_used);
72 if (pair->search_cycle)
73 for (auto i = res_begin; i != res_end; ++i) {
74 std::shared_ptr<simgrid::mc::VisitedPair> const& pair_test = *i;
75 if (xbt_automaton_state_compare(pair_test->prop_state_, new_pair->prop_state_) != 0 ||
76 *(pair_test->atomic_propositions) != *(new_pair->atomic_propositions) ||
77 (not pair_test->app_state_->get_system_state()->equals_to(*new_pair->app_state_->get_system_state(),
78 *get_remote_app().get_remote_process_memory())))
80 XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
81 exploration_stack_.pop_back();
82 dot_output("\"%d\" -> \"%d\" [%s];\n", this->previous_pair_, pair_test->num, this->previous_request_.c_str());
86 acceptance_pairs_.insert(res_begin, new_pair);
90 void LivenessChecker::remove_acceptance_pair(int pair_num)
92 for (auto i = acceptance_pairs_.begin(); i != acceptance_pairs_.end(); ++i)
93 if ((*i)->num == pair_num) {
94 acceptance_pairs_.erase(i);
99 void LivenessChecker::replay()
101 XBT_DEBUG("**** Begin Replay ****");
103 /* Intermediate backtracking */
104 if (_sg_mc_checkpoint > 0) {
105 const Pair* pair = exploration_stack_.back().get();
106 if (const auto* system_state = pair->app_state_->get_system_state()) {
107 system_state->restore(*get_remote_app().get_remote_process_memory());
112 get_remote_app().restore_initial_state();
114 /* Traverse the stack from the initial state and re-execute the transitions */
116 for (std::shared_ptr<Pair> const& pair : exploration_stack_) {
117 if (pair == exploration_stack_.back())
120 std::shared_ptr<State> state = pair->app_state_;
122 if (pair->exploration_started) {
123 state->get_transition()->replay(get_remote_app());
124 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, state->get_transition()->to_string().c_str(), state.get());
127 /* Update statistics */
128 visited_pairs_count_++;
131 XBT_DEBUG("**** End Replay ****");
135 * @brief Checks whether a given pair has already been visited by the algorithm.
137 int LivenessChecker::insert_visited_pair(std::shared_ptr<VisitedPair> visited_pair, simgrid::mc::Pair* pair)
139 if (_sg_mc_max_visited_states == 0)
142 if (visited_pair == nullptr)
143 visited_pair = std::make_shared<VisitedPair>(pair->num, pair->prop_state_, pair->atomic_propositions,
144 pair->app_state_, get_remote_app());
147 range_end] = boost::range::equal_range(visited_pairs_, visited_pair.get(), [](auto const& a, auto const& b) {
148 return std::make_pair(a->actor_count_, a->heap_bytes_used) < std::make_pair(b->actor_count_, b->heap_bytes_used);
151 for (auto i = range_begin; i != range_end; ++i) {
152 const VisitedPair* pair_test = i->get();
153 if (xbt_automaton_state_compare(pair_test->prop_state_, visited_pair->prop_state_) != 0 ||
154 *(pair_test->atomic_propositions) != *(visited_pair->atomic_propositions) ||
155 (not pair_test->app_state_->get_system_state()->equals_to(*visited_pair->app_state_->get_system_state(),
156 *get_remote_app().get_remote_process_memory())))
158 if (pair_test->other_num == -1)
159 visited_pair->other_num = pair_test->num;
161 visited_pair->other_num = pair_test->other_num;
162 XBT_DEBUG("Pair %d already visited ! (equal to pair %d (pair %d in dot_output))", visited_pair->num, pair_test->num,
163 visited_pair->other_num);
164 (*i) = std::move(visited_pair);
165 return (*i)->other_num;
168 visited_pairs_.insert(range_begin, std::move(visited_pair));
169 this->purge_visited_pairs();
173 void LivenessChecker::purge_visited_pairs()
175 if (_sg_mc_max_visited_states != 0 && visited_pairs_.size() > (std::size_t)_sg_mc_max_visited_states) {
176 // Remove the oldest entry with a linear search:
177 visited_pairs_.erase(
178 boost::min_element(visited_pairs_, [](std::shared_ptr<VisitedPair> const a,
179 std::shared_ptr<VisitedPair> const& b) { return a->num < b->num; }));
183 LivenessChecker::LivenessChecker(const std::vector<char*>& args) : Exploration(args, true) {}
184 LivenessChecker::~LivenessChecker()
186 xbt_automaton_free(property_automaton_);
189 xbt_automaton_t LivenessChecker::property_automaton_ = nullptr;
191 void LivenessChecker::automaton_load(const char* file) const
193 if (property_automaton_ == nullptr)
194 property_automaton_ = xbt_automaton_new();
196 xbt_automaton_load(property_automaton_, file);
199 std::vector<int> LivenessChecker::automaton_propositional_symbol_evaluate() const
201 unsigned int cursor = 0;
202 std::vector<int> values;
203 xbt_automaton_propositional_symbol_t ps = nullptr;
204 xbt_dynar_foreach (property_automaton_->propositional_symbols, cursor, ps)
205 values.push_back(xbt_automaton_propositional_symbol_evaluate(ps));
209 std::vector<xbt_automaton_state_t> LivenessChecker::get_automaton_state() const
211 std::vector<xbt_automaton_state_t> automaton_stack;
212 unsigned int cursor = 0;
213 xbt_automaton_state_t automaton_state;
214 xbt_dynar_foreach (property_automaton_->states, cursor, automaton_state)
215 if (automaton_state->type == -1)
216 automaton_stack.push_back(automaton_state);
217 return automaton_stack;
220 int LivenessChecker::compare_automaton_exp_label(const xbt_automaton_exp_label* l) const
222 unsigned int cursor = 0;
223 xbt_automaton_propositional_symbol_t p = nullptr;
224 xbt_dynar_foreach (property_automaton_->propositional_symbols, cursor, p) {
225 if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
231 void LivenessChecker::set_property_automaton(xbt_automaton_state_t const& automaton_state) const
233 property_automaton_->current_state = automaton_state;
236 xbt_automaton_exp_label_t LivenessChecker::get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const
238 const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
239 return transition->label;
242 xbt_automaton_state_t LivenessChecker::get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const
244 const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
245 return transition->dst;
247 void LivenessChecker::automaton_register_symbol(RemoteProcessMemory const& remote_process, const char* name,
248 RemotePtr<int> address)
250 if (property_automaton_ == nullptr)
251 property_automaton_ = xbt_automaton_new();
253 xbt::add_proposition(property_automaton_, name,
254 [&remote_process, address]() { return remote_process.read(address); });
257 RecordTrace LivenessChecker::get_record_trace() // override
260 for (std::shared_ptr<Pair> const& pair : exploration_stack_)
261 res.push_back(pair->app_state_->get_transition());
265 void LivenessChecker::log_state() // override
267 XBT_INFO("Expanded pairs = %lu", expanded_pairs_count_);
268 XBT_INFO("Visited pairs = %lu", visited_pairs_count_);
269 XBT_INFO("Executed transitions = %lu", Transition::get_executed_transitions());
270 Exploration::log_state();
273 void LivenessChecker::show_acceptance_cycle(std::size_t depth)
275 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
276 XBT_INFO("| ACCEPTANCE CYCLE |");
277 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
278 XBT_INFO("Counter-example that violates formula:");
279 for (auto const& s : this->get_textual_trace())
280 XBT_INFO(" %s", s.c_str());
281 XBT_INFO("You can debug the problem (and see the whole details) by rerunning out of simgrid-mc with "
282 "--cfg=model-check/replay:'%s'",
283 get_record_trace().to_string().c_str());
285 XBT_INFO("Counter-example depth: %zu", depth);
288 std::vector<std::string> LivenessChecker::get_textual_trace() // override
290 std::vector<std::string> trace;
291 for (std::shared_ptr<Pair> const& pair : exploration_stack_)
292 if (pair->app_state_->get_transition() != nullptr)
293 trace.push_back(pair->app_state_->get_transition()->to_string());
298 std::shared_ptr<Pair> LivenessChecker::create_pair(const Pair* current_pair, xbt_automaton_state_t state,
299 std::shared_ptr<const std::vector<int>> propositions)
301 ++expanded_pairs_count_;
302 auto next_pair = std::make_shared<Pair>(expanded_pairs_count_);
303 next_pair->prop_state_ = state;
304 next_pair->app_state_ = std::make_shared<State>(get_remote_app());
305 next_pair->atomic_propositions = std::move(propositions);
307 next_pair->depth = current_pair->depth + 1;
309 next_pair->depth = 1;
310 /* Add all enabled actors to the interleave set of the initial state */
311 for (auto const& [aid, _] : next_pair->app_state_->get_actors_list())
312 if (next_pair->app_state_->is_actor_enabled(aid))
313 next_pair->app_state_->consider_one(aid);
315 next_pair->requests = next_pair->app_state_->count_todo();
316 /* FIXME : get search_cycle value for each accepting state */
317 if (next_pair->prop_state_->type == 1 || (current_pair && current_pair->search_cycle))
318 next_pair->search_cycle = true;
320 next_pair->search_cycle = false;
324 void LivenessChecker::backtrack()
326 /* Traverse the stack backwards until a pair with a non empty interleave
327 set is found, deleting all the pairs that have it empty in the way. */
328 while (not exploration_stack_.empty()) {
329 std::shared_ptr<simgrid::mc::Pair> current_pair = exploration_stack_.back();
330 exploration_stack_.pop_back();
331 if (current_pair->requests > 0) {
332 /* We found a backtracking point */
333 XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
334 exploration_stack_.push_back(std::move(current_pair));
336 XBT_DEBUG("Backtracking done");
339 XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
340 if (current_pair->prop_state_->type == 1)
341 this->remove_acceptance_pair(current_pair->num);
346 void LivenessChecker::run()
348 XBT_INFO("Check the liveness property %s", _sg_mc_property_file.get().c_str());
349 automaton_load(_sg_mc_property_file.get().c_str());
351 XBT_DEBUG("Starting the liveness algorithm");
354 this->previous_pair_ = 0;
356 std::shared_ptr<const std::vector<int>> propos = this->get_proposition_values();
358 // For each initial state of the property automaton, push a
359 // (application_state, automaton_state) pair to the exploration stack:
360 auto automaton_stack = get_automaton_state();
361 for (auto* automaton_state : automaton_stack) {
362 if (automaton_state->type == -1)
363 exploration_stack_.push_back(this->create_pair(nullptr, automaton_state, propos));
366 /* Actually run the double DFS search for counter-examples */
367 while (not exploration_stack_.empty()) {
368 std::shared_ptr<Pair> current_pair = exploration_stack_.back();
370 /* Update current state in buchi automaton */
371 set_property_automaton(current_pair->prop_state_);
374 "********************* ( Depth = %d, search_cycle = %d, interleave size = %zu, pair_num = %d, requests = %d)",
375 current_pair->depth, current_pair->search_cycle, current_pair->app_state_->count_todo(), current_pair->num,
376 current_pair->requests);
378 if (current_pair->requests == 0) {
383 std::shared_ptr<VisitedPair> reached_pair;
384 if (current_pair->prop_state_->type == 1 && not current_pair->exploration_started) {
385 reached_pair = this->insert_acceptance_pair(current_pair.get());
386 if (reached_pair == nullptr) {
387 this->show_acceptance_cycle(current_pair->depth);
388 throw McError(ExitStatus::LIVENESS);
392 /* Pair already visited ? stop the exploration on the current path */
393 if (not current_pair->exploration_started) {
394 int visited_num = this->insert_visited_pair(reached_pair, current_pair.get());
395 if (visited_num != -1) {
396 dot_output("\"%d\" -> \"%d\" [%s];\n", this->previous_pair_, visited_num, this->previous_request_.c_str());
398 XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
399 current_pair->requests = 0;
405 current_pair->app_state_->execute_next(current_pair->app_state_->next_transition(), get_remote_app());
406 XBT_DEBUG("Execute: %s", current_pair->app_state_->get_transition()->to_string().c_str());
408 /* Update the dot output */
409 if (this->previous_pair_ != 0 && this->previous_pair_ != current_pair->num) {
410 dot_output("\"%d\" -> \"%d\" [%s];\n", this->previous_pair_, current_pair->num, this->previous_request_.c_str());
411 this->previous_request_.clear();
413 this->previous_pair_ = current_pair->num;
414 this->previous_request_ = current_pair->app_state_->get_transition()->dot_string();
415 if (current_pair->search_cycle)
416 dot_output("%d [shape=doublecircle];\n", current_pair->num);
418 if (not current_pair->exploration_started)
419 visited_pairs_count_++;
421 current_pair->requests--;
422 current_pair->exploration_started = true;
424 /* Get values of atomic propositions (variables used in the property formula) */
425 std::shared_ptr<const std::vector<int>> prop_values = this->get_proposition_values();
427 // For each enabled transition in the property automaton, push a
428 // (application_state, automaton_state) pair to the exploration stack:
429 for (int i = xbt_dynar_length(current_pair->prop_state_->out) - 1; i >= 0; i--) {
430 const auto* transition_succ_label = get_automaton_transition_label(current_pair->prop_state_->out, i);
431 auto* transition_succ_dst = get_automaton_transition_dst(current_pair->prop_state_->out, i);
432 if (evaluate_label(transition_succ_label, *prop_values))
433 exploration_stack_.push_back(this->create_pair(current_pair.get(), transition_succ_dst, prop_values));
437 XBT_INFO("No property violation found.");
441 Exploration* create_liveness_checker(const std::vector<char*>& args)
443 return new LivenessChecker(args);
446 } // namespace simgrid::mc