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 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
183 smx_process_t process;
184 xbt_swag_foreach(process, simix_global->process_list) {
185 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
190 mmalloc_set_current_heap(heap);
192 if (mc_mode == MC_MODE_CLIENT) {
193 // This will move somehwere else:
194 MC_client_handle_messages();
199 /******************************* Core of MC *******************************/
200 /**************************************************************************/
202 static void MC_modelcheck_comm_determinism_init(void)
206 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
208 /* Create exploration stack */
209 mc_stack = xbt_fifo_new();
213 MC_pre_modelcheck_comm_determinism();
216 initial_global_state = xbt_new0(s_mc_global_t, 1);
217 initial_global_state->snapshot = MC_take_snapshot(0);
218 initial_global_state->initial_communications_pattern_done = 0;
219 initial_global_state->comm_deterministic = 1;
220 initial_global_state->send_deterministic = 1;
223 MC_modelcheck_comm_determinism();
225 mmalloc_set_current_heap(heap);
228 static void MC_modelcheck_safety_init(void)
234 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
236 /* Create exploration stack */
237 mc_stack = xbt_fifo_new();
241 MC_pre_modelcheck_safety();
244 /* Save the initial state */
245 initial_global_state = xbt_new0(s_mc_global_t, 1);
246 initial_global_state->snapshot = MC_take_snapshot(0);
249 MC_modelcheck_safety();
251 mmalloc_set_current_heap(heap);
257 static void MC_modelcheck_liveness_init()
263 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
265 /* Create exploration stack */
266 mc_stack = xbt_fifo_new();
268 /* Create the initial state */
269 initial_global_state = xbt_new0(s_mc_global_t, 1);
273 MC_pre_modelcheck_liveness();
276 MC_print_statistics(mc_stats);
279 mmalloc_set_current_heap(heap);
283 void MC_do_the_modelcheck_for_real()
286 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
287 XBT_INFO("Check communication determinism");
288 MC_modelcheck_comm_determinism_init();
289 } else if (!_sg_mc_property_file || _sg_mc_property_file[0] == '\0') {
290 if (mc_reduce_kind == e_mc_reduce_unset)
291 mc_reduce_kind = e_mc_reduce_dpor;
292 XBT_INFO("Check a safety property");
293 MC_modelcheck_safety_init();
295 if (mc_reduce_kind == e_mc_reduce_unset)
296 mc_reduce_kind = e_mc_reduce_none;
297 XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
298 MC_automaton_load(_sg_mc_property_file);
299 MC_modelcheck_liveness_init();
312 int MC_deadlock_check()
314 int deadlock = FALSE;
315 smx_process_t process;
316 if (xbt_swag_size(simix_global->process_list)) {
318 xbt_swag_foreach(process, simix_global->process_list) {
319 if (MC_request_is_enabled(&process->simcall)) {
328 void handle_comm_pattern(e_mc_call_type_t call_type, smx_simcall_t req, int value, xbt_dynar_t pattern, int backtracking) {
331 case MC_CALL_TYPE_NONE:
333 case MC_CALL_TYPE_SEND:
334 case MC_CALL_TYPE_RECV:
335 get_comm_pattern(pattern, req, call_type);
337 case MC_CALL_TYPE_WAIT:
338 case MC_CALL_TYPE_WAITANY:
340 smx_synchro_t current_comm = NULL;
341 if (call_type == MC_CALL_TYPE_WAIT)
342 current_comm = simcall_comm_wait__get__comm(req);
344 current_comm = xbt_dynar_get_as(simcall_comm_waitany__get__comms(req), value, smx_synchro_t);
345 // First wait only must be considered:
346 if (current_comm->comm.refcount == 1)
347 complete_comm_pattern(pattern, current_comm, backtracking);
351 xbt_die("Unexpected call type %i", (int)call_type);
356 static void MC_restore_communications_pattern(mc_state_t state) {
357 mc_list_comm_pattern_t list_process_comm;
358 unsigned int cursor, cursor2;
359 xbt_dynar_foreach(initial_communications_pattern, cursor, list_process_comm){
360 list_process_comm->index_comm = (int)xbt_dynar_get_as(state->index_comm, cursor, int);
362 mc_comm_pattern_t comm;
364 xbt_dynar_t initial_incomplete_process_comms, incomplete_process_comms;
365 for(int i=0; i<simix_process_maxpid; i++){
366 initial_incomplete_process_comms = xbt_dynar_get_as(incomplete_communications_pattern, i, xbt_dynar_t);
367 xbt_dynar_reset(initial_incomplete_process_comms);
368 incomplete_process_comms = xbt_dynar_get_as(state->incomplete_comm_pattern, i, xbt_dynar_t);
369 xbt_dynar_foreach(incomplete_process_comms, cursor2, comm) {
370 mc_comm_pattern_t copy_comm = xbt_new0(s_mc_comm_pattern_t, 1);
371 copy_comm->index = comm->index;
372 copy_comm->type = comm->type;
373 copy_comm->comm = comm->comm;
374 copy_comm->rdv = strdup(comm->rdv);
375 copy_comm->data_size = -1;
376 copy_comm->data = NULL;
377 if(comm->type == SIMIX_COMM_SEND){
378 copy_comm->src_proc = comm->src_proc;
379 copy_comm->src_host = comm->src_host;
380 if(comm->data != NULL){
381 copy_comm->data_size = comm->data_size;
382 copy_comm->data = xbt_malloc0(comm->data_size);
383 memcpy(copy_comm->data, comm->data, comm->data_size);
386 copy_comm->dst_proc = comm->dst_proc;
387 copy_comm->dst_host = comm->dst_host;
389 xbt_dynar_push(initial_incomplete_process_comms, ©_comm);
395 * \brief Re-executes from the state at position start all the transitions indicated by
396 * a given model-checker stack.
397 * \param stack The stack with the transitions to execute.
398 * \param start Start index to begin the re-execution.
400 void MC_replay(xbt_fifo_t stack)
402 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
404 int value, count = 1, j;
406 smx_simcall_t req = NULL, saved_req = NULL;
407 xbt_fifo_item_t item, start_item;
410 XBT_DEBUG("**** Begin Replay ****");
412 /* Intermediate backtracking */
413 if(_sg_mc_checkpoint > 0) {
414 start_item = xbt_fifo_get_first_item(stack);
415 state = (mc_state_t)xbt_fifo_get_item_content(start_item);
416 if(state->system_state){
417 MC_restore_snapshot(state->system_state);
418 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
419 MC_restore_communications_pattern(state);
426 /* Restore the initial state */
427 MC_restore_snapshot(initial_global_state->snapshot);
428 /* At the moment of taking the snapshot the raw heap was set, so restoring
429 * it will set it back again, we have to unset it to continue */
432 start_item = xbt_fifo_get_last_item(stack);
436 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
437 for (j=0; j<simix_process_maxpid; j++) {
438 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
439 ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t))->index_comm = 0;
445 /* Traverse the stack from the state at position start and re-execute the transitions */
446 for (item = start_item;
447 item != xbt_fifo_get_first_item(stack);
448 item = xbt_fifo_get_prev_item(item)) {
450 state = (mc_state_t) xbt_fifo_get_item_content(item);
451 saved_req = MC_state_get_executed_request(state, &value);
454 /* because we got a copy of the executed request, we have to fetch the
455 real one, pointed by the request field of the issuer process */
456 req = &saved_req->issuer->simcall;
458 /* Debug information */
459 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
460 req_str = MC_request_to_string(req, value);
461 XBT_DEBUG("Replay: %s (%p)", req_str, state);
465 /* TODO : handle test and testany simcalls */
466 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
467 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
468 call = mc_get_call_type(req);
470 SIMIX_simcall_handle(req, value);
473 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
474 handle_comm_pattern(call, req, value, NULL, 1);
477 MC_wait_for_requests();
482 /* Update statistics */
483 mc_stats->visited_states++;
484 mc_stats->executed_transitions++;
488 XBT_DEBUG("**** End Replay ****");
489 mmalloc_set_current_heap(heap);
492 void MC_replay_liveness(xbt_fifo_t stack)
495 initial_global_state->raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
497 xbt_fifo_item_t item;
498 mc_pair_t pair = NULL;
499 mc_state_t state = NULL;
500 smx_simcall_t req = NULL, saved_req = NULL;
501 int value, depth = 1;
504 XBT_DEBUG("**** Begin Replay ****");
506 /* Intermediate backtracking */
507 if(_sg_mc_checkpoint > 0) {
508 item = xbt_fifo_get_first_item(stack);
509 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
510 if(pair->graph_state->system_state){
511 MC_restore_snapshot(pair->graph_state->system_state);
517 /* Restore the initial state */
518 MC_restore_snapshot(initial_global_state->snapshot);
520 /* At the moment of taking the snapshot the raw heap was set, so restoring
521 * it will set it back again, we have to unset it to continue */
522 if (!initial_global_state->raw_mem_set)
525 /* Traverse the stack from the initial state and re-execute the transitions */
526 for (item = xbt_fifo_get_last_item(stack);
527 item != xbt_fifo_get_first_item(stack);
528 item = xbt_fifo_get_prev_item(item)) {
530 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
532 state = (mc_state_t) pair->graph_state;
534 if (pair->exploration_started) {
536 saved_req = MC_state_get_executed_request(state, &value);
538 if (saved_req != NULL) {
539 /* because we got a copy of the executed request, we have to fetch the
540 real one, pointed by the request field of the issuer process */
541 req = &saved_req->issuer->simcall;
543 /* Debug information */
544 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
545 req_str = MC_request_to_string(req, value);
546 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
552 SIMIX_simcall_handle(req, value);
553 MC_wait_for_requests();
556 /* Update statistics */
557 mc_stats->visited_pairs++;
558 mc_stats->executed_transitions++;
564 XBT_DEBUG("**** End Replay ****");
566 if (initial_global_state->raw_mem_set)
574 * \brief Dumps the contents of a model-checker's stack and shows the actual
576 * \param stack The stack to dump
578 void MC_dump_stack_safety(xbt_fifo_t stack)
580 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
582 MC_show_stack_safety(stack);
587 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
588 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
589 mmalloc_set_current_heap(heap);
593 void MC_show_stack_safety(xbt_fifo_t stack)
595 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
599 xbt_fifo_item_t item;
601 char *req_str = NULL;
603 for (item = xbt_fifo_get_last_item(stack);
604 (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
605 : (NULL)); item = xbt_fifo_get_prev_item(item)) {
606 req = MC_state_get_executed_request(state, &value);
608 req_str = MC_request_to_string(req, value);
609 XBT_INFO("%s", req_str);
614 mmalloc_set_current_heap(heap);
617 void MC_show_deadlock(smx_simcall_t req)
619 /*char *req_str = NULL; */
620 XBT_INFO("**************************");
621 XBT_INFO("*** DEAD-LOCK DETECTED ***");
622 XBT_INFO("**************************");
623 XBT_INFO("Locked request:");
624 /*req_str = MC_request_to_string(req);
625 XBT_INFO("%s", req_str);
626 xbt_free(req_str); */
627 XBT_INFO("Counter-example execution trace:");
628 MC_dump_stack_safety(mc_stack);
629 MC_print_statistics(mc_stats);
633 void MC_show_stack_liveness(xbt_fifo_t stack)
637 xbt_fifo_item_t item;
639 char *req_str = NULL;
641 for (item = xbt_fifo_get_last_item(stack);
642 (item ? (pair = (mc_pair_t) (xbt_fifo_get_item_content(item))) : (NULL));
643 item = xbt_fifo_get_prev_item(item)) {
644 req = MC_state_get_executed_request(pair->graph_state, &value);
645 if (req && req->call != SIMCALL_NONE) {
646 req_str = MC_request_to_string(req, value);
647 XBT_INFO("%s", req_str);
654 void MC_dump_stack_liveness(xbt_fifo_t stack)
656 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
658 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
659 MC_pair_delete(pair);
660 mmalloc_set_current_heap(heap);
664 void MC_print_statistics(mc_stats_t stats)
666 if (stats->expanded_pairs == 0) {
667 XBT_INFO("Expanded states = %lu", stats->expanded_states);
668 XBT_INFO("Visited states = %lu", stats->visited_states);
670 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
671 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
673 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
674 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
675 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0')) {
676 fprintf(dot_output, "}\n");
679 if (initial_global_state != NULL) {
680 if (_sg_mc_comms_determinism)
681 XBT_INFO("Communication-deterministic : %s", !initial_global_state->comm_deterministic ? "No" : "Yes");
682 if (_sg_mc_send_determinism)
683 XBT_INFO("Send-deterministic : %s", !initial_global_state->send_deterministic ? "No" : "Yes");
685 mmalloc_set_current_heap(heap);
688 void MC_automaton_load(const char *file)
690 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
692 if (_mc_property_automaton == NULL)
693 _mc_property_automaton = xbt_automaton_new();
695 xbt_automaton_load(_mc_property_automaton, file);
696 mmalloc_set_current_heap(heap);
699 static void register_symbol(xbt_automaton_propositional_symbol_t symbol)
701 if (mc_mode != MC_MODE_CLIENT)
703 s_mc_register_symbol_message_t message;
704 message.type = MC_MESSAGE_REGISTER_SYMBOL;
705 const char* name = xbt_automaton_propositional_symbol_get_name(symbol);
706 if (strlen(name) + 1 > sizeof(message.name))
707 xbt_die("Symbol is too long");
708 strncpy(message.name, name, sizeof(message.name));
709 message.callback = xbt_automaton_propositional_symbol_get_callback(symbol);
710 message.data = xbt_automaton_propositional_symbol_get_data(symbol);
711 MC_client_send_message(&message, sizeof(message));
714 void MC_automaton_new_propositional_symbol(const char *id, int(*fct)(void))
716 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
718 if (_mc_property_automaton == NULL)
719 _mc_property_automaton = xbt_automaton_new();
721 xbt_automaton_propositional_symbol_t symbol = xbt_automaton_propositional_symbol_new(_mc_property_automaton, id, fct);
722 register_symbol(symbol);
723 mmalloc_set_current_heap(heap);
726 void MC_automaton_new_propositional_symbol_pointer(const char *id, int* value)
728 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
729 if (_mc_property_automaton == NULL)
730 _mc_property_automaton = xbt_automaton_new();
731 xbt_automaton_propositional_symbol_t symbol = xbt_automaton_propositional_symbol_new_pointer(_mc_property_automaton, id, value);
732 register_symbol(symbol);
733 mmalloc_set_current_heap(heap);
736 void MC_automaton_new_propositional_symbol_callback(const char* id,
737 xbt_automaton_propositional_symbol_callback_type callback,
738 void* data, xbt_automaton_propositional_symbol_free_function_type free_function)
740 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
741 if (_mc_property_automaton == NULL)
742 _mc_property_automaton = xbt_automaton_new();
743 xbt_automaton_propositional_symbol_t symbol = xbt_automaton_propositional_symbol_new_callback(
744 _mc_property_automaton, id, callback, data, free_function);
745 register_symbol(symbol);
746 mmalloc_set_current_heap(heap);
749 void MC_dump_stacks(FILE* file)
751 xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
754 stack_region_t current_stack;
756 xbt_dynar_foreach(stacks_areas, cursor, current_stack) {
757 unw_context_t * context = (unw_context_t *)current_stack->context;
758 fprintf(file, "Stack %i:\n", nstack);
763 unw_init_local (&c, context);
766 const char * name = !unw_get_proc_name(&c, buffer, 100, &off) ? buffer : "?";
767 fprintf(file, " %i: %s\n", nframe, name);
769 } while(unw_step(&c));
773 mmalloc_set_current_heap(heap);
777 double MC_process_clock_get(smx_process_t process)
781 return mc_time[process->pid];
789 void MC_process_clock_add(smx_process_t process, double amount)
791 mc_time[process->pid] += amount;