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. */
21 #include "simgrid/sg_config.h"
22 #include "../surf/surf_private.h"
23 #include "../simix/smx_private.h"
25 #include "xbt/automaton.h"
27 #include "mc_record.h"
30 #include "mc_server.h"
31 #include <libunwind.h>
32 #include <xbt/mmalloc.h>
33 #include "../xbt/mmalloc/mmprivate.h"
34 #include "mc_object_info.h"
35 #include "mc_comm_pattern.h"
36 #include "mc_request.h"
37 #include "mc_safety.h"
38 #include "mc_memory_map.h"
39 #include "mc_snapshot.h"
40 #include "mc_liveness.h"
41 #include "mc_private.h"
44 #include "mcer_ignore.h"
46 #include "mc_record.h"
47 #include "mc_protocol.h"
48 #include "mc_client.h"
52 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
53 "Logging specific to MC (global)");
57 double *mc_time = NULL;
60 int user_max_depth_reached = 0;
62 /* MC global data structures */
63 mc_state_t mc_current_state = NULL;
64 char mc_replay_mode = FALSE;
66 __thread mc_comparison_times_t mc_comp_times = NULL;
67 __thread double mc_snapshot_comparison_time;
68 mc_stats_t mc_stats = NULL;
69 mc_global_t initial_global_state = NULL;
70 xbt_fifo_t mc_stack = NULL;
73 xbt_automaton_t _mc_property_automaton = NULL;
76 FILE *dot_output = NULL;
77 const char *colors[13];
80 /******************************* Initialisation of MC *******************************/
81 /*********************************************************************************/
83 static void MC_init_dot_output()
84 { /* FIXME : more colors */
89 colors[3] = "goldenrod";
92 colors[6] = "magenta";
93 colors[7] = "turquoise4";
95 colors[9] = "forestgreen";
96 colors[10] = "hotpink";
97 colors[11] = "lightblue";
100 dot_output = fopen(_sg_mc_dot_output_file, "w");
102 if (dot_output == NULL) {
103 perror("Error open dot output file");
108 "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");
115 mc_time = xbt_new0(double, simix_process_maxpid);
117 if (_sg_mc_visited > 0 || _sg_mc_liveness || _sg_mc_termination || mc_mode == MC_MODE_SERVER) {
118 /* Those requests are handled on the client side and propagated by message
121 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
123 smx_process_t process;
124 xbt_swag_foreach(process, simix_global->process_list) {
125 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
130 void MC_init_model_checker(pid_t pid, int socket)
132 mc_model_checker = new simgrid::mc::ModelChecker(pid, socket);
134 mc_comp_times = xbt_new0(s_mc_comparison_times_t, 1);
136 /* Initialize statistics */
137 mc_stats = xbt_new0(s_mc_stats_t, 1);
138 mc_stats->state_size = 1;
140 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0'))
141 MC_init_dot_output();
144 //parmap = xbt_parmap_mc_new(xbt_os_get_numcores(), XBT_PARMAP_DEFAULT);
146 /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
147 MC_ignore_local_variable("e", "*");
148 MC_ignore_local_variable("__ex_cleanup", "*");
149 MC_ignore_local_variable("__ex_mctx_en", "*");
150 MC_ignore_local_variable("__ex_mctx_me", "*");
151 MC_ignore_local_variable("__xbt_ex_ctx_ptr", "*");
152 MC_ignore_local_variable("_log_ev", "*");
153 MC_ignore_local_variable("_throw_ctx", "*");
154 MC_ignore_local_variable("ctx", "*");
156 MC_ignore_local_variable("self", "simcall_BODY_mc_snapshot");
157 MC_ignore_local_variable("next_cont"
158 "ext", "smx_ctx_sysv_suspend_serial");
159 MC_ignore_local_variable("i", "smx_ctx_sysv_suspend_serial");
161 /* Ignore local variable about time used for tracing */
162 MC_ignore_local_variable("start_time", "*");
164 /* Static variable used for tracing */
165 MCer_ignore_global_variable("counter");
168 MCer_ignore_global_variable("smx_total_comms");
172 /******************************* Core of MC *******************************/
173 /**************************************************************************/
177 mc_mode = MC_MODE_CLIENT;
179 MC_client_main_loop();
191 int MC_deadlock_check()
193 if (mc_mode == MC_MODE_SERVER) {
195 if ((res = MC_protocol_send_simple_message(mc_model_checker->process().socket,
196 MC_MESSAGE_DEADLOCK_CHECK)))
197 xbt_die("Could not check deadlock state");
198 s_mc_int_message_t message;
199 ssize_t s = MC_receive_message(mc_model_checker->process().socket, &message, sizeof(message), 0);
201 xbt_die("Could not receive message");
202 else if (s != sizeof(message) || message.type != MC_MESSAGE_DEADLOCK_CHECK_REPLY) {
203 xbt_die("%s received unexpected message %s (%i, size=%i) "
204 "expected MC_MESSAGE_DEADLOCK_CHECK_REPLY (%i, size=%i)",
205 MC_mode_name(mc_mode),
206 MC_message_type_name(message.type), (int) message.type, (int) s,
207 (int) MC_MESSAGE_DEADLOCK_CHECK_REPLY, (int) sizeof(message)
211 return message.value;
214 int deadlock = FALSE;
215 smx_process_t process;
216 if (xbt_swag_size(simix_global->process_list)) {
218 xbt_swag_foreach(process, simix_global->process_list) {
219 if (MC_process_is_enabled(process)) {
230 * \brief Re-executes from the state at position start all the transitions indicated by
231 * a given model-checker stack.
232 * \param stack The stack with the transitions to execute.
233 * \param start Start index to begin the re-execution.
235 void MC_replay(xbt_fifo_t stack)
237 int value, count = 1;
239 smx_simcall_t req = NULL, saved_req = NULL;
240 xbt_fifo_item_t item, start_item;
243 XBT_DEBUG("**** Begin Replay ****");
245 /* Intermediate backtracking */
246 if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
247 start_item = xbt_fifo_get_first_item(stack);
248 state = (mc_state_t)xbt_fifo_get_item_content(start_item);
249 if(state->system_state){
250 MC_restore_snapshot(state->system_state);
251 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
252 MC_restore_communications_pattern(state);
258 /* Restore the initial state */
259 MC_restore_snapshot(initial_global_state->snapshot);
260 /* At the moment of taking the snapshot the raw heap was set, so restoring
261 * it will set it back again, we have to unset it to continue */
263 start_item = xbt_fifo_get_last_item(stack);
265 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
266 // int n = xbt_dynar_length(incomplete_communications_pattern);
267 unsigned n = MC_smx_get_maxpid();
268 assert(n == xbt_dynar_length(incomplete_communications_pattern));
269 assert(n == xbt_dynar_length(initial_communications_pattern));
270 for (unsigned j=0; j < n ; j++) {
271 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
272 xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t)->index_comm = 0;
276 /* Traverse the stack from the state at position start and re-execute the transitions */
277 for (item = start_item;
278 item != xbt_fifo_get_first_item(stack);
279 item = xbt_fifo_get_prev_item(item)) {
281 state = (mc_state_t) xbt_fifo_get_item_content(item);
282 saved_req = MC_state_get_executed_request(state, &value);
285 /* because we got a copy of the executed request, we have to fetch the
286 real one, pointed by the request field of the issuer process */
288 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
289 req = &issuer->simcall;
291 /* Debug information */
292 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
293 req_str = MC_request_to_string(req, value, MC_REQUEST_SIMIX);
294 XBT_DEBUG("Replay: %s (%p)", req_str, state);
298 /* TODO : handle test and testany simcalls */
299 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
300 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
301 call = MC_get_call_type(req);
303 MC_simcall_handle(req, value);
305 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
306 MC_handle_comm_pattern(call, req, value, NULL, 1);
308 MC_wait_for_requests();
313 /* Update statistics */
314 mc_stats->visited_states++;
315 mc_stats->executed_transitions++;
319 XBT_DEBUG("**** End Replay ****");
322 void MC_replay_liveness(xbt_fifo_t stack)
324 xbt_fifo_item_t item;
325 mc_pair_t pair = NULL;
326 mc_state_t state = NULL;
327 smx_simcall_t req = NULL, saved_req = NULL;
328 int value, depth = 1;
331 XBT_DEBUG("**** Begin Replay ****");
333 /* Intermediate backtracking */
334 if(_sg_mc_checkpoint > 0) {
335 item = xbt_fifo_get_first_item(stack);
336 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
337 if(pair->graph_state->system_state){
338 MC_restore_snapshot(pair->graph_state->system_state);
343 /* Restore the initial state */
344 MC_restore_snapshot(initial_global_state->snapshot);
346 /* Traverse the stack from the initial state and re-execute the transitions */
347 for (item = xbt_fifo_get_last_item(stack);
348 item != xbt_fifo_get_first_item(stack);
349 item = xbt_fifo_get_prev_item(item)) {
351 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
353 state = (mc_state_t) pair->graph_state;
355 if (pair->exploration_started) {
357 saved_req = MC_state_get_executed_request(state, &value);
359 if (saved_req != NULL) {
360 /* because we got a copy of the executed request, we have to fetch the
361 real one, pointed by the request field of the issuer process */
362 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
363 req = &issuer->simcall;
365 /* Debug information */
366 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
367 req_str = MC_request_to_string(req, value, MC_REQUEST_SIMIX);
368 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
374 MC_simcall_handle(req, value);
375 MC_wait_for_requests();
378 /* Update statistics */
379 mc_stats->visited_pairs++;
380 mc_stats->executed_transitions++;
386 XBT_DEBUG("**** End Replay ****");
390 * \brief Dumps the contents of a model-checker's stack and shows the actual
392 * \param stack The stack to dump
394 void MC_dump_stack_safety(xbt_fifo_t stack)
396 MC_show_stack_safety(stack);
400 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
401 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
405 void MC_show_stack_safety(xbt_fifo_t stack)
409 xbt_fifo_item_t item;
411 char *req_str = NULL;
413 for (item = xbt_fifo_get_last_item(stack);
414 item; item = xbt_fifo_get_prev_item(item)) {
415 state = (mc_state_t)xbt_fifo_get_item_content(item);
416 req = MC_state_get_executed_request(state, &value);
418 req_str = MC_request_to_string(req, value, MC_REQUEST_EXECUTED);
419 XBT_INFO("%s", req_str);
425 void MC_show_deadlock(smx_simcall_t req)
427 /*char *req_str = NULL; */
428 XBT_INFO("**************************");
429 XBT_INFO("*** DEAD-LOCK DETECTED ***");
430 XBT_INFO("**************************");
431 XBT_INFO("Locked request:");
432 /*req_str = MC_request_to_string(req);
433 XBT_INFO("%s", req_str);
434 xbt_free(req_str); */
435 XBT_INFO("Counter-example execution trace:");
436 MC_dump_stack_safety(mc_stack);
437 MC_print_statistics(mc_stats);
440 void MC_show_non_termination(void){
441 XBT_INFO("******************************************");
442 XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
443 XBT_INFO("******************************************");
444 XBT_INFO("Counter-example execution trace:");
445 MC_dump_stack_safety(mc_stack);
446 MC_print_statistics(mc_stats);
450 void MC_show_stack_liveness(xbt_fifo_t stack)
454 xbt_fifo_item_t item;
456 char *req_str = NULL;
458 for (item = xbt_fifo_get_last_item(stack);
459 item; item = xbt_fifo_get_prev_item(item)) {
460 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
461 req = MC_state_get_executed_request(pair->graph_state, &value);
462 if (req && req->call != SIMCALL_NONE) {
463 req_str = MC_request_to_string(req, value, MC_REQUEST_EXECUTED);
464 XBT_INFO("%s", req_str);
471 void MC_dump_stack_liveness(xbt_fifo_t stack)
474 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
475 MC_pair_delete(pair);
478 void MC_print_statistics(mc_stats_t stats)
480 if(_sg_mc_comms_determinism) {
481 if (!initial_global_state->recv_deterministic && initial_global_state->send_deterministic){
482 XBT_INFO("******************************************************");
483 XBT_INFO("**** Only-send-deterministic communication pattern ****");
484 XBT_INFO("******************************************************");
485 XBT_INFO("%s", initial_global_state->recv_diff);
486 }else if(!initial_global_state->send_deterministic && initial_global_state->recv_deterministic) {
487 XBT_INFO("******************************************************");
488 XBT_INFO("**** Only-recv-deterministic communication pattern ****");
489 XBT_INFO("******************************************************");
490 XBT_INFO("%s", initial_global_state->send_diff);
494 if (stats->expanded_pairs == 0) {
495 XBT_INFO("Expanded states = %lu", stats->expanded_states);
496 XBT_INFO("Visited states = %lu", stats->visited_states);
498 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
499 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
501 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
502 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0')) {
503 fprintf(dot_output, "}\n");
506 if (initial_global_state != NULL && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
507 XBT_INFO("Send-deterministic : %s", !initial_global_state->send_deterministic ? "No" : "Yes");
508 if (_sg_mc_comms_determinism)
509 XBT_INFO("Recv-deterministic : %s", !initial_global_state->recv_deterministic ? "No" : "Yes");
513 void MC_automaton_load(const char *file)
515 if (_mc_property_automaton == NULL)
516 _mc_property_automaton = xbt_automaton_new();
518 xbt_automaton_load(_mc_property_automaton, file);
521 static void register_symbol(xbt_automaton_propositional_symbol_t symbol)
523 if (mc_mode != MC_MODE_CLIENT)
525 s_mc_register_symbol_message_t message;
526 message.type = MC_MESSAGE_REGISTER_SYMBOL;
527 const char* name = xbt_automaton_propositional_symbol_get_name(symbol);
528 if (strlen(name) + 1 > sizeof(message.name))
529 xbt_die("Symbol is too long");
530 strncpy(message.name, name, sizeof(message.name));
531 message.callback = xbt_automaton_propositional_symbol_get_callback(symbol);
532 message.data = xbt_automaton_propositional_symbol_get_data(symbol);
533 MC_client_send_message(&message, sizeof(message));
536 void MC_automaton_new_propositional_symbol(const char *id, int(*fct)(void))
538 if (_mc_property_automaton == NULL)
539 _mc_property_automaton = xbt_automaton_new();
541 xbt_automaton_propositional_symbol_t symbol = xbt_automaton_propositional_symbol_new(_mc_property_automaton, id, fct);
542 register_symbol(symbol);
545 void MC_automaton_new_propositional_symbol_pointer(const char *id, int* value)
547 if (_mc_property_automaton == NULL)
548 _mc_property_automaton = xbt_automaton_new();
549 xbt_automaton_propositional_symbol_t symbol = xbt_automaton_propositional_symbol_new_pointer(_mc_property_automaton, id, value);
550 register_symbol(symbol);
553 void MC_automaton_new_propositional_symbol_callback(const char* id,
554 xbt_automaton_propositional_symbol_callback_type callback,
555 void* data, xbt_automaton_propositional_symbol_free_function_type free_function)
557 if (_mc_property_automaton == NULL)
558 _mc_property_automaton = xbt_automaton_new();
559 xbt_automaton_propositional_symbol_t symbol = xbt_automaton_propositional_symbol_new_callback(
560 _mc_property_automaton, id, callback, data, free_function);
561 register_symbol(symbol);
564 // TODO, fix cross-process access (this function is not used)
565 void MC_dump_stacks(FILE* file)
568 stack_region_t current_stack;
570 xbt_dynar_foreach(stacks_areas, cursor, current_stack) {
571 unw_context_t * context = (unw_context_t *)current_stack->context;
572 fprintf(file, "Stack %i:\n", nstack);
577 unw_init_local (&c, context);
580 const char * name = !unw_get_proc_name(&c, buffer, 100, &off) ? buffer : "?";
581 #if defined(__x86_64__)
584 unw_get_reg(&c, UNW_X86_64_RIP, &rip);
585 unw_get_reg(&c, UNW_X86_64_RSP, &rsp);
586 fprintf(file, " %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
587 nframe, name, rip, rsp);
589 fprintf(file, " %i: %s\n", nframe, name);
592 } while(unw_step(&c));
599 double MC_process_clock_get(smx_process_t process)
603 return mc_time[process->pid];
611 void MC_process_clock_add(smx_process_t process, double amount)
613 mc_time[process->pid] += amount;
617 void MC_report_assertion_error(void)
619 XBT_INFO("**************************");
620 XBT_INFO("*** PROPERTY NOT VALID ***");
621 XBT_INFO("**************************");
622 XBT_INFO("Counter-example execution trace:");
623 MC_record_dump_path(mc_stack);
624 MC_dump_stack_safety(mc_stack);
625 MC_print_statistics(mc_stats);
628 void MC_invalidate_cache(void)
630 if (mc_model_checker)
631 mc_model_checker->process().cache_flags = 0;