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 if(info->flags & MC_OBJECT_INFO_EXECUTABLE)
218 void* result = info->start_exec;
219 if(info->start_rw!=NULL && result > (void*) info->start_rw) result = info->start_rw;
220 if(info->start_ro!=NULL && result > (void*) info->start_ro) result = info->start_ro;
224 // ***** Functions index
226 static int MC_compare_frame_index_items(mc_function_index_item_t a, mc_function_index_item_t b) {
227 if(a->low_pc < b->low_pc)
229 else if(a->low_pc == b->low_pc)
235 static void MC_make_functions_index(mc_object_info_t info) {
236 xbt_dynar_t index = xbt_dynar_new(sizeof(s_mc_function_index_item_t), NULL);
238 // Populate the array:
239 dw_frame_t frame = NULL;
240 xbt_dict_cursor_t cursor;
242 xbt_dict_foreach(info->subprograms, cursor, key, frame) {
243 if(frame->low_pc==NULL)
245 s_mc_function_index_item_t entry;
246 entry.low_pc = frame->low_pc;
247 entry.high_pc = frame->high_pc;
248 entry.function = frame;
249 xbt_dynar_push(index, &entry);
252 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(index, 0);
254 // Sort the array by low_pc:
256 xbt_dynar_length(index),
257 sizeof(s_mc_function_index_item_t),
258 (int (*)(const void *, const void *))MC_compare_frame_index_items);
260 info->functions_index = index;
263 mc_object_info_t MC_ip_find_object_info(void* ip) {
265 for(i=0; i!=mc_object_infos_size; ++i) {
266 if(ip >= (void*)mc_object_infos[i]->start_exec && ip <= (void*)mc_object_infos[i]->end_exec) {
267 return mc_object_infos[i];
273 static dw_frame_t MC_find_function_by_ip_and_object(void* ip, mc_object_info_t info) {
274 xbt_dynar_t dynar = info->functions_index;
275 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(dynar, 0);
277 int j = xbt_dynar_length(dynar) - 1;
279 int k = i + ((j-i)/2);
280 if(ip < base[k].low_pc) {
282 } else if(ip >= base[k].high_pc) {
285 return base[k].function;
291 dw_frame_t MC_find_function_by_ip(void* ip) {
292 mc_object_info_t info = MC_ip_find_object_info(ip);
296 return MC_find_function_by_ip_and_object(ip, info);
299 static void MC_post_process_variables(mc_object_info_t info) {
301 dw_variable_t variable = NULL;
302 xbt_dynar_foreach(info->global_variables, cursor, variable) {
303 if(variable->type_origin) {
304 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
309 static void mc_post_process_scope(mc_object_info_t info, dw_frame_t scope) {
311 if(scope->tag == DW_TAG_inlined_subroutine) {
313 // Attach correct namespaced name in inlined subroutine:
314 char* key = bprintf("%" PRIx64, (uint64_t) scope->abstract_origin_id);
315 dw_frame_t abstract_origin = xbt_dict_get_or_null(info->subprograms, key);
316 xbt_assert(abstract_origin, "Could not lookup abstract origin %s", key);
318 scope->name = xbt_strdup(abstract_origin->name);
324 dw_variable_t variable = NULL;
325 xbt_dynar_foreach(scope->variables, cursor, variable) {
326 if(variable->type_origin) {
327 variable->type = xbt_dict_get_or_null(info->types, variable->type_origin);
331 // Recursive post-processing of nested-scopes:
332 dw_frame_t nested_scope = NULL;
333 xbt_dynar_foreach(scope->scopes, cursor, nested_scope)
334 mc_post_process_scope(info, nested_scope);
338 static void MC_post_process_functions(mc_object_info_t info) {
339 xbt_dict_cursor_t cursor;
341 dw_frame_t subprogram = NULL;
342 xbt_dict_foreach(info->subprograms, cursor, key, subprogram) {
343 mc_post_process_scope(info, subprogram);
347 /** \brief Finds informations about a given shared object/executable */
348 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
349 mc_object_info_t result = MC_new_object_info();
351 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
352 result->file_name = xbt_strdup(name);
353 MC_find_object_address(maps, result);
354 MC_dwarf_get_variables(result);
355 MC_post_process_types(result);
356 MC_post_process_variables(result);
357 MC_post_process_functions(result);
358 MC_make_functions_index(result);
362 /*************************************************************************/
364 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
366 if(xbt_dynar_is_empty(variables))
369 unsigned int cursor = 0;
371 int end = xbt_dynar_length(variables) - 1;
372 dw_variable_t var_test = NULL;
375 cursor = (start + end) / 2;
376 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
377 if(strcmp(var_test->name, var) < 0){
379 }else if(strcmp(var_test->name, var) > 0){
382 if(address){ /* global variable */
383 if(var_test->address == address)
385 if(var_test->address > address)
389 }else{ /* local variable */
395 if(strcmp(var_test->name, var) == 0){
396 if(address && var_test->address < address)
400 }else if(strcmp(var_test->name, var) < 0)
407 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
408 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
410 xbt_dynar_insert_at(info->global_variables, index, &variable);
414 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
415 xbt_assert(frame, "Frame is NULL");
416 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
418 xbt_dynar_insert_at(frame->variables, index, &variable);
422 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
424 MC_dwarf_register_global_variable(info, variable);
426 xbt_die("No frame for this local variable");
428 MC_dwarf_register_non_global_variable(info, frame, variable);
432 /******************************* Ignore mechanism *******************************/
433 /*********************************************************************************/
435 xbt_dynar_t mc_checkpoint_ignore;
437 typedef struct s_mc_stack_ignore_variable{
440 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
442 /**************************** Free functions ******************************/
444 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
445 xbt_free(v->var_name);
450 static void stack_ignore_variable_free_voidp(void *v){
451 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
454 void heap_ignore_region_free(mc_heap_ignore_region_t r){
458 void heap_ignore_region_free_voidp(void *r){
459 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
462 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
466 static void checkpoint_ignore_region_free_voidp(void *r){
467 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
470 /***********************************************************************/
472 void MC_ignore_heap(void *address, size_t size){
474 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
478 mc_heap_ignore_region_t region = NULL;
479 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
480 region->address = address;
483 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
485 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
486 region->fragment = -1;
487 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
489 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
490 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
493 if(mc_heap_comparison_ignore == NULL){
494 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
495 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
501 unsigned int cursor = 0;
502 mc_heap_ignore_region_t current_region = NULL;
504 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
507 cursor = (start + end) / 2;
508 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
509 if(current_region->address == address){
510 heap_ignore_region_free(region);
514 }else if(current_region->address < address){
521 if(current_region->address < address)
522 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
524 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
530 void MC_remove_ignore_heap(void *address, size_t size){
532 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
536 unsigned int cursor = 0;
538 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
539 mc_heap_ignore_region_t region;
540 int ignore_found = 0;
543 cursor = (start + end) / 2;
544 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
545 if(region->address == address){
548 }else if(region->address < address){
551 if((char * )region->address <= ((char *)address + size)){
560 if(ignore_found == 1){
561 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
562 MC_remove_ignore_heap(address, size);
570 void MC_ignore_global_variable(const char *name){
572 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
576 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
578 unsigned int cursor = 0;
579 dw_variable_t current_var;
581 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
584 cursor = (start + end) /2;
585 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
586 if(strcmp(current_var->name, name) == 0){
587 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
589 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
590 }else if(strcmp(current_var->name, name) < 0){
601 /** \brief Ignore a local variable in a scope
603 * Ignore all instances of variables with a given name in
604 * any (possibly inlined) subprogram with a given namespaced
607 * \param var_name Name of the local variable (or parameter to ignore)
608 * \param subprogram_name Name of the subprogram fo ignore (NULL for any)
609 * \param subprogram (possibly inlined) Subprogram of the scope
610 * \param scope Current scope
612 static void mc_ignore_local_variable_in_scope(
613 const char *var_name, const char *subprogram_name,
614 dw_frame_t subprogram, dw_frame_t scope) {
615 // Processing of direct variables:
617 // If the current subprogram matche the given name:
618 if(subprogram_name==NULL || strcmp(subprogram_name, subprogram->name)==0) {
620 // Try to find the variable and remove it:
622 int end = xbt_dynar_length(scope->variables) - 1;
624 // Dichotomic search:
626 int cursor = (start + end) / 2;
627 dw_variable_t current_var = (dw_variable_t)xbt_dynar_get_as(scope->variables, cursor, dw_variable_t);
629 int compare = strcmp(current_var->name, var_name);
631 // Variable found, remove it:
632 xbt_dynar_remove_at(scope->variables, cursor, NULL);
636 end = xbt_dynar_length(scope->variables) - 1;
637 }else if(compare < 0){
646 // And recursive processing in nested scopes:
648 dw_frame_t nested_scope = NULL;
649 xbt_dynar_foreach(scope->scopes, cursor, nested_scope) {
650 // The new scope may be an inlined subroutine, in this case we want to use its
651 // namespaced name in recursive calls:
652 dw_frame_t nested_subprogram = nested_scope->tag == DW_TAG_inlined_subroutine ? nested_scope : subprogram;
654 mc_ignore_local_variable_in_scope(var_name, subprogram_name, nested_subprogram, nested_scope);
658 static void MC_ignore_local_variable_in_object(const char *var_name, const char *subprogram_name, mc_object_info_t info) {
659 xbt_dict_cursor_t cursor2;
662 xbt_dict_foreach(info->subprograms, cursor2, key, frame) {
663 mc_ignore_local_variable_in_scope(var_name, subprogram_name, frame, frame);
667 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
669 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
671 if(strcmp(frame_name, "*") == 0)
676 MC_ignore_local_variable_in_object(var_name, frame_name, mc_libsimgrid_info);
678 MC_ignore_local_variable_in_object(var_name, frame_name, mc_binary_info);
685 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
687 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
691 if(stacks_areas == NULL)
692 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
694 stack_region_t region = NULL;
695 region = xbt_new0(s_stack_region_t, 1);
696 region->address = stack;
697 region->process_name = strdup(name);
698 region->context = context;
700 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
701 xbt_dynar_push(stacks_areas, ®ion);
707 void MC_ignore(void *addr, size_t size){
709 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
713 if(mc_checkpoint_ignore == NULL)
714 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
716 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
720 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
721 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
724 unsigned int cursor = 0;
726 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
727 mc_checkpoint_ignore_region_t current_region = NULL;
730 cursor = (start + end) / 2;
731 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
732 if(current_region->addr == addr){
733 if(current_region->size == size){
734 checkpoint_ignore_region_free(region);
738 }else if(current_region->size < size){
743 }else if(current_region->addr < addr){
750 if(current_region->addr == addr){
751 if(current_region->size < size){
752 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
754 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
756 }else if(current_region->addr < addr){
757 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
759 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
767 /******************************* Initialisation of MC *******************************/
768 /*********************************************************************************/
770 static void MC_post_process_object_info(mc_object_info_t info) {
771 xbt_dict_cursor_t cursor = NULL;
773 dw_type_t type = NULL;
774 xbt_dict_foreach(info->types, cursor, key, type){
776 // Resolve full_type:
777 if(type->name && type->byte_size == 0) {
778 for(size_t i=0; i!=mc_object_infos_size; ++i) {
779 dw_type_t same_type = xbt_dict_get_or_null(mc_object_infos[i]->full_types_by_name, type->name);
780 if(same_type && same_type->name && same_type->byte_size) {
781 type->full_type = same_type;
790 static void MC_init_debug_info(void) {
791 XBT_INFO("Get debug information ...");
793 memory_map_t maps = MC_get_memory_map();
795 /* Get local variables for state equality detection */
796 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
797 mc_object_infos[0] = mc_binary_info;
799 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
800 mc_object_infos[1] = mc_libsimgrid_info;
802 // Use information of the other objects:
803 MC_post_process_object_info(mc_binary_info);
804 MC_post_process_object_info(mc_libsimgrid_info);
806 MC_free_memory_map(maps);
807 XBT_INFO("Get debug information done !");
812 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
816 /* Initialize the data structures that must be persistent across every
817 iteration of the model-checker (in RAW memory) */
821 MC_init_memory_map_info();
822 MC_init_debug_info();
825 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
829 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
830 MC_ignore_local_variable("e", "*");
831 MC_ignore_local_variable("__ex_cleanup", "*");
832 MC_ignore_local_variable("__ex_mctx_en", "*");
833 MC_ignore_local_variable("__ex_mctx_me", "*");
834 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
835 MC_ignore_local_variable("_log_ev", "*");
836 MC_ignore_local_variable("_throw_ctx", "*");
837 MC_ignore_local_variable("ctx", "*");
839 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
840 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
841 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
843 /* Ignore local variable about time used for tracing */
844 MC_ignore_local_variable("start_time", "*");
846 MC_ignore_global_variable("compared_pointers");
847 MC_ignore_global_variable("mc_comp_times");
848 MC_ignore_global_variable("mc_snapshot_comparison_time");
849 MC_ignore_global_variable("mc_time");
850 MC_ignore_global_variable("smpi_current_rank");
851 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
852 MC_ignore_global_variable("maestro_stack_start");
853 MC_ignore_global_variable("maestro_stack_end");
854 MC_ignore_global_variable("smx_total_comms");
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));
858 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
859 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
861 smx_process_t process;
862 xbt_swag_foreach(process, simix_global->process_list){
863 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
871 static void MC_init_dot_output(){ /* FIXME : more colors */
875 colors[2] = "green3";
876 colors[3] = "goldenrod";
878 colors[5] = "purple";
879 colors[6] = "magenta";
880 colors[7] = "turquoise4";
881 colors[8] = "gray25";
882 colors[9] = "forestgreen";
883 colors[10] = "hotpink";
884 colors[11] = "lightblue";
887 dot_output = fopen(_sg_mc_dot_output_file, "w");
889 if(dot_output == NULL){
890 perror("Error open dot output file");
894 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");
898 /******************************* Core of MC *******************************/
899 /**************************************************************************/
901 void MC_do_the_modelcheck_for_real() {
904 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
907 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
908 if (mc_reduce_kind==e_mc_reduce_unset)
909 mc_reduce_kind=e_mc_reduce_dpor;
911 XBT_INFO("Check a safety property");
912 MC_modelcheck_safety();
916 if (mc_reduce_kind==e_mc_reduce_unset)
917 mc_reduce_kind=e_mc_reduce_none;
919 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
920 MC_automaton_load(_sg_mc_property_file);
921 MC_modelcheck_liveness();
925 void MC_modelcheck_safety(void)
927 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
929 /* Check if MC is already initialized */
930 if (initial_state_safety)
933 mc_time = xbt_new0(double, simix_process_maxpid);
935 /* mc_time refers to clock for each process -> ignore it for heap comparison */
936 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
938 /* Initialize the data structures that must be persistent across every
939 iteration of the model-checker (in RAW memory) */
943 /* Initialize statistics */
944 mc_stats = xbt_new0(s_mc_stats_t, 1);
945 mc_stats->state_size = 1;
947 /* Create exploration stack */
948 mc_stack_safety = xbt_fifo_new();
950 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
951 MC_init_dot_output();
955 if(_sg_mc_visited > 0){
959 MC_init_memory_map_info();
960 MC_init_debug_info();
967 /* Save the initial state */
968 initial_state_safety = xbt_new0(s_mc_global_t, 1);
969 initial_state_safety->snapshot = MC_take_snapshot(0);
970 initial_state_safety->initial_communications_pattern_done = 0;
971 initial_state_safety->comm_deterministic = 1;
972 initial_state_safety->send_deterministic = 1;
984 void MC_modelcheck_liveness(){
986 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
990 mc_time = xbt_new0(double, simix_process_maxpid);
992 /* mc_time refers to clock for each process -> ignore it for heap comparison */
993 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
997 /* Initialize statistics */
998 mc_stats = xbt_new0(s_mc_stats_t, 1);
999 mc_stats->state_size = 1;
1001 /* Create exploration stack */
1002 mc_stack_liveness = xbt_fifo_new();
1004 /* Create the initial state */
1005 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
1007 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
1008 MC_init_dot_output();
1015 MC_print_statistics(mc_stats);
1032 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
1034 return simcall->mc_value;
1038 int MC_random(int min, int max)
1040 /*FIXME: return mc_current_state->executed_transition->random.value;*/
1041 return simcall_mc_random(min, max);
1045 * \brief Schedules all the process that are ready to run
1047 void MC_wait_for_requests(void)
1049 smx_process_t process;
1053 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1054 SIMIX_process_runall();
1055 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1056 req = &process->simcall;
1057 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1058 SIMIX_simcall_pre(req, 0);
1063 int MC_deadlock_check()
1065 int deadlock = FALSE;
1066 smx_process_t process;
1067 if(xbt_swag_size(simix_global->process_list)){
1069 xbt_swag_foreach(process, simix_global->process_list){
1070 if(process->simcall.call != SIMCALL_NONE
1071 && MC_request_is_enabled(&process->simcall)){
1081 * \brief Re-executes from the state at position start all the transitions indicated by
1082 * a given model-checker stack.
1083 * \param stack The stack with the transitions to execute.
1084 * \param start Start index to begin the re-execution.
1086 void MC_replay(xbt_fifo_t stack, int start)
1088 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1090 int value, i = 1, count = 1;
1092 smx_simcall_t req = NULL, saved_req = NULL;
1093 xbt_fifo_item_t item, start_item;
1095 smx_process_t process = NULL;
1096 int comm_pattern = 0;
1098 XBT_DEBUG("**** Begin Replay ****");
1101 /* Restore the initial state */
1102 MC_restore_snapshot(initial_state_safety->snapshot);
1103 /* At the moment of taking the snapshot the raw heap was set, so restoring
1104 * it will set it back again, we have to unset it to continue */
1108 start_item = xbt_fifo_get_last_item(stack);
1111 start_item = xbt_fifo_get_prev_item(start_item);
1117 xbt_dict_reset(first_enabled_state);
1118 xbt_swag_foreach(process, simix_global->process_list){
1119 if(MC_process_is_enabled(process)){
1120 char *key = bprintf("%lu", process->pid);
1121 char *data = bprintf("%d", count);
1122 xbt_dict_set(first_enabled_state, key, data, NULL);
1126 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
1127 xbt_dynar_reset(communications_pattern);
1131 /* Traverse the stack from the state at position start and re-execute the transitions */
1132 for (item = start_item;
1133 item != xbt_fifo_get_first_item(stack);
1134 item = xbt_fifo_get_prev_item(item)) {
1136 state = (mc_state_t) xbt_fifo_get_item_content(item);
1137 saved_req = MC_state_get_executed_request(state, &value);
1140 char *key = bprintf("%lu", saved_req->issuer->pid);
1141 xbt_dict_remove(first_enabled_state, key);
1146 /* because we got a copy of the executed request, we have to fetch the
1147 real one, pointed by the request field of the issuer process */
1148 req = &saved_req->issuer->simcall;
1150 /* Debug information */
1151 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1152 req_str = MC_request_to_string(req, value);
1153 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1158 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1159 if(req->call == SIMCALL_COMM_ISEND)
1161 else if(req->call == SIMCALL_COMM_IRECV)
1165 SIMIX_simcall_pre(req, value);
1167 if(_sg_mc_comms_determinism || _sg_mc_send_determinism){
1169 if(comm_pattern != 0){
1170 get_comm_pattern(communications_pattern, req, comm_pattern);
1176 MC_wait_for_requests();
1181 /* Insert in dict all enabled processes */
1182 xbt_swag_foreach(process, simix_global->process_list){
1183 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1184 char *key = bprintf("%lu", process->pid);
1185 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1186 char *data = bprintf("%d", count);
1187 xbt_dict_set(first_enabled_state, key, data, NULL);
1194 /* Update statistics */
1195 mc_stats->visited_states++;
1196 mc_stats->executed_transitions++;
1200 XBT_DEBUG("**** End Replay ****");
1210 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1213 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1217 smx_simcall_t req = NULL, saved_req = NULL;
1218 xbt_fifo_item_t item;
1223 XBT_DEBUG("**** Begin Replay ****");
1225 /* Restore the initial state */
1226 MC_restore_snapshot(initial_state_liveness->snapshot);
1228 /* At the moment of taking the snapshot the raw heap was set, so restoring
1229 * it will set it back again, we have to unset it to continue */
1230 if(!initial_state_liveness->raw_mem_set)
1235 item = xbt_fifo_get_last_item(stack);
1237 while(depth <= xbt_fifo_size(stack)){
1239 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1240 state = (mc_state_t) pair->graph_state;
1242 if(pair->requests > 0){
1244 saved_req = MC_state_get_executed_request(state, &value);
1245 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1247 if(saved_req != NULL){
1248 /* because we got a copy of the executed request, we have to fetch the
1249 real one, pointed by the request field of the issuer process */
1250 req = &saved_req->issuer->simcall;
1251 //XBT_DEBUG("Req->call %u", req->call);
1253 /* Debug information */
1254 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1255 req_str = MC_request_to_string(req, value);
1256 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1262 SIMIX_simcall_pre(req, value);
1263 MC_wait_for_requests();
1268 /* Update statistics */
1269 mc_stats->visited_pairs++;
1270 mc_stats->executed_transitions++;
1272 item = xbt_fifo_get_prev_item(item);
1277 /* Traverse the stack from the initial state and re-execute the transitions */
1278 for (item = xbt_fifo_get_last_item(stack);
1279 item != xbt_fifo_get_first_item(stack);
1280 item = xbt_fifo_get_prev_item(item)) {
1282 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1283 state = (mc_state_t) pair->graph_state;
1285 if(pair->requests > 0){
1287 saved_req = MC_state_get_executed_request(state, &value);
1288 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1290 if(saved_req != NULL){
1291 /* because we got a copy of the executed request, we have to fetch the
1292 real one, pointed by the request field of the issuer process */
1293 req = &saved_req->issuer->simcall;
1294 //XBT_DEBUG("Req->call %u", req->call);
1296 /* Debug information */
1297 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1298 req_str = MC_request_to_string(req, value);
1299 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1305 SIMIX_simcall_pre(req, value);
1306 MC_wait_for_requests();
1311 /* Update statistics */
1312 mc_stats->visited_pairs++;
1313 mc_stats->executed_transitions++;
1317 XBT_DEBUG("**** End Replay ****");
1319 if(initial_state_liveness->raw_mem_set)
1327 * \brief Dumps the contents of a model-checker's stack and shows the actual
1329 * \param stack The stack to dump
1331 void MC_dump_stack_safety(xbt_fifo_t stack)
1334 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1336 MC_show_stack_safety(stack);
1338 if(!_sg_mc_checkpoint){
1343 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1344 MC_state_delete(state);
1357 void MC_show_stack_safety(xbt_fifo_t stack)
1360 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1366 xbt_fifo_item_t item;
1368 char *req_str = NULL;
1370 for (item = xbt_fifo_get_last_item(stack);
1371 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1372 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1373 req = MC_state_get_executed_request(state, &value);
1375 req_str = MC_request_to_string(req, value);
1376 XBT_INFO("%s", req_str);
1385 void MC_show_deadlock(smx_simcall_t req)
1387 /*char *req_str = NULL;*/
1388 XBT_INFO("**************************");
1389 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1390 XBT_INFO("**************************");
1391 XBT_INFO("Locked request:");
1392 /*req_str = MC_request_to_string(req);
1393 XBT_INFO("%s", req_str);
1394 xbt_free(req_str);*/
1395 XBT_INFO("Counter-example execution trace:");
1396 MC_dump_stack_safety(mc_stack_safety);
1397 MC_print_statistics(mc_stats);
1401 void MC_show_stack_liveness(xbt_fifo_t stack){
1404 xbt_fifo_item_t item;
1406 char *req_str = NULL;
1408 for (item = xbt_fifo_get_last_item(stack);
1409 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1410 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1411 req = MC_state_get_executed_request(pair->graph_state, &value);
1413 if(pair->requests>0){
1414 req_str = MC_request_to_string(req, value);
1415 XBT_INFO("%s", req_str);
1418 XBT_INFO("End of system requests but evolution in Büchi automaton");
1424 void MC_dump_stack_liveness(xbt_fifo_t stack){
1426 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1431 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1432 MC_pair_delete(pair);
1441 void MC_print_statistics(mc_stats_t stats)
1443 if(stats->expanded_pairs == 0){
1444 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1445 XBT_INFO("Visited states = %lu", stats->visited_states);
1447 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1448 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1450 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1452 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1453 fprintf(dot_output, "}\n");
1456 if(initial_state_safety != NULL){
1457 if(_sg_mc_comms_determinism)
1458 XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1459 if (_sg_mc_send_determinism)
1460 XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1465 void MC_assert(int prop)
1467 if (MC_is_active() && !prop){
1468 XBT_INFO("**************************");
1469 XBT_INFO("*** PROPERTY NOT VALID ***");
1470 XBT_INFO("**************************");
1471 XBT_INFO("Counter-example execution trace:");
1472 MC_dump_stack_safety(mc_stack_safety);
1473 MC_print_statistics(mc_stats);
1479 user_max_depth_reached = 1;
1482 void MC_process_clock_add(smx_process_t process, double amount)
1484 mc_time[process->pid] += amount;
1487 double MC_process_clock_get(smx_process_t process)
1491 return mc_time[process->pid];
1499 void MC_automaton_load(const char *file){
1501 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1505 if (_mc_property_automaton == NULL)
1506 _mc_property_automaton = xbt_automaton_new();
1508 xbt_automaton_load(_mc_property_automaton,file);
1517 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1519 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1523 if (_mc_property_automaton == NULL)
1524 _mc_property_automaton = xbt_automaton_new();
1526 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);