Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
e9520f680d7c123445b7b8ec39b787efa55e1fe5
[simgrid.git] / src / mc / mc_global.c
1 /* Copyright (c) 2008-2014. 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/types.h>
9 #include <sys/wait.h>
10 #include <sys/time.h>
11 #include <sys/mman.h>
12 #include <libgen.h>
13
14 #include "simgrid/sg_config.h"
15 #include "../surf/surf_private.h"
16 #include "../simix/smx_private.h"
17 #include "../xbt/mmalloc/mmprivate.h"
18 #include "xbt/fifo.h"
19 #include "mc_private.h"
20 #include "xbt/automaton.h"
21 #include "xbt/dict.h"
22
23 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
25                                 "Logging specific to MC (global)");
26
27 /* Configuration support */
28 e_mc_reduce_t mc_reduce_kind = e_mc_reduce_unset;
29
30 int _sg_do_model_check = 0;
31 int _sg_mc_checkpoint = 0;
32 int _sg_mc_sparse_checkpoint = 0;
33 char *_sg_mc_property_file = NULL;
34 int _sg_mc_timeout = 0;
35 int _sg_mc_hash = 0;
36 int _sg_mc_max_depth = 1000;
37 int _sg_mc_visited = 0;
38 char *_sg_mc_dot_output_file = NULL;
39 int _sg_mc_comms_determinism = 0;
40 int _sg_mc_send_determinism = 0;
41 int _sg_mc_safety = 0;
42 int _sg_mc_liveness = 0;
43
44 int user_max_depth_reached = 0;
45
46 void _mc_cfg_cb_reduce(const char *name, int pos)
47 {
48   if (_sg_cfg_init_status && !_sg_do_model_check) {
49     xbt_die
50         ("You are specifying a reduction strategy after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
51   }
52   char *val = xbt_cfg_get_string(_sg_cfg_set, name);
53   if (!strcasecmp(val, "none")) {
54     mc_reduce_kind = e_mc_reduce_none;
55   } else if (!strcasecmp(val, "dpor")) {
56     mc_reduce_kind = e_mc_reduce_dpor;
57   } else {
58     xbt_die("configuration option %s can only take 'none' or 'dpor' as a value",
59             name);
60   }
61 }
62
63 void _mc_cfg_cb_checkpoint(const char *name, int pos)
64 {
65   if (_sg_cfg_init_status && !_sg_do_model_check) {
66     xbt_die
67         ("You are specifying a checkpointing value after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
68   }
69   _sg_mc_checkpoint = xbt_cfg_get_int(_sg_cfg_set, name);
70 }
71
72 void _mc_cfg_cb_sparse_checkpoint(const char *name, int pos) {
73   if (_sg_cfg_init_status && !_sg_do_model_check) {
74     xbt_die("You are specifying a checkpointing value after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
75   }
76   _sg_mc_sparse_checkpoint = xbt_cfg_get_int(_sg_cfg_set, name);
77 }
78
79 void _mc_cfg_cb_property(const char *name, int pos)
80 {
81   if (_sg_cfg_init_status && !_sg_do_model_check) {
82     xbt_die
83         ("You are specifying a property after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
84   }
85   _sg_mc_property_file = xbt_cfg_get_string(_sg_cfg_set, name);
86 }
87
88 void _mc_cfg_cb_timeout(const char *name, int pos)
89 {
90   if (_sg_cfg_init_status && !_sg_do_model_check) {
91     xbt_die
92         ("You are specifying a value to enable/disable timeout for wait requests after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
93   }
94   _sg_mc_timeout = xbt_cfg_get_boolean(_sg_cfg_set, name);
95 }
96
97 void _mc_cfg_cb_hash(const char *name, int pos)
98 {
99   if (_sg_cfg_init_status && !_sg_do_model_check) {
100     xbt_die
101         ("You are specifying a value to enable/disable the use of global hash to speedup state comparaison, but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
102   }
103   _sg_mc_hash = xbt_cfg_get_boolean(_sg_cfg_set, name);
104 }
105
106 void _mc_cfg_cb_max_depth(const char *name, int pos)
107 {
108   if (_sg_cfg_init_status && !_sg_do_model_check) {
109     xbt_die
110         ("You are specifying a max depth value after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
111   }
112   _sg_mc_max_depth = xbt_cfg_get_int(_sg_cfg_set, name);
113 }
114
115 void _mc_cfg_cb_visited(const char *name, int pos)
116 {
117   if (_sg_cfg_init_status && !_sg_do_model_check) {
118     xbt_die
119         ("You are specifying a number of stored visited states after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
120   }
121   _sg_mc_visited = xbt_cfg_get_int(_sg_cfg_set, name);
122 }
123
124 void _mc_cfg_cb_dot_output(const char *name, int pos)
125 {
126   if (_sg_cfg_init_status && !_sg_do_model_check) {
127     xbt_die
128         ("You are specifying a file name for a dot output of graph state after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
129   }
130   _sg_mc_dot_output_file = xbt_cfg_get_string(_sg_cfg_set, name);
131 }
132
133 void _mc_cfg_cb_comms_determinism(const char *name, int pos)
134 {
135   if (_sg_cfg_init_status && !_sg_do_model_check) {
136     xbt_die
137         ("You are specifying a value to enable/disable the detection of determinism in the communications schemes after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
138   }
139   _sg_mc_comms_determinism = xbt_cfg_get_boolean(_sg_cfg_set, name);
140 }
141
142 void _mc_cfg_cb_send_determinism(const char *name, int pos)
143 {
144   if (_sg_cfg_init_status && !_sg_do_model_check) {
145     xbt_die
146         ("You are specifying a value to enable/disable the detection of send-determinism in the communications schemes after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
147   }
148   _sg_mc_send_determinism = xbt_cfg_get_boolean(_sg_cfg_set, name);
149 }
150
151 /* MC global data structures */
152 mc_state_t mc_current_state = NULL;
153 char mc_replay_mode = FALSE;
154 double *mc_time = NULL;
155 __thread mc_comparison_times_t mc_comp_times = NULL;
156 __thread double mc_snapshot_comparison_time;
157 mc_stats_t mc_stats = NULL;
158 mc_global_t initial_global_state = NULL;
159 xbt_fifo_t mc_stack = NULL;
160
161 /* Liveness */
162 xbt_automaton_t _mc_property_automaton = NULL;
163
164 /* Variables */
165 mc_object_info_t mc_libsimgrid_info = NULL;
166 mc_object_info_t mc_binary_info = NULL;
167
168 mc_object_info_t mc_object_infos[2] = { NULL, NULL };
169
170 size_t mc_object_infos_size = 2;
171
172 /* Dot output */
173 FILE *dot_output = NULL;
174 const char *colors[13];
175
176
177 /*******************************  Initialisation of MC *******************************/
178 /*********************************************************************************/
179
180 static void MC_init_dot_output()
181 {                               /* FIXME : more colors */
182
183   colors[0] = "blue";
184   colors[1] = "red";
185   colors[2] = "green3";
186   colors[3] = "goldenrod";
187   colors[4] = "brown";
188   colors[5] = "purple";
189   colors[6] = "magenta";
190   colors[7] = "turquoise4";
191   colors[8] = "gray25";
192   colors[9] = "forestgreen";
193   colors[10] = "hotpink";
194   colors[11] = "lightblue";
195   colors[12] = "tan";
196
197   dot_output = fopen(_sg_mc_dot_output_file, "w");
198
199   if (dot_output == NULL) {
200     perror("Error open dot output file");
201     xbt_abort();
202   }
203
204   fprintf(dot_output,
205           "digraph graphname{\n fixedsize=true; rankdir=TB; ranksep=.25; edge [fontsize=12]; node [fontsize=10, shape=circle,width=.5 ]; graph [resolution=20, fontsize=10];\n");
206
207 }
208
209 static void MC_init_debug_info(void)
210 {
211   XBT_INFO("Get debug information ...");
212
213   memory_map_t maps = MC_get_memory_map();
214
215   /* Get local variables for state equality detection */
216   mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
217   mc_object_infos[0] = mc_binary_info;
218
219   mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
220   mc_object_infos[1] = mc_libsimgrid_info;
221
222   // Use information of the other objects:
223   MC_post_process_object_info(mc_binary_info);
224   MC_post_process_object_info(mc_libsimgrid_info);
225
226   MC_free_memory_map(maps);
227   XBT_INFO("Get debug information done !");
228 }
229
230
231 mc_model_checker_t mc_model_checker = NULL;
232
233 void MC_init()
234 {
235   int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
236
237   mc_time = xbt_new0(double, simix_process_maxpid);
238
239   /* Initialize the data structures that must be persistent across every
240      iteration of the model-checker (in RAW memory) */
241
242   MC_SET_MC_HEAP;
243
244   mc_model_checker = xbt_new0(s_mc_model_checker_t, 1);
245   mc_model_checker->pages = mc_pages_store_new();
246   mc_model_checker->fd_clear_refs = -1;
247   mc_model_checker->fd_pagemap = -1;
248
249   mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
250
251   /* Initialize statistics */
252   mc_stats = xbt_new0(s_mc_stats_t, 1);
253   mc_stats->state_size = 1;
254
255   MC_init_memory_map_info();
256   MC_init_debug_info();         /* FIXME : get debug information only if liveness verification or visited state reduction */
257
258   if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0'))
259     MC_init_dot_output();
260
261   /* Init parmap */
262   //parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
263
264   MC_SET_STD_HEAP;
265
266   if (_sg_mc_visited > 0 || _sg_mc_liveness) {
267     /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
268     MC_ignore_local_variable("e", "*");
269     MC_ignore_local_variable("__ex_cleanup", "*");
270     MC_ignore_local_variable("__ex_mctx_en", "*");
271     MC_ignore_local_variable("__ex_mctx_me", "*");
272     MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
273     MC_ignore_local_variable("_log_ev", "*");
274     MC_ignore_local_variable("_throw_ctx", "*");
275     MC_ignore_local_variable("ctx", "*");
276
277     MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
278     MC_ignore_local_variable("next_cont"
279       "ext", "smx_ctx_sysv_suspend_serial");
280     MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
281
282     /* Ignore local variable about time used for tracing */
283     MC_ignore_local_variable("start_time", "*");
284
285     MC_ignore_global_variable("mc_model_checker");
286
287     // Mot of those things could be moved into mc_model_checker:
288     MC_ignore_global_variable("compared_pointers");
289     MC_ignore_global_variable("mc_comp_times");
290     MC_ignore_global_variable("mc_snapshot_comparison_time");
291     MC_ignore_global_variable("mc_time");
292     MC_ignore_global_variable("smpi_current_rank");
293     MC_ignore_global_variable("counter");       /* Static variable used for tracing */
294     MC_ignore_global_variable("maestro_stack_start");
295     MC_ignore_global_variable("maestro_stack_end");
296     MC_ignore_global_variable("smx_total_comms");
297
298
299     MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
300
301     smx_process_t process;
302     xbt_swag_foreach(process, simix_global->process_list) {
303       MC_ignore_heap(&(process->process_hookup),
304                      sizeof(process->process_hookup));
305                      }
306   }
307
308   if (raw_mem_set)
309     MC_SET_MC_HEAP;
310
311 }
312
313 /*******************************  Core of MC *******************************/
314 /**************************************************************************/
315
316 static void MC_modelcheck_comm_determinism_init(void)
317 {
318
319   int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
320
321   MC_init();
322
323   if (!mc_mem_set)
324     MC_SET_MC_HEAP;
325
326   /* Create exploration stack */
327   mc_stack = xbt_fifo_new();
328
329   MC_SET_STD_HEAP;
330
331   MC_pre_modelcheck_comm_determinism();
332
333   MC_SET_MC_HEAP;
334   initial_global_state = xbt_new0(s_mc_global_t, 1);
335   initial_global_state->snapshot = MC_take_snapshot(0);
336   initial_global_state->initial_communications_pattern_done = 0;
337   initial_global_state->comm_deterministic = 1;
338   initial_global_state->send_deterministic = 1;
339   MC_SET_STD_HEAP;
340
341   MC_modelcheck_comm_determinism();
342
343   if(mc_mem_set)
344     MC_SET_MC_HEAP;
345
346 }
347
348 static void MC_modelcheck_safety_init(void)
349 {
350   int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
351
352   _sg_mc_safety = 1;
353
354   MC_init();
355
356   if (!mc_mem_set)
357     MC_SET_MC_HEAP;
358
359   /* Create exploration stack */
360   mc_stack = xbt_fifo_new();
361
362   MC_SET_STD_HEAP;
363
364   MC_pre_modelcheck_safety();
365
366   MC_SET_MC_HEAP;
367   /* Save the initial state */
368   initial_global_state = xbt_new0(s_mc_global_t, 1);
369   initial_global_state->snapshot = MC_take_snapshot(0);
370   MC_SET_STD_HEAP;
371
372   MC_modelcheck_safety();
373
374   if (mc_mem_set)
375     MC_SET_MC_HEAP;
376
377   xbt_abort();
378   //MC_exit();
379 }
380
381 static void MC_modelcheck_liveness_init()
382 {
383
384   int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
385
386   _sg_mc_liveness = 1;
387
388   MC_init();
389
390   if (!mc_mem_set)
391     MC_SET_MC_HEAP;
392
393   /* Create exploration stack */
394   mc_stack = xbt_fifo_new();
395
396   /* Create the initial state */
397   initial_global_state = xbt_new0(s_mc_global_t, 1);
398
399   MC_SET_STD_HEAP;
400
401   MC_pre_modelcheck_liveness();
402
403   /* We're done */
404   MC_print_statistics(mc_stats);
405   xbt_free(mc_time);
406
407   if (mc_mem_set)
408     MC_SET_MC_HEAP;
409
410 }
411
412 void MC_do_the_modelcheck_for_real()
413 {
414
415   if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
416     XBT_INFO("Check communication determinism");
417     MC_modelcheck_comm_determinism_init();
418   } else if (!_sg_mc_property_file || _sg_mc_property_file[0] == '\0') {
419     if (mc_reduce_kind == e_mc_reduce_unset)
420       mc_reduce_kind = e_mc_reduce_dpor;
421     XBT_INFO("Check a safety property");
422     MC_modelcheck_safety_init();
423   } else {
424     if (mc_reduce_kind == e_mc_reduce_unset)
425       mc_reduce_kind = e_mc_reduce_none;
426     XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
427     MC_automaton_load(_sg_mc_property_file);
428     MC_modelcheck_liveness_init();
429   }
430 }
431
432
433 void MC_exit(void)
434 {
435   xbt_free(mc_time);
436
437   MC_memory_exit();
438   //xbt_abort();
439 }
440
441 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max)
442 {
443
444   return simcall->mc_value;
445 }
446
447
448 int MC_random(int min, int max)
449 {
450   /*FIXME: return mc_current_state->executed_transition->random.value; */
451   return simcall_mc_random(min, max);
452 }
453
454 /**
455  * \brief Schedules all the process that are ready to run
456  */
457 void MC_wait_for_requests(void)
458 {
459   smx_process_t process;
460   smx_simcall_t req;
461   unsigned int iter;
462
463   while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
464     SIMIX_process_runall();
465     xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
466       req = &process->simcall;
467       if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
468         SIMIX_simcall_pre(req, 0);
469     }
470   }
471 }
472
473 int MC_deadlock_check()
474 {
475   int deadlock = FALSE;
476   smx_process_t process;
477   if (xbt_swag_size(simix_global->process_list)) {
478     deadlock = TRUE;
479     xbt_swag_foreach(process, simix_global->process_list) {
480       if (process->simcall.call != SIMCALL_NONE
481           && MC_request_is_enabled(&process->simcall)) {
482         deadlock = FALSE;
483         break;
484       }
485     }
486   }
487   return deadlock;
488 }
489
490 /**
491  * \brief Re-executes from the state at position start all the transitions indicated by
492  *        a given model-checker stack.
493  * \param stack The stack with the transitions to execute.
494  * \param start Start index to begin the re-execution.
495  */
496 void MC_replay(xbt_fifo_t stack, int start)
497 {
498   int raw_mem = (mmalloc_get_current_heap() == mc_heap);
499
500   int value, i = 1, count = 1;
501   char *req_str;
502   smx_simcall_t req = NULL, saved_req = NULL;
503   xbt_fifo_item_t item, start_item;
504   mc_state_t state;
505   smx_process_t process = NULL;
506   int comm_pattern = 0;
507   smx_action_t current_comm;
508
509   XBT_DEBUG("**** Begin Replay ****");
510
511   if (start == -1) {
512     /* Restore the initial state */
513     MC_restore_snapshot(initial_global_state->snapshot);
514     /* At the moment of taking the snapshot the raw heap was set, so restoring
515      * it will set it back again, we have to unset it to continue  */
516     MC_SET_STD_HEAP;
517   }
518
519   start_item = xbt_fifo_get_last_item(stack);
520   if (start != -1) {
521     while (i != start) {
522       start_item = xbt_fifo_get_prev_item(start_item);
523       i++;
524     }
525   }
526
527   MC_SET_MC_HEAP;
528
529   if ((mc_reduce_kind == e_mc_reduce_dpor) && !_sg_mc_comms_determinism && !_sg_mc_send_determinism) {
530     xbt_dict_reset(first_enabled_state);
531     xbt_swag_foreach(process, simix_global->process_list) {
532       if (MC_process_is_enabled(process)) {
533         char *key = bprintf("%lu", process->pid);
534         char *data = bprintf("%d", count);
535         xbt_dict_set(first_enabled_state, key, data, NULL);
536         xbt_free(key);
537       }
538     }
539   }
540
541   if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
542     xbt_dynar_reset(communications_pattern);
543     xbt_dynar_reset(incomplete_communications_pattern);
544   }
545
546   MC_SET_STD_HEAP;
547
548
549   /* Traverse the stack from the state at position start and re-execute the transitions */
550   for (item = start_item;
551        item != xbt_fifo_get_first_item(stack);
552        item = xbt_fifo_get_prev_item(item)) {
553
554     state = (mc_state_t) xbt_fifo_get_item_content(item);
555     saved_req = MC_state_get_executed_request(state, &value);
556
557     if ((mc_reduce_kind == e_mc_reduce_dpor) && !_sg_mc_comms_determinism && !_sg_mc_send_determinism) {
558       MC_SET_MC_HEAP;
559       char *key = bprintf("%lu", saved_req->issuer->pid);
560       xbt_dict_remove(first_enabled_state, key);
561       xbt_free(key);
562       MC_SET_STD_HEAP;
563     }
564
565     if (saved_req) {
566       /* because we got a copy of the executed request, we have to fetch the  
567          real one, pointed by the request field of the issuer process */
568       req = &saved_req->issuer->simcall;
569
570       /* Debug information */
571       if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
572         req_str = MC_request_to_string(req, value);
573         XBT_DEBUG("Replay: %s (%p)", req_str, state);
574         xbt_free(req_str);
575       }
576
577       /* TODO : handle test and testany simcalls */
578       if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
579         if (req->call == SIMCALL_COMM_ISEND)
580           comm_pattern = 1;
581         else if (req->call == SIMCALL_COMM_IRECV)
582           comm_pattern = 2;
583         else if (req->call == SIMCALL_COMM_WAIT)
584           comm_pattern = 3;
585         else if (req->call == SIMCALL_COMM_WAITANY)
586           comm_pattern = 4;
587       }
588
589       SIMIX_simcall_pre(req, value);
590
591       if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
592         MC_SET_MC_HEAP;
593         if (comm_pattern == 1 || comm_pattern == 2) {
594           get_comm_pattern(communications_pattern, req, comm_pattern);
595         } else if (comm_pattern == 3 /* || comm_pattern == 4 */ ) {
596           current_comm = simcall_comm_wait__get__comm(req);
597           if (current_comm->comm.refcount == 1) {       /* First wait only must be considered */
598             complete_comm_pattern(communications_pattern, current_comm);
599           }
600         } else if (comm_pattern == 4 /* || comm_pattern == 4 */ ) {
601           current_comm =
602               xbt_dynar_get_as(simcall_comm_waitany__get__comms(req), value,
603                                smx_action_t);
604           if (current_comm->comm.refcount == 1) {       /* First wait only must be considered */
605             complete_comm_pattern(communications_pattern, current_comm);
606           }
607         }
608         MC_SET_STD_HEAP;
609         comm_pattern = 0;
610       }
611
612
613       MC_wait_for_requests();
614
615       count++;
616
617       if ((mc_reduce_kind == e_mc_reduce_dpor) && !_sg_mc_comms_determinism && !_sg_mc_send_determinism) {
618         MC_SET_MC_HEAP;
619         /* Insert in dict all enabled processes */
620         xbt_swag_foreach(process, simix_global->process_list) {
621           if (MC_process_is_enabled(process) ) {
622             char *key = bprintf("%lu", process->pid);
623             if (xbt_dict_get_or_null(first_enabled_state, key) == NULL) {
624               char *data = bprintf("%d", count);
625               xbt_dict_set(first_enabled_state, key, data, NULL);
626             }
627             xbt_free(key);
628           }
629         }
630         MC_SET_STD_HEAP;
631       }
632     }
633
634     /* Update statistics */
635     mc_stats->visited_states++;
636     mc_stats->executed_transitions++;
637
638   }
639
640   XBT_DEBUG("**** End Replay ****");
641
642   if (raw_mem)
643     MC_SET_MC_HEAP;
644   else
645     MC_SET_STD_HEAP;
646
647
648 }
649
650 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
651 {
652
653   initial_global_state->raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
654
655   int value;
656   char *req_str;
657   smx_simcall_t req = NULL, saved_req = NULL;
658   xbt_fifo_item_t item;
659   mc_state_t state;
660   mc_pair_t pair;
661   int depth = 1;
662
663   XBT_DEBUG("**** Begin Replay ****");
664
665   /* Restore the initial state */
666   MC_restore_snapshot(initial_global_state->snapshot);
667
668   /* At the moment of taking the snapshot the raw heap was set, so restoring
669    * it will set it back again, we have to unset it to continue  */
670   if (!initial_global_state->raw_mem_set)
671     MC_SET_STD_HEAP;
672
673   if (all_stack) {
674
675     item = xbt_fifo_get_last_item(stack);
676
677     while (depth <= xbt_fifo_size(stack)) {
678
679       pair = (mc_pair_t) xbt_fifo_get_item_content(item);
680       state = (mc_state_t) pair->graph_state;
681
682       if (pair->requests > 0) {
683
684         saved_req = MC_state_get_executed_request(state, &value);
685         //XBT_DEBUG("SavedReq->call %u", saved_req->call);
686
687         if (saved_req != NULL) {
688           /* because we got a copy of the executed request, we have to fetch the  
689              real one, pointed by the request field of the issuer process */
690           req = &saved_req->issuer->simcall;
691           //XBT_DEBUG("Req->call %u", req->call);
692
693           /* Debug information */
694           if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
695             req_str = MC_request_to_string(req, value);
696             XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
697             xbt_free(req_str);
698           }
699
700         }
701
702         SIMIX_simcall_pre(req, value);
703         MC_wait_for_requests();
704       }
705
706       depth++;
707
708       /* Update statistics */
709       mc_stats->visited_pairs++;
710       mc_stats->executed_transitions++;
711
712       item = xbt_fifo_get_prev_item(item);
713     }
714
715   } else {
716
717     /* Traverse the stack from the initial state and re-execute the transitions */
718     for (item = xbt_fifo_get_last_item(stack);
719          item != xbt_fifo_get_first_item(stack);
720          item = xbt_fifo_get_prev_item(item)) {
721
722       pair = (mc_pair_t) xbt_fifo_get_item_content(item);
723       state = (mc_state_t) pair->graph_state;
724
725       if (pair->requests > 0) {
726
727         saved_req = MC_state_get_executed_request(state, &value);
728         //XBT_DEBUG("SavedReq->call %u", saved_req->call);
729
730         if (saved_req != NULL) {
731           /* because we got a copy of the executed request, we have to fetch the  
732              real one, pointed by the request field of the issuer process */
733           req = &saved_req->issuer->simcall;
734           //XBT_DEBUG("Req->call %u", req->call);
735
736           /* Debug information */
737           if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
738             req_str = MC_request_to_string(req, value);
739             XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
740             xbt_free(req_str);
741           }
742
743         }
744
745         SIMIX_simcall_pre(req, value);
746         MC_wait_for_requests();
747       }
748
749       depth++;
750
751       /* Update statistics */
752       mc_stats->visited_pairs++;
753       mc_stats->executed_transitions++;
754     }
755   }
756
757   XBT_DEBUG("**** End Replay ****");
758
759   if (initial_global_state->raw_mem_set)
760     MC_SET_MC_HEAP;
761   else
762     MC_SET_STD_HEAP;
763
764 }
765
766 /**
767  * \brief Dumps the contents of a model-checker's stack and shows the actual
768  *        execution trace
769  * \param stack The stack to dump
770  */
771 void MC_dump_stack_safety(xbt_fifo_t stack)
772 {
773
774   int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
775
776   MC_show_stack_safety(stack);
777
778   if (!_sg_mc_checkpoint) {
779
780     mc_state_t state;
781
782     MC_SET_MC_HEAP;
783     while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
784       MC_state_delete(state);
785     MC_SET_STD_HEAP;
786
787   }
788
789   if (raw_mem_set)
790     MC_SET_MC_HEAP;
791   else
792     MC_SET_STD_HEAP;
793
794 }
795
796
797 void MC_show_stack_safety(xbt_fifo_t stack)
798 {
799
800   int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
801
802   MC_SET_MC_HEAP;
803
804   int value;
805   mc_state_t state;
806   xbt_fifo_item_t item;
807   smx_simcall_t req;
808   char *req_str = NULL;
809
810   for (item = xbt_fifo_get_last_item(stack);
811        (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
812         : (NULL)); item = xbt_fifo_get_prev_item(item)) {
813     req = MC_state_get_executed_request(state, &value);
814     if (req) {
815       req_str = MC_request_to_string(req, value);
816       XBT_INFO("%s", req_str);
817       xbt_free(req_str);
818     }
819   }
820
821   if (!raw_mem_set)
822     MC_SET_STD_HEAP;
823 }
824
825 void MC_show_deadlock(smx_simcall_t req)
826 {
827   /*char *req_str = NULL; */
828   XBT_INFO("**************************");
829   XBT_INFO("*** DEAD-LOCK DETECTED ***");
830   XBT_INFO("**************************");
831   XBT_INFO("Locked request:");
832   /*req_str = MC_request_to_string(req);
833      XBT_INFO("%s", req_str);
834      xbt_free(req_str); */
835   XBT_INFO("Counter-example execution trace:");
836   MC_dump_stack_safety(mc_stack);
837   MC_print_statistics(mc_stats);
838 }
839
840
841 void MC_show_stack_liveness(xbt_fifo_t stack)
842 {
843   int value;
844   mc_pair_t pair;
845   xbt_fifo_item_t item;
846   smx_simcall_t req;
847   char *req_str = NULL;
848
849   for (item = xbt_fifo_get_last_item(stack);
850        (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
851         : (NULL)); item = xbt_fifo_get_prev_item(item)) {
852     req = MC_state_get_executed_request(pair->graph_state, &value);
853     if (req) {
854       if (pair->requests > 0) {
855         req_str = MC_request_to_string(req, value);
856         XBT_INFO("%s", req_str);
857         xbt_free(req_str);
858       } else {
859         XBT_INFO("End of system requests but evolution in Büchi automaton");
860       }
861     }
862   }
863 }
864
865 void MC_dump_stack_liveness(xbt_fifo_t stack)
866 {
867
868   int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
869
870   mc_pair_t pair;
871
872   MC_SET_MC_HEAP;
873   while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
874     MC_pair_delete(pair);
875   MC_SET_STD_HEAP;
876
877   if (raw_mem_set)
878     MC_SET_MC_HEAP;
879
880 }
881
882
883 void MC_print_statistics(mc_stats_t stats)
884 {
885   if (stats->expanded_pairs == 0) {
886     XBT_INFO("Expanded states = %lu", stats->expanded_states);
887     XBT_INFO("Visited states = %lu", stats->visited_states);
888   } else {
889     XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
890     XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
891   }
892   XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
893   MC_SET_MC_HEAP;
894   if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0')) {
895     fprintf(dot_output, "}\n");
896     fclose(dot_output);
897   }
898   if (initial_global_state != NULL) {
899     if (_sg_mc_comms_determinism)
900       XBT_INFO("Communication-deterministic : %s",
901                !initial_global_state->comm_deterministic ? "No" : "Yes");
902     if (_sg_mc_send_determinism)
903       XBT_INFO("Send-deterministic : %s",
904                !initial_global_state->send_deterministic ? "No" : "Yes");
905   }
906   MC_SET_STD_HEAP;
907 }
908
909 void MC_assert(int prop)
910 {
911   if (MC_is_active() && !prop) {
912     XBT_INFO("**************************");
913     XBT_INFO("*** PROPERTY NOT VALID ***");
914     XBT_INFO("**************************");
915     XBT_INFO("Counter-example execution trace:");
916     MC_dump_stack_safety(mc_stack);
917     MC_print_statistics(mc_stats);
918     xbt_abort();
919   }
920 }
921
922 void MC_cut(void)
923 {
924   user_max_depth_reached = 1;
925 }
926
927 void MC_process_clock_add(smx_process_t process, double amount)
928 {
929   mc_time[process->pid] += amount;
930 }
931
932 double MC_process_clock_get(smx_process_t process)
933 {
934   if (mc_time) {
935     if (process != NULL)
936       return mc_time[process->pid];
937     else
938       return -1;
939   } else {
940     return 0;
941   }
942 }
943
944 void MC_automaton_load(const char *file)
945 {
946
947   int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
948
949   MC_SET_MC_HEAP;
950
951   if (_mc_property_automaton == NULL)
952     _mc_property_automaton = xbt_automaton_new();
953
954   xbt_automaton_load(_mc_property_automaton, file);
955
956   MC_SET_STD_HEAP;
957
958   if (raw_mem_set)
959     MC_SET_MC_HEAP;
960
961 }
962
963 void MC_automaton_new_propositional_symbol(const char *id, void *fct)
964 {
965
966   int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
967
968   MC_SET_MC_HEAP;
969
970   if (_mc_property_automaton == NULL)
971     _mc_property_automaton = xbt_automaton_new();
972
973   xbt_automaton_propositional_symbol_new(_mc_property_automaton, id, fct);
974
975   MC_SET_STD_HEAP;
976
977   if (raw_mem_set)
978     MC_SET_MC_HEAP;
979
980 }