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/mc_liveness.h"
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();
111 * \brief Re-executes from the state at position start all the transitions indicated by
112 * a given model-checker stack.
113 * \param stack The stack with the transitions to execute.
114 * \param start Start index to begin the re-execution.
116 void MC_replay(xbt_fifo_t stack)
118 int value, count = 1;
120 smx_simcall_t req = nullptr, saved_req = NULL;
121 xbt_fifo_item_t item, start_item;
124 XBT_DEBUG("**** Begin Replay ****");
126 /* Intermediate backtracking */
127 if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
128 start_item = xbt_fifo_get_first_item(stack);
129 state = (mc_state_t)xbt_fifo_get_item_content(start_item);
130 if(state->system_state){
131 simgrid::mc::restore_snapshot(state->system_state);
132 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
133 MC_restore_communications_pattern(state);
139 /* Restore the initial state */
140 simgrid::mc::restore_snapshot(initial_global_state->snapshot);
141 /* At the moment of taking the snapshot the raw heap was set, so restoring
142 * it will set it back again, we have to unset it to continue */
144 start_item = xbt_fifo_get_last_item(stack);
146 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
147 // int n = xbt_dynar_length(incomplete_communications_pattern);
148 unsigned n = MC_smx_get_maxpid();
149 assert(n == xbt_dynar_length(incomplete_communications_pattern));
150 assert(n == xbt_dynar_length(initial_communications_pattern));
151 for (unsigned j=0; j < n ; j++) {
152 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
153 xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t)->index_comm = 0;
157 /* Traverse the stack from the state at position start and re-execute the transitions */
158 for (item = start_item;
159 item != xbt_fifo_get_first_item(stack);
160 item = xbt_fifo_get_prev_item(item)) {
162 state = (mc_state_t) xbt_fifo_get_item_content(item);
163 saved_req = MC_state_get_executed_request(state, &value);
166 /* because we got a copy of the executed request, we have to fetch the
167 real one, pointed by the request field of the issuer process */
169 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
170 req = &issuer->simcall;
172 /* Debug information */
173 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
174 req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
175 XBT_DEBUG("Replay: %s (%p)", req_str, state);
179 /* TODO : handle test and testany simcalls */
180 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
181 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
182 call = MC_get_call_type(req);
184 simgrid::mc::handle_simcall(req, value);
186 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
187 MC_handle_comm_pattern(call, req, value, nullptr, 1);
189 mc_model_checker->wait_for_requests();
194 /* Update statistics */
195 mc_stats->visited_states++;
196 mc_stats->executed_transitions++;
200 XBT_DEBUG("**** End Replay ****");
204 * \brief Dumps the contents of a model-checker's stack and shows the actual
206 * \param stack The stack to dump
208 void MC_dump_stack_safety(xbt_fifo_t stack)
210 MC_show_stack_safety(stack);
214 while ((state = (mc_state_t) xbt_fifo_pop(stack)) != nullptr)
215 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
219 void MC_show_stack_safety(xbt_fifo_t stack)
223 xbt_fifo_item_t item;
225 char *req_str = nullptr;
227 for (item = xbt_fifo_get_last_item(stack);
228 item; item = xbt_fifo_get_prev_item(item)) {
229 state = (mc_state_t)xbt_fifo_get_item_content(item);
230 req = MC_state_get_executed_request(state, &value);
232 req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
233 XBT_INFO("%s", req_str);
239 void MC_show_deadlock(smx_simcall_t req)
241 /*char *req_str = nullptr; */
242 XBT_INFO("**************************");
243 XBT_INFO("*** DEAD-LOCK DETECTED ***");
244 XBT_INFO("**************************");
245 XBT_INFO("Locked request:");
246 /*req_str = simgrid::mc::request_to_string(req);
247 XBT_INFO("%s", req_str);
248 xbt_free(req_str); */
249 XBT_INFO("Counter-example execution trace:");
250 MC_dump_stack_safety(mc_stack);
251 MC_print_statistics(mc_stats);
254 void MC_show_non_termination(void){
255 XBT_INFO("******************************************");
256 XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
257 XBT_INFO("******************************************");
258 XBT_INFO("Counter-example execution trace:");
259 MC_dump_stack_safety(mc_stack);
260 MC_print_statistics(mc_stats);
263 void MC_print_statistics(mc_stats_t stats)
265 if(_sg_mc_comms_determinism) {
266 if (!initial_global_state->recv_deterministic && initial_global_state->send_deterministic){
267 XBT_INFO("******************************************************");
268 XBT_INFO("**** Only-send-deterministic communication pattern ****");
269 XBT_INFO("******************************************************");
270 XBT_INFO("%s", initial_global_state->recv_diff);
271 }else if(!initial_global_state->send_deterministic && initial_global_state->recv_deterministic) {
272 XBT_INFO("******************************************************");
273 XBT_INFO("**** Only-recv-deterministic communication pattern ****");
274 XBT_INFO("******************************************************");
275 XBT_INFO("%s", initial_global_state->send_diff);
279 if (stats->expanded_pairs == 0) {
280 XBT_INFO("Expanded states = %lu", stats->expanded_states);
281 XBT_INFO("Visited states = %lu", stats->visited_states);
283 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
284 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
286 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
287 if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0')) {
288 fprintf(dot_output, "}\n");
291 if (initial_global_state != nullptr && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
292 XBT_INFO("Send-deterministic : %s", !initial_global_state->send_deterministic ? "No" : "Yes");
293 if (_sg_mc_comms_determinism)
294 XBT_INFO("Recv-deterministic : %s", !initial_global_state->recv_deterministic ? "No" : "Yes");
296 if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
297 int ret=system("free");
298 if(ret!=0)XBT_WARN("system call did not return 0, but %d",ret);
302 void MC_automaton_load(const char *file)
304 if (simgrid::mc::property_automaton == nullptr)
305 simgrid::mc::property_automaton = xbt_automaton_new();
307 xbt_automaton_load(simgrid::mc::property_automaton, file);
310 // TODO, fix cross-process access (this function is not used)
311 static void MC_dump_stacks(FILE* file)
314 for (auto const& stack : mc_model_checker->process().stack_areas()) {
316 xbt_die("Fix cross-process access to the context");
317 unw_context_t * context = (unw_context_t *)stack.context;
318 fprintf(file, "Stack %i:\n", nstack);
323 unw_init_local (&c, context);
326 const char * name = !unw_get_proc_name(&c, buffer, 100, &off) ? buffer : "?";
327 #if defined(__x86_64__)
330 unw_get_reg(&c, UNW_X86_64_RIP, &rip);
331 unw_get_reg(&c, UNW_X86_64_RSP, &rsp);
332 fprintf(file, " %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
333 nframe, name, (std::uint64_t) rip, (std::uint64_t) rsp);
335 fprintf(file, " %i: %s\n", nframe, name);
338 } while(unw_step(&c));
345 double MC_process_clock_get(smx_process_t process)
347 if (simgrid::mc::processes_time.empty())
349 if (process != nullptr)
350 return simgrid::mc::processes_time[process->pid];
354 void MC_process_clock_add(smx_process_t process, double amount)
356 simgrid::mc::processes_time[process->pid] += amount;
360 void MC_report_assertion_error(void)
362 XBT_INFO("**************************");
363 XBT_INFO("*** PROPERTY NOT VALID ***");
364 XBT_INFO("**************************");
365 XBT_INFO("Counter-example execution trace:");
366 MC_record_dump_path(mc_stack);
367 MC_dump_stack_safety(mc_stack);
368 MC_print_statistics(mc_stats);
371 void MC_report_crash(int status)
373 XBT_INFO("**************************");
374 XBT_INFO("** CRASH IN THE PROGRAM **");
375 XBT_INFO("**************************");
376 if (WIFSIGNALED(status))
377 XBT_INFO("From signal: %s", strsignal(WTERMSIG(status)));
378 else if (WIFEXITED(status))
379 XBT_INFO("From exit: %i", WEXITSTATUS(status));
380 if (WCOREDUMP(status))
381 XBT_INFO("A core dump was generated by the system.");
383 XBT_INFO("No core dump was generated by the system.");
384 XBT_INFO("Counter-example execution trace:");
385 MC_record_dump_path(mc_stack);
386 MC_dump_stack_safety(mc_stack);
387 MC_print_statistics(mc_stats);