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>
26 #include <xbt/mmalloc.h>
28 #include "../xbt/mmalloc/mmprivate.h"
29 #include "mc_object_info.h"
30 #include "mc_comm_pattern.h"
31 #include "mc_request.h"
32 #include "mc_safety.h"
33 #include "mc_memory_map.h"
34 #include "mc_snapshot.h"
35 #include "mc_liveness.h"
36 #include "mc_private.h"
39 #include "mc_record.h"
40 #include "mc_protocol.h"
41 #include "mc_client.h"
43 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
44 "Logging specific to MC (global)");
48 double *mc_time = NULL;
51 int user_max_depth_reached = 0;
53 /* MC global data structures */
54 mc_state_t mc_current_state = NULL;
55 char mc_replay_mode = FALSE;
57 __thread mc_comparison_times_t mc_comp_times = NULL;
58 __thread double mc_snapshot_comparison_time;
59 mc_stats_t mc_stats = NULL;
60 mc_global_t initial_global_state = NULL;
61 xbt_fifo_t mc_stack = NULL;
64 xbt_automaton_t _mc_property_automaton = NULL;
67 FILE *dot_output = NULL;
68 const char *colors[13];
71 /******************************* Initialisation of MC *******************************/
72 /*********************************************************************************/
74 static void MC_init_dot_output()
75 { /* FIXME : more colors */
80 colors[3] = "goldenrod";
83 colors[6] = "magenta";
84 colors[7] = "turquoise4";
86 colors[9] = "forestgreen";
87 colors[10] = "hotpink";
88 colors[11] = "lightblue";
91 dot_output = fopen(_sg_mc_dot_output_file, "w");
93 if (dot_output == NULL) {
94 perror("Error open dot output file");
99 "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");
105 MC_init_pid(getpid(), -1);
108 void MC_init_pid(pid_t pid, int socket)
110 if (mc_mode == MC_MODE_NONE) {
111 if (getenv(MC_ENV_SOCKET_FD)) {
112 mc_mode = MC_MODE_CLIENT;
114 mc_mode = MC_MODE_STANDALONE;
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) */
123 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
125 mc_model_checker = MC_model_checker_new(pid, socket);
127 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
129 /* Initialize statistics */
130 mc_stats = xbt_new0(s_mc_stats_t, 1);
131 mc_stats->state_size = 1;
133 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0'))
134 MC_init_dot_output();
137 //parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
141 if (_sg_mc_visited > 0 || _sg_mc_liveness) {
142 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
143 MC_ignore_local_variable("e", "*");
144 MC_ignore_local_variable("__ex_cleanup", "*");
145 MC_ignore_local_variable("__ex_mctx_en", "*");
146 MC_ignore_local_variable("__ex_mctx_me", "*");
147 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
148 MC_ignore_local_variable("_log_ev", "*");
149 MC_ignore_local_variable("_throw_ctx", "*");
150 MC_ignore_local_variable("ctx", "*");
152 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
153 MC_ignore_local_variable("next_cont"
154 "ext", "smx_ctx_sysv_suspend_serial");
155 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
157 /* Ignore local variable about time used for tracing */
158 MC_ignore_local_variable("start_time", "*");
161 MC_ignore_global_variable("mc_model_checker");
162 MC_ignore_global_variable("initial_communications_pattern");
163 MC_ignore_global_variable("incomplete_communications_pattern");
164 MC_ignore_global_variable("nb_comm_pattern");
166 /* MC __thread variables: */
167 MC_ignore_global_variable("mc_diff_info");
168 MC_ignore_global_variable("mc_comp_times");
169 MC_ignore_global_variable("mc_snapshot_comparison_time");
171 /* This MC state is used in MC replay as well: */
172 MC_ignore_global_variable("mc_time");
174 /* Static variable used for tracing */
175 MC_ignore_global_variable("counter");
178 MC_ignore_global_variable("smx_total_comms");
180 if (mc_mode == MC_MODE_STANDALONE || mc_mode == MC_MODE_CLIENT) {
181 /* Those requests are handled on the client side and propagated by message
184 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
186 smx_process_t process;
187 xbt_swag_foreach(process, simix_global->process_list) {
188 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
193 mmalloc_set_current_heap(heap);
195 if (mc_mode == MC_MODE_CLIENT) {
196 // This will move somehwere else:
197 MC_client_handle_messages();
202 /******************************* Core of MC *******************************/
203 /**************************************************************************/
205 static void MC_modelcheck_comm_determinism_init(void)
209 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
211 /* Create exploration stack */
212 mc_stack = xbt_fifo_new();
216 MC_pre_modelcheck_comm_determinism();
219 initial_global_state = xbt_new0(s_mc_global_t, 1);
220 initial_global_state->snapshot = MC_take_snapshot(0);
221 initial_global_state->initial_communications_pattern_done = 0;
222 initial_global_state->comm_deterministic = 1;
223 initial_global_state->send_deterministic = 1;
226 MC_modelcheck_comm_determinism();
228 mmalloc_set_current_heap(heap);
231 static void MC_modelcheck_safety_init(void)
237 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
239 /* Create exploration stack */
240 mc_stack = xbt_fifo_new();
244 MC_pre_modelcheck_safety();
247 /* Save the initial state */
248 initial_global_state = xbt_new0(s_mc_global_t, 1);
249 initial_global_state->snapshot = MC_take_snapshot(0);
252 MC_modelcheck_safety();
254 mmalloc_set_current_heap(heap);
260 static void MC_modelcheck_liveness_init()
266 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
268 /* Create exploration stack */
269 mc_stack = xbt_fifo_new();
271 /* Create the initial state */
272 initial_global_state = xbt_new0(s_mc_global_t, 1);
276 MC_pre_modelcheck_liveness();
279 MC_print_statistics(mc_stats);
282 mmalloc_set_current_heap(heap);
286 void MC_do_the_modelcheck_for_real()
289 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
290 XBT_INFO("Check communication determinism");
291 MC_modelcheck_comm_determinism_init();
292 } else if (!_sg_mc_property_file || _sg_mc_property_file[0] == '\0') {
293 if (mc_reduce_kind == e_mc_reduce_unset)
294 mc_reduce_kind = e_mc_reduce_dpor;
295 XBT_INFO("Check a safety property");
296 MC_modelcheck_safety_init();
298 if (mc_reduce_kind == e_mc_reduce_unset)
299 mc_reduce_kind = e_mc_reduce_none;
300 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
301 MC_automaton_load(_sg_mc_property_file);
302 MC_modelcheck_liveness_init();
315 int MC_deadlock_check()
317 if (mc_mode == MC_MODE_SERVER) {
319 if ((res = MC_protocol_send_simple_message(mc_model_checker->process.socket,
320 MC_MESSAGE_DEADLOCK_CHECK)))
321 xbt_die("Could not check deadlock state");
322 s_mc_int_message_t message;
323 ssize_t s = MC_receive_message(mc_model_checker->process.socket, &message, sizeof(message));
325 xbt_die("Could not receive message");
326 else if (s != sizeof(message) || message.type != MC_MESSAGE_DEADLOCK_CHECK_REPLY) {
327 xbt_die("Unexpected message, expected MC_MESSAGE_DEADLOCK_CHECK_REPLY %i %i vs %i %i",
328 (int) s, (int) message.type, (int) sizeof(message), (int) MC_MESSAGE_DEADLOCK_CHECK_REPLY
332 return message.value;
335 int deadlock = FALSE;
336 smx_process_t process;
337 if (xbt_swag_size(simix_global->process_list)) {
339 xbt_swag_foreach(process, simix_global->process_list) {
340 if (MC_request_is_enabled(&process->simcall)) {
349 void handle_comm_pattern(e_mc_call_type_t call_type, smx_simcall_t req, int value, xbt_dynar_t pattern, int backtracking) {
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:
359 case MC_CALL_TYPE_WAITANY:
361 smx_synchro_t current_comm = NULL;
362 if (call_type == MC_CALL_TYPE_WAIT)
363 current_comm = simcall_comm_wait__get__comm(req);
365 current_comm = xbt_dynar_get_as(simcall_comm_waitany__get__comms(req), value, smx_synchro_t);
366 // First wait only must be considered:
367 if (current_comm->comm.refcount == 1)
368 complete_comm_pattern(pattern, current_comm, backtracking);
372 xbt_die("Unexpected call type %i", (int)call_type);
377 static void MC_restore_communications_pattern(mc_state_t state) {
378 mc_list_comm_pattern_t list_process_comm;
379 unsigned int cursor, cursor2;
380 xbt_dynar_foreach(initial_communications_pattern, cursor, list_process_comm){
381 list_process_comm->index_comm = (int)xbt_dynar_get_as(state->index_comm, cursor, int);
383 mc_comm_pattern_t comm;
385 xbt_dynar_t initial_incomplete_process_comms, incomplete_process_comms;
386 for(int i=0; i<simix_process_maxpid; i++){
387 initial_incomplete_process_comms = xbt_dynar_get_as(incomplete_communications_pattern, i, xbt_dynar_t);
388 xbt_dynar_reset(initial_incomplete_process_comms);
389 incomplete_process_comms = xbt_dynar_get_as(state->incomplete_comm_pattern, i, xbt_dynar_t);
390 xbt_dynar_foreach(incomplete_process_comms, cursor2, comm) {
391 mc_comm_pattern_t copy_comm = xbt_new0(s_mc_comm_pattern_t, 1);
392 copy_comm->index = comm->index;
393 copy_comm->type = comm->type;
394 copy_comm->comm = comm->comm;
395 copy_comm->rdv = strdup(comm->rdv);
396 copy_comm->data_size = -1;
397 copy_comm->data = NULL;
398 if(comm->type == SIMIX_COMM_SEND){
399 copy_comm->src_proc = comm->src_proc;
400 copy_comm->src_host = comm->src_host;
401 if(comm->data != NULL){
402 copy_comm->data_size = comm->data_size;
403 copy_comm->data = xbt_malloc0(comm->data_size);
404 memcpy(copy_comm->data, comm->data, comm->data_size);
407 copy_comm->dst_proc = comm->dst_proc;
408 copy_comm->dst_host = comm->dst_host;
410 xbt_dynar_push(initial_incomplete_process_comms, ©_comm);
416 * \brief Re-executes from the state at position start all the transitions indicated by
417 * a given model-checker stack.
418 * \param stack The stack with the transitions to execute.
419 * \param start Start index to begin the re-execution.
421 void MC_replay(xbt_fifo_t stack)
423 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
425 int value, count = 1, j;
427 smx_simcall_t req = NULL, saved_req = NULL;
428 xbt_fifo_item_t item, start_item;
431 XBT_DEBUG("**** Begin Replay ****");
433 /* Intermediate backtracking */
434 if(_sg_mc_checkpoint > 0) {
435 start_item = xbt_fifo_get_first_item(stack);
436 state = (mc_state_t)xbt_fifo_get_item_content(start_item);
437 if(state->system_state){
438 MC_restore_snapshot(state->system_state);
439 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
440 MC_restore_communications_pattern(state);
447 /* Restore the initial state */
448 MC_restore_snapshot(initial_global_state->snapshot);
449 /* At the moment of taking the snapshot the raw heap was set, so restoring
450 * it will set it back again, we have to unset it to continue */
453 start_item = xbt_fifo_get_last_item(stack);
457 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
458 for (j=0; j<simix_process_maxpid; j++) {
459 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
460 ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t))->index_comm = 0;
466 /* Traverse the stack from the state at position start and re-execute the transitions */
467 for (item = start_item;
468 item != xbt_fifo_get_first_item(stack);
469 item = xbt_fifo_get_prev_item(item)) {
471 state = (mc_state_t) xbt_fifo_get_item_content(item);
472 saved_req = MC_state_get_executed_request(state, &value);
475 /* because we got a copy of the executed request, we have to fetch the
476 real one, pointed by the request field of the issuer process */
477 req = &saved_req->issuer->simcall;
479 /* Debug information */
480 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
481 req_str = MC_request_to_string(req, value);
482 XBT_DEBUG("Replay: %s (%p)", req_str, state);
486 /* TODO : handle test and testany simcalls */
487 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
488 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
489 call = mc_get_call_type(req);
491 SIMIX_simcall_handle(req, value);
494 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
495 handle_comm_pattern(call, req, value, NULL, 1);
498 MC_wait_for_requests();
503 /* Update statistics */
504 mc_stats->visited_states++;
505 mc_stats->executed_transitions++;
509 XBT_DEBUG("**** End Replay ****");
510 mmalloc_set_current_heap(heap);
513 void MC_replay_liveness(xbt_fifo_t stack)
516 initial_global_state->raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
518 xbt_fifo_item_t item;
519 mc_pair_t pair = NULL;
520 mc_state_t state = NULL;
521 smx_simcall_t req = NULL, saved_req = NULL;
522 int value, depth = 1;
525 XBT_DEBUG("**** Begin Replay ****");
527 /* Intermediate backtracking */
528 if(_sg_mc_checkpoint > 0) {
529 item = xbt_fifo_get_first_item(stack);
530 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
531 if(pair->graph_state->system_state){
532 MC_restore_snapshot(pair->graph_state->system_state);
538 /* Restore the initial state */
539 MC_restore_snapshot(initial_global_state->snapshot);
541 /* At the moment of taking the snapshot the raw heap was set, so restoring
542 * it will set it back again, we have to unset it to continue */
543 if (!initial_global_state->raw_mem_set)
546 /* Traverse the stack from the initial state and re-execute the transitions */
547 for (item = xbt_fifo_get_last_item(stack);
548 item != xbt_fifo_get_first_item(stack);
549 item = xbt_fifo_get_prev_item(item)) {
551 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
553 state = (mc_state_t) pair->graph_state;
555 if (pair->exploration_started) {
557 saved_req = MC_state_get_executed_request(state, &value);
559 if (saved_req != NULL) {
560 /* because we got a copy of the executed request, we have to fetch the
561 real one, pointed by the request field of the issuer process */
562 req = &saved_req->issuer->simcall;
564 /* Debug information */
565 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
566 req_str = MC_request_to_string(req, value);
567 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
573 SIMIX_simcall_handle(req, value);
574 MC_wait_for_requests();
577 /* Update statistics */
578 mc_stats->visited_pairs++;
579 mc_stats->executed_transitions++;
585 XBT_DEBUG("**** End Replay ****");
587 if (initial_global_state->raw_mem_set)
595 * \brief Dumps the contents of a model-checker's stack and shows the actual
597 * \param stack The stack to dump
599 void MC_dump_stack_safety(xbt_fifo_t stack)
601 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
603 MC_show_stack_safety(stack);
608 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
609 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
610 mmalloc_set_current_heap(heap);
614 void MC_show_stack_safety(xbt_fifo_t stack)
616 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
620 xbt_fifo_item_t item;
622 char *req_str = NULL;
624 for (item = xbt_fifo_get_last_item(stack);
625 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
626 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
627 req = MC_state_get_executed_request(state, &value);
629 req_str = MC_request_to_string(req, value);
630 XBT_INFO("%s", req_str);
635 mmalloc_set_current_heap(heap);
638 void MC_show_deadlock(smx_simcall_t req)
640 /*char *req_str = NULL; */
641 XBT_INFO("**************************");
642 XBT_INFO("*** DEAD-LOCK DETECTED ***");
643 XBT_INFO("**************************");
644 XBT_INFO("Locked request:");
645 /*req_str = MC_request_to_string(req);
646 XBT_INFO("%s", req_str);
647 xbt_free(req_str); */
648 XBT_INFO("Counter-example execution trace:");
649 MC_dump_stack_safety(mc_stack);
650 MC_print_statistics(mc_stats);
654 void MC_show_stack_liveness(xbt_fifo_t stack)
658 xbt_fifo_item_t item;
660 char *req_str = NULL;
662 for (item = xbt_fifo_get_last_item(stack);
663 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item))) : (NULL));
664 item = xbt_fifo_get_prev_item(item)) {
665 req = MC_state_get_executed_request(pair->graph_state, &value);
666 if (req && req->call != SIMCALL_NONE) {
667 req_str = MC_request_to_string(req, value);
668 XBT_INFO("%s", req_str);
675 void MC_dump_stack_liveness(xbt_fifo_t stack)
677 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
679 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
680 MC_pair_delete(pair);
681 mmalloc_set_current_heap(heap);
685 void MC_print_statistics(mc_stats_t stats)
687 if (stats->expanded_pairs == 0) {
688 XBT_INFO("Expanded states = %lu", stats->expanded_states);
689 XBT_INFO("Visited states = %lu", stats->visited_states);
691 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
692 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
694 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
695 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
696 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0')) {
697 fprintf(dot_output, "}\n");
700 if (initial_global_state != NULL) {
701 if (_sg_mc_comms_determinism)
702 XBT_INFO("Communication-deterministic : %s", !initial_global_state->comm_deterministic ? "No" : "Yes");
703 if (_sg_mc_send_determinism)
704 XBT_INFO("Send-deterministic : %s", !initial_global_state->send_deterministic ? "No" : "Yes");
706 mmalloc_set_current_heap(heap);
709 void MC_automaton_load(const char *file)
711 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
713 if (_mc_property_automaton == NULL)
714 _mc_property_automaton = xbt_automaton_new();
716 xbt_automaton_load(_mc_property_automaton, file);
717 mmalloc_set_current_heap(heap);
720 static void register_symbol(xbt_automaton_propositional_symbol_t symbol)
722 if (mc_mode != MC_MODE_CLIENT)
724 s_mc_register_symbol_message_t message;
725 message.type = MC_MESSAGE_REGISTER_SYMBOL;
726 const char* name = xbt_automaton_propositional_symbol_get_name(symbol);
727 if (strlen(name) + 1 > sizeof(message.name))
728 xbt_die("Symbol is too long");
729 strncpy(message.name, name, sizeof(message.name));
730 message.callback = xbt_automaton_propositional_symbol_get_callback(symbol);
731 message.data = xbt_automaton_propositional_symbol_get_data(symbol);
732 MC_client_send_message(&message, sizeof(message));
735 void MC_automaton_new_propositional_symbol(const char *id, int(*fct)(void))
737 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
739 if (_mc_property_automaton == NULL)
740 _mc_property_automaton = xbt_automaton_new();
742 xbt_automaton_propositional_symbol_t symbol = xbt_automaton_propositional_symbol_new(_mc_property_automaton, id, fct);
743 register_symbol(symbol);
744 mmalloc_set_current_heap(heap);
747 void MC_automaton_new_propositional_symbol_pointer(const char *id, int* value)
749 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
750 if (_mc_property_automaton == NULL)
751 _mc_property_automaton = xbt_automaton_new();
752 xbt_automaton_propositional_symbol_t symbol = xbt_automaton_propositional_symbol_new_pointer(_mc_property_automaton, id, value);
753 register_symbol(symbol);
754 mmalloc_set_current_heap(heap);
757 void MC_automaton_new_propositional_symbol_callback(const char* id,
758 xbt_automaton_propositional_symbol_callback_type callback,
759 void* data, xbt_automaton_propositional_symbol_free_function_type free_function)
761 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
762 if (_mc_property_automaton == NULL)
763 _mc_property_automaton = xbt_automaton_new();
764 xbt_automaton_propositional_symbol_t symbol = xbt_automaton_propositional_symbol_new_callback(
765 _mc_property_automaton, id, callback, data, free_function);
766 register_symbol(symbol);
767 mmalloc_set_current_heap(heap);
770 void MC_dump_stacks(FILE* file)
772 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
775 stack_region_t current_stack;
777 xbt_dynar_foreach(stacks_areas, cursor, current_stack) {
778 unw_context_t * context = (unw_context_t *)current_stack->context;
779 fprintf(file, "Stack %i:\n", nstack);
784 unw_init_local (&c, context);
787 const char * name = !unw_get_proc_name(&c, buffer, 100, &off) ? buffer : "?";
788 fprintf(file, " %i: %s\n", nframe, name);
790 } while(unw_step(&c));
794 mmalloc_set_current_heap(heap);
798 double MC_process_clock_get(smx_process_t process)
802 return mc_time[process->pid];
810 void MC_process_clock_add(smx_process_t process, double amount)
812 mc_time[process->pid] += amount;