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. */
16 #include <xbt/automaton.h>
17 #include <xbt/dynar.h>
18 #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 /********* Static functions *********/
43 std::list<VisitedPair*> LivenessChecker::acceptance_pairs;
44 std::list<Pair*> LivenessChecker::liveness_stack;
45 xbt_dynar_t LivenessChecker::visited_pairs;
47 VisitedPair::VisitedPair(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions, std::shared_ptr<simgrid::mc::State> graph_state)
49 simgrid::mc::Process* process = &(mc_model_checker->process());
51 this->graph_state = std::move(graph_state);
52 if(this->graph_state->system_state == nullptr)
53 this->graph_state->system_state = simgrid::mc::take_snapshot(pair_num);
54 this->heap_bytes_used = mmalloc_get_bytes_used_remote(
55 process->get_heap()->heaplimit,
56 process->get_malloc_info());
59 mc_model_checker->process().simix_processes().size();
61 this->automaton_state = automaton_state;
64 this->acceptance_removed = 0;
65 this->visited_removed = 0;
66 this->acceptance_pair = 0;
67 this->atomic_propositions = simgrid::xbt::unique_ptr<s_xbt_dynar_t>(
68 xbt_dynar_new(sizeof(int), nullptr));
70 unsigned int cursor = 0;
72 xbt_dynar_foreach(atomic_propositions, cursor, value)
73 xbt_dynar_push_as(this->atomic_propositions.get(), int, value);
76 VisitedPair::~VisitedPair()
80 static int MC_automaton_evaluate_label(xbt_automaton_exp_label_t l,
81 xbt_dynar_t atomic_propositions_values)
86 int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
87 int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
88 return (left_res || right_res);
91 int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
92 int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
93 return (left_res && right_res);
96 int res = MC_automaton_evaluate_label(l->u.exp_not, atomic_propositions_values);
100 unsigned int cursor = 0;
101 xbt_automaton_propositional_symbol_t p = nullptr;
102 xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
103 if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
104 return (int) xbt_dynar_get_as(atomic_propositions_values, cursor, int);
115 Pair::Pair() : num(++mc_stats->expanded_pairs)
120 simgrid::xbt::unique_ptr<s_xbt_dynar_t> LivenessChecker::getPropositionValues()
122 unsigned int cursor = 0;
123 xbt_automaton_propositional_symbol_t ps = nullptr;
124 simgrid::xbt::unique_ptr<s_xbt_dynar_t> values = simgrid::xbt::unique_ptr<s_xbt_dynar_t>(xbt_dynar_new(sizeof(int), nullptr));
125 xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, ps) {
126 int res = xbt_automaton_propositional_symbol_evaluate(ps);
127 xbt_dynar_push_as(values.get(), int, res);
132 int LivenessChecker::compare(simgrid::mc::VisitedPair* state1, simgrid::mc::VisitedPair* state2)
134 simgrid::mc::Snapshot* s1 = state1->graph_state->system_state.get();
135 simgrid::mc::Snapshot* s2 = state2->graph_state->system_state.get();
136 int num1 = state1->num;
137 int num2 = state2->num;
138 return simgrid::mc::snapshot_compare(num1, s1, num2, s2);
141 simgrid::mc::VisitedPair* LivenessChecker::insertAcceptancePair(simgrid::mc::Pair* pair)
144 std::unique_ptr<simgrid::mc::VisitedPair>(new VisitedPair(
145 pair->num, pair->automaton_state, pair->atomic_propositions.get(),
147 new_pair->acceptance_pair = 1;
149 auto res = std::equal_range(acceptance_pairs.begin(), acceptance_pairs.end(),
150 new_pair, simgrid::mc::DerefAndCompareByNbProcessesAndUsedHeap());
152 if (pair->search_cycle == 1)
153 for (auto i = res.first; i != res.second; ++i) {
154 simgrid::mc::VisitedPair* pair_test = *i;
155 if (xbt_automaton_state_compare(pair_test->automaton_state, new_pair->automaton_state) == 0) {
156 if (xbt_automaton_propositional_symbols_compare_value(
157 pair_test->atomic_propositions.get(),
158 new_pair->atomic_propositions.get()) == 0) {
159 if (this->compare(pair_test, new_pair.get()) == 0) {
160 XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
161 liveness_stack.pop_back();
162 if (dot_output != nullptr)
163 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, pair_test->num, initial_global_state->prev_req);
170 auto new_raw_pair = new_pair.release();
171 acceptance_pairs.insert(res.first, new_raw_pair);
175 void LivenessChecker::removeAcceptancePair(int pair_num)
177 for (auto i = acceptance_pairs.begin(); i != acceptance_pairs.end(); ++i)
178 if ((*i)->num == pair_num) {
179 acceptance_pairs.erase(i);
180 (*i)->acceptance_removed = 1;
181 if (_sg_mc_visited == 0 || (*i)->visited_removed == 1)
187 void LivenessChecker::prepare(void)
189 simgrid::mc::Pair* initial_pair = nullptr;
190 mc_model_checker->wait_for_requests();
191 acceptance_pairs.clear();
192 if(_sg_mc_visited > 0)
193 LivenessChecker::visited_pairs = xbt_dynar_new(sizeof(simgrid::mc::VisitedPair*), nullptr);
195 initial_global_state->snapshot = simgrid::mc::take_snapshot(0);
196 initial_global_state->prev_pair = 0;
198 unsigned int cursor = 0;
199 xbt_automaton_state_t automaton_state;
201 xbt_dynar_foreach(simgrid::mc::property_automaton->states, cursor, automaton_state) {
202 if (automaton_state->type == -1) { /* Initial automaton state */
204 initial_pair = new Pair();
205 initial_pair->automaton_state = automaton_state;
206 initial_pair->graph_state = std::shared_ptr<simgrid::mc::State>(MC_state_new());
207 initial_pair->atomic_propositions = this->getPropositionValues();
208 initial_pair->depth = 1;
210 /* Get enabled processes and insert them in the interleave set of the graph_state */
211 for (auto& p : mc_model_checker->process().simix_processes())
212 if (simgrid::mc::process_is_enabled(&p.copy))
213 MC_state_interleave_process(initial_pair->graph_state.get(), &p.copy);
215 initial_pair->requests = MC_state_interleave_size(initial_pair->graph_state.get());
216 initial_pair->search_cycle = 0;
218 liveness_stack.push_back(initial_pair);
224 void LivenessChecker::replay()
226 smx_simcall_t req = nullptr, saved_req = NULL;
227 int value, depth = 1;
230 XBT_DEBUG("**** Begin Replay ****");
232 /* Intermediate backtracking */
233 if(_sg_mc_checkpoint > 0) {
234 simgrid::mc::Pair* pair = liveness_stack.back();
235 if(pair->graph_state->system_state){
236 simgrid::mc::restore_snapshot(pair->graph_state->system_state);
241 /* Restore the initial state */
242 simgrid::mc::restore_snapshot(initial_global_state->snapshot);
244 /* Traverse the stack from the initial state and re-execute the transitions */
245 for (simgrid::mc::Pair* pair : liveness_stack) {
246 if (pair == liveness_stack.back())
249 std::shared_ptr<State> state = pair->graph_state;
251 if (pair->exploration_started) {
253 saved_req = MC_state_get_executed_request(state.get(), &value);
255 if (saved_req != nullptr) {
256 /* because we got a copy of the executed request, we have to fetch the
257 real one, pointed by the request field of the issuer process */
258 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
259 req = &issuer->simcall;
261 /* Debug information */
262 if (XBT_LOG_ISENABLED(mc_liveness, xbt_log_priority_debug)) {
263 req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
264 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state.get());
270 simgrid::mc::handle_simcall(req, value);
271 mc_model_checker->wait_for_requests();
274 /* Update statistics */
275 mc_stats->visited_pairs++;
276 mc_stats->executed_transitions++;
282 XBT_DEBUG("**** End Replay ****");
286 * \brief Checks whether a given pair has already been visited by the algorithm.
288 int LivenessChecker::insertVisitedPair(simgrid::mc::VisitedPair* visited_pair, simgrid::mc::Pair* pair)
290 if (_sg_mc_visited == 0)
293 simgrid::mc::VisitedPair* new_visited_pair = nullptr;
294 if (visited_pair == nullptr)
295 new_visited_pair = new simgrid::mc::VisitedPair(
296 pair->num, pair->automaton_state, pair->atomic_propositions.get(),
299 new_visited_pair = visited_pair;
301 auto visited_pairs = simgrid::xbt::range<simgrid::mc::VisitedPair*>(LivenessChecker::visited_pairs);
303 auto range = std::equal_range(visited_pairs.begin(), visited_pairs.end(),
304 new_visited_pair, simgrid::mc::DerefAndCompareByNbProcessesAndUsedHeap());
306 for (auto i = range.first; i != range.second; ++i) {
307 simgrid::mc::VisitedPair* pair_test = *i;
308 std::size_t cursor = i - visited_pairs.begin();
309 if (xbt_automaton_state_compare(pair_test->automaton_state, new_visited_pair->automaton_state) == 0) {
310 if (xbt_automaton_propositional_symbols_compare_value(
311 pair_test->atomic_propositions.get(),
312 new_visited_pair->atomic_propositions.get()) == 0) {
313 if (this->compare(pair_test, new_visited_pair) == 0) {
314 if (pair_test->other_num == -1)
315 new_visited_pair->other_num = pair_test->num;
317 new_visited_pair->other_num = pair_test->other_num;
318 if (dot_output == nullptr)
319 XBT_DEBUG("Pair %d already visited ! (equal to pair %d)", new_visited_pair->num, pair_test->num);
321 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);
322 xbt_dynar_remove_at(LivenessChecker::visited_pairs, cursor, &pair_test);
323 xbt_dynar_insert_at(LivenessChecker::visited_pairs, cursor, &new_visited_pair);
324 pair_test->visited_removed = 1;
325 if (!pair_test->acceptance_pair
326 || pair_test->acceptance_removed == 1)
328 return new_visited_pair->other_num;
334 xbt_dynar_insert_at(LivenessChecker::visited_pairs, range.first - visited_pairs.begin(), &new_visited_pair);
336 if ((ssize_t) visited_pairs.size() > _sg_mc_visited) {
337 int min2 = mc_stats->expanded_pairs;
338 unsigned int index2 = 0;
339 for (std::size_t i = 0; i != (std::size_t) visited_pairs.size(); ++i) {
340 simgrid::mc::VisitedPair* pair_test = visited_pairs[i];
341 if (pair_test->num < min2) {
343 min2 = pair_test->num;
346 simgrid::mc::VisitedPair* pair_test = nullptr;
347 xbt_dynar_remove_at(LivenessChecker::visited_pairs, index2, &pair_test);
348 pair_test->visited_removed = 1;
349 if (!pair_test->acceptance_pair || pair_test->acceptance_removed)
356 LivenessChecker::LivenessChecker(Session& session) : Checker(session)
360 LivenessChecker::~LivenessChecker()
364 RecordTrace LivenessChecker::getRecordTrace() // override
367 for (simgrid::mc::Pair* pair : liveness_stack) {
369 smx_simcall_t req = MC_state_get_executed_request(pair->graph_state.get(), &value);
370 if (req && req->call != SIMCALL_NONE) {
371 smx_process_t issuer = MC_smx_simcall_get_issuer(req);
372 const int pid = issuer->pid;
374 // Serialization the (pid, value) pair:
375 res.push_back(RecordTraceElement(pid, value));
381 void LivenessChecker::showAcceptanceCycle(std::size_t depth)
383 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
384 XBT_INFO("| ACCEPTANCE CYCLE |");
385 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
386 XBT_INFO("Counter-example that violates formula :");
387 simgrid::mc::dumpRecordPath();
388 for (auto& s : this->getTextualTrace())
389 XBT_INFO("%s", s.c_str());
390 MC_print_statistics(mc_stats);
391 XBT_INFO("Counter-example depth : %zd", depth);
394 std::vector<std::string> LivenessChecker::getTextualTrace() // override
396 std::vector<std::string> trace;
397 for (simgrid::mc::Pair* pair : liveness_stack) {
399 smx_simcall_t req = MC_state_get_executed_request(pair->graph_state.get(), &value);
400 if (req && req->call != SIMCALL_NONE) {
401 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
402 trace.push_back(std::string(req_str));
409 int LivenessChecker::main(void)
411 simgrid::mc::Pair* current_pair = nullptr;
412 int value, res, visited_num = -1;
413 smx_simcall_t req = nullptr;
414 xbt_automaton_transition_t transition_succ = nullptr;
416 simgrid::xbt::unique_ptr<s_xbt_dynar_t> prop_values;
417 simgrid::mc::VisitedPair* reached_pair = nullptr;
419 while (!liveness_stack.empty()){
421 /* Get current pair */
422 current_pair = liveness_stack.back();
424 /* Update current state in buchi automaton */
425 simgrid::mc::property_automaton->current_state = current_pair->automaton_state;
427 XBT_DEBUG("********************* ( Depth = %d, search_cycle = %d, interleave size = %d, pair_num = %d, requests = %d)",
428 current_pair->depth, current_pair->search_cycle,
429 MC_state_interleave_size(current_pair->graph_state.get()), current_pair->num,
430 current_pair->requests);
432 if (current_pair->requests > 0) {
434 if (current_pair->automaton_state->type == 1 && current_pair->exploration_started == 0) {
435 /* If new acceptance pair, return new pair */
436 if ((reached_pair = this->insertAcceptancePair(current_pair)) == nullptr) {
437 this->showAcceptanceCycle(current_pair->depth);
438 return SIMGRID_MC_EXIT_LIVENESS;
442 /* Pair already visited ? stop the exploration on the current path */
443 if ((current_pair->exploration_started == 0)
444 && (visited_num = this->insertVisitedPair(
445 reached_pair, current_pair)) != -1) {
447 if (dot_output != nullptr){
448 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, visited_num, initial_global_state->prev_req);
452 XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
453 current_pair->requests = 0;
458 req = MC_state_get_request(current_pair->graph_state.get(), &value);
460 if (dot_output != nullptr) {
461 if (initial_global_state->prev_pair != 0 && initial_global_state->prev_pair != current_pair->num) {
462 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, current_pair->num, initial_global_state->prev_req);
463 xbt_free(initial_global_state->prev_req);
465 initial_global_state->prev_pair = current_pair->num;
466 initial_global_state->prev_req = simgrid::mc::request_get_dot_output(req, value);
467 if (current_pair->search_cycle)
468 fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
472 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
473 XBT_DEBUG("Execute: %s", req_str);
476 /* Set request as executed */
477 MC_state_set_executed_request(current_pair->graph_state.get(), req, value);
479 /* Update mc_stats */
480 mc_stats->executed_transitions++;
481 if(current_pair->exploration_started == 0)
482 mc_stats->visited_pairs++;
484 /* Answer the request */
485 simgrid::mc::handle_simcall(req, value);
487 /* Wait for requests (schedules processes) */
488 mc_model_checker->wait_for_requests();
490 current_pair->requests--;
491 current_pair->exploration_started = 1;
493 /* Get values of atomic propositions (variables used in the property formula) */
494 prop_values = this->getPropositionValues();
496 /* Evaluate enabled/true transitions in automaton according to atomic propositions values and create new pairs */
497 cursor = xbt_dynar_length(current_pair->automaton_state->out) - 1;
498 while (cursor >= 0) {
499 transition_succ = (xbt_automaton_transition_t)xbt_dynar_get_as(current_pair->automaton_state->out, cursor, xbt_automaton_transition_t);
500 res = MC_automaton_evaluate_label(transition_succ->label, prop_values.get());
501 if (res == 1 || res == 2) { /* 1 = True transition (always enabled), 2 = enabled transition according to atomic prop values */
502 Pair* next_pair = new Pair();
503 next_pair->graph_state = std::shared_ptr<simgrid::mc::State>(MC_state_new());
504 next_pair->automaton_state = transition_succ->dst;
505 next_pair->atomic_propositions = this->getPropositionValues();
506 next_pair->depth = current_pair->depth + 1;
507 /* Get enabled processes and insert them in the interleave set of the next graph_state */
508 for (auto& p : mc_model_checker->process().simix_processes())
509 if (simgrid::mc::process_is_enabled(&p.copy))
510 MC_state_interleave_process(next_pair->graph_state.get(), &p.copy);
512 next_pair->requests = MC_state_interleave_size(next_pair->graph_state.get());
514 /* FIXME : get search_cycle value for each acceptant state */
515 if (next_pair->automaton_state->type == 1 || current_pair->search_cycle)
516 next_pair->search_cycle = 1;
518 /* Add new pair to the exploration stack */
519 liveness_stack.push_back(next_pair);
525 } /* End of visited_pair test */
530 if(visited_num == -1)
531 XBT_DEBUG("No more request to execute. Looking for backtracking point.");
535 /* Traverse the stack backwards until a pair with a non empty interleave
536 set is found, deleting all the pairs that have it empty in the way. */
537 while (!liveness_stack.empty()) {
538 current_pair = liveness_stack.back();
539 liveness_stack.pop_back();
540 if (current_pair->requests > 0) {
541 /* We found a backtracking point */
542 XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
543 liveness_stack.push_back(current_pair);
545 XBT_DEBUG("Backtracking done");
549 XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
550 if (current_pair->automaton_state->type == 1)
551 this->removeAcceptancePair(current_pair->num);
556 } /* End of if (current_pair->requests > 0) else ... */
560 XBT_INFO("No property violation found.");
561 MC_print_statistics(mc_stats);
562 return SIMGRID_MC_EXIT_SUCCESS;
565 int LivenessChecker::run()
567 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
568 MC_automaton_load(_sg_mc_property_file);
569 mc_model_checker->wait_for_requests();
571 XBT_DEBUG("Starting the liveness algorithm");
574 /* Create exploration stack */
575 liveness_stack.clear();
577 /* Create the initial state */
578 simgrid::mc::initial_global_state = std::unique_ptr<s_mc_global_t>(new s_mc_global_t());
581 int res = this->main();
582 simgrid::mc::initial_global_state = nullptr;