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 /* Ignore mechanism */
142 extern xbt_dynar_t mc_heap_comparison_ignore;
143 extern xbt_dynar_t stacks_areas;
146 FILE *dot_output = NULL;
147 const char* colors[13];
150 /******************************* DWARF Information *******************************/
151 /**********************************************************************************/
153 /************************** Free functions *************************/
155 void dw_type_free(dw_type_t t){
157 xbt_free(t->dw_type_id);
158 xbt_dynar_free(&(t->members));
159 mc_dwarf_expression_clear(&t->location);
163 static void dw_type_free_voidp(void *t){
164 dw_type_free((dw_type_t) * (void **) t);
167 void dw_variable_free(dw_variable_t v){
170 xbt_free(v->type_origin);
172 if(v->locations.locations)
173 mc_dwarf_location_list_clear(&v->locations);
178 void dw_variable_free_voidp(void *t){
179 dw_variable_free((dw_variable_t) * (void **) t);
184 mc_object_info_t MC_new_object_info(void) {
185 mc_object_info_t res = xbt_new0(s_mc_object_info_t, 1);
186 res->subprograms = xbt_dynar_new(sizeof(dw_frame_t), NULL);
187 res->global_variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
188 res->types = xbt_dict_new_homogeneous(NULL);
189 res->types_by_name = xbt_dict_new_homogeneous(NULL);
193 void MC_free_object_info(mc_object_info_t* info) {
194 xbt_free(&(*info)->file_name);
195 xbt_dynar_free(&(*info)->subprograms);
196 xbt_dynar_free(&(*info)->global_variables);
197 xbt_dict_free(&(*info)->types);
198 xbt_dict_free(&(*info)->types_by_name);
200 xbt_dynar_free(&(*info)->functions_index);
206 void* MC_object_base_address(mc_object_info_t info) {
207 void* result = info->start_exec;
208 if(info->start_rw!=NULL && result > (void*) info->start_rw) result = info->start_rw;
209 if(info->start_ro!=NULL && result > (void*) info->start_ro) result = info->start_ro;
213 // ***** Functions index
215 static int MC_compare_frame_index_items(mc_function_index_item_t a, mc_function_index_item_t b) {
216 if(a->low_pc < b->low_pc)
218 else if(a->low_pc == b->low_pc)
224 static void MC_make_functions_index(mc_object_info_t info) {
225 xbt_dynar_t index = xbt_dynar_new(sizeof(s_mc_function_index_item_t), NULL);
227 // Populate the array:
228 dw_frame_t frame = NULL;
230 xbt_dynar_foreach(info->subprograms, cursor, frame) {
231 if(frame->low_pc==NULL)
233 s_mc_function_index_item_t entry;
234 entry.low_pc = frame->low_pc;
235 entry.high_pc = frame->high_pc;
236 entry.function = frame;
237 xbt_dynar_push(index, &entry);
240 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(index, 0);
242 // Sort the array by low_pc:
244 xbt_dynar_length(index),
245 sizeof(s_mc_function_index_item_t),
246 (int (*)(const void *, const void *))MC_compare_frame_index_items);
248 info->functions_index = index;
251 mc_object_info_t MC_ip_find_object_info(void* ip) {
252 mc_object_info_t infos[2] = { mc_binary_info, mc_libsimgrid_info };
255 for(i=0; i!=n; ++i) {
256 if(ip >= (void*)infos[i]->start_exec && ip <= (void*)infos[i]->end_exec) {
263 static dw_frame_t MC_find_function_by_ip_and_object(void* ip, mc_object_info_t info) {
264 xbt_dynar_t dynar = info->functions_index;
265 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(dynar, 0);
267 int j = xbt_dynar_length(dynar) - 1;
269 int k = i + ((j-i)/2);
270 if(ip < base[k].low_pc) {
272 } else if(ip > base[k].high_pc) {
275 return base[k].function;
281 dw_frame_t MC_find_function_by_ip(void* ip) {
282 mc_object_info_t info = MC_ip_find_object_info(ip);
286 return MC_find_function_by_ip_and_object(ip, info);
289 static void MC_post_process_variables(mc_object_info_t info) {
291 dw_variable_t variable = NULL;
292 xbt_dynar_foreach(info->global_variables, cursor, variable) {
293 if(variable->type_origin) {
294 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
299 static void MC_post_process_functions(mc_object_info_t info) {
301 dw_frame_t function = NULL;
302 xbt_dynar_foreach(info->subprograms, cursor, function) {
303 unsigned cursor2 = 0;
304 dw_variable_t variable = NULL;
305 xbt_dynar_foreach(function->variables, cursor2, variable) {
306 if(variable->type_origin) {
307 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
313 /** \brief Finds informations about a given shared object/executable */
314 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
315 mc_object_info_t result = MC_new_object_info();
317 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
318 result->file_name = xbt_strdup(name);
319 MC_find_object_address(maps, result);
320 MC_dwarf_get_variables(result);
321 MC_post_process_types(result);
322 MC_post_process_variables(result);
323 MC_post_process_functions(result);
324 MC_make_functions_index(result);
328 /*************************************************************************/
330 /** \brief Finds a frame (DW_TAG_subprogram) from an DWARF offset in the rangd of this subprogram
332 * The offset can be an offset of a child DW_TAG_variable.
334 static dw_frame_t MC_dwarf_get_frame_by_offset(xbt_dict_t all_variables, unsigned long int offset){
336 xbt_dict_cursor_t cursor = NULL;
340 xbt_dict_foreach(all_variables, cursor, name, res) {
341 if(offset >= res->start && offset < res->end){
342 xbt_dict_cursor_free(&cursor);
347 xbt_dict_cursor_free(&cursor);
352 static dw_variable_t MC_dwarf_get_variable_by_name(dw_frame_t frame, char *var){
354 unsigned int cursor = 0;
355 dw_variable_t current_var;
357 xbt_dynar_foreach(frame->variables, cursor, current_var){
358 if(strcmp(var, current_var->name) == 0)
365 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
367 if(xbt_dynar_is_empty(variables))
370 unsigned int cursor = 0;
372 int end = xbt_dynar_length(variables) - 1;
373 dw_variable_t var_test = NULL;
376 cursor = (start + end) / 2;
377 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
378 if(strcmp(var_test->name, var) < 0){
380 }else if(strcmp(var_test->name, var) > 0){
383 if(address){ /* global variable */
384 if(var_test->address == address)
386 if(var_test->address > address)
390 }else{ /* local variable */
396 if(strcmp(var_test->name, var) == 0){
397 if(address && var_test->address < address)
401 }else if(strcmp(var_test->name, var) < 0)
408 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
409 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
411 xbt_dynar_insert_at(info->global_variables, index, &variable);
415 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
416 xbt_assert(frame, "Frame is NULL");
417 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
419 xbt_dynar_insert_at(frame->variables, index, &variable);
423 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
425 MC_dwarf_register_global_variable(info, variable);
427 xbt_die("No frame for this local variable");
429 MC_dwarf_register_non_global_variable(info, frame, variable);
433 /******************************* Ignore mechanism *******************************/
434 /*********************************************************************************/
436 xbt_dynar_t mc_checkpoint_ignore;
438 typedef struct s_mc_stack_ignore_variable{
441 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
443 /**************************** Free functions ******************************/
445 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
446 xbt_free(v->var_name);
451 static void stack_ignore_variable_free_voidp(void *v){
452 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
455 void heap_ignore_region_free(mc_heap_ignore_region_t r){
459 void heap_ignore_region_free_voidp(void *r){
460 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
463 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
467 static void checkpoint_ignore_region_free_voidp(void *r){
468 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
471 /***********************************************************************/
473 void MC_ignore_heap(void *address, size_t size){
475 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
479 mc_heap_ignore_region_t region = NULL;
480 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
481 region->address = address;
484 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
486 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
487 region->fragment = -1;
488 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
490 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
491 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
494 if(mc_heap_comparison_ignore == NULL){
495 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
496 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
502 unsigned int cursor = 0;
503 mc_heap_ignore_region_t current_region = NULL;
505 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
508 cursor = (start + end) / 2;
509 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
510 if(current_region->address == address){
511 heap_ignore_region_free(region);
515 }else if(current_region->address < address){
522 if(current_region->address < address)
523 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
525 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
531 void MC_remove_ignore_heap(void *address, size_t size){
533 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
537 unsigned int cursor = 0;
539 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
540 mc_heap_ignore_region_t region;
541 int ignore_found = 0;
544 cursor = (start + end) / 2;
545 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
546 if(region->address == address){
549 }else if(region->address < address){
552 if((char * )region->address <= ((char *)address + size)){
561 if(ignore_found == 1){
562 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
563 MC_remove_ignore_heap(address, size);
571 void MC_ignore_global_variable(const char *name){
573 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
577 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
579 unsigned int cursor = 0;
580 dw_variable_t current_var;
582 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
585 cursor = (start + end) /2;
586 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
587 if(strcmp(current_var->name, name) == 0){
588 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
590 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
591 }else if(strcmp(current_var->name, name) < 0){
602 static void MC_ignore_local_variable_in_object(const char *var_name, const char *frame_name, mc_object_info_t info) {
607 dw_variable_t current_var;
609 xbt_dynar_foreach(info->subprograms, cursor2, frame) {
611 if(frame_name && strcmp(frame_name, frame->name))
615 end = xbt_dynar_length(frame->variables) - 1;
617 cursor = (start + end) / 2;
618 current_var = (dw_variable_t)xbt_dynar_get_as(frame->variables, cursor, dw_variable_t);
620 int compare = strcmp(current_var->name, var_name);
622 xbt_dynar_remove_at(frame->variables, cursor, NULL);
624 end = xbt_dynar_length(frame->variables) - 1;
625 }else if(compare < 0){
634 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
636 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
638 if(strcmp(frame_name, "*") == 0)
643 MC_ignore_local_variable_in_object(var_name, frame_name, mc_libsimgrid_info);
645 MC_ignore_local_variable_in_object(var_name, frame_name, mc_binary_info);
652 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
654 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
658 if(stacks_areas == NULL)
659 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
661 stack_region_t region = NULL;
662 region = xbt_new0(s_stack_region_t, 1);
663 region->address = stack;
664 region->process_name = strdup(name);
665 region->context = context;
667 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
668 xbt_dynar_push(stacks_areas, ®ion);
674 void MC_ignore(void *addr, size_t size){
676 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
680 if(mc_checkpoint_ignore == NULL)
681 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
683 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
687 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
688 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
691 unsigned int cursor = 0;
693 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
694 mc_checkpoint_ignore_region_t current_region = NULL;
697 cursor = (start + end) / 2;
698 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
699 if(current_region->addr == addr){
700 if(current_region->size == size){
701 checkpoint_ignore_region_free(region);
705 }else if(current_region->size < size){
710 }else if(current_region->addr < addr){
717 if(current_region->addr == addr){
718 if(current_region->size < size){
719 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
721 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
723 }else if(current_region->addr < addr){
724 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
726 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
734 /******************************* Initialisation of MC *******************************/
735 /*********************************************************************************/
737 static void MC_post_process_object_info(mc_object_info_t info) {
738 mc_object_info_t other_info = info == mc_binary_info ? mc_libsimgrid_info : mc_binary_info;
739 xbt_dict_cursor_t cursor = NULL;
741 dw_type_t type = NULL;
742 xbt_dict_foreach(info->types, cursor, key, type){
743 if(type->name && type->byte_size == 0) {
744 type->other_object_same_type = xbt_dict_get_or_null(other_info->types_by_name, type->name);
749 static void MC_init_debug_info(void) {
750 XBT_INFO("Get debug information ...");
752 memory_map_t maps = MC_get_memory_map();
754 /* Get local variables for state equality detection */
755 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
756 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
758 // Use information of the other objects:
759 MC_post_process_object_info(mc_binary_info);
760 MC_post_process_object_info(mc_libsimgrid_info);
762 MC_free_memory_map(maps);
763 XBT_INFO("Get debug information done !");
768 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
772 /* Initialize the data structures that must be persistent across every
773 iteration of the model-checker (in RAW memory) */
777 MC_init_memory_map_info();
778 MC_init_debug_info();
781 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
785 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
786 MC_ignore_local_variable("e", "*");
787 MC_ignore_local_variable("__ex_cleanup", "*");
788 MC_ignore_local_variable("__ex_mctx_en", "*");
789 MC_ignore_local_variable("__ex_mctx_me", "*");
790 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
791 MC_ignore_local_variable("_log_ev", "*");
792 MC_ignore_local_variable("_throw_ctx", "*");
793 MC_ignore_local_variable("ctx", "*");
795 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
796 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
797 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
799 /* Ignore local variable about time used for tracing */
800 MC_ignore_local_variable("start_time", "*");
802 MC_ignore_global_variable("compared_pointers");
803 MC_ignore_global_variable("mc_comp_times");
804 MC_ignore_global_variable("mc_snapshot_comparison_time");
805 MC_ignore_global_variable("mc_time");
806 MC_ignore_global_variable("smpi_current_rank");
807 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
808 MC_ignore_global_variable("maestro_stack_start");
809 MC_ignore_global_variable("maestro_stack_end");
810 MC_ignore_global_variable("smx_total_comms");
812 MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
813 MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
814 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
815 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
817 smx_process_t process;
818 xbt_swag_foreach(process, simix_global->process_list){
819 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
827 static void MC_init_dot_output(){ /* FIXME : more colors */
831 colors[2] = "green3";
832 colors[3] = "goldenrod";
834 colors[5] = "purple";
835 colors[6] = "magenta";
836 colors[7] = "turquoise4";
837 colors[8] = "gray25";
838 colors[9] = "forestgreen";
839 colors[10] = "hotpink";
840 colors[11] = "lightblue";
843 dot_output = fopen(_sg_mc_dot_output_file, "w");
845 if(dot_output == NULL){
846 perror("Error open dot output file");
850 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");
854 /******************************* Core of MC *******************************/
855 /**************************************************************************/
857 void MC_do_the_modelcheck_for_real() {
860 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
863 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
864 if (mc_reduce_kind==e_mc_reduce_unset)
865 mc_reduce_kind=e_mc_reduce_dpor;
867 XBT_INFO("Check a safety property");
868 MC_modelcheck_safety();
872 if (mc_reduce_kind==e_mc_reduce_unset)
873 mc_reduce_kind=e_mc_reduce_none;
875 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
876 MC_automaton_load(_sg_mc_property_file);
877 MC_modelcheck_liveness();
881 void MC_modelcheck_safety(void)
883 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
885 /* Check if MC is already initialized */
886 if (initial_state_safety)
889 mc_time = xbt_new0(double, simix_process_maxpid);
891 /* mc_time refers to clock for each process -> ignore it for heap comparison */
892 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
894 /* Initialize the data structures that must be persistent across every
895 iteration of the model-checker (in RAW memory) */
899 /* Initialize statistics */
900 mc_stats = xbt_new0(s_mc_stats_t, 1);
901 mc_stats->state_size = 1;
903 /* Create exploration stack */
904 mc_stack_safety = xbt_fifo_new();
906 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
907 MC_init_dot_output();
911 if(_sg_mc_visited > 0){
915 MC_init_memory_map_info();
916 MC_init_debug_info();
923 /* Save the initial state */
924 initial_state_safety = xbt_new0(s_mc_global_t, 1);
925 initial_state_safety->snapshot = MC_take_snapshot(0);
926 initial_state_safety->initial_communications_pattern_done = 0;
927 initial_state_safety->comm_deterministic = 1;
928 initial_state_safety->send_deterministic = 1;
940 void MC_modelcheck_liveness(){
942 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
946 mc_time = xbt_new0(double, simix_process_maxpid);
948 /* mc_time refers to clock for each process -> ignore it for heap comparison */
949 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
953 /* Initialize statistics */
954 mc_stats = xbt_new0(s_mc_stats_t, 1);
955 mc_stats->state_size = 1;
957 /* Create exploration stack */
958 mc_stack_liveness = xbt_fifo_new();
960 /* Create the initial state */
961 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
963 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
964 MC_init_dot_output();
971 MC_print_statistics(mc_stats);
988 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
990 return simcall->mc_value;
994 int MC_random(int min, int max)
996 /*FIXME: return mc_current_state->executed_transition->random.value;*/
997 return simcall_mc_random(min, max);
1001 * \brief Schedules all the process that are ready to run
1003 void MC_wait_for_requests(void)
1005 smx_process_t process;
1009 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1010 SIMIX_process_runall();
1011 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1012 req = &process->simcall;
1013 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1014 SIMIX_simcall_pre(req, 0);
1019 int MC_deadlock_check()
1021 int deadlock = FALSE;
1022 smx_process_t process;
1023 if(xbt_swag_size(simix_global->process_list)){
1025 xbt_swag_foreach(process, simix_global->process_list){
1026 if(process->simcall.call != SIMCALL_NONE
1027 && MC_request_is_enabled(&process->simcall)){
1037 * \brief Re-executes from the state at position start all the transitions indicated by
1038 * a given model-checker stack.
1039 * \param stack The stack with the transitions to execute.
1040 * \param start Start index to begin the re-execution.
1042 void MC_replay(xbt_fifo_t stack, int start)
1044 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1046 int value, i = 1, count = 1;
1048 smx_simcall_t req = NULL, saved_req = NULL;
1049 xbt_fifo_item_t item, start_item;
1051 smx_process_t process = NULL;
1052 int comm_pattern = 0;
1054 XBT_DEBUG("**** Begin Replay ****");
1057 /* Restore the initial state */
1058 MC_restore_snapshot(initial_state_safety->snapshot);
1059 /* At the moment of taking the snapshot the raw heap was set, so restoring
1060 * it will set it back again, we have to unset it to continue */
1064 start_item = xbt_fifo_get_last_item(stack);
1067 start_item = xbt_fifo_get_prev_item(start_item);
1073 xbt_dict_reset(first_enabled_state);
1074 xbt_swag_foreach(process, simix_global->process_list){
1075 if(MC_process_is_enabled(process)){
1076 char *key = bprintf("%lu", process->pid);
1077 char *data = bprintf("%d", count);
1078 xbt_dict_set(first_enabled_state, key, data, NULL);
1082 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
1083 xbt_dynar_reset(communications_pattern);
1087 /* Traverse the stack from the state at position start and re-execute the transitions */
1088 for (item = start_item;
1089 item != xbt_fifo_get_first_item(stack);
1090 item = xbt_fifo_get_prev_item(item)) {
1092 state = (mc_state_t) xbt_fifo_get_item_content(item);
1093 saved_req = MC_state_get_executed_request(state, &value);
1096 char *key = bprintf("%lu", saved_req->issuer->pid);
1097 xbt_dict_remove(first_enabled_state, key);
1102 /* because we got a copy of the executed request, we have to fetch the
1103 real one, pointed by the request field of the issuer process */
1104 req = &saved_req->issuer->simcall;
1106 /* Debug information */
1107 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1108 req_str = MC_request_to_string(req, value);
1109 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1114 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1115 if(req->call == SIMCALL_COMM_ISEND)
1117 else if(req->call == SIMCALL_COMM_IRECV)
1121 SIMIX_simcall_pre(req, value);
1123 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1125 if(comm_pattern != 0){
1126 get_comm_pattern(communications_pattern, req, comm_pattern);
1132 MC_wait_for_requests();
1137 /* Insert in dict all enabled processes */
1138 xbt_swag_foreach(process, simix_global->process_list){
1139 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1140 char *key = bprintf("%lu", process->pid);
1141 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1142 char *data = bprintf("%d", count);
1143 xbt_dict_set(first_enabled_state, key, data, NULL);
1150 /* Update statistics */
1151 mc_stats->visited_states++;
1152 mc_stats->executed_transitions++;
1156 XBT_DEBUG("**** End Replay ****");
1166 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1169 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1173 smx_simcall_t req = NULL, saved_req = NULL;
1174 xbt_fifo_item_t item;
1179 XBT_DEBUG("**** Begin Replay ****");
1181 /* Restore the initial state */
1182 MC_restore_snapshot(initial_state_liveness->snapshot);
1184 /* At the moment of taking the snapshot the raw heap was set, so restoring
1185 * it will set it back again, we have to unset it to continue */
1186 if(!initial_state_liveness->raw_mem_set)
1191 item = xbt_fifo_get_last_item(stack);
1193 while(depth <= xbt_fifo_size(stack)){
1195 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1196 state = (mc_state_t) pair->graph_state;
1198 if(pair->requests > 0){
1200 saved_req = MC_state_get_executed_request(state, &value);
1201 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1203 if(saved_req != NULL){
1204 /* because we got a copy of the executed request, we have to fetch the
1205 real one, pointed by the request field of the issuer process */
1206 req = &saved_req->issuer->simcall;
1207 //XBT_DEBUG("Req->call %u", req->call);
1209 /* Debug information */
1210 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1211 req_str = MC_request_to_string(req, value);
1212 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1218 SIMIX_simcall_pre(req, value);
1219 MC_wait_for_requests();
1224 /* Update statistics */
1225 mc_stats->visited_pairs++;
1226 mc_stats->executed_transitions++;
1228 item = xbt_fifo_get_prev_item(item);
1233 /* Traverse the stack from the initial state and re-execute the transitions */
1234 for (item = xbt_fifo_get_last_item(stack);
1235 item != xbt_fifo_get_first_item(stack);
1236 item = xbt_fifo_get_prev_item(item)) {
1238 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1239 state = (mc_state_t) pair->graph_state;
1241 if(pair->requests > 0){
1243 saved_req = MC_state_get_executed_request(state, &value);
1244 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1246 if(saved_req != NULL){
1247 /* because we got a copy of the executed request, we have to fetch the
1248 real one, pointed by the request field of the issuer process */
1249 req = &saved_req->issuer->simcall;
1250 //XBT_DEBUG("Req->call %u", req->call);
1252 /* Debug information */
1253 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1254 req_str = MC_request_to_string(req, value);
1255 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1261 SIMIX_simcall_pre(req, value);
1262 MC_wait_for_requests();
1267 /* Update statistics */
1268 mc_stats->visited_pairs++;
1269 mc_stats->executed_transitions++;
1273 XBT_DEBUG("**** End Replay ****");
1275 if(initial_state_liveness->raw_mem_set)
1283 * \brief Dumps the contents of a model-checker's stack and shows the actual
1285 * \param stack The stack to dump
1287 void MC_dump_stack_safety(xbt_fifo_t stack)
1290 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1292 MC_show_stack_safety(stack);
1294 if(!_sg_mc_checkpoint){
1299 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1300 MC_state_delete(state);
1313 void MC_show_stack_safety(xbt_fifo_t stack)
1316 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1322 xbt_fifo_item_t item;
1324 char *req_str = NULL;
1326 for (item = xbt_fifo_get_last_item(stack);
1327 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1328 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1329 req = MC_state_get_executed_request(state, &value);
1331 req_str = MC_request_to_string(req, value);
1332 XBT_INFO("%s", req_str);
1341 void MC_show_deadlock(smx_simcall_t req)
1343 /*char *req_str = NULL;*/
1344 XBT_INFO("**************************");
1345 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1346 XBT_INFO("**************************");
1347 XBT_INFO("Locked request:");
1348 /*req_str = MC_request_to_string(req);
1349 XBT_INFO("%s", req_str);
1350 xbt_free(req_str);*/
1351 XBT_INFO("Counter-example execution trace:");
1352 MC_dump_stack_safety(mc_stack_safety);
1353 MC_print_statistics(mc_stats);
1357 void MC_show_stack_liveness(xbt_fifo_t stack){
1360 xbt_fifo_item_t item;
1362 char *req_str = NULL;
1364 for (item = xbt_fifo_get_last_item(stack);
1365 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1366 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1367 req = MC_state_get_executed_request(pair->graph_state, &value);
1369 if(pair->requests>0){
1370 req_str = MC_request_to_string(req, value);
1371 XBT_INFO("%s", req_str);
1374 XBT_INFO("End of system requests but evolution in Büchi automaton");
1380 void MC_dump_stack_liveness(xbt_fifo_t stack){
1382 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1387 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1388 MC_pair_delete(pair);
1397 void MC_print_statistics(mc_stats_t stats)
1399 if(stats->expanded_pairs == 0){
1400 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1401 XBT_INFO("Visited states = %lu", stats->visited_states);
1403 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1404 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1406 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1408 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1409 fprintf(dot_output, "}\n");
1412 if(initial_state_safety != NULL){
1413 if(_sg_mc_comms_determinism)
1414 XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1415 if (_sg_mc_send_determinism)
1416 XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1421 void MC_assert(int prop)
1423 if (MC_is_active() && !prop){
1424 XBT_INFO("**************************");
1425 XBT_INFO("*** PROPERTY NOT VALID ***");
1426 XBT_INFO("**************************");
1427 XBT_INFO("Counter-example execution trace:");
1428 MC_dump_stack_safety(mc_stack_safety);
1429 MC_print_statistics(mc_stats);
1435 user_max_depth_reached = 1;
1438 void MC_process_clock_add(smx_process_t process, double amount)
1440 mc_time[process->pid] += amount;
1443 double MC_process_clock_get(smx_process_t process)
1447 return mc_time[process->pid];
1455 void MC_automaton_load(const char *file){
1457 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1461 if (_mc_property_automaton == NULL)
1462 _mc_property_automaton = xbt_automaton_new();
1464 xbt_automaton_load(_mc_property_automaton,file);
1473 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1475 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1479 if (_mc_property_automaton == NULL)
1480 _mc_property_automaton = xbt_automaton_new();
1482 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);