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. */
24 #include "src/simix/smx_process_private.h"
27 #include <libunwind.h>
28 #include "src/mc/mc_comm_pattern.h"
29 #include "src/mc/mc_request.h"
30 #include "src/mc/mc_safety.h"
31 #include "src/mc/mc_snapshot.h"
32 #include "src/mc/LivenessChecker.hpp"
33 #include "src/mc/mc_private.h"
34 #include "src/mc/mc_unw.h"
35 #include "src/mc/mc_smx.h"
38 #include "src/mc/mc_record.h"
39 #include "src/mc/mc_protocol.h"
40 #include "src/mc/Client.hpp"
42 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc, "Logging specific to MC (global)");
49 std::vector<double> processes_time;
55 int user_max_depth_reached = 0;
57 /* MC global data structures */
58 mc_state_t mc_current_state = nullptr;
59 char mc_replay_mode = false;
61 mc_stats_t mc_stats = nullptr;
62 mc_global_t initial_global_state = nullptr;
63 xbt_fifo_t mc_stack = nullptr;
70 xbt_automaton_t property_automaton = nullptr;
76 FILE *dot_output = nullptr;
79 /******************************* Initialisation of MC *******************************/
80 /*********************************************************************************/
82 void MC_init_dot_output()
84 dot_output = fopen(_sg_mc_dot_output_file, "w");
86 if (dot_output == nullptr) {
87 perror("Error open dot output file");
92 "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");
96 /******************************* Core of MC *******************************/
97 /**************************************************************************/
101 simgrid::mc::processes_time.resize(simix_process_maxpid);
102 MC_ignore_heap(simgrid::mc::processes_time.data(),
103 simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0]));
104 smx_process_t process;
105 xbt_swag_foreach(process, simix_global->process_list)
106 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
107 simgrid::mc::Client::get()->mainLoop();
108 simgrid::mc::processes_time.clear();
112 * \brief Re-executes from the state at position start all the transitions indicated by
113 * a given model-checker stack.
114 * \param stack The stack with the transitions to execute.
115 * \param start Start index to begin the re-execution.
117 void MC_replay(xbt_fifo_t stack)
119 int value, count = 1;
121 smx_simcall_t req = nullptr, saved_req = NULL;
122 xbt_fifo_item_t item, start_item;
125 XBT_DEBUG("**** Begin Replay ****");
127 /* Intermediate backtracking */
128 if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
129 start_item = xbt_fifo_get_first_item(stack);
130 state = (mc_state_t)xbt_fifo_get_item_content(start_item);
131 if(state->system_state){
132 simgrid::mc::restore_snapshot(state->system_state);
133 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
134 MC_restore_communications_pattern(state);
140 /* Restore the initial state */
141 simgrid::mc::restore_snapshot(initial_global_state->snapshot);
142 /* At the moment of taking the snapshot the raw heap was set, so restoring
143 * it will set it back again, we have to unset it to continue */
145 start_item = xbt_fifo_get_last_item(stack);
147 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
148 // int n = xbt_dynar_length(incomplete_communications_pattern);
149 unsigned n = MC_smx_get_maxpid();
150 assert(n == xbt_dynar_length(incomplete_communications_pattern));
151 assert(n == xbt_dynar_length(initial_communications_pattern));
152 for (unsigned j=0; j < n ; j++) {
153 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
154 xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t)->index_comm = 0;
158 /* Traverse the stack from the state at position start and re-execute the transitions */
159 for (item = start_item;
160 item != xbt_fifo_get_first_item(stack);
161 item = xbt_fifo_get_prev_item(item)) {
163 state = (mc_state_t) xbt_fifo_get_item_content(item);
164 saved_req = MC_state_get_executed_request(state, &value);
167 /* because we got a copy of the executed request, we have to fetch the
168 real one, pointed by the request field of the issuer process */
170 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
171 req = &issuer->simcall;
173 /* Debug information */
174 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
175 req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
176 XBT_DEBUG("Replay: %s (%p)", req_str, state);
180 /* TODO : handle test and testany simcalls */
181 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
182 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
183 call = MC_get_call_type(req);
185 simgrid::mc::handle_simcall(req, value);
187 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
188 MC_handle_comm_pattern(call, req, value, nullptr, 1);
190 mc_model_checker->wait_for_requests();
195 /* Update statistics */
196 mc_stats->visited_states++;
197 mc_stats->executed_transitions++;
201 XBT_DEBUG("**** End Replay ****");
205 * \brief Dumps the contents of a model-checker's stack and shows the actual
207 * \param stack The stack to dump
209 void MC_dump_stack_safety(xbt_fifo_t stack)
211 MC_show_stack_safety(stack);
215 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != nullptr)
216 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
220 void MC_show_stack_safety(xbt_fifo_t stack)
224 xbt_fifo_item_t item;
226 char *req_str = nullptr;
228 for (item = xbt_fifo_get_last_item(stack);
229 item; item = xbt_fifo_get_prev_item(item)) {
230 state = (mc_state_t)xbt_fifo_get_item_content(item);
231 req = MC_state_get_executed_request(state, &value);
233 req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
234 XBT_INFO("%s", req_str);
240 void MC_show_deadlock(void)
242 XBT_INFO("**************************");
243 XBT_INFO("*** DEAD-LOCK DETECTED ***");
244 XBT_INFO("**************************");
245 XBT_INFO("Counter-example execution trace:");
246 MC_dump_stack_safety(mc_stack);
247 MC_print_statistics(mc_stats);
250 void MC_print_statistics(mc_stats_t stats)
252 if(_sg_mc_comms_determinism) {
253 if (!initial_global_state->recv_deterministic && initial_global_state->send_deterministic){
254 XBT_INFO("******************************************************");
255 XBT_INFO("**** Only-send-deterministic communication pattern ****");
256 XBT_INFO("******************************************************");
257 XBT_INFO("%s", initial_global_state->recv_diff);
258 }else if(!initial_global_state->send_deterministic && initial_global_state->recv_deterministic) {
259 XBT_INFO("******************************************************");
260 XBT_INFO("**** Only-recv-deterministic communication pattern ****");
261 XBT_INFO("******************************************************");
262 XBT_INFO("%s", initial_global_state->send_diff);
266 if (stats->expanded_pairs == 0) {
267 XBT_INFO("Expanded states = %lu", stats->expanded_states);
268 XBT_INFO("Visited states = %lu", stats->visited_states);
270 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
271 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
273 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
274 if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0')) {
275 fprintf(dot_output, "}\n");
278 if (initial_global_state != nullptr && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
279 XBT_INFO("Send-deterministic : %s", !initial_global_state->send_deterministic ? "No" : "Yes");
280 if (_sg_mc_comms_determinism)
281 XBT_INFO("Recv-deterministic : %s", !initial_global_state->recv_deterministic ? "No" : "Yes");
283 if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
284 int ret=system("free");
285 if(ret!=0)XBT_WARN("system call did not return 0, but %d",ret);
289 void MC_automaton_load(const char *file)
291 if (simgrid::mc::property_automaton == nullptr)
292 simgrid::mc::property_automaton = xbt_automaton_new();
294 xbt_automaton_load(simgrid::mc::property_automaton, file);
297 static void MC_dump_stacks(FILE* file)
300 for (auto const& stack : mc_model_checker->process().stack_areas()) {
302 fprintf(file, "Stack %i:\n", nstack);
307 simgrid::mc::UnwindContext context;
308 unw_context_t raw_context =
309 mc_model_checker->process().read<unw_context_t>(
310 simgrid::mc::remote((unw_context_t *)stack.context));
311 context.initialize(&mc_model_checker->process(), &raw_context);
313 unw_cursor_t cursor = context.cursor();
317 const char * name = !unw_get_proc_name(&cursor, buffer, 100, &off) ? buffer : "?";
318 #if defined(__x86_64__)
321 unw_get_reg(&cursor, UNW_X86_64_RIP, &rip);
322 unw_get_reg(&cursor, UNW_X86_64_RSP, &rsp);
323 fprintf(file, " %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
324 nframe, name, (std::uint64_t) rip, (std::uint64_t) rsp);
326 fprintf(file, " %i: %s\n", nframe, name);
329 } while(unw_step(&cursor));
336 double MC_process_clock_get(smx_process_t process)
338 if (simgrid::mc::processes_time.empty())
340 if (process != nullptr)
341 return simgrid::mc::processes_time[process->pid];
345 void MC_process_clock_add(smx_process_t process, double amount)
347 simgrid::mc::processes_time[process->pid] += amount;
351 void MC_report_assertion_error(void)
353 XBT_INFO("**************************");
354 XBT_INFO("*** PROPERTY NOT VALID ***");
355 XBT_INFO("**************************");
356 XBT_INFO("Counter-example execution trace:");
357 MC_record_dump_path(mc_stack);
358 MC_dump_stack_safety(mc_stack);
359 MC_print_statistics(mc_stats);
362 void MC_report_crash(int status)
364 XBT_INFO("**************************");
365 XBT_INFO("** CRASH IN THE PROGRAM **");
366 XBT_INFO("**************************");
367 if (WIFSIGNALED(status))
368 XBT_INFO("From signal: %s", strsignal(WTERMSIG(status)));
369 else if (WIFEXITED(status))
370 XBT_INFO("From exit: %i", WEXITSTATUS(status));
371 if (WCOREDUMP(status))
372 XBT_INFO("A core dump was generated by the system.");
374 XBT_INFO("No core dump was generated by the system.");
375 XBT_INFO("Counter-example execution trace:");
376 MC_record_dump_path(mc_stack);
377 MC_dump_stack_safety(mc_stack);
378 MC_print_statistics(mc_stats);