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. */
26 #include "src/simix/smx_process_private.h"
29 #include <libunwind.h>
30 #include "src/mc/mc_comm_pattern.h"
31 #include "src/mc/mc_request.h"
32 #include "src/mc/mc_safety.h"
33 #include "src/mc/mc_snapshot.h"
34 #include "src/mc/mc_private.h"
35 #include "src/mc/mc_unw.h"
36 #include "src/mc/mc_smx.h"
37 #include "src/mc/Checker.hpp"
40 #include "src/mc/mc_record.h"
41 #include "src/mc/mc_protocol.h"
42 #include "src/mc/Client.hpp"
44 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc, "Logging specific to MC (global)");
51 std::vector<double> processes_time;
57 int user_max_depth_reached = 0;
59 /* MC global data structures */
60 simgrid::mc::State* mc_current_state = nullptr;
61 char mc_replay_mode = false;
63 mc_stats_t mc_stats = nullptr;
64 xbt_fifo_t mc_stack = nullptr;
71 std::unique_ptr<s_mc_global_t> initial_global_state = nullptr;
72 xbt_automaton_t property_automaton = nullptr;
78 FILE *dot_output = nullptr;
81 /******************************* Initialisation of MC *******************************/
82 /*********************************************************************************/
84 void MC_init_dot_output()
86 dot_output = fopen(_sg_mc_dot_output_file, "w");
88 if (dot_output == nullptr) {
89 perror("Error open dot output file");
94 "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");
98 /******************************* Core of MC *******************************/
99 /**************************************************************************/
103 simgrid::mc::processes_time.resize(simix_process_maxpid);
104 MC_ignore_heap(simgrid::mc::processes_time.data(),
105 simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0]));
106 smx_process_t process;
107 xbt_swag_foreach(process, simix_global->process_list)
108 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
109 simgrid::mc::Client::get()->mainLoop();
110 simgrid::mc::processes_time.clear();
114 * \brief Re-executes from the state at position start all the transitions indicated by
115 * a given model-checker stack.
116 * \param stack The stack with the transitions to execute.
117 * \param start Start index to begin the re-execution.
119 void MC_replay(xbt_fifo_t stack)
121 int value, count = 1;
123 smx_simcall_t req = nullptr, saved_req = NULL;
124 xbt_fifo_item_t item, start_item;
125 simgrid::mc::State* state;
127 XBT_DEBUG("**** Begin Replay ****");
129 /* Intermediate backtracking */
130 if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
131 start_item = xbt_fifo_get_first_item(stack);
132 state = (simgrid::mc::State*)xbt_fifo_get_item_content(start_item);
133 if(state->system_state){
134 simgrid::mc::restore_snapshot(state->system_state);
135 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
136 MC_restore_communications_pattern(state);
142 /* Restore the initial state */
143 simgrid::mc::restore_snapshot(simgrid::mc::initial_global_state->snapshot);
144 /* At the moment of taking the snapshot the raw heap was set, so restoring
145 * it will set it back again, we have to unset it to continue */
147 start_item = xbt_fifo_get_last_item(stack);
149 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
150 // int n = xbt_dynar_length(incomplete_communications_pattern);
151 unsigned n = MC_smx_get_maxpid();
152 assert(n == xbt_dynar_length(incomplete_communications_pattern));
153 assert(n == xbt_dynar_length(initial_communications_pattern));
154 for (unsigned j=0; j < n ; j++) {
155 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
156 xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t)->index_comm = 0;
160 /* Traverse the stack from the state at position start and re-execute the transitions */
161 for (item = start_item;
162 item != xbt_fifo_get_first_item(stack);
163 item = xbt_fifo_get_prev_item(item)) {
165 state = (simgrid::mc::State*) xbt_fifo_get_item_content(item);
166 saved_req = MC_state_get_executed_request(state, &value);
169 /* because we got a copy of the executed request, we have to fetch the
170 real one, pointed by the request field of the issuer process */
172 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
173 req = &issuer->simcall;
175 /* Debug information */
176 if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
177 req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
178 XBT_DEBUG("Replay: %s (%p)", req_str, state);
182 /* TODO : handle test and testany simcalls */
183 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
184 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
185 call = MC_get_call_type(req);
187 simgrid::mc::handle_simcall(req, value);
189 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
190 MC_handle_comm_pattern(call, req, value, nullptr, 1);
192 mc_model_checker->wait_for_requests();
197 /* Update statistics */
198 mc_stats->visited_states++;
199 mc_stats->executed_transitions++;
203 XBT_DEBUG("**** End Replay ****");
206 void MC_show_deadlock(void)
208 XBT_INFO("**************************");
209 XBT_INFO("*** DEAD-LOCK DETECTED ***");
210 XBT_INFO("**************************");
211 XBT_INFO("Counter-example execution trace:");
212 for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
213 XBT_INFO("%s", s.c_str());
214 MC_print_statistics(mc_stats);
217 void MC_print_statistics(mc_stats_t stats)
219 if(_sg_mc_comms_determinism) {
220 if (!simgrid::mc::initial_global_state->recv_deterministic &&
221 simgrid::mc::initial_global_state->send_deterministic){
222 XBT_INFO("******************************************************");
223 XBT_INFO("**** Only-send-deterministic communication pattern ****");
224 XBT_INFO("******************************************************");
225 XBT_INFO("%s", simgrid::mc::initial_global_state->recv_diff);
226 }else if(!simgrid::mc::initial_global_state->send_deterministic &&
227 simgrid::mc::initial_global_state->recv_deterministic) {
228 XBT_INFO("******************************************************");
229 XBT_INFO("**** Only-recv-deterministic communication pattern ****");
230 XBT_INFO("******************************************************");
231 XBT_INFO("%s", simgrid::mc::initial_global_state->send_diff);
235 if (stats->expanded_pairs == 0) {
236 XBT_INFO("Expanded states = %lu", stats->expanded_states);
237 XBT_INFO("Visited states = %lu", stats->visited_states);
239 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
240 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
242 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
243 if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0')) {
244 fprintf(dot_output, "}\n");
247 if (simgrid::mc::initial_global_state != nullptr
248 && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
249 XBT_INFO("Send-deterministic : %s",
250 !simgrid::mc::initial_global_state->send_deterministic ? "No" : "Yes");
251 if (_sg_mc_comms_determinism)
252 XBT_INFO("Recv-deterministic : %s",
253 !simgrid::mc::initial_global_state->recv_deterministic ? "No" : "Yes");
255 if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
256 int ret=system("free");
257 if(ret!=0)XBT_WARN("system call did not return 0, but %d",ret);
261 void MC_automaton_load(const char *file)
263 if (simgrid::mc::property_automaton == nullptr)
264 simgrid::mc::property_automaton = xbt_automaton_new();
266 xbt_automaton_load(simgrid::mc::property_automaton, file);
272 void dumpStack(FILE* file, unw_cursor_t cursor)
279 const char * name = !unw_get_proc_name(&cursor, buffer, 100, &off) ? buffer : "?";
283 // Demangle C++ names:
284 char* realname = abi::__cxa_demangle(name, 0, 0, &status);
286 #if defined(__x86_64__)
289 unw_get_reg(&cursor, UNW_X86_64_RIP, &rip);
290 unw_get_reg(&cursor, UNW_X86_64_RSP, &rsp);
291 fprintf(file, " %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
292 nframe, realname ? realname : name, (std::uint64_t) rip, (std::uint64_t) rsp);
294 fprintf(file, " %i: %s\n", nframe, realname ? realname : name);
299 } while(unw_step(&cursor));
305 static void MC_dump_stacks(FILE* file)
308 for (auto const& stack : mc_model_checker->process().stack_areas()) {
309 fprintf(file, "Stack %i:\n", nstack++);
311 simgrid::mc::UnwindContext context;
312 unw_context_t raw_context =
313 mc_model_checker->process().read<unw_context_t>(
314 simgrid::mc::remote((unw_context_t *)stack.context));
315 context.initialize(&mc_model_checker->process(), &raw_context);
317 unw_cursor_t cursor = context.cursor();
318 simgrid::mc::dumpStack(file, cursor);
323 double MC_process_clock_get(smx_process_t process)
325 if (simgrid::mc::processes_time.empty())
327 if (process != nullptr)
328 return simgrid::mc::processes_time[process->pid];
332 void MC_process_clock_add(smx_process_t process, double amount)
334 simgrid::mc::processes_time[process->pid] += amount;
338 void MC_report_assertion_error(void)
340 XBT_INFO("**************************");
341 XBT_INFO("*** PROPERTY NOT VALID ***");
342 XBT_INFO("**************************");
343 XBT_INFO("Counter-example execution trace:");
344 simgrid::mc::dumpRecordPath();
345 for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
346 XBT_INFO("%s", s.c_str());
347 MC_print_statistics(mc_stats);
350 void MC_report_crash(int status)
352 XBT_INFO("**************************");
353 XBT_INFO("** CRASH IN THE PROGRAM **");
354 XBT_INFO("**************************");
355 if (WIFSIGNALED(status))
356 XBT_INFO("From signal: %s", strsignal(WTERMSIG(status)));
357 else if (WIFEXITED(status))
358 XBT_INFO("From exit: %i", WEXITSTATUS(status));
359 if (WCOREDUMP(status))
360 XBT_INFO("A core dump was generated by the system.");
362 XBT_INFO("No core dump was generated by the system.");
363 XBT_INFO("Counter-example execution trace:");
364 simgrid::mc::dumpRecordPath();
365 for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
366 XBT_INFO("%s", s.c_str());
367 MC_print_statistics(mc_stats);
368 XBT_INFO("Stack trace:");
369 mc_model_checker->process().dumpStack();