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_functions(mc_object_info_t info) {
308 xbt_dict_cursor_t cursor;
310 dw_frame_t function = NULL;
311 xbt_dict_foreach(info->subprograms, cursor, key, function) {
312 unsigned cursor2 = 0;
313 dw_variable_t variable = NULL;
314 xbt_dynar_foreach(function->variables, cursor2, variable) {
315 if(variable->type_origin) {
316 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
322 /** \brief Finds informations about a given shared object/executable */
323 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
324 mc_object_info_t result = MC_new_object_info();
326 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
327 result->file_name = xbt_strdup(name);
328 MC_find_object_address(maps, result);
329 MC_dwarf_get_variables(result);
330 MC_post_process_types(result);
331 MC_post_process_variables(result);
332 MC_post_process_functions(result);
333 MC_make_functions_index(result);
337 /*************************************************************************/
339 /** \brief Finds a frame (DW_TAG_subprogram) from an DWARF offset in the rangd of this subprogram
341 * The offset can be an offset of a child DW_TAG_variable.
343 static dw_frame_t MC_dwarf_get_frame_by_offset(xbt_dict_t all_variables, unsigned long int offset){
345 xbt_dict_cursor_t cursor = NULL;
349 xbt_dict_foreach(all_variables, cursor, name, res) {
350 if(offset >= res->start && offset < res->end){
351 xbt_dict_cursor_free(&cursor);
356 xbt_dict_cursor_free(&cursor);
361 static dw_variable_t MC_dwarf_get_variable_by_name(dw_frame_t frame, char *var){
363 unsigned int cursor = 0;
364 dw_variable_t current_var;
366 xbt_dynar_foreach(frame->variables, cursor, current_var){
367 if(strcmp(var, current_var->name) == 0)
374 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
376 if(xbt_dynar_is_empty(variables))
379 unsigned int cursor = 0;
381 int end = xbt_dynar_length(variables) - 1;
382 dw_variable_t var_test = NULL;
385 cursor = (start + end) / 2;
386 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
387 if(strcmp(var_test->name, var) < 0){
389 }else if(strcmp(var_test->name, var) > 0){
392 if(address){ /* global variable */
393 if(var_test->address == address)
395 if(var_test->address > address)
399 }else{ /* local variable */
405 if(strcmp(var_test->name, var) == 0){
406 if(address && var_test->address < address)
410 }else if(strcmp(var_test->name, var) < 0)
417 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
418 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
420 xbt_dynar_insert_at(info->global_variables, index, &variable);
424 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
425 xbt_assert(frame, "Frame is NULL");
426 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
428 xbt_dynar_insert_at(frame->variables, index, &variable);
432 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
434 MC_dwarf_register_global_variable(info, variable);
436 xbt_die("No frame for this local variable");
438 MC_dwarf_register_non_global_variable(info, frame, variable);
442 /******************************* Ignore mechanism *******************************/
443 /*********************************************************************************/
445 xbt_dynar_t mc_checkpoint_ignore;
447 typedef struct s_mc_stack_ignore_variable{
450 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
452 /**************************** Free functions ******************************/
454 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
455 xbt_free(v->var_name);
460 static void stack_ignore_variable_free_voidp(void *v){
461 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
464 void heap_ignore_region_free(mc_heap_ignore_region_t r){
468 void heap_ignore_region_free_voidp(void *r){
469 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
472 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
476 static void checkpoint_ignore_region_free_voidp(void *r){
477 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
480 /***********************************************************************/
482 void MC_ignore_heap(void *address, size_t size){
484 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
488 mc_heap_ignore_region_t region = NULL;
489 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
490 region->address = address;
493 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
495 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
496 region->fragment = -1;
497 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
499 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
500 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
503 if(mc_heap_comparison_ignore == NULL){
504 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
505 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
511 unsigned int cursor = 0;
512 mc_heap_ignore_region_t current_region = NULL;
514 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
517 cursor = (start + end) / 2;
518 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
519 if(current_region->address == address){
520 heap_ignore_region_free(region);
524 }else if(current_region->address < address){
531 if(current_region->address < address)
532 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
534 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
540 void MC_remove_ignore_heap(void *address, size_t size){
542 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
546 unsigned int cursor = 0;
548 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
549 mc_heap_ignore_region_t region;
550 int ignore_found = 0;
553 cursor = (start + end) / 2;
554 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
555 if(region->address == address){
558 }else if(region->address < address){
561 if((char * )region->address <= ((char *)address + size)){
570 if(ignore_found == 1){
571 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
572 MC_remove_ignore_heap(address, size);
580 void MC_ignore_global_variable(const char *name){
582 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
586 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
588 unsigned int cursor = 0;
589 dw_variable_t current_var;
591 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
594 cursor = (start + end) /2;
595 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
596 if(strcmp(current_var->name, name) == 0){
597 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
599 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
600 }else if(strcmp(current_var->name, name) < 0){
611 static void MC_ignore_local_variable_in_object(const char *var_name, const char *frame_name, mc_object_info_t info) {
612 xbt_dict_cursor_t cursor2;
616 dw_variable_t current_var;
618 xbt_dict_foreach(info->subprograms, cursor2, key, frame) {
620 if(frame_name && strcmp(frame_name, frame->name))
624 end = xbt_dynar_length(frame->variables) - 1;
626 cursor = (start + end) / 2;
627 current_var = (dw_variable_t)xbt_dynar_get_as(frame->variables, cursor, dw_variable_t);
629 int compare = strcmp(current_var->name, var_name);
631 xbt_dynar_remove_at(frame->variables, cursor, NULL);
633 end = xbt_dynar_length(frame->variables) - 1;
634 }else if(compare < 0){
643 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
645 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
647 if(strcmp(frame_name, "*") == 0)
652 MC_ignore_local_variable_in_object(var_name, frame_name, mc_libsimgrid_info);
654 MC_ignore_local_variable_in_object(var_name, frame_name, mc_binary_info);
661 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
663 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
667 if(stacks_areas == NULL)
668 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
670 stack_region_t region = NULL;
671 region = xbt_new0(s_stack_region_t, 1);
672 region->address = stack;
673 region->process_name = strdup(name);
674 region->context = context;
676 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
677 xbt_dynar_push(stacks_areas, ®ion);
683 void MC_ignore(void *addr, size_t size){
685 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
689 if(mc_checkpoint_ignore == NULL)
690 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
692 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
696 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
697 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
700 unsigned int cursor = 0;
702 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
703 mc_checkpoint_ignore_region_t current_region = NULL;
706 cursor = (start + end) / 2;
707 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
708 if(current_region->addr == addr){
709 if(current_region->size == size){
710 checkpoint_ignore_region_free(region);
714 }else if(current_region->size < size){
719 }else if(current_region->addr < addr){
726 if(current_region->addr == addr){
727 if(current_region->size < size){
728 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
730 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
732 }else if(current_region->addr < addr){
733 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
735 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
743 /******************************* Initialisation of MC *******************************/
744 /*********************************************************************************/
746 static void MC_post_process_object_info(mc_object_info_t info) {
747 xbt_dict_cursor_t cursor = NULL;
749 dw_type_t type = NULL;
750 xbt_dict_foreach(info->types, cursor, key, type){
752 // Resolve full_type:
753 if(type->name && type->byte_size == 0) {
754 for(size_t i=0; i!=mc_object_infos_size; ++i) {
755 dw_type_t same_type = xbt_dict_get_or_null(mc_object_infos[i]->full_types_by_name, type->name);
756 if(same_type && same_type->name && same_type->byte_size) {
757 type->full_type = same_type;
766 static void MC_init_debug_info(void) {
767 XBT_INFO("Get debug information ...");
769 memory_map_t maps = MC_get_memory_map();
771 /* Get local variables for state equality detection */
772 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
773 mc_object_infos[0] = mc_binary_info;
775 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
776 mc_object_infos[1] = mc_libsimgrid_info;
778 // Use information of the other objects:
779 MC_post_process_object_info(mc_binary_info);
780 MC_post_process_object_info(mc_libsimgrid_info);
782 MC_free_memory_map(maps);
783 XBT_INFO("Get debug information done !");
788 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
792 /* Initialize the data structures that must be persistent across every
793 iteration of the model-checker (in RAW memory) */
797 MC_init_memory_map_info();
798 MC_init_debug_info();
801 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
805 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
806 MC_ignore_local_variable("e", "*");
807 MC_ignore_local_variable("__ex_cleanup", "*");
808 MC_ignore_local_variable("__ex_mctx_en", "*");
809 MC_ignore_local_variable("__ex_mctx_me", "*");
810 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
811 MC_ignore_local_variable("_log_ev", "*");
812 MC_ignore_local_variable("_throw_ctx", "*");
813 MC_ignore_local_variable("ctx", "*");
815 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
816 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
817 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
819 /* Ignore local variable about time used for tracing */
820 MC_ignore_local_variable("start_time", "*");
822 MC_ignore_global_variable("compared_pointers");
823 MC_ignore_global_variable("mc_comp_times");
824 MC_ignore_global_variable("mc_snapshot_comparison_time");
825 MC_ignore_global_variable("mc_time");
826 MC_ignore_global_variable("smpi_current_rank");
827 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
828 MC_ignore_global_variable("maestro_stack_start");
829 MC_ignore_global_variable("maestro_stack_end");
830 MC_ignore_global_variable("smx_total_comms");
832 MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
833 MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
834 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
835 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
837 smx_process_t process;
838 xbt_swag_foreach(process, simix_global->process_list){
839 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
847 static void MC_init_dot_output(){ /* FIXME : more colors */
851 colors[2] = "green3";
852 colors[3] = "goldenrod";
854 colors[5] = "purple";
855 colors[6] = "magenta";
856 colors[7] = "turquoise4";
857 colors[8] = "gray25";
858 colors[9] = "forestgreen";
859 colors[10] = "hotpink";
860 colors[11] = "lightblue";
863 dot_output = fopen(_sg_mc_dot_output_file, "w");
865 if(dot_output == NULL){
866 perror("Error open dot output file");
870 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");
874 /******************************* Core of MC *******************************/
875 /**************************************************************************/
877 void MC_do_the_modelcheck_for_real() {
880 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
883 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
884 if (mc_reduce_kind==e_mc_reduce_unset)
885 mc_reduce_kind=e_mc_reduce_dpor;
887 XBT_INFO("Check a safety property");
888 MC_modelcheck_safety();
892 if (mc_reduce_kind==e_mc_reduce_unset)
893 mc_reduce_kind=e_mc_reduce_none;
895 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
896 MC_automaton_load(_sg_mc_property_file);
897 MC_modelcheck_liveness();
901 void MC_modelcheck_safety(void)
903 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
905 /* Check if MC is already initialized */
906 if (initial_state_safety)
909 mc_time = xbt_new0(double, simix_process_maxpid);
911 /* mc_time refers to clock for each process -> ignore it for heap comparison */
912 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
914 /* Initialize the data structures that must be persistent across every
915 iteration of the model-checker (in RAW memory) */
919 /* Initialize statistics */
920 mc_stats = xbt_new0(s_mc_stats_t, 1);
921 mc_stats->state_size = 1;
923 /* Create exploration stack */
924 mc_stack_safety = xbt_fifo_new();
926 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
927 MC_init_dot_output();
931 if(_sg_mc_visited > 0){
935 MC_init_memory_map_info();
936 MC_init_debug_info();
943 /* Save the initial state */
944 initial_state_safety = xbt_new0(s_mc_global_t, 1);
945 initial_state_safety->snapshot = MC_take_snapshot(0);
946 initial_state_safety->initial_communications_pattern_done = 0;
947 initial_state_safety->comm_deterministic = 1;
948 initial_state_safety->send_deterministic = 1;
960 void MC_modelcheck_liveness(){
962 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
966 mc_time = xbt_new0(double, simix_process_maxpid);
968 /* mc_time refers to clock for each process -> ignore it for heap comparison */
969 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
973 /* Initialize statistics */
974 mc_stats = xbt_new0(s_mc_stats_t, 1);
975 mc_stats->state_size = 1;
977 /* Create exploration stack */
978 mc_stack_liveness = xbt_fifo_new();
980 /* Create the initial state */
981 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
983 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
984 MC_init_dot_output();
991 MC_print_statistics(mc_stats);
1008 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
1010 return simcall->mc_value;
1014 int MC_random(int min, int max)
1016 /*FIXME: return mc_current_state->executed_transition->random.value;*/
1017 return simcall_mc_random(min, max);
1021 * \brief Schedules all the process that are ready to run
1023 void MC_wait_for_requests(void)
1025 smx_process_t process;
1029 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1030 SIMIX_process_runall();
1031 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1032 req = &process->simcall;
1033 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1034 SIMIX_simcall_pre(req, 0);
1039 int MC_deadlock_check()
1041 int deadlock = FALSE;
1042 smx_process_t process;
1043 if(xbt_swag_size(simix_global->process_list)){
1045 xbt_swag_foreach(process, simix_global->process_list){
1046 if(process->simcall.call != SIMCALL_NONE
1047 && MC_request_is_enabled(&process->simcall)){
1057 * \brief Re-executes from the state at position start all the transitions indicated by
1058 * a given model-checker stack.
1059 * \param stack The stack with the transitions to execute.
1060 * \param start Start index to begin the re-execution.
1062 void MC_replay(xbt_fifo_t stack, int start)
1064 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1066 int value, i = 1, count = 1;
1068 smx_simcall_t req = NULL, saved_req = NULL;
1069 xbt_fifo_item_t item, start_item;
1071 smx_process_t process = NULL;
1072 int comm_pattern = 0;
1074 XBT_DEBUG("**** Begin Replay ****");
1077 /* Restore the initial state */
1078 MC_restore_snapshot(initial_state_safety->snapshot);
1079 /* At the moment of taking the snapshot the raw heap was set, so restoring
1080 * it will set it back again, we have to unset it to continue */
1084 start_item = xbt_fifo_get_last_item(stack);
1087 start_item = xbt_fifo_get_prev_item(start_item);
1093 xbt_dict_reset(first_enabled_state);
1094 xbt_swag_foreach(process, simix_global->process_list){
1095 if(MC_process_is_enabled(process)){
1096 char *key = bprintf("%lu", process->pid);
1097 char *data = bprintf("%d", count);
1098 xbt_dict_set(first_enabled_state, key, data, NULL);
1102 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
1103 xbt_dynar_reset(communications_pattern);
1107 /* Traverse the stack from the state at position start and re-execute the transitions */
1108 for (item = start_item;
1109 item != xbt_fifo_get_first_item(stack);
1110 item = xbt_fifo_get_prev_item(item)) {
1112 state = (mc_state_t) xbt_fifo_get_item_content(item);
1113 saved_req = MC_state_get_executed_request(state, &value);
1116 char *key = bprintf("%lu", saved_req->issuer->pid);
1117 xbt_dict_remove(first_enabled_state, key);
1122 /* because we got a copy of the executed request, we have to fetch the
1123 real one, pointed by the request field of the issuer process */
1124 req = &saved_req->issuer->simcall;
1126 /* Debug information */
1127 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1128 req_str = MC_request_to_string(req, value);
1129 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1134 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1135 if(req->call == SIMCALL_COMM_ISEND)
1137 else if(req->call == SIMCALL_COMM_IRECV)
1141 SIMIX_simcall_pre(req, value);
1143 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1145 if(comm_pattern != 0){
1146 get_comm_pattern(communications_pattern, req, comm_pattern);
1152 MC_wait_for_requests();
1157 /* Insert in dict all enabled processes */
1158 xbt_swag_foreach(process, simix_global->process_list){
1159 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1160 char *key = bprintf("%lu", process->pid);
1161 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1162 char *data = bprintf("%d", count);
1163 xbt_dict_set(first_enabled_state, key, data, NULL);
1170 /* Update statistics */
1171 mc_stats->visited_states++;
1172 mc_stats->executed_transitions++;
1176 XBT_DEBUG("**** End Replay ****");
1186 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1189 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1193 smx_simcall_t req = NULL, saved_req = NULL;
1194 xbt_fifo_item_t item;
1199 XBT_DEBUG("**** Begin Replay ****");
1201 /* Restore the initial state */
1202 MC_restore_snapshot(initial_state_liveness->snapshot);
1204 /* At the moment of taking the snapshot the raw heap was set, so restoring
1205 * it will set it back again, we have to unset it to continue */
1206 if(!initial_state_liveness->raw_mem_set)
1211 item = xbt_fifo_get_last_item(stack);
1213 while(depth <= xbt_fifo_size(stack)){
1215 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1216 state = (mc_state_t) pair->graph_state;
1218 if(pair->requests > 0){
1220 saved_req = MC_state_get_executed_request(state, &value);
1221 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1223 if(saved_req != NULL){
1224 /* because we got a copy of the executed request, we have to fetch the
1225 real one, pointed by the request field of the issuer process */
1226 req = &saved_req->issuer->simcall;
1227 //XBT_DEBUG("Req->call %u", req->call);
1229 /* Debug information */
1230 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1231 req_str = MC_request_to_string(req, value);
1232 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1238 SIMIX_simcall_pre(req, value);
1239 MC_wait_for_requests();
1244 /* Update statistics */
1245 mc_stats->visited_pairs++;
1246 mc_stats->executed_transitions++;
1248 item = xbt_fifo_get_prev_item(item);
1253 /* Traverse the stack from the initial state and re-execute the transitions */
1254 for (item = xbt_fifo_get_last_item(stack);
1255 item != xbt_fifo_get_first_item(stack);
1256 item = xbt_fifo_get_prev_item(item)) {
1258 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1259 state = (mc_state_t) pair->graph_state;
1261 if(pair->requests > 0){
1263 saved_req = MC_state_get_executed_request(state, &value);
1264 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1266 if(saved_req != NULL){
1267 /* because we got a copy of the executed request, we have to fetch the
1268 real one, pointed by the request field of the issuer process */
1269 req = &saved_req->issuer->simcall;
1270 //XBT_DEBUG("Req->call %u", req->call);
1272 /* Debug information */
1273 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1274 req_str = MC_request_to_string(req, value);
1275 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1281 SIMIX_simcall_pre(req, value);
1282 MC_wait_for_requests();
1287 /* Update statistics */
1288 mc_stats->visited_pairs++;
1289 mc_stats->executed_transitions++;
1293 XBT_DEBUG("**** End Replay ****");
1295 if(initial_state_liveness->raw_mem_set)
1303 * \brief Dumps the contents of a model-checker's stack and shows the actual
1305 * \param stack The stack to dump
1307 void MC_dump_stack_safety(xbt_fifo_t stack)
1310 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1312 MC_show_stack_safety(stack);
1314 if(!_sg_mc_checkpoint){
1319 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1320 MC_state_delete(state);
1333 void MC_show_stack_safety(xbt_fifo_t stack)
1336 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1342 xbt_fifo_item_t item;
1344 char *req_str = NULL;
1346 for (item = xbt_fifo_get_last_item(stack);
1347 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1348 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1349 req = MC_state_get_executed_request(state, &value);
1351 req_str = MC_request_to_string(req, value);
1352 XBT_INFO("%s", req_str);
1361 void MC_show_deadlock(smx_simcall_t req)
1363 /*char *req_str = NULL;*/
1364 XBT_INFO("**************************");
1365 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1366 XBT_INFO("**************************");
1367 XBT_INFO("Locked request:");
1368 /*req_str = MC_request_to_string(req);
1369 XBT_INFO("%s", req_str);
1370 xbt_free(req_str);*/
1371 XBT_INFO("Counter-example execution trace:");
1372 MC_dump_stack_safety(mc_stack_safety);
1373 MC_print_statistics(mc_stats);
1377 void MC_show_stack_liveness(xbt_fifo_t stack){
1380 xbt_fifo_item_t item;
1382 char *req_str = NULL;
1384 for (item = xbt_fifo_get_last_item(stack);
1385 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1386 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1387 req = MC_state_get_executed_request(pair->graph_state, &value);
1389 if(pair->requests>0){
1390 req_str = MC_request_to_string(req, value);
1391 XBT_INFO("%s", req_str);
1394 XBT_INFO("End of system requests but evolution in Büchi automaton");
1400 void MC_dump_stack_liveness(xbt_fifo_t stack){
1402 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1407 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1408 MC_pair_delete(pair);
1417 void MC_print_statistics(mc_stats_t stats)
1419 if(stats->expanded_pairs == 0){
1420 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1421 XBT_INFO("Visited states = %lu", stats->visited_states);
1423 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1424 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1426 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1428 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1429 fprintf(dot_output, "}\n");
1432 if(initial_state_safety != NULL){
1433 if(_sg_mc_comms_determinism)
1434 XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1435 if (_sg_mc_send_determinism)
1436 XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1441 void MC_assert(int prop)
1443 if (MC_is_active() && !prop){
1444 XBT_INFO("**************************");
1445 XBT_INFO("*** PROPERTY NOT VALID ***");
1446 XBT_INFO("**************************");
1447 XBT_INFO("Counter-example execution trace:");
1448 MC_dump_stack_safety(mc_stack_safety);
1449 MC_print_statistics(mc_stats);
1455 user_max_depth_reached = 1;
1458 void MC_process_clock_add(smx_process_t process, double amount)
1460 mc_time[process->pid] += amount;
1463 double MC_process_clock_get(smx_process_t process)
1467 return mc_time[process->pid];
1475 void MC_automaton_load(const char *file){
1477 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1481 if (_mc_property_automaton == NULL)
1482 _mc_property_automaton = xbt_automaton_new();
1484 xbt_automaton_load(_mc_property_automaton,file);
1493 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1495 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1499 if (_mc_property_automaton == NULL)
1500 _mc_property_automaton = xbt_automaton_new();
1502 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);