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 dw_type_free(dw_type_t t){
160 xbt_free(t->dw_type_id);
161 xbt_dynar_free(&(t->members));
162 mc_dwarf_expression_clear(&t->location);
166 static void dw_type_free_voidp(void *t){
167 dw_type_free((dw_type_t) * (void **) t);
170 void dw_variable_free(dw_variable_t v){
173 xbt_free(v->type_origin);
175 if(v->locations.locations)
176 mc_dwarf_location_list_clear(&v->locations);
181 void dw_variable_free_voidp(void *t){
182 dw_variable_free((dw_variable_t) * (void **) t);
187 mc_object_info_t MC_new_object_info(void) {
188 mc_object_info_t res = xbt_new0(s_mc_object_info_t, 1);
189 res->subprograms = xbt_dynar_new(sizeof(dw_frame_t), NULL);
190 res->global_variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
191 res->types = xbt_dict_new_homogeneous(NULL);
192 res->full_types_by_name = xbt_dict_new_homogeneous(NULL);
196 void MC_free_object_info(mc_object_info_t* info) {
197 xbt_free(&(*info)->file_name);
198 xbt_dynar_free(&(*info)->subprograms);
199 xbt_dynar_free(&(*info)->global_variables);
200 xbt_dict_free(&(*info)->types);
201 xbt_dict_free(&(*info)->full_types_by_name);
203 xbt_dynar_free(&(*info)->functions_index);
209 void* MC_object_base_address(mc_object_info_t info) {
210 void* result = info->start_exec;
211 if(info->start_rw!=NULL && result > (void*) info->start_rw) result = info->start_rw;
212 if(info->start_ro!=NULL && result > (void*) info->start_ro) result = info->start_ro;
216 // ***** Functions index
218 static int MC_compare_frame_index_items(mc_function_index_item_t a, mc_function_index_item_t b) {
219 if(a->low_pc < b->low_pc)
221 else if(a->low_pc == b->low_pc)
227 static void MC_make_functions_index(mc_object_info_t info) {
228 xbt_dynar_t index = xbt_dynar_new(sizeof(s_mc_function_index_item_t), NULL);
230 // Populate the array:
231 dw_frame_t frame = NULL;
233 xbt_dynar_foreach(info->subprograms, cursor, frame) {
234 if(frame->low_pc==NULL)
236 s_mc_function_index_item_t entry;
237 entry.low_pc = frame->low_pc;
238 entry.high_pc = frame->high_pc;
239 entry.function = frame;
240 xbt_dynar_push(index, &entry);
243 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(index, 0);
245 // Sort the array by low_pc:
247 xbt_dynar_length(index),
248 sizeof(s_mc_function_index_item_t),
249 (int (*)(const void *, const void *))MC_compare_frame_index_items);
251 info->functions_index = index;
254 mc_object_info_t MC_ip_find_object_info(void* ip) {
256 for(i=0; i!=mc_object_infos_size; ++i) {
257 if(ip >= (void*)mc_object_infos[i]->start_exec && ip <= (void*)mc_object_infos[i]->end_exec) {
258 return mc_object_infos[i];
264 static dw_frame_t MC_find_function_by_ip_and_object(void* ip, mc_object_info_t info) {
265 xbt_dynar_t dynar = info->functions_index;
266 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(dynar, 0);
268 int j = xbt_dynar_length(dynar) - 1;
270 int k = i + ((j-i)/2);
271 if(ip < base[k].low_pc) {
273 } else if(ip > base[k].high_pc) {
276 return base[k].function;
282 dw_frame_t MC_find_function_by_ip(void* ip) {
283 mc_object_info_t info = MC_ip_find_object_info(ip);
287 return MC_find_function_by_ip_and_object(ip, info);
290 static void MC_post_process_variables(mc_object_info_t info) {
292 dw_variable_t variable = NULL;
293 xbt_dynar_foreach(info->global_variables, cursor, variable) {
294 if(variable->type_origin) {
295 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
300 static void MC_post_process_functions(mc_object_info_t info) {
302 dw_frame_t function = NULL;
303 xbt_dynar_foreach(info->subprograms, cursor, function) {
304 unsigned cursor2 = 0;
305 dw_variable_t variable = NULL;
306 xbt_dynar_foreach(function->variables, cursor2, variable) {
307 if(variable->type_origin) {
308 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
314 /** \brief Finds informations about a given shared object/executable */
315 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
316 mc_object_info_t result = MC_new_object_info();
318 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
319 result->file_name = xbt_strdup(name);
320 MC_find_object_address(maps, result);
321 MC_dwarf_get_variables(result);
322 MC_post_process_types(result);
323 MC_post_process_variables(result);
324 MC_post_process_functions(result);
325 MC_make_functions_index(result);
329 /*************************************************************************/
331 /** \brief Finds a frame (DW_TAG_subprogram) from an DWARF offset in the rangd of this subprogram
333 * The offset can be an offset of a child DW_TAG_variable.
335 static dw_frame_t MC_dwarf_get_frame_by_offset(xbt_dict_t all_variables, unsigned long int offset){
337 xbt_dict_cursor_t cursor = NULL;
341 xbt_dict_foreach(all_variables, cursor, name, res) {
342 if(offset >= res->start && offset < res->end){
343 xbt_dict_cursor_free(&cursor);
348 xbt_dict_cursor_free(&cursor);
353 static dw_variable_t MC_dwarf_get_variable_by_name(dw_frame_t frame, char *var){
355 unsigned int cursor = 0;
356 dw_variable_t current_var;
358 xbt_dynar_foreach(frame->variables, cursor, current_var){
359 if(strcmp(var, current_var->name) == 0)
366 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
368 if(xbt_dynar_is_empty(variables))
371 unsigned int cursor = 0;
373 int end = xbt_dynar_length(variables) - 1;
374 dw_variable_t var_test = NULL;
377 cursor = (start + end) / 2;
378 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
379 if(strcmp(var_test->name, var) < 0){
381 }else if(strcmp(var_test->name, var) > 0){
384 if(address){ /* global variable */
385 if(var_test->address == address)
387 if(var_test->address > address)
391 }else{ /* local variable */
397 if(strcmp(var_test->name, var) == 0){
398 if(address && var_test->address < address)
402 }else if(strcmp(var_test->name, var) < 0)
409 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
410 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
412 xbt_dynar_insert_at(info->global_variables, index, &variable);
416 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
417 xbt_assert(frame, "Frame is NULL");
418 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
420 xbt_dynar_insert_at(frame->variables, index, &variable);
424 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
426 MC_dwarf_register_global_variable(info, variable);
428 xbt_die("No frame for this local variable");
430 MC_dwarf_register_non_global_variable(info, frame, variable);
434 /******************************* Ignore mechanism *******************************/
435 /*********************************************************************************/
437 xbt_dynar_t mc_checkpoint_ignore;
439 typedef struct s_mc_stack_ignore_variable{
442 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
444 /**************************** Free functions ******************************/
446 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
447 xbt_free(v->var_name);
452 static void stack_ignore_variable_free_voidp(void *v){
453 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
456 void heap_ignore_region_free(mc_heap_ignore_region_t r){
460 void heap_ignore_region_free_voidp(void *r){
461 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
464 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
468 static void checkpoint_ignore_region_free_voidp(void *r){
469 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
472 /***********************************************************************/
474 void MC_ignore_heap(void *address, size_t size){
476 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
480 mc_heap_ignore_region_t region = NULL;
481 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
482 region->address = address;
485 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
487 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
488 region->fragment = -1;
489 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
491 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
492 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
495 if(mc_heap_comparison_ignore == NULL){
496 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
497 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
503 unsigned int cursor = 0;
504 mc_heap_ignore_region_t current_region = NULL;
506 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
509 cursor = (start + end) / 2;
510 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
511 if(current_region->address == address){
512 heap_ignore_region_free(region);
516 }else if(current_region->address < address){
523 if(current_region->address < address)
524 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
526 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
532 void MC_remove_ignore_heap(void *address, size_t size){
534 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
538 unsigned int cursor = 0;
540 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
541 mc_heap_ignore_region_t region;
542 int ignore_found = 0;
545 cursor = (start + end) / 2;
546 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
547 if(region->address == address){
550 }else if(region->address < address){
553 if((char * )region->address <= ((char *)address + size)){
562 if(ignore_found == 1){
563 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
564 MC_remove_ignore_heap(address, size);
572 void MC_ignore_global_variable(const char *name){
574 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
578 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
580 unsigned int cursor = 0;
581 dw_variable_t current_var;
583 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
586 cursor = (start + end) /2;
587 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
588 if(strcmp(current_var->name, name) == 0){
589 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
591 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
592 }else if(strcmp(current_var->name, name) < 0){
603 static void MC_ignore_local_variable_in_object(const char *var_name, const char *frame_name, mc_object_info_t info) {
608 dw_variable_t current_var;
610 xbt_dynar_foreach(info->subprograms, cursor2, frame) {
612 if(frame_name && strcmp(frame_name, frame->name))
616 end = xbt_dynar_length(frame->variables) - 1;
618 cursor = (start + end) / 2;
619 current_var = (dw_variable_t)xbt_dynar_get_as(frame->variables, cursor, dw_variable_t);
621 int compare = strcmp(current_var->name, var_name);
623 xbt_dynar_remove_at(frame->variables, cursor, NULL);
625 end = xbt_dynar_length(frame->variables) - 1;
626 }else if(compare < 0){
635 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
637 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
639 if(strcmp(frame_name, "*") == 0)
644 MC_ignore_local_variable_in_object(var_name, frame_name, mc_libsimgrid_info);
646 MC_ignore_local_variable_in_object(var_name, frame_name, mc_binary_info);
653 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
655 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
659 if(stacks_areas == NULL)
660 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
662 stack_region_t region = NULL;
663 region = xbt_new0(s_stack_region_t, 1);
664 region->address = stack;
665 region->process_name = strdup(name);
666 region->context = context;
668 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
669 xbt_dynar_push(stacks_areas, ®ion);
675 void MC_ignore(void *addr, size_t size){
677 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
681 if(mc_checkpoint_ignore == NULL)
682 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
684 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
688 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
689 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
692 unsigned int cursor = 0;
694 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
695 mc_checkpoint_ignore_region_t current_region = NULL;
698 cursor = (start + end) / 2;
699 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
700 if(current_region->addr == addr){
701 if(current_region->size == size){
702 checkpoint_ignore_region_free(region);
706 }else if(current_region->size < size){
711 }else if(current_region->addr < addr){
718 if(current_region->addr == addr){
719 if(current_region->size < size){
720 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
722 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
724 }else if(current_region->addr < addr){
725 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
727 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
735 /******************************* Initialisation of MC *******************************/
736 /*********************************************************************************/
738 static void MC_post_process_object_info(mc_object_info_t info) {
739 xbt_dict_cursor_t cursor = NULL;
741 dw_type_t type = NULL;
742 xbt_dict_foreach(info->types, cursor, key, type){
744 // Resolve full_type:
745 if(type->name && type->byte_size == 0) {
746 for(size_t i=0; i!=mc_object_infos_size; ++i) {
747 dw_type_t same_type = xbt_dict_get_or_null(mc_object_infos[i]->full_types_by_name, type->name);
748 if(same_type && same_type->name && same_type->byte_size) {
749 type->full_type = same_type;
758 static void MC_init_debug_info(void) {
759 XBT_INFO("Get debug information ...");
761 memory_map_t maps = MC_get_memory_map();
763 /* Get local variables for state equality detection */
764 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
765 mc_object_infos[0] = mc_binary_info;
767 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
768 mc_object_infos[1] = mc_libsimgrid_info;
770 // Use information of the other objects:
771 MC_post_process_object_info(mc_binary_info);
772 MC_post_process_object_info(mc_libsimgrid_info);
774 MC_free_memory_map(maps);
775 XBT_INFO("Get debug information done !");
780 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
784 /* Initialize the data structures that must be persistent across every
785 iteration of the model-checker (in RAW memory) */
789 MC_init_memory_map_info();
790 MC_init_debug_info();
793 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
797 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
798 MC_ignore_local_variable("e", "*");
799 MC_ignore_local_variable("__ex_cleanup", "*");
800 MC_ignore_local_variable("__ex_mctx_en", "*");
801 MC_ignore_local_variable("__ex_mctx_me", "*");
802 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
803 MC_ignore_local_variable("_log_ev", "*");
804 MC_ignore_local_variable("_throw_ctx", "*");
805 MC_ignore_local_variable("ctx", "*");
807 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
808 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
809 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
811 /* Ignore local variable about time used for tracing */
812 MC_ignore_local_variable("start_time", "*");
814 MC_ignore_global_variable("compared_pointers");
815 MC_ignore_global_variable("mc_comp_times");
816 MC_ignore_global_variable("mc_snapshot_comparison_time");
817 MC_ignore_global_variable("mc_time");
818 MC_ignore_global_variable("smpi_current_rank");
819 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
820 MC_ignore_global_variable("maestro_stack_start");
821 MC_ignore_global_variable("maestro_stack_end");
822 MC_ignore_global_variable("smx_total_comms");
824 MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
825 MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
826 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
827 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
829 smx_process_t process;
830 xbt_swag_foreach(process, simix_global->process_list){
831 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
839 static void MC_init_dot_output(){ /* FIXME : more colors */
843 colors[2] = "green3";
844 colors[3] = "goldenrod";
846 colors[5] = "purple";
847 colors[6] = "magenta";
848 colors[7] = "turquoise4";
849 colors[8] = "gray25";
850 colors[9] = "forestgreen";
851 colors[10] = "hotpink";
852 colors[11] = "lightblue";
855 dot_output = fopen(_sg_mc_dot_output_file, "w");
857 if(dot_output == NULL){
858 perror("Error open dot output file");
862 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");
866 /******************************* Core of MC *******************************/
867 /**************************************************************************/
869 void MC_do_the_modelcheck_for_real() {
872 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
875 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
876 if (mc_reduce_kind==e_mc_reduce_unset)
877 mc_reduce_kind=e_mc_reduce_dpor;
879 XBT_INFO("Check a safety property");
880 MC_modelcheck_safety();
884 if (mc_reduce_kind==e_mc_reduce_unset)
885 mc_reduce_kind=e_mc_reduce_none;
887 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
888 MC_automaton_load(_sg_mc_property_file);
889 MC_modelcheck_liveness();
893 void MC_modelcheck_safety(void)
895 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
897 /* Check if MC is already initialized */
898 if (initial_state_safety)
901 mc_time = xbt_new0(double, simix_process_maxpid);
903 /* mc_time refers to clock for each process -> ignore it for heap comparison */
904 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
906 /* Initialize the data structures that must be persistent across every
907 iteration of the model-checker (in RAW memory) */
911 /* Initialize statistics */
912 mc_stats = xbt_new0(s_mc_stats_t, 1);
913 mc_stats->state_size = 1;
915 /* Create exploration stack */
916 mc_stack_safety = xbt_fifo_new();
918 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
919 MC_init_dot_output();
923 if(_sg_mc_visited > 0){
927 MC_init_memory_map_info();
928 MC_init_debug_info();
935 /* Save the initial state */
936 initial_state_safety = xbt_new0(s_mc_global_t, 1);
937 initial_state_safety->snapshot = MC_take_snapshot(0);
938 initial_state_safety->initial_communications_pattern_done = 0;
939 initial_state_safety->comm_deterministic = 1;
940 initial_state_safety->send_deterministic = 1;
952 void MC_modelcheck_liveness(){
954 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
958 mc_time = xbt_new0(double, simix_process_maxpid);
960 /* mc_time refers to clock for each process -> ignore it for heap comparison */
961 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
965 /* Initialize statistics */
966 mc_stats = xbt_new0(s_mc_stats_t, 1);
967 mc_stats->state_size = 1;
969 /* Create exploration stack */
970 mc_stack_liveness = xbt_fifo_new();
972 /* Create the initial state */
973 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
975 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
976 MC_init_dot_output();
983 MC_print_statistics(mc_stats);
1000 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
1002 return simcall->mc_value;
1006 int MC_random(int min, int max)
1008 /*FIXME: return mc_current_state->executed_transition->random.value;*/
1009 return simcall_mc_random(min, max);
1013 * \brief Schedules all the process that are ready to run
1015 void MC_wait_for_requests(void)
1017 smx_process_t process;
1021 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1022 SIMIX_process_runall();
1023 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1024 req = &process->simcall;
1025 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1026 SIMIX_simcall_pre(req, 0);
1031 int MC_deadlock_check()
1033 int deadlock = FALSE;
1034 smx_process_t process;
1035 if(xbt_swag_size(simix_global->process_list)){
1037 xbt_swag_foreach(process, simix_global->process_list){
1038 if(process->simcall.call != SIMCALL_NONE
1039 && MC_request_is_enabled(&process->simcall)){
1049 * \brief Re-executes from the state at position start all the transitions indicated by
1050 * a given model-checker stack.
1051 * \param stack The stack with the transitions to execute.
1052 * \param start Start index to begin the re-execution.
1054 void MC_replay(xbt_fifo_t stack, int start)
1056 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1058 int value, i = 1, count = 1;
1060 smx_simcall_t req = NULL, saved_req = NULL;
1061 xbt_fifo_item_t item, start_item;
1063 smx_process_t process = NULL;
1064 int comm_pattern = 0;
1066 XBT_DEBUG("**** Begin Replay ****");
1069 /* Restore the initial state */
1070 MC_restore_snapshot(initial_state_safety->snapshot);
1071 /* At the moment of taking the snapshot the raw heap was set, so restoring
1072 * it will set it back again, we have to unset it to continue */
1076 start_item = xbt_fifo_get_last_item(stack);
1079 start_item = xbt_fifo_get_prev_item(start_item);
1085 xbt_dict_reset(first_enabled_state);
1086 xbt_swag_foreach(process, simix_global->process_list){
1087 if(MC_process_is_enabled(process)){
1088 char *key = bprintf("%lu", process->pid);
1089 char *data = bprintf("%d", count);
1090 xbt_dict_set(first_enabled_state, key, data, NULL);
1094 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
1095 xbt_dynar_reset(communications_pattern);
1099 /* Traverse the stack from the state at position start and re-execute the transitions */
1100 for (item = start_item;
1101 item != xbt_fifo_get_first_item(stack);
1102 item = xbt_fifo_get_prev_item(item)) {
1104 state = (mc_state_t) xbt_fifo_get_item_content(item);
1105 saved_req = MC_state_get_executed_request(state, &value);
1108 char *key = bprintf("%lu", saved_req->issuer->pid);
1109 xbt_dict_remove(first_enabled_state, key);
1114 /* because we got a copy of the executed request, we have to fetch the
1115 real one, pointed by the request field of the issuer process */
1116 req = &saved_req->issuer->simcall;
1118 /* Debug information */
1119 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1120 req_str = MC_request_to_string(req, value);
1121 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1126 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1127 if(req->call == SIMCALL_COMM_ISEND)
1129 else if(req->call == SIMCALL_COMM_IRECV)
1133 SIMIX_simcall_pre(req, value);
1135 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1137 if(comm_pattern != 0){
1138 get_comm_pattern(communications_pattern, req, comm_pattern);
1144 MC_wait_for_requests();
1149 /* Insert in dict all enabled processes */
1150 xbt_swag_foreach(process, simix_global->process_list){
1151 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1152 char *key = bprintf("%lu", process->pid);
1153 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1154 char *data = bprintf("%d", count);
1155 xbt_dict_set(first_enabled_state, key, data, NULL);
1162 /* Update statistics */
1163 mc_stats->visited_states++;
1164 mc_stats->executed_transitions++;
1168 XBT_DEBUG("**** End Replay ****");
1178 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1181 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1185 smx_simcall_t req = NULL, saved_req = NULL;
1186 xbt_fifo_item_t item;
1191 XBT_DEBUG("**** Begin Replay ****");
1193 /* Restore the initial state */
1194 MC_restore_snapshot(initial_state_liveness->snapshot);
1196 /* At the moment of taking the snapshot the raw heap was set, so restoring
1197 * it will set it back again, we have to unset it to continue */
1198 if(!initial_state_liveness->raw_mem_set)
1203 item = xbt_fifo_get_last_item(stack);
1205 while(depth <= xbt_fifo_size(stack)){
1207 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1208 state = (mc_state_t) pair->graph_state;
1210 if(pair->requests > 0){
1212 saved_req = MC_state_get_executed_request(state, &value);
1213 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1215 if(saved_req != NULL){
1216 /* because we got a copy of the executed request, we have to fetch the
1217 real one, pointed by the request field of the issuer process */
1218 req = &saved_req->issuer->simcall;
1219 //XBT_DEBUG("Req->call %u", req->call);
1221 /* Debug information */
1222 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1223 req_str = MC_request_to_string(req, value);
1224 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1230 SIMIX_simcall_pre(req, value);
1231 MC_wait_for_requests();
1236 /* Update statistics */
1237 mc_stats->visited_pairs++;
1238 mc_stats->executed_transitions++;
1240 item = xbt_fifo_get_prev_item(item);
1245 /* Traverse the stack from the initial state and re-execute the transitions */
1246 for (item = xbt_fifo_get_last_item(stack);
1247 item != xbt_fifo_get_first_item(stack);
1248 item = xbt_fifo_get_prev_item(item)) {
1250 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1251 state = (mc_state_t) pair->graph_state;
1253 if(pair->requests > 0){
1255 saved_req = MC_state_get_executed_request(state, &value);
1256 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1258 if(saved_req != NULL){
1259 /* because we got a copy of the executed request, we have to fetch the
1260 real one, pointed by the request field of the issuer process */
1261 req = &saved_req->issuer->simcall;
1262 //XBT_DEBUG("Req->call %u", req->call);
1264 /* Debug information */
1265 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1266 req_str = MC_request_to_string(req, value);
1267 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1273 SIMIX_simcall_pre(req, value);
1274 MC_wait_for_requests();
1279 /* Update statistics */
1280 mc_stats->visited_pairs++;
1281 mc_stats->executed_transitions++;
1285 XBT_DEBUG("**** End Replay ****");
1287 if(initial_state_liveness->raw_mem_set)
1295 * \brief Dumps the contents of a model-checker's stack and shows the actual
1297 * \param stack The stack to dump
1299 void MC_dump_stack_safety(xbt_fifo_t stack)
1302 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1304 MC_show_stack_safety(stack);
1306 if(!_sg_mc_checkpoint){
1311 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1312 MC_state_delete(state);
1325 void MC_show_stack_safety(xbt_fifo_t stack)
1328 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1334 xbt_fifo_item_t item;
1336 char *req_str = NULL;
1338 for (item = xbt_fifo_get_last_item(stack);
1339 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1340 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1341 req = MC_state_get_executed_request(state, &value);
1343 req_str = MC_request_to_string(req, value);
1344 XBT_INFO("%s", req_str);
1353 void MC_show_deadlock(smx_simcall_t req)
1355 /*char *req_str = NULL;*/
1356 XBT_INFO("**************************");
1357 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1358 XBT_INFO("**************************");
1359 XBT_INFO("Locked request:");
1360 /*req_str = MC_request_to_string(req);
1361 XBT_INFO("%s", req_str);
1362 xbt_free(req_str);*/
1363 XBT_INFO("Counter-example execution trace:");
1364 MC_dump_stack_safety(mc_stack_safety);
1365 MC_print_statistics(mc_stats);
1369 void MC_show_stack_liveness(xbt_fifo_t stack){
1372 xbt_fifo_item_t item;
1374 char *req_str = NULL;
1376 for (item = xbt_fifo_get_last_item(stack);
1377 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1378 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1379 req = MC_state_get_executed_request(pair->graph_state, &value);
1381 if(pair->requests>0){
1382 req_str = MC_request_to_string(req, value);
1383 XBT_INFO("%s", req_str);
1386 XBT_INFO("End of system requests but evolution in Büchi automaton");
1392 void MC_dump_stack_liveness(xbt_fifo_t stack){
1394 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1399 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1400 MC_pair_delete(pair);
1409 void MC_print_statistics(mc_stats_t stats)
1411 if(stats->expanded_pairs == 0){
1412 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1413 XBT_INFO("Visited states = %lu", stats->visited_states);
1415 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1416 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1418 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1420 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1421 fprintf(dot_output, "}\n");
1424 if(initial_state_safety != NULL){
1425 if(_sg_mc_comms_determinism)
1426 XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1427 if (_sg_mc_send_determinism)
1428 XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1433 void MC_assert(int prop)
1435 if (MC_is_active() && !prop){
1436 XBT_INFO("**************************");
1437 XBT_INFO("*** PROPERTY NOT VALID ***");
1438 XBT_INFO("**************************");
1439 XBT_INFO("Counter-example execution trace:");
1440 MC_dump_stack_safety(mc_stack_safety);
1441 MC_print_statistics(mc_stats);
1447 user_max_depth_reached = 1;
1450 void MC_process_clock_add(smx_process_t process, double amount)
1452 mc_time[process->pid] += amount;
1455 double MC_process_clock_get(smx_process_t process)
1459 return mc_time[process->pid];
1467 void MC_automaton_load(const char *file){
1469 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1473 if (_mc_property_automaton == NULL)
1474 _mc_property_automaton = xbt_automaton_new();
1476 xbt_automaton_load(_mc_property_automaton,file);
1485 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1487 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1491 if (_mc_property_automaton == NULL)
1492 _mc_property_automaton = xbt_automaton_new();
1494 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);