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. */
12 #include <xbt/automaton.h>
13 #include <xbt/dynar.h>
16 #include <xbt/parmap.h>
17 #include <xbt/sysdep.h>
19 #include "src/mc/mc_request.h"
20 #include "src/mc/mc_liveness.h"
21 #include "src/mc/mc_private.h"
22 #include "src/mc/mc_record.h"
23 #include "src/mc/mc_smx.h"
24 #include "src/mc/mc_client.h"
25 #include "src/mc/mc_replay.h"
26 #include "src/mc/mc_safety.h"
27 #include "src/mc/mc_exit.h"
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_liveness, mc,
32 "Logging specific to algorithms for liveness properties verification");
36 /********* Global variables *********/
38 xbt_dynar_t acceptance_pairs;
41 /********* Static functions *********/
43 static xbt_dynar_t get_atomic_propositions_values()
45 unsigned int cursor = 0;
46 xbt_automaton_propositional_symbol_t ps = nullptr;
47 xbt_dynar_t values = xbt_dynar_new(sizeof(int), nullptr);
48 xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, ps) {
49 int res = xbt_automaton_propositional_symbol_evaluate(ps);
50 xbt_dynar_push_as(values, int, res);
56 static simgrid::mc::VisitedPair* is_reached_acceptance_pair(simgrid::mc::Pair* pair)
58 simgrid::mc::VisitedPair* new_pair = nullptr;
59 new_pair = simgrid::mc::visited_pair_new(pair->num, pair->automaton_state, pair->atomic_propositions, pair->graph_state);
60 new_pair->acceptance_pair = 1;
62 if (xbt_dynar_is_empty(acceptance_pairs))
63 xbt_dynar_push(acceptance_pairs, &new_pair);
66 int min = -1, max = -1, index;
68 simgrid::mc::VisitedPair* pair_test;
71 index = get_search_interval(acceptance_pairs, new_pair, &min, &max);
73 if (min != -1 && max != -1) { // Acceptance pair with same number of processes and same heap bytes used exists
75 // Parallell implementation
76 /*res = xbt_parmap_mc_apply(parmap, snapshot_compare, xbt_dynar_get_ptr(acceptance_pairs, min), (max-min)+1, pair);
78 return ((simgrid::mc::Pair*)xbt_dynar_get_as(acceptance_pairs, (min+res)-1, simgrid::mc::Pair*))->num;
82 if(pair->search_cycle == 1){
83 while (cursor <= max) {
84 pair_test = (simgrid::mc::VisitedPair*) xbt_dynar_get_as(acceptance_pairs, cursor, simgrid::mc::VisitedPair*);
85 if (xbt_automaton_state_compare(pair_test->automaton_state, new_pair->automaton_state) == 0) {
86 if (xbt_automaton_propositional_symbols_compare_value(pair_test->atomic_propositions, new_pair->atomic_propositions) == 0) {
87 if (snapshot_compare(pair_test, new_pair) == 0) {
88 XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
89 xbt_fifo_shift(mc_stack);
90 if (dot_output != nullptr)
91 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, pair_test->num, initial_global_state->prev_req);
99 xbt_dynar_insert_at(acceptance_pairs, min, &new_pair);
101 pair_test = (simgrid::mc::VisitedPair*) xbt_dynar_get_as(acceptance_pairs, index, simgrid::mc::VisitedPair*);
102 if (pair_test->nb_processes < new_pair->nb_processes)
103 xbt_dynar_insert_at(acceptance_pairs, index + 1, &new_pair);
104 else if (pair_test->heap_bytes_used < new_pair->heap_bytes_used)
105 xbt_dynar_insert_at(acceptance_pairs, index + 1, &new_pair);
107 xbt_dynar_insert_at(acceptance_pairs, index, &new_pair);
113 static void remove_acceptance_pair(int pair_num)
115 unsigned int cursor = 0;
116 simgrid::mc::VisitedPair* pair_test = nullptr;
119 xbt_dynar_foreach(acceptance_pairs, cursor, pair_test)
120 if (pair_test->num == pair_num) {
125 if(pair_found == 1) {
126 xbt_dynar_remove_at(acceptance_pairs, cursor, &pair_test);
128 pair_test->acceptance_removed = 1;
130 if (_sg_mc_visited == 0 || pair_test->visited_removed == 1)
131 simgrid::mc::visited_pair_delete(pair_test);
137 static int MC_automaton_evaluate_label(xbt_automaton_exp_label_t l,
138 xbt_dynar_t atomic_propositions_values)
143 int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
144 int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
145 return (left_res || right_res);
148 int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
149 int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
150 return (left_res && right_res);
153 int res = MC_automaton_evaluate_label(l->u.exp_not, atomic_propositions_values);
157 unsigned int cursor = 0;
158 xbt_automaton_propositional_symbol_t p = nullptr;
159 xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
160 if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
161 return (int) xbt_dynar_get_as(atomic_propositions_values, cursor, int);
172 static void MC_pre_modelcheck_liveness(void)
174 simgrid::mc::Pair* initial_pair = nullptr;
175 mc_model_checker->wait_for_requests();
176 acceptance_pairs = xbt_dynar_new(sizeof(simgrid::mc::VisitedPair*), nullptr);
177 if(_sg_mc_visited > 0)
178 simgrid::mc::visited_pairs = xbt_dynar_new(sizeof(simgrid::mc::VisitedPair*), nullptr);
180 initial_global_state->snapshot = simgrid::mc::take_snapshot(0);
181 initial_global_state->prev_pair = 0;
183 unsigned int cursor = 0;
184 xbt_automaton_state_t automaton_state;
186 xbt_dynar_foreach(simgrid::mc::property_automaton->states, cursor, automaton_state) {
187 if (automaton_state->type == -1) { /* Initial automaton state */
189 initial_pair = simgrid::mc::pair_new();
190 initial_pair->automaton_state = automaton_state;
191 initial_pair->graph_state = MC_state_new();
192 initial_pair->atomic_propositions = get_atomic_propositions_values();
193 initial_pair->depth = 1;
195 /* Get enabled processes and insert them in the interleave set of the graph_state */
196 for (auto& p : mc_model_checker->process().simix_processes())
197 if (simgrid::mc::process_is_enabled(&p.copy))
198 MC_state_interleave_process(initial_pair->graph_state, &p.copy);
200 initial_pair->requests = MC_state_interleave_size(initial_pair->graph_state);
201 initial_pair->search_cycle = 0;
203 xbt_fifo_unshift(mc_stack, initial_pair);
208 static int MC_modelcheck_liveness_main(void)
210 simgrid::mc::Pair* current_pair = nullptr;
211 int value, res, visited_num = -1;
212 smx_simcall_t req = nullptr;
213 xbt_automaton_transition_t transition_succ = nullptr;
215 simgrid::mc::Pair* next_pair = nullptr;
216 xbt_dynar_t prop_values = nullptr;
217 simgrid::mc::VisitedPair* reached_pair = nullptr;
219 while(xbt_fifo_size(mc_stack) > 0){
221 /* Get current pair */
222 current_pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(xbt_fifo_get_first_item(mc_stack));
224 /* Update current state in buchi automaton */
225 simgrid::mc::property_automaton->current_state = current_pair->automaton_state;
227 XBT_DEBUG("********************* ( Depth = %d, search_cycle = %d, interleave size = %d, pair_num = %d, requests = %d)",
228 current_pair->depth, current_pair->search_cycle,
229 MC_state_interleave_size(current_pair->graph_state), current_pair->num,
230 current_pair->requests);
232 if (current_pair->requests > 0) {
234 if (current_pair->automaton_state->type == 1 && current_pair->exploration_started == 0) {
235 /* If new acceptance pair, return new pair */
236 if ((reached_pair = is_reached_acceptance_pair(current_pair)) == nullptr) {
237 int counter_example_depth = current_pair->depth;
238 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
239 XBT_INFO("| ACCEPTANCE CYCLE |");
240 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
241 XBT_INFO("Counter-example that violates formula :");
242 MC_record_dump_path(mc_stack);
243 simgrid::mc::show_stack_liveness(mc_stack);
244 simgrid::mc::dump_stack_liveness(mc_stack);
245 MC_print_statistics(mc_stats);
246 XBT_INFO("Counter-example depth : %d", counter_example_depth);
247 return SIMGRID_MC_EXIT_LIVENESS;
251 /* Pair already visited ? stop the exploration on the current path */
252 if ((current_pair->exploration_started == 0)
253 && (visited_num = simgrid::mc::is_visited_pair(
254 reached_pair, current_pair)) != -1) {
256 if (dot_output != nullptr){
257 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, visited_num, initial_global_state->prev_req);
261 XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
262 current_pair->requests = 0;
267 req = MC_state_get_request(current_pair->graph_state, &value);
269 if (dot_output != nullptr) {
270 if (initial_global_state->prev_pair != 0 && initial_global_state->prev_pair != current_pair->num) {
271 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, current_pair->num, initial_global_state->prev_req);
272 xbt_free(initial_global_state->prev_req);
274 initial_global_state->prev_pair = current_pair->num;
275 initial_global_state->prev_req = simgrid::mc::request_get_dot_output(req, value);
276 if (current_pair->search_cycle)
277 fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
281 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
282 XBT_DEBUG("Execute: %s", req_str);
285 /* Set request as executed */
286 MC_state_set_executed_request(current_pair->graph_state, req, value);
288 /* Update mc_stats */
289 mc_stats->executed_transitions++;
290 if(current_pair->exploration_started == 0)
291 mc_stats->visited_pairs++;
293 /* Answer the request */
294 simgrid::mc::handle_simcall(req, value);
296 /* Wait for requests (schedules processes) */
297 mc_model_checker->wait_for_requests();
299 current_pair->requests--;
300 current_pair->exploration_started = 1;
302 /* Get values of atomic propositions (variables used in the property formula) */
303 prop_values = get_atomic_propositions_values();
305 /* Evaluate enabled/true transitions in automaton according to atomic propositions values and create new pairs */
306 cursor = xbt_dynar_length(current_pair->automaton_state->out) - 1;
307 while (cursor >= 0) {
308 transition_succ = (xbt_automaton_transition_t)xbt_dynar_get_as(current_pair->automaton_state->out, cursor, xbt_automaton_transition_t);
309 res = MC_automaton_evaluate_label(transition_succ->label, prop_values);
310 if (res == 1 || res == 2) { /* 1 = True transition (always enabled), 2 = enabled transition according to atomic prop values */
311 next_pair = simgrid::mc::pair_new();
312 next_pair->graph_state = MC_state_new();
313 next_pair->automaton_state = transition_succ->dst;
314 next_pair->atomic_propositions = get_atomic_propositions_values();
315 next_pair->depth = current_pair->depth + 1;
316 /* Get enabled processes and insert them in the interleave set of the next graph_state */
317 for (auto& p : mc_model_checker->process().simix_processes())
318 if (simgrid::mc::process_is_enabled(&p.copy))
319 MC_state_interleave_process(next_pair->graph_state, &p.copy);
321 next_pair->requests = MC_state_interleave_size(next_pair->graph_state);
323 /* FIXME : get search_cycle value for each acceptant state */
324 if (next_pair->automaton_state->type == 1 || current_pair->search_cycle)
325 next_pair->search_cycle = 1;
327 /* Add new pair to the exploration stack */
328 xbt_fifo_unshift(mc_stack, next_pair);
334 } /* End of visited_pair test */
339 if(visited_num == -1)
340 XBT_DEBUG("No more request to execute. Looking for backtracking point.");
342 xbt_dynar_free(&prop_values);
344 /* Traverse the stack backwards until a pair with a non empty interleave
345 set is found, deleting all the pairs that have it empty in the way. */
346 while ((current_pair = (simgrid::mc::Pair*) xbt_fifo_shift(mc_stack)) != nullptr) {
347 if (current_pair->requests > 0) {
348 /* We found a backtracking point */
349 XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
350 xbt_fifo_unshift(mc_stack, current_pair);
351 MC_replay_liveness(mc_stack);
352 XBT_DEBUG("Backtracking done");
356 XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
357 if (current_pair->automaton_state->type == 1)
358 remove_acceptance_pair(current_pair->num);
359 simgrid::mc::pair_delete(current_pair);
363 } /* End of if (current_pair->requests > 0) else ... */
365 } /* End of while(xbt_fifo_size(mc_stack) > 0) */
367 XBT_INFO("No property violation found.");
368 MC_print_statistics(mc_stats);
369 return SIMGRID_MC_EXIT_SUCCESS;
375 int modelcheck_liveness(void)
377 if (mc_reduce_kind == e_mc_reduce_unset)
378 mc_reduce_kind = e_mc_reduce_none;
379 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
380 MC_automaton_load(_sg_mc_property_file);
381 mc_model_checker->wait_for_requests();
383 XBT_DEBUG("Starting the liveness algorithm");
386 /* Create exploration stack */
387 mc_stack = xbt_fifo_new();
389 /* Create the initial state */
390 initial_global_state = xbt_new0(s_mc_global_t, 1);
392 MC_pre_modelcheck_liveness();
393 int res = MC_modelcheck_liveness_main();
396 simgrid::mc::processes_time.clear();