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::shared_ptr<const std::vector<int>> atomic_propositions,
44 std::shared_ptr<simgrid::mc::State> graph_state)
46 simgrid::mc::Process* process = &(mc_model_checker->process());
48 this->graph_state = std::move(graph_state);
49 if(this->graph_state->system_state == nullptr)
50 this->graph_state->system_state = simgrid::mc::take_snapshot(pair_num);
51 this->heap_bytes_used = mmalloc_get_bytes_used_remote(
52 process->get_heap()->heaplimit,
53 process->get_malloc_info());
55 this->nb_processes = mc_model_checker->process().simix_processes().size();
57 this->automaton_state = automaton_state;
60 this->atomic_propositions = std::move(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::shared_ptr<const 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));
107 return std::make_shared<const std::vector<int>>(std::move(values));
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 explorationStack_.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();
161 initial_global_state->snapshot = simgrid::mc::take_snapshot(0);
162 initial_global_state->prev_pair = 0;
164 std::shared_ptr<const std::vector<int>> propos = this->getPropositionValues();
166 // For each initial state of the property automaton, push a
167 // (application_state, automaton_state) pair to the exploration stack:
168 unsigned int cursor = 0;
169 xbt_automaton_state_t automaton_state;
170 xbt_dynar_foreach(simgrid::mc::property_automaton->states, cursor, automaton_state)
171 if (automaton_state->type == -1)
172 explorationStack_.push_back(this->newPair(nullptr, automaton_state, propos));
176 void LivenessChecker::replay()
178 XBT_DEBUG("**** Begin Replay ****");
180 /* Intermediate backtracking */
181 if(_sg_mc_checkpoint > 0) {
182 simgrid::mc::Pair* pair = explorationStack_.back().get();
183 if(pair->graph_state->system_state){
184 simgrid::mc::restore_snapshot(pair->graph_state->system_state);
189 /* Restore the initial state */
190 simgrid::mc::restore_snapshot(initial_global_state->snapshot);
192 /* Traverse the stack from the initial state and re-execute the transitions */
194 for (std::shared_ptr<Pair> const& pair : explorationStack_) {
195 if (pair == explorationStack_.back())
198 std::shared_ptr<State> state = pair->graph_state;
200 if (pair->exploration_started) {
203 smx_simcall_t saved_req = MC_state_get_executed_request(state.get(), &value);
205 smx_simcall_t req = nullptr;
207 if (saved_req != nullptr) {
208 /* because we got a copy of the executed request, we have to fetch the
209 real one, pointed by the request field of the issuer process */
210 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
211 req = &issuer->simcall;
213 /* Debug information */
214 if (XBT_LOG_ISENABLED(mc_liveness, xbt_log_priority_debug)) {
215 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
216 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state.get());
222 simgrid::mc::handle_simcall(req, value);
223 mc_model_checker->wait_for_requests();
226 /* Update statistics */
227 mc_stats->visited_pairs++;
228 mc_stats->executed_transitions++;
234 XBT_DEBUG("**** End Replay ****");
238 * \brief Checks whether a given pair has already been visited by the algorithm.
240 int LivenessChecker::insertVisitedPair(std::shared_ptr<VisitedPair> visited_pair, simgrid::mc::Pair* pair)
242 if (_sg_mc_visited == 0)
245 if (visited_pair == nullptr)
246 visited_pair = std::make_shared<VisitedPair>(
247 pair->num, pair->automaton_state, pair->atomic_propositions,
250 auto range = std::equal_range(visitedPairs_.begin(), visitedPairs_.end(),
251 visited_pair.get(), simgrid::mc::DerefAndCompareByNbProcessesAndUsedHeap());
253 for (auto i = range.first; i != range.second; ++i) {
254 VisitedPair* pair_test = i->get();
255 if (xbt_automaton_state_compare(
256 pair_test->automaton_state, visited_pair->automaton_state) != 0
257 || *(pair_test->atomic_propositions) != *(visited_pair->atomic_propositions)
258 || this->compare(pair_test, visited_pair.get()) != 0)
260 if (pair_test->other_num == -1)
261 visited_pair->other_num = pair_test->num;
263 visited_pair->other_num = pair_test->other_num;
264 if (dot_output == nullptr)
265 XBT_DEBUG("Pair %d already visited ! (equal to pair %d)", visited_pair->num, pair_test->num);
267 XBT_DEBUG("Pair %d already visited ! (equal to pair %d (pair %d in dot_output))",
268 visited_pair->num, pair_test->num, visited_pair->other_num);
269 (*i) = std::move(visited_pair);
270 return (*i)->other_num;
273 visitedPairs_.insert(range.first, std::move(visited_pair));
274 this->purgeVisitedPairs();
278 void LivenessChecker::purgeVisitedPairs()
280 if (_sg_mc_visited != 0 && visitedPairs_.size() > (std::size_t) _sg_mc_visited) {
281 // Remove the oldest entry with a linear search:
282 visitedPairs_.erase(std::min_element(
283 visitedPairs_.begin(), visitedPairs_.end(),
284 [](std::shared_ptr<VisitedPair> const a, std::shared_ptr<VisitedPair> const& b) {
285 return a->num < b->num; } ));
289 LivenessChecker::LivenessChecker(Session& session) : Checker(session)
293 LivenessChecker::~LivenessChecker()
297 RecordTrace LivenessChecker::getRecordTrace() // override
300 for (std::shared_ptr<Pair> const& pair : explorationStack_) {
302 smx_simcall_t req = MC_state_get_executed_request(pair->graph_state.get(), &value);
303 if (req && req->call != SIMCALL_NONE) {
304 smx_process_t issuer = MC_smx_simcall_get_issuer(req);
305 const int pid = issuer->pid;
306 res.push_back(RecordTraceElement(pid, value));
312 void LivenessChecker::showAcceptanceCycle(std::size_t depth)
314 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
315 XBT_INFO("| ACCEPTANCE CYCLE |");
316 XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
317 XBT_INFO("Counter-example that violates formula :");
318 simgrid::mc::dumpRecordPath();
319 for (auto& s : this->getTextualTrace())
320 XBT_INFO("%s", s.c_str());
321 MC_print_statistics(mc_stats);
322 XBT_INFO("Counter-example depth : %zd", depth);
325 std::vector<std::string> LivenessChecker::getTextualTrace() // override
327 std::vector<std::string> trace;
328 for (std::shared_ptr<Pair> const& pair : explorationStack_) {
330 smx_simcall_t req = MC_state_get_executed_request(pair->graph_state.get(), &value);
331 if (req && req->call != SIMCALL_NONE) {
332 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
333 trace.push_back(std::string(req_str));
340 int LivenessChecker::main(void)
342 while (!explorationStack_.empty()){
343 std::shared_ptr<Pair> current_pair = explorationStack_.back();
345 /* Update current state in buchi automaton */
346 simgrid::mc::property_automaton->current_state = current_pair->automaton_state;
348 XBT_DEBUG("********************* ( Depth = %d, search_cycle = %d, interleave size = %d, pair_num = %d, requests = %d)",
349 current_pair->depth, current_pair->search_cycle,
350 MC_state_interleave_size(current_pair->graph_state.get()), current_pair->num,
351 current_pair->requests);
353 if (current_pair->requests == 0) {
358 std::shared_ptr<VisitedPair> reached_pair;
359 if (current_pair->automaton_state->type == 1 && !current_pair->exploration_started
360 && (reached_pair = this->insertAcceptancePair(current_pair.get())) == nullptr) {
361 this->showAcceptanceCycle(current_pair->depth);
362 return SIMGRID_MC_EXIT_LIVENESS;
365 /* Pair already visited ? stop the exploration on the current path */
366 int visited_num = -1;
367 if ((!current_pair->exploration_started)
368 && (visited_num = this->insertVisitedPair(
369 reached_pair, current_pair.get())) != -1) {
370 if (dot_output != nullptr){
371 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, visited_num, initial_global_state->prev_req);
374 XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
375 current_pair->requests = 0;
381 smx_simcall_t req = MC_state_get_request(current_pair->graph_state.get(), &value);
383 if (dot_output != nullptr) {
384 if (initial_global_state->prev_pair != 0 && initial_global_state->prev_pair != current_pair->num) {
385 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, current_pair->num, initial_global_state->prev_req);
386 xbt_free(initial_global_state->prev_req);
388 initial_global_state->prev_pair = current_pair->num;
389 initial_global_state->prev_req = simgrid::mc::request_get_dot_output(req, value);
390 if (current_pair->search_cycle)
391 fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
395 char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
396 XBT_DEBUG("Execute: %s", req_str);
399 /* Set request as executed */
400 MC_state_set_executed_request(current_pair->graph_state.get(), req, value);
402 /* Update mc_stats */
403 mc_stats->executed_transitions++;
404 if (!current_pair->exploration_started)
405 mc_stats->visited_pairs++;
407 /* Answer the request */
408 simgrid::mc::handle_simcall(req, value);
410 /* Wait for requests (schedules processes) */
411 mc_model_checker->wait_for_requests();
413 current_pair->requests--;
414 current_pair->exploration_started = true;
416 /* Get values of atomic propositions (variables used in the property formula) */
417 std::shared_ptr<const std::vector<int>> prop_values = this->getPropositionValues();
419 // For each enabled transition in the property automaton, push a
420 // (application_state, automaton_state) pair to the exploration stack:
421 int cursor = xbt_dynar_length(current_pair->automaton_state->out) - 1;
422 while (cursor >= 0) {
423 xbt_automaton_transition_t transition_succ = (xbt_automaton_transition_t)xbt_dynar_get_as(current_pair->automaton_state->out, cursor, xbt_automaton_transition_t);
424 if (evaluate_label(transition_succ->label, *prop_values))
425 explorationStack_.push_back(this->newPair(
426 current_pair.get(), transition_succ->dst, prop_values));
432 XBT_INFO("No property violation found.");
433 MC_print_statistics(mc_stats);
434 return SIMGRID_MC_EXIT_SUCCESS;
437 std::shared_ptr<Pair> LivenessChecker::newPair(Pair* current_pair, xbt_automaton_state_t state, std::shared_ptr<const std::vector<int>> propositions)
439 std::shared_ptr<Pair> next_pair = std::make_shared<Pair>();
440 next_pair->automaton_state = state;
441 next_pair->graph_state = std::shared_ptr<simgrid::mc::State>(MC_state_new());
442 next_pair->atomic_propositions = std::move(propositions);
444 next_pair->depth = current_pair->depth + 1;
446 next_pair->depth = 1;
447 /* Get enabled processes and insert them in the interleave set of the next graph_state */
448 for (auto& p : mc_model_checker->process().simix_processes())
449 if (simgrid::mc::process_is_enabled(&p.copy))
450 MC_state_interleave_process(next_pair->graph_state.get(), &p.copy);
451 next_pair->requests = MC_state_interleave_size(next_pair->graph_state.get());
452 /* FIXME : get search_cycle value for each acceptant state */
453 if (next_pair->automaton_state->type == 1 ||
454 (current_pair && current_pair->search_cycle))
455 next_pair->search_cycle = true;
457 next_pair->search_cycle = false;
458 return std::move(next_pair);
461 void LivenessChecker::backtrack()
463 /* Traverse the stack backwards until a pair with a non empty interleave
464 set is found, deleting all the pairs that have it empty in the way. */
465 while (!explorationStack_.empty()) {
466 std::shared_ptr<simgrid::mc::Pair> current_pair = explorationStack_.back();
467 explorationStack_.pop_back();
468 if (current_pair->requests > 0) {
469 /* We found a backtracking point */
470 XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
471 explorationStack_.push_back(std::move(current_pair));
473 XBT_DEBUG("Backtracking done");
476 XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
477 if (current_pair->automaton_state->type == 1)
478 this->removeAcceptancePair(current_pair->num);
483 int LivenessChecker::run()
485 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
486 MC_automaton_load(_sg_mc_property_file);
487 mc_model_checker->wait_for_requests();
489 XBT_DEBUG("Starting the liveness algorithm");
491 /* Create the initial state */
492 simgrid::mc::initial_global_state = std::unique_ptr<s_mc_global_t>(new s_mc_global_t());
495 int res = this->main();
496 simgrid::mc::initial_global_state = nullptr;
501 Checker* createLivenessChecker(Session& session)
503 return new LivenessChecker(session);