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. */
15 #include "simgrid/sg_config.h"
16 #include "../surf/surf_private.h"
17 #include "../simix/smx_private.h"
19 #include "xbt/automaton.h"
23 #define UNW_LOCAL_ONLY
24 #include <libunwind.h>
26 #include "../xbt/mmalloc/mmprivate.h"
27 #include "mc_object_info.h"
28 #include "mc_comm_pattern.h"
29 #include "mc_request.h"
30 #include "mc_safety.h"
31 #include "mc_memory_map.h"
32 #include "mc_snapshot.h"
33 #include "mc_liveness.h"
34 #include "mc_private.h"
36 #include "mc_record.h"
38 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
39 "Logging specific to MC (global)");
41 double *mc_time = NULL;
44 int user_max_depth_reached = 0;
46 /* MC global data structures */
47 mc_state_t mc_current_state = NULL;
48 char mc_replay_mode = FALSE;
50 __thread mc_comparison_times_t mc_comp_times = NULL;
51 __thread double mc_snapshot_comparison_time;
52 mc_stats_t mc_stats = NULL;
53 mc_global_t initial_global_state = NULL;
54 xbt_fifo_t mc_stack = NULL;
57 xbt_automaton_t _mc_property_automaton = NULL;
60 FILE *dot_output = NULL;
61 const char *colors[13];
64 /******************************* Initialisation of MC *******************************/
65 /*********************************************************************************/
67 static void MC_init_dot_output()
68 { /* FIXME : more colors */
73 colors[3] = "goldenrod";
76 colors[6] = "magenta";
77 colors[7] = "turquoise4";
79 colors[9] = "forestgreen";
80 colors[10] = "hotpink";
81 colors[11] = "lightblue";
84 dot_output = fopen(_sg_mc_dot_output_file, "w");
86 if (dot_output == NULL) {
87 perror("Error open dot output file");
92 "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");
96 mc_model_checker_t mc_model_checker = NULL;
98 mc_model_checker_t MC_model_checker_new()
100 mc_model_checker_t mc = xbt_new0(s_mc_model_checker_t, 1);
101 mc->pages = mc_pages_store_new();
102 mc->fd_clear_refs = -1;
104 MC_process_init(&mc->process, getpid());
108 void MC_model_checker_delete(mc_model_checker_t mc) {
109 mc_pages_store_delete(mc->pages);
111 xbt_dynar_free(&mc->record);
112 MC_process_clear(&mc->process);
117 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
119 mc_time = xbt_new0(double, simix_process_maxpid);
121 /* Initialize the data structures that must be persistent across every
122 iteration of the model-checker (in RAW memory) */
126 mc_model_checker = MC_model_checker_new();
128 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
130 /* Initialize statistics */
131 mc_stats = xbt_new0(s_mc_stats_t, 1);
132 mc_stats->state_size = 1;
134 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0'))
135 MC_init_dot_output();
138 //parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
142 if (_sg_mc_visited > 0 || _sg_mc_liveness) {
143 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
144 MC_ignore_local_variable("e", "*");
145 MC_ignore_local_variable("__ex_cleanup", "*");
146 MC_ignore_local_variable("__ex_mctx_en", "*");
147 MC_ignore_local_variable("__ex_mctx_me", "*");
148 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
149 MC_ignore_local_variable("_log_ev", "*");
150 MC_ignore_local_variable("_throw_ctx", "*");
151 MC_ignore_local_variable("ctx", "*");
153 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
154 MC_ignore_local_variable("next_cont"
155 "ext", "smx_ctx_sysv_suspend_serial");
156 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
158 /* Ignore local variable about time used for tracing */
159 MC_ignore_local_variable("start_time", "*");
162 MC_ignore_global_variable("mc_model_checker");
163 MC_ignore_global_variable("communications_pattern");
164 MC_ignore_global_variable("initial_communications_pattern");
165 MC_ignore_global_variable("incomplete_communications_pattern");
167 /* MC __thread variables: */
168 MC_ignore_global_variable("mc_diff_info");
169 MC_ignore_global_variable("mc_comp_times");
170 MC_ignore_global_variable("mc_snapshot_comparison_time");
172 /* This MC state is used in MC replay as well: */
173 MC_ignore_global_variable("mc_time");
175 /* Static variable used for tracing */
176 MC_ignore_global_variable("counter");
179 MC_ignore_global_variable("smx_total_comms");
181 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
183 smx_process_t process;
184 // FIXME, cross-process support (simix_global->process_list)
185 xbt_swag_foreach(process, simix_global->process_list) {
186 MC_ignore_heap(&(process->process_hookup),
187 sizeof(process->process_hookup));
196 /******************************* Core of MC *******************************/
197 /**************************************************************************/
199 static void MC_modelcheck_comm_determinism_init(void)
202 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
209 /* Create exploration stack */
210 mc_stack = xbt_fifo_new();
214 MC_pre_modelcheck_comm_determinism();
217 initial_global_state = xbt_new0(s_mc_global_t, 1);
218 initial_global_state->snapshot = MC_take_snapshot(0);
219 initial_global_state->initial_communications_pattern_done = 0;
220 initial_global_state->comm_deterministic = 1;
221 initial_global_state->send_deterministic = 1;
224 MC_modelcheck_comm_determinism();
231 static void MC_modelcheck_safety_init(void)
233 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
242 /* Create exploration stack */
243 mc_stack = xbt_fifo_new();
247 MC_pre_modelcheck_safety();
250 /* Save the initial state */
251 initial_global_state = xbt_new0(s_mc_global_t, 1);
252 initial_global_state->snapshot = MC_take_snapshot(0);
255 MC_modelcheck_safety();
264 static void MC_modelcheck_liveness_init()
267 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
276 /* Create exploration stack */
277 mc_stack = xbt_fifo_new();
279 /* Create the initial state */
280 initial_global_state = xbt_new0(s_mc_global_t, 1);
284 MC_pre_modelcheck_liveness();
287 MC_print_statistics(mc_stats);
295 void MC_do_the_modelcheck_for_real()
298 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
299 XBT_INFO("Check communication determinism");
300 MC_modelcheck_comm_determinism_init();
301 } else if (!_sg_mc_property_file || _sg_mc_property_file[0] == '\0') {
302 if (mc_reduce_kind == e_mc_reduce_unset)
303 mc_reduce_kind = e_mc_reduce_dpor;
304 XBT_INFO("Check a safety property");
305 MC_modelcheck_safety_init();
307 if (mc_reduce_kind == e_mc_reduce_unset)
308 mc_reduce_kind = e_mc_reduce_none;
309 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
310 MC_automaton_load(_sg_mc_property_file);
311 MC_modelcheck_liveness_init();
324 int MC_deadlock_check()
326 int deadlock = FALSE;
327 smx_process_t process;
328 if (xbt_swag_size(simix_global->process_list)) {
330 xbt_swag_foreach(process, simix_global->process_list) {
331 if (MC_request_is_enabled(&process->simcall)) {
340 void mc_update_comm_pattern(mc_call_type call_type, smx_simcall_t req, int value, xbt_dynar_t pattern) {
342 case MC_CALL_TYPE_NONE:
344 case MC_CALL_TYPE_SEND:
345 case MC_CALL_TYPE_RECV:
346 get_comm_pattern(pattern, req, call_type);
348 case MC_CALL_TYPE_WAIT:
350 smx_synchro_t current_comm = NULL;
351 if (call_type == MC_CALL_TYPE_WAIT)
352 current_comm = simcall_comm_wait__get__comm(req);
354 current_comm = xbt_dynar_get_as(simcall_comm_waitany__get__comms(req), value, smx_synchro_t);
355 // First wait only must be considered:
356 if (current_comm->comm.refcount == 1)
357 complete_comm_pattern(pattern, current_comm);
361 xbt_die("Unexpected call type %i", (int)call_type);
366 * \brief Re-executes from the state at position start all the transitions indicated by
367 * a given model-checker stack.
368 * \param stack The stack with the transitions to execute.
369 * \param start Start index to begin the re-execution.
371 * If start==-1, restore the initial state and replay the actions the
372 * the transitions in the stack.
374 * Otherwise, we only replay a part of the transitions of the stacks
375 * without restoring the state: it is assumed that the current state
376 * match with the transitions to execute.
378 void MC_replay(xbt_fifo_t stack, int start)
380 int raw_mem = (mmalloc_get_current_heap() == mc_heap);
382 int value, i = 1, count = 1, j;
384 smx_simcall_t req = NULL, saved_req = NULL;
385 xbt_fifo_item_t item, start_item;
387 smx_process_t process = NULL;
389 XBT_DEBUG("**** Begin Replay ****");
392 /* Restore the initial state */
393 MC_restore_snapshot(initial_global_state->snapshot);
394 /* At the moment of taking the snapshot the raw heap was set, so restoring
395 * it will set it back again, we have to unset it to continue */
399 start_item = xbt_fifo_get_last_item(stack);
402 start_item = xbt_fifo_get_prev_item(start_item);
409 if (mc_reduce_kind == e_mc_reduce_dpor) {
410 xbt_dict_reset(first_enabled_state);
411 xbt_swag_foreach(process, simix_global->process_list) {
412 if (MC_process_is_enabled(process)) {
413 char *key = bprintf("%lu", process->pid);
414 char *data = bprintf("%d", count);
415 xbt_dict_set(first_enabled_state, key, data, NULL);
421 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
422 for (j=0; j<simix_process_maxpid; j++) {
423 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(communications_pattern, j, xbt_dynar_t));
425 for (j=0; j<simix_process_maxpid; j++) {
426 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
432 /* Traverse the stack from the state at position start and re-execute the transitions */
433 for (item = start_item;
434 item != xbt_fifo_get_first_item(stack);
435 item = xbt_fifo_get_prev_item(item)) {
437 state = (mc_state_t) xbt_fifo_get_item_content(item);
438 saved_req = MC_state_get_executed_request(state, &value);
440 if (mc_reduce_kind == e_mc_reduce_dpor) {
442 char *key = bprintf("%lu", saved_req->issuer->pid);
443 if(xbt_dict_get_or_null(first_enabled_state, key))
444 xbt_dict_remove(first_enabled_state, key);
450 /* because we got a copy of the executed request, we have to fetch the
451 real one, pointed by the request field of the issuer process */
452 req = &saved_req->issuer->simcall;
454 /* Debug information */
455 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
456 req_str = MC_request_to_string(req, value);
457 XBT_DEBUG("Replay: %s (%p)", req_str, state);
461 /* TODO : handle test and testany simcalls */
462 mc_call_type call = MC_CALL_TYPE_NONE;
463 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
464 call = mc_get_call_type(req);
467 SIMIX_simcall_handle(req, value);
469 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
471 mc_update_comm_pattern(call, req, value, communications_pattern);
475 MC_wait_for_requests();
479 if (mc_reduce_kind == e_mc_reduce_dpor) {
481 /* Insert in dict all enabled processes */
482 xbt_swag_foreach(process, simix_global->process_list) {
483 if (MC_process_is_enabled(process) ) {
484 char *key = bprintf("%lu", process->pid);
485 if (xbt_dict_get_or_null(first_enabled_state, key) == NULL) {
486 char *data = bprintf("%d", count);
487 xbt_dict_set(first_enabled_state, key, data, NULL);
496 /* Update statistics */
497 mc_stats->visited_states++;
498 mc_stats->executed_transitions++;
502 XBT_DEBUG("**** End Replay ****");
512 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
515 initial_global_state->raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
517 xbt_fifo_item_t item;
520 XBT_DEBUG("**** Begin Replay ****");
522 /* Restore the initial state */
523 MC_restore_snapshot(initial_global_state->snapshot);
525 /* At the moment of taking the snapshot the raw heap was set, so restoring
526 * it will set it back again, we have to unset it to continue */
527 if (!initial_global_state->raw_mem_set)
530 /* Traverse the stack from the initial state and re-execute the transitions */
531 for (item = xbt_fifo_get_last_item(stack);
532 all_stack ? depth <= xbt_fifo_size(stack) : item != xbt_fifo_get_first_item(stack);
533 item = xbt_fifo_get_prev_item(item)) {
535 mc_pair_t pair = (mc_pair_t) xbt_fifo_get_item_content(item);
537 mc_state_t state = (mc_state_t) pair->graph_state;
538 smx_simcall_t req = NULL, saved_req = NULL;
542 if (pair->requests > 0) {
544 saved_req = MC_state_get_executed_request(state, &value);
545 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
547 if (saved_req != NULL) {
548 /* because we got a copy of the executed request, we have to fetch the
549 real one, pointed by the request field of the issuer process */
550 req = &saved_req->issuer->simcall;
551 //XBT_DEBUG("Req->call %u", req->call);
553 /* Debug information */
554 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
555 req_str = MC_request_to_string(req, value);
556 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
562 SIMIX_simcall_handle(req, value);
563 MC_wait_for_requests();
566 /* Update statistics */
567 mc_stats->visited_pairs++;
568 mc_stats->executed_transitions++;
574 XBT_DEBUG("**** End Replay ****");
576 if (initial_global_state->raw_mem_set)
584 * \brief Dumps the contents of a model-checker's stack and shows the actual
586 * \param stack The stack to dump
588 void MC_dump_stack_safety(xbt_fifo_t stack)
591 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
593 MC_show_stack_safety(stack);
595 if (!_sg_mc_checkpoint) {
600 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
601 MC_state_delete(state);
614 void MC_show_stack_safety(xbt_fifo_t stack)
617 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
623 xbt_fifo_item_t item;
625 char *req_str = NULL;
627 for (item = xbt_fifo_get_last_item(stack);
628 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
629 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
630 req = MC_state_get_executed_request(state, &value);
632 req_str = MC_request_to_string(req, value);
633 XBT_INFO("%s", req_str);
642 void MC_show_deadlock(smx_simcall_t req)
644 /*char *req_str = NULL; */
645 XBT_INFO("**************************");
646 XBT_INFO("*** DEAD-LOCK DETECTED ***");
647 XBT_INFO("**************************");
648 XBT_INFO("Locked request:");
649 /*req_str = MC_request_to_string(req);
650 XBT_INFO("%s", req_str);
651 xbt_free(req_str); */
652 XBT_INFO("Counter-example execution trace:");
653 MC_dump_stack_safety(mc_stack);
654 MC_print_statistics(mc_stats);
658 void MC_show_stack_liveness(xbt_fifo_t stack)
662 xbt_fifo_item_t item;
664 char *req_str = NULL;
666 for (item = xbt_fifo_get_last_item(stack);
667 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
668 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
669 req = MC_state_get_executed_request(pair->graph_state, &value);
671 if (pair->requests > 0) {
672 req_str = MC_request_to_string(req, value);
673 XBT_INFO("%s", req_str);
676 XBT_INFO("End of system requests but evolution in Büchi automaton");
682 void MC_dump_stack_liveness(xbt_fifo_t stack)
685 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
690 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
691 MC_pair_delete(pair);
700 void MC_print_statistics(mc_stats_t stats)
702 xbt_mheap_t previous_heap = mmalloc_get_current_heap();
704 if (stats->expanded_pairs == 0) {
705 XBT_INFO("Expanded states = %lu", stats->expanded_states);
706 XBT_INFO("Visited states = %lu", stats->visited_states);
708 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
709 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
711 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
713 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0')) {
714 fprintf(dot_output, "}\n");
717 if (initial_global_state != NULL) {
718 if (_sg_mc_comms_determinism)
719 XBT_INFO("Communication-deterministic : %s",
720 !initial_global_state->comm_deterministic ? "No" : "Yes");
721 if (_sg_mc_send_determinism)
722 XBT_INFO("Send-deterministic : %s",
723 !initial_global_state->send_deterministic ? "No" : "Yes");
725 mmalloc_set_current_heap(previous_heap);
728 void MC_assert(int prop)
730 if (MC_is_active() && !prop) {
731 XBT_INFO("**************************");
732 XBT_INFO("*** PROPERTY NOT VALID ***");
733 XBT_INFO("**************************");
734 XBT_INFO("Counter-example execution trace:");
735 MC_record_dump_path(mc_stack);
736 MC_dump_stack_safety(mc_stack);
737 MC_print_statistics(mc_stats);
744 user_max_depth_reached = 1;
747 void MC_automaton_load(const char *file)
750 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
754 if (_mc_property_automaton == NULL)
755 _mc_property_automaton = xbt_automaton_new();
757 xbt_automaton_load(_mc_property_automaton, file);
766 void MC_automaton_new_propositional_symbol(const char *id, void *fct)
769 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
773 if (_mc_property_automaton == NULL)
774 _mc_property_automaton = xbt_automaton_new();
776 xbt_automaton_propositional_symbol_new(_mc_property_automaton, id, fct);
785 void MC_dump_stacks(FILE* file)
787 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
791 stack_region_t current_stack;
793 xbt_dynar_foreach(stacks_areas, cursor, current_stack) {
794 unw_context_t * context = (unw_context_t *)current_stack->context;
795 fprintf(file, "Stack %i:\n", nstack);
800 unw_init_local (&c, context);
803 const char * name = !unw_get_proc_name(&c, buffer, 100, &off) ? buffer : "?";
804 fprintf(file, " %i: %s\n", nframe, name);
806 } while(unw_step(&c));
816 double MC_process_clock_get(smx_process_t process)
820 return mc_time[process->pid];
828 void MC_process_clock_add(smx_process_t process, double amount)
830 mc_time[process->pid] += amount;