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 void dw_variable_free(dw_variable_t v){
176 xbt_free(v->type_origin);
178 if(v->locations.locations)
179 mc_dwarf_location_list_clear(&v->locations);
184 void dw_variable_free_voidp(void *t){
185 dw_variable_free((dw_variable_t) * (void **) t);
192 mc_object_info_t MC_new_object_info(void) {
193 mc_object_info_t res = xbt_new0(s_mc_object_info_t, 1);
194 res->subprograms = xbt_dict_new_homogeneous((void (*)(void*))mc_frame_free);
195 res->global_variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
196 res->types = xbt_dict_new_homogeneous((void (*)(void*))dw_type_free);
197 res->full_types_by_name = xbt_dict_new_homogeneous(NULL);
201 void MC_free_object_info(mc_object_info_t* info) {
202 xbt_free(&(*info)->file_name);
203 xbt_dict_free(&(*info)->subprograms);
204 xbt_dynar_free(&(*info)->global_variables);
205 xbt_dict_free(&(*info)->types);
206 xbt_dict_free(&(*info)->full_types_by_name);
208 xbt_dynar_free(&(*info)->functions_index);
214 void* MC_object_base_address(mc_object_info_t info) {
215 void* result = info->start_exec;
216 if(info->start_rw!=NULL && result > (void*) info->start_rw) result = info->start_rw;
217 if(info->start_ro!=NULL && result > (void*) info->start_ro) result = info->start_ro;
221 // ***** Functions index
223 static int MC_compare_frame_index_items(mc_function_index_item_t a, mc_function_index_item_t b) {
224 if(a->low_pc < b->low_pc)
226 else if(a->low_pc == b->low_pc)
232 static void MC_make_functions_index(mc_object_info_t info) {
233 xbt_dynar_t index = xbt_dynar_new(sizeof(s_mc_function_index_item_t), NULL);
235 // Populate the array:
236 dw_frame_t frame = NULL;
237 xbt_dict_cursor_t cursor;
239 xbt_dict_foreach(info->subprograms, cursor, key, frame) {
240 if(frame->low_pc==NULL)
242 s_mc_function_index_item_t entry;
243 entry.low_pc = frame->low_pc;
244 entry.high_pc = frame->high_pc;
245 entry.function = frame;
246 xbt_dynar_push(index, &entry);
249 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(index, 0);
251 // Sort the array by low_pc:
253 xbt_dynar_length(index),
254 sizeof(s_mc_function_index_item_t),
255 (int (*)(const void *, const void *))MC_compare_frame_index_items);
257 info->functions_index = index;
260 mc_object_info_t MC_ip_find_object_info(void* ip) {
262 for(i=0; i!=mc_object_infos_size; ++i) {
263 if(ip >= (void*)mc_object_infos[i]->start_exec && ip <= (void*)mc_object_infos[i]->end_exec) {
264 return mc_object_infos[i];
270 static dw_frame_t MC_find_function_by_ip_and_object(void* ip, mc_object_info_t info) {
271 xbt_dynar_t dynar = info->functions_index;
272 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(dynar, 0);
274 int j = xbt_dynar_length(dynar) - 1;
276 int k = i + ((j-i)/2);
277 if(ip < base[k].low_pc) {
279 } else if(ip > base[k].high_pc) {
282 return base[k].function;
288 dw_frame_t MC_find_function_by_ip(void* ip) {
289 mc_object_info_t info = MC_ip_find_object_info(ip);
293 return MC_find_function_by_ip_and_object(ip, info);
296 static void MC_post_process_variables(mc_object_info_t info) {
298 dw_variable_t variable = NULL;
299 xbt_dynar_foreach(info->global_variables, cursor, variable) {
300 if(variable->type_origin) {
301 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
306 static void MC_post_process_functions(mc_object_info_t info) {
307 xbt_dict_cursor_t cursor;
309 dw_frame_t function = NULL;
310 xbt_dict_foreach(info->subprograms, cursor, key, function) {
311 unsigned cursor2 = 0;
312 dw_variable_t variable = NULL;
313 xbt_dynar_foreach(function->variables, cursor2, variable) {
314 if(variable->type_origin) {
315 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
321 /** \brief Finds informations about a given shared object/executable */
322 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
323 mc_object_info_t result = MC_new_object_info();
325 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
326 result->file_name = xbt_strdup(name);
327 MC_find_object_address(maps, result);
328 MC_dwarf_get_variables(result);
329 MC_post_process_types(result);
330 MC_post_process_variables(result);
331 MC_post_process_functions(result);
332 MC_make_functions_index(result);
336 /*************************************************************************/
338 /** \brief Finds a frame (DW_TAG_subprogram) from an DWARF offset in the rangd of this subprogram
340 * The offset can be an offset of a child DW_TAG_variable.
342 static dw_frame_t MC_dwarf_get_frame_by_offset(xbt_dict_t all_variables, unsigned long int offset){
344 xbt_dict_cursor_t cursor = NULL;
348 xbt_dict_foreach(all_variables, cursor, name, res) {
349 if(offset >= res->start && offset < res->end){
350 xbt_dict_cursor_free(&cursor);
355 xbt_dict_cursor_free(&cursor);
360 static dw_variable_t MC_dwarf_get_variable_by_name(dw_frame_t frame, char *var){
362 unsigned int cursor = 0;
363 dw_variable_t current_var;
365 xbt_dynar_foreach(frame->variables, cursor, current_var){
366 if(strcmp(var, current_var->name) == 0)
373 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
375 if(xbt_dynar_is_empty(variables))
378 unsigned int cursor = 0;
380 int end = xbt_dynar_length(variables) - 1;
381 dw_variable_t var_test = NULL;
384 cursor = (start + end) / 2;
385 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
386 if(strcmp(var_test->name, var) < 0){
388 }else if(strcmp(var_test->name, var) > 0){
391 if(address){ /* global variable */
392 if(var_test->address == address)
394 if(var_test->address > address)
398 }else{ /* local variable */
404 if(strcmp(var_test->name, var) == 0){
405 if(address && var_test->address < address)
409 }else if(strcmp(var_test->name, var) < 0)
416 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
417 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
419 xbt_dynar_insert_at(info->global_variables, index, &variable);
423 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
424 xbt_assert(frame, "Frame is NULL");
425 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
427 xbt_dynar_insert_at(frame->variables, index, &variable);
431 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
433 MC_dwarf_register_global_variable(info, variable);
435 xbt_die("No frame for this local variable");
437 MC_dwarf_register_non_global_variable(info, frame, variable);
441 /******************************* Ignore mechanism *******************************/
442 /*********************************************************************************/
444 xbt_dynar_t mc_checkpoint_ignore;
446 typedef struct s_mc_stack_ignore_variable{
449 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
451 /**************************** Free functions ******************************/
453 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
454 xbt_free(v->var_name);
459 static void stack_ignore_variable_free_voidp(void *v){
460 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
463 void heap_ignore_region_free(mc_heap_ignore_region_t r){
467 void heap_ignore_region_free_voidp(void *r){
468 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
471 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
475 static void checkpoint_ignore_region_free_voidp(void *r){
476 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
479 /***********************************************************************/
481 void MC_ignore_heap(void *address, size_t size){
483 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
487 mc_heap_ignore_region_t region = NULL;
488 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
489 region->address = address;
492 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
494 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
495 region->fragment = -1;
496 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
498 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
499 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
502 if(mc_heap_comparison_ignore == NULL){
503 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
504 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
510 unsigned int cursor = 0;
511 mc_heap_ignore_region_t current_region = NULL;
513 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
516 cursor = (start + end) / 2;
517 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
518 if(current_region->address == address){
519 heap_ignore_region_free(region);
523 }else if(current_region->address < address){
530 if(current_region->address < address)
531 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
533 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
539 void MC_remove_ignore_heap(void *address, size_t size){
541 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
545 unsigned int cursor = 0;
547 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
548 mc_heap_ignore_region_t region;
549 int ignore_found = 0;
552 cursor = (start + end) / 2;
553 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
554 if(region->address == address){
557 }else if(region->address < address){
560 if((char * )region->address <= ((char *)address + size)){
569 if(ignore_found == 1){
570 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
571 MC_remove_ignore_heap(address, size);
579 void MC_ignore_global_variable(const char *name){
581 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
585 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
587 unsigned int cursor = 0;
588 dw_variable_t current_var;
590 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
593 cursor = (start + end) /2;
594 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
595 if(strcmp(current_var->name, name) == 0){
596 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
598 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
599 }else if(strcmp(current_var->name, name) < 0){
610 static void MC_ignore_local_variable_in_object(const char *var_name, const char *frame_name, mc_object_info_t info) {
611 xbt_dict_cursor_t cursor2;
615 dw_variable_t current_var;
617 xbt_dict_foreach(info->subprograms, cursor2, key, frame) {
619 if(frame_name && strcmp(frame_name, frame->name))
623 end = xbt_dynar_length(frame->variables) - 1;
625 cursor = (start + end) / 2;
626 current_var = (dw_variable_t)xbt_dynar_get_as(frame->variables, cursor, dw_variable_t);
628 int compare = strcmp(current_var->name, var_name);
630 xbt_dynar_remove_at(frame->variables, cursor, NULL);
632 end = xbt_dynar_length(frame->variables) - 1;
633 }else if(compare < 0){
642 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
644 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
646 if(strcmp(frame_name, "*") == 0)
651 MC_ignore_local_variable_in_object(var_name, frame_name, mc_libsimgrid_info);
653 MC_ignore_local_variable_in_object(var_name, frame_name, mc_binary_info);
660 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
662 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
666 if(stacks_areas == NULL)
667 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
669 stack_region_t region = NULL;
670 region = xbt_new0(s_stack_region_t, 1);
671 region->address = stack;
672 region->process_name = strdup(name);
673 region->context = context;
675 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
676 xbt_dynar_push(stacks_areas, ®ion);
682 void MC_ignore(void *addr, size_t size){
684 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
688 if(mc_checkpoint_ignore == NULL)
689 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
691 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
695 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
696 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
699 unsigned int cursor = 0;
701 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
702 mc_checkpoint_ignore_region_t current_region = NULL;
705 cursor = (start + end) / 2;
706 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
707 if(current_region->addr == addr){
708 if(current_region->size == size){
709 checkpoint_ignore_region_free(region);
713 }else if(current_region->size < size){
718 }else if(current_region->addr < addr){
725 if(current_region->addr == addr){
726 if(current_region->size < size){
727 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
729 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
731 }else if(current_region->addr < addr){
732 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
734 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
742 /******************************* Initialisation of MC *******************************/
743 /*********************************************************************************/
745 static void MC_post_process_object_info(mc_object_info_t info) {
746 xbt_dict_cursor_t cursor = NULL;
748 dw_type_t type = NULL;
749 xbt_dict_foreach(info->types, cursor, key, type){
751 // Resolve full_type:
752 if(type->name && type->byte_size == 0) {
753 for(size_t i=0; i!=mc_object_infos_size; ++i) {
754 dw_type_t same_type = xbt_dict_get_or_null(mc_object_infos[i]->full_types_by_name, type->name);
755 if(same_type && same_type->name && same_type->byte_size) {
756 type->full_type = same_type;
765 static void MC_init_debug_info(void) {
766 XBT_INFO("Get debug information ...");
768 memory_map_t maps = MC_get_memory_map();
770 /* Get local variables for state equality detection */
771 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
772 mc_object_infos[0] = mc_binary_info;
774 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
775 mc_object_infos[1] = mc_libsimgrid_info;
777 // Use information of the other objects:
778 MC_post_process_object_info(mc_binary_info);
779 MC_post_process_object_info(mc_libsimgrid_info);
781 MC_free_memory_map(maps);
782 XBT_INFO("Get debug information done !");
787 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
791 /* Initialize the data structures that must be persistent across every
792 iteration of the model-checker (in RAW memory) */
796 MC_init_memory_map_info();
797 MC_init_debug_info();
800 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
804 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
805 MC_ignore_local_variable("e", "*");
806 MC_ignore_local_variable("__ex_cleanup", "*");
807 MC_ignore_local_variable("__ex_mctx_en", "*");
808 MC_ignore_local_variable("__ex_mctx_me", "*");
809 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
810 MC_ignore_local_variable("_log_ev", "*");
811 MC_ignore_local_variable("_throw_ctx", "*");
812 MC_ignore_local_variable("ctx", "*");
814 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
815 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
816 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
818 /* Ignore local variable about time used for tracing */
819 MC_ignore_local_variable("start_time", "*");
821 MC_ignore_global_variable("compared_pointers");
822 MC_ignore_global_variable("mc_comp_times");
823 MC_ignore_global_variable("mc_snapshot_comparison_time");
824 MC_ignore_global_variable("mc_time");
825 MC_ignore_global_variable("smpi_current_rank");
826 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
827 MC_ignore_global_variable("maestro_stack_start");
828 MC_ignore_global_variable("maestro_stack_end");
829 MC_ignore_global_variable("smx_total_comms");
831 MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
832 MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
833 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
834 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
836 smx_process_t process;
837 xbt_swag_foreach(process, simix_global->process_list){
838 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
846 static void MC_init_dot_output(){ /* FIXME : more colors */
850 colors[2] = "green3";
851 colors[3] = "goldenrod";
853 colors[5] = "purple";
854 colors[6] = "magenta";
855 colors[7] = "turquoise4";
856 colors[8] = "gray25";
857 colors[9] = "forestgreen";
858 colors[10] = "hotpink";
859 colors[11] = "lightblue";
862 dot_output = fopen(_sg_mc_dot_output_file, "w");
864 if(dot_output == NULL){
865 perror("Error open dot output file");
869 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");
873 /******************************* Core of MC *******************************/
874 /**************************************************************************/
876 void MC_do_the_modelcheck_for_real() {
879 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
882 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
883 if (mc_reduce_kind==e_mc_reduce_unset)
884 mc_reduce_kind=e_mc_reduce_dpor;
886 XBT_INFO("Check a safety property");
887 MC_modelcheck_safety();
891 if (mc_reduce_kind==e_mc_reduce_unset)
892 mc_reduce_kind=e_mc_reduce_none;
894 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
895 MC_automaton_load(_sg_mc_property_file);
896 MC_modelcheck_liveness();
900 void MC_modelcheck_safety(void)
902 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
904 /* Check if MC is already initialized */
905 if (initial_state_safety)
908 mc_time = xbt_new0(double, simix_process_maxpid);
910 /* mc_time refers to clock for each process -> ignore it for heap comparison */
911 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
913 /* Initialize the data structures that must be persistent across every
914 iteration of the model-checker (in RAW memory) */
918 /* Initialize statistics */
919 mc_stats = xbt_new0(s_mc_stats_t, 1);
920 mc_stats->state_size = 1;
922 /* Create exploration stack */
923 mc_stack_safety = xbt_fifo_new();
925 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
926 MC_init_dot_output();
930 if(_sg_mc_visited > 0){
934 MC_init_memory_map_info();
935 MC_init_debug_info();
942 /* Save the initial state */
943 initial_state_safety = xbt_new0(s_mc_global_t, 1);
944 initial_state_safety->snapshot = MC_take_snapshot(0);
945 initial_state_safety->initial_communications_pattern_done = 0;
946 initial_state_safety->comm_deterministic = 1;
947 initial_state_safety->send_deterministic = 1;
959 void MC_modelcheck_liveness(){
961 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
965 mc_time = xbt_new0(double, simix_process_maxpid);
967 /* mc_time refers to clock for each process -> ignore it for heap comparison */
968 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
972 /* Initialize statistics */
973 mc_stats = xbt_new0(s_mc_stats_t, 1);
974 mc_stats->state_size = 1;
976 /* Create exploration stack */
977 mc_stack_liveness = xbt_fifo_new();
979 /* Create the initial state */
980 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
982 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
983 MC_init_dot_output();
990 MC_print_statistics(mc_stats);
1007 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
1009 return simcall->mc_value;
1013 int MC_random(int min, int max)
1015 /*FIXME: return mc_current_state->executed_transition->random.value;*/
1016 return simcall_mc_random(min, max);
1020 * \brief Schedules all the process that are ready to run
1022 void MC_wait_for_requests(void)
1024 smx_process_t process;
1028 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1029 SIMIX_process_runall();
1030 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1031 req = &process->simcall;
1032 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1033 SIMIX_simcall_pre(req, 0);
1038 int MC_deadlock_check()
1040 int deadlock = FALSE;
1041 smx_process_t process;
1042 if(xbt_swag_size(simix_global->process_list)){
1044 xbt_swag_foreach(process, simix_global->process_list){
1045 if(process->simcall.call != SIMCALL_NONE
1046 && MC_request_is_enabled(&process->simcall)){
1056 * \brief Re-executes from the state at position start all the transitions indicated by
1057 * a given model-checker stack.
1058 * \param stack The stack with the transitions to execute.
1059 * \param start Start index to begin the re-execution.
1061 void MC_replay(xbt_fifo_t stack, int start)
1063 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1065 int value, i = 1, count = 1;
1067 smx_simcall_t req = NULL, saved_req = NULL;
1068 xbt_fifo_item_t item, start_item;
1070 smx_process_t process = NULL;
1071 int comm_pattern = 0;
1073 XBT_DEBUG("**** Begin Replay ****");
1076 /* Restore the initial state */
1077 MC_restore_snapshot(initial_state_safety->snapshot);
1078 /* At the moment of taking the snapshot the raw heap was set, so restoring
1079 * it will set it back again, we have to unset it to continue */
1083 start_item = xbt_fifo_get_last_item(stack);
1086 start_item = xbt_fifo_get_prev_item(start_item);
1092 xbt_dict_reset(first_enabled_state);
1093 xbt_swag_foreach(process, simix_global->process_list){
1094 if(MC_process_is_enabled(process)){
1095 char *key = bprintf("%lu", process->pid);
1096 char *data = bprintf("%d", count);
1097 xbt_dict_set(first_enabled_state, key, data, NULL);
1101 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
1102 xbt_dynar_reset(communications_pattern);
1106 /* Traverse the stack from the state at position start and re-execute the transitions */
1107 for (item = start_item;
1108 item != xbt_fifo_get_first_item(stack);
1109 item = xbt_fifo_get_prev_item(item)) {
1111 state = (mc_state_t) xbt_fifo_get_item_content(item);
1112 saved_req = MC_state_get_executed_request(state, &value);
1115 char *key = bprintf("%lu", saved_req->issuer->pid);
1116 xbt_dict_remove(first_enabled_state, key);
1121 /* because we got a copy of the executed request, we have to fetch the
1122 real one, pointed by the request field of the issuer process */
1123 req = &saved_req->issuer->simcall;
1125 /* Debug information */
1126 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1127 req_str = MC_request_to_string(req, value);
1128 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1133 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1134 if(req->call == SIMCALL_COMM_ISEND)
1136 else if(req->call == SIMCALL_COMM_IRECV)
1140 SIMIX_simcall_pre(req, value);
1142 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1144 if(comm_pattern != 0){
1145 get_comm_pattern(communications_pattern, req, comm_pattern);
1151 MC_wait_for_requests();
1156 /* Insert in dict all enabled processes */
1157 xbt_swag_foreach(process, simix_global->process_list){
1158 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1159 char *key = bprintf("%lu", process->pid);
1160 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1161 char *data = bprintf("%d", count);
1162 xbt_dict_set(first_enabled_state, key, data, NULL);
1169 /* Update statistics */
1170 mc_stats->visited_states++;
1171 mc_stats->executed_transitions++;
1175 XBT_DEBUG("**** End Replay ****");
1185 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1188 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1192 smx_simcall_t req = NULL, saved_req = NULL;
1193 xbt_fifo_item_t item;
1198 XBT_DEBUG("**** Begin Replay ****");
1200 /* Restore the initial state */
1201 MC_restore_snapshot(initial_state_liveness->snapshot);
1203 /* At the moment of taking the snapshot the raw heap was set, so restoring
1204 * it will set it back again, we have to unset it to continue */
1205 if(!initial_state_liveness->raw_mem_set)
1210 item = xbt_fifo_get_last_item(stack);
1212 while(depth <= xbt_fifo_size(stack)){
1214 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1215 state = (mc_state_t) pair->graph_state;
1217 if(pair->requests > 0){
1219 saved_req = MC_state_get_executed_request(state, &value);
1220 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1222 if(saved_req != NULL){
1223 /* because we got a copy of the executed request, we have to fetch the
1224 real one, pointed by the request field of the issuer process */
1225 req = &saved_req->issuer->simcall;
1226 //XBT_DEBUG("Req->call %u", req->call);
1228 /* Debug information */
1229 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1230 req_str = MC_request_to_string(req, value);
1231 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1237 SIMIX_simcall_pre(req, value);
1238 MC_wait_for_requests();
1243 /* Update statistics */
1244 mc_stats->visited_pairs++;
1245 mc_stats->executed_transitions++;
1247 item = xbt_fifo_get_prev_item(item);
1252 /* Traverse the stack from the initial state and re-execute the transitions */
1253 for (item = xbt_fifo_get_last_item(stack);
1254 item != xbt_fifo_get_first_item(stack);
1255 item = xbt_fifo_get_prev_item(item)) {
1257 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1258 state = (mc_state_t) pair->graph_state;
1260 if(pair->requests > 0){
1262 saved_req = MC_state_get_executed_request(state, &value);
1263 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1265 if(saved_req != NULL){
1266 /* because we got a copy of the executed request, we have to fetch the
1267 real one, pointed by the request field of the issuer process */
1268 req = &saved_req->issuer->simcall;
1269 //XBT_DEBUG("Req->call %u", req->call);
1271 /* Debug information */
1272 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1273 req_str = MC_request_to_string(req, value);
1274 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1280 SIMIX_simcall_pre(req, value);
1281 MC_wait_for_requests();
1286 /* Update statistics */
1287 mc_stats->visited_pairs++;
1288 mc_stats->executed_transitions++;
1292 XBT_DEBUG("**** End Replay ****");
1294 if(initial_state_liveness->raw_mem_set)
1302 * \brief Dumps the contents of a model-checker's stack and shows the actual
1304 * \param stack The stack to dump
1306 void MC_dump_stack_safety(xbt_fifo_t stack)
1309 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1311 MC_show_stack_safety(stack);
1313 if(!_sg_mc_checkpoint){
1318 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1319 MC_state_delete(state);
1332 void MC_show_stack_safety(xbt_fifo_t stack)
1335 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1341 xbt_fifo_item_t item;
1343 char *req_str = NULL;
1345 for (item = xbt_fifo_get_last_item(stack);
1346 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1347 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1348 req = MC_state_get_executed_request(state, &value);
1350 req_str = MC_request_to_string(req, value);
1351 XBT_INFO("%s", req_str);
1360 void MC_show_deadlock(smx_simcall_t req)
1362 /*char *req_str = NULL;*/
1363 XBT_INFO("**************************");
1364 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1365 XBT_INFO("**************************");
1366 XBT_INFO("Locked request:");
1367 /*req_str = MC_request_to_string(req);
1368 XBT_INFO("%s", req_str);
1369 xbt_free(req_str);*/
1370 XBT_INFO("Counter-example execution trace:");
1371 MC_dump_stack_safety(mc_stack_safety);
1372 MC_print_statistics(mc_stats);
1376 void MC_show_stack_liveness(xbt_fifo_t stack){
1379 xbt_fifo_item_t item;
1381 char *req_str = NULL;
1383 for (item = xbt_fifo_get_last_item(stack);
1384 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1385 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1386 req = MC_state_get_executed_request(pair->graph_state, &value);
1388 if(pair->requests>0){
1389 req_str = MC_request_to_string(req, value);
1390 XBT_INFO("%s", req_str);
1393 XBT_INFO("End of system requests but evolution in Büchi automaton");
1399 void MC_dump_stack_liveness(xbt_fifo_t stack){
1401 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1406 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1407 MC_pair_delete(pair);
1416 void MC_print_statistics(mc_stats_t stats)
1418 if(stats->expanded_pairs == 0){
1419 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1420 XBT_INFO("Visited states = %lu", stats->visited_states);
1422 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1423 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1425 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1427 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1428 fprintf(dot_output, "}\n");
1431 if(initial_state_safety != NULL){
1432 if(_sg_mc_comms_determinism)
1433 XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1434 if (_sg_mc_send_determinism)
1435 XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1440 void MC_assert(int prop)
1442 if (MC_is_active() && !prop){
1443 XBT_INFO("**************************");
1444 XBT_INFO("*** PROPERTY NOT VALID ***");
1445 XBT_INFO("**************************");
1446 XBT_INFO("Counter-example execution trace:");
1447 MC_dump_stack_safety(mc_stack_safety);
1448 MC_print_statistics(mc_stats);
1454 user_max_depth_reached = 1;
1457 void MC_process_clock_add(smx_process_t process, double amount)
1459 mc_time[process->pid] += amount;
1462 double MC_process_clock_get(smx_process_t process)
1466 return mc_time[process->pid];
1474 void MC_automaton_load(const char *file){
1476 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1480 if (_mc_property_automaton == NULL)
1481 _mc_property_automaton = xbt_automaton_new();
1483 xbt_automaton_load(_mc_property_automaton,file);
1492 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1494 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1498 if (_mc_property_automaton == NULL)
1499 _mc_property_automaton = xbt_automaton_new();
1501 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);