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. */
14 #define UNW_LOCAL_ONLY
15 #include <libunwind.h>
17 #include "simgrid/sg_config.h"
18 #include "../surf/surf_private.h"
19 #include "../simix/smx_private.h"
20 #include "../xbt/mmalloc/mmprivate.h"
22 #include "mc_private.h"
23 #include "xbt/automaton.h"
26 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
27 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
28 "Logging specific to MC (global)");
30 int user_max_depth_reached = 0;
32 /* MC global data structures */
33 mc_state_t mc_current_state = NULL;
34 char mc_replay_mode = FALSE;
35 double *mc_time = NULL;
36 __thread mc_comparison_times_t mc_comp_times = NULL;
37 __thread double mc_snapshot_comparison_time;
38 mc_stats_t mc_stats = NULL;
39 mc_global_t initial_global_state = NULL;
40 xbt_fifo_t mc_stack = NULL;
43 xbt_automaton_t _mc_property_automaton = NULL;
46 mc_object_info_t mc_libsimgrid_info = NULL;
47 mc_object_info_t mc_binary_info = NULL;
49 mc_object_info_t mc_object_infos[2] = { NULL, NULL };
51 size_t mc_object_infos_size = 2;
54 FILE *dot_output = NULL;
55 const char *colors[13];
58 /******************************* Initialisation of MC *******************************/
59 /*********************************************************************************/
61 static void MC_init_dot_output()
62 { /* FIXME : more colors */
67 colors[3] = "goldenrod";
70 colors[6] = "magenta";
71 colors[7] = "turquoise4";
73 colors[9] = "forestgreen";
74 colors[10] = "hotpink";
75 colors[11] = "lightblue";
78 dot_output = fopen(_sg_mc_dot_output_file, "w");
80 if (dot_output == NULL) {
81 perror("Error open dot output file");
86 "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");
90 static void MC_init_debug_info(void)
92 XBT_INFO("Get debug information ...");
94 memory_map_t maps = MC_get_memory_map();
96 /* Get local variables for state equality detection */
97 mc_binary_info = MC_find_object_info(maps, xbt_binary_name, 1);
98 mc_object_infos[0] = mc_binary_info;
100 mc_libsimgrid_info = MC_find_object_info(maps, libsimgrid_path, 0);
101 mc_object_infos[1] = mc_libsimgrid_info;
103 // Use information of the other objects:
104 MC_post_process_object_info(mc_binary_info);
105 MC_post_process_object_info(mc_libsimgrid_info);
107 MC_free_memory_map(maps);
108 XBT_INFO("Get debug information done !");
112 mc_model_checker_t mc_model_checker = NULL;
116 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
118 mc_time = xbt_new0(double, simix_process_maxpid);
120 /* Initialize the data structures that must be persistent across every
121 iteration of the model-checker (in RAW memory) */
125 mc_model_checker = xbt_new0(s_mc_model_checker_t, 1);
126 mc_model_checker->pages = mc_pages_store_new();
127 mc_model_checker->fd_clear_refs = -1;
128 mc_model_checker->fd_pagemap = -1;
130 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
132 /* Initialize statistics */
133 mc_stats = xbt_new0(s_mc_stats_t, 1);
134 mc_stats->state_size = 1;
136 MC_init_memory_map_info();
137 MC_init_debug_info(); /* FIXME : get debug information only if liveness verification or visited state reduction */
139 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0'))
140 MC_init_dot_output();
143 //parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
147 if (_sg_mc_visited > 0 || _sg_mc_liveness) {
148 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
149 MC_ignore_local_variable("e", "*");
150 MC_ignore_local_variable("__ex_cleanup", "*");
151 MC_ignore_local_variable("__ex_mctx_en", "*");
152 MC_ignore_local_variable("__ex_mctx_me", "*");
153 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
154 MC_ignore_local_variable("_log_ev", "*");
155 MC_ignore_local_variable("_throw_ctx", "*");
156 MC_ignore_local_variable("ctx", "*");
158 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
159 MC_ignore_local_variable("next_cont"
160 "ext", "smx_ctx_sysv_suspend_serial");
161 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
163 /* Ignore local variable about time used for tracing */
164 MC_ignore_local_variable("start_time", "*");
166 MC_ignore_global_variable("mc_model_checker");
168 // Mot of those things could be moved into mc_model_checker:
169 MC_ignore_global_variable("compared_pointers");
170 MC_ignore_global_variable("mc_comp_times");
171 MC_ignore_global_variable("mc_snapshot_comparison_time");
172 MC_ignore_global_variable("mc_time");
173 MC_ignore_global_variable("smpi_current_rank");
174 MC_ignore_global_variable("counter"); /* Static variable used for tracing */
175 MC_ignore_global_variable("maestro_stack_start");
176 MC_ignore_global_variable("maestro_stack_end");
177 MC_ignore_global_variable("smx_total_comms");
178 MC_ignore_global_variable("communications_pattern");
179 MC_ignore_global_variable("initial_communications_pattern");
180 MC_ignore_global_variable("incomplete_communications_pattern");
182 if (MC_is_active()) {
183 MC_ignore_global_variable("mc_diff_info");
186 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
188 smx_process_t process;
189 xbt_swag_foreach(process, simix_global->process_list) {
190 MC_ignore_heap(&(process->process_hookup),
191 sizeof(process->process_hookup));
200 /******************************* Core of MC *******************************/
201 /**************************************************************************/
203 static void MC_modelcheck_comm_determinism_init(void)
206 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
213 /* Create exploration stack */
214 mc_stack = xbt_fifo_new();
218 MC_pre_modelcheck_comm_determinism();
221 initial_global_state = xbt_new0(s_mc_global_t, 1);
222 initial_global_state->snapshot = MC_take_snapshot(0);
223 initial_global_state->initial_communications_pattern_done = 0;
224 initial_global_state->comm_deterministic = 1;
225 initial_global_state->send_deterministic = 1;
228 MC_modelcheck_comm_determinism();
235 static void MC_modelcheck_safety_init(void)
237 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
246 /* Create exploration stack */
247 mc_stack = xbt_fifo_new();
251 MC_pre_modelcheck_safety();
254 /* Save the initial state */
255 initial_global_state = xbt_new0(s_mc_global_t, 1);
256 initial_global_state->snapshot = MC_take_snapshot(0);
259 MC_modelcheck_safety();
268 static void MC_modelcheck_liveness_init()
271 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
280 /* Create exploration stack */
281 mc_stack = xbt_fifo_new();
283 /* Create the initial state */
284 initial_global_state = xbt_new0(s_mc_global_t, 1);
288 MC_pre_modelcheck_liveness();
291 MC_print_statistics(mc_stats);
299 void MC_do_the_modelcheck_for_real()
302 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
303 XBT_INFO("Check communication determinism");
304 MC_modelcheck_comm_determinism_init();
305 } else if (!_sg_mc_property_file || _sg_mc_property_file[0] == '\0') {
306 if (mc_reduce_kind == e_mc_reduce_unset)
307 mc_reduce_kind = e_mc_reduce_dpor;
308 XBT_INFO("Check a safety property");
309 MC_modelcheck_safety_init();
311 if (mc_reduce_kind == e_mc_reduce_unset)
312 mc_reduce_kind = e_mc_reduce_none;
313 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
314 MC_automaton_load(_sg_mc_property_file);
315 MC_modelcheck_liveness_init();
328 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
331 return simcall->mc_value;
335 int MC_random(int min, int max)
337 /*FIXME: return mc_current_state->executed_transition->random.value; */
338 return simcall_mc_random(min, max);
342 * \brief Schedules all the process that are ready to run
344 void MC_wait_for_requests(void)
346 smx_process_t process;
350 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
351 SIMIX_process_runall();
352 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
353 req = &process->simcall;
354 if (req->call != SIMCALL_NONE && !MC_request_is_visible(req))
355 SIMIX_simcall_handle(req, 0);
360 int MC_deadlock_check()
362 int deadlock = FALSE;
363 smx_process_t process;
364 if (xbt_swag_size(simix_global->process_list)) {
366 xbt_swag_foreach(process, simix_global->process_list) {
367 if (MC_request_is_enabled(&process->simcall)) {
376 void mc_update_comm_pattern(mc_call_type call_type, smx_simcall_t req, int value, xbt_dynar_t pattern) {
378 case MC_CALL_TYPE_NONE:
380 case MC_CALL_TYPE_SEND:
381 case MC_CALL_TYPE_RECV:
382 get_comm_pattern(pattern, req, call_type);
384 case MC_CALL_TYPE_WAIT:
386 smx_synchro_t current_comm = NULL;
387 if (call_type == MC_CALL_TYPE_WAIT)
388 current_comm = simcall_comm_wait__get__comm(req);
390 current_comm = xbt_dynar_get_as(simcall_comm_waitany__get__comms(req), value, smx_synchro_t);
391 // First wait only must be considered:
392 if (current_comm->comm.refcount == 1)
393 complete_comm_pattern(pattern, current_comm);
397 xbt_die("Unexpected call type %i", (int)call_type);
402 * \brief Re-executes from the state at position start all the transitions indicated by
403 * a given model-checker stack.
404 * \param stack The stack with the transitions to execute.
405 * \param start Start index to begin the re-execution.
407 void MC_replay(xbt_fifo_t stack, int start)
409 int raw_mem = (mmalloc_get_current_heap() == mc_heap);
411 int value, i = 1, count = 1, j;
413 smx_simcall_t req = NULL, saved_req = NULL;
414 xbt_fifo_item_t item, start_item;
416 smx_process_t process = NULL;
418 XBT_DEBUG("**** Begin Replay ****");
421 /* Restore the initial state */
422 MC_restore_snapshot(initial_global_state->snapshot);
423 /* At the moment of taking the snapshot the raw heap was set, so restoring
424 * it will set it back again, we have to unset it to continue */
428 start_item = xbt_fifo_get_last_item(stack);
431 start_item = xbt_fifo_get_prev_item(start_item);
438 if (mc_reduce_kind == e_mc_reduce_dpor) {
439 xbt_dict_reset(first_enabled_state);
440 xbt_swag_foreach(process, simix_global->process_list) {
441 if (MC_process_is_enabled(process)) {
442 char *key = bprintf("%lu", process->pid);
443 char *data = bprintf("%d", count);
444 xbt_dict_set(first_enabled_state, key, data, NULL);
450 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
451 for (j=0; j<simix_process_maxpid; j++) {
452 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(communications_pattern, j, xbt_dynar_t));
454 for (j=0; j<simix_process_maxpid; j++) {
455 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
462 /* Traverse the stack from the state at position start and re-execute the transitions */
463 for (item = start_item;
464 item != xbt_fifo_get_first_item(stack);
465 item = xbt_fifo_get_prev_item(item)) {
467 state = (mc_state_t) xbt_fifo_get_item_content(item);
468 saved_req = MC_state_get_executed_request(state, &value);
470 if (mc_reduce_kind == e_mc_reduce_dpor) {
472 char *key = bprintf("%lu", saved_req->issuer->pid);
473 if(xbt_dict_get_or_null(first_enabled_state, key))
474 xbt_dict_remove(first_enabled_state, key);
480 /* because we got a copy of the executed request, we have to fetch the
481 real one, pointed by the request field of the issuer process */
482 req = &saved_req->issuer->simcall;
484 /* Debug information */
485 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
486 req_str = MC_request_to_string(req, value);
487 XBT_DEBUG("Replay: %s (%p)", req_str, state);
491 /* TODO : handle test and testany simcalls */
492 mc_call_type call = MC_CALL_TYPE_NONE;
493 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
494 call = mc_get_call_type(req);
497 SIMIX_simcall_handle(req, value);
499 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
501 mc_update_comm_pattern(call, req, value, communications_pattern);
505 MC_wait_for_requests();
509 if (mc_reduce_kind == e_mc_reduce_dpor) {
511 /* Insert in dict all enabled processes */
512 xbt_swag_foreach(process, simix_global->process_list) {
513 if (MC_process_is_enabled(process) ) {
514 char *key = bprintf("%lu", process->pid);
515 if (xbt_dict_get_or_null(first_enabled_state, key) == NULL) {
516 char *data = bprintf("%d", count);
517 xbt_dict_set(first_enabled_state, key, data, NULL);
526 /* Update statistics */
527 mc_stats->visited_states++;
528 mc_stats->executed_transitions++;
532 XBT_DEBUG("**** End Replay ****");
542 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
545 initial_global_state->raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
547 xbt_fifo_item_t item;
550 XBT_DEBUG("**** Begin Replay ****");
552 /* Restore the initial state */
553 MC_restore_snapshot(initial_global_state->snapshot);
555 /* At the moment of taking the snapshot the raw heap was set, so restoring
556 * it will set it back again, we have to unset it to continue */
557 if (!initial_global_state->raw_mem_set)
560 /* Traverse the stack from the initial state and re-execute the transitions */
561 for (item = xbt_fifo_get_last_item(stack);
562 all_stack ? depth <= xbt_fifo_size(stack) : item != xbt_fifo_get_first_item(stack);
563 item = xbt_fifo_get_prev_item(item)) {
565 mc_pair_t pair = (mc_pair_t) xbt_fifo_get_item_content(item);
567 mc_state_t state = (mc_state_t) pair->graph_state;
568 smx_simcall_t req = NULL, saved_req = NULL;
572 if (pair->requests > 0) {
574 saved_req = MC_state_get_executed_request(state, &value);
575 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
577 if (saved_req != NULL) {
578 /* because we got a copy of the executed request, we have to fetch the
579 real one, pointed by the request field of the issuer process */
580 req = &saved_req->issuer->simcall;
581 //XBT_DEBUG("Req->call %u", req->call);
583 /* Debug information */
584 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
585 req_str = MC_request_to_string(req, value);
586 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
592 SIMIX_simcall_handle(req, value);
593 MC_wait_for_requests();
596 /* Update statistics */
597 mc_stats->visited_pairs++;
598 mc_stats->executed_transitions++;
604 XBT_DEBUG("**** End Replay ****");
606 if (initial_global_state->raw_mem_set)
614 * \brief Dumps the contents of a model-checker's stack and shows the actual
616 * \param stack The stack to dump
618 void MC_dump_stack_safety(xbt_fifo_t stack)
621 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
623 MC_show_stack_safety(stack);
625 if (!_sg_mc_checkpoint) {
630 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
631 MC_state_delete(state);
644 void MC_show_stack_safety(xbt_fifo_t stack)
647 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
653 xbt_fifo_item_t item;
655 char *req_str = NULL;
657 for (item = xbt_fifo_get_last_item(stack);
658 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
659 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
660 req = MC_state_get_executed_request(state, &value);
662 req_str = MC_request_to_string(req, value);
663 XBT_INFO("%s", req_str);
672 void MC_show_deadlock(smx_simcall_t req)
674 /*char *req_str = NULL; */
675 XBT_INFO("**************************");
676 XBT_INFO("*** DEAD-LOCK DETECTED ***");
677 XBT_INFO("**************************");
678 XBT_INFO("Locked request:");
679 /*req_str = MC_request_to_string(req);
680 XBT_INFO("%s", req_str);
681 xbt_free(req_str); */
682 XBT_INFO("Counter-example execution trace:");
683 MC_dump_stack_safety(mc_stack);
684 MC_print_statistics(mc_stats);
688 void MC_show_stack_liveness(xbt_fifo_t stack)
692 xbt_fifo_item_t item;
694 char *req_str = NULL;
696 for (item = xbt_fifo_get_last_item(stack);
697 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
698 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
699 req = MC_state_get_executed_request(pair->graph_state, &value);
701 if (pair->requests > 0) {
702 req_str = MC_request_to_string(req, value);
703 XBT_INFO("%s", req_str);
706 XBT_INFO("End of system requests but evolution in Büchi automaton");
712 void MC_dump_stack_liveness(xbt_fifo_t stack)
715 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
720 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
721 MC_pair_delete(pair);
730 void MC_print_statistics(mc_stats_t stats)
732 xbt_mheap_t previous_heap = mmalloc_get_current_heap();
734 if (stats->expanded_pairs == 0) {
735 XBT_INFO("Expanded states = %lu", stats->expanded_states);
736 XBT_INFO("Visited states = %lu", stats->visited_states);
738 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
739 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
741 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
743 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0')) {
744 fprintf(dot_output, "}\n");
747 if (initial_global_state != NULL) {
748 if (_sg_mc_comms_determinism)
749 XBT_INFO("Communication-deterministic : %s",
750 !initial_global_state->comm_deterministic ? "No" : "Yes");
751 if (_sg_mc_send_determinism)
752 XBT_INFO("Send-deterministic : %s",
753 !initial_global_state->send_deterministic ? "No" : "Yes");
755 mmalloc_set_current_heap(previous_heap);
758 void MC_assert(int prop)
760 if (MC_is_active() && !prop) {
761 XBT_INFO("**************************");
762 XBT_INFO("*** PROPERTY NOT VALID ***");
763 XBT_INFO("**************************");
764 XBT_INFO("Counter-example execution trace:");
765 MC_dump_stack_safety(mc_stack);
766 MC_print_statistics(mc_stats);
773 user_max_depth_reached = 1;
776 void MC_process_clock_add(smx_process_t process, double amount)
778 mc_time[process->pid] += amount;
781 double MC_process_clock_get(smx_process_t process)
785 return mc_time[process->pid];
793 void MC_automaton_load(const char *file)
796 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
800 if (_mc_property_automaton == NULL)
801 _mc_property_automaton = xbt_automaton_new();
803 xbt_automaton_load(_mc_property_automaton, file);
812 void MC_automaton_new_propositional_symbol(const char *id, void *fct)
815 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
819 if (_mc_property_automaton == NULL)
820 _mc_property_automaton = xbt_automaton_new();
822 xbt_automaton_propositional_symbol_new(_mc_property_automaton, id, fct);
831 void MC_dump_stacks(FILE* file)
833 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
837 stack_region_t current_stack;
839 xbt_dynar_foreach(stacks_areas, cursor, current_stack) {
840 unw_context_t * context = (unw_context_t *)current_stack->context;
841 fprintf(file, "Stack %i:\n", nstack);
846 unw_init_local (&c, context);
849 const char * name = !unw_get_proc_name(&c, buffer, 100, &off) ? buffer : "?";
850 fprintf(file, " %i: %s\n", nframe, name);
852 } while(unw_step(&c));