1 /* Copyright (c) 2008-2013. 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;
38 int user_max_depth_reached = 0;
40 void _mc_cfg_cb_reduce(const char *name, int pos) {
41 if (_sg_cfg_init_status && !_sg_do_model_check) {
42 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.");
44 char *val= xbt_cfg_get_string(_sg_cfg_set, name);
45 if (!strcasecmp(val,"none")) {
46 mc_reduce_kind = e_mc_reduce_none;
47 } else if (!strcasecmp(val,"dpor")) {
48 mc_reduce_kind = e_mc_reduce_dpor;
50 xbt_die("configuration option %s can only take 'none' or 'dpor' as a value",name);
54 void _mc_cfg_cb_checkpoint(const char *name, int pos) {
55 if (_sg_cfg_init_status && !_sg_do_model_check) {
56 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.");
58 _sg_mc_checkpoint = xbt_cfg_get_int(_sg_cfg_set, name);
60 void _mc_cfg_cb_property(const char *name, int pos) {
61 if (_sg_cfg_init_status && !_sg_do_model_check) {
62 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.");
64 _sg_mc_property_file= xbt_cfg_get_string(_sg_cfg_set, name);
67 void _mc_cfg_cb_timeout(const char *name, int pos) {
68 if (_sg_cfg_init_status && !_sg_do_model_check) {
69 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.");
71 _sg_mc_timeout= xbt_cfg_get_boolean(_sg_cfg_set, name);
74 void _mc_cfg_cb_hash(const char *name, int pos) {
75 if (_sg_cfg_init_status && !_sg_do_model_check) {
76 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.");
78 _sg_mc_hash= xbt_cfg_get_boolean(_sg_cfg_set, name);
81 void _mc_cfg_cb_max_depth(const char *name, int pos) {
82 if (_sg_cfg_init_status && !_sg_do_model_check) {
83 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.");
85 _sg_mc_max_depth= xbt_cfg_get_int(_sg_cfg_set, name);
88 void _mc_cfg_cb_visited(const char *name, int pos) {
89 if (_sg_cfg_init_status && !_sg_do_model_check) {
90 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.");
92 _sg_mc_visited= xbt_cfg_get_int(_sg_cfg_set, name);
95 void _mc_cfg_cb_dot_output(const char *name, int pos) {
96 if (_sg_cfg_init_status && !_sg_do_model_check) {
97 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.");
99 _sg_mc_dot_output_file= xbt_cfg_get_string(_sg_cfg_set, name);
102 /* MC global data structures */
103 mc_state_t mc_current_state = NULL;
104 char mc_replay_mode = FALSE;
105 double *mc_time = NULL;
106 __thread mc_comparison_times_t mc_comp_times = NULL;
107 __thread double mc_snapshot_comparison_time;
108 mc_stats_t mc_stats = NULL;
111 xbt_fifo_t mc_stack_safety = NULL;
112 mc_global_t initial_state_safety = NULL;
115 xbt_fifo_t mc_stack_liveness = NULL;
116 mc_global_t initial_state_liveness = NULL;
119 xbt_automaton_t _mc_property_automaton = NULL;
122 mc_object_info_t mc_libsimgrid_info = NULL;
123 mc_object_info_t mc_binary_info = NULL;
125 /* Ignore mechanism */
126 extern xbt_dynar_t mc_heap_comparison_ignore;
127 extern xbt_dynar_t stacks_areas;
130 FILE *dot_output = NULL;
131 const char* colors[13];
134 /******************************* DWARF Information *******************************/
135 /**********************************************************************************/
137 /************************** Free functions *************************/
139 static void dw_location_free(dw_location_t l){
141 if(l->type == e_dw_loclist)
142 xbt_dynar_free(&(l->location.loclist));
143 else if(l->type == e_dw_compose)
144 xbt_dynar_free(&(l->location.compose));
145 else if(l->type == e_dw_arithmetic)
146 xbt_free(l->location.arithmetic);
152 static void dw_location_entry_free(dw_location_entry_t e){
153 dw_location_free(e->location);
157 void dw_type_free(dw_type_t t){
159 xbt_free(t->dw_type_id);
160 xbt_dynar_free(&(t->members));
164 static void dw_type_free_voidp(void *t){
165 dw_type_free((dw_type_t) * (void **) t);
168 void dw_variable_free(dw_variable_t v){
171 xbt_free(v->type_origin);
173 dw_location_free(v->location);
178 void dw_variable_free_voidp(void *t){
179 dw_variable_free((dw_variable_t) * (void **) t);
184 mc_object_info_t MC_new_object_info(void) {
185 mc_object_info_t res = xbt_new0(s_mc_object_info_t, 1);
186 res->local_variables = xbt_dict_new_homogeneous(NULL);
187 res->global_variables = xbt_dynar_new(sizeof(dw_variable_t), dw_variable_free_voidp);
188 res->types = xbt_dict_new_homogeneous(NULL);
189 res->types_by_name = xbt_dict_new_homogeneous(NULL);
194 void MC_free_object_info(mc_object_info_t* info) {
195 xbt_free(&(*info)->file_name);
196 xbt_dict_free(&(*info)->local_variables);
197 xbt_dynar_free(&(*info)->global_variables);
198 xbt_dict_free(&(*info)->types);
199 xbt_dict_free(&(*info)->types_by_name);
201 xbt_dynar_free(&(*info)->functions_index);
207 void* MC_object_base_address(mc_object_info_t info) {
208 void* result = info->start_exec;
209 if(info->start_rw!=NULL && result > (void*) info->start_rw) result = info->start_rw;
210 if(info->start_ro!=NULL && result > (void*) info->start_ro) result = info->start_ro;
214 // ***** Functions index
216 static int MC_compare_frame_index_items(mc_function_index_item_t a, mc_function_index_item_t b) {
217 if(a->low_pc < b->low_pc)
219 else if(a->low_pc == b->low_pc)
225 static void MC_make_functions_index(mc_object_info_t info) {
226 xbt_dynar_t index = xbt_dynar_new(sizeof(s_mc_function_index_item_t), NULL);
228 // Populate the array:
229 dw_frame_t frame = NULL;
230 xbt_dict_cursor_t cursor = NULL;
231 const char* name = NULL;
232 xbt_dict_foreach(info->local_variables, cursor, name, frame) {
233 if(frame->low_pc==NULL)
235 s_mc_function_index_item_t entry;
236 entry.low_pc = frame->low_pc;
237 entry.high_pc = frame->high_pc;
238 entry.function = frame;
239 xbt_dynar_push(index, &entry);
242 mc_function_index_item_t base = (mc_function_index_item_t) xbt_dynar_get_ptr(index, 0);
244 // Sort the array by low_pc:
246 xbt_dynar_length(index),
247 sizeof(s_mc_function_index_item_t),
248 (int (*)(const void *, const void *))MC_compare_frame_index_items);
250 info->functions_index = index;
253 mc_object_info_t MC_ip_find_object_info(void* ip) {
254 mc_object_info_t infos[2] = { mc_binary_info, mc_libsimgrid_info };
257 for(i=0; i!=n; ++i) {
258 if(ip >= (void*)infos[i]->start_exec && ip <= (void*)infos[i]->end_exec) {
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 /** \brief Finds informations about a given shared object/executable */
292 mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable) {
293 mc_object_info_t result = MC_new_object_info();
295 result->flags |= MC_OBJECT_INFO_EXECUTABLE;
296 result->file_name = xbt_strdup(name);
297 MC_find_object_address(maps, result);
298 MC_dwarf_get_variables(result);
299 MC_post_process_types(result);
300 MC_make_functions_index(result);
304 /*************************************************************************/
306 static dw_location_t MC_dwarf_get_location(xbt_dict_t location_list, char *expr){
308 dw_location_t loc = xbt_new0(s_dw_location_t, 1);
310 if(location_list != NULL){
312 char *key = bprintf("%d", (int)strtoul(expr, NULL, 16));
313 loc->type = e_dw_loclist;
314 loc->location.loclist = (xbt_dynar_t)xbt_dict_get_or_null(location_list, key);
315 if(loc->location.loclist == NULL)
316 XBT_INFO("Key not found in loclist");
323 char *tok = NULL, *tok2 = NULL;
325 xbt_dynar_t tokens1 = xbt_str_split(expr, ";");
328 loc->type = e_dw_compose;
329 loc->location.compose = xbt_dynar_new(sizeof(dw_location_t), NULL);
331 while(cursor < xbt_dynar_length(tokens1)){
333 tok = xbt_dynar_get_as(tokens1, cursor, char*);
334 tokens2 = xbt_str_split(tok, " ");
335 tok2 = xbt_dynar_get_as(tokens2, 0, char*);
337 if(strncmp(tok2, "DW_OP_reg", 9) == 0){
338 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
339 new_element->type = e_dw_register;
340 new_element->location.reg = atoi(strtok(tok2, "DW_OP_reg"));
341 xbt_dynar_push(loc->location.compose, &new_element);
342 }else if(strcmp(tok2, "DW_OP_fbreg:") == 0){
343 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
344 new_element->type = e_dw_fbregister_op;
345 new_element->location.fbreg_op = atoi(xbt_dynar_get_as(tokens2, xbt_dynar_length(tokens2) - 1, char*));
346 xbt_dynar_push(loc->location.compose, &new_element);
347 }else if(strncmp(tok2, "DW_OP_breg", 10) == 0){
348 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
349 new_element->type = e_dw_bregister_op;
350 new_element->location.breg_op.reg = atoi(strtok(tok2, "DW_OP_breg"));
351 new_element->location.breg_op.offset = atoi(xbt_dynar_get_as(tokens2, xbt_dynar_length(tokens2) - 1, char*));
352 xbt_dynar_push(loc->location.compose, &new_element);
353 }else if(strncmp(tok2, "DW_OP_lit", 9) == 0){
354 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
355 new_element->type = e_dw_lit;
356 new_element->location.lit = atoi(strtok(tok2, "DW_OP_lit"));
357 xbt_dynar_push(loc->location.compose, &new_element);
358 }else if(strcmp(tok2, "DW_OP_piece:") == 0){
359 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
360 new_element->type = e_dw_piece;
361 new_element->location.piece = atoi(xbt_dynar_get_as(tokens2, xbt_dynar_length(tokens2) - 1, char*));
362 xbt_dynar_push(loc->location.compose, &new_element);
363 }else if(strcmp(tok2, "DW_OP_plus_uconst:") == 0){
364 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
365 new_element->type = e_dw_plus_uconst;
366 new_element->location.plus_uconst = atoi(xbt_dynar_get_as(tokens2, xbt_dynar_length(tokens2) - 1, char *));
367 xbt_dynar_push(loc->location.compose, &new_element);
368 }else if(strcmp(tok, "DW_OP_abs") == 0 ||
369 strcmp(tok, "DW_OP_and") == 0 ||
370 strcmp(tok, "DW_OP_div") == 0 ||
371 strcmp(tok, "DW_OP_minus") == 0 ||
372 strcmp(tok, "DW_OP_mod") == 0 ||
373 strcmp(tok, "DW_OP_mul") == 0 ||
374 strcmp(tok, "DW_OP_neg") == 0 ||
375 strcmp(tok, "DW_OP_not") == 0 ||
376 strcmp(tok, "DW_OP_or") == 0 ||
377 strcmp(tok, "DW_OP_plus") == 0){
378 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
379 new_element->type = e_dw_arithmetic;
380 new_element->location.arithmetic = strdup(strtok(tok2, "DW_OP_"));
381 xbt_dynar_push(loc->location.compose, &new_element);
382 }else if(strcmp(tok, "DW_OP_stack_value") == 0){
383 }else if(strcmp(tok2, "DW_OP_deref_size:") == 0){
384 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
385 new_element->type = e_dw_deref;
386 new_element->location.deref_size = (unsigned int short) atoi(xbt_dynar_get_as(tokens2, xbt_dynar_length(tokens2) - 1, char*));
387 xbt_dynar_push(loc->location.compose, &new_element);
388 }else if(strcmp(tok, "DW_OP_deref") == 0){
389 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
390 new_element->type = e_dw_deref;
391 new_element->location.deref_size = sizeof(void *);
392 xbt_dynar_push(loc->location.compose, &new_element);
393 }else if(strcmp(tok2, "DW_OP_constu:") == 0){
394 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
395 new_element->type = e_dw_uconstant;
396 new_element->location.uconstant.bytes = 1;
397 new_element->location.uconstant.value = (unsigned long int)(atoi(xbt_dynar_get_as(tokens2, xbt_dynar_length(tokens2) - 1, char*)));
398 xbt_dynar_push(loc->location.compose, &new_element);
399 }else if(strcmp(tok2, "DW_OP_consts:") == 0){
400 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
401 new_element->type = e_dw_sconstant;
402 new_element->location.sconstant.bytes = 1;
403 new_element->location.sconstant.value = (long int)(atoi(xbt_dynar_get_as(tokens2, xbt_dynar_length(tokens2) - 1, char*)));
404 xbt_dynar_push(loc->location.compose, &new_element);
405 }else if(strcmp(tok2, "DW_OP_const1u:") == 0 ||
406 strcmp(tok2, "DW_OP_const2u:") == 0 ||
407 strcmp(tok2, "DW_OP_const4u:") == 0 ||
408 strcmp(tok2, "DW_OP_const8u:") == 0){
409 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
410 new_element->type = e_dw_uconstant;
411 new_element->location.uconstant.bytes = tok2[11] - '0';
412 new_element->location.uconstant.value = (unsigned long int)(atoi(xbt_dynar_get_as(tokens2, xbt_dynar_length(tokens2) - 1, char*)));
413 xbt_dynar_push(loc->location.compose, &new_element);
414 }else if(strcmp(tok, "DW_OP_const1s") == 0 ||
415 strcmp(tok, "DW_OP_const2s") == 0 ||
416 strcmp(tok, "DW_OP_const4s") == 0 ||
417 strcmp(tok, "DW_OP_const8s") == 0){
418 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
419 new_element->type = e_dw_sconstant;
420 new_element->location.sconstant.bytes = tok2[11] - '0';
421 new_element->location.sconstant.value = (long int)(atoi(xbt_dynar_get_as(tokens2, xbt_dynar_length(tokens2) - 1, char*)));
422 xbt_dynar_push(loc->location.compose, &new_element);
424 dw_location_t new_element = xbt_new0(s_dw_location_t, 1);
425 new_element->type = e_dw_unsupported;
426 xbt_dynar_push(loc->location.compose, &new_element);
430 xbt_dynar_free(&tokens2);
434 xbt_dynar_free(&tokens1);
443 /** \brief Finds a frame (DW_TAG_subprogram) from an DWARF offset in the rangd of this subprogram
445 * The offset can be an offset of a child DW_TAG_variable.
447 static dw_frame_t MC_dwarf_get_frame_by_offset(xbt_dict_t all_variables, unsigned long int offset){
449 xbt_dict_cursor_t cursor = NULL;
453 xbt_dict_foreach(all_variables, cursor, name, res) {
454 if(offset >= res->start && offset < res->end){
455 xbt_dict_cursor_free(&cursor);
460 xbt_dict_cursor_free(&cursor);
465 static dw_variable_t MC_dwarf_get_variable_by_name(dw_frame_t frame, char *var){
467 unsigned int cursor = 0;
468 dw_variable_t current_var;
470 xbt_dynar_foreach(frame->variables, cursor, current_var){
471 if(strcmp(var, current_var->name) == 0)
478 static int MC_dwarf_get_variable_index(xbt_dynar_t variables, char* var, void *address){
480 if(xbt_dynar_is_empty(variables))
483 unsigned int cursor = 0;
485 int end = xbt_dynar_length(variables) - 1;
486 dw_variable_t var_test = NULL;
489 cursor = (start + end) / 2;
490 var_test = (dw_variable_t)xbt_dynar_get_as(variables, cursor, dw_variable_t);
491 if(strcmp(var_test->name, var) < 0){
493 }else if(strcmp(var_test->name, var) > 0){
496 if(address){ /* global variable */
497 if(var_test->address == address)
499 if(var_test->address > address)
503 }else{ /* local variable */
509 if(strcmp(var_test->name, var) == 0){
510 if(address && var_test->address < address)
514 }else if(strcmp(var_test->name, var) < 0)
521 void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable) {
522 int index = MC_dwarf_get_variable_index(info->global_variables, variable->name, variable->address);
524 xbt_dynar_insert_at(info->global_variables, index, &variable);
528 void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
529 xbt_assert(frame, "Frame is NULL");
530 int index = MC_dwarf_get_variable_index(frame->variables, variable->name, NULL);
532 xbt_dynar_insert_at(frame->variables, index, &variable);
536 void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable) {
538 MC_dwarf_register_global_variable(info, variable);
540 xbt_die("No frame for this local variable");
542 MC_dwarf_register_non_global_variable(info, frame, variable);
546 /******************************* Ignore mechanism *******************************/
547 /*********************************************************************************/
549 xbt_dynar_t mc_checkpoint_ignore;
551 typedef struct s_mc_stack_ignore_variable{
554 }s_mc_stack_ignore_variable_t, *mc_stack_ignore_variable_t;
556 /**************************** Free functions ******************************/
558 static void stack_ignore_variable_free(mc_stack_ignore_variable_t v){
559 xbt_free(v->var_name);
564 static void stack_ignore_variable_free_voidp(void *v){
565 stack_ignore_variable_free((mc_stack_ignore_variable_t) * (void **) v);
568 void heap_ignore_region_free(mc_heap_ignore_region_t r){
572 void heap_ignore_region_free_voidp(void *r){
573 heap_ignore_region_free((mc_heap_ignore_region_t) * (void **) r);
576 static void checkpoint_ignore_region_free(mc_checkpoint_ignore_region_t r){
580 static void checkpoint_ignore_region_free_voidp(void *r){
581 checkpoint_ignore_region_free((mc_checkpoint_ignore_region_t) * (void **) r);
584 /***********************************************************************/
586 void MC_ignore_heap(void *address, size_t size){
588 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
592 mc_heap_ignore_region_t region = NULL;
593 region = xbt_new0(s_mc_heap_ignore_region_t, 1);
594 region->address = address;
597 region->block = ((char*)address - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
599 if(((xbt_mheap_t)std_heap)->heapinfo[region->block].type == 0){
600 region->fragment = -1;
601 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_block.ignore++;
603 region->fragment = ((uintptr_t) (ADDR2UINT (address) % (BLOCKSIZE))) >> ((xbt_mheap_t)std_heap)->heapinfo[region->block].type;
604 ((xbt_mheap_t)std_heap)->heapinfo[region->block].busy_frag.ignore[region->fragment]++;
607 if(mc_heap_comparison_ignore == NULL){
608 mc_heap_comparison_ignore = xbt_dynar_new(sizeof(mc_heap_ignore_region_t), heap_ignore_region_free_voidp);
609 xbt_dynar_push(mc_heap_comparison_ignore, ®ion);
615 unsigned int cursor = 0;
616 mc_heap_ignore_region_t current_region = NULL;
618 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
621 cursor = (start + end) / 2;
622 current_region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
623 if(current_region->address == address){
624 heap_ignore_region_free(region);
628 }else if(current_region->address < address){
635 if(current_region->address < address)
636 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor + 1, ®ion);
638 xbt_dynar_insert_at(mc_heap_comparison_ignore, cursor, ®ion);
644 void MC_remove_ignore_heap(void *address, size_t size){
646 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
650 unsigned int cursor = 0;
652 int end = xbt_dynar_length(mc_heap_comparison_ignore) - 1;
653 mc_heap_ignore_region_t region;
654 int ignore_found = 0;
657 cursor = (start + end) / 2;
658 region = (mc_heap_ignore_region_t)xbt_dynar_get_as(mc_heap_comparison_ignore, cursor, mc_heap_ignore_region_t);
659 if(region->address == address){
662 }else if(region->address < address){
665 if((char * )region->address <= ((char *)address + size)){
674 if(ignore_found == 1){
675 xbt_dynar_remove_at(mc_heap_comparison_ignore, cursor, NULL);
676 MC_remove_ignore_heap(address, size);
684 void MC_ignore_global_variable(const char *name){
686 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
690 xbt_assert(mc_libsimgrid_info, "MC subsystem not initialized");
692 unsigned int cursor = 0;
693 dw_variable_t current_var;
695 int end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
698 cursor = (start + end) /2;
699 current_var = (dw_variable_t)xbt_dynar_get_as(mc_libsimgrid_info->global_variables, cursor, dw_variable_t);
700 if(strcmp(current_var->name, name) == 0){
701 xbt_dynar_remove_at(mc_libsimgrid_info->global_variables, cursor, NULL);
703 end = xbt_dynar_length(mc_libsimgrid_info->global_variables) - 1;
704 }else if(strcmp(current_var->name, name) < 0){
715 void MC_ignore_local_variable(const char *var_name, const char *frame_name){
717 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
721 unsigned int cursor = 0;
722 dw_variable_t current_var;
724 if(strcmp(frame_name, "*") == 0){ /* Remove variable in all frames */
725 xbt_dict_cursor_t dict_cursor;
726 char *current_frame_name;
728 xbt_dict_foreach(mc_libsimgrid_info->local_variables, dict_cursor, current_frame_name, frame){
730 end = xbt_dynar_length(frame->variables) - 1;
732 cursor = (start + end) / 2;
733 current_var = (dw_variable_t)xbt_dynar_get_as(frame->variables, cursor, dw_variable_t);
734 if(strcmp(current_var->name, var_name) == 0){
735 xbt_dynar_remove_at(frame->variables, cursor, NULL);
737 end = xbt_dynar_length(frame->variables) - 1;
738 }else if(strcmp(current_var->name, var_name) < 0){
745 xbt_dict_foreach(mc_binary_info->local_variables, dict_cursor, current_frame_name, frame){
747 end = xbt_dynar_length(frame->variables) - 1;
749 cursor = (start + end) / 2;
750 current_var = (dw_variable_t)xbt_dynar_get_as(frame->variables, cursor, dw_variable_t);
751 if(strcmp(current_var->name, var_name) == 0){
752 xbt_dynar_remove_at(frame->variables, cursor, NULL);
754 end = xbt_dynar_length(frame->variables) - 1;
755 }else if(strcmp(current_var->name, var_name) < 0){
763 xbt_dynar_t variables_list = ((dw_frame_t)xbt_dict_get_or_null(
764 mc_libsimgrid_info->local_variables, frame_name))->variables;
766 end = xbt_dynar_length(variables_list) - 1;
768 cursor = (start + end) / 2;
769 current_var = (dw_variable_t)xbt_dynar_get_as(variables_list, cursor, dw_variable_t);
770 if(strcmp(current_var->name, var_name) == 0){
771 xbt_dynar_remove_at(variables_list, cursor, NULL);
773 end = xbt_dynar_length(variables_list) - 1;
774 }else if(strcmp(current_var->name, var_name) < 0){
787 void MC_new_stack_area(void *stack, char *name, void* context, size_t size){
789 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
793 if(stacks_areas == NULL)
794 stacks_areas = xbt_dynar_new(sizeof(stack_region_t), NULL);
796 stack_region_t region = NULL;
797 region = xbt_new0(s_stack_region_t, 1);
798 region->address = stack;
799 region->process_name = strdup(name);
800 region->context = context;
802 region->block = ((char*)stack - (char*)((xbt_mheap_t)std_heap)->heapbase) / BLOCKSIZE + 1;
803 xbt_dynar_push(stacks_areas, ®ion);
809 void MC_ignore(void *addr, size_t size){
811 int raw_mem_set= (mmalloc_get_current_heap() == raw_heap);
815 if(mc_checkpoint_ignore == NULL)
816 mc_checkpoint_ignore = xbt_dynar_new(sizeof(mc_checkpoint_ignore_region_t), checkpoint_ignore_region_free_voidp);
818 mc_checkpoint_ignore_region_t region = xbt_new0(s_mc_checkpoint_ignore_region_t, 1);
822 if(xbt_dynar_is_empty(mc_checkpoint_ignore)){
823 xbt_dynar_push(mc_checkpoint_ignore, ®ion);
826 unsigned int cursor = 0;
828 int end = xbt_dynar_length(mc_checkpoint_ignore) -1;
829 mc_checkpoint_ignore_region_t current_region = NULL;
832 cursor = (start + end) / 2;
833 current_region = (mc_checkpoint_ignore_region_t)xbt_dynar_get_as(mc_checkpoint_ignore, cursor, mc_checkpoint_ignore_region_t);
834 if(current_region->addr == addr){
835 if(current_region->size == size){
836 checkpoint_ignore_region_free(region);
840 }else if(current_region->size < size){
845 }else if(current_region->addr < addr){
852 if(current_region->addr == addr){
853 if(current_region->size < size){
854 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
856 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
858 }else if(current_region->addr < addr){
859 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor + 1, ®ion);
861 xbt_dynar_insert_at(mc_checkpoint_ignore, cursor, ®ion);
869 /******************************* Initialisation of MC *******************************/
870 /*********************************************************************************/
872 static void MC_init_debug_info();
873 static void MC_init_debug_info() {
874 XBT_INFO("Get debug information ...");
876 memory_map_t maps = MC_get_memory_map();
878 /* Get local variables for state equality detection */
879 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
880 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
882 MC_free_memory_map(maps);
883 XBT_INFO("Get debug information done !");
888 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
892 /* Initialize the data structures that must be persistent across every
893 iteration of the model-checker (in RAW memory) */
897 MC_init_memory_map_info();
898 MC_init_debug_info();
901 parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
905 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
906 MC_ignore_local_variable("e", "*");
907 MC_ignore_local_variable("__ex_cleanup", "*");
908 MC_ignore_local_variable("__ex_mctx_en", "*");
909 MC_ignore_local_variable("__ex_mctx_me", "*");
910 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
911 MC_ignore_local_variable("_log_ev", "*");
912 MC_ignore_local_variable("_throw_ctx", "*");
913 MC_ignore_local_variable("ctx", "*");
915 MC_ignore_local_variable("next_context", "smx_ctx_sysv_suspend_serial");
916 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
918 /* Ignore local variable about time used for tracing */
919 MC_ignore_local_variable("start_time", "*");
921 MC_ignore_global_variable("mc_comp_times");
922 MC_ignore_global_variable("mc_snapshot_comparison_time");
923 MC_ignore_global_variable("mc_time");
924 MC_ignore_global_variable("smpi_current_rank");
925 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
926 MC_ignore_global_variable("maestro_stack_start");
927 MC_ignore_global_variable("maestro_stack_end");
928 MC_ignore_global_variable("smx_total_comms");
930 MC_ignore_heap(&(simix_global->process_to_run), sizeof(simix_global->process_to_run));
931 MC_ignore_heap(&(simix_global->process_that_ran), sizeof(simix_global->process_that_ran));
932 MC_ignore_heap(simix_global->process_to_run, sizeof(*(simix_global->process_to_run)));
933 MC_ignore_heap(simix_global->process_that_ran, sizeof(*(simix_global->process_that_ran)));
935 smx_process_t process;
936 xbt_swag_foreach(process, simix_global->process_list){
937 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
945 static void MC_init_dot_output(){ /* FIXME : more colors */
949 colors[2] = "green3";
950 colors[3] = "goldenrod";
952 colors[5] = "purple";
953 colors[6] = "magenta";
954 colors[7] = "turquoise4";
955 colors[8] = "gray25";
956 colors[9] = "forestgreen";
957 colors[10] = "hotpink";
958 colors[11] = "lightblue";
961 dot_output = fopen(_sg_mc_dot_output_file, "w");
963 if(dot_output == NULL){
964 perror("Error open dot output file");
968 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");
972 /******************************* Core of MC *******************************/
973 /**************************************************************************/
975 void MC_do_the_modelcheck_for_real() {
978 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
981 if (!_sg_mc_property_file || _sg_mc_property_file[0]=='\0') {
982 if (mc_reduce_kind==e_mc_reduce_unset)
983 mc_reduce_kind=e_mc_reduce_dpor;
985 XBT_INFO("Check a safety property");
986 MC_modelcheck_safety();
990 if (mc_reduce_kind==e_mc_reduce_unset)
991 mc_reduce_kind=e_mc_reduce_none;
993 XBT_INFO("Check the liveness property %s",_sg_mc_property_file);
994 MC_automaton_load(_sg_mc_property_file);
995 MC_modelcheck_liveness();
999 void MC_modelcheck_safety(void)
1001 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1003 /* Check if MC is already initialized */
1004 if (initial_state_safety)
1007 mc_time = xbt_new0(double, simix_process_maxpid);
1009 /* mc_time refers to clock for each process -> ignore it for heap comparison */
1010 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
1012 /* Initialize the data structures that must be persistent across every
1013 iteration of the model-checker (in RAW memory) */
1017 /* Initialize statistics */
1018 mc_stats = xbt_new0(s_mc_stats_t, 1);
1019 mc_stats->state_size = 1;
1021 /* Create exploration stack */
1022 mc_stack_safety = xbt_fifo_new();
1024 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
1025 MC_init_dot_output();
1029 if(_sg_mc_visited > 0){
1033 MC_init_memory_map_info();
1034 MC_init_debug_info();
1041 /* Save the initial state */
1042 initial_state_safety = xbt_new0(s_mc_global_t, 1);
1043 initial_state_safety->snapshot = MC_take_snapshot(0);
1044 initial_state_safety->initial_communications_pattern_done = 0;
1045 initial_state_safety->comm_deterministic = 1;
1046 initial_state_safety->send_deterministic = 1;
1058 void MC_modelcheck_liveness(){
1060 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1064 mc_time = xbt_new0(double, simix_process_maxpid);
1066 /* mc_time refers to clock for each process -> ignore it for heap comparison */
1067 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
1071 /* Initialize statistics */
1072 mc_stats = xbt_new0(s_mc_stats_t, 1);
1073 mc_stats->state_size = 1;
1075 /* Create exploration stack */
1076 mc_stack_liveness = xbt_fifo_new();
1078 /* Create the initial state */
1079 initial_state_liveness = xbt_new0(s_mc_global_t, 1);
1081 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0'))
1082 MC_init_dot_output();
1089 MC_print_statistics(mc_stats);
1106 int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max){
1108 return simcall->mc_value;
1112 int MC_random(int min, int max)
1114 /*FIXME: return mc_current_state->executed_transition->random.value;*/
1115 return simcall_mc_random(min, max);
1119 * \brief Schedules all the process that are ready to run
1121 void MC_wait_for_requests(void)
1123 smx_process_t process;
1127 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
1128 SIMIX_process_runall();
1129 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
1130 req = &process->simcall;
1131 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
1132 SIMIX_simcall_pre(req, 0);
1137 int MC_deadlock_check()
1139 int deadlock = FALSE;
1140 smx_process_t process;
1141 if(xbt_swag_size(simix_global->process_list)){
1143 xbt_swag_foreach(process, simix_global->process_list){
1144 if(process->simcall.call != SIMCALL_NONE
1145 && MC_request_is_enabled(&process->simcall)){
1155 * \brief Re-executes from the state at position start all the transitions indicated by
1156 * a given model-checker stack.
1157 * \param stack The stack with the transitions to execute.
1158 * \param start Start index to begin the re-execution.
1160 void MC_replay(xbt_fifo_t stack, int start)
1162 int raw_mem = (mmalloc_get_current_heap() == raw_heap);
1164 int value, i = 1, count = 1;
1166 smx_simcall_t req = NULL, saved_req = NULL;
1167 xbt_fifo_item_t item, start_item;
1169 smx_process_t process = NULL;
1170 int comm_pattern = 0;
1172 XBT_DEBUG("**** Begin Replay ****");
1175 /* Restore the initial state */
1176 MC_restore_snapshot(initial_state_safety->snapshot);
1177 /* At the moment of taking the snapshot the raw heap was set, so restoring
1178 * it will set it back again, we have to unset it to continue */
1182 start_item = xbt_fifo_get_last_item(stack);
1185 start_item = xbt_fifo_get_prev_item(start_item);
1191 xbt_dict_reset(first_enabled_state);
1192 xbt_swag_foreach(process, simix_global->process_list){
1193 if(MC_process_is_enabled(process)){
1194 char *key = bprintf("%lu", process->pid);
1195 char *data = bprintf("%d", count);
1196 xbt_dict_set(first_enabled_state, key, data, NULL);
1200 xbt_dynar_reset(communications_pattern);
1204 /* Traverse the stack from the state at position start and re-execute the transitions */
1205 for (item = start_item;
1206 item != xbt_fifo_get_first_item(stack);
1207 item = xbt_fifo_get_prev_item(item)) {
1209 state = (mc_state_t) xbt_fifo_get_item_content(item);
1210 saved_req = MC_state_get_executed_request(state, &value);
1213 char *key = bprintf("%lu", saved_req->issuer->pid);
1214 xbt_dict_remove(first_enabled_state, key);
1219 /* because we got a copy of the executed request, we have to fetch the
1220 real one, pointed by the request field of the issuer process */
1221 req = &saved_req->issuer->simcall;
1223 /* Debug information */
1224 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1225 req_str = MC_request_to_string(req, value);
1226 XBT_DEBUG("Replay: %s (%p)", req_str, state);
1231 if(req->call == SIMCALL_COMM_ISEND)
1233 else if(req->call == SIMCALL_COMM_IRECV)
1236 SIMIX_simcall_pre(req, value);
1239 if(comm_pattern != 0){
1240 get_comm_pattern(communications_pattern, req, comm_pattern);
1246 MC_wait_for_requests();
1251 /* Insert in dict all enabled processes */
1252 xbt_swag_foreach(process, simix_global->process_list){
1253 if(MC_process_is_enabled(process) /*&& !MC_state_process_is_done(state, process)*/){
1254 char *key = bprintf("%lu", process->pid);
1255 if(xbt_dict_get_or_null(first_enabled_state, key) == NULL){
1256 char *data = bprintf("%d", count);
1257 xbt_dict_set(first_enabled_state, key, data, NULL);
1264 /* Update statistics */
1265 mc_stats->visited_states++;
1266 mc_stats->executed_transitions++;
1270 XBT_DEBUG("**** End Replay ****");
1280 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
1283 initial_state_liveness->raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1287 smx_simcall_t req = NULL, saved_req = NULL;
1288 xbt_fifo_item_t item;
1293 XBT_DEBUG("**** Begin Replay ****");
1295 /* Restore the initial state */
1296 MC_restore_snapshot(initial_state_liveness->snapshot);
1298 /* At the moment of taking the snapshot the raw heap was set, so restoring
1299 * it will set it back again, we have to unset it to continue */
1300 if(!initial_state_liveness->raw_mem_set)
1305 item = xbt_fifo_get_last_item(stack);
1307 while(depth <= xbt_fifo_size(stack)){
1309 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1310 state = (mc_state_t) pair->graph_state;
1312 if(pair->requests > 0){
1314 saved_req = MC_state_get_executed_request(state, &value);
1315 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1317 if(saved_req != NULL){
1318 /* because we got a copy of the executed request, we have to fetch the
1319 real one, pointed by the request field of the issuer process */
1320 req = &saved_req->issuer->simcall;
1321 //XBT_DEBUG("Req->call %u", req->call);
1323 /* Debug information */
1324 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1325 req_str = MC_request_to_string(req, value);
1326 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1332 SIMIX_simcall_pre(req, value);
1333 MC_wait_for_requests();
1338 /* Update statistics */
1339 mc_stats->visited_pairs++;
1340 mc_stats->executed_transitions++;
1342 item = xbt_fifo_get_prev_item(item);
1347 /* Traverse the stack from the initial state and re-execute the transitions */
1348 for (item = xbt_fifo_get_last_item(stack);
1349 item != xbt_fifo_get_first_item(stack);
1350 item = xbt_fifo_get_prev_item(item)) {
1352 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
1353 state = (mc_state_t) pair->graph_state;
1355 if(pair->requests > 0){
1357 saved_req = MC_state_get_executed_request(state, &value);
1358 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
1360 if(saved_req != NULL){
1361 /* because we got a copy of the executed request, we have to fetch the
1362 real one, pointed by the request field of the issuer process */
1363 req = &saved_req->issuer->simcall;
1364 //XBT_DEBUG("Req->call %u", req->call);
1366 /* Debug information */
1367 if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
1368 req_str = MC_request_to_string(req, value);
1369 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
1375 SIMIX_simcall_pre(req, value);
1376 MC_wait_for_requests();
1381 /* Update statistics */
1382 mc_stats->visited_pairs++;
1383 mc_stats->executed_transitions++;
1387 XBT_DEBUG("**** End Replay ****");
1389 if(initial_state_liveness->raw_mem_set)
1397 * \brief Dumps the contents of a model-checker's stack and shows the actual
1399 * \param stack The stack to dump
1401 void MC_dump_stack_safety(xbt_fifo_t stack)
1404 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1406 MC_show_stack_safety(stack);
1408 if(!_sg_mc_checkpoint){
1413 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
1414 MC_state_delete(state);
1427 void MC_show_stack_safety(xbt_fifo_t stack)
1430 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1436 xbt_fifo_item_t item;
1438 char *req_str = NULL;
1440 for (item = xbt_fifo_get_last_item(stack);
1441 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
1442 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1443 req = MC_state_get_executed_request(state, &value);
1445 req_str = MC_request_to_string(req, value);
1446 XBT_INFO("%s", req_str);
1455 void MC_show_deadlock(smx_simcall_t req)
1457 /*char *req_str = NULL;*/
1458 XBT_INFO("**************************");
1459 XBT_INFO("*** DEAD-LOCK DETECTED ***");
1460 XBT_INFO("**************************");
1461 XBT_INFO("Locked request:");
1462 /*req_str = MC_request_to_string(req);
1463 XBT_INFO("%s", req_str);
1464 xbt_free(req_str);*/
1465 XBT_INFO("Counter-example execution trace:");
1466 MC_dump_stack_safety(mc_stack_safety);
1467 MC_print_statistics(mc_stats);
1471 void MC_show_stack_liveness(xbt_fifo_t stack){
1474 xbt_fifo_item_t item;
1476 char *req_str = NULL;
1478 for (item = xbt_fifo_get_last_item(stack);
1479 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
1480 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
1481 req = MC_state_get_executed_request(pair->graph_state, &value);
1483 if(pair->requests>0){
1484 req_str = MC_request_to_string(req, value);
1485 XBT_INFO("%s", req_str);
1488 XBT_INFO("End of system requests but evolution in Büchi automaton");
1494 void MC_dump_stack_liveness(xbt_fifo_t stack){
1496 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1501 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
1502 MC_pair_delete(pair);
1511 void MC_print_statistics(mc_stats_t stats)
1513 if(stats->expanded_pairs == 0){
1514 XBT_INFO("Expanded states = %lu", stats->expanded_states);
1515 XBT_INFO("Visited states = %lu", stats->visited_states);
1517 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
1518 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
1520 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
1522 if((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0]!='\0')){
1523 fprintf(dot_output, "}\n");
1526 if(initial_state_safety != NULL){
1527 // XBT_INFO("Communication-deterministic : %s", !initial_state_safety->comm_deterministic ? "No" : "Yes");
1528 // XBT_INFO("Send-deterministic : %s", !initial_state_safety->send_deterministic ? "No" : "Yes");
1533 void MC_assert(int prop)
1535 if (MC_is_active() && !prop){
1536 XBT_INFO("**************************");
1537 XBT_INFO("*** PROPERTY NOT VALID ***");
1538 XBT_INFO("**************************");
1539 XBT_INFO("Counter-example execution trace:");
1540 MC_dump_stack_safety(mc_stack_safety);
1541 MC_print_statistics(mc_stats);
1547 user_max_depth_reached = 1;
1550 void MC_process_clock_add(smx_process_t process, double amount)
1552 mc_time[process->pid] += amount;
1555 double MC_process_clock_get(smx_process_t process)
1559 return mc_time[process->pid];
1567 void MC_automaton_load(const char *file){
1569 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1573 if (_mc_property_automaton == NULL)
1574 _mc_property_automaton = xbt_automaton_new();
1576 xbt_automaton_load(_mc_property_automaton,file);
1585 void MC_automaton_new_propositional_symbol(const char* id, void* fct) {
1587 int raw_mem_set = (mmalloc_get_current_heap() == raw_heap);
1591 if (_mc_property_automaton == NULL)
1592 _mc_property_automaton = xbt_automaton_new();
1594 xbt_automaton_propositional_symbol_new(_mc_property_automaton,id,fct);