1 /* Copyright (c) 2008-2014. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
13 #include "simgrid/sg_config.h"
14 #include "../surf/surf_private.h"
15 #include "../simix/smx_private.h"
16 #include "../xbt/mmalloc/mmprivate.h"
18 #include "mc_private.h"
19 #include "xbt/automaton.h"
22 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
24 "Logging specific to MC (global)");
26 /* Configuration support */
27 e_mc_reduce_t mc_reduce_kind=e_mc_reduce_unset;
29 int _sg_do_model_check = 0;
30 int _sg_mc_checkpoint=0;
31 char* _sg_mc_property_file=NULL;
34 int _sg_mc_max_depth=1000;
36 char *_sg_mc_dot_output_file = NULL;
37 int _sg_mc_comms_determinism=0;
38 int _sg_mc_send_determinism=0;
40 int user_max_depth_reached = 0;
42 void _mc_cfg_cb_reduce(const char *name, int pos) {
43 if (_sg_cfg_init_status && !_sg_do_model_check) {
44 xbt_die("You are specifying a reduction strategy after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
46 char *val= xbt_cfg_get_string(_sg_cfg_set, name);
47 if (!strcasecmp(val,"none")) {
48 mc_reduce_kind = e_mc_reduce_none;
49 } else if (!strcasecmp(val,"dpor")) {
50 mc_reduce_kind = e_mc_reduce_dpor;
52 xbt_die("configuration option %s can only take 'none' or 'dpor' as a value",name);
56 void _mc_cfg_cb_checkpoint(const char *name, int pos) {
57 if (_sg_cfg_init_status && !_sg_do_model_check) {
58 xbt_die("You are specifying a checkpointing value after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
60 _sg_mc_checkpoint = xbt_cfg_get_int(_sg_cfg_set, name);
62 void _mc_cfg_cb_property(const char *name, int pos) {
63 if (_sg_cfg_init_status && !_sg_do_model_check) {
64 xbt_die("You are specifying a property after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
66 _sg_mc_property_file= xbt_cfg_get_string(_sg_cfg_set, name);
69 void _mc_cfg_cb_timeout(const char *name, int pos) {
70 if (_sg_cfg_init_status && !_sg_do_model_check) {
71 xbt_die("You are specifying a value to enable/disable timeout for wait requests after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
73 _sg_mc_timeout= xbt_cfg_get_boolean(_sg_cfg_set, name);
76 void _mc_cfg_cb_hash(const char *name, int pos) {
77 if (_sg_cfg_init_status && !_sg_do_model_check) {
78 xbt_die("You are specifying a value to enable/disable the use of global hash to speedup state comparaison, but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
80 _sg_mc_hash= xbt_cfg_get_boolean(_sg_cfg_set, name);
83 void _mc_cfg_cb_max_depth(const char *name, int pos) {
84 if (_sg_cfg_init_status && !_sg_do_model_check) {
85 xbt_die("You are specifying a max depth value after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
87 _sg_mc_max_depth= xbt_cfg_get_int(_sg_cfg_set, name);
90 void _mc_cfg_cb_visited(const char *name, int pos) {
91 if (_sg_cfg_init_status && !_sg_do_model_check) {
92 xbt_die("You are specifying a number of stored visited states after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
94 _sg_mc_visited= xbt_cfg_get_int(_sg_cfg_set, name);
97 void _mc_cfg_cb_dot_output(const char *name, int pos) {
98 if (_sg_cfg_init_status && !_sg_do_model_check) {
99 xbt_die("You are specifying a file name for a dot output of graph state after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
101 _sg_mc_dot_output_file= xbt_cfg_get_string(_sg_cfg_set, name);
104 void _mc_cfg_cb_comms_determinism(const char *name, int pos) {
105 if (_sg_cfg_init_status && !_sg_do_model_check) {
106 xbt_die("You are specifying a value to enable/disable the detection of determinism in the communications schemes after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
108 _sg_mc_comms_determinism= xbt_cfg_get_boolean(_sg_cfg_set, name);
111 void _mc_cfg_cb_send_determinism(const char *name, int pos) {
112 if (_sg_cfg_init_status && !_sg_do_model_check) {
113 xbt_die("You are specifying a value to enable/disable the detection of send-determinism in the communications schemes after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
115 _sg_mc_send_determinism= xbt_cfg_get_boolean(_sg_cfg_set, name);
118 /* MC global data structures */
119 mc_state_t mc_current_state = NULL;
120 char mc_replay_mode = FALSE;
121 double *mc_time = NULL;
122 __thread mc_comparison_times_t mc_comp_times = NULL;
123 __thread double mc_snapshot_comparison_time;
124 mc_stats_t mc_stats = NULL;
127 xbt_fifo_t mc_stack_safety = NULL;
128 mc_global_t initial_state_safety = NULL;
131 xbt_fifo_t mc_stack_liveness = NULL;
132 mc_global_t initial_state_liveness = NULL;
135 xbt_automaton_t _mc_property_automaton = NULL;
138 mc_object_info_t mc_libsimgrid_info = NULL;
139 mc_object_info_t mc_binary_info = NULL;
141 mc_object_info_t mc_object_infos[2] = { NULL, NULL };
142 size_t mc_object_infos_size = 2;
144 /* Ignore mechanism */
145 extern xbt_dynar_t mc_heap_comparison_ignore;
146 extern xbt_dynar_t stacks_areas;
149 FILE *dot_output = NULL;
150 const char* colors[13];
153 /******************************* DWARF Information *******************************/
154 /**********************************************************************************/
156 /************************** Free functions *************************/
158 void mc_frame_free(dw_frame_t frame){
159 xbt_free(frame->name);
160 mc_dwarf_location_list_clear(&(frame->frame_base));
161 xbt_dynar_free(&(frame->variables));
162 xbt_dynar_free(&(frame->scopes));
166 void dw_type_free(dw_type_t t){
168 xbt_free(t->dw_type_id);
169 xbt_dynar_free(&(t->members));
170 mc_dwarf_expression_clear(&t->location);
174 void dw_variable_free(dw_variable_t v){
177 xbt_free(v->type_origin);
179 if(v->locations.locations)
180 mc_dwarf_location_list_clear(&v->locations);
185 void dw_variable_free_voidp(void *t){
186 dw_variable_free((dw_variable_t) * (void **) t);
193 mc_object_info_t MC_new_object_info(void) {
194 mc_object_info_t res = xbt_new0(s_mc_object_info_t, 1);
195 res->subprograms = xbt_dict_new_homogeneous((void (*)(void*))mc_frame_free);
196 res->global_variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
197 res->types = xbt_dict_new_homogeneous((void (*)(void*))dw_type_free);
198 res->full_types_by_name = xbt_dict_new_homogeneous(NULL);
202 void MC_free_object_info(mc_object_info_t* info) {
203 xbt_free(&(*info)->file_name);
204 xbt_dict_free(&(*info)->subprograms);
205 xbt_dynar_free(&(*info)->global_variables);
206 xbt_dict_free(&(*info)->types);
207 xbt_dict_free(&(*info)->full_types_by_name);
209 xbt_dynar_free(&(*info)->functions_index);
215 void* MC_object_base_address(mc_object_info_t info) {
216 void* result = info->start_exec;
217 if(info->start_rw!=NULL && result > (void*) info->start_rw) result = info->start_rw;
218 if(info->start_ro!=NULL && result > (void*) info->start_ro) result = info->start_ro;
222 // ***** Functions index
224 static int MC_compare_frame_index_items(mc_function_index_item_t a, mc_function_index_item_t b) {
225 if(a->low_pc < b->low_pc)
227 else if(a->low_pc == b->low_pc)
233 static void MC_make_functions_index(mc_object_info_t info) {
234 xbt_dynar_t index = xbt_dynar_new(sizeof(s_mc_function_index_item_t), NULL);
236 // Populate the array:
237 dw_frame_t frame = NULL;
238 xbt_dict_cursor_t cursor;
240 xbt_dict_foreach(info->subprograms, cursor, key, frame) {
241 if(frame->low_pc==NULL)
243 s_mc_function_index_item_t entry;
244 entry.low_pc = frame->low_pc;
245 entry.high_pc = frame->high_pc;
246 entry.function = frame;
247 xbt_dynar_push(index, &entry);
250 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(index, 0);
252 // Sort the array by low_pc:
254 xbt_dynar_length(index),
255 sizeof(s_mc_function_index_item_t),
256 (int (*)(const void *, const void *))MC_compare_frame_index_items);
258 info->functions_index = index;
261 mc_object_info_t MC_ip_find_object_info(void* ip) {
263 for(i=0; i!=mc_object_infos_size; ++i) {
264 if(ip >= (void*)mc_object_infos[i]->start_exec && ip <= (void*)mc_object_infos[i]->end_exec) {
265 return mc_object_infos[i];
271 static dw_frame_t MC_find_function_by_ip_and_object(void* ip, mc_object_info_t info) {
272 xbt_dynar_t dynar = info->functions_index;
273 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(dynar, 0);
275 int j = xbt_dynar_length(dynar) - 1;
277 int k = i + ((j-i)/2);
278 if(ip < base[k].low_pc) {
280 } else if(ip >= base[k].high_pc) {
283 return base[k].function;
289 dw_frame_t MC_find_function_by_ip(void* ip) {
290 mc_object_info_t info = MC_ip_find_object_info(ip);
294 return MC_find_function_by_ip_and_object(ip, info);
297 static void MC_post_process_variables(mc_object_info_t info) {
299 dw_variable_t variable = NULL;
300 xbt_dynar_foreach(info->global_variables, cursor, variable) {
301 if(variable->type_origin) {
302 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
307 static void mc_post_process_scope(mc_object_info_t info, dw_frame_t scope) {
309 if(scope->tag == DW_TAG_inlined_subroutine) {
311 // Attach correct namespaced name in inlined subroutine:
312 char* key = bprintf("%" PRIx64, (uint64_t) scope->abstract_origin_id);
313 dw_frame_t abstract_origin = xbt_dict_get_or_null(info->subprograms, key);
314 xbt_assert(abstract_origin, "Could not lookup abstract origin %s", key);
316 scope->name = xbt_strdup(abstract_origin->name);
322 dw_variable_t variable = NULL;
323 xbt_dynar_foreach(scope->variables, cursor, variable) {
324 if(variable->type_origin) {
325 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
329 // Recursive post-processing of nested-scopes:
330 dw_frame_t nested_scope = NULL;
331 xbt_dynar_foreach(scope->scopes, cursor, nested_scope)
332 mc_post_process_scope(info, nested_scope);
336 static void MC_post_process_functions(mc_object_info_t info) {
337 xbt_dict_cursor_t cursor;
339 dw_frame_t subprogram = NULL;
340 xbt_dict_foreach(info->subprograms, cursor, key, subprogram) {
341 mc_post_process_scope(info, subprogram);
345 /** \brief Finds informations about a given shared object/executable */
346 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
347 mc_object_info_t result = MC_new_object_info();
349 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
350 result->file_name = xbt_strdup(name);
351 MC_find_object_address(maps, result);
352 MC_dwarf_get_variables(result);
353 MC_post_process_types(result);
354 MC_post_process_variables(result);
355 MC_post_process_functions(result);
356 MC_make_functions_index(result);
360 /*************************************************************************/
362 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
364 if(xbt_dynar_is_empty(variables))
367 unsigned int cursor = 0;
369 int end = xbt_dynar_length(variables) - 1;
370 dw_variable_t var_test = NULL;
373 cursor = (start + end) / 2;
374 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
375 if(strcmp(var_test->name, var) < 0){
377 }else if(strcmp(var_test->name, var) > 0){
380 if(address){ /* global variable */
381 if(var_test->address == address)
383 if(var_test->address > address)
387 }else{ /* local variable */
393 if(strcmp(var_test->name, var) == 0){
394 if(address && var_test->address < address)
398 }else if(strcmp(var_test->name, var) < 0)
405 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
406 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
408 xbt_dynar_insert_at(info->global_variables, index, &variable);
412 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
413 xbt_assert(frame, "Frame is NULL");
414 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
416 xbt_dynar_insert_at(frame->variables, index, &variable);
420 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
422 MC_dwarf_register_global_variable(info, variable);
424 xbt_die("No frame for this local variable");
426 MC_dwarf_register_non_global_variable(info, frame, variable);
430 /******************************* Ignore mechanism *******************************/
431 /*********************************************************************************/
433 xbt_dynar_t mc_checkpoint_ignore;
435 typedef struct s_mc_stack_ignore_variable{
438 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
440 /**************************** Free functions ******************************/
442 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
443 xbt_free(v->var_name);
448 static void stack_ignore_variable_free_voidp(void *v){
449 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
452 void heap_ignore_region_free(mc_heap_ignore_region_t r){
456 void heap_ignore_region_free_voidp(void *r){
457 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
460 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
464 static void checkpoint_ignore_region_free_voidp(void *r){
465 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
468 /***********************************************************************/
470 void MC_ignore_heap(void *address, size_t size){
472 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
476 mc_heap_ignore_region_t region = NULL;
477 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
478 region->address = address;
481 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
483 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
484 region->fragment = -1;
485 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
487 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
488 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
491 if(mc_heap_comparison_ignore == NULL){
492 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
493 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
499 unsigned int cursor = 0;
500 mc_heap_ignore_region_t current_region = NULL;
502 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
505 cursor = (start + end) / 2;
506 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
507 if(current_region->address == address){
508 heap_ignore_region_free(region);
512 }else if(current_region->address < address){
519 if(current_region->address < address)
520 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
522 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
528 void MC_remove_ignore_heap(void *address, size_t size){
530 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
534 unsigned int cursor = 0;
536 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
537 mc_heap_ignore_region_t region;
538 int ignore_found = 0;
541 cursor = (start + end) / 2;
542 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
543 if(region->address == address){
546 }else if(region->address < address){
549 if((char * )region->address <= ((char *)address + size)){
558 if(ignore_found == 1){
559 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
560 MC_remove_ignore_heap(address, size);
568 void MC_ignore_global_variable(const char *name){
570 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
574 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
576 unsigned int cursor = 0;
577 dw_variable_t current_var;
579 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
582 cursor = (start + end) /2;
583 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
584 if(strcmp(current_var->name, name) == 0){
585 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
587 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
588 }else if(strcmp(current_var->name, name) < 0){
599 /** \brief Ignore a local variable in a scope
601 * Ignore all instances of variables with a given name in
602 * any (possibly inlined) subprogram with a given namespaced
605 * \param var_name Name of the local variable (or parameter to ignore)
606 * \param subprogram_name Name of the subprogram fo ignore (NULL for any)
607 * \param subprogram (possibly inlined) Subprogram of the scope
608 * \param scope Current scope
610 static void mc_ignore_local_variable_in_scope(
611 const char *var_name, const char *subprogram_name,
612 dw_frame_t subprogram, dw_frame_t scope) {
613 // Processing of direct variables:
615 // If the current subprogram matche the given name:
616 if(subprogram_name==NULL || strcmp(subprogram_name, subprogram->name)==0) {
618 // Try to find the variable and remove it:
620 int end = xbt_dynar_length(scope->variables) - 1;
622 // Dichotomic search:
624 int cursor = (start + end) / 2;
625 dw_variable_t current_var = (dw_variable_t)xbt_dynar_get_as(scope->variables, cursor, dw_variable_t);
627 int compare = strcmp(current_var->name, var_name);
629 // Variable found, remove it:
630 xbt_dynar_remove_at(scope->variables, cursor, NULL);
634 end = xbt_dynar_length(scope->variables) - 1;
635 }else if(compare < 0){
644 // And recursive processing in nested scopes:
646 dw_frame_t nested_scope = NULL;
647 xbt_dynar_foreach(scope->scopes, cursor, nested_scope) {
648 // The new scope may be an inlined subroutine, in this case we want to use its
649 // namespaced name in recursive calls:
650 dw_frame_t nested_subprogram = nested_scope->tag == DW_TAG_inlined_subroutine ? nested_scope : subprogram;
652 mc_ignore_local_variable_in_scope(var_name, subprogram_name, nested_subprogram, nested_scope);
656 static void MC_ignore_local_variable_in_object(const char *var_name, const char *subprogram_name, mc_object_info_t info) {
657 xbt_dict_cursor_t cursor2;
660 xbt_dict_foreach(info->subprograms, cursor2, key, frame) {
661 mc_ignore_local_variable_in_scope(var_name, subprogram_name, frame, frame);
665 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
667 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
669 if(strcmp(frame_name, "*") == 0)
674 MC_ignore_local_variable_in_object(var_name, frame_name, mc_libsimgrid_info);
676 MC_ignore_local_variable_in_object(var_name, frame_name, mc_binary_info);
683 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
685 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
689 if(stacks_areas == NULL)
690 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
692 stack_region_t region = NULL;
693 region = xbt_new0(s_stack_region_t, 1);
694 region->address = stack;
695 region->process_name = strdup(name);
696 region->context = context;
698 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
699 xbt_dynar_push(stacks_areas, ®ion);
705 void MC_ignore(void *addr, size_t size){
707 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
711 if(mc_checkpoint_ignore == NULL)
712 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
714 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
718 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
719 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
722 unsigned int cursor = 0;
724 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
725 mc_checkpoint_ignore_region_t current_region = NULL;
728 cursor = (start + end) / 2;
729 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
730 if(current_region->addr == addr){
731 if(current_region->size == size){
732 checkpoint_ignore_region_free(region);
736 }else if(current_region->size < size){
741 }else if(current_region->addr < addr){
748 if(current_region->addr == addr){
749 if(current_region->size < size){
750 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
752 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
754 }else if(current_region->addr < addr){
755 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
757 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
765 /******************************* Initialisation of MC *******************************/
766 /*********************************************************************************/
768 static void MC_post_process_object_info(mc_object_info_t info) {
769 xbt_dict_cursor_t cursor = NULL;
771 dw_type_t type = NULL;
772 xbt_dict_foreach(info->types, cursor, key, type){
774 // Resolve full_type:
775 if(type->name && type->byte_size == 0) {
776 for(size_t i=0; i!=mc_object_infos_size; ++i) {
777 dw_type_t same_type = xbt_dict_get_or_null(mc_object_infos[i]->full_types_by_name, type->name);
778 if(same_type && same_type->name && same_type->byte_size) {
779 type->full_type = same_type;
788 static void MC_init_debug_info(void) {
789 XBT_INFO("Get debug information ...");
791 memory_map_t maps = MC_get_memory_map();
793 /* Get local variables for state equality detection */
794 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
795 mc_object_infos[0] = mc_binary_info;
797 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
798 mc_object_infos[1] = mc_libsimgrid_info;
800 // Use information of the other objects:
801 MC_post_process_object_info(mc_binary_info);
802 MC_post_process_object_info(mc_libsimgrid_info);
804 MC_free_memory_map(maps);
805 XBT_INFO("Get debug information done !");
810 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
814 /* Initialize the data structures that must be persistent across every
815 iteration of the model-checker (in RAW memory) */
819 MC_init_memory_map_info();
820 MC_init_debug_info();
823 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
827 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
828 MC_ignore_local_variable("e", "*");
829 MC_ignore_local_variable("__ex_cleanup", "*");
830 MC_ignore_local_variable("__ex_mctx_en", "*");
831 MC_ignore_local_variable("__ex_mctx_me", "*");
832 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
833 MC_ignore_local_variable("_log_ev", "*");
834 MC_ignore_local_variable("_throw_ctx", "*");
835 MC_ignore_local_variable("ctx", "*");
837 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
838 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
839 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
841 /* Ignore local variable about time used for tracing */
842 MC_ignore_local_variable("start_time", "*");
844 MC_ignore_global_variable("compared_pointers");
845 MC_ignore_global_variable("mc_comp_times");
846 MC_ignore_global_variable("mc_snapshot_comparison_time");
847 MC_ignore_global_variable("mc_time");
848 MC_ignore_global_variable("smpi_current_rank");
849 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
850 MC_ignore_global_variable("maestro_stack_start");
851 MC_ignore_global_variable("maestro_stack_end");
852 MC_ignore_global_variable("smx_total_comms");
854 MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
855 MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
856 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
857 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
859 smx_process_t process;
860 xbt_swag_foreach(process, simix_global->process_list){
861 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
869 static void MC_init_dot_output(){ /* FIXME : more colors */
873 colors[2] = "green3";
874 colors[3] = "goldenrod";
876 colors[5] = "purple";
877 colors[6] = "magenta";
878 colors[7] = "turquoise4";
879 colors[8] = "gray25";
880 colors[9] = "forestgreen";
881 colors[10] = "hotpink";
882 colors[11] = "lightblue";
885 dot_output = fopen(_sg_mc_dot_output_file, "w");
887 if(dot_output == NULL){
888 perror("Error open dot output file");
892 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");
896 /******************************* Core of MC *******************************/
897 /**************************************************************************/
899 void MC_do_the_modelcheck_for_real() {
902 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
905 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
906 if (mc_reduce_kind==e_mc_reduce_unset)
907 mc_reduce_kind=e_mc_reduce_dpor;
909 XBT_INFO("Check a safety property");
910 MC_modelcheck_safety();
914 if (mc_reduce_kind==e_mc_reduce_unset)
915 mc_reduce_kind=e_mc_reduce_none;
917 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
918 MC_automaton_load(_sg_mc_property_file);
919 MC_modelcheck_liveness();
923 void MC_modelcheck_safety(void)
925 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
927 /* Check if MC is already initialized */
928 if (initial_state_safety)
931 mc_time = xbt_new0(double, simix_process_maxpid);
933 /* mc_time refers to clock for each process -> ignore it for heap comparison */
934 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
936 /* Initialize the data structures that must be persistent across every
937 iteration of the model-checker (in RAW memory) */
941 /* Initialize statistics */
942 mc_stats = xbt_new0(s_mc_stats_t, 1);
943 mc_stats->state_size = 1;
945 /* Create exploration stack */
946 mc_stack_safety = xbt_fifo_new();
948 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
949 MC_init_dot_output();
953 if(_sg_mc_visited > 0){
957 MC_init_memory_map_info();
958 MC_init_debug_info();
965 /* Save the initial state */
966 initial_state_safety = xbt_new0(s_mc_global_t, 1);
967 initial_state_safety->snapshot = MC_take_snapshot(0);
968 initial_state_safety->initial_communications_pattern_done = 0;
969 initial_state_safety->comm_deterministic = 1;
970 initial_state_safety->send_deterministic = 1;
982 void MC_modelcheck_liveness(){
984 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
988 mc_time = xbt_new0(double, simix_process_maxpid);
990 /* mc_time refers to clock for each process -> ignore it for heap comparison */
991 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
995 /* Initialize statistics */
996 mc_stats = xbt_new0(s_mc_stats_t, 1);
997 mc_stats->state_size = 1;
999 /* Create exploration stack */
1000 mc_stack_liveness = xbt_fifo_new();
1002 /* Create the initial state */
1003 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
1005 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
1006 MC_init_dot_output();
1013 MC_print_statistics(mc_stats);
1030 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
1032 return simcall->mc_value;
1036 int MC_random(int min, int max)
1038 /*FIXME: return mc_current_state->executed_transition->random.value;*/
1039 return simcall_mc_random(min, max);
1043 * \brief Schedules all the process that are ready to run
1045 void MC_wait_for_requests(void)
1047 smx_process_t process;
1051 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1052 SIMIX_process_runall();
1053 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1054 req = &process->simcall;
1055 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1056 SIMIX_simcall_pre(req, 0);
1061 int MC_deadlock_check()
1063 int deadlock = FALSE;
1064 smx_process_t process;
1065 if(xbt_swag_size(simix_global->process_list)){
1067 xbt_swag_foreach(process, simix_global->process_list){
1068 if(process->simcall.call != SIMCALL_NONE
1069 && MC_request_is_enabled(&process->simcall)){
1079 * \brief Re-executes from the state at position start all the transitions indicated by
1080 * a given model-checker stack.
1081 * \param stack The stack with the transitions to execute.
1082 * \param start Start index to begin the re-execution.
1084 void MC_replay(xbt_fifo_t stack, int start)
1086 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1088 int value, i = 1, count = 1;
1090 smx_simcall_t req = NULL, saved_req = NULL;
1091 xbt_fifo_item_t item, start_item;
1093 smx_process_t process = NULL;
1094 int comm_pattern = 0;
1096 XBT_DEBUG("**** Begin Replay ****");
1099 /* Restore the initial state */
1100 MC_restore_snapshot(initial_state_safety->snapshot);
1101 /* At the moment of taking the snapshot the raw heap was set, so restoring
1102 * it will set it back again, we have to unset it to continue */
1106 start_item = xbt_fifo_get_last_item(stack);
1109 start_item = xbt_fifo_get_prev_item(start_item);
1115 xbt_dict_reset(first_enabled_state);
1116 xbt_swag_foreach(process, simix_global->process_list){
1117 if(MC_process_is_enabled(process)){
1118 char *key = bprintf("%lu", process->pid);
1119 char *data = bprintf("%d", count);
1120 xbt_dict_set(first_enabled_state, key, data, NULL);
1124 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
1125 xbt_dynar_reset(communications_pattern);
1129 /* Traverse the stack from the state at position start and re-execute the transitions */
1130 for (item = start_item;
1131 item != xbt_fifo_get_first_item(stack);
1132 item = xbt_fifo_get_prev_item(item)) {
1134 state = (mc_state_t) xbt_fifo_get_item_content(item);
1135 saved_req = MC_state_get_executed_request(state, &value);
1138 char *key = bprintf("%lu", saved_req->issuer->pid);
1139 xbt_dict_remove(first_enabled_state, key);
1144 /* because we got a copy of the executed request, we have to fetch the
1145 real one, pointed by the request field of the issuer process */
1146 req = &saved_req->issuer->simcall;
1148 /* Debug information */
1149 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1150 req_str = MC_request_to_string(req, value);
1151 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1156 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1157 if(req->call == SIMCALL_COMM_ISEND)
1159 else if(req->call == SIMCALL_COMM_IRECV)
1163 SIMIX_simcall_pre(req, value);
1165 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1167 if(comm_pattern != 0){
1168 get_comm_pattern(communications_pattern, req, comm_pattern);
1174 MC_wait_for_requests();
1179 /* Insert in dict all enabled processes */
1180 xbt_swag_foreach(process, simix_global->process_list){
1181 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1182 char *key = bprintf("%lu", process->pid);
1183 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1184 char *data = bprintf("%d", count);
1185 xbt_dict_set(first_enabled_state, key, data, NULL);
1192 /* Update statistics */
1193 mc_stats->visited_states++;
1194 mc_stats->executed_transitions++;
1198 XBT_DEBUG("**** End Replay ****");
1208 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1211 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1215 smx_simcall_t req = NULL, saved_req = NULL;
1216 xbt_fifo_item_t item;
1221 XBT_DEBUG("**** Begin Replay ****");
1223 /* Restore the initial state */
1224 MC_restore_snapshot(initial_state_liveness->snapshot);
1226 /* At the moment of taking the snapshot the raw heap was set, so restoring
1227 * it will set it back again, we have to unset it to continue */
1228 if(!initial_state_liveness->raw_mem_set)
1233 item = xbt_fifo_get_last_item(stack);
1235 while(depth <= xbt_fifo_size(stack)){
1237 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1238 state = (mc_state_t) pair->graph_state;
1240 if(pair->requests > 0){
1242 saved_req = MC_state_get_executed_request(state, &value);
1243 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1245 if(saved_req != NULL){
1246 /* because we got a copy of the executed request, we have to fetch the
1247 real one, pointed by the request field of the issuer process */
1248 req = &saved_req->issuer->simcall;
1249 //XBT_DEBUG("Req->call %u", req->call);
1251 /* Debug information */
1252 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1253 req_str = MC_request_to_string(req, value);
1254 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1260 SIMIX_simcall_pre(req, value);
1261 MC_wait_for_requests();
1266 /* Update statistics */
1267 mc_stats->visited_pairs++;
1268 mc_stats->executed_transitions++;
1270 item = xbt_fifo_get_prev_item(item);
1275 /* Traverse the stack from the initial state and re-execute the transitions */
1276 for (item = xbt_fifo_get_last_item(stack);
1277 item != xbt_fifo_get_first_item(stack);
1278 item = xbt_fifo_get_prev_item(item)) {
1280 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1281 state = (mc_state_t) pair->graph_state;
1283 if(pair->requests > 0){
1285 saved_req = MC_state_get_executed_request(state, &value);
1286 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1288 if(saved_req != NULL){
1289 /* because we got a copy of the executed request, we have to fetch the
1290 real one, pointed by the request field of the issuer process */
1291 req = &saved_req->issuer->simcall;
1292 //XBT_DEBUG("Req->call %u", req->call);
1294 /* Debug information */
1295 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1296 req_str = MC_request_to_string(req, value);
1297 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1303 SIMIX_simcall_pre(req, value);
1304 MC_wait_for_requests();
1309 /* Update statistics */
1310 mc_stats->visited_pairs++;
1311 mc_stats->executed_transitions++;
1315 XBT_DEBUG("**** End Replay ****");
1317 if(initial_state_liveness->raw_mem_set)
1325 * \brief Dumps the contents of a model-checker's stack and shows the actual
1327 * \param stack The stack to dump
1329 void MC_dump_stack_safety(xbt_fifo_t stack)
1332 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1334 MC_show_stack_safety(stack);
1336 if(!_sg_mc_checkpoint){
1341 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1342 MC_state_delete(state);
1355 void MC_show_stack_safety(xbt_fifo_t stack)
1358 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1364 xbt_fifo_item_t item;
1366 char *req_str = NULL;
1368 for (item = xbt_fifo_get_last_item(stack);
1369 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1370 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1371 req = MC_state_get_executed_request(state, &value);
1373 req_str = MC_request_to_string(req, value);
1374 XBT_INFO("%s", req_str);
1383 void MC_show_deadlock(smx_simcall_t req)
1385 /*char *req_str = NULL;*/
1386 XBT_INFO("**************************");
1387 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1388 XBT_INFO("**************************");
1389 XBT_INFO("Locked request:");
1390 /*req_str = MC_request_to_string(req);
1391 XBT_INFO("%s", req_str);
1392 xbt_free(req_str);*/
1393 XBT_INFO("Counter-example execution trace:");
1394 MC_dump_stack_safety(mc_stack_safety);
1395 MC_print_statistics(mc_stats);
1399 void MC_show_stack_liveness(xbt_fifo_t stack){
1402 xbt_fifo_item_t item;
1404 char *req_str = NULL;
1406 for (item = xbt_fifo_get_last_item(stack);
1407 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1408 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1409 req = MC_state_get_executed_request(pair->graph_state, &value);
1411 if(pair->requests>0){
1412 req_str = MC_request_to_string(req, value);
1413 XBT_INFO("%s", req_str);
1416 XBT_INFO("End of system requests but evolution in Büchi automaton");
1422 void MC_dump_stack_liveness(xbt_fifo_t stack){
1424 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1429 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1430 MC_pair_delete(pair);
1439 void MC_print_statistics(mc_stats_t stats)
1441 if(stats->expanded_pairs == 0){
1442 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1443 XBT_INFO("Visited states = %lu", stats->visited_states);
1445 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1446 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1448 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1450 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1451 fprintf(dot_output, "}\n");
1454 if(initial_state_safety != NULL){
1455 if(_sg_mc_comms_determinism)
1456 XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1457 if (_sg_mc_send_determinism)
1458 XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1463 void MC_assert(int prop)
1465 if (MC_is_active() && !prop){
1466 XBT_INFO("**************************");
1467 XBT_INFO("*** PROPERTY NOT VALID ***");
1468 XBT_INFO("**************************");
1469 XBT_INFO("Counter-example execution trace:");
1470 MC_dump_stack_safety(mc_stack_safety);
1471 MC_print_statistics(mc_stats);
1477 user_max_depth_reached = 1;
1480 void MC_process_clock_add(smx_process_t process, double amount)
1482 mc_time[process->pid] += amount;
1485 double MC_process_clock_get(smx_process_t process)
1489 return mc_time[process->pid];
1497 void MC_automaton_load(const char *file){
1499 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1503 if (_mc_property_automaton == NULL)
1504 _mc_property_automaton = xbt_automaton_new();
1506 xbt_automaton_load(_mc_property_automaton,file);
1515 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1517 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1521 if (_mc_property_automaton == NULL)
1522 _mc_property_automaton = xbt_automaton_new();
1524 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);