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));
162 static void dw_type_free_voidp(void *t){
163 dw_type_free((dw_type_t) * (void **) t);
166 void dw_variable_free(dw_variable_t v){
169 xbt_free(v->type_origin);
171 if(v->locations.locations)
172 mc_dwarf_location_list_clear(&v->locations);
177 void dw_variable_free_voidp(void *t){
178 dw_variable_free((dw_variable_t) * (void **) t);
183 mc_object_info_t MC_new_object_info(void) {
184 mc_object_info_t res = xbt_new0(s_mc_object_info_t, 1);
185 res->subprograms = xbt_dynar_new(sizeof(dw_frame_t), NULL);
186 res->global_variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
187 res->types = xbt_dict_new_homogeneous(NULL);
188 res->types_by_name = xbt_dict_new_homogeneous(NULL);
192 void MC_free_object_info(mc_object_info_t* info) {
193 xbt_free(&(*info)->file_name);
194 xbt_dynar_free(&(*info)->subprograms);
195 xbt_dynar_free(&(*info)->global_variables);
196 xbt_dict_free(&(*info)->types);
197 xbt_dict_free(&(*info)->types_by_name);
199 xbt_dynar_free(&(*info)->functions_index);
205 void* MC_object_base_address(mc_object_info_t info) {
206 void* result = info->start_exec;
207 if(info->start_rw!=NULL && result > (void*) info->start_rw) result = info->start_rw;
208 if(info->start_ro!=NULL && result > (void*) info->start_ro) result = info->start_ro;
212 // ***** Functions index
214 static int MC_compare_frame_index_items(mc_function_index_item_t a, mc_function_index_item_t b) {
215 if(a->low_pc < b->low_pc)
217 else if(a->low_pc == b->low_pc)
223 static void MC_make_functions_index(mc_object_info_t info) {
224 xbt_dynar_t index = xbt_dynar_new(sizeof(s_mc_function_index_item_t), NULL);
226 // Populate the array:
227 dw_frame_t frame = NULL;
229 xbt_dynar_foreach(info->subprograms, cursor, frame) {
230 if(frame->low_pc==NULL)
232 s_mc_function_index_item_t entry;
233 entry.low_pc = frame->low_pc;
234 entry.high_pc = frame->high_pc;
235 entry.function = frame;
236 xbt_dynar_push(index, &entry);
239 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(index, 0);
241 // Sort the array by low_pc:
243 xbt_dynar_length(index),
244 sizeof(s_mc_function_index_item_t),
245 (int (*)(const void *, const void *))MC_compare_frame_index_items);
247 info->functions_index = index;
250 mc_object_info_t MC_ip_find_object_info(void* ip) {
251 mc_object_info_t infos[2] = { mc_binary_info, mc_libsimgrid_info };
254 for(i=0; i!=n; ++i) {
255 if(ip >= (void*)infos[i]->start_exec && ip <= (void*)infos[i]->end_exec) {
262 static dw_frame_t MC_find_function_by_ip_and_object(void* ip, mc_object_info_t info) {
263 xbt_dynar_t dynar = info->functions_index;
264 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(dynar, 0);
266 int j = xbt_dynar_length(dynar) - 1;
268 int k = i + ((j-i)/2);
269 if(ip < base[k].low_pc) {
271 } else if(ip > base[k].high_pc) {
274 return base[k].function;
280 dw_frame_t MC_find_function_by_ip(void* ip) {
281 mc_object_info_t info = MC_ip_find_object_info(ip);
285 return MC_find_function_by_ip_and_object(ip, info);
288 static void MC_post_process_variables(mc_object_info_t info) {
290 dw_variable_t variable = NULL;
291 xbt_dynar_foreach(info->global_variables, cursor, variable) {
292 if(variable->type_origin) {
293 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
298 static void MC_post_process_functions(mc_object_info_t info) {
300 dw_frame_t function = NULL;
301 xbt_dynar_foreach(info->subprograms, cursor, function) {
302 unsigned cursor2 = 0;
303 dw_variable_t variable = NULL;
304 xbt_dynar_foreach(function->variables, cursor2, variable) {
305 if(variable->type_origin) {
306 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
312 /** \brief Finds informations about a given shared object/executable */
313 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
314 mc_object_info_t result = MC_new_object_info();
316 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
317 result->file_name = xbt_strdup(name);
318 MC_find_object_address(maps, result);
319 MC_dwarf_get_variables(result);
320 MC_post_process_types(result);
321 MC_post_process_variables(result);
322 MC_post_process_functions(result);
323 MC_make_functions_index(result);
327 /*************************************************************************/
329 /** \brief Finds a frame (DW_TAG_subprogram) from an DWARF offset in the rangd of this subprogram
331 * The offset can be an offset of a child DW_TAG_variable.
333 static dw_frame_t MC_dwarf_get_frame_by_offset(xbt_dict_t all_variables, unsigned long int offset){
335 xbt_dict_cursor_t cursor = NULL;
339 xbt_dict_foreach(all_variables, cursor, name, res) {
340 if(offset >= res->start && offset < res->end){
341 xbt_dict_cursor_free(&cursor);
346 xbt_dict_cursor_free(&cursor);
351 static dw_variable_t MC_dwarf_get_variable_by_name(dw_frame_t frame, char *var){
353 unsigned int cursor = 0;
354 dw_variable_t current_var;
356 xbt_dynar_foreach(frame->variables, cursor, current_var){
357 if(strcmp(var, current_var->name) == 0)
364 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
366 if(xbt_dynar_is_empty(variables))
369 unsigned int cursor = 0;
371 int end = xbt_dynar_length(variables) - 1;
372 dw_variable_t var_test = NULL;
375 cursor = (start + end) / 2;
376 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
377 if(strcmp(var_test->name, var) < 0){
379 }else if(strcmp(var_test->name, var) > 0){
382 if(address){ /* global variable */
383 if(var_test->address == address)
385 if(var_test->address > address)
389 }else{ /* local variable */
395 if(strcmp(var_test->name, var) == 0){
396 if(address && var_test->address < address)
400 }else if(strcmp(var_test->name, var) < 0)
407 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
408 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
410 xbt_dynar_insert_at(info->global_variables, index, &variable);
414 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
415 xbt_assert(frame, "Frame is NULL");
416 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
418 xbt_dynar_insert_at(frame->variables, index, &variable);
422 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
424 MC_dwarf_register_global_variable(info, variable);
426 xbt_die("No frame for this local variable");
428 MC_dwarf_register_non_global_variable(info, frame, variable);
432 /******************************* Ignore mechanism *******************************/
433 /*********************************************************************************/
435 xbt_dynar_t mc_checkpoint_ignore;
437 typedef struct s_mc_stack_ignore_variable{
440 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
442 /**************************** Free functions ******************************/
444 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
445 xbt_free(v->var_name);
450 static void stack_ignore_variable_free_voidp(void *v){
451 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
454 void heap_ignore_region_free(mc_heap_ignore_region_t r){
458 void heap_ignore_region_free_voidp(void *r){
459 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
462 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
466 static void checkpoint_ignore_region_free_voidp(void *r){
467 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
470 /***********************************************************************/
472 void MC_ignore_heap(void *address, size_t size){
474 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
478 mc_heap_ignore_region_t region = NULL;
479 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
480 region->address = address;
483 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
485 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
486 region->fragment = -1;
487 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
489 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
490 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
493 if(mc_heap_comparison_ignore == NULL){
494 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
495 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
501 unsigned int cursor = 0;
502 mc_heap_ignore_region_t current_region = NULL;
504 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
507 cursor = (start + end) / 2;
508 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
509 if(current_region->address == address){
510 heap_ignore_region_free(region);
514 }else if(current_region->address < address){
521 if(current_region->address < address)
522 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
524 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
530 void MC_remove_ignore_heap(void *address, size_t size){
532 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
536 unsigned int cursor = 0;
538 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
539 mc_heap_ignore_region_t region;
540 int ignore_found = 0;
543 cursor = (start + end) / 2;
544 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
545 if(region->address == address){
548 }else if(region->address < address){
551 if((char * )region->address <= ((char *)address + size)){
560 if(ignore_found == 1){
561 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
562 MC_remove_ignore_heap(address, size);
570 void MC_ignore_global_variable(const char *name){
572 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
576 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
578 unsigned int cursor = 0;
579 dw_variable_t current_var;
581 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
584 cursor = (start + end) /2;
585 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
586 if(strcmp(current_var->name, name) == 0){
587 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
589 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
590 }else if(strcmp(current_var->name, name) < 0){
601 static void MC_ignore_local_variable_in_object(const char *var_name, const char *frame_name, mc_object_info_t info) {
606 dw_variable_t current_var;
608 xbt_dynar_foreach(info->subprograms, cursor2, frame) {
610 if(frame_name && strcmp(frame_name, frame->name))
614 end = xbt_dynar_length(frame->variables) - 1;
616 cursor = (start + end) / 2;
617 current_var = (dw_variable_t)xbt_dynar_get_as(frame->variables, cursor, dw_variable_t);
619 int compare = strcmp(current_var->name, var_name);
621 xbt_dynar_remove_at(frame->variables, cursor, NULL);
623 end = xbt_dynar_length(frame->variables) - 1;
624 }else if(compare < 0){
633 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
635 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
637 if(strcmp(frame_name, "*") == 0)
642 MC_ignore_local_variable_in_object(var_name, frame_name, mc_libsimgrid_info);
644 MC_ignore_local_variable_in_object(var_name, frame_name, mc_binary_info);
651 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
653 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
657 if(stacks_areas == NULL)
658 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
660 stack_region_t region = NULL;
661 region = xbt_new0(s_stack_region_t, 1);
662 region->address = stack;
663 region->process_name = strdup(name);
664 region->context = context;
666 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
667 xbt_dynar_push(stacks_areas, ®ion);
673 void MC_ignore(void *addr, size_t size){
675 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
679 if(mc_checkpoint_ignore == NULL)
680 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
682 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
686 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
687 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
690 unsigned int cursor = 0;
692 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
693 mc_checkpoint_ignore_region_t current_region = NULL;
696 cursor = (start + end) / 2;
697 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
698 if(current_region->addr == addr){
699 if(current_region->size == size){
700 checkpoint_ignore_region_free(region);
704 }else if(current_region->size < size){
709 }else if(current_region->addr < addr){
716 if(current_region->addr == addr){
717 if(current_region->size < size){
718 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
720 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
722 }else if(current_region->addr < addr){
723 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
725 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
733 /******************************* Initialisation of MC *******************************/
734 /*********************************************************************************/
736 static void MC_post_process_object_info(mc_object_info_t info) {
737 mc_object_info_t other_info = info == mc_binary_info ? mc_libsimgrid_info : mc_binary_info;
738 xbt_dict_cursor_t cursor = NULL;
740 dw_type_t type = NULL;
741 xbt_dict_foreach(info->types, cursor, key, type){
742 if(type->name && type->byte_size == 0) {
743 type->other_object_same_type = xbt_dict_get_or_null(other_info->types_by_name, type->name);
748 static void MC_init_debug_info(void) {
749 XBT_INFO("Get debug information ...");
751 memory_map_t maps = MC_get_memory_map();
753 /* Get local variables for state equality detection */
754 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
755 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
757 // Use information of the other objects:
758 MC_post_process_object_info(mc_binary_info);
759 MC_post_process_object_info(mc_libsimgrid_info);
761 MC_free_memory_map(maps);
762 XBT_INFO("Get debug information done !");
767 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
771 /* Initialize the data structures that must be persistent across every
772 iteration of the model-checker (in RAW memory) */
776 MC_init_memory_map_info();
777 MC_init_debug_info();
780 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
784 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
785 MC_ignore_local_variable("e", "*");
786 MC_ignore_local_variable("__ex_cleanup", "*");
787 MC_ignore_local_variable("__ex_mctx_en", "*");
788 MC_ignore_local_variable("__ex_mctx_me", "*");
789 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
790 MC_ignore_local_variable("_log_ev", "*");
791 MC_ignore_local_variable("_throw_ctx", "*");
792 MC_ignore_local_variable("ctx", "*");
794 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
795 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
796 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
798 /* Ignore local variable about time used for tracing */
799 MC_ignore_local_variable("start_time", "*");
801 MC_ignore_global_variable("compared_pointers");
802 MC_ignore_global_variable("mc_comp_times");
803 MC_ignore_global_variable("mc_snapshot_comparison_time");
804 MC_ignore_global_variable("mc_time");
805 MC_ignore_global_variable("smpi_current_rank");
806 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
807 MC_ignore_global_variable("maestro_stack_start");
808 MC_ignore_global_variable("maestro_stack_end");
809 MC_ignore_global_variable("smx_total_comms");
811 MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
812 MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
813 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
814 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
816 smx_process_t process;
817 xbt_swag_foreach(process, simix_global->process_list){
818 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
826 static void MC_init_dot_output(){ /* FIXME : more colors */
830 colors[2] = "green3";
831 colors[3] = "goldenrod";
833 colors[5] = "purple";
834 colors[6] = "magenta";
835 colors[7] = "turquoise4";
836 colors[8] = "gray25";
837 colors[9] = "forestgreen";
838 colors[10] = "hotpink";
839 colors[11] = "lightblue";
842 dot_output = fopen(_sg_mc_dot_output_file, "w");
844 if(dot_output == NULL){
845 perror("Error open dot output file");
849 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");
853 /******************************* Core of MC *******************************/
854 /**************************************************************************/
856 void MC_do_the_modelcheck_for_real() {
859 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
862 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
863 if (mc_reduce_kind==e_mc_reduce_unset)
864 mc_reduce_kind=e_mc_reduce_dpor;
866 XBT_INFO("Check a safety property");
867 MC_modelcheck_safety();
871 if (mc_reduce_kind==e_mc_reduce_unset)
872 mc_reduce_kind=e_mc_reduce_none;
874 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
875 MC_automaton_load(_sg_mc_property_file);
876 MC_modelcheck_liveness();
880 void MC_modelcheck_safety(void)
882 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
884 /* Check if MC is already initialized */
885 if (initial_state_safety)
888 mc_time = xbt_new0(double, simix_process_maxpid);
890 /* mc_time refers to clock for each process -> ignore it for heap comparison */
891 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
893 /* Initialize the data structures that must be persistent across every
894 iteration of the model-checker (in RAW memory) */
898 /* Initialize statistics */
899 mc_stats = xbt_new0(s_mc_stats_t, 1);
900 mc_stats->state_size = 1;
902 /* Create exploration stack */
903 mc_stack_safety = xbt_fifo_new();
905 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
906 MC_init_dot_output();
910 if(_sg_mc_visited > 0){
914 MC_init_memory_map_info();
915 MC_init_debug_info();
922 /* Save the initial state */
923 initial_state_safety = xbt_new0(s_mc_global_t, 1);
924 initial_state_safety->snapshot = MC_take_snapshot(0);
925 initial_state_safety->initial_communications_pattern_done = 0;
926 initial_state_safety->comm_deterministic = 1;
927 initial_state_safety->send_deterministic = 1;
939 void MC_modelcheck_liveness(){
941 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
945 mc_time = xbt_new0(double, simix_process_maxpid);
947 /* mc_time refers to clock for each process -> ignore it for heap comparison */
948 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
952 /* Initialize statistics */
953 mc_stats = xbt_new0(s_mc_stats_t, 1);
954 mc_stats->state_size = 1;
956 /* Create exploration stack */
957 mc_stack_liveness = xbt_fifo_new();
959 /* Create the initial state */
960 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
962 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
963 MC_init_dot_output();
970 MC_print_statistics(mc_stats);
987 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
989 return simcall->mc_value;
993 int MC_random(int min, int max)
995 /*FIXME: return mc_current_state->executed_transition->random.value;*/
996 return simcall_mc_random(min, max);
1000 * \brief Schedules all the process that are ready to run
1002 void MC_wait_for_requests(void)
1004 smx_process_t process;
1008 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1009 SIMIX_process_runall();
1010 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1011 req = &process->simcall;
1012 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1013 SIMIX_simcall_pre(req, 0);
1018 int MC_deadlock_check()
1020 int deadlock = FALSE;
1021 smx_process_t process;
1022 if(xbt_swag_size(simix_global->process_list)){
1024 xbt_swag_foreach(process, simix_global->process_list){
1025 if(process->simcall.call != SIMCALL_NONE
1026 && MC_request_is_enabled(&process->simcall)){
1036 * \brief Re-executes from the state at position start all the transitions indicated by
1037 * a given model-checker stack.
1038 * \param stack The stack with the transitions to execute.
1039 * \param start Start index to begin the re-execution.
1041 void MC_replay(xbt_fifo_t stack, int start)
1043 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1045 int value, i = 1, count = 1;
1047 smx_simcall_t req = NULL, saved_req = NULL;
1048 xbt_fifo_item_t item, start_item;
1050 smx_process_t process = NULL;
1051 int comm_pattern = 0;
1053 XBT_DEBUG("**** Begin Replay ****");
1056 /* Restore the initial state */
1057 MC_restore_snapshot(initial_state_safety->snapshot);
1058 /* At the moment of taking the snapshot the raw heap was set, so restoring
1059 * it will set it back again, we have to unset it to continue */
1063 start_item = xbt_fifo_get_last_item(stack);
1066 start_item = xbt_fifo_get_prev_item(start_item);
1072 xbt_dict_reset(first_enabled_state);
1073 xbt_swag_foreach(process, simix_global->process_list){
1074 if(MC_process_is_enabled(process)){
1075 char *key = bprintf("%lu", process->pid);
1076 char *data = bprintf("%d", count);
1077 xbt_dict_set(first_enabled_state, key, data, NULL);
1081 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
1082 xbt_dynar_reset(communications_pattern);
1086 /* Traverse the stack from the state at position start and re-execute the transitions */
1087 for (item = start_item;
1088 item != xbt_fifo_get_first_item(stack);
1089 item = xbt_fifo_get_prev_item(item)) {
1091 state = (mc_state_t) xbt_fifo_get_item_content(item);
1092 saved_req = MC_state_get_executed_request(state, &value);
1095 char *key = bprintf("%lu", saved_req->issuer->pid);
1096 xbt_dict_remove(first_enabled_state, key);
1101 /* because we got a copy of the executed request, we have to fetch the
1102 real one, pointed by the request field of the issuer process */
1103 req = &saved_req->issuer->simcall;
1105 /* Debug information */
1106 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1107 req_str = MC_request_to_string(req, value);
1108 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1113 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1114 if(req->call == SIMCALL_COMM_ISEND)
1116 else if(req->call == SIMCALL_COMM_IRECV)
1120 SIMIX_simcall_pre(req, value);
1122 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1124 if(comm_pattern != 0){
1125 get_comm_pattern(communications_pattern, req, comm_pattern);
1131 MC_wait_for_requests();
1136 /* Insert in dict all enabled processes */
1137 xbt_swag_foreach(process, simix_global->process_list){
1138 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1139 char *key = bprintf("%lu", process->pid);
1140 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1141 char *data = bprintf("%d", count);
1142 xbt_dict_set(first_enabled_state, key, data, NULL);
1149 /* Update statistics */
1150 mc_stats->visited_states++;
1151 mc_stats->executed_transitions++;
1155 XBT_DEBUG("**** End Replay ****");
1165 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1168 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1172 smx_simcall_t req = NULL, saved_req = NULL;
1173 xbt_fifo_item_t item;
1178 XBT_DEBUG("**** Begin Replay ****");
1180 /* Restore the initial state */
1181 MC_restore_snapshot(initial_state_liveness->snapshot);
1183 /* At the moment of taking the snapshot the raw heap was set, so restoring
1184 * it will set it back again, we have to unset it to continue */
1185 if(!initial_state_liveness->raw_mem_set)
1190 item = xbt_fifo_get_last_item(stack);
1192 while(depth <= xbt_fifo_size(stack)){
1194 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1195 state = (mc_state_t) pair->graph_state;
1197 if(pair->requests > 0){
1199 saved_req = MC_state_get_executed_request(state, &value);
1200 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1202 if(saved_req != NULL){
1203 /* because we got a copy of the executed request, we have to fetch the
1204 real one, pointed by the request field of the issuer process */
1205 req = &saved_req->issuer->simcall;
1206 //XBT_DEBUG("Req->call %u", req->call);
1208 /* Debug information */
1209 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1210 req_str = MC_request_to_string(req, value);
1211 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1217 SIMIX_simcall_pre(req, value);
1218 MC_wait_for_requests();
1223 /* Update statistics */
1224 mc_stats->visited_pairs++;
1225 mc_stats->executed_transitions++;
1227 item = xbt_fifo_get_prev_item(item);
1232 /* Traverse the stack from the initial state and re-execute the transitions */
1233 for (item = xbt_fifo_get_last_item(stack);
1234 item != xbt_fifo_get_first_item(stack);
1235 item = xbt_fifo_get_prev_item(item)) {
1237 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1238 state = (mc_state_t) pair->graph_state;
1240 if(pair->requests > 0){
1242 saved_req = MC_state_get_executed_request(state, &value);
1243 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1245 if(saved_req != NULL){
1246 /* because we got a copy of the executed request, we have to fetch the
1247 real one, pointed by the request field of the issuer process */
1248 req = &saved_req->issuer->simcall;
1249 //XBT_DEBUG("Req->call %u", req->call);
1251 /* Debug information */
1252 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1253 req_str = MC_request_to_string(req, value);
1254 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1260 SIMIX_simcall_pre(req, value);
1261 MC_wait_for_requests();
1266 /* Update statistics */
1267 mc_stats->visited_pairs++;
1268 mc_stats->executed_transitions++;
1272 XBT_DEBUG("**** End Replay ****");
1274 if(initial_state_liveness->raw_mem_set)
1282 * \brief Dumps the contents of a model-checker's stack and shows the actual
1284 * \param stack The stack to dump
1286 void MC_dump_stack_safety(xbt_fifo_t stack)
1289 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1291 MC_show_stack_safety(stack);
1293 if(!_sg_mc_checkpoint){
1298 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1299 MC_state_delete(state);
1312 void MC_show_stack_safety(xbt_fifo_t stack)
1315 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1321 xbt_fifo_item_t item;
1323 char *req_str = NULL;
1325 for (item = xbt_fifo_get_last_item(stack);
1326 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1327 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1328 req = MC_state_get_executed_request(state, &value);
1330 req_str = MC_request_to_string(req, value);
1331 XBT_INFO("%s", req_str);
1340 void MC_show_deadlock(smx_simcall_t req)
1342 /*char *req_str = NULL;*/
1343 XBT_INFO("**************************");
1344 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1345 XBT_INFO("**************************");
1346 XBT_INFO("Locked request:");
1347 /*req_str = MC_request_to_string(req);
1348 XBT_INFO("%s", req_str);
1349 xbt_free(req_str);*/
1350 XBT_INFO("Counter-example execution trace:");
1351 MC_dump_stack_safety(mc_stack_safety);
1352 MC_print_statistics(mc_stats);
1356 void MC_show_stack_liveness(xbt_fifo_t stack){
1359 xbt_fifo_item_t item;
1361 char *req_str = NULL;
1363 for (item = xbt_fifo_get_last_item(stack);
1364 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1365 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1366 req = MC_state_get_executed_request(pair->graph_state, &value);
1368 if(pair->requests>0){
1369 req_str = MC_request_to_string(req, value);
1370 XBT_INFO("%s", req_str);
1373 XBT_INFO("End of system requests but evolution in Büchi automaton");
1379 void MC_dump_stack_liveness(xbt_fifo_t stack){
1381 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1386 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1387 MC_pair_delete(pair);
1396 void MC_print_statistics(mc_stats_t stats)
1398 if(stats->expanded_pairs == 0){
1399 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1400 XBT_INFO("Visited states = %lu", stats->visited_states);
1402 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1403 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1405 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1407 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1408 fprintf(dot_output, "}\n");
1411 if(initial_state_safety != NULL){
1412 if(_sg_mc_comms_determinism)
1413 XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1414 if (_sg_mc_send_determinism)
1415 XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1420 void MC_assert(int prop)
1422 if (MC_is_active() && !prop){
1423 XBT_INFO("**************************");
1424 XBT_INFO("*** PROPERTY NOT VALID ***");
1425 XBT_INFO("**************************");
1426 XBT_INFO("Counter-example execution trace:");
1427 MC_dump_stack_safety(mc_stack_safety);
1428 MC_print_statistics(mc_stats);
1434 user_max_depth_reached = 1;
1437 void MC_process_clock_add(smx_process_t process, double amount)
1439 mc_time[process->pid] += amount;
1442 double MC_process_clock_get(smx_process_t process)
1446 return mc_time[process->pid];
1454 void MC_automaton_load(const char *file){
1456 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1460 if (_mc_property_automaton == NULL)
1461 _mc_property_automaton = xbt_automaton_new();
1463 xbt_automaton_load(_mc_property_automaton,file);
1472 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1474 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1478 if (_mc_property_automaton == NULL)
1479 _mc_property_automaton = xbt_automaton_new();
1481 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);