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. */
17 #include "simgrid/sg_config.h"
18 #include "../surf/surf_private.h"
19 #include "../simix/smx_private.h"
21 #include "xbt/automaton.h"
25 #include <libunwind.h>
27 #include "../xbt/mmalloc/mmprivate.h"
28 #include "mc_object_info.h"
29 #include "mc_comm_pattern.h"
30 #include "mc_request.h"
31 #include "mc_safety.h"
32 #include "mc_memory_map.h"
33 #include "mc_snapshot.h"
34 #include "mc_liveness.h"
35 #include "mc_private.h"
38 #include "mc_record.h"
39 #include "mc_protocol.h"
40 #include "mc_client.h"
42 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
43 "Logging specific to MC (global)");
47 double *mc_time = NULL;
50 int user_max_depth_reached = 0;
52 /* MC global data structures */
53 mc_state_t mc_current_state = NULL;
54 char mc_replay_mode = FALSE;
56 __thread mc_comparison_times_t mc_comp_times = NULL;
57 __thread double mc_snapshot_comparison_time;
58 mc_stats_t mc_stats = NULL;
59 mc_global_t initial_global_state = NULL;
60 xbt_fifo_t mc_stack = NULL;
63 xbt_automaton_t _mc_property_automaton = NULL;
66 FILE *dot_output = NULL;
67 const char *colors[13];
70 /******************************* Initialisation of MC *******************************/
71 /*********************************************************************************/
73 static void MC_init_dot_output()
74 { /* FIXME : more colors */
79 colors[3] = "goldenrod";
82 colors[6] = "magenta";
83 colors[7] = "turquoise4";
85 colors[9] = "forestgreen";
86 colors[10] = "hotpink";
87 colors[11] = "lightblue";
90 dot_output = fopen(_sg_mc_dot_output_file, "w");
92 if (dot_output == NULL) {
93 perror("Error open dot output file");
98 "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");
104 MC_init_pid(getpid(), -1);
107 void MC_init_pid(pid_t pid, int socket)
109 if (mc_mode == MC_MODE_NONE) {
110 if (getenv(MC_ENV_SOCKET_FD)) {
111 mc_mode = MC_MODE_CLIENT;
113 mc_mode = MC_MODE_STANDALONE;
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(pid, socket);
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)
186 if (mc_mode == MC_MODE_STANDALONE || mc_mode == MC_MODE_CLIENT) {
187 xbt_swag_foreach(process, simix_global->process_list) {
188 MC_ignore_heap(&(process->process_hookup),
189 sizeof(process->process_hookup));
199 if (mc_mode == MC_MODE_CLIENT) {
200 // This will move somehwere else:
201 MC_client_handle_messages();
206 /******************************* Core of MC *******************************/
207 /**************************************************************************/
209 static void MC_modelcheck_comm_determinism_init(void)
212 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
219 /* Create exploration stack */
220 mc_stack = xbt_fifo_new();
224 MC_pre_modelcheck_comm_determinism();
227 initial_global_state = xbt_new0(s_mc_global_t, 1);
228 initial_global_state->snapshot = MC_take_snapshot(0);
229 initial_global_state->initial_communications_pattern_done = 0;
230 initial_global_state->comm_deterministic = 1;
231 initial_global_state->send_deterministic = 1;
234 MC_modelcheck_comm_determinism();
241 static void MC_modelcheck_safety_init(void)
243 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
252 /* Create exploration stack */
253 mc_stack = xbt_fifo_new();
257 MC_pre_modelcheck_safety();
260 /* Save the initial state */
261 initial_global_state = xbt_new0(s_mc_global_t, 1);
262 initial_global_state->snapshot = MC_take_snapshot(0);
265 MC_modelcheck_safety();
274 static void MC_modelcheck_liveness_init()
277 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
286 /* Create exploration stack */
287 mc_stack = xbt_fifo_new();
289 /* Create the initial state */
290 initial_global_state = xbt_new0(s_mc_global_t, 1);
294 MC_pre_modelcheck_liveness();
297 MC_print_statistics(mc_stats);
305 void MC_do_the_modelcheck_for_real()
308 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
309 XBT_INFO("Check communication determinism");
310 MC_modelcheck_comm_determinism_init();
311 } else if (!_sg_mc_property_file || _sg_mc_property_file[0] == '\0') {
312 if (mc_reduce_kind == e_mc_reduce_unset)
313 mc_reduce_kind = e_mc_reduce_dpor;
314 XBT_INFO("Check a safety property");
315 MC_modelcheck_safety_init();
317 if (mc_reduce_kind == e_mc_reduce_unset)
318 mc_reduce_kind = e_mc_reduce_none;
319 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
320 MC_automaton_load(_sg_mc_property_file);
321 MC_modelcheck_liveness_init();
334 int MC_deadlock_check()
336 int deadlock = FALSE;
337 smx_process_t process;
338 if (xbt_swag_size(simix_global->process_list)) {
340 xbt_swag_foreach(process, simix_global->process_list) {
341 if (MC_request_is_enabled(&process->simcall)) {
350 void mc_update_comm_pattern(mc_call_type call_type, smx_simcall_t req, int value, xbt_dynar_t pattern) {
352 case MC_CALL_TYPE_NONE:
354 case MC_CALL_TYPE_SEND:
355 case MC_CALL_TYPE_RECV:
356 get_comm_pattern(pattern, req, call_type);
358 case MC_CALL_TYPE_WAIT:
360 smx_synchro_t current_comm = NULL;
361 if (call_type == MC_CALL_TYPE_WAIT)
362 current_comm = simcall_comm_wait__get__comm(req);
364 current_comm = xbt_dynar_get_as(simcall_comm_waitany__get__comms(req), value, smx_synchro_t);
365 // First wait only must be considered:
366 if (current_comm->comm.refcount == 1)
367 complete_comm_pattern(pattern, current_comm);
371 xbt_die("Unexpected call type %i", (int)call_type);
376 * \brief Re-executes from the state at position start all the transitions indicated by
377 * a given model-checker stack.
378 * \param stack The stack with the transitions to execute.
379 * \param start Start index to begin the re-execution.
381 * If start==-1, restore the initial state and replay the actions the
382 * the transitions in the stack.
384 * Otherwise, we only replay a part of the transitions of the stacks
385 * without restoring the state: it is assumed that the current state
386 * match with the transitions to execute.
388 void MC_replay(xbt_fifo_t stack, int start)
390 int raw_mem = (mmalloc_get_current_heap() == mc_heap);
392 int value, i = 1, count = 1, j;
394 smx_simcall_t req = NULL, saved_req = NULL;
395 xbt_fifo_item_t item, start_item;
397 smx_process_t process = NULL;
399 XBT_DEBUG("**** Begin Replay ****");
402 /* Restore the initial state */
403 MC_restore_snapshot(initial_global_state->snapshot);
404 /* At the moment of taking the snapshot the raw heap was set, so restoring
405 * it will set it back again, we have to unset it to continue */
409 start_item = xbt_fifo_get_last_item(stack);
412 start_item = xbt_fifo_get_prev_item(start_item);
419 if (mc_reduce_kind == e_mc_reduce_dpor) {
420 xbt_dict_reset(first_enabled_state);
421 xbt_swag_foreach(process, simix_global->process_list) {
422 if (MC_process_is_enabled(process)) {
423 char *key = bprintf("%lu", process->pid);
424 char *data = bprintf("%d", count);
425 xbt_dict_set(first_enabled_state, key, data, NULL);
431 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
432 for (j=0; j<simix_process_maxpid; j++) {
433 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(communications_pattern, j, xbt_dynar_t));
435 for (j=0; j<simix_process_maxpid; j++) {
436 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
442 /* Traverse the stack from the state at position start and re-execute the transitions */
443 for (item = start_item;
444 item != xbt_fifo_get_first_item(stack);
445 item = xbt_fifo_get_prev_item(item)) {
447 state = (mc_state_t) xbt_fifo_get_item_content(item);
448 saved_req = MC_state_get_executed_request(state, &value);
450 if (mc_reduce_kind == e_mc_reduce_dpor) {
452 char *key = bprintf("%lu", saved_req->issuer->pid);
453 if(xbt_dict_get_or_null(first_enabled_state, key))
454 xbt_dict_remove(first_enabled_state, key);
460 /* because we got a copy of the executed request, we have to fetch the
461 real one, pointed by the request field of the issuer process */
462 req = &saved_req->issuer->simcall;
464 /* Debug information */
465 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
466 req_str = MC_request_to_string(req, value);
467 XBT_DEBUG("Replay: %s (%p)", req_str, state);
471 /* TODO : handle test and testany simcalls */
472 mc_call_type call = MC_CALL_TYPE_NONE;
473 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
474 call = mc_get_call_type(req);
477 SIMIX_simcall_handle(req, value);
479 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
481 mc_update_comm_pattern(call, req, value, communications_pattern);
485 MC_wait_for_requests();
489 if (mc_reduce_kind == e_mc_reduce_dpor) {
491 /* Insert in dict all enabled processes */
492 xbt_swag_foreach(process, simix_global->process_list) {
493 if (MC_process_is_enabled(process) ) {
494 char *key = bprintf("%lu", process->pid);
495 if (xbt_dict_get_or_null(first_enabled_state, key) == NULL) {
496 char *data = bprintf("%d", count);
497 xbt_dict_set(first_enabled_state, key, data, NULL);
506 /* Update statistics */
507 mc_stats->visited_states++;
508 mc_stats->executed_transitions++;
512 XBT_DEBUG("**** End Replay ****");
522 void MC_replay_liveness(xbt_fifo_t stack, int all_stack)
525 initial_global_state->raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
527 xbt_fifo_item_t item;
530 XBT_DEBUG("**** Begin Replay ****");
532 /* Restore the initial state */
533 MC_restore_snapshot(initial_global_state->snapshot);
535 /* At the moment of taking the snapshot the raw heap was set, so restoring
536 * it will set it back again, we have to unset it to continue */
537 if (!initial_global_state->raw_mem_set)
540 /* Traverse the stack from the initial state and re-execute the transitions */
541 for (item = xbt_fifo_get_last_item(stack);
542 all_stack ? depth <= xbt_fifo_size(stack) : item != xbt_fifo_get_first_item(stack);
543 item = xbt_fifo_get_prev_item(item)) {
545 mc_pair_t pair = (mc_pair_t) xbt_fifo_get_item_content(item);
547 mc_state_t state = (mc_state_t) pair->graph_state;
548 smx_simcall_t req = NULL, saved_req = NULL;
552 if (pair->requests > 0) {
554 saved_req = MC_state_get_executed_request(state, &value);
555 //XBT_DEBUG("SavedReq->call %u", saved_req->call);
557 if (saved_req != NULL) {
558 /* because we got a copy of the executed request, we have to fetch the
559 real one, pointed by the request field of the issuer process */
560 req = &saved_req->issuer->simcall;
561 //XBT_DEBUG("Req->call %u", req->call);
563 /* Debug information */
564 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
565 req_str = MC_request_to_string(req, value);
566 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
572 SIMIX_simcall_handle(req, value);
573 MC_wait_for_requests();
576 /* Update statistics */
577 mc_stats->visited_pairs++;
578 mc_stats->executed_transitions++;
584 XBT_DEBUG("**** End Replay ****");
586 if (initial_global_state->raw_mem_set)
594 * \brief Dumps the contents of a model-checker's stack and shows the actual
596 * \param stack The stack to dump
598 void MC_dump_stack_safety(xbt_fifo_t stack)
601 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
603 MC_show_stack_safety(stack);
605 if (!_sg_mc_checkpoint) {
610 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
611 MC_state_delete(state);
624 void MC_show_stack_safety(xbt_fifo_t stack)
627 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
633 xbt_fifo_item_t item;
635 char *req_str = NULL;
637 for (item = xbt_fifo_get_last_item(stack);
638 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
639 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
640 req = MC_state_get_executed_request(state, &value);
642 req_str = MC_request_to_string(req, value);
643 XBT_INFO("%s", req_str);
652 void MC_show_deadlock(smx_simcall_t req)
654 /*char *req_str = NULL; */
655 XBT_INFO("**************************");
656 XBT_INFO("*** DEAD-LOCK DETECTED ***");
657 XBT_INFO("**************************");
658 XBT_INFO("Locked request:");
659 /*req_str = MC_request_to_string(req);
660 XBT_INFO("%s", req_str);
661 xbt_free(req_str); */
662 XBT_INFO("Counter-example execution trace:");
663 MC_dump_stack_safety(mc_stack);
664 MC_print_statistics(mc_stats);
668 void MC_show_stack_liveness(xbt_fifo_t stack)
672 xbt_fifo_item_t item;
674 char *req_str = NULL;
676 for (item = xbt_fifo_get_last_item(stack);
677 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item)))
678 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
679 req = MC_state_get_executed_request(pair->graph_state, &value);
681 if (pair->requests > 0) {
682 req_str = MC_request_to_string(req, value);
683 XBT_INFO("%s", req_str);
686 XBT_INFO("End of system requests but evolution in Büchi automaton");
692 void MC_dump_stack_liveness(xbt_fifo_t stack)
695 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
700 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
701 MC_pair_delete(pair);
710 void MC_print_statistics(mc_stats_t stats)
712 xbt_mheap_t previous_heap = mmalloc_get_current_heap();
714 if (stats->expanded_pairs == 0) {
715 XBT_INFO("Expanded states = %lu", stats->expanded_states);
716 XBT_INFO("Visited states = %lu", stats->visited_states);
718 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
719 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
721 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
723 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0')) {
724 fprintf(dot_output, "}\n");
727 if (initial_global_state != NULL) {
728 if (_sg_mc_comms_determinism)
729 XBT_INFO("Communication-deterministic : %s",
730 !initial_global_state->comm_deterministic ? "No" : "Yes");
731 if (_sg_mc_send_determinism)
732 XBT_INFO("Send-deterministic : %s",
733 !initial_global_state->send_deterministic ? "No" : "Yes");
735 mmalloc_set_current_heap(previous_heap);
738 void MC_assert(int prop)
740 if (MC_is_active() && !prop) {
741 XBT_INFO("**************************");
742 XBT_INFO("*** PROPERTY NOT VALID ***");
743 XBT_INFO("**************************");
744 XBT_INFO("Counter-example execution trace:");
745 MC_record_dump_path(mc_stack);
746 MC_dump_stack_safety(mc_stack);
747 MC_print_statistics(mc_stats);
754 user_max_depth_reached = 1;
757 void MC_automaton_load(const char *file)
760 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
764 if (_mc_property_automaton == NULL)
765 _mc_property_automaton = xbt_automaton_new();
767 xbt_automaton_load(_mc_property_automaton, file);
776 void MC_automaton_new_propositional_symbol(const char *id, void *fct)
779 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
783 if (_mc_property_automaton == NULL)
784 _mc_property_automaton = xbt_automaton_new();
786 xbt_automaton_propositional_symbol_new(_mc_property_automaton, id, fct);
795 void MC_dump_stacks(FILE* file)
797 int raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
801 stack_region_t current_stack;
803 xbt_dynar_foreach(stacks_areas, cursor, current_stack) {
804 unw_context_t * context = (unw_context_t *)current_stack->context;
805 fprintf(file, "Stack %i:\n", nstack);
810 unw_init_local (&c, context);
813 const char * name = !unw_get_proc_name(&c, buffer, 100, &off) ? buffer : "?";
814 fprintf(file, " %i: %s\n", nframe, name);
816 } while(unw_step(&c));
826 double MC_process_clock_get(smx_process_t process)
830 return mc_time[process->pid];
838 void MC_process_clock_add(smx_process_t process, double amount)
840 mc_time[process->pid] += amount;