1 /* Copyright (c) 2008-2015. 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_dwarf.hpp"
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_model_checker->process().send_message(MC_MESSAGE_DEADLOCK_CHECK)))
196 xbt_die("Could not check deadlock state");
197 s_mc_int_message_t message;
198 ssize_t s = mc_model_checker->process().receive_message(message);
200 xbt_die("Could not receive message");
201 else if (s != sizeof(message) || message.type != MC_MESSAGE_DEADLOCK_CHECK_REPLY) {
202 xbt_die("%s received unexpected message %s (%i, size=%i) "
203 "expected MC_MESSAGE_DEADLOCK_CHECK_REPLY (%i, size=%i)",
204 MC_mode_name(mc_mode),
205 MC_message_type_name(message.type), (int) message.type, (int) s,
206 (int) MC_MESSAGE_DEADLOCK_CHECK_REPLY, (int) sizeof(message)
210 return message.value;
213 int deadlock = FALSE;
214 smx_process_t process;
215 if (xbt_swag_size(simix_global->process_list)) {
217 xbt_swag_foreach(process, simix_global->process_list) {
218 if (MC_process_is_enabled(process)) {
229 * \brief Re-executes from the state at position start all the transitions indicated by
230 * a given model-checker stack.
231 * \param stack The stack with the transitions to execute.
232 * \param start Start index to begin the re-execution.
234 void MC_replay(xbt_fifo_t stack)
236 int value, count = 1;
238 smx_simcall_t req = NULL, saved_req = NULL;
239 xbt_fifo_item_t item, start_item;
242 XBT_DEBUG("**** Begin Replay ****");
244 /* Intermediate backtracking */
245 if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
246 start_item = xbt_fifo_get_first_item(stack);
247 state = (mc_state_t)xbt_fifo_get_item_content(start_item);
248 if(state->system_state){
249 MC_restore_snapshot(state->system_state);
250 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
251 MC_restore_communications_pattern(state);
257 /* Restore the initial state */
258 MC_restore_snapshot(initial_global_state->snapshot);
259 /* At the moment of taking the snapshot the raw heap was set, so restoring
260 * it will set it back again, we have to unset it to continue */
262 start_item = xbt_fifo_get_last_item(stack);
264 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
265 // int n = xbt_dynar_length(incomplete_communications_pattern);
266 unsigned n = MC_smx_get_maxpid();
267 assert(n == xbt_dynar_length(incomplete_communications_pattern));
268 assert(n == xbt_dynar_length(initial_communications_pattern));
269 for (unsigned j=0; j < n ; j++) {
270 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
271 xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t)->index_comm = 0;
275 /* Traverse the stack from the state at position start and re-execute the transitions */
276 for (item = start_item;
277 item != xbt_fifo_get_first_item(stack);
278 item = xbt_fifo_get_prev_item(item)) {
280 state = (mc_state_t) xbt_fifo_get_item_content(item);
281 saved_req = MC_state_get_executed_request(state, &value);
284 /* because we got a copy of the executed request, we have to fetch the
285 real one, pointed by the request field of the issuer process */
287 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
288 req = &issuer->simcall;
290 /* Debug information */
291 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
292 req_str = MC_request_to_string(req, value, MC_REQUEST_SIMIX);
293 XBT_DEBUG("Replay: %s (%p)", req_str, state);
297 /* TODO : handle test and testany simcalls */
298 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
299 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
300 call = MC_get_call_type(req);
302 MC_simcall_handle(req, value);
304 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
305 MC_handle_comm_pattern(call, req, value, NULL, 1);
307 MC_wait_for_requests();
312 /* Update statistics */
313 mc_stats->visited_states++;
314 mc_stats->executed_transitions++;
318 XBT_DEBUG("**** End Replay ****");
321 void MC_replay_liveness(xbt_fifo_t stack)
323 xbt_fifo_item_t item;
324 mc_pair_t pair = NULL;
325 mc_state_t state = NULL;
326 smx_simcall_t req = NULL, saved_req = NULL;
327 int value, depth = 1;
330 XBT_DEBUG("**** Begin Replay ****");
332 /* Intermediate backtracking */
333 if(_sg_mc_checkpoint > 0) {
334 item = xbt_fifo_get_first_item(stack);
335 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
336 if(pair->graph_state->system_state){
337 MC_restore_snapshot(pair->graph_state->system_state);
342 /* Restore the initial state */
343 MC_restore_snapshot(initial_global_state->snapshot);
345 /* Traverse the stack from the initial state and re-execute the transitions */
346 for (item = xbt_fifo_get_last_item(stack);
347 item != xbt_fifo_get_first_item(stack);
348 item = xbt_fifo_get_prev_item(item)) {
350 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
352 state = (mc_state_t) pair->graph_state;
354 if (pair->exploration_started) {
356 saved_req = MC_state_get_executed_request(state, &value);
358 if (saved_req != NULL) {
359 /* because we got a copy of the executed request, we have to fetch the
360 real one, pointed by the request field of the issuer process */
361 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
362 req = &issuer->simcall;
364 /* Debug information */
365 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
366 req_str = MC_request_to_string(req, value, MC_REQUEST_SIMIX);
367 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
373 MC_simcall_handle(req, value);
374 MC_wait_for_requests();
377 /* Update statistics */
378 mc_stats->visited_pairs++;
379 mc_stats->executed_transitions++;
385 XBT_DEBUG("**** End Replay ****");
389 * \brief Dumps the contents of a model-checker's stack and shows the actual
391 * \param stack The stack to dump
393 void MC_dump_stack_safety(xbt_fifo_t stack)
395 MC_show_stack_safety(stack);
399 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
400 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
404 void MC_show_stack_safety(xbt_fifo_t stack)
408 xbt_fifo_item_t item;
410 char *req_str = NULL;
412 for (item = xbt_fifo_get_last_item(stack);
413 item; item = xbt_fifo_get_prev_item(item)) {
414 state = (mc_state_t)xbt_fifo_get_item_content(item);
415 req = MC_state_get_executed_request(state, &value);
417 req_str = MC_request_to_string(req, value, MC_REQUEST_EXECUTED);
418 XBT_INFO("%s", req_str);
424 void MC_show_deadlock(smx_simcall_t req)
426 /*char *req_str = NULL; */
427 XBT_INFO("**************************");
428 XBT_INFO("*** DEAD-LOCK DETECTED ***");
429 XBT_INFO("**************************");
430 XBT_INFO("Locked request:");
431 /*req_str = MC_request_to_string(req);
432 XBT_INFO("%s", req_str);
433 xbt_free(req_str); */
434 XBT_INFO("Counter-example execution trace:");
435 MC_dump_stack_safety(mc_stack);
436 MC_print_statistics(mc_stats);
439 void MC_show_non_termination(void){
440 XBT_INFO("******************************************");
441 XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
442 XBT_INFO("******************************************");
443 XBT_INFO("Counter-example execution trace:");
444 MC_dump_stack_safety(mc_stack);
445 MC_print_statistics(mc_stats);
449 void MC_show_stack_liveness(xbt_fifo_t stack)
453 xbt_fifo_item_t item;
455 char *req_str = NULL;
457 for (item = xbt_fifo_get_last_item(stack);
458 item; item = xbt_fifo_get_prev_item(item)) {
459 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
460 req = MC_state_get_executed_request(pair->graph_state, &value);
461 if (req && req->call != SIMCALL_NONE) {
462 req_str = MC_request_to_string(req, value, MC_REQUEST_EXECUTED);
463 XBT_INFO("%s", req_str);
470 void MC_dump_stack_liveness(xbt_fifo_t stack)
473 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
474 MC_pair_delete(pair);
477 void MC_print_statistics(mc_stats_t stats)
479 if(_sg_mc_comms_determinism) {
480 if (!initial_global_state->recv_deterministic && initial_global_state->send_deterministic){
481 XBT_INFO("******************************************************");
482 XBT_INFO("**** Only-send-deterministic communication pattern ****");
483 XBT_INFO("******************************************************");
484 XBT_INFO("%s", initial_global_state->recv_diff);
485 }else if(!initial_global_state->send_deterministic && initial_global_state->recv_deterministic) {
486 XBT_INFO("******************************************************");
487 XBT_INFO("**** Only-recv-deterministic communication pattern ****");
488 XBT_INFO("******************************************************");
489 XBT_INFO("%s", initial_global_state->send_diff);
493 if (stats->expanded_pairs == 0) {
494 XBT_INFO("Expanded states = %lu", stats->expanded_states);
495 XBT_INFO("Visited states = %lu", stats->visited_states);
497 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
498 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
500 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
501 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0')) {
502 fprintf(dot_output, "}\n");
505 if (initial_global_state != NULL && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
506 XBT_INFO("Send-deterministic : %s", !initial_global_state->send_deterministic ? "No" : "Yes");
507 if (_sg_mc_comms_determinism)
508 XBT_INFO("Recv-deterministic : %s", !initial_global_state->recv_deterministic ? "No" : "Yes");
512 void MC_automaton_load(const char *file)
514 if (_mc_property_automaton == NULL)
515 _mc_property_automaton = xbt_automaton_new();
517 xbt_automaton_load(_mc_property_automaton, file);
520 // TODO, fix cross-process access (this function is not used)
521 void MC_dump_stacks(FILE* file)
524 stack_region_t current_stack;
526 xbt_dynar_foreach(stacks_areas, cursor, current_stack) {
527 unw_context_t * context = (unw_context_t *)current_stack->context;
528 fprintf(file, "Stack %i:\n", nstack);
533 unw_init_local (&c, context);
536 const char * name = !unw_get_proc_name(&c, buffer, 100, &off) ? buffer : "?";
537 #if defined(__x86_64__)
540 unw_get_reg(&c, UNW_X86_64_RIP, &rip);
541 unw_get_reg(&c, UNW_X86_64_RSP, &rsp);
542 fprintf(file, " %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
543 nframe, name, rip, rsp);
545 fprintf(file, " %i: %s\n", nframe, name);
548 } while(unw_step(&c));
555 double MC_process_clock_get(smx_process_t process)
559 return mc_time[process->pid];
567 void MC_process_clock_add(smx_process_t process, double amount)
569 mc_time[process->pid] += amount;
573 void MC_report_assertion_error(void)
575 XBT_INFO("**************************");
576 XBT_INFO("*** PROPERTY NOT VALID ***");
577 XBT_INFO("**************************");
578 XBT_INFO("Counter-example execution trace:");
579 MC_record_dump_path(mc_stack);
580 MC_dump_stack_safety(mc_stack);
581 MC_print_statistics(mc_stats);
584 void MC_invalidate_cache(void)
586 if (mc_model_checker)
587 mc_model_checker->process().cache_flags = 0;