Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Use std::equal_range in get_search_range()
[simgrid.git] / src / mc / mc_liveness.cpp
1 /* Copyright (c) 2011-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include <cstring>
8
9 #include <unistd.h>
10 #include <sys/wait.h>
11
12 #include <xbt/automaton.h>
13 #include <xbt/dynar.h>
14 #include <xbt/fifo.h>
15 #include <xbt/log.h>
16 #include <xbt/sysdep.h>
17
18 #include "src/mc/mc_request.h"
19 #include "src/mc/mc_liveness.h"
20 #include "src/mc/mc_private.h"
21 #include "src/mc/mc_record.h"
22 #include "src/mc/mc_smx.h"
23 #include "src/mc/Client.hpp"
24 #include "src/mc/mc_private.h"
25 #include "src/mc/mc_replay.h"
26 #include "src/mc/mc_safety.h"
27 #include "src/mc/mc_exit.h"
28
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_liveness, mc,
30                                 "Logging specific to algorithms for liveness properties verification");
31
32 /********* Global variables *********/
33
34 xbt_dynar_t acceptance_pairs;
35
36 /********* Static functions *********/
37
38 namespace simgrid {
39 namespace mc {
40
41 static xbt_dynar_t visited_pairs;
42
43 Pair::Pair() : num(++mc_stats->expanded_pairs),
44   visited_pair_removed(_sg_mc_visited > 0 ? 0 : 1)
45 {}
46
47 Pair::~Pair() {
48   if (this->visited_pair_removed)
49     MC_state_delete(this->graph_state, 1);
50 }
51
52 static  void show_stack_liveness(xbt_fifo_t stack)
53 {
54   int value;
55   simgrid::mc::Pair* pair;
56   xbt_fifo_item_t item;
57   smx_simcall_t req;
58   char *req_str = nullptr;
59
60   for (item = xbt_fifo_get_last_item(stack);
61        item; item = xbt_fifo_get_prev_item(item)) {
62     pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
63     req = MC_state_get_executed_request(pair->graph_state, &value);
64     if (req && req->call != SIMCALL_NONE) {
65       req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
66       XBT_INFO("%s", req_str);
67       xbt_free(req_str);
68     }
69   }
70 }
71
72 static void dump_stack_liveness(xbt_fifo_t stack)
73 {
74   simgrid::mc::Pair* pair;
75   while ((pair = (simgrid::mc::Pair*) xbt_fifo_pop(stack)) != nullptr)
76     delete pair;
77 }
78
79 static simgrid::xbt::unique_ptr<s_xbt_dynar_t> get_atomic_propositions_values()
80 {
81   unsigned int cursor = 0;
82   xbt_automaton_propositional_symbol_t ps = nullptr;
83   simgrid::xbt::unique_ptr<s_xbt_dynar_t> values = simgrid::xbt::unique_ptr<s_xbt_dynar_t>(xbt_dynar_new(sizeof(int), nullptr));
84   xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, ps) {
85     int res = xbt_automaton_propositional_symbol_evaluate(ps);
86     xbt_dynar_push_as(values.get(), int, res);
87   }
88   return std::move(values);
89 }
90
91 static int snapshot_compare(simgrid::mc::VisitedPair* state1, simgrid::mc::VisitedPair* state2)
92 {
93   simgrid::mc::Snapshot* s1 = state1->graph_state->system_state;
94   simgrid::mc::Snapshot* s2 = state2->graph_state->system_state;
95   int num1 = state1->num;
96   int num2 = state2->num;
97   return snapshot_compare(num1, s1, num2, s2);
98 }
99
100 static simgrid::mc::VisitedPair* is_reached_acceptance_pair(simgrid::mc::Pair* pair)
101 {
102   simgrid::mc::VisitedPair* new_pair = new VisitedPair(
103     pair->num, pair->automaton_state, pair->atomic_propositions.get(),
104     pair->graph_state);
105   new_pair->acceptance_pair = 1;
106
107   if (xbt_dynar_is_empty(acceptance_pairs))
108     xbt_dynar_push(acceptance_pairs, &new_pair);
109   else {
110
111     int min = -1, max = -1, index;
112     //int res;
113     simgrid::mc::VisitedPair* pair_test;
114     int cursor;
115
116     index = simgrid::mc::get_search_interval(
117       (simgrid::mc::VisitedPair**) xbt_dynar_get_ptr(acceptance_pairs, 0),
118       xbt_dynar_length(acceptance_pairs),
119       new_pair, &min, &max);
120
121     if (min != -1 && max != -1) {       // Acceptance pair with same number of processes and same heap bytes used exists
122
123       cursor = min;
124       if(pair->search_cycle == 1){
125         while (cursor <= max) {
126           pair_test = (simgrid::mc::VisitedPair*) xbt_dynar_get_as(acceptance_pairs, cursor, simgrid::mc::VisitedPair*);
127           if (xbt_automaton_state_compare(pair_test->automaton_state, new_pair->automaton_state) == 0) {
128             if (xbt_automaton_propositional_symbols_compare_value(
129                 pair_test->atomic_propositions.get(),
130                 new_pair->atomic_propositions.get()) == 0) {
131               if (snapshot_compare(pair_test, new_pair) == 0) {
132                 XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
133                 xbt_fifo_shift(mc_stack);
134                 if (dot_output != nullptr)
135                   fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, pair_test->num, initial_global_state->prev_req);
136                 return nullptr;
137               }
138             }
139           }
140           cursor++;
141         }
142       }
143       xbt_dynar_insert_at(acceptance_pairs, min, &new_pair);
144     } else {
145       xbt_dynar_insert_at(acceptance_pairs, index, &new_pair);
146     }
147   }
148   return new_pair;
149 }
150
151 static void remove_acceptance_pair(int pair_num)
152 {
153   unsigned int cursor = 0;
154   simgrid::mc::VisitedPair* pair_test = nullptr;
155   int pair_found = 0;
156
157   xbt_dynar_foreach(acceptance_pairs, cursor, pair_test)
158     if (pair_test->num == pair_num) {
159        pair_found = 1;
160       break;
161     }
162
163   if(pair_found == 1) {
164     xbt_dynar_remove_at(acceptance_pairs, cursor, &pair_test);
165
166     pair_test->acceptance_removed = 1;
167
168     if (_sg_mc_visited == 0 || pair_test->visited_removed == 1) 
169       delete pair_test;
170
171   }
172 }
173
174
175 static int MC_automaton_evaluate_label(xbt_automaton_exp_label_t l,
176                                        xbt_dynar_t atomic_propositions_values)
177 {
178
179   switch (l->type) {
180   case 0:{
181       int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
182       int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
183       return (left_res || right_res);
184     }
185   case 1:{
186       int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
187       int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
188       return (left_res && right_res);
189     }
190   case 2:{
191       int res = MC_automaton_evaluate_label(l->u.exp_not, atomic_propositions_values);
192       return (!res);
193     }
194   case 3:{
195       unsigned int cursor = 0;
196       xbt_automaton_propositional_symbol_t p = nullptr;
197       xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
198         if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
199           return (int) xbt_dynar_get_as(atomic_propositions_values, cursor, int);
200       }
201       return -1;
202     }
203   case 4:
204     return 2;
205   default:
206     return -1;
207   }
208 }
209
210 static void MC_pre_modelcheck_liveness(void)
211 {
212   simgrid::mc::Pair* initial_pair = nullptr;
213   mc_model_checker->wait_for_requests();
214   acceptance_pairs = xbt_dynar_new(sizeof(simgrid::mc::VisitedPair*), nullptr);
215   if(_sg_mc_visited > 0)
216     simgrid::mc::visited_pairs = xbt_dynar_new(sizeof(simgrid::mc::VisitedPair*), nullptr);
217
218   initial_global_state->snapshot = simgrid::mc::take_snapshot(0);
219   initial_global_state->prev_pair = 0;
220
221   unsigned int cursor = 0;
222   xbt_automaton_state_t automaton_state;
223   
224   xbt_dynar_foreach(simgrid::mc::property_automaton->states, cursor, automaton_state) {
225     if (automaton_state->type == -1) {  /* Initial automaton state */
226
227       initial_pair = new Pair();
228       initial_pair->automaton_state = automaton_state;
229       initial_pair->graph_state = MC_state_new();
230       initial_pair->atomic_propositions = get_atomic_propositions_values();
231       initial_pair->depth = 1;
232
233       /* Get enabled processes and insert them in the interleave set of the graph_state */
234       for (auto& p : mc_model_checker->process().simix_processes())
235         if (simgrid::mc::process_is_enabled(&p.copy))
236           MC_state_interleave_process(initial_pair->graph_state, &p.copy);
237
238       initial_pair->requests = MC_state_interleave_size(initial_pair->graph_state);
239       initial_pair->search_cycle = 0;
240
241       xbt_fifo_unshift(mc_stack, initial_pair);
242     }
243   }
244 }
245
246 static void MC_replay_liveness(xbt_fifo_t stack)
247 {
248   xbt_fifo_item_t item;
249   simgrid::mc::Pair* pair = nullptr;
250   mc_state_t state = nullptr;
251   smx_simcall_t req = nullptr, saved_req = NULL;
252   int value, depth = 1;
253   char *req_str;
254
255   XBT_DEBUG("**** Begin Replay ****");
256
257   /* Intermediate backtracking */
258   if(_sg_mc_checkpoint > 0) {
259     item = xbt_fifo_get_first_item(stack);
260     pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
261     if(pair->graph_state->system_state){
262       simgrid::mc::restore_snapshot(pair->graph_state->system_state);
263       return;
264     }
265   }
266
267   /* Restore the initial state */
268   simgrid::mc::restore_snapshot(initial_global_state->snapshot);
269
270     /* Traverse the stack from the initial state and re-execute the transitions */
271     for (item = xbt_fifo_get_last_item(stack);
272          item != xbt_fifo_get_first_item(stack);
273          item = xbt_fifo_get_prev_item(item)) {
274
275       pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(item);
276
277       state = (mc_state_t) pair->graph_state;
278
279       if (pair->exploration_started) {
280
281         saved_req = MC_state_get_executed_request(state, &value);
282
283         if (saved_req != nullptr) {
284           /* because we got a copy of the executed request, we have to fetch the
285              real one, pointed by the request field of the issuer process */
286           const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
287           req = &issuer->simcall;
288
289           /* Debug information */
290           if (XBT_LOG_ISENABLED(mc_liveness, xbt_log_priority_debug)) {
291             req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
292             XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
293             xbt_free(req_str);
294           }
295
296         }
297
298         simgrid::mc::handle_simcall(req, value);
299         mc_model_checker->wait_for_requests();
300       }
301
302       /* Update statistics */
303       mc_stats->visited_pairs++;
304       mc_stats->executed_transitions++;
305
306       depth++;
307
308     }
309
310   XBT_DEBUG("**** End Replay ****");
311 }
312
313 /**
314  * \brief Checks whether a given pair has already been visited by the algorithm.
315  */
316 static
317 int is_visited_pair(simgrid::mc::VisitedPair* visited_pair, simgrid::mc::Pair* pair)
318 {
319   if (_sg_mc_visited == 0)
320     return -1;
321
322   simgrid::mc::VisitedPair* new_visited_pair = nullptr;
323   if (visited_pair == nullptr)
324     new_visited_pair = new simgrid::mc::VisitedPair(
325       pair->num, pair->automaton_state, pair->atomic_propositions.get(),
326       pair->graph_state);
327   else
328     new_visited_pair = visited_pair;
329
330   if (xbt_dynar_is_empty(visited_pairs)) {
331     xbt_dynar_push(visited_pairs, &new_visited_pair);
332     return -1;
333   }
334
335     int min = -1, max = -1, index;
336     //int res;
337     simgrid::mc::VisitedPair* pair_test;
338     int cursor;
339
340     index = get_search_interval(
341       (simgrid::mc::VisitedPair**) xbt_dynar_get_ptr(visited_pairs, 0),
342       xbt_dynar_length(visited_pairs), new_visited_pair, &min, &max);
343
344     if (min != -1 && max != -1) {       // Visited pair with same number of processes and same heap bytes used exists
345       cursor = min;
346       while (cursor <= max) {
347         pair_test = (simgrid::mc::VisitedPair*) xbt_dynar_get_as(visited_pairs, cursor, simgrid::mc::VisitedPair*);
348         if (xbt_automaton_state_compare(pair_test->automaton_state, new_visited_pair->automaton_state) == 0) {
349           if (xbt_automaton_propositional_symbols_compare_value(
350               pair_test->atomic_propositions.get(),
351               new_visited_pair->atomic_propositions.get()) == 0) {
352             if (snapshot_compare(pair_test, new_visited_pair) == 0) {
353               if (pair_test->other_num == -1)
354                 new_visited_pair->other_num = pair_test->num;
355               else
356                 new_visited_pair->other_num = pair_test->other_num;
357               if (dot_output == nullptr)
358                 XBT_DEBUG("Pair %d already visited ! (equal to pair %d)", new_visited_pair->num, pair_test->num);
359               else
360                 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);
361               xbt_dynar_remove_at(visited_pairs, cursor, &pair_test);
362               xbt_dynar_insert_at(visited_pairs, cursor, &new_visited_pair);
363               pair_test->visited_removed = 1;
364               if (!pair_test->acceptance_pair
365                   || pair_test->acceptance_removed == 1)
366                 delete pair_test;
367               return new_visited_pair->other_num;
368             }
369           }
370         }
371         cursor++;
372       }
373       xbt_dynar_insert_at(visited_pairs, min, &new_visited_pair);
374     } else {
375       xbt_dynar_insert_at(visited_pairs, index, &new_visited_pair);
376     }
377
378     if ((ssize_t) xbt_dynar_length(visited_pairs) > _sg_mc_visited) {
379       int min2 = mc_stats->expanded_pairs;
380       unsigned int cursor2 = 0;
381       unsigned int index2 = 0;
382       xbt_dynar_foreach(visited_pairs, cursor2, pair_test) {
383         if (!mc_model_checker->is_important_snapshot(*pair_test->graph_state->system_state)
384             && pair_test->num < min2) {
385           index2 = cursor2;
386           min2 = pair_test->num;
387         }
388       }
389       xbt_dynar_remove_at(visited_pairs, index2, &pair_test);
390       pair_test->visited_removed = 1;
391       if (!pair_test->acceptance_pair || pair_test->acceptance_removed)
392         delete pair_test;
393     }
394   return -1;
395 }
396
397 static int MC_modelcheck_liveness_main(void)
398 {
399   simgrid::mc::Pair* current_pair = nullptr;
400   int value, res, visited_num = -1;
401   smx_simcall_t req = nullptr;
402   xbt_automaton_transition_t transition_succ = nullptr;
403   int cursor = 0;
404   simgrid::mc::Pair* next_pair = nullptr;
405   simgrid::xbt::unique_ptr<s_xbt_dynar_t> prop_values;
406   simgrid::mc::VisitedPair* reached_pair = nullptr;
407   
408   while(xbt_fifo_size(mc_stack) > 0){
409
410     /* Get current pair */
411     current_pair = (simgrid::mc::Pair*) xbt_fifo_get_item_content(xbt_fifo_get_first_item(mc_stack));
412
413     /* Update current state in buchi automaton */
414     simgrid::mc::property_automaton->current_state = current_pair->automaton_state;
415
416     XBT_DEBUG("********************* ( Depth = %d, search_cycle = %d, interleave size = %d, pair_num = %d, requests = %d)",
417        current_pair->depth, current_pair->search_cycle,
418        MC_state_interleave_size(current_pair->graph_state), current_pair->num,
419        current_pair->requests);
420
421     if (current_pair->requests > 0) {
422
423       if (current_pair->automaton_state->type == 1 && current_pair->exploration_started == 0) {
424         /* If new acceptance pair, return new pair */
425         if ((reached_pair = is_reached_acceptance_pair(current_pair)) == nullptr) {
426           int counter_example_depth = current_pair->depth;
427           XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
428           XBT_INFO("|             ACCEPTANCE CYCLE            |");
429           XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
430           XBT_INFO("Counter-example that violates formula :");
431           MC_record_dump_path(mc_stack);
432           simgrid::mc::show_stack_liveness(mc_stack);
433           simgrid::mc::dump_stack_liveness(mc_stack);
434           MC_print_statistics(mc_stats);
435           XBT_INFO("Counter-example depth : %d", counter_example_depth);
436           return SIMGRID_MC_EXIT_LIVENESS;
437         }
438       }
439
440       /* Pair already visited ? stop the exploration on the current path */
441       if ((current_pair->exploration_started == 0)
442         && (visited_num = simgrid::mc::is_visited_pair(
443           reached_pair, current_pair)) != -1) {
444
445         if (dot_output != nullptr){
446           fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, visited_num, initial_global_state->prev_req);
447           fflush(dot_output);
448         }
449
450         XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
451         current_pair->requests = 0;
452         goto backtracking;
453         
454       }else{
455
456         req = MC_state_get_request(current_pair->graph_state, &value);
457
458          if (dot_output != nullptr) {
459            if (initial_global_state->prev_pair != 0 && initial_global_state->prev_pair != current_pair->num) {
460              fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, current_pair->num, initial_global_state->prev_req);
461              xbt_free(initial_global_state->prev_req);
462            }
463            initial_global_state->prev_pair = current_pair->num;
464            initial_global_state->prev_req = simgrid::mc::request_get_dot_output(req, value);
465            if (current_pair->search_cycle)
466              fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
467            fflush(dot_output);
468          }
469
470          char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
471          XBT_DEBUG("Execute: %s", req_str);
472          xbt_free(req_str);
473
474          /* Set request as executed */
475          MC_state_set_executed_request(current_pair->graph_state, req, value);
476
477          /* Update mc_stats */
478          mc_stats->executed_transitions++;
479          if(current_pair->exploration_started == 0)
480            mc_stats->visited_pairs++;
481
482          /* Answer the request */
483          simgrid::mc::handle_simcall(req, value);
484          
485          /* Wait for requests (schedules processes) */
486          mc_model_checker->wait_for_requests();
487
488          current_pair->requests--;
489          current_pair->exploration_started = 1;
490
491          /* Get values of atomic propositions (variables used in the property formula) */ 
492          prop_values = get_atomic_propositions_values();
493
494          /* Evaluate enabled/true transitions in automaton according to atomic propositions values and create new pairs */
495          cursor = xbt_dynar_length(current_pair->automaton_state->out) - 1;
496          while (cursor >= 0) {
497            transition_succ = (xbt_automaton_transition_t)xbt_dynar_get_as(current_pair->automaton_state->out, cursor, xbt_automaton_transition_t);
498            res = MC_automaton_evaluate_label(transition_succ->label, prop_values.get());
499            if (res == 1 || res == 2) { /* 1 = True transition (always enabled), 2 = enabled transition according to atomic prop values */
500               next_pair = new Pair();
501               next_pair->graph_state = MC_state_new();
502               next_pair->automaton_state = transition_succ->dst;
503               next_pair->atomic_propositions = get_atomic_propositions_values();
504               next_pair->depth = current_pair->depth + 1;
505               /* Get enabled processes and insert them in the interleave set of the next graph_state */
506               for (auto& p : mc_model_checker->process().simix_processes())
507                 if (simgrid::mc::process_is_enabled(&p.copy))
508                   MC_state_interleave_process(next_pair->graph_state, &p.copy);
509
510               next_pair->requests = MC_state_interleave_size(next_pair->graph_state);
511
512               /* FIXME : get search_cycle value for each acceptant state */
513               if (next_pair->automaton_state->type == 1 || current_pair->search_cycle)
514                 next_pair->search_cycle = 1;
515
516               /* Add new pair to the exploration stack */
517               xbt_fifo_unshift(mc_stack, next_pair);
518
519            }
520            cursor--;
521          }
522
523       } /* End of visited_pair test */
524       
525     } else {
526
527     backtracking:
528       if(visited_num == -1)
529         XBT_DEBUG("No more request to execute. Looking for backtracking point.");
530     
531       prop_values.reset();
532     
533       /* Traverse the stack backwards until a pair with a non empty interleave
534          set is found, deleting all the pairs that have it empty in the way. */
535       while ((current_pair = (simgrid::mc::Pair*) xbt_fifo_shift(mc_stack)) != nullptr) {
536         if (current_pair->requests > 0) {
537           /* We found a backtracking point */
538           XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
539           xbt_fifo_unshift(mc_stack, current_pair);
540           MC_replay_liveness(mc_stack);
541           XBT_DEBUG("Backtracking done");
542           break;
543         }else{
544           /* Delete pair */
545           XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
546           if (current_pair->automaton_state->type == 1) 
547             remove_acceptance_pair(current_pair->num);
548           delete current_pair;
549         }
550       }
551
552     } /* End of if (current_pair->requests > 0) else ... */
553     
554   } /* End of while(xbt_fifo_size(mc_stack) > 0) */
555
556   XBT_INFO("No property violation found.");
557   MC_print_statistics(mc_stats);
558   return SIMGRID_MC_EXIT_SUCCESS;
559 }
560
561 int modelcheck_liveness(void)
562 {
563   XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
564   MC_automaton_load(_sg_mc_property_file);
565   mc_model_checker->wait_for_requests();
566
567   XBT_DEBUG("Starting the liveness algorithm");
568   _sg_mc_liveness = 1;
569
570   /* Create exploration stack */
571   mc_stack = xbt_fifo_new();
572
573   /* Create the initial state */
574   initial_global_state = xbt_new0(s_mc_global_t, 1);
575
576   MC_pre_modelcheck_liveness();
577   int res = MC_modelcheck_liveness_main();
578
579   /* We're done */
580   simgrid::mc::processes_time.clear();
581
582   return res;
583 }
584
585 }
586 }