1 /* Copyright (c) 2011-2015. 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. */
14 #include <xbt/automaton.h>
15 #include <xbt/dynar.h>
16 #include <xbt/dynar.hpp>
19 #include <xbt/sysdep.h>
21 #include "src/mc/mc_request.h"
22 #include "src/mc/mc_liveness.h"
23 #include "src/mc/mc_private.h"
24 #include "src/mc/mc_record.h"
25 #include "src/mc/mc_smx.h"
26 #include "src/mc/Client.hpp"
27 #include "src/mc/mc_private.h"
28 #include "src/mc/mc_replay.h"
29 #include "src/mc/mc_safety.h"
30 #include "src/mc/mc_exit.h"
32 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_liveness, mc,
33 "Logging specific to algorithms for liveness properties verification");
35 /********* Global variables *********/
37 xbt_dynar_t acceptance_pairs;
39 /********* Static functions *********/
44 static xbt_dynar_t visited_pairs;
46 Pair::Pair() : num(++mc_stats->expanded_pairs),
47 visited_pair_removed(_sg_mc_visited > 0 ? 0 : 1)
51 if (this->visited_pair_removed)
52 MC_state_delete(this->graph_state, 1);
55 static void show_stack_liveness(xbt_fifo_t stack)
58 simgrid::mc::Pair* pair;
61 char *req_str = nullptr;
63 for (item = xbt_fifo_get_last_item(stack);
64 item; item = xbt_fifo_get_prev_item(item)) {
65 pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
66 req = MC_state_get_executed_request(pair->graph_state, &value);
67 if (req && req->call != SIMCALL_NONE) {
68 req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
69 XBT_INFO("%s", req_str);
75 static void dump_stack_liveness(xbt_fifo_t stack)
77 simgrid::mc::Pair* pair;
78 while ((pair = (simgrid::mc::Pair*) xbt_fifo_pop(stack)) != nullptr)
82 static simgrid::xbt::unique_ptr<s_xbt_dynar_t> get_atomic_propositions_values()
84 unsigned int cursor = 0;
85 xbt_automaton_propositional_symbol_t ps = nullptr;
86 simgrid::xbt::unique_ptr<s_xbt_dynar_t> values = simgrid::xbt::unique_ptr<s_xbt_dynar_t>(xbt_dynar_new(sizeof(int), nullptr));
87 xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, ps) {
88 int res = xbt_automaton_propositional_symbol_evaluate(ps);
89 xbt_dynar_push_as(values.get(), int, res);
91 return std::move(values);
94 static int snapshot_compare(simgrid::mc::VisitedPair* state1, simgrid::mc::VisitedPair* state2)
96 simgrid::mc::Snapshot* s1 = state1->graph_state->system_state;
97 simgrid::mc::Snapshot* s2 = state2->graph_state->system_state;
98 int num1 = state1->num;
99 int num2 = state2->num;
100 return snapshot_compare(num1, s1, num2, s2);
103 static simgrid::mc::VisitedPair* is_reached_acceptance_pair(simgrid::mc::Pair* pair)
105 auto acceptance_pairs = simgrid::xbt::range<simgrid::mc::VisitedPair*>(::acceptance_pairs);
107 simgrid::mc::VisitedPair* new_pair = new VisitedPair(
108 pair->num, pair->automaton_state, pair->atomic_propositions.get(),
110 new_pair->acceptance_pair = 1;
112 auto res = std::equal_range(acceptance_pairs.begin(), acceptance_pairs.end(),
113 new_pair, simgrid::mc::DerefAndCompareByNbProcessesAndUsedHeap());
115 if (pair->search_cycle == 1)
116 for (auto i = res.first; i != res.second; ++i) {
117 simgrid::mc::VisitedPair* pair_test = *i;
118 if (xbt_automaton_state_compare(pair_test->automaton_state, new_pair->automaton_state) == 0) {
119 if (xbt_automaton_propositional_symbols_compare_value(
120 pair_test->atomic_propositions.get(),
121 new_pair->atomic_propositions.get()) == 0) {
122 if (snapshot_compare(pair_test, new_pair) == 0) {
123 XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
124 xbt_fifo_shift(mc_stack);
125 if (dot_output != nullptr)
126 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, pair_test->num, initial_global_state->prev_req);
134 ::acceptance_pairs, res.first - acceptance_pairs.begin(), &new_pair);
138 static void remove_acceptance_pair(int pair_num)
140 unsigned int cursor = 0;
141 simgrid::mc::VisitedPair* pair_test = nullptr;
144 xbt_dynar_foreach(acceptance_pairs, cursor, pair_test)
145 if (pair_test->num == pair_num) {
150 if(pair_found == 1) {
151 xbt_dynar_remove_at(acceptance_pairs, cursor, &pair_test);
153 pair_test->acceptance_removed = 1;
155 if (_sg_mc_visited == 0 || pair_test->visited_removed == 1)
162 static int MC_automaton_evaluate_label(xbt_automaton_exp_label_t l,
163 xbt_dynar_t atomic_propositions_values)
168 int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
169 int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
170 return (left_res || right_res);
173 int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
174 int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
175 return (left_res && right_res);
178 int res = MC_automaton_evaluate_label(l->u.exp_not, atomic_propositions_values);
182 unsigned int cursor = 0;
183 xbt_automaton_propositional_symbol_t p = nullptr;
184 xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
185 if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
186 return (int) xbt_dynar_get_as(atomic_propositions_values, cursor, int);
197 static void MC_pre_modelcheck_liveness(void)
199 simgrid::mc::Pair* initial_pair = nullptr;
200 mc_model_checker->wait_for_requests();
201 acceptance_pairs = xbt_dynar_new(sizeof(simgrid::mc::VisitedPair*), nullptr);
202 if(_sg_mc_visited > 0)
203 simgrid::mc::visited_pairs = xbt_dynar_new(sizeof(simgrid::mc::VisitedPair*), nullptr);
205 initial_global_state->snapshot = simgrid::mc::take_snapshot(0);
206 initial_global_state->prev_pair = 0;
208 unsigned int cursor = 0;
209 xbt_automaton_state_t automaton_state;
211 xbt_dynar_foreach(simgrid::mc::property_automaton->states, cursor, automaton_state) {
212 if (automaton_state->type == -1) { /* Initial automaton state */
214 initial_pair = new Pair();
215 initial_pair->automaton_state = automaton_state;
216 initial_pair->graph_state = MC_state_new();
217 initial_pair->atomic_propositions = get_atomic_propositions_values();
218 initial_pair->depth = 1;
220 /* Get enabled processes and insert them in the interleave set of the graph_state */
221 for (auto& p : mc_model_checker->process().simix_processes())
222 if (simgrid::mc::process_is_enabled(&p.copy))
223 MC_state_interleave_process(initial_pair->graph_state, &p.copy);
225 initial_pair->requests = MC_state_interleave_size(initial_pair->graph_state);
226 initial_pair->search_cycle = 0;
228 xbt_fifo_unshift(mc_stack, initial_pair);
233 static void MC_replay_liveness(xbt_fifo_t stack)
235 xbt_fifo_item_t item;
236 simgrid::mc::Pair* pair = nullptr;
237 mc_state_t state = nullptr;
238 smx_simcall_t req = nullptr, saved_req = NULL;
239 int value, depth = 1;
242 XBT_DEBUG("**** Begin Replay ****");
244 /* Intermediate backtracking */
245 if(_sg_mc_checkpoint > 0) {
246 item = xbt_fifo_get_first_item(stack);
247 pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
248 if(pair->graph_state->system_state){
249 simgrid::mc::restore_snapshot(pair->graph_state->system_state);
254 /* Restore the initial state */
255 simgrid::mc::restore_snapshot(initial_global_state->snapshot);
257 /* Traverse the stack from the initial state and re-execute the transitions */
258 for (item = xbt_fifo_get_last_item(stack);
259 item != xbt_fifo_get_first_item(stack);
260 item = xbt_fifo_get_prev_item(item)) {
262 pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
264 state = (mc_state_t) pair->graph_state;
266 if (pair->exploration_started) {
268 saved_req = MC_state_get_executed_request(state, &value);
270 if (saved_req != nullptr) {
271 /* because we got a copy of the executed request, we have to fetch the
272 real one, pointed by the request field of the issuer process */
273 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
274 req = &issuer->simcall;
276 /* Debug information */
277 if (XBT_LOG_ISENABLED(mc_liveness, xbt_log_priority_debug)) {
278 req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
279 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
285 simgrid::mc::handle_simcall(req, value);
286 mc_model_checker->wait_for_requests();
289 /* Update statistics */
290 mc_stats->visited_pairs++;
291 mc_stats->executed_transitions++;
297 XBT_DEBUG("**** End Replay ****");
301 * \brief Checks whether a given pair has already been visited by the algorithm.
304 int is_visited_pair(simgrid::mc::VisitedPair* visited_pair, simgrid::mc::Pair* pair)
306 if (_sg_mc_visited == 0)
309 simgrid::mc::VisitedPair* new_visited_pair = nullptr;
310 if (visited_pair == nullptr)
311 new_visited_pair = new simgrid::mc::VisitedPair(
312 pair->num, pair->automaton_state, pair->atomic_propositions.get(),
315 new_visited_pair = visited_pair;
317 if (xbt_dynar_is_empty(visited_pairs)) {
318 xbt_dynar_push(visited_pairs, &new_visited_pair);
322 int min = -1, max = -1, index;
324 simgrid::mc::VisitedPair* pair_test;
327 index = get_search_interval(
328 (simgrid::mc::VisitedPair**) xbt_dynar_get_ptr(visited_pairs, 0),
329 xbt_dynar_length(visited_pairs), new_visited_pair, &min, &max);
331 if (min != -1 && max != -1) { // Visited pair with same number of processes and same heap bytes used exists
333 while (cursor <= max) {
334 pair_test = (simgrid::mc::VisitedPair*) xbt_dynar_get_as(visited_pairs, cursor, simgrid::mc::VisitedPair*);
335 if (xbt_automaton_state_compare(pair_test->automaton_state, new_visited_pair->automaton_state) == 0) {
336 if (xbt_automaton_propositional_symbols_compare_value(
337 pair_test->atomic_propositions.get(),
338 new_visited_pair->atomic_propositions.get()) == 0) {
339 if (snapshot_compare(pair_test, new_visited_pair) == 0) {
340 if (pair_test->other_num == -1)
341 new_visited_pair->other_num = pair_test->num;
343 new_visited_pair->other_num = pair_test->other_num;
344 if (dot_output == nullptr)
345 XBT_DEBUG("Pair %d already visited ! (equal to pair %d)", new_visited_pair->num, pair_test->num);
347 XBT_DEBUG("Pair %d already visited ! (equal to pair %d (pair %d in dot_output))", new_visited_pair->num, pair_test->num, new_visited_pair->other_num);
348 xbt_dynar_remove_at(visited_pairs, cursor, &pair_test);
349 xbt_dynar_insert_at(visited_pairs, cursor, &new_visited_pair);
350 pair_test->visited_removed = 1;
351 if (!pair_test->acceptance_pair
352 || pair_test->acceptance_removed == 1)
354 return new_visited_pair->other_num;
360 xbt_dynar_insert_at(visited_pairs, min, &new_visited_pair);
362 xbt_dynar_insert_at(visited_pairs, index, &new_visited_pair);
365 if ((ssize_t) xbt_dynar_length(visited_pairs) > _sg_mc_visited) {
366 int min2 = mc_stats->expanded_pairs;
367 unsigned int cursor2 = 0;
368 unsigned int index2 = 0;
369 xbt_dynar_foreach(visited_pairs, cursor2, pair_test) {
370 if (!mc_model_checker->is_important_snapshot(*pair_test->graph_state->system_state)
371 && pair_test->num < min2) {
373 min2 = pair_test->num;
376 xbt_dynar_remove_at(visited_pairs, index2, &pair_test);
377 pair_test->visited_removed = 1;
378 if (!pair_test->acceptance_pair || pair_test->acceptance_removed)
384 static int MC_modelcheck_liveness_main(void)
386 simgrid::mc::Pair* current_pair = nullptr;
387 int value, res, visited_num = -1;
388 smx_simcall_t req = nullptr;
389 xbt_automaton_transition_t transition_succ = nullptr;
391 simgrid::mc::Pair* next_pair = nullptr;
392 simgrid::xbt::unique_ptr<s_xbt_dynar_t> prop_values;
393 simgrid::mc::VisitedPair* reached_pair = nullptr;
395 while(xbt_fifo_size(mc_stack) > 0){
397 /* Get current pair */
398 current_pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(xbt_fifo_get_first_item(mc_stack));
400 /* Update current state in buchi automaton */
401 simgrid::mc::property_automaton->current_state = current_pair->automaton_state;
403 XBT_DEBUG("********************* ( Depth = %d, search_cycle = %d, interleave size = %d, pair_num = %d, requests = %d)",
404 current_pair->depth, current_pair->search_cycle,
405 MC_state_interleave_size(current_pair->graph_state), current_pair->num,
406 current_pair->requests);
408 if (current_pair->requests > 0) {
410 if (current_pair->automaton_state->type == 1 && current_pair->exploration_started == 0) {
411 /* If new acceptance pair, return new pair */
412 if ((reached_pair = is_reached_acceptance_pair(current_pair)) == nullptr) {
413 int counter_example_depth = current_pair->depth;
414 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
415 XBT_INFO("| ACCEPTANCE CYCLE |");
416 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
417 XBT_INFO("Counter-example that violates formula :");
418 MC_record_dump_path(mc_stack);
419 simgrid::mc::show_stack_liveness(mc_stack);
420 simgrid::mc::dump_stack_liveness(mc_stack);
421 MC_print_statistics(mc_stats);
422 XBT_INFO("Counter-example depth : %d", counter_example_depth);
423 return SIMGRID_MC_EXIT_LIVENESS;
427 /* Pair already visited ? stop the exploration on the current path */
428 if ((current_pair->exploration_started == 0)
429 && (visited_num = simgrid::mc::is_visited_pair(
430 reached_pair, current_pair)) != -1) {
432 if (dot_output != nullptr){
433 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, visited_num, initial_global_state->prev_req);
437 XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
438 current_pair->requests = 0;
443 req = MC_state_get_request(current_pair->graph_state, &value);
445 if (dot_output != nullptr) {
446 if (initial_global_state->prev_pair != 0 && initial_global_state->prev_pair != current_pair->num) {
447 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, current_pair->num, initial_global_state->prev_req);
448 xbt_free(initial_global_state->prev_req);
450 initial_global_state->prev_pair = current_pair->num;
451 initial_global_state->prev_req = simgrid::mc::request_get_dot_output(req, value);
452 if (current_pair->search_cycle)
453 fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
457 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
458 XBT_DEBUG("Execute: %s", req_str);
461 /* Set request as executed */
462 MC_state_set_executed_request(current_pair->graph_state, req, value);
464 /* Update mc_stats */
465 mc_stats->executed_transitions++;
466 if(current_pair->exploration_started == 0)
467 mc_stats->visited_pairs++;
469 /* Answer the request */
470 simgrid::mc::handle_simcall(req, value);
472 /* Wait for requests (schedules processes) */
473 mc_model_checker->wait_for_requests();
475 current_pair->requests--;
476 current_pair->exploration_started = 1;
478 /* Get values of atomic propositions (variables used in the property formula) */
479 prop_values = get_atomic_propositions_values();
481 /* Evaluate enabled/true transitions in automaton according to atomic propositions values and create new pairs */
482 cursor = xbt_dynar_length(current_pair->automaton_state->out) - 1;
483 while (cursor >= 0) {
484 transition_succ = (xbt_automaton_transition_t)xbt_dynar_get_as(current_pair->automaton_state->out, cursor, xbt_automaton_transition_t);
485 res = MC_automaton_evaluate_label(transition_succ->label, prop_values.get());
486 if (res == 1 || res == 2) { /* 1 = True transition (always enabled), 2 = enabled transition according to atomic prop values */
487 next_pair = new Pair();
488 next_pair->graph_state = MC_state_new();
489 next_pair->automaton_state = transition_succ->dst;
490 next_pair->atomic_propositions = get_atomic_propositions_values();
491 next_pair->depth = current_pair->depth + 1;
492 /* Get enabled processes and insert them in the interleave set of the next graph_state */
493 for (auto& p : mc_model_checker->process().simix_processes())
494 if (simgrid::mc::process_is_enabled(&p.copy))
495 MC_state_interleave_process(next_pair->graph_state, &p.copy);
497 next_pair->requests = MC_state_interleave_size(next_pair->graph_state);
499 /* FIXME : get search_cycle value for each acceptant state */
500 if (next_pair->automaton_state->type == 1 || current_pair->search_cycle)
501 next_pair->search_cycle = 1;
503 /* Add new pair to the exploration stack */
504 xbt_fifo_unshift(mc_stack, next_pair);
510 } /* End of visited_pair test */
515 if(visited_num == -1)
516 XBT_DEBUG("No more request to execute. Looking for backtracking point.");
520 /* Traverse the stack backwards until a pair with a non empty interleave
521 set is found, deleting all the pairs that have it empty in the way. */
522 while ((current_pair = (simgrid::mc::Pair*) xbt_fifo_shift(mc_stack)) != nullptr) {
523 if (current_pair->requests > 0) {
524 /* We found a backtracking point */
525 XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
526 xbt_fifo_unshift(mc_stack, current_pair);
527 MC_replay_liveness(mc_stack);
528 XBT_DEBUG("Backtracking done");
532 XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
533 if (current_pair->automaton_state->type == 1)
534 remove_acceptance_pair(current_pair->num);
539 } /* End of if (current_pair->requests > 0) else ... */
541 } /* End of while(xbt_fifo_size(mc_stack) > 0) */
543 XBT_INFO("No property violation found.");
544 MC_print_statistics(mc_stats);
545 return SIMGRID_MC_EXIT_SUCCESS;
548 int modelcheck_liveness(void)
550 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
551 MC_automaton_load(_sg_mc_property_file);
552 mc_model_checker->wait_for_requests();
554 XBT_DEBUG("Starting the liveness algorithm");
557 /* Create exploration stack */
558 mc_stack = xbt_fifo_new();
560 /* Create the initial state */
561 initial_global_state = xbt_new0(s_mc_global_t, 1);
563 MC_pre_modelcheck_liveness();
564 int res = MC_modelcheck_liveness_main();
567 simgrid::mc::processes_time.clear();