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 /********* Static functions *********/
41 VisitedPair::VisitedPair(
42 int pair_num, xbt_automaton_state_t automaton_state,
43 std::vector<int> const& atomic_propositions, std::shared_ptr<simgrid::mc::State> graph_state)
45 simgrid::mc::Process* process = &(mc_model_checker->process());
47 this->graph_state = std::move(graph_state);
48 if(this->graph_state->system_state == nullptr)
49 this->graph_state->system_state = simgrid::mc::take_snapshot(pair_num);
50 this->heap_bytes_used = mmalloc_get_bytes_used_remote(
51 process->get_heap()->heaplimit,
52 process->get_malloc_info());
55 mc_model_checker->process().simix_processes().size();
57 this->automaton_state = automaton_state;
60 this->atomic_propositions = atomic_propositions;
63 VisitedPair::~VisitedPair()
67 static bool evaluate_label(
68 xbt_automaton_exp_label_t l, std::vector<int> const& values)
71 case xbt_automaton_exp_label::AUT_OR:
72 return evaluate_label(l->u.or_and.left_exp, values)
73 || evaluate_label(l->u.or_and.right_exp, values);
74 case xbt_automaton_exp_label::AUT_AND:
75 return evaluate_label(l->u.or_and.left_exp, values)
76 && evaluate_label(l->u.or_and.right_exp, values);
77 case xbt_automaton_exp_label::AUT_NOT:
78 return !evaluate_label(l->u.exp_not, values);
79 case xbt_automaton_exp_label::AUT_PREDICAT:{
80 unsigned int cursor = 0;
81 xbt_automaton_propositional_symbol_t p = nullptr;
82 xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
83 if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
84 return values[cursor] != 0;
86 xbt_die("Missing predicate");
88 case xbt_automaton_exp_label::AUT_ONE:
91 xbt_die("Unexpected vaue for automaton");
95 Pair::Pair() : num(++mc_stats->expanded_pairs)
100 std::vector<int> LivenessChecker::getPropositionValues()
102 std::vector<int> values;
103 unsigned int cursor = 0;
104 xbt_automaton_propositional_symbol_t ps = nullptr;
105 xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, ps)
106 values.push_back(xbt_automaton_propositional_symbol_evaluate(ps));
110 int LivenessChecker::compare(simgrid::mc::VisitedPair* state1, simgrid::mc::VisitedPair* state2)
112 simgrid::mc::Snapshot* s1 = state1->graph_state->system_state.get();
113 simgrid::mc::Snapshot* s2 = state2->graph_state->system_state.get();
114 int num1 = state1->num;
115 int num2 = state2->num;
116 return simgrid::mc::snapshot_compare(num1, s1, num2, s2);
119 std::shared_ptr<VisitedPair> LivenessChecker::insertAcceptancePair(simgrid::mc::Pair* pair)
121 std::shared_ptr<VisitedPair> new_pair = std::make_shared<VisitedPair>(
122 pair->num, pair->automaton_state, pair->atomic_propositions,
125 auto res = std::equal_range(acceptancePairs_.begin(), acceptancePairs_.end(),
126 new_pair.get(), simgrid::mc::DerefAndCompareByNbProcessesAndUsedHeap());
128 if (pair->search_cycle) for (auto i = res.first; i != res.second; ++i) {
129 std::shared_ptr<simgrid::mc::VisitedPair> const& pair_test = *i;
130 if (xbt_automaton_state_compare(
131 pair_test->automaton_state, new_pair->automaton_state) != 0
132 || pair_test->atomic_propositions != new_pair->atomic_propositions
133 || this->compare(pair_test.get(), new_pair.get()) != 0)
135 XBT_INFO("Pair %d already reached (equal to pair %d) !",
136 new_pair->num, pair_test->num);
137 livenessStack_.pop_back();
138 if (dot_output != nullptr)
139 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n",
140 initial_global_state->prev_pair, pair_test->num,
141 initial_global_state->prev_req);
145 acceptancePairs_.insert(res.first, new_pair);
149 void LivenessChecker::removeAcceptancePair(int pair_num)
151 for (auto i = acceptancePairs_.begin(); i != acceptancePairs_.end(); ++i)
152 if ((*i)->num == pair_num) {
153 acceptancePairs_.erase(i);
158 void LivenessChecker::prepare(void)
160 mc_model_checker->wait_for_requests();
162 initial_global_state->snapshot = simgrid::mc::take_snapshot(0);
163 initial_global_state->prev_pair = 0;
165 unsigned int cursor = 0;
166 xbt_automaton_state_t automaton_state;
168 xbt_dynar_foreach(simgrid::mc::property_automaton->states, cursor, automaton_state) {
169 if (automaton_state->type == -1) { /* Initial automaton state */
171 std::shared_ptr<Pair> initial_pair = std::make_shared<Pair>();
172 initial_pair->automaton_state = automaton_state;
173 initial_pair->graph_state = std::shared_ptr<simgrid::mc::State>(MC_state_new());
174 initial_pair->atomic_propositions = this->getPropositionValues();
175 initial_pair->depth = 1;
177 /* Get enabled processes and insert them in the interleave set of the graph_state */
178 for (auto& p : mc_model_checker->process().simix_processes())
179 if (simgrid::mc::process_is_enabled(&p.copy))
180 MC_state_interleave_process(initial_pair->graph_state.get(), &p.copy);
182 initial_pair->requests = MC_state_interleave_size(initial_pair->graph_state.get());
183 initial_pair->search_cycle = false;
185 livenessStack_.push_back(std::move(initial_pair));
191 void LivenessChecker::replay()
193 XBT_DEBUG("**** Begin Replay ****");
195 /* Intermediate backtracking */
196 if(_sg_mc_checkpoint > 0) {
197 simgrid::mc::Pair* pair = livenessStack_.back().get();
198 if(pair->graph_state->system_state){
199 simgrid::mc::restore_snapshot(pair->graph_state->system_state);
204 /* Restore the initial state */
205 simgrid::mc::restore_snapshot(initial_global_state->snapshot);
207 /* Traverse the stack from the initial state and re-execute the transitions */
209 for (std::shared_ptr<Pair> const& pair : livenessStack_) {
210 if (pair == livenessStack_.back())
213 std::shared_ptr<State> state = pair->graph_state;
215 if (pair->exploration_started) {
218 smx_simcall_t saved_req = MC_state_get_executed_request(state.get(), &value);
220 smx_simcall_t req = nullptr;
222 if (saved_req != nullptr) {
223 /* because we got a copy of the executed request, we have to fetch the
224 real one, pointed by the request field of the issuer process */
225 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
226 req = &issuer->simcall;
228 /* Debug information */
229 if (XBT_LOG_ISENABLED(mc_liveness, xbt_log_priority_debug)) {
230 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
231 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state.get());
237 simgrid::mc::handle_simcall(req, value);
238 mc_model_checker->wait_for_requests();
241 /* Update statistics */
242 mc_stats->visited_pairs++;
243 mc_stats->executed_transitions++;
249 XBT_DEBUG("**** End Replay ****");
253 * \brief Checks whether a given pair has already been visited by the algorithm.
255 int LivenessChecker::insertVisitedPair(std::shared_ptr<VisitedPair> visited_pair, simgrid::mc::Pair* pair)
257 if (_sg_mc_visited == 0)
260 if (visited_pair == nullptr)
261 visited_pair = std::make_shared<VisitedPair>(
262 pair->num, pair->automaton_state, pair->atomic_propositions,
265 auto range = std::equal_range(visitedPairs_.begin(), visitedPairs_.end(),
266 visited_pair.get(), simgrid::mc::DerefAndCompareByNbProcessesAndUsedHeap());
268 for (auto i = range.first; i != range.second; ++i) {
269 VisitedPair* pair_test = i->get();
270 if (xbt_automaton_state_compare(
271 pair_test->automaton_state, visited_pair->automaton_state) != 0
272 || pair_test->atomic_propositions != visited_pair->atomic_propositions
273 || this->compare(pair_test, visited_pair.get()) != 0)
275 if (pair_test->other_num == -1)
276 visited_pair->other_num = pair_test->num;
278 visited_pair->other_num = pair_test->other_num;
279 if (dot_output == nullptr)
280 XBT_DEBUG("Pair %d already visited ! (equal to pair %d)",
281 visited_pair->num, pair_test->num);
283 XBT_DEBUG("Pair %d already visited ! (equal to pair %d (pair %d in dot_output))",
284 visited_pair->num, pair_test->num, visited_pair->other_num);
285 (*i) = std::move(visited_pair);
286 return (*i)->other_num;
289 visitedPairs_.insert(range.first, std::move(visited_pair));
290 this->purgeVisitedPairs();
294 void LivenessChecker::purgeVisitedPairs()
296 if (_sg_mc_visited != 0 && visitedPairs_.size() > (std::size_t) _sg_mc_visited) {
297 // Remove the oldest entry with a linear search:
298 visitedPairs_.erase(std::min_element(
299 visitedPairs_.begin(), visitedPairs_.end(),
300 [](std::shared_ptr<VisitedPair> const a, std::shared_ptr<VisitedPair> const& b) {
301 return a->num < b->num; } ));
305 LivenessChecker::LivenessChecker(Session& session) : Checker(session)
309 LivenessChecker::~LivenessChecker()
313 RecordTrace LivenessChecker::getRecordTrace() // override
316 for (std::shared_ptr<Pair> const& pair : livenessStack_) {
318 smx_simcall_t req = MC_state_get_executed_request(pair->graph_state.get(), &value);
319 if (req && req->call != SIMCALL_NONE) {
320 smx_process_t issuer = MC_smx_simcall_get_issuer(req);
321 const int pid = issuer->pid;
323 // Serialization the (pid, value) pair:
324 res.push_back(RecordTraceElement(pid, value));
330 void LivenessChecker::showAcceptanceCycle(std::size_t depth)
332 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
333 XBT_INFO("| ACCEPTANCE CYCLE |");
334 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
335 XBT_INFO("Counter-example that violates formula :");
336 simgrid::mc::dumpRecordPath();
337 for (auto& s : this->getTextualTrace())
338 XBT_INFO("%s", s.c_str());
339 MC_print_statistics(mc_stats);
340 XBT_INFO("Counter-example depth : %zd", depth);
343 std::vector<std::string> LivenessChecker::getTextualTrace() // override
345 std::vector<std::string> trace;
346 for (std::shared_ptr<Pair> const& pair : livenessStack_) {
348 smx_simcall_t req = MC_state_get_executed_request(pair->graph_state.get(), &value);
349 if (req && req->call != SIMCALL_NONE) {
350 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
351 trace.push_back(std::string(req_str));
358 int LivenessChecker::main(void)
360 int visited_num = -1;
362 while (!livenessStack_.empty()){
364 /* Get current pair */
365 std::shared_ptr<Pair> current_pair = livenessStack_.back();
367 /* Update current state in buchi automaton */
368 simgrid::mc::property_automaton->current_state = current_pair->automaton_state;
370 XBT_DEBUG("********************* ( Depth = %d, search_cycle = %d, interleave size = %d, pair_num = %d, requests = %d)",
371 current_pair->depth, current_pair->search_cycle,
372 MC_state_interleave_size(current_pair->graph_state.get()), current_pair->num,
373 current_pair->requests);
375 if (current_pair->requests > 0) {
377 std::shared_ptr<VisitedPair> reached_pair;
378 if (current_pair->automaton_state->type == 1 && !current_pair->exploration_started
379 && (reached_pair = this->insertAcceptancePair(current_pair.get())) == nullptr) {
380 this->showAcceptanceCycle(current_pair->depth);
381 return SIMGRID_MC_EXIT_LIVENESS;
384 /* Pair already visited ? stop the exploration on the current path */
385 if ((!current_pair->exploration_started)
386 && (visited_num = this->insertVisitedPair(
387 reached_pair, current_pair.get())) != -1) {
389 if (dot_output != nullptr){
390 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, visited_num, initial_global_state->prev_req);
394 XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
395 current_pair->requests = 0;
401 smx_simcall_t req = MC_state_get_request(current_pair->graph_state.get(), &value);
403 if (dot_output != nullptr) {
404 if (initial_global_state->prev_pair != 0 && initial_global_state->prev_pair != current_pair->num) {
405 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, current_pair->num, initial_global_state->prev_req);
406 xbt_free(initial_global_state->prev_req);
408 initial_global_state->prev_pair = current_pair->num;
409 initial_global_state->prev_req = simgrid::mc::request_get_dot_output(req, value);
410 if (current_pair->search_cycle)
411 fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
415 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
416 XBT_DEBUG("Execute: %s", req_str);
419 /* Set request as executed */
420 MC_state_set_executed_request(current_pair->graph_state.get(), req, value);
422 /* Update mc_stats */
423 mc_stats->executed_transitions++;
424 if (!current_pair->exploration_started)
425 mc_stats->visited_pairs++;
427 /* Answer the request */
428 simgrid::mc::handle_simcall(req, value);
430 /* Wait for requests (schedules processes) */
431 mc_model_checker->wait_for_requests();
433 current_pair->requests--;
434 current_pair->exploration_started = true;
436 /* Get values of atomic propositions (variables used in the property formula) */
437 std::vector<int> prop_values = this->getPropositionValues();
439 /* Evaluate enabled/true transitions in automaton according to atomic propositions values and create new pairs */
440 int cursor = xbt_dynar_length(current_pair->automaton_state->out) - 1;
441 while (cursor >= 0) {
442 xbt_automaton_transition_t transition_succ = (xbt_automaton_transition_t)xbt_dynar_get_as(current_pair->automaton_state->out, cursor, xbt_automaton_transition_t);
443 if (evaluate_label(transition_succ->label, prop_values)) {
444 std::shared_ptr<Pair> next_pair = std::make_shared<Pair>();
445 next_pair->graph_state = std::shared_ptr<simgrid::mc::State>(MC_state_new());
446 next_pair->automaton_state = transition_succ->dst;
447 next_pair->atomic_propositions = this->getPropositionValues();
448 next_pair->depth = current_pair->depth + 1;
449 /* Get enabled processes and insert them in the interleave set of the next graph_state */
450 for (auto& p : mc_model_checker->process().simix_processes())
451 if (simgrid::mc::process_is_enabled(&p.copy))
452 MC_state_interleave_process(next_pair->graph_state.get(), &p.copy);
454 next_pair->requests = MC_state_interleave_size(next_pair->graph_state.get());
456 /* FIXME : get search_cycle value for each acceptant state */
457 if (next_pair->automaton_state->type == 1 || current_pair->search_cycle)
458 next_pair->search_cycle = true;
460 /* Add new pair to the exploration stack */
461 livenessStack_.push_back(std::move(next_pair));
467 } /* End of visited_pair test */
472 if(visited_num == -1)
473 XBT_DEBUG("No more request to execute. Looking for backtracking point.");
475 /* Traverse the stack backwards until a pair with a non empty interleave
476 set is found, deleting all the pairs that have it empty in the way. */
477 while (!livenessStack_.empty()) {
478 std::shared_ptr<simgrid::mc::Pair> current_pair = livenessStack_.back();
479 livenessStack_.pop_back();
480 if (current_pair->requests > 0) {
481 /* We found a backtracking point */
482 XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
483 livenessStack_.push_back(std::move(current_pair));
485 XBT_DEBUG("Backtracking done");
488 XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
489 if (current_pair->automaton_state->type == 1)
490 this->removeAcceptancePair(current_pair->num);
494 } /* End of if (current_pair->requests > 0) else ... */
498 XBT_INFO("No property violation found.");
499 MC_print_statistics(mc_stats);
500 return SIMGRID_MC_EXIT_SUCCESS;
503 int LivenessChecker::run()
505 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
506 MC_automaton_load(_sg_mc_property_file);
507 mc_model_checker->wait_for_requests();
509 XBT_DEBUG("Starting the liveness algorithm");
511 /* Create the initial state */
512 simgrid::mc::initial_global_state = std::unique_ptr<s_mc_global_t>(new s_mc_global_t());
515 int res = this->main();
516 simgrid::mc::initial_global_state = nullptr;
521 Checker* createLivenessChecker(Session& session)
523 return new LivenessChecker(session);