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. */
15 #include <xbt/automaton.h>
16 #include <xbt/dynar.h>
17 #include <xbt/dynar.hpp>
20 #include <xbt/sysdep.h>
22 #include "src/mc/mc_request.h"
23 #include "src/mc/LivenessChecker.hpp"
24 #include "src/mc/mc_private.h"
25 #include "src/mc/mc_record.h"
26 #include "src/mc/mc_smx.h"
27 #include "src/mc/Client.hpp"
28 #include "src/mc/mc_private.h"
29 #include "src/mc/mc_replay.h"
30 #include "src/mc/mc_safety.h"
31 #include "src/mc/mc_exit.h"
33 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_liveness, mc,
34 "Logging specific to algorithms for liveness properties verification");
36 /********* Global variables *********/
38 xbt_dynar_t acceptance_pairs;
39 static xbt_fifo_t liveness_stack;
41 /********* Static functions *********/
46 VisitedPair::VisitedPair(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions, simgrid::mc::State* graph_state)
48 simgrid::mc::Process* process = &(mc_model_checker->process());
50 this->graph_state = graph_state;
51 if(this->graph_state->system_state == nullptr)
52 this->graph_state->system_state = simgrid::mc::take_snapshot(pair_num);
53 this->heap_bytes_used = mmalloc_get_bytes_used_remote(
54 process->get_heap()->heaplimit,
55 process->get_malloc_info());
58 mc_model_checker->process().simix_processes().size();
60 this->automaton_state = automaton_state;
63 this->acceptance_removed = 0;
64 this->visited_removed = 0;
65 this->acceptance_pair = 0;
66 this->atomic_propositions = simgrid::xbt::unique_ptr<s_xbt_dynar_t>(
67 xbt_dynar_new(sizeof(int), nullptr));
69 unsigned int cursor = 0;
71 xbt_dynar_foreach(atomic_propositions, cursor, value)
72 xbt_dynar_push_as(this->atomic_propositions.get(), int, value);
75 static int is_exploration_stack_pair(simgrid::mc::VisitedPair* pair){
76 xbt_fifo_item_t item = xbt_fifo_get_first_item(liveness_stack);
78 if (((simgrid::mc::Pair*)xbt_fifo_get_item_content(item))->num == pair->num){
79 ((simgrid::mc::Pair*)xbt_fifo_get_item_content(item))->visited_pair_removed = 1;
82 item = xbt_fifo_get_next_item(item);
87 VisitedPair::~VisitedPair()
89 if( !is_exploration_stack_pair(this))
90 MC_state_delete(this->graph_state, 1);
93 static int MC_automaton_evaluate_label(xbt_automaton_exp_label_t l,
94 xbt_dynar_t atomic_propositions_values)
99 int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
100 int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
101 return (left_res || right_res);
104 int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
105 int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
106 return (left_res && right_res);
109 int res = MC_automaton_evaluate_label(l->u.exp_not, atomic_propositions_values);
113 unsigned int cursor = 0;
114 xbt_automaton_propositional_symbol_t p = nullptr;
115 xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
116 if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
117 return (int) xbt_dynar_get_as(atomic_propositions_values, cursor, int);
128 static xbt_dynar_t visited_pairs;
130 Pair::Pair() : num(++mc_stats->expanded_pairs),
131 visited_pair_removed(_sg_mc_visited > 0 ? 0 : 1)
135 if (this->visited_pair_removed)
136 MC_state_delete(this->graph_state, 1);
139 simgrid::xbt::unique_ptr<s_xbt_dynar_t> LivenessChecker::getPropositionValues()
141 unsigned int cursor = 0;
142 xbt_automaton_propositional_symbol_t ps = nullptr;
143 simgrid::xbt::unique_ptr<s_xbt_dynar_t> values = simgrid::xbt::unique_ptr<s_xbt_dynar_t>(xbt_dynar_new(sizeof(int), nullptr));
144 xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, ps) {
145 int res = xbt_automaton_propositional_symbol_evaluate(ps);
146 xbt_dynar_push_as(values.get(), int, res);
148 return std::move(values);
151 int LivenessChecker::compare(simgrid::mc::VisitedPair* state1, simgrid::mc::VisitedPair* state2)
153 simgrid::mc::Snapshot* s1 = state1->graph_state->system_state.get();
154 simgrid::mc::Snapshot* s2 = state2->graph_state->system_state.get();
155 int num1 = state1->num;
156 int num2 = state2->num;
157 return simgrid::mc::snapshot_compare(num1, s1, num2, s2);
160 simgrid::mc::VisitedPair* LivenessChecker::insertAcceptancePair(simgrid::mc::Pair* pair)
162 auto acceptance_pairs = simgrid::xbt::range<simgrid::mc::VisitedPair*>(::acceptance_pairs);
164 std::unique_ptr<simgrid::mc::VisitedPair>(new VisitedPair(
165 pair->num, pair->automaton_state, pair->atomic_propositions.get(),
167 new_pair->acceptance_pair = 1;
169 auto res = std::equal_range(acceptance_pairs.begin(), acceptance_pairs.end(),
170 new_pair, simgrid::mc::DerefAndCompareByNbProcessesAndUsedHeap());
172 if (pair->search_cycle == 1)
173 for (auto i = res.first; i != res.second; ++i) {
174 simgrid::mc::VisitedPair* pair_test = *i;
175 if (xbt_automaton_state_compare(pair_test->automaton_state, new_pair->automaton_state) == 0) {
176 if (xbt_automaton_propositional_symbols_compare_value(
177 pair_test->atomic_propositions.get(),
178 new_pair->atomic_propositions.get()) == 0) {
179 if (this->compare(pair_test, new_pair.get()) == 0) {
180 XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
181 xbt_fifo_shift(liveness_stack);
182 if (dot_output != nullptr)
183 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, pair_test->num, initial_global_state->prev_req);
190 auto new_raw_pair = new_pair.release();
192 ::acceptance_pairs, res.first - acceptance_pairs.begin(), &new_raw_pair);
196 void LivenessChecker::removeAcceptancePair(int pair_num)
198 unsigned int cursor = 0;
199 simgrid::mc::VisitedPair* pair_test = nullptr;
202 xbt_dynar_foreach(acceptance_pairs, cursor, pair_test)
203 if (pair_test->num == pair_num) {
208 if(pair_found == 1) {
209 xbt_dynar_remove_at(acceptance_pairs, cursor, &pair_test);
211 pair_test->acceptance_removed = 1;
213 if (_sg_mc_visited == 0 || pair_test->visited_removed == 1)
219 void LivenessChecker::prepare(void)
221 simgrid::mc::Pair* initial_pair = nullptr;
222 mc_model_checker->wait_for_requests();
223 acceptance_pairs = xbt_dynar_new(sizeof(simgrid::mc::VisitedPair*), nullptr);
224 if(_sg_mc_visited > 0)
225 simgrid::mc::visited_pairs = xbt_dynar_new(sizeof(simgrid::mc::VisitedPair*), nullptr);
227 initial_global_state->snapshot = simgrid::mc::take_snapshot(0);
228 initial_global_state->prev_pair = 0;
230 unsigned int cursor = 0;
231 xbt_automaton_state_t automaton_state;
233 xbt_dynar_foreach(simgrid::mc::property_automaton->states, cursor, automaton_state) {
234 if (automaton_state->type == -1) { /* Initial automaton state */
236 initial_pair = new Pair();
237 initial_pair->automaton_state = automaton_state;
238 initial_pair->graph_state = MC_state_new();
239 initial_pair->atomic_propositions = this->getPropositionValues();
240 initial_pair->depth = 1;
242 /* Get enabled processes and insert them in the interleave set of the graph_state */
243 for (auto& p : mc_model_checker->process().simix_processes())
244 if (simgrid::mc::process_is_enabled(&p.copy))
245 MC_state_interleave_process(initial_pair->graph_state, &p.copy);
247 initial_pair->requests = MC_state_interleave_size(initial_pair->graph_state);
248 initial_pair->search_cycle = 0;
250 xbt_fifo_unshift(liveness_stack, initial_pair);
256 void LivenessChecker::replay(xbt_fifo_t stack)
258 xbt_fifo_item_t item;
259 simgrid::mc::Pair* pair = nullptr;
260 simgrid::mc::State* state = nullptr;
261 smx_simcall_t req = nullptr, saved_req = NULL;
262 int value, depth = 1;
265 XBT_DEBUG("**** Begin Replay ****");
267 /* Intermediate backtracking */
268 if(_sg_mc_checkpoint > 0) {
269 item = xbt_fifo_get_first_item(stack);
270 pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
271 if(pair->graph_state->system_state){
272 simgrid::mc::restore_snapshot(pair->graph_state->system_state);
277 /* Restore the initial state */
278 simgrid::mc::restore_snapshot(initial_global_state->snapshot);
280 /* Traverse the stack from the initial state and re-execute the transitions */
281 for (item = xbt_fifo_get_last_item(stack);
282 item != xbt_fifo_get_first_item(stack);
283 item = xbt_fifo_get_prev_item(item)) {
285 pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
287 state = (simgrid::mc::State*) pair->graph_state;
289 if (pair->exploration_started) {
291 saved_req = MC_state_get_executed_request(state, &value);
293 if (saved_req != nullptr) {
294 /* because we got a copy of the executed request, we have to fetch the
295 real one, pointed by the request field of the issuer process */
296 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
297 req = &issuer->simcall;
299 /* Debug information */
300 if (XBT_LOG_ISENABLED(mc_liveness, xbt_log_priority_debug)) {
301 req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
302 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
308 simgrid::mc::handle_simcall(req, value);
309 mc_model_checker->wait_for_requests();
312 /* Update statistics */
313 mc_stats->visited_pairs++;
314 mc_stats->executed_transitions++;
320 XBT_DEBUG("**** End Replay ****");
324 * \brief Checks whether a given pair has already been visited by the algorithm.
326 int LivenessChecker::insertVisitedPair(simgrid::mc::VisitedPair* visited_pair, simgrid::mc::Pair* pair)
328 if (_sg_mc_visited == 0)
331 simgrid::mc::VisitedPair* new_visited_pair = nullptr;
332 if (visited_pair == nullptr)
333 new_visited_pair = new simgrid::mc::VisitedPair(
334 pair->num, pair->automaton_state, pair->atomic_propositions.get(),
337 new_visited_pair = visited_pair;
339 auto visited_pairs = simgrid::xbt::range<simgrid::mc::VisitedPair*>(simgrid::mc::visited_pairs);
341 auto range = std::equal_range(visited_pairs.begin(), visited_pairs.end(),
342 new_visited_pair, simgrid::mc::DerefAndCompareByNbProcessesAndUsedHeap());
344 for (auto i = range.first; i != range.second; ++i) {
345 simgrid::mc::VisitedPair* pair_test = *i;
346 std::size_t cursor = i - visited_pairs.begin();
347 if (xbt_automaton_state_compare(pair_test->automaton_state, new_visited_pair->automaton_state) == 0) {
348 if (xbt_automaton_propositional_symbols_compare_value(
349 pair_test->atomic_propositions.get(),
350 new_visited_pair->atomic_propositions.get()) == 0) {
351 if (this->compare(pair_test, new_visited_pair) == 0) {
352 if (pair_test->other_num == -1)
353 new_visited_pair->other_num = pair_test->num;
355 new_visited_pair->other_num = pair_test->other_num;
356 if (dot_output == nullptr)
357 XBT_DEBUG("Pair %d already visited ! (equal to pair %d)", new_visited_pair->num, pair_test->num);
359 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);
360 xbt_dynar_remove_at(simgrid::mc::visited_pairs, cursor, &pair_test);
361 xbt_dynar_insert_at(simgrid::mc::visited_pairs, cursor, &new_visited_pair);
362 pair_test->visited_removed = 1;
363 if (!pair_test->acceptance_pair
364 || pair_test->acceptance_removed == 1)
366 return new_visited_pair->other_num;
372 xbt_dynar_insert_at(simgrid::mc::visited_pairs, range.first - visited_pairs.begin(), &new_visited_pair);
374 if ((ssize_t) visited_pairs.size() > _sg_mc_visited) {
375 int min2 = mc_stats->expanded_pairs;
376 unsigned int index2 = 0;
377 for (std::size_t i = 0; i != (std::size_t) visited_pairs.size(); ++i) {
378 simgrid::mc::VisitedPair* pair_test = visited_pairs[i];
379 if (pair_test->num < min2) {
381 min2 = pair_test->num;
384 simgrid::mc::VisitedPair* pair_test = nullptr;
385 xbt_dynar_remove_at(simgrid::mc::visited_pairs, index2, &pair_test);
386 pair_test->visited_removed = 1;
387 if (!pair_test->acceptance_pair || pair_test->acceptance_removed)
394 LivenessChecker::LivenessChecker(Session& session) : Checker(session)
398 LivenessChecker::~LivenessChecker()
402 RecordTrace LivenessChecker::getRecordTrace() // override
406 xbt_fifo_item_t start = xbt_fifo_get_last_item(liveness_stack);
407 for (xbt_fifo_item_t item = start; item; item = xbt_fifo_get_prev_item(item)) {
408 simgrid::mc::Pair* pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
410 smx_simcall_t req = MC_state_get_executed_request(pair->graph_state, &value);
411 if (req && req->call != SIMCALL_NONE) {
412 smx_process_t issuer = MC_smx_simcall_get_issuer(req);
413 const int pid = issuer->pid;
415 // Serialization the (pid, value) pair:
416 res.push_back(RecordTraceElement(pid, value));
420 return std::move(res);
423 void LivenessChecker::showAcceptanceCycle(std::size_t depth)
425 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
426 XBT_INFO("| ACCEPTANCE CYCLE |");
427 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
428 XBT_INFO("Counter-example that violates formula :");
429 simgrid::mc::dumpRecordPath();
430 for (auto& s : this->getTextualTrace())
431 XBT_INFO("%s", s.c_str());
432 MC_print_statistics(mc_stats);
433 XBT_INFO("Counter-example depth : %zd", depth);
436 std::vector<std::string> LivenessChecker::getTextualTrace() // override
438 std::vector<std::string> trace;
439 for (xbt_fifo_item_t item = xbt_fifo_get_last_item(liveness_stack);
440 item; item = xbt_fifo_get_prev_item(item)) {
441 simgrid::mc::Pair* pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
443 smx_simcall_t req = MC_state_get_executed_request(pair->graph_state, &value);
444 if (req && req->call != SIMCALL_NONE) {
445 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
446 trace.push_back(std::string(req_str));
450 return std::move(trace);
453 int LivenessChecker::main(void)
455 simgrid::mc::Pair* current_pair = nullptr;
456 int value, res, visited_num = -1;
457 smx_simcall_t req = nullptr;
458 xbt_automaton_transition_t transition_succ = nullptr;
460 simgrid::mc::Pair* next_pair = nullptr;
461 simgrid::xbt::unique_ptr<s_xbt_dynar_t> prop_values;
462 simgrid::mc::VisitedPair* reached_pair = nullptr;
464 while(xbt_fifo_size(liveness_stack) > 0){
466 /* Get current pair */
467 current_pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(xbt_fifo_get_first_item(liveness_stack));
469 /* Update current state in buchi automaton */
470 simgrid::mc::property_automaton->current_state = current_pair->automaton_state;
472 XBT_DEBUG("********************* ( Depth = %d, search_cycle = %d, interleave size = %d, pair_num = %d, requests = %d)",
473 current_pair->depth, current_pair->search_cycle,
474 MC_state_interleave_size(current_pair->graph_state), current_pair->num,
475 current_pair->requests);
477 if (current_pair->requests > 0) {
479 if (current_pair->automaton_state->type == 1 && current_pair->exploration_started == 0) {
480 /* If new acceptance pair, return new pair */
481 if ((reached_pair = this->insertAcceptancePair(current_pair)) == nullptr) {
482 this->showAcceptanceCycle(current_pair->depth);
483 return SIMGRID_MC_EXIT_LIVENESS;
487 /* Pair already visited ? stop the exploration on the current path */
488 if ((current_pair->exploration_started == 0)
489 && (visited_num = this->insertVisitedPair(
490 reached_pair, current_pair)) != -1) {
492 if (dot_output != nullptr){
493 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, visited_num, initial_global_state->prev_req);
497 XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
498 current_pair->requests = 0;
503 req = MC_state_get_request(current_pair->graph_state, &value);
505 if (dot_output != nullptr) {
506 if (initial_global_state->prev_pair != 0 && initial_global_state->prev_pair != current_pair->num) {
507 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, current_pair->num, initial_global_state->prev_req);
508 xbt_free(initial_global_state->prev_req);
510 initial_global_state->prev_pair = current_pair->num;
511 initial_global_state->prev_req = simgrid::mc::request_get_dot_output(req, value);
512 if (current_pair->search_cycle)
513 fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
517 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
518 XBT_DEBUG("Execute: %s", req_str);
521 /* Set request as executed */
522 MC_state_set_executed_request(current_pair->graph_state, req, value);
524 /* Update mc_stats */
525 mc_stats->executed_transitions++;
526 if(current_pair->exploration_started == 0)
527 mc_stats->visited_pairs++;
529 /* Answer the request */
530 simgrid::mc::handle_simcall(req, value);
532 /* Wait for requests (schedules processes) */
533 mc_model_checker->wait_for_requests();
535 current_pair->requests--;
536 current_pair->exploration_started = 1;
538 /* Get values of atomic propositions (variables used in the property formula) */
539 prop_values = this->getPropositionValues();
541 /* Evaluate enabled/true transitions in automaton according to atomic propositions values and create new pairs */
542 cursor = xbt_dynar_length(current_pair->automaton_state->out) - 1;
543 while (cursor >= 0) {
544 transition_succ = (xbt_automaton_transition_t)xbt_dynar_get_as(current_pair->automaton_state->out, cursor, xbt_automaton_transition_t);
545 res = MC_automaton_evaluate_label(transition_succ->label, prop_values.get());
546 if (res == 1 || res == 2) { /* 1 = True transition (always enabled), 2 = enabled transition according to atomic prop values */
547 next_pair = new Pair();
548 next_pair->graph_state = MC_state_new();
549 next_pair->automaton_state = transition_succ->dst;
550 next_pair->atomic_propositions = this->getPropositionValues();
551 next_pair->depth = current_pair->depth + 1;
552 /* Get enabled processes and insert them in the interleave set of the next graph_state */
553 for (auto& p : mc_model_checker->process().simix_processes())
554 if (simgrid::mc::process_is_enabled(&p.copy))
555 MC_state_interleave_process(next_pair->graph_state, &p.copy);
557 next_pair->requests = MC_state_interleave_size(next_pair->graph_state);
559 /* FIXME : get search_cycle value for each acceptant state */
560 if (next_pair->automaton_state->type == 1 || current_pair->search_cycle)
561 next_pair->search_cycle = 1;
563 /* Add new pair to the exploration stack */
564 xbt_fifo_unshift(liveness_stack, next_pair);
570 } /* End of visited_pair test */
575 if(visited_num == -1)
576 XBT_DEBUG("No more request to execute. Looking for backtracking point.");
580 /* Traverse the stack backwards until a pair with a non empty interleave
581 set is found, deleting all the pairs that have it empty in the way. */
582 while ((current_pair = (simgrid::mc::Pair*) xbt_fifo_shift(liveness_stack)) != nullptr) {
583 if (current_pair->requests > 0) {
584 /* We found a backtracking point */
585 XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
586 xbt_fifo_unshift(liveness_stack, current_pair);
587 this->replay(liveness_stack);
588 XBT_DEBUG("Backtracking done");
592 XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
593 if (current_pair->automaton_state->type == 1)
594 this->removeAcceptancePair(current_pair->num);
599 } /* End of if (current_pair->requests > 0) else ... */
601 } /* End of while(xbt_fifo_size(liveness_stack) > 0) */
603 XBT_INFO("No property violation found.");
604 MC_print_statistics(mc_stats);
605 return SIMGRID_MC_EXIT_SUCCESS;
608 int LivenessChecker::run()
610 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
611 MC_automaton_load(_sg_mc_property_file);
612 mc_model_checker->wait_for_requests();
614 XBT_DEBUG("Starting the liveness algorithm");
617 /* Create exploration stack */
618 liveness_stack = xbt_fifo_new();
620 /* Create the initial state */
621 simgrid::mc::initial_global_state = std::unique_ptr<s_mc_global_t>(new s_mc_global_t());
624 int res = this->main();
625 simgrid::mc::initial_global_state = nullptr;