Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merging changes done by Steven, Samuel and Luka, regarding simulation of StarPU-MPI
[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 <unistd.h>
8 #include <sys/wait.h>
9
10 #include <xbt/dynar.h>
11 #include <xbt/automaton.h>
12
13 #include "src/mc/mc_request.h"
14 #include "src/mc/mc_liveness.h"
15 #include "src/mc/mc_private.h"
16 #include "src/mc/mc_record.h"
17 #include "src/mc/mc_smx.h"
18 #include "src/mc/mc_client.h"
19 #include "src/mc/mc_replay.h"
20 #include "src/mc/mc_safety.h"
21 #include "src/mc/mc_exit.h"
22
23 extern "C" {
24
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_liveness, mc,
26                                 "Logging specific to algorithms for liveness properties verification");
27
28 /********* Global variables *********/
29
30 xbt_dynar_t acceptance_pairs;
31 xbt_parmap_t parmap;
32
33 /********* Static functions *********/
34
35 static xbt_dynar_t get_atomic_propositions_values()
36 {
37   unsigned int cursor = 0;
38   xbt_automaton_propositional_symbol_t ps = NULL;
39   xbt_dynar_t values = xbt_dynar_new(sizeof(int), NULL);
40   xbt_dynar_foreach(_mc_property_automaton->propositional_symbols, cursor, ps) {
41     int res = xbt_automaton_propositional_symbol_evaluate(ps);
42     xbt_dynar_push_as(values, int, res);
43   }
44
45   return values;
46 }
47
48 static mc_visited_pair_t is_reached_acceptance_pair(mc_pair_t pair)
49 {
50   mc_visited_pair_t new_pair = NULL;
51   new_pair = MC_visited_pair_new(pair->num, pair->automaton_state, pair->atomic_propositions, pair->graph_state);
52   new_pair->acceptance_pair = 1;
53
54   if (xbt_dynar_is_empty(acceptance_pairs)) {
55
56     xbt_dynar_push(acceptance_pairs, &new_pair);
57
58   } else {
59
60     int min = -1, max = -1, index;
61     //int res;
62     mc_visited_pair_t pair_test;
63     int cursor;
64
65     index = get_search_interval(acceptance_pairs, new_pair, &min, &max);
66
67     if (min != -1 && max != -1) {       // Acceptance pair with same number of processes and same heap bytes used exists
68
69       // Parallell implementation
70       /*res = xbt_parmap_mc_apply(parmap, snapshot_compare, xbt_dynar_get_ptr(acceptance_pairs, min), (max-min)+1, pair);
71          if(res != -1){
72          return ((mc_pair_t)xbt_dynar_get_as(acceptance_pairs, (min+res)-1, mc_pair_t))->num;
73          } */
74
75       cursor = min;
76       if(pair->search_cycle == 1){
77         while (cursor <= max) {
78           pair_test = (mc_visited_pair_t) xbt_dynar_get_as(acceptance_pairs, cursor, mc_visited_pair_t);
79           if (xbt_automaton_state_compare(pair_test->automaton_state, new_pair->automaton_state) == 0) {
80             if (xbt_automaton_propositional_symbols_compare_value(pair_test->atomic_propositions, new_pair->atomic_propositions) == 0) {
81               if (snapshot_compare(pair_test, new_pair) == 0) {
82                 XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
83                 xbt_fifo_shift(mc_stack);
84                 if (dot_output != NULL)
85                   fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, pair_test->num, initial_global_state->prev_req);
86                 return NULL;
87               }
88             }
89           }
90           cursor++;
91         }
92       }
93       xbt_dynar_insert_at(acceptance_pairs, min, &new_pair);
94     } else {
95       pair_test = (mc_visited_pair_t) xbt_dynar_get_as(acceptance_pairs, index, mc_visited_pair_t);
96       if (pair_test->nb_processes < new_pair->nb_processes) {
97         xbt_dynar_insert_at(acceptance_pairs, index + 1, &new_pair);
98       } else {
99         if (pair_test->heap_bytes_used < new_pair->heap_bytes_used)
100           xbt_dynar_insert_at(acceptance_pairs, index + 1, &new_pair);
101         else
102           xbt_dynar_insert_at(acceptance_pairs, index, &new_pair);
103       }
104     }
105   }
106   return new_pair;
107 }
108
109 static void remove_acceptance_pair(int pair_num)
110 {
111   unsigned int cursor = 0;
112   mc_visited_pair_t pair_test = NULL;
113   int pair_found = 0;
114
115   xbt_dynar_foreach(acceptance_pairs, cursor, pair_test) {
116     if (pair_test->num == pair_num) {
117        pair_found = 1;
118       break;
119     }
120   }
121
122   if(pair_found == 1) {
123     xbt_dynar_remove_at(acceptance_pairs, cursor, &pair_test);
124
125     pair_test->acceptance_removed = 1;
126
127     if (_sg_mc_visited == 0 || pair_test->visited_removed == 1) 
128       MC_visited_pair_delete(pair_test);
129
130   }
131 }
132
133
134 static int MC_automaton_evaluate_label(xbt_automaton_exp_label_t l,
135                                        xbt_dynar_t atomic_propositions_values)
136 {
137
138   switch (l->type) {
139   case 0:{
140       int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
141       int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
142       return (left_res || right_res);
143     }
144   case 1:{
145       int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
146       int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
147       return (left_res && right_res);
148     }
149   case 2:{
150       int res = MC_automaton_evaluate_label(l->u.exp_not, atomic_propositions_values);
151       return (!res);
152     }
153   case 3:{
154       unsigned int cursor = 0;
155       xbt_automaton_propositional_symbol_t p = NULL;
156       xbt_dynar_foreach(_mc_property_automaton->propositional_symbols, cursor, p) {
157         if (strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
158           return (int) xbt_dynar_get_as(atomic_propositions_values, cursor, int);
159       }
160       return -1;
161     }
162   case 4:{
163       return 2;
164     }
165   default:
166     return -1;
167   }
168 }
169
170 static int MC_modelcheck_liveness_main(void);
171
172 static void MC_pre_modelcheck_liveness(void)
173 {
174   mc_pair_t initial_pair = NULL;
175   smx_process_t process;
176
177   mc_model_checker->wait_for_requests();
178
179   acceptance_pairs = xbt_dynar_new(sizeof(mc_visited_pair_t), NULL);
180   if(_sg_mc_visited > 0)
181     visited_pairs = xbt_dynar_new(sizeof(mc_visited_pair_t), NULL);
182
183   initial_global_state->snapshot = MC_take_snapshot(0);
184   initial_global_state->prev_pair = 0;
185
186   unsigned int cursor = 0;
187   xbt_automaton_state_t automaton_state;
188   
189   xbt_dynar_foreach(_mc_property_automaton->states, cursor, automaton_state) {
190     if (automaton_state->type == -1) {  /* Initial automaton state */
191
192       initial_pair = MC_pair_new();
193       initial_pair->automaton_state = automaton_state;
194       initial_pair->graph_state = MC_state_new();
195       initial_pair->atomic_propositions = get_atomic_propositions_values();
196       initial_pair->depth = 1;
197
198       /* Get enabled processes and insert them in the interleave set of the graph_state */
199       MC_EACH_SIMIX_PROCESS(process,
200         if (MC_process_is_enabled(process)) {
201           MC_state_interleave_process(initial_pair->graph_state, process);
202         }
203       );
204
205       initial_pair->requests = MC_state_interleave_size(initial_pair->graph_state);
206       initial_pair->search_cycle = 0;
207
208       xbt_fifo_unshift(mc_stack, initial_pair);
209     }
210   }
211 }
212
213 static int MC_modelcheck_liveness_main(void)
214 {
215   smx_process_t process = NULL;
216   mc_pair_t current_pair = NULL;
217   int value, res, visited_num = -1;
218   smx_simcall_t req = NULL;
219   xbt_automaton_transition_t transition_succ = NULL;
220   int cursor = 0;
221   mc_pair_t next_pair = NULL;
222   xbt_dynar_t prop_values = NULL;
223   mc_visited_pair_t reached_pair = NULL;
224   
225   while(xbt_fifo_size(mc_stack) > 0){
226
227     /* Get current pair */
228     current_pair = (mc_pair_t) xbt_fifo_get_item_content(xbt_fifo_get_first_item(mc_stack));
229
230     /* Update current state in buchi automaton */
231     _mc_property_automaton->current_state = current_pair->automaton_state;
232
233     XBT_DEBUG("********************* ( Depth = %d, search_cycle = %d, interleave size = %d, pair_num = %d, requests = %d)",
234        current_pair->depth, current_pair->search_cycle,
235        MC_state_interleave_size(current_pair->graph_state), current_pair->num,
236        current_pair->requests);
237
238     if (current_pair->requests > 0) {
239
240       if (current_pair->automaton_state->type == 1 && current_pair->exploration_started == 0) {
241         /* If new acceptance pair, return new pair */
242         if ((reached_pair = is_reached_acceptance_pair(current_pair)) == NULL) {
243           int counter_example_depth = current_pair->depth;
244           XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
245           XBT_INFO("|             ACCEPTANCE CYCLE            |");
246           XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
247           XBT_INFO("Counter-example that violates formula :");
248           MC_record_dump_path(mc_stack);
249           MC_show_stack_liveness(mc_stack);
250           MC_dump_stack_liveness(mc_stack);
251           MC_print_statistics(mc_stats);
252           XBT_INFO("Counter-example depth : %d", counter_example_depth);
253           return SIMGRID_MC_EXIT_LIVENESS;
254         }
255       }
256
257       /* Pair already visited ? stop the exploration on the current path */
258       if ((current_pair->exploration_started == 0) && (visited_num = is_visited_pair(reached_pair, current_pair)) != -1) {
259
260         if (dot_output != NULL){
261           fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, visited_num, initial_global_state->prev_req);
262           fflush(dot_output);
263         }
264
265         XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
266         current_pair->requests = 0;
267         goto backtracking;
268         
269       }else{
270
271         req = MC_state_get_request(current_pair->graph_state, &value);
272
273          if (dot_output != NULL) {
274            if (initial_global_state->prev_pair != 0 && initial_global_state->prev_pair != current_pair->num) {
275              fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, current_pair->num, initial_global_state->prev_req);
276              xbt_free(initial_global_state->prev_req);
277            }
278            initial_global_state->prev_pair = current_pair->num;
279            initial_global_state->prev_req = MC_request_get_dot_output(req, value);
280            if (current_pair->search_cycle)
281              fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
282            fflush(dot_output);
283          }
284
285          char* req_str = MC_request_to_string(req, value, MC_REQUEST_SIMIX); 
286          XBT_DEBUG("Execute: %s", req_str);
287          xbt_free(req_str);
288
289          /* Set request as executed */
290          MC_state_set_executed_request(current_pair->graph_state, req, value);
291
292          /* Update mc_stats */
293          mc_stats->executed_transitions++;
294          if(current_pair->exploration_started == 0)
295            mc_stats->visited_pairs++;
296
297          /* Answer the request */
298          MC_simcall_handle(req, value);
299          
300          /* Wait for requests (schedules processes) */
301          mc_model_checker->wait_for_requests();
302
303          current_pair->requests--;
304          current_pair->exploration_started = 1;
305
306          /* Get values of atomic propositions (variables used in the property formula) */ 
307          prop_values = get_atomic_propositions_values();
308
309          /* Evaluate enabled/true transitions in automaton according to atomic propositions values and create new pairs */
310          cursor = xbt_dynar_length(current_pair->automaton_state->out) - 1;
311          while (cursor >= 0) {
312            transition_succ = (xbt_automaton_transition_t)xbt_dynar_get_as(current_pair->automaton_state->out, cursor, xbt_automaton_transition_t);
313            res = MC_automaton_evaluate_label(transition_succ->label, prop_values);
314            if (res == 1 || res == 2) { /* 1 = True transition (always enabled), 2 = enabled transition according to atomic prop values */
315               next_pair = MC_pair_new();
316               next_pair->graph_state = MC_state_new();
317               next_pair->automaton_state = transition_succ->dst;
318               next_pair->atomic_propositions = get_atomic_propositions_values();
319               next_pair->depth = current_pair->depth + 1;
320               /* Get enabled processes and insert them in the interleave set of the next graph_state */
321               MC_EACH_SIMIX_PROCESS(process,
322                 if (MC_process_is_enabled(process)) {
323                   MC_state_interleave_process(next_pair->graph_state, process);
324                 }
325               );
326
327               next_pair->requests = MC_state_interleave_size(next_pair->graph_state);
328
329               /* FIXME : get search_cycle value for each acceptant state */
330               if (next_pair->automaton_state->type == 1 || current_pair->search_cycle)
331                 next_pair->search_cycle = 1;
332
333               /* Add new pair to the exploration stack */
334               xbt_fifo_unshift(mc_stack, next_pair);
335
336            }
337            cursor--;
338          }
339
340       } /* End of visited_pair test */
341       
342     } else {
343
344     backtracking:
345       if(visited_num == -1)
346         XBT_DEBUG("No more request to execute. Looking for backtracking point.");
347     
348       xbt_dynar_free(&prop_values);
349     
350       /* Traverse the stack backwards until a pair with a non empty interleave
351          set is found, deleting all the pairs that have it empty in the way. */
352       while ((current_pair = (mc_pair_t) xbt_fifo_shift(mc_stack)) != NULL) {
353         if (current_pair->requests > 0) {
354           /* We found a backtracking point */
355           XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
356           xbt_fifo_unshift(mc_stack, current_pair);
357           MC_replay_liveness(mc_stack);
358           XBT_DEBUG("Backtracking done");
359           break;
360         }else{
361           /* Delete pair */
362           XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
363           if (current_pair->automaton_state->type == 1) 
364             remove_acceptance_pair(current_pair->num);
365           MC_pair_delete(current_pair);
366         }
367       }
368
369     } /* End of if (current_pair->requests > 0) else ... */
370     
371   } /* End of while(xbt_fifo_size(mc_stack) > 0) */
372
373   XBT_INFO("No property violation found.");
374   MC_print_statistics(mc_stats);
375   return SIMGRID_MC_EXIT_SUCCESS;
376 }
377
378 int MC_modelcheck_liveness(void)
379 {
380   if (mc_reduce_kind == e_mc_reduce_unset)
381     mc_reduce_kind = e_mc_reduce_none;
382   XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
383   MC_automaton_load(_sg_mc_property_file);
384   mc_model_checker->wait_for_requests();
385
386   XBT_DEBUG("Starting the liveness algorithm");
387   _sg_mc_liveness = 1;
388
389   /* Create exploration stack */
390   mc_stack = xbt_fifo_new();
391
392   /* Create the initial state */
393   initial_global_state = xbt_new0(s_mc_global_t, 1);
394
395   MC_pre_modelcheck_liveness();
396   int res = MC_modelcheck_liveness_main();
397
398   /* We're done */
399   xbt_free(mc_time);
400
401   return res;
402 }
403
404 }