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. */
22 #include "simgrid/sg_config.h"
23 #include "src/surf/surf_private.h"
24 #include "src/simix/smx_private.h"
26 #include "xbt/automaton.h"
28 #include "mc_record.h"
31 #include <libunwind.h>
32 #include <xbt/mmalloc.h>
33 #include "src/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_snapshot.h"
39 #include "mc_liveness.h"
40 #include "mc_private.h"
44 #include "mc_record.h"
45 #include "mc_protocol.h"
46 #include "mc_client.h"
50 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
51 "Logging specific to MC (global)");
55 double *mc_time = NULL;
58 int user_max_depth_reached = 0;
60 /* MC global data structures */
61 mc_state_t mc_current_state = NULL;
62 char mc_replay_mode = FALSE;
64 mc_stats_t mc_stats = NULL;
65 mc_global_t initial_global_state = NULL;
66 xbt_fifo_t mc_stack = NULL;
69 xbt_automaton_t _mc_property_automaton = NULL;
72 FILE *dot_output = NULL;
73 const char *colors[13];
76 /******************************* Initialisation of MC *******************************/
77 /*********************************************************************************/
79 void MC_init_dot_output()
80 { /* FIXME : more colors */
85 colors[3] = "goldenrod";
88 colors[6] = "magenta";
89 colors[7] = "turquoise4";
91 colors[9] = "forestgreen";
92 colors[10] = "hotpink";
93 colors[11] = "lightblue";
96 dot_output = fopen(_sg_mc_dot_output_file, "w");
98 if (dot_output == NULL) {
99 perror("Error open dot output file");
104 "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");
111 mc_time = xbt_new0(double, simix_process_maxpid);
113 if (_sg_mc_visited > 0 || _sg_mc_liveness || _sg_mc_termination || mc_mode == MC_MODE_SERVER) {
114 /* Those requests are handled on the client side and propagated by message
117 MC_ignore_heap(mc_time, simix_process_maxpid * sizeof(double));
119 smx_process_t process;
120 xbt_swag_foreach(process, simix_global->process_list) {
121 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
128 /******************************* Core of MC *******************************/
129 /**************************************************************************/
133 mc_mode = MC_MODE_CLIENT;
135 MC_client_main_loop();
147 int MC_deadlock_check()
149 if (mc_mode == MC_MODE_SERVER) {
151 if ((res = mc_model_checker->process().send_message(MC_MESSAGE_DEADLOCK_CHECK)))
152 xbt_die("Could not check deadlock state");
153 s_mc_int_message_t message;
154 ssize_t s = mc_model_checker->process().receive_message(message);
156 xbt_die("Could not receive message");
157 else if (s != sizeof(message) || message.type != MC_MESSAGE_DEADLOCK_CHECK_REPLY) {
158 xbt_die("%s received unexpected message %s (%i, size=%i) "
159 "expected MC_MESSAGE_DEADLOCK_CHECK_REPLY (%i, size=%i)",
160 MC_mode_name(mc_mode),
161 MC_message_type_name(message.type), (int) message.type, (int) s,
162 (int) MC_MESSAGE_DEADLOCK_CHECK_REPLY, (int) sizeof(message)
166 return message.value;
169 int deadlock = FALSE;
170 smx_process_t process;
171 if (xbt_swag_size(simix_global->process_list)) {
173 xbt_swag_foreach(process, simix_global->process_list) {
174 if (MC_process_is_enabled(process)) {
185 * \brief Re-executes from the state at position start all the transitions indicated by
186 * a given model-checker stack.
187 * \param stack The stack with the transitions to execute.
188 * \param start Start index to begin the re-execution.
190 void MC_replay(xbt_fifo_t stack)
192 int value, count = 1;
194 smx_simcall_t req = NULL, saved_req = NULL;
195 xbt_fifo_item_t item, start_item;
198 XBT_DEBUG("**** Begin Replay ****");
200 /* Intermediate backtracking */
201 if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
202 start_item = xbt_fifo_get_first_item(stack);
203 state = (mc_state_t)xbt_fifo_get_item_content(start_item);
204 if(state->system_state){
205 MC_restore_snapshot(state->system_state);
206 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
207 MC_restore_communications_pattern(state);
213 /* Restore the initial state */
214 MC_restore_snapshot(initial_global_state->snapshot);
215 /* At the moment of taking the snapshot the raw heap was set, so restoring
216 * it will set it back again, we have to unset it to continue */
218 start_item = xbt_fifo_get_last_item(stack);
220 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
221 // int n = xbt_dynar_length(incomplete_communications_pattern);
222 unsigned n = MC_smx_get_maxpid();
223 assert(n == xbt_dynar_length(incomplete_communications_pattern));
224 assert(n == xbt_dynar_length(initial_communications_pattern));
225 for (unsigned j=0; j < n ; j++) {
226 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
227 xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t)->index_comm = 0;
231 /* Traverse the stack from the state at position start and re-execute the transitions */
232 for (item = start_item;
233 item != xbt_fifo_get_first_item(stack);
234 item = xbt_fifo_get_prev_item(item)) {
236 state = (mc_state_t) xbt_fifo_get_item_content(item);
237 saved_req = MC_state_get_executed_request(state, &value);
240 /* because we got a copy of the executed request, we have to fetch the
241 real one, pointed by the request field of the issuer process */
243 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
244 req = &issuer->simcall;
246 /* Debug information */
247 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
248 req_str = MC_request_to_string(req, value, MC_REQUEST_SIMIX);
249 XBT_DEBUG("Replay: %s (%p)", req_str, state);
253 /* TODO : handle test and testany simcalls */
254 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
255 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
256 call = MC_get_call_type(req);
258 MC_simcall_handle(req, value);
260 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
261 MC_handle_comm_pattern(call, req, value, NULL, 1);
263 mc_model_checker->wait_for_requests();
268 /* Update statistics */
269 mc_stats->visited_states++;
270 mc_stats->executed_transitions++;
274 XBT_DEBUG("**** End Replay ****");
277 void MC_replay_liveness(xbt_fifo_t stack)
279 xbt_fifo_item_t item;
280 mc_pair_t pair = NULL;
281 mc_state_t state = NULL;
282 smx_simcall_t req = NULL, saved_req = NULL;
283 int value, depth = 1;
286 XBT_DEBUG("**** Begin Replay ****");
288 /* Intermediate backtracking */
289 if(_sg_mc_checkpoint > 0) {
290 item = xbt_fifo_get_first_item(stack);
291 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
292 if(pair->graph_state->system_state){
293 MC_restore_snapshot(pair->graph_state->system_state);
298 /* Restore the initial state */
299 MC_restore_snapshot(initial_global_state->snapshot);
301 /* Traverse the stack from the initial state and re-execute the transitions */
302 for (item = xbt_fifo_get_last_item(stack);
303 item != xbt_fifo_get_first_item(stack);
304 item = xbt_fifo_get_prev_item(item)) {
306 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
308 state = (mc_state_t) pair->graph_state;
310 if (pair->exploration_started) {
312 saved_req = MC_state_get_executed_request(state, &value);
314 if (saved_req != NULL) {
315 /* because we got a copy of the executed request, we have to fetch the
316 real one, pointed by the request field of the issuer process */
317 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
318 req = &issuer->simcall;
320 /* Debug information */
321 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
322 req_str = MC_request_to_string(req, value, MC_REQUEST_SIMIX);
323 XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state);
329 MC_simcall_handle(req, value);
330 mc_model_checker->wait_for_requests();
333 /* Update statistics */
334 mc_stats->visited_pairs++;
335 mc_stats->executed_transitions++;
341 XBT_DEBUG("**** End Replay ****");
345 * \brief Dumps the contents of a model-checker's stack and shows the actual
347 * \param stack The stack to dump
349 void MC_dump_stack_safety(xbt_fifo_t stack)
351 MC_show_stack_safety(stack);
355 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
356 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
360 void MC_show_stack_safety(xbt_fifo_t stack)
364 xbt_fifo_item_t item;
366 char *req_str = NULL;
368 for (item = xbt_fifo_get_last_item(stack);
369 item; item = xbt_fifo_get_prev_item(item)) {
370 state = (mc_state_t)xbt_fifo_get_item_content(item);
371 req = MC_state_get_executed_request(state, &value);
373 req_str = MC_request_to_string(req, value, MC_REQUEST_EXECUTED);
374 XBT_INFO("%s", req_str);
380 void MC_show_deadlock(smx_simcall_t req)
382 /*char *req_str = NULL; */
383 XBT_INFO("**************************");
384 XBT_INFO("*** DEAD-LOCK DETECTED ***");
385 XBT_INFO("**************************");
386 XBT_INFO("Locked request:");
387 /*req_str = MC_request_to_string(req);
388 XBT_INFO("%s", req_str);
389 xbt_free(req_str); */
390 XBT_INFO("Counter-example execution trace:");
391 MC_dump_stack_safety(mc_stack);
392 MC_print_statistics(mc_stats);
395 void MC_show_non_termination(void){
396 XBT_INFO("******************************************");
397 XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
398 XBT_INFO("******************************************");
399 XBT_INFO("Counter-example execution trace:");
400 MC_dump_stack_safety(mc_stack);
401 MC_print_statistics(mc_stats);
405 void MC_show_stack_liveness(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 pair = (mc_pair_t) xbt_fifo_get_item_content(item);
416 req = MC_state_get_executed_request(pair->graph_state, &value);
417 if (req && req->call != SIMCALL_NONE) {
418 req_str = MC_request_to_string(req, value, MC_REQUEST_EXECUTED);
419 XBT_INFO("%s", req_str);
426 void MC_dump_stack_liveness(xbt_fifo_t stack)
429 while ((pair = (mc_pair_t) xbt_fifo_pop(stack)) != NULL)
430 MC_pair_delete(pair);
433 void MC_print_statistics(mc_stats_t stats)
435 if(_sg_mc_comms_determinism) {
436 if (!initial_global_state->recv_deterministic && initial_global_state->send_deterministic){
437 XBT_INFO("******************************************************");
438 XBT_INFO("**** Only-send-deterministic communication pattern ****");
439 XBT_INFO("******************************************************");
440 XBT_INFO("%s", initial_global_state->recv_diff);
441 }else if(!initial_global_state->send_deterministic && initial_global_state->recv_deterministic) {
442 XBT_INFO("******************************************************");
443 XBT_INFO("**** Only-recv-deterministic communication pattern ****");
444 XBT_INFO("******************************************************");
445 XBT_INFO("%s", initial_global_state->send_diff);
449 if (stats->expanded_pairs == 0) {
450 XBT_INFO("Expanded states = %lu", stats->expanded_states);
451 XBT_INFO("Visited states = %lu", stats->visited_states);
453 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
454 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
456 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
457 if ((_sg_mc_dot_output_file != NULL) && (_sg_mc_dot_output_file[0] != '\0')) {
458 fprintf(dot_output, "}\n");
461 if (initial_global_state != NULL && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
462 XBT_INFO("Send-deterministic : %s", !initial_global_state->send_deterministic ? "No" : "Yes");
463 if (_sg_mc_comms_determinism)
464 XBT_INFO("Recv-deterministic : %s", !initial_global_state->recv_deterministic ? "No" : "Yes");
466 if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
467 int ret=system("free");
468 if(ret!=0)XBT_WARN("system call did not return 0, but %d",ret);
472 void MC_automaton_load(const char *file)
474 if (_mc_property_automaton == NULL)
475 _mc_property_automaton = xbt_automaton_new();
477 xbt_automaton_load(_mc_property_automaton, file);
480 // TODO, fix cross-process access (this function is not used)
481 void MC_dump_stacks(FILE* file)
484 for (auto const& stack : mc_model_checker->process().stack_areas()) {
486 xbt_die("Fix cross-process access to the context");
487 unw_context_t * context = (unw_context_t *)stack.context;
488 fprintf(file, "Stack %i:\n", nstack);
493 unw_init_local (&c, context);
496 const char * name = !unw_get_proc_name(&c, buffer, 100, &off) ? buffer : "?";
497 #if defined(__x86_64__)
500 unw_get_reg(&c, UNW_X86_64_RIP, &rip);
501 unw_get_reg(&c, UNW_X86_64_RSP, &rsp);
502 fprintf(file, " %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
503 nframe, name, (std::uint64_t) rip, (std::uint64_t) rsp);
505 fprintf(file, " %i: %s\n", nframe, name);
508 } while(unw_step(&c));
515 double MC_process_clock_get(smx_process_t process)
519 return mc_time[process->pid];
527 void MC_process_clock_add(smx_process_t process, double amount)
529 mc_time[process->pid] += amount;
533 void MC_report_assertion_error(void)
535 XBT_INFO("**************************");
536 XBT_INFO("*** PROPERTY NOT VALID ***");
537 XBT_INFO("**************************");
538 XBT_INFO("Counter-example execution trace:");
539 MC_record_dump_path(mc_stack);
540 MC_dump_stack_safety(mc_stack);
541 MC_print_statistics(mc_stats);
544 void MC_report_crash(int status)
546 XBT_INFO("**************************");
547 XBT_INFO("** CRASH IN THE PROGRAM **");
548 XBT_INFO("**************************");
549 if (WIFSIGNALED(status))
550 XBT_INFO("From signal: %s", strsignal(WTERMSIG(status)));
551 else if (WIFEXITED(status))
552 XBT_INFO("From exit: %i", WEXITSTATUS(status));
553 if (WCOREDUMP(status))
554 XBT_INFO("A core dump was generated by the system.");
556 XBT_INFO("No core dump was generated by the system.");
557 XBT_INFO("Counter-example execution trace:");
558 MC_record_dump_path(mc_stack);
559 MC_dump_stack_safety(mc_stack);
560 MC_print_statistics(mc_stats);