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) {
257 for(i=0; i!=mc_object_infos_size; ++i) {
258 if(ip >= (void*)mc_object_infos[i]->start_exec && ip <= (void*)mc_object_infos[i]->end_exec) {
259 return mc_object_infos[i];
265 static dw_frame_t MC_find_function_by_ip_and_object(void* ip, mc_object_info_t info) {
266 xbt_dynar_t dynar = info->functions_index;
267 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(dynar, 0);
269 int j = xbt_dynar_length(dynar) - 1;
271 int k = i + ((j-i)/2);
272 if(ip < base[k].low_pc) {
274 } else if(ip > base[k].high_pc) {
277 return base[k].function;
283 dw_frame_t MC_find_function_by_ip(void* ip) {
284 mc_object_info_t info = MC_ip_find_object_info(ip);
288 return MC_find_function_by_ip_and_object(ip, info);
291 static void MC_post_process_variables(mc_object_info_t info) {
293 dw_variable_t variable = NULL;
294 xbt_dynar_foreach(info->global_variables, cursor, variable) {
295 if(variable->type_origin) {
296 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
301 static void MC_post_process_functions(mc_object_info_t info) {
303 dw_frame_t function = NULL;
304 xbt_dynar_foreach(info->subprograms, cursor, function) {
305 unsigned cursor2 = 0;
306 dw_variable_t variable = NULL;
307 xbt_dynar_foreach(function->variables, cursor2, variable) {
308 if(variable->type_origin) {
309 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
315 /** \brief Finds informations about a given shared object/executable */
316 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
317 mc_object_info_t result = MC_new_object_info();
319 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
320 result->file_name = xbt_strdup(name);
321 MC_find_object_address(maps, result);
322 MC_dwarf_get_variables(result);
323 MC_post_process_types(result);
324 MC_post_process_variables(result);
325 MC_post_process_functions(result);
326 MC_make_functions_index(result);
330 /*************************************************************************/
332 /** \brief Finds a frame (DW_TAG_subprogram) from an DWARF offset in the rangd of this subprogram
334 * The offset can be an offset of a child DW_TAG_variable.
336 static dw_frame_t MC_dwarf_get_frame_by_offset(xbt_dict_t all_variables, unsigned long int offset){
338 xbt_dict_cursor_t cursor = NULL;
342 xbt_dict_foreach(all_variables, cursor, name, res) {
343 if(offset >= res->start && offset < res->end){
344 xbt_dict_cursor_free(&cursor);
349 xbt_dict_cursor_free(&cursor);
354 static dw_variable_t MC_dwarf_get_variable_by_name(dw_frame_t frame, char *var){
356 unsigned int cursor = 0;
357 dw_variable_t current_var;
359 xbt_dynar_foreach(frame->variables, cursor, current_var){
360 if(strcmp(var, current_var->name) == 0)
367 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
369 if(xbt_dynar_is_empty(variables))
372 unsigned int cursor = 0;
374 int end = xbt_dynar_length(variables) - 1;
375 dw_variable_t var_test = NULL;
378 cursor = (start + end) / 2;
379 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
380 if(strcmp(var_test->name, var) < 0){
382 }else if(strcmp(var_test->name, var) > 0){
385 if(address){ /* global variable */
386 if(var_test->address == address)
388 if(var_test->address > address)
392 }else{ /* local variable */
398 if(strcmp(var_test->name, var) == 0){
399 if(address && var_test->address < address)
403 }else if(strcmp(var_test->name, var) < 0)
410 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
411 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
413 xbt_dynar_insert_at(info->global_variables, index, &variable);
417 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
418 xbt_assert(frame, "Frame is NULL");
419 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
421 xbt_dynar_insert_at(frame->variables, index, &variable);
425 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
427 MC_dwarf_register_global_variable(info, variable);
429 xbt_die("No frame for this local variable");
431 MC_dwarf_register_non_global_variable(info, frame, variable);
435 /******************************* Ignore mechanism *******************************/
436 /*********************************************************************************/
438 xbt_dynar_t mc_checkpoint_ignore;
440 typedef struct s_mc_stack_ignore_variable{
443 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
445 /**************************** Free functions ******************************/
447 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
448 xbt_free(v->var_name);
453 static void stack_ignore_variable_free_voidp(void *v){
454 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
457 void heap_ignore_region_free(mc_heap_ignore_region_t r){
461 void heap_ignore_region_free_voidp(void *r){
462 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
465 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
469 static void checkpoint_ignore_region_free_voidp(void *r){
470 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
473 /***********************************************************************/
475 void MC_ignore_heap(void *address, size_t size){
477 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
481 mc_heap_ignore_region_t region = NULL;
482 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
483 region->address = address;
486 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
488 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
489 region->fragment = -1;
490 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
492 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
493 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
496 if(mc_heap_comparison_ignore == NULL){
497 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
498 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
504 unsigned int cursor = 0;
505 mc_heap_ignore_region_t current_region = NULL;
507 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
510 cursor = (start + end) / 2;
511 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
512 if(current_region->address == address){
513 heap_ignore_region_free(region);
517 }else if(current_region->address < address){
524 if(current_region->address < address)
525 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
527 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
533 void MC_remove_ignore_heap(void *address, size_t size){
535 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
539 unsigned int cursor = 0;
541 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
542 mc_heap_ignore_region_t region;
543 int ignore_found = 0;
546 cursor = (start + end) / 2;
547 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
548 if(region->address == address){
551 }else if(region->address < address){
554 if((char * )region->address <= ((char *)address + size)){
563 if(ignore_found == 1){
564 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
565 MC_remove_ignore_heap(address, size);
573 void MC_ignore_global_variable(const char *name){
575 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
579 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
581 unsigned int cursor = 0;
582 dw_variable_t current_var;
584 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
587 cursor = (start + end) /2;
588 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
589 if(strcmp(current_var->name, name) == 0){
590 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
592 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
593 }else if(strcmp(current_var->name, name) < 0){
604 static void MC_ignore_local_variable_in_object(const char *var_name, const char *frame_name, mc_object_info_t info) {
609 dw_variable_t current_var;
611 xbt_dynar_foreach(info->subprograms, cursor2, frame) {
613 if(frame_name && strcmp(frame_name, frame->name))
617 end = xbt_dynar_length(frame->variables) - 1;
619 cursor = (start + end) / 2;
620 current_var = (dw_variable_t)xbt_dynar_get_as(frame->variables, cursor, dw_variable_t);
622 int compare = strcmp(current_var->name, var_name);
624 xbt_dynar_remove_at(frame->variables, cursor, NULL);
626 end = xbt_dynar_length(frame->variables) - 1;
627 }else if(compare < 0){
636 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
638 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
640 if(strcmp(frame_name, "*") == 0)
645 MC_ignore_local_variable_in_object(var_name, frame_name, mc_libsimgrid_info);
647 MC_ignore_local_variable_in_object(var_name, frame_name, mc_binary_info);
654 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
656 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
660 if(stacks_areas == NULL)
661 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
663 stack_region_t region = NULL;
664 region = xbt_new0(s_stack_region_t, 1);
665 region->address = stack;
666 region->process_name = strdup(name);
667 region->context = context;
669 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
670 xbt_dynar_push(stacks_areas, ®ion);
676 void MC_ignore(void *addr, size_t size){
678 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
682 if(mc_checkpoint_ignore == NULL)
683 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
685 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
689 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
690 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
693 unsigned int cursor = 0;
695 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
696 mc_checkpoint_ignore_region_t current_region = NULL;
699 cursor = (start + end) / 2;
700 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
701 if(current_region->addr == addr){
702 if(current_region->size == size){
703 checkpoint_ignore_region_free(region);
707 }else if(current_region->size < size){
712 }else if(current_region->addr < addr){
719 if(current_region->addr == addr){
720 if(current_region->size < size){
721 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
723 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
725 }else if(current_region->addr < addr){
726 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
728 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
736 /******************************* Initialisation of MC *******************************/
737 /*********************************************************************************/
739 static void MC_post_process_object_info(mc_object_info_t info) {
740 xbt_dict_cursor_t cursor = NULL;
742 dw_type_t type = NULL;
743 xbt_dict_foreach(info->types, cursor, key, type){
745 // Resolve full_type:
746 if(type->name && type->byte_size == 0) {
747 for(size_t i=0; i!=mc_object_infos_size; ++i) {
748 dw_type_t same_type = xbt_dict_get_or_null(mc_object_infos[i]->full_types_by_name, type->name);
749 if(same_type && same_type->name && same_type->byte_size) {
750 type->full_type = same_type;
759 static void MC_init_debug_info(void) {
760 XBT_INFO("Get debug information ...");
762 memory_map_t maps = MC_get_memory_map();
764 /* Get local variables for state equality detection */
765 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
766 mc_object_infos[0] = mc_binary_info;
768 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
769 mc_object_infos[1] = mc_libsimgrid_info;
771 // Use information of the other objects:
772 MC_post_process_object_info(mc_binary_info);
773 MC_post_process_object_info(mc_libsimgrid_info);
775 MC_free_memory_map(maps);
776 XBT_INFO("Get debug information done !");
781 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
785 /* Initialize the data structures that must be persistent across every
786 iteration of the model-checker (in RAW memory) */
790 MC_init_memory_map_info();
791 MC_init_debug_info();
794 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
798 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
799 MC_ignore_local_variable("e", "*");
800 MC_ignore_local_variable("__ex_cleanup", "*");
801 MC_ignore_local_variable("__ex_mctx_en", "*");
802 MC_ignore_local_variable("__ex_mctx_me", "*");
803 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
804 MC_ignore_local_variable("_log_ev", "*");
805 MC_ignore_local_variable("_throw_ctx", "*");
806 MC_ignore_local_variable("ctx", "*");
808 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
809 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
810 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
812 /* Ignore local variable about time used for tracing */
813 MC_ignore_local_variable("start_time", "*");
815 MC_ignore_global_variable("compared_pointers");
816 MC_ignore_global_variable("mc_comp_times");
817 MC_ignore_global_variable("mc_snapshot_comparison_time");
818 MC_ignore_global_variable("mc_time");
819 MC_ignore_global_variable("smpi_current_rank");
820 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
821 MC_ignore_global_variable("maestro_stack_start");
822 MC_ignore_global_variable("maestro_stack_end");
823 MC_ignore_global_variable("smx_total_comms");
825 MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
826 MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
827 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
828 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
830 smx_process_t process;
831 xbt_swag_foreach(process, simix_global->process_list){
832 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
840 static void MC_init_dot_output(){ /* FIXME : more colors */
844 colors[2] = "green3";
845 colors[3] = "goldenrod";
847 colors[5] = "purple";
848 colors[6] = "magenta";
849 colors[7] = "turquoise4";
850 colors[8] = "gray25";
851 colors[9] = "forestgreen";
852 colors[10] = "hotpink";
853 colors[11] = "lightblue";
856 dot_output = fopen(_sg_mc_dot_output_file, "w");
858 if(dot_output == NULL){
859 perror("Error open dot output file");
863 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");
867 /******************************* Core of MC *******************************/
868 /**************************************************************************/
870 void MC_do_the_modelcheck_for_real() {
873 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
876 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
877 if (mc_reduce_kind==e_mc_reduce_unset)
878 mc_reduce_kind=e_mc_reduce_dpor;
880 XBT_INFO("Check a safety property");
881 MC_modelcheck_safety();
885 if (mc_reduce_kind==e_mc_reduce_unset)
886 mc_reduce_kind=e_mc_reduce_none;
888 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
889 MC_automaton_load(_sg_mc_property_file);
890 MC_modelcheck_liveness();
894 void MC_modelcheck_safety(void)
896 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
898 /* Check if MC is already initialized */
899 if (initial_state_safety)
902 mc_time = xbt_new0(double, simix_process_maxpid);
904 /* mc_time refers to clock for each process -> ignore it for heap comparison */
905 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
907 /* Initialize the data structures that must be persistent across every
908 iteration of the model-checker (in RAW memory) */
912 /* Initialize statistics */
913 mc_stats = xbt_new0(s_mc_stats_t, 1);
914 mc_stats->state_size = 1;
916 /* Create exploration stack */
917 mc_stack_safety = xbt_fifo_new();
919 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
920 MC_init_dot_output();
924 if(_sg_mc_visited > 0){
928 MC_init_memory_map_info();
929 MC_init_debug_info();
936 /* Save the initial state */
937 initial_state_safety = xbt_new0(s_mc_global_t, 1);
938 initial_state_safety->snapshot = MC_take_snapshot(0);
939 initial_state_safety->initial_communications_pattern_done = 0;
940 initial_state_safety->comm_deterministic = 1;
941 initial_state_safety->send_deterministic = 1;
953 void MC_modelcheck_liveness(){
955 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
959 mc_time = xbt_new0(double, simix_process_maxpid);
961 /* mc_time refers to clock for each process -> ignore it for heap comparison */
962 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
966 /* Initialize statistics */
967 mc_stats = xbt_new0(s_mc_stats_t, 1);
968 mc_stats->state_size = 1;
970 /* Create exploration stack */
971 mc_stack_liveness = xbt_fifo_new();
973 /* Create the initial state */
974 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
976 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
977 MC_init_dot_output();
984 MC_print_statistics(mc_stats);
1001 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
1003 return simcall->mc_value;
1007 int MC_random(int min, int max)
1009 /*FIXME: return mc_current_state->executed_transition->random.value;*/
1010 return simcall_mc_random(min, max);
1014 * \brief Schedules all the process that are ready to run
1016 void MC_wait_for_requests(void)
1018 smx_process_t process;
1022 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1023 SIMIX_process_runall();
1024 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1025 req = &process->simcall;
1026 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1027 SIMIX_simcall_pre(req, 0);
1032 int MC_deadlock_check()
1034 int deadlock = FALSE;
1035 smx_process_t process;
1036 if(xbt_swag_size(simix_global->process_list)){
1038 xbt_swag_foreach(process, simix_global->process_list){
1039 if(process->simcall.call != SIMCALL_NONE
1040 && MC_request_is_enabled(&process->simcall)){
1050 * \brief Re-executes from the state at position start all the transitions indicated by
1051 * a given model-checker stack.
1052 * \param stack The stack with the transitions to execute.
1053 * \param start Start index to begin the re-execution.
1055 void MC_replay(xbt_fifo_t stack, int start)
1057 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1059 int value, i = 1, count = 1;
1061 smx_simcall_t req = NULL, saved_req = NULL;
1062 xbt_fifo_item_t item, start_item;
1064 smx_process_t process = NULL;
1065 int comm_pattern = 0;
1067 XBT_DEBUG("**** Begin Replay ****");
1070 /* Restore the initial state */
1071 MC_restore_snapshot(initial_state_safety->snapshot);
1072 /* At the moment of taking the snapshot the raw heap was set, so restoring
1073 * it will set it back again, we have to unset it to continue */
1077 start_item = xbt_fifo_get_last_item(stack);
1080 start_item = xbt_fifo_get_prev_item(start_item);
1086 xbt_dict_reset(first_enabled_state);
1087 xbt_swag_foreach(process, simix_global->process_list){
1088 if(MC_process_is_enabled(process)){
1089 char *key = bprintf("%lu", process->pid);
1090 char *data = bprintf("%d", count);
1091 xbt_dict_set(first_enabled_state, key, data, NULL);
1095 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
1096 xbt_dynar_reset(communications_pattern);
1100 /* Traverse the stack from the state at position start and re-execute the transitions */
1101 for (item = start_item;
1102 item != xbt_fifo_get_first_item(stack);
1103 item = xbt_fifo_get_prev_item(item)) {
1105 state = (mc_state_t) xbt_fifo_get_item_content(item);
1106 saved_req = MC_state_get_executed_request(state, &value);
1109 char *key = bprintf("%lu", saved_req->issuer->pid);
1110 xbt_dict_remove(first_enabled_state, key);
1115 /* because we got a copy of the executed request, we have to fetch the
1116 real one, pointed by the request field of the issuer process */
1117 req = &saved_req->issuer->simcall;
1119 /* Debug information */
1120 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1121 req_str = MC_request_to_string(req, value);
1122 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1127 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1128 if(req->call == SIMCALL_COMM_ISEND)
1130 else if(req->call == SIMCALL_COMM_IRECV)
1134 SIMIX_simcall_pre(req, value);
1136 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1138 if(comm_pattern != 0){
1139 get_comm_pattern(communications_pattern, req, comm_pattern);
1145 MC_wait_for_requests();
1150 /* Insert in dict all enabled processes */
1151 xbt_swag_foreach(process, simix_global->process_list){
1152 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1153 char *key = bprintf("%lu", process->pid);
1154 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1155 char *data = bprintf("%d", count);
1156 xbt_dict_set(first_enabled_state, key, data, NULL);
1163 /* Update statistics */
1164 mc_stats->visited_states++;
1165 mc_stats->executed_transitions++;
1169 XBT_DEBUG("**** End Replay ****");
1179 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1182 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1186 smx_simcall_t req = NULL, saved_req = NULL;
1187 xbt_fifo_item_t item;
1192 XBT_DEBUG("**** Begin Replay ****");
1194 /* Restore the initial state */
1195 MC_restore_snapshot(initial_state_liveness->snapshot);
1197 /* At the moment of taking the snapshot the raw heap was set, so restoring
1198 * it will set it back again, we have to unset it to continue */
1199 if(!initial_state_liveness->raw_mem_set)
1204 item = xbt_fifo_get_last_item(stack);
1206 while(depth <= xbt_fifo_size(stack)){
1208 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1209 state = (mc_state_t) pair->graph_state;
1211 if(pair->requests > 0){
1213 saved_req = MC_state_get_executed_request(state, &value);
1214 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1216 if(saved_req != NULL){
1217 /* because we got a copy of the executed request, we have to fetch the
1218 real one, pointed by the request field of the issuer process */
1219 req = &saved_req->issuer->simcall;
1220 //XBT_DEBUG("Req->call %u", req->call);
1222 /* Debug information */
1223 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1224 req_str = MC_request_to_string(req, value);
1225 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1231 SIMIX_simcall_pre(req, value);
1232 MC_wait_for_requests();
1237 /* Update statistics */
1238 mc_stats->visited_pairs++;
1239 mc_stats->executed_transitions++;
1241 item = xbt_fifo_get_prev_item(item);
1246 /* Traverse the stack from the initial state and re-execute the transitions */
1247 for (item = xbt_fifo_get_last_item(stack);
1248 item != xbt_fifo_get_first_item(stack);
1249 item = xbt_fifo_get_prev_item(item)) {
1251 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1252 state = (mc_state_t) pair->graph_state;
1254 if(pair->requests > 0){
1256 saved_req = MC_state_get_executed_request(state, &value);
1257 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1259 if(saved_req != NULL){
1260 /* because we got a copy of the executed request, we have to fetch the
1261 real one, pointed by the request field of the issuer process */
1262 req = &saved_req->issuer->simcall;
1263 //XBT_DEBUG("Req->call %u", req->call);
1265 /* Debug information */
1266 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1267 req_str = MC_request_to_string(req, value);
1268 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1274 SIMIX_simcall_pre(req, value);
1275 MC_wait_for_requests();
1280 /* Update statistics */
1281 mc_stats->visited_pairs++;
1282 mc_stats->executed_transitions++;
1286 XBT_DEBUG("**** End Replay ****");
1288 if(initial_state_liveness->raw_mem_set)
1296 * \brief Dumps the contents of a model-checker's stack and shows the actual
1298 * \param stack The stack to dump
1300 void MC_dump_stack_safety(xbt_fifo_t stack)
1303 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1305 MC_show_stack_safety(stack);
1307 if(!_sg_mc_checkpoint){
1312 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1313 MC_state_delete(state);
1326 void MC_show_stack_safety(xbt_fifo_t stack)
1329 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1335 xbt_fifo_item_t item;
1337 char *req_str = NULL;
1339 for (item = xbt_fifo_get_last_item(stack);
1340 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1341 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1342 req = MC_state_get_executed_request(state, &value);
1344 req_str = MC_request_to_string(req, value);
1345 XBT_INFO("%s", req_str);
1354 void MC_show_deadlock(smx_simcall_t req)
1356 /*char *req_str = NULL;*/
1357 XBT_INFO("**************************");
1358 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1359 XBT_INFO("**************************");
1360 XBT_INFO("Locked request:");
1361 /*req_str = MC_request_to_string(req);
1362 XBT_INFO("%s", req_str);
1363 xbt_free(req_str);*/
1364 XBT_INFO("Counter-example execution trace:");
1365 MC_dump_stack_safety(mc_stack_safety);
1366 MC_print_statistics(mc_stats);
1370 void MC_show_stack_liveness(xbt_fifo_t stack){
1373 xbt_fifo_item_t item;
1375 char *req_str = NULL;
1377 for (item = xbt_fifo_get_last_item(stack);
1378 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1379 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1380 req = MC_state_get_executed_request(pair->graph_state, &value);
1382 if(pair->requests>0){
1383 req_str = MC_request_to_string(req, value);
1384 XBT_INFO("%s", req_str);
1387 XBT_INFO("End of system requests but evolution in Büchi automaton");
1393 void MC_dump_stack_liveness(xbt_fifo_t stack){
1395 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1400 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1401 MC_pair_delete(pair);
1410 void MC_print_statistics(mc_stats_t stats)
1412 if(stats->expanded_pairs == 0){
1413 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1414 XBT_INFO("Visited states = %lu", stats->visited_states);
1416 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1417 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1419 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1421 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1422 fprintf(dot_output, "}\n");
1425 if(initial_state_safety != NULL){
1426 if(_sg_mc_comms_determinism)
1427 XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1428 if (_sg_mc_send_determinism)
1429 XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1434 void MC_assert(int prop)
1436 if (MC_is_active() && !prop){
1437 XBT_INFO("**************************");
1438 XBT_INFO("*** PROPERTY NOT VALID ***");
1439 XBT_INFO("**************************");
1440 XBT_INFO("Counter-example execution trace:");
1441 MC_dump_stack_safety(mc_stack_safety);
1442 MC_print_statistics(mc_stats);
1448 user_max_depth_reached = 1;
1451 void MC_process_clock_add(smx_process_t process, double amount)
1453 mc_time[process->pid] += amount;
1456 double MC_process_clock_get(smx_process_t process)
1460 return mc_time[process->pid];
1468 void MC_automaton_load(const char *file){
1470 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1474 if (_mc_property_automaton == NULL)
1475 _mc_property_automaton = xbt_automaton_new();
1477 xbt_automaton_load(_mc_property_automaton,file);
1486 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1488 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1492 if (_mc_property_automaton == NULL)
1493 _mc_property_automaton = xbt_automaton_new();
1495 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);