1 /* Copyright (c) 2008-2014. 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. */
13 #include "simgrid/sg_config.h"
14 #include "../surf/surf_private.h"
15 #include "../simix/smx_private.h"
16 #include "../xbt/mmalloc/mmprivate.h"
18 #include "mc_private.h"
19 #include "xbt/automaton.h"
22 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
24 "Logging specific to MC (global)");
26 /* Configuration support */
27 e_mc_reduce_t mc_reduce_kind=e_mc_reduce_unset;
29 int _sg_do_model_check = 0;
30 int _sg_mc_checkpoint=0;
31 char* _sg_mc_property_file=NULL;
34 int _sg_mc_max_depth=1000;
36 char *_sg_mc_dot_output_file = NULL;
37 int _sg_mc_comms_determinism=0;
38 int _sg_mc_send_determinism=0;
40 int user_max_depth_reached = 0;
42 void _mc_cfg_cb_reduce(const char *name, int pos) {
43 if (_sg_cfg_init_status && !_sg_do_model_check) {
44 xbt_die("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.");
46 char *val= xbt_cfg_get_string(_sg_cfg_set, name);
47 if (!strcasecmp(val,"none")) {
48 mc_reduce_kind = e_mc_reduce_none;
49 } else if (!strcasecmp(val,"dpor")) {
50 mc_reduce_kind = e_mc_reduce_dpor;
52 xbt_die("configuration option %s can only take 'none' or 'dpor' as a value",name);
56 void _mc_cfg_cb_checkpoint(const char *name, int pos) {
57 if (_sg_cfg_init_status && !_sg_do_model_check) {
58 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.");
60 _sg_mc_checkpoint = xbt_cfg_get_int(_sg_cfg_set, name);
62 void _mc_cfg_cb_property(const char *name, int pos) {
63 if (_sg_cfg_init_status && !_sg_do_model_check) {
64 xbt_die("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.");
66 _sg_mc_property_file= xbt_cfg_get_string(_sg_cfg_set, name);
69 void _mc_cfg_cb_timeout(const char *name, int pos) {
70 if (_sg_cfg_init_status && !_sg_do_model_check) {
71 xbt_die("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.");
73 _sg_mc_timeout= xbt_cfg_get_boolean(_sg_cfg_set, name);
76 void _mc_cfg_cb_hash(const char *name, int pos) {
77 if (_sg_cfg_init_status && !_sg_do_model_check) {
78 xbt_die("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.");
80 _sg_mc_hash= xbt_cfg_get_boolean(_sg_cfg_set, name);
83 void _mc_cfg_cb_max_depth(const char *name, int pos) {
84 if (_sg_cfg_init_status && !_sg_do_model_check) {
85 xbt_die("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.");
87 _sg_mc_max_depth= xbt_cfg_get_int(_sg_cfg_set, name);
90 void _mc_cfg_cb_visited(const char *name, int pos) {
91 if (_sg_cfg_init_status && !_sg_do_model_check) {
92 xbt_die("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.");
94 _sg_mc_visited= xbt_cfg_get_int(_sg_cfg_set, name);
97 void _mc_cfg_cb_dot_output(const char *name, int pos) {
98 if (_sg_cfg_init_status && !_sg_do_model_check) {
99 xbt_die("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.");
101 _sg_mc_dot_output_file= xbt_cfg_get_string(_sg_cfg_set, name);
104 void _mc_cfg_cb_comms_determinism(const char *name, int pos) {
105 if (_sg_cfg_init_status && !_sg_do_model_check) {
106 xbt_die("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.");
108 _sg_mc_comms_determinism= xbt_cfg_get_boolean(_sg_cfg_set, name);
111 void _mc_cfg_cb_send_determinism(const char *name, int pos) {
112 if (_sg_cfg_init_status && !_sg_do_model_check) {
113 xbt_die("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.");
115 _sg_mc_send_determinism= xbt_cfg_get_boolean(_sg_cfg_set, name);
118 /* MC global data structures */
119 mc_state_t mc_current_state = NULL;
120 char mc_replay_mode = FALSE;
121 double *mc_time = NULL;
122 __thread mc_comparison_times_t mc_comp_times = NULL;
123 __thread double mc_snapshot_comparison_time;
124 mc_stats_t mc_stats = NULL;
127 xbt_fifo_t mc_stack_safety = NULL;
128 mc_global_t initial_state_safety = NULL;
131 xbt_fifo_t mc_stack_liveness = NULL;
132 mc_global_t initial_state_liveness = NULL;
135 xbt_automaton_t _mc_property_automaton = NULL;
138 mc_object_info_t mc_libsimgrid_info = NULL;
139 mc_object_info_t mc_binary_info = NULL;
141 mc_object_info_t mc_object_infos[2] = { NULL, NULL };
142 size_t mc_object_infos_size = 2;
144 /* Ignore mechanism */
145 extern xbt_dynar_t mc_heap_comparison_ignore;
146 extern xbt_dynar_t stacks_areas;
149 FILE *dot_output = NULL;
150 const char* colors[13];
153 /******************************* DWARF Information *******************************/
154 /**********************************************************************************/
156 /************************** Free functions *************************/
158 void mc_frame_free(dw_frame_t frame){
159 xbt_free(frame->name);
160 mc_dwarf_location_list_clear(&(frame->frame_base));
161 xbt_dynar_free(&(frame->variables));
165 void dw_type_free(dw_type_t t){
167 xbt_free(t->dw_type_id);
168 xbt_dynar_free(&(t->members));
169 mc_dwarf_expression_clear(&t->location);
173 static void dw_type_free_voidp(void *t){
174 dw_type_free((dw_type_t) * (void **) t);
177 void dw_variable_free(dw_variable_t v){
180 xbt_free(v->type_origin);
182 if(v->locations.locations)
183 mc_dwarf_location_list_clear(&v->locations);
188 void dw_variable_free_voidp(void *t){
189 dw_variable_free((dw_variable_t) * (void **) t);
196 mc_object_info_t MC_new_object_info(void) {
197 mc_object_info_t res = xbt_new0(s_mc_object_info_t, 1);
198 res->subprograms = xbt_dict_new_homogeneous((void (*)(void*))mc_frame_free);
199 res->global_variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
200 res->types = xbt_dict_new_homogeneous(NULL);
201 res->full_types_by_name = xbt_dict_new_homogeneous(NULL);
205 void MC_free_object_info(mc_object_info_t* info) {
206 xbt_free(&(*info)->file_name);
207 xbt_dict_free(&(*info)->subprograms);
208 xbt_dynar_free(&(*info)->global_variables);
209 xbt_dict_free(&(*info)->types);
210 xbt_dict_free(&(*info)->full_types_by_name);
212 xbt_dynar_free(&(*info)->functions_index);
218 void* MC_object_base_address(mc_object_info_t info) {
219 void* result = info->start_exec;
220 if(info->start_rw!=NULL && result > (void*) info->start_rw) result = info->start_rw;
221 if(info->start_ro!=NULL && result > (void*) info->start_ro) result = info->start_ro;
225 // ***** Functions index
227 static int MC_compare_frame_index_items(mc_function_index_item_t a, mc_function_index_item_t b) {
228 if(a->low_pc < b->low_pc)
230 else if(a->low_pc == b->low_pc)
236 static void MC_make_functions_index(mc_object_info_t info) {
237 xbt_dynar_t index = xbt_dynar_new(sizeof(s_mc_function_index_item_t), NULL);
239 // Populate the array:
240 dw_frame_t frame = NULL;
241 xbt_dict_cursor_t cursor;
243 xbt_dict_foreach(info->subprograms, cursor, key, frame) {
244 if(frame->low_pc==NULL)
246 s_mc_function_index_item_t entry;
247 entry.low_pc = frame->low_pc;
248 entry.high_pc = frame->high_pc;
249 entry.function = frame;
250 xbt_dynar_push(index, &entry);
253 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(index, 0);
255 // Sort the array by low_pc:
257 xbt_dynar_length(index),
258 sizeof(s_mc_function_index_item_t),
259 (int (*)(const void *, const void *))MC_compare_frame_index_items);
261 info->functions_index = index;
264 mc_object_info_t MC_ip_find_object_info(void* ip) {
266 for(i=0; i!=mc_object_infos_size; ++i) {
267 if(ip >= (void*)mc_object_infos[i]->start_exec && ip <= (void*)mc_object_infos[i]->end_exec) {
268 return mc_object_infos[i];
274 static dw_frame_t MC_find_function_by_ip_and_object(void* ip, mc_object_info_t info) {
275 xbt_dynar_t dynar = info->functions_index;
276 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(dynar, 0);
278 int j = xbt_dynar_length(dynar) - 1;
280 int k = i + ((j-i)/2);
281 if(ip < base[k].low_pc) {
283 } else if(ip > base[k].high_pc) {
286 return base[k].function;
292 dw_frame_t MC_find_function_by_ip(void* ip) {
293 mc_object_info_t info = MC_ip_find_object_info(ip);
297 return MC_find_function_by_ip_and_object(ip, info);
300 static void MC_post_process_variables(mc_object_info_t info) {
302 dw_variable_t variable = NULL;
303 xbt_dynar_foreach(info->global_variables, cursor, variable) {
304 if(variable->type_origin) {
305 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
310 static void MC_post_process_functions(mc_object_info_t info) {
311 xbt_dict_cursor_t cursor;
313 dw_frame_t function = NULL;
314 xbt_dict_foreach(info->subprograms, cursor, key, function) {
315 unsigned cursor2 = 0;
316 dw_variable_t variable = NULL;
317 xbt_dynar_foreach(function->variables, cursor2, variable) {
318 if(variable->type_origin) {
319 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
325 /** \brief Finds informations about a given shared object/executable */
326 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
327 mc_object_info_t result = MC_new_object_info();
329 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
330 result->file_name = xbt_strdup(name);
331 MC_find_object_address(maps, result);
332 MC_dwarf_get_variables(result);
333 MC_post_process_types(result);
334 MC_post_process_variables(result);
335 MC_post_process_functions(result);
336 MC_make_functions_index(result);
340 /*************************************************************************/
342 /** \brief Finds a frame (DW_TAG_subprogram) from an DWARF offset in the rangd of this subprogram
344 * The offset can be an offset of a child DW_TAG_variable.
346 static dw_frame_t MC_dwarf_get_frame_by_offset(xbt_dict_t all_variables, unsigned long int offset){
348 xbt_dict_cursor_t cursor = NULL;
352 xbt_dict_foreach(all_variables, cursor, name, res) {
353 if(offset >= res->start && offset < res->end){
354 xbt_dict_cursor_free(&cursor);
359 xbt_dict_cursor_free(&cursor);
364 static dw_variable_t MC_dwarf_get_variable_by_name(dw_frame_t frame, char *var){
366 unsigned int cursor = 0;
367 dw_variable_t current_var;
369 xbt_dynar_foreach(frame->variables, cursor, current_var){
370 if(strcmp(var, current_var->name) == 0)
377 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
379 if(xbt_dynar_is_empty(variables))
382 unsigned int cursor = 0;
384 int end = xbt_dynar_length(variables) - 1;
385 dw_variable_t var_test = NULL;
388 cursor = (start + end) / 2;
389 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
390 if(strcmp(var_test->name, var) < 0){
392 }else if(strcmp(var_test->name, var) > 0){
395 if(address){ /* global variable */
396 if(var_test->address == address)
398 if(var_test->address > address)
402 }else{ /* local variable */
408 if(strcmp(var_test->name, var) == 0){
409 if(address && var_test->address < address)
413 }else if(strcmp(var_test->name, var) < 0)
420 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
421 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
423 xbt_dynar_insert_at(info->global_variables, index, &variable);
427 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
428 xbt_assert(frame, "Frame is NULL");
429 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
431 xbt_dynar_insert_at(frame->variables, index, &variable);
435 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
437 MC_dwarf_register_global_variable(info, variable);
439 xbt_die("No frame for this local variable");
441 MC_dwarf_register_non_global_variable(info, frame, variable);
445 /******************************* Ignore mechanism *******************************/
446 /*********************************************************************************/
448 xbt_dynar_t mc_checkpoint_ignore;
450 typedef struct s_mc_stack_ignore_variable{
453 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
455 /**************************** Free functions ******************************/
457 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
458 xbt_free(v->var_name);
463 static void stack_ignore_variable_free_voidp(void *v){
464 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
467 void heap_ignore_region_free(mc_heap_ignore_region_t r){
471 void heap_ignore_region_free_voidp(void *r){
472 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
475 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
479 static void checkpoint_ignore_region_free_voidp(void *r){
480 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
483 /***********************************************************************/
485 void MC_ignore_heap(void *address, size_t size){
487 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
491 mc_heap_ignore_region_t region = NULL;
492 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
493 region->address = address;
496 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
498 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
499 region->fragment = -1;
500 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
502 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
503 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
506 if(mc_heap_comparison_ignore == NULL){
507 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
508 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
514 unsigned int cursor = 0;
515 mc_heap_ignore_region_t current_region = NULL;
517 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
520 cursor = (start + end) / 2;
521 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
522 if(current_region->address == address){
523 heap_ignore_region_free(region);
527 }else if(current_region->address < address){
534 if(current_region->address < address)
535 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
537 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
543 void MC_remove_ignore_heap(void *address, size_t size){
545 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
549 unsigned int cursor = 0;
551 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
552 mc_heap_ignore_region_t region;
553 int ignore_found = 0;
556 cursor = (start + end) / 2;
557 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
558 if(region->address == address){
561 }else if(region->address < address){
564 if((char * )region->address <= ((char *)address + size)){
573 if(ignore_found == 1){
574 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
575 MC_remove_ignore_heap(address, size);
583 void MC_ignore_global_variable(const char *name){
585 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
589 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
591 unsigned int cursor = 0;
592 dw_variable_t current_var;
594 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
597 cursor = (start + end) /2;
598 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
599 if(strcmp(current_var->name, name) == 0){
600 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
602 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
603 }else if(strcmp(current_var->name, name) < 0){
614 static void MC_ignore_local_variable_in_object(const char *var_name, const char *frame_name, mc_object_info_t info) {
615 xbt_dict_cursor_t cursor2;
619 dw_variable_t current_var;
621 xbt_dict_foreach(info->subprograms, cursor2, key, frame) {
623 if(frame_name && strcmp(frame_name, frame->name))
627 end = xbt_dynar_length(frame->variables) - 1;
629 cursor = (start + end) / 2;
630 current_var = (dw_variable_t)xbt_dynar_get_as(frame->variables, cursor, dw_variable_t);
632 int compare = strcmp(current_var->name, var_name);
634 xbt_dynar_remove_at(frame->variables, cursor, NULL);
636 end = xbt_dynar_length(frame->variables) - 1;
637 }else if(compare < 0){
646 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
648 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
650 if(strcmp(frame_name, "*") == 0)
655 MC_ignore_local_variable_in_object(var_name, frame_name, mc_libsimgrid_info);
657 MC_ignore_local_variable_in_object(var_name, frame_name, mc_binary_info);
664 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
666 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
670 if(stacks_areas == NULL)
671 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
673 stack_region_t region = NULL;
674 region = xbt_new0(s_stack_region_t, 1);
675 region->address = stack;
676 region->process_name = strdup(name);
677 region->context = context;
679 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
680 xbt_dynar_push(stacks_areas, ®ion);
686 void MC_ignore(void *addr, size_t size){
688 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
692 if(mc_checkpoint_ignore == NULL)
693 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
695 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
699 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
700 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
703 unsigned int cursor = 0;
705 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
706 mc_checkpoint_ignore_region_t current_region = NULL;
709 cursor = (start + end) / 2;
710 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
711 if(current_region->addr == addr){
712 if(current_region->size == size){
713 checkpoint_ignore_region_free(region);
717 }else if(current_region->size < size){
722 }else if(current_region->addr < addr){
729 if(current_region->addr == addr){
730 if(current_region->size < size){
731 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
733 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
735 }else if(current_region->addr < addr){
736 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
738 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
746 /******************************* Initialisation of MC *******************************/
747 /*********************************************************************************/
749 static void MC_post_process_object_info(mc_object_info_t info) {
750 xbt_dict_cursor_t cursor = NULL;
752 dw_type_t type = NULL;
753 xbt_dict_foreach(info->types, cursor, key, type){
755 // Resolve full_type:
756 if(type->name && type->byte_size == 0) {
757 for(size_t i=0; i!=mc_object_infos_size; ++i) {
758 dw_type_t same_type = xbt_dict_get_or_null(mc_object_infos[i]->full_types_by_name, type->name);
759 if(same_type && same_type->name && same_type->byte_size) {
760 type->full_type = same_type;
769 static void MC_init_debug_info(void) {
770 XBT_INFO("Get debug information ...");
772 memory_map_t maps = MC_get_memory_map();
774 /* Get local variables for state equality detection */
775 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
776 mc_object_infos[0] = mc_binary_info;
778 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
779 mc_object_infos[1] = mc_libsimgrid_info;
781 // Use information of the other objects:
782 MC_post_process_object_info(mc_binary_info);
783 MC_post_process_object_info(mc_libsimgrid_info);
785 MC_free_memory_map(maps);
786 XBT_INFO("Get debug information done !");
791 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
795 /* Initialize the data structures that must be persistent across every
796 iteration of the model-checker (in RAW memory) */
800 MC_init_memory_map_info();
801 MC_init_debug_info();
804 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
808 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
809 MC_ignore_local_variable("e", "*");
810 MC_ignore_local_variable("__ex_cleanup", "*");
811 MC_ignore_local_variable("__ex_mctx_en", "*");
812 MC_ignore_local_variable("__ex_mctx_me", "*");
813 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
814 MC_ignore_local_variable("_log_ev", "*");
815 MC_ignore_local_variable("_throw_ctx", "*");
816 MC_ignore_local_variable("ctx", "*");
818 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
819 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
820 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
822 /* Ignore local variable about time used for tracing */
823 MC_ignore_local_variable("start_time", "*");
825 MC_ignore_global_variable("compared_pointers");
826 MC_ignore_global_variable("mc_comp_times");
827 MC_ignore_global_variable("mc_snapshot_comparison_time");
828 MC_ignore_global_variable("mc_time");
829 MC_ignore_global_variable("smpi_current_rank");
830 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
831 MC_ignore_global_variable("maestro_stack_start");
832 MC_ignore_global_variable("maestro_stack_end");
833 MC_ignore_global_variable("smx_total_comms");
835 MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
836 MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
837 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
838 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
840 smx_process_t process;
841 xbt_swag_foreach(process, simix_global->process_list){
842 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
850 static void MC_init_dot_output(){ /* FIXME : more colors */
854 colors[2] = "green3";
855 colors[3] = "goldenrod";
857 colors[5] = "purple";
858 colors[6] = "magenta";
859 colors[7] = "turquoise4";
860 colors[8] = "gray25";
861 colors[9] = "forestgreen";
862 colors[10] = "hotpink";
863 colors[11] = "lightblue";
866 dot_output = fopen(_sg_mc_dot_output_file, "w");
868 if(dot_output == NULL){
869 perror("Error open dot output file");
873 fprintf(dot_output, "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");
877 /******************************* Core of MC *******************************/
878 /**************************************************************************/
880 void MC_do_the_modelcheck_for_real() {
883 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
886 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
887 if (mc_reduce_kind==e_mc_reduce_unset)
888 mc_reduce_kind=e_mc_reduce_dpor;
890 XBT_INFO("Check a safety property");
891 MC_modelcheck_safety();
895 if (mc_reduce_kind==e_mc_reduce_unset)
896 mc_reduce_kind=e_mc_reduce_none;
898 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
899 MC_automaton_load(_sg_mc_property_file);
900 MC_modelcheck_liveness();
904 void MC_modelcheck_safety(void)
906 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
908 /* Check if MC is already initialized */
909 if (initial_state_safety)
912 mc_time = xbt_new0(double, simix_process_maxpid);
914 /* mc_time refers to clock for each process -> ignore it for heap comparison */
915 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
917 /* Initialize the data structures that must be persistent across every
918 iteration of the model-checker (in RAW memory) */
922 /* Initialize statistics */
923 mc_stats = xbt_new0(s_mc_stats_t, 1);
924 mc_stats->state_size = 1;
926 /* Create exploration stack */
927 mc_stack_safety = xbt_fifo_new();
929 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
930 MC_init_dot_output();
934 if(_sg_mc_visited > 0){
938 MC_init_memory_map_info();
939 MC_init_debug_info();
946 /* Save the initial state */
947 initial_state_safety = xbt_new0(s_mc_global_t, 1);
948 initial_state_safety->snapshot = MC_take_snapshot(0);
949 initial_state_safety->initial_communications_pattern_done = 0;
950 initial_state_safety->comm_deterministic = 1;
951 initial_state_safety->send_deterministic = 1;
963 void MC_modelcheck_liveness(){
965 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
969 mc_time = xbt_new0(double, simix_process_maxpid);
971 /* mc_time refers to clock for each process -> ignore it for heap comparison */
972 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
976 /* Initialize statistics */
977 mc_stats = xbt_new0(s_mc_stats_t, 1);
978 mc_stats->state_size = 1;
980 /* Create exploration stack */
981 mc_stack_liveness = xbt_fifo_new();
983 /* Create the initial state */
984 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
986 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
987 MC_init_dot_output();
994 MC_print_statistics(mc_stats);
1011 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
1013 return simcall->mc_value;
1017 int MC_random(int min, int max)
1019 /*FIXME: return mc_current_state->executed_transition->random.value;*/
1020 return simcall_mc_random(min, max);
1024 * \brief Schedules all the process that are ready to run
1026 void MC_wait_for_requests(void)
1028 smx_process_t process;
1032 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1033 SIMIX_process_runall();
1034 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1035 req = &process->simcall;
1036 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1037 SIMIX_simcall_pre(req, 0);
1042 int MC_deadlock_check()
1044 int deadlock = FALSE;
1045 smx_process_t process;
1046 if(xbt_swag_size(simix_global->process_list)){
1048 xbt_swag_foreach(process, simix_global->process_list){
1049 if(process->simcall.call != SIMCALL_NONE
1050 && MC_request_is_enabled(&process->simcall)){
1060 * \brief Re-executes from the state at position start all the transitions indicated by
1061 * a given model-checker stack.
1062 * \param stack The stack with the transitions to execute.
1063 * \param start Start index to begin the re-execution.
1065 void MC_replay(xbt_fifo_t stack, int start)
1067 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1069 int value, i = 1, count = 1;
1071 smx_simcall_t req = NULL, saved_req = NULL;
1072 xbt_fifo_item_t item, start_item;
1074 smx_process_t process = NULL;
1075 int comm_pattern = 0;
1077 XBT_DEBUG("**** Begin Replay ****");
1080 /* Restore the initial state */
1081 MC_restore_snapshot(initial_state_safety->snapshot);
1082 /* At the moment of taking the snapshot the raw heap was set, so restoring
1083 * it will set it back again, we have to unset it to continue */
1087 start_item = xbt_fifo_get_last_item(stack);
1090 start_item = xbt_fifo_get_prev_item(start_item);
1096 xbt_dict_reset(first_enabled_state);
1097 xbt_swag_foreach(process, simix_global->process_list){
1098 if(MC_process_is_enabled(process)){
1099 char *key = bprintf("%lu", process->pid);
1100 char *data = bprintf("%d", count);
1101 xbt_dict_set(first_enabled_state, key, data, NULL);
1105 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
1106 xbt_dynar_reset(communications_pattern);
1110 /* Traverse the stack from the state at position start and re-execute the transitions */
1111 for (item = start_item;
1112 item != xbt_fifo_get_first_item(stack);
1113 item = xbt_fifo_get_prev_item(item)) {
1115 state = (mc_state_t) xbt_fifo_get_item_content(item);
1116 saved_req = MC_state_get_executed_request(state, &value);
1119 char *key = bprintf("%lu", saved_req->issuer->pid);
1120 xbt_dict_remove(first_enabled_state, key);
1125 /* because we got a copy of the executed request, we have to fetch the
1126 real one, pointed by the request field of the issuer process */
1127 req = &saved_req->issuer->simcall;
1129 /* Debug information */
1130 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1131 req_str = MC_request_to_string(req, value);
1132 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1137 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1138 if(req->call == SIMCALL_COMM_ISEND)
1140 else if(req->call == SIMCALL_COMM_IRECV)
1144 SIMIX_simcall_pre(req, value);
1146 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1148 if(comm_pattern != 0){
1149 get_comm_pattern(communications_pattern, req, comm_pattern);
1155 MC_wait_for_requests();
1160 /* Insert in dict all enabled processes */
1161 xbt_swag_foreach(process, simix_global->process_list){
1162 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1163 char *key = bprintf("%lu", process->pid);
1164 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1165 char *data = bprintf("%d", count);
1166 xbt_dict_set(first_enabled_state, key, data, NULL);
1173 /* Update statistics */
1174 mc_stats->visited_states++;
1175 mc_stats->executed_transitions++;
1179 XBT_DEBUG("**** End Replay ****");
1189 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1192 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1196 smx_simcall_t req = NULL, saved_req = NULL;
1197 xbt_fifo_item_t item;
1202 XBT_DEBUG("**** Begin Replay ****");
1204 /* Restore the initial state */
1205 MC_restore_snapshot(initial_state_liveness->snapshot);
1207 /* At the moment of taking the snapshot the raw heap was set, so restoring
1208 * it will set it back again, we have to unset it to continue */
1209 if(!initial_state_liveness->raw_mem_set)
1214 item = xbt_fifo_get_last_item(stack);
1216 while(depth <= xbt_fifo_size(stack)){
1218 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1219 state = (mc_state_t) pair->graph_state;
1221 if(pair->requests > 0){
1223 saved_req = MC_state_get_executed_request(state, &value);
1224 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1226 if(saved_req != NULL){
1227 /* because we got a copy of the executed request, we have to fetch the
1228 real one, pointed by the request field of the issuer process */
1229 req = &saved_req->issuer->simcall;
1230 //XBT_DEBUG("Req->call %u", req->call);
1232 /* Debug information */
1233 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1234 req_str = MC_request_to_string(req, value);
1235 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1241 SIMIX_simcall_pre(req, value);
1242 MC_wait_for_requests();
1247 /* Update statistics */
1248 mc_stats->visited_pairs++;
1249 mc_stats->executed_transitions++;
1251 item = xbt_fifo_get_prev_item(item);
1256 /* Traverse the stack from the initial state and re-execute the transitions */
1257 for (item = xbt_fifo_get_last_item(stack);
1258 item != xbt_fifo_get_first_item(stack);
1259 item = xbt_fifo_get_prev_item(item)) {
1261 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1262 state = (mc_state_t) pair->graph_state;
1264 if(pair->requests > 0){
1266 saved_req = MC_state_get_executed_request(state, &value);
1267 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1269 if(saved_req != NULL){
1270 /* because we got a copy of the executed request, we have to fetch the
1271 real one, pointed by the request field of the issuer process */
1272 req = &saved_req->issuer->simcall;
1273 //XBT_DEBUG("Req->call %u", req->call);
1275 /* Debug information */
1276 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1277 req_str = MC_request_to_string(req, value);
1278 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1284 SIMIX_simcall_pre(req, value);
1285 MC_wait_for_requests();
1290 /* Update statistics */
1291 mc_stats->visited_pairs++;
1292 mc_stats->executed_transitions++;
1296 XBT_DEBUG("**** End Replay ****");
1298 if(initial_state_liveness->raw_mem_set)
1306 * \brief Dumps the contents of a model-checker's stack and shows the actual
1308 * \param stack The stack to dump
1310 void MC_dump_stack_safety(xbt_fifo_t stack)
1313 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1315 MC_show_stack_safety(stack);
1317 if(!_sg_mc_checkpoint){
1322 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1323 MC_state_delete(state);
1336 void MC_show_stack_safety(xbt_fifo_t stack)
1339 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1345 xbt_fifo_item_t item;
1347 char *req_str = NULL;
1349 for (item = xbt_fifo_get_last_item(stack);
1350 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1351 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1352 req = MC_state_get_executed_request(state, &value);
1354 req_str = MC_request_to_string(req, value);
1355 XBT_INFO("%s", req_str);
1364 void MC_show_deadlock(smx_simcall_t req)
1366 /*char *req_str = NULL;*/
1367 XBT_INFO("**************************");
1368 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1369 XBT_INFO("**************************");
1370 XBT_INFO("Locked request:");
1371 /*req_str = MC_request_to_string(req);
1372 XBT_INFO("%s", req_str);
1373 xbt_free(req_str);*/
1374 XBT_INFO("Counter-example execution trace:");
1375 MC_dump_stack_safety(mc_stack_safety);
1376 MC_print_statistics(mc_stats);
1380 void MC_show_stack_liveness(xbt_fifo_t stack){
1383 xbt_fifo_item_t item;
1385 char *req_str = NULL;
1387 for (item = xbt_fifo_get_last_item(stack);
1388 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1389 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1390 req = MC_state_get_executed_request(pair->graph_state, &value);
1392 if(pair->requests>0){
1393 req_str = MC_request_to_string(req, value);
1394 XBT_INFO("%s", req_str);
1397 XBT_INFO("End of system requests but evolution in Büchi automaton");
1403 void MC_dump_stack_liveness(xbt_fifo_t stack){
1405 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1410 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1411 MC_pair_delete(pair);
1420 void MC_print_statistics(mc_stats_t stats)
1422 if(stats->expanded_pairs == 0){
1423 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1424 XBT_INFO("Visited states = %lu", stats->visited_states);
1426 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1427 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1429 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1431 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1432 fprintf(dot_output, "}\n");
1435 if(initial_state_safety != NULL){
1436 if(_sg_mc_comms_determinism)
1437 XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1438 if (_sg_mc_send_determinism)
1439 XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1444 void MC_assert(int prop)
1446 if (MC_is_active() && !prop){
1447 XBT_INFO("**************************");
1448 XBT_INFO("*** PROPERTY NOT VALID ***");
1449 XBT_INFO("**************************");
1450 XBT_INFO("Counter-example execution trace:");
1451 MC_dump_stack_safety(mc_stack_safety);
1452 MC_print_statistics(mc_stats);
1458 user_max_depth_reached = 1;
1461 void MC_process_clock_add(smx_process_t process, double amount)
1463 mc_time[process->pid] += amount;
1466 double MC_process_clock_get(smx_process_t process)
1470 return mc_time[process->pid];
1478 void MC_automaton_load(const char *file){
1480 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1484 if (_mc_property_automaton == NULL)
1485 _mc_property_automaton = xbt_automaton_new();
1487 xbt_automaton_load(_mc_property_automaton,file);
1496 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1498 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1502 if (_mc_property_automaton == NULL)
1503 _mc_property_automaton = xbt_automaton_new();
1505 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);