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));
162 xbt_dynar_free(&(frame->scopes));
166 void dw_type_free(dw_type_t t){
168 xbt_free(t->dw_type_id);
169 xbt_dynar_free(&(t->members));
170 mc_dwarf_expression_clear(&t->location);
174 void dw_variable_free(dw_variable_t v){
177 xbt_free(v->type_origin);
179 if(v->locations.locations)
180 mc_dwarf_location_list_clear(&v->locations);
185 void dw_variable_free_voidp(void *t){
186 dw_variable_free((dw_variable_t) * (void **) t);
193 mc_object_info_t MC_new_object_info(void) {
194 mc_object_info_t res = xbt_new0(s_mc_object_info_t, 1);
195 res->subprograms = xbt_dict_new_homogeneous((void (*)(void*))mc_frame_free);
196 res->global_variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
197 res->types = xbt_dict_new_homogeneous((void (*)(void*))dw_type_free);
198 res->full_types_by_name = xbt_dict_new_homogeneous(NULL);
202 void MC_free_object_info(mc_object_info_t* info) {
203 xbt_free(&(*info)->file_name);
204 xbt_dict_free(&(*info)->subprograms);
205 xbt_dynar_free(&(*info)->global_variables);
206 xbt_dict_free(&(*info)->types);
207 xbt_dict_free(&(*info)->full_types_by_name);
209 xbt_dynar_free(&(*info)->functions_index);
215 void* MC_object_base_address(mc_object_info_t info) {
216 void* result = info->start_exec;
217 if(info->start_rw!=NULL && result > (void*) info->start_rw) result = info->start_rw;
218 if(info->start_ro!=NULL && result > (void*) info->start_ro) result = info->start_ro;
222 // ***** Functions index
224 static int MC_compare_frame_index_items(mc_function_index_item_t a, mc_function_index_item_t b) {
225 if(a->low_pc < b->low_pc)
227 else if(a->low_pc == b->low_pc)
233 static void MC_make_functions_index(mc_object_info_t info) {
234 xbt_dynar_t index = xbt_dynar_new(sizeof(s_mc_function_index_item_t), NULL);
236 // Populate the array:
237 dw_frame_t frame = NULL;
238 xbt_dict_cursor_t cursor;
240 xbt_dict_foreach(info->subprograms, cursor, key, frame) {
241 if(frame->low_pc==NULL)
243 s_mc_function_index_item_t entry;
244 entry.low_pc = frame->low_pc;
245 entry.high_pc = frame->high_pc;
246 entry.function = frame;
247 xbt_dynar_push(index, &entry);
250 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(index, 0);
252 // Sort the array by low_pc:
254 xbt_dynar_length(index),
255 sizeof(s_mc_function_index_item_t),
256 (int (*)(const void *, const void *))MC_compare_frame_index_items);
258 info->functions_index = index;
261 mc_object_info_t MC_ip_find_object_info(void* ip) {
263 for(i=0; i!=mc_object_infos_size; ++i) {
264 if(ip >= (void*)mc_object_infos[i]->start_exec && ip <= (void*)mc_object_infos[i]->end_exec) {
265 return mc_object_infos[i];
271 static dw_frame_t MC_find_function_by_ip_and_object(void* ip, mc_object_info_t info) {
272 xbt_dynar_t dynar = info->functions_index;
273 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(dynar, 0);
275 int j = xbt_dynar_length(dynar) - 1;
277 int k = i + ((j-i)/2);
278 if(ip < base[k].low_pc) {
280 } else if(ip >= base[k].high_pc) {
283 return base[k].function;
289 dw_frame_t MC_find_function_by_ip(void* ip) {
290 mc_object_info_t info = MC_ip_find_object_info(ip);
294 return MC_find_function_by_ip_and_object(ip, info);
297 static void MC_post_process_variables(mc_object_info_t info) {
299 dw_variable_t variable = NULL;
300 xbt_dynar_foreach(info->global_variables, cursor, variable) {
301 if(variable->type_origin) {
302 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
307 static void mc_post_process_scope(mc_object_info_t info, dw_frame_t scope) {
309 if(scope->tag == DW_TAG_inlined_subroutine) {
311 // Attach correct namespaced name in inlined subroutine:
312 char* key = bprintf("%" PRIx64, (uint64_t) scope->abstract_origin_id);
313 dw_frame_t abstract_origin = xbt_dict_get_or_null(info->subprograms, key);
314 xbt_assert(abstract_origin, "Could not lookup abstract origin %s", key);
316 scope->name = xbt_strdup(abstract_origin->name);
322 dw_variable_t variable = NULL;
323 xbt_dynar_foreach(scope->variables, cursor, variable) {
324 if(variable->type_origin) {
325 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
329 // Recursive post-processing of nested-scopes:
330 dw_frame_t nested_scope = NULL;
331 xbt_dynar_foreach(scope->scopes, cursor, nested_scope)
332 mc_post_process_scope(info, nested_scope);
336 static void MC_post_process_functions(mc_object_info_t info) {
337 xbt_dict_cursor_t cursor;
339 dw_frame_t subprogram = NULL;
340 xbt_dict_foreach(info->subprograms, cursor, key, subprogram) {
341 mc_post_process_scope(info, subprogram);
345 /** \brief Finds informations about a given shared object/executable */
346 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
347 mc_object_info_t result = MC_new_object_info();
349 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
350 result->file_name = xbt_strdup(name);
351 MC_find_object_address(maps, result);
352 MC_dwarf_get_variables(result);
353 MC_post_process_types(result);
354 MC_post_process_variables(result);
355 MC_post_process_functions(result);
356 MC_make_functions_index(result);
360 /*************************************************************************/
362 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
364 if(xbt_dynar_is_empty(variables))
367 unsigned int cursor = 0;
369 int end = xbt_dynar_length(variables) - 1;
370 dw_variable_t var_test = NULL;
373 cursor = (start + end) / 2;
374 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
375 if(strcmp(var_test->name, var) < 0){
377 }else if(strcmp(var_test->name, var) > 0){
380 if(address){ /* global variable */
381 if(var_test->address == address)
383 if(var_test->address > address)
387 }else{ /* local variable */
393 if(strcmp(var_test->name, var) == 0){
394 if(address && var_test->address < address)
398 }else if(strcmp(var_test->name, var) < 0)
405 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
406 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
408 xbt_dynar_insert_at(info->global_variables, index, &variable);
412 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
413 xbt_assert(frame, "Frame is NULL");
414 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
416 xbt_dynar_insert_at(frame->variables, index, &variable);
420 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
422 MC_dwarf_register_global_variable(info, variable);
424 xbt_die("No frame for this local variable");
426 MC_dwarf_register_non_global_variable(info, frame, variable);
430 /******************************* Ignore mechanism *******************************/
431 /*********************************************************************************/
433 xbt_dynar_t mc_checkpoint_ignore;
435 typedef struct s_mc_stack_ignore_variable{
438 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
440 /**************************** Free functions ******************************/
442 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
443 xbt_free(v->var_name);
448 static void stack_ignore_variable_free_voidp(void *v){
449 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
452 void heap_ignore_region_free(mc_heap_ignore_region_t r){
456 void heap_ignore_region_free_voidp(void *r){
457 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
460 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
464 static void checkpoint_ignore_region_free_voidp(void *r){
465 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
468 /***********************************************************************/
470 void MC_ignore_heap(void *address, size_t size){
472 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
476 mc_heap_ignore_region_t region = NULL;
477 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
478 region->address = address;
481 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
483 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
484 region->fragment = -1;
485 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
487 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
488 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
491 if(mc_heap_comparison_ignore == NULL){
492 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
493 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
499 unsigned int cursor = 0;
500 mc_heap_ignore_region_t current_region = NULL;
502 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
505 cursor = (start + end) / 2;
506 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
507 if(current_region->address == address){
508 heap_ignore_region_free(region);
512 }else if(current_region->address < address){
519 if(current_region->address < address)
520 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
522 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
528 void MC_remove_ignore_heap(void *address, size_t size){
530 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
534 unsigned int cursor = 0;
536 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
537 mc_heap_ignore_region_t region;
538 int ignore_found = 0;
541 cursor = (start + end) / 2;
542 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
543 if(region->address == address){
546 }else if(region->address < address){
549 if((char * )region->address <= ((char *)address + size)){
558 if(ignore_found == 1){
559 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
560 MC_remove_ignore_heap(address, size);
568 void MC_ignore_global_variable(const char *name){
570 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
574 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
576 unsigned int cursor = 0;
577 dw_variable_t current_var;
579 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
582 cursor = (start + end) /2;
583 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
584 if(strcmp(current_var->name, name) == 0){
585 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
587 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
588 }else if(strcmp(current_var->name, name) < 0){
599 static void mc_ignore_local_variable_in_scope(const char *var_name, dw_frame_t scope) {
600 // Processing of direct variables:
602 int end = xbt_dynar_length(scope->variables) - 1;
604 int cursor = (start + end) / 2;
605 dw_variable_t current_var = (dw_variable_t)xbt_dynar_get_as(scope->variables, cursor, dw_variable_t);
607 int compare = strcmp(current_var->name, var_name);
609 xbt_dynar_remove_at(scope->variables, cursor, NULL);
611 end = xbt_dynar_length(scope->variables) - 1;
612 }else if(compare < 0){
619 // And recursive processing in nested scopes:
621 dw_frame_t nested_scope = NULL;
622 xbt_dynar_foreach(scope->scopes, cursor, nested_scope) {
623 mc_ignore_local_variable_in_scope(var_name, nested_scope);
627 static void MC_ignore_local_variable_in_object(const char *var_name, const char *frame_name, mc_object_info_t info) {
628 xbt_dict_cursor_t cursor2;
631 xbt_dict_foreach(info->subprograms, cursor2, key, frame) {
632 if(frame_name && strcmp(frame_name, frame->name))
634 mc_ignore_local_variable_in_scope(var_name, frame);
638 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
640 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
642 if(strcmp(frame_name, "*") == 0)
647 MC_ignore_local_variable_in_object(var_name, frame_name, mc_libsimgrid_info);
649 MC_ignore_local_variable_in_object(var_name, frame_name, mc_binary_info);
656 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
658 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
662 if(stacks_areas == NULL)
663 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
665 stack_region_t region = NULL;
666 region = xbt_new0(s_stack_region_t, 1);
667 region->address = stack;
668 region->process_name = strdup(name);
669 region->context = context;
671 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
672 xbt_dynar_push(stacks_areas, ®ion);
678 void MC_ignore(void *addr, size_t size){
680 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
684 if(mc_checkpoint_ignore == NULL)
685 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
687 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
691 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
692 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
695 unsigned int cursor = 0;
697 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
698 mc_checkpoint_ignore_region_t current_region = NULL;
701 cursor = (start + end) / 2;
702 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
703 if(current_region->addr == addr){
704 if(current_region->size == size){
705 checkpoint_ignore_region_free(region);
709 }else if(current_region->size < size){
714 }else if(current_region->addr < addr){
721 if(current_region->addr == addr){
722 if(current_region->size < size){
723 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
725 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
727 }else if(current_region->addr < addr){
728 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
730 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
738 /******************************* Initialisation of MC *******************************/
739 /*********************************************************************************/
741 static void MC_post_process_object_info(mc_object_info_t info) {
742 xbt_dict_cursor_t cursor = NULL;
744 dw_type_t type = NULL;
745 xbt_dict_foreach(info->types, cursor, key, type){
747 // Resolve full_type:
748 if(type->name && type->byte_size == 0) {
749 for(size_t i=0; i!=mc_object_infos_size; ++i) {
750 dw_type_t same_type = xbt_dict_get_or_null(mc_object_infos[i]->full_types_by_name, type->name);
751 if(same_type && same_type->name && same_type->byte_size) {
752 type->full_type = same_type;
761 static void MC_init_debug_info(void) {
762 XBT_INFO("Get debug information ...");
764 memory_map_t maps = MC_get_memory_map();
766 /* Get local variables for state equality detection */
767 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
768 mc_object_infos[0] = mc_binary_info;
770 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
771 mc_object_infos[1] = mc_libsimgrid_info;
773 // Use information of the other objects:
774 MC_post_process_object_info(mc_binary_info);
775 MC_post_process_object_info(mc_libsimgrid_info);
777 MC_free_memory_map(maps);
778 XBT_INFO("Get debug information done !");
783 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
787 /* Initialize the data structures that must be persistent across every
788 iteration of the model-checker (in RAW memory) */
792 MC_init_memory_map_info();
793 MC_init_debug_info();
796 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
800 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
801 MC_ignore_local_variable("e", "*");
802 MC_ignore_local_variable("__ex_cleanup", "*");
803 MC_ignore_local_variable("__ex_mctx_en", "*");
804 MC_ignore_local_variable("__ex_mctx_me", "*");
805 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
806 MC_ignore_local_variable("_log_ev", "*");
807 MC_ignore_local_variable("_throw_ctx", "*");
808 MC_ignore_local_variable("ctx", "*");
810 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
811 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
812 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
814 /* Ignore local variable about time used for tracing */
815 MC_ignore_local_variable("start_time", "*");
817 MC_ignore_global_variable("compared_pointers");
818 MC_ignore_global_variable("mc_comp_times");
819 MC_ignore_global_variable("mc_snapshot_comparison_time");
820 MC_ignore_global_variable("mc_time");
821 MC_ignore_global_variable("smpi_current_rank");
822 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
823 MC_ignore_global_variable("maestro_stack_start");
824 MC_ignore_global_variable("maestro_stack_end");
825 MC_ignore_global_variable("smx_total_comms");
827 MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
828 MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
829 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
830 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
832 smx_process_t process;
833 xbt_swag_foreach(process, simix_global->process_list){
834 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
842 static void MC_init_dot_output(){ /* FIXME : more colors */
846 colors[2] = "green3";
847 colors[3] = "goldenrod";
849 colors[5] = "purple";
850 colors[6] = "magenta";
851 colors[7] = "turquoise4";
852 colors[8] = "gray25";
853 colors[9] = "forestgreen";
854 colors[10] = "hotpink";
855 colors[11] = "lightblue";
858 dot_output = fopen(_sg_mc_dot_output_file, "w");
860 if(dot_output == NULL){
861 perror("Error open dot output file");
865 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");
869 /******************************* Core of MC *******************************/
870 /**************************************************************************/
872 void MC_do_the_modelcheck_for_real() {
875 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
878 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
879 if (mc_reduce_kind==e_mc_reduce_unset)
880 mc_reduce_kind=e_mc_reduce_dpor;
882 XBT_INFO("Check a safety property");
883 MC_modelcheck_safety();
887 if (mc_reduce_kind==e_mc_reduce_unset)
888 mc_reduce_kind=e_mc_reduce_none;
890 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
891 MC_automaton_load(_sg_mc_property_file);
892 MC_modelcheck_liveness();
896 void MC_modelcheck_safety(void)
898 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
900 /* Check if MC is already initialized */
901 if (initial_state_safety)
904 mc_time = xbt_new0(double, simix_process_maxpid);
906 /* mc_time refers to clock for each process -> ignore it for heap comparison */
907 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
909 /* Initialize the data structures that must be persistent across every
910 iteration of the model-checker (in RAW memory) */
914 /* Initialize statistics */
915 mc_stats = xbt_new0(s_mc_stats_t, 1);
916 mc_stats->state_size = 1;
918 /* Create exploration stack */
919 mc_stack_safety = xbt_fifo_new();
921 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
922 MC_init_dot_output();
926 if(_sg_mc_visited > 0){
930 MC_init_memory_map_info();
931 MC_init_debug_info();
938 /* Save the initial state */
939 initial_state_safety = xbt_new0(s_mc_global_t, 1);
940 initial_state_safety->snapshot = MC_take_snapshot(0);
941 initial_state_safety->initial_communications_pattern_done = 0;
942 initial_state_safety->comm_deterministic = 1;
943 initial_state_safety->send_deterministic = 1;
955 void MC_modelcheck_liveness(){
957 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
961 mc_time = xbt_new0(double, simix_process_maxpid);
963 /* mc_time refers to clock for each process -> ignore it for heap comparison */
964 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
968 /* Initialize statistics */
969 mc_stats = xbt_new0(s_mc_stats_t, 1);
970 mc_stats->state_size = 1;
972 /* Create exploration stack */
973 mc_stack_liveness = xbt_fifo_new();
975 /* Create the initial state */
976 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
978 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
979 MC_init_dot_output();
986 MC_print_statistics(mc_stats);
1003 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
1005 return simcall->mc_value;
1009 int MC_random(int min, int max)
1011 /*FIXME: return mc_current_state->executed_transition->random.value;*/
1012 return simcall_mc_random(min, max);
1016 * \brief Schedules all the process that are ready to run
1018 void MC_wait_for_requests(void)
1020 smx_process_t process;
1024 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1025 SIMIX_process_runall();
1026 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1027 req = &process->simcall;
1028 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1029 SIMIX_simcall_pre(req, 0);
1034 int MC_deadlock_check()
1036 int deadlock = FALSE;
1037 smx_process_t process;
1038 if(xbt_swag_size(simix_global->process_list)){
1040 xbt_swag_foreach(process, simix_global->process_list){
1041 if(process->simcall.call != SIMCALL_NONE
1042 && MC_request_is_enabled(&process->simcall)){
1052 * \brief Re-executes from the state at position start all the transitions indicated by
1053 * a given model-checker stack.
1054 * \param stack The stack with the transitions to execute.
1055 * \param start Start index to begin the re-execution.
1057 void MC_replay(xbt_fifo_t stack, int start)
1059 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1061 int value, i = 1, count = 1;
1063 smx_simcall_t req = NULL, saved_req = NULL;
1064 xbt_fifo_item_t item, start_item;
1066 smx_process_t process = NULL;
1067 int comm_pattern = 0;
1069 XBT_DEBUG("**** Begin Replay ****");
1072 /* Restore the initial state */
1073 MC_restore_snapshot(initial_state_safety->snapshot);
1074 /* At the moment of taking the snapshot the raw heap was set, so restoring
1075 * it will set it back again, we have to unset it to continue */
1079 start_item = xbt_fifo_get_last_item(stack);
1082 start_item = xbt_fifo_get_prev_item(start_item);
1088 xbt_dict_reset(first_enabled_state);
1089 xbt_swag_foreach(process, simix_global->process_list){
1090 if(MC_process_is_enabled(process)){
1091 char *key = bprintf("%lu", process->pid);
1092 char *data = bprintf("%d", count);
1093 xbt_dict_set(first_enabled_state, key, data, NULL);
1097 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
1098 xbt_dynar_reset(communications_pattern);
1102 /* Traverse the stack from the state at position start and re-execute the transitions */
1103 for (item = start_item;
1104 item != xbt_fifo_get_first_item(stack);
1105 item = xbt_fifo_get_prev_item(item)) {
1107 state = (mc_state_t) xbt_fifo_get_item_content(item);
1108 saved_req = MC_state_get_executed_request(state, &value);
1111 char *key = bprintf("%lu", saved_req->issuer->pid);
1112 xbt_dict_remove(first_enabled_state, key);
1117 /* because we got a copy of the executed request, we have to fetch the
1118 real one, pointed by the request field of the issuer process */
1119 req = &saved_req->issuer->simcall;
1121 /* Debug information */
1122 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1123 req_str = MC_request_to_string(req, value);
1124 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1129 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1130 if(req->call == SIMCALL_COMM_ISEND)
1132 else if(req->call == SIMCALL_COMM_IRECV)
1136 SIMIX_simcall_pre(req, value);
1138 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1140 if(comm_pattern != 0){
1141 get_comm_pattern(communications_pattern, req, comm_pattern);
1147 MC_wait_for_requests();
1152 /* Insert in dict all enabled processes */
1153 xbt_swag_foreach(process, simix_global->process_list){
1154 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1155 char *key = bprintf("%lu", process->pid);
1156 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1157 char *data = bprintf("%d", count);
1158 xbt_dict_set(first_enabled_state, key, data, NULL);
1165 /* Update statistics */
1166 mc_stats->visited_states++;
1167 mc_stats->executed_transitions++;
1171 XBT_DEBUG("**** End Replay ****");
1181 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1184 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1188 smx_simcall_t req = NULL, saved_req = NULL;
1189 xbt_fifo_item_t item;
1194 XBT_DEBUG("**** Begin Replay ****");
1196 /* Restore the initial state */
1197 MC_restore_snapshot(initial_state_liveness->snapshot);
1199 /* At the moment of taking the snapshot the raw heap was set, so restoring
1200 * it will set it back again, we have to unset it to continue */
1201 if(!initial_state_liveness->raw_mem_set)
1206 item = xbt_fifo_get_last_item(stack);
1208 while(depth <= xbt_fifo_size(stack)){
1210 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1211 state = (mc_state_t) pair->graph_state;
1213 if(pair->requests > 0){
1215 saved_req = MC_state_get_executed_request(state, &value);
1216 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1218 if(saved_req != NULL){
1219 /* because we got a copy of the executed request, we have to fetch the
1220 real one, pointed by the request field of the issuer process */
1221 req = &saved_req->issuer->simcall;
1222 //XBT_DEBUG("Req->call %u", req->call);
1224 /* Debug information */
1225 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1226 req_str = MC_request_to_string(req, value);
1227 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1233 SIMIX_simcall_pre(req, value);
1234 MC_wait_for_requests();
1239 /* Update statistics */
1240 mc_stats->visited_pairs++;
1241 mc_stats->executed_transitions++;
1243 item = xbt_fifo_get_prev_item(item);
1248 /* Traverse the stack from the initial state and re-execute the transitions */
1249 for (item = xbt_fifo_get_last_item(stack);
1250 item != xbt_fifo_get_first_item(stack);
1251 item = xbt_fifo_get_prev_item(item)) {
1253 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1254 state = (mc_state_t) pair->graph_state;
1256 if(pair->requests > 0){
1258 saved_req = MC_state_get_executed_request(state, &value);
1259 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1261 if(saved_req != NULL){
1262 /* because we got a copy of the executed request, we have to fetch the
1263 real one, pointed by the request field of the issuer process */
1264 req = &saved_req->issuer->simcall;
1265 //XBT_DEBUG("Req->call %u", req->call);
1267 /* Debug information */
1268 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1269 req_str = MC_request_to_string(req, value);
1270 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1276 SIMIX_simcall_pre(req, value);
1277 MC_wait_for_requests();
1282 /* Update statistics */
1283 mc_stats->visited_pairs++;
1284 mc_stats->executed_transitions++;
1288 XBT_DEBUG("**** End Replay ****");
1290 if(initial_state_liveness->raw_mem_set)
1298 * \brief Dumps the contents of a model-checker's stack and shows the actual
1300 * \param stack The stack to dump
1302 void MC_dump_stack_safety(xbt_fifo_t stack)
1305 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1307 MC_show_stack_safety(stack);
1309 if(!_sg_mc_checkpoint){
1314 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1315 MC_state_delete(state);
1328 void MC_show_stack_safety(xbt_fifo_t stack)
1331 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1337 xbt_fifo_item_t item;
1339 char *req_str = NULL;
1341 for (item = xbt_fifo_get_last_item(stack);
1342 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1343 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1344 req = MC_state_get_executed_request(state, &value);
1346 req_str = MC_request_to_string(req, value);
1347 XBT_INFO("%s", req_str);
1356 void MC_show_deadlock(smx_simcall_t req)
1358 /*char *req_str = NULL;*/
1359 XBT_INFO("**************************");
1360 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1361 XBT_INFO("**************************");
1362 XBT_INFO("Locked request:");
1363 /*req_str = MC_request_to_string(req);
1364 XBT_INFO("%s", req_str);
1365 xbt_free(req_str);*/
1366 XBT_INFO("Counter-example execution trace:");
1367 MC_dump_stack_safety(mc_stack_safety);
1368 MC_print_statistics(mc_stats);
1372 void MC_show_stack_liveness(xbt_fifo_t stack){
1375 xbt_fifo_item_t item;
1377 char *req_str = NULL;
1379 for (item = xbt_fifo_get_last_item(stack);
1380 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1381 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1382 req = MC_state_get_executed_request(pair->graph_state, &value);
1384 if(pair->requests>0){
1385 req_str = MC_request_to_string(req, value);
1386 XBT_INFO("%s", req_str);
1389 XBT_INFO("End of system requests but evolution in Büchi automaton");
1395 void MC_dump_stack_liveness(xbt_fifo_t stack){
1397 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1402 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1403 MC_pair_delete(pair);
1412 void MC_print_statistics(mc_stats_t stats)
1414 if(stats->expanded_pairs == 0){
1415 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1416 XBT_INFO("Visited states = %lu", stats->visited_states);
1418 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1419 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1421 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1423 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1424 fprintf(dot_output, "}\n");
1427 if(initial_state_safety != NULL){
1428 if(_sg_mc_comms_determinism)
1429 XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1430 if (_sg_mc_send_determinism)
1431 XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1436 void MC_assert(int prop)
1438 if (MC_is_active() && !prop){
1439 XBT_INFO("**************************");
1440 XBT_INFO("*** PROPERTY NOT VALID ***");
1441 XBT_INFO("**************************");
1442 XBT_INFO("Counter-example execution trace:");
1443 MC_dump_stack_safety(mc_stack_safety);
1444 MC_print_statistics(mc_stats);
1450 user_max_depth_reached = 1;
1453 void MC_process_clock_add(smx_process_t process, double amount)
1455 mc_time[process->pid] += amount;
1458 double MC_process_clock_get(smx_process_t process)
1462 return mc_time[process->pid];
1470 void MC_automaton_load(const char *file){
1472 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1476 if (_mc_property_automaton == NULL)
1477 _mc_property_automaton = xbt_automaton_new();
1479 xbt_automaton_load(_mc_property_automaton,file);
1488 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1490 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1494 if (_mc_property_automaton == NULL)
1495 _mc_property_automaton = xbt_automaton_new();
1497 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);