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. */
16 #include <xbt/dynar.h>
17 #include <xbt/automaton.h>
30 #include "src/simix/smx_process_private.h"
33 #include <libunwind.h>
34 #include "src/mc/mc_comm_pattern.h"
35 #include "src/mc/mc_request.h"
36 #include "src/mc/mc_safety.h"
37 #include "src/mc/mc_snapshot.h"
38 #include "src/mc/mc_private.h"
39 #include "src/mc/mc_unw.h"
40 #include "src/mc/mc_smx.h"
41 #include "src/mc/Checker.hpp"
44 #include "src/mc/mc_record.h"
45 #include "src/mc/mc_protocol.h"
46 #include "src/mc/Client.hpp"
48 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc, "Logging specific to MC (global)");
55 std::vector<double> processes_time;
62 /* MC global data structures */
63 simgrid::mc::State* mc_current_state = nullptr;
64 char mc_replay_mode = false;
66 mc_stats_t mc_stats = nullptr;
73 std::unique_ptr<s_mc_global_t> initial_global_state = nullptr;
74 xbt_automaton_t property_automaton = nullptr;
80 FILE *dot_output = nullptr;
83 /******************************* Initialisation of MC *******************************/
84 /*********************************************************************************/
86 void MC_init_dot_output()
88 dot_output = fopen(_sg_mc_dot_output_file, "w");
90 if (dot_output == nullptr) {
91 perror("Error open dot output file");
96 "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");
100 /******************************* Core of MC *******************************/
101 /**************************************************************************/
105 simgrid::mc::processes_time.resize(simix_process_maxpid);
106 MC_ignore_heap(simgrid::mc::processes_time.data(),
107 simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0]));
108 smx_process_t process;
109 xbt_swag_foreach(process, simix_global->process_list)
110 MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
111 simgrid::mc::Client::get()->mainLoop();
112 simgrid::mc::processes_time.clear();
118 void handle_simcall(smx_simcall_t req, int value)
120 for (auto& pi : mc_model_checker->process().smx_process_infos)
121 if (req == &pi.copy.simcall) {
122 mc_model_checker->simcall_handle(
123 mc_model_checker->process(), pi.copy.pid, value);
126 xbt_die("Could not find the request");
130 * \brief Re-executes from the state at position start all the transitions indicated by
131 * a given model-checker stack.
132 * \param stack The stack with the transitions to execute.
133 * \param start Start index to begin the re-execution.
135 void replay(std::list<std::unique_ptr<simgrid::mc::State>> const& stack)
137 XBT_DEBUG("**** Begin Replay ****");
139 /* Intermediate backtracking */
140 if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
141 simgrid::mc::State* state = stack.back().get();
142 if (state->system_state) {
143 simgrid::mc::restore_snapshot(state->system_state);
144 if(_sg_mc_comms_determinism || _sg_mc_send_determinism)
145 MC_restore_communications_pattern(state);
151 /* Restore the initial state */
152 simgrid::mc::restore_snapshot(simgrid::mc::initial_global_state->snapshot);
153 /* At the moment of taking the snapshot the raw heap was set, so restoring
154 * it will set it back again, we have to unset it to continue */
156 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
157 // int n = xbt_dynar_length(incomplete_communications_pattern);
158 unsigned n = MC_smx_get_maxpid();
159 assert(n == xbt_dynar_length(incomplete_communications_pattern));
160 assert(n == xbt_dynar_length(initial_communications_pattern));
161 for (unsigned j=0; j < n ; j++) {
162 xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
163 xbt_dynar_get_as(initial_communications_pattern, j, simgrid::mc::PatternCommunicationList*)->index_comm = 0;
169 /* Traverse the stack from the state at position start and re-execute the transitions */
170 for (std::unique_ptr<simgrid::mc::State> const& state : stack) {
171 if (state == stack.back())
174 int value = state->req_num;
175 smx_simcall_t saved_req = &state->executed_req;
178 /* because we got a copy of the executed request, we have to fetch the
179 real one, pointed by the request field of the issuer process */
181 const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
182 smx_simcall_t req = &issuer->simcall;
184 /* Debug information */
185 XBT_DEBUG("Replay: %s (%p)",
186 simgrid::mc::request_to_string(
187 req, value, simgrid::mc::RequestType::simix).c_str(),
190 /* TODO : handle test and testany simcalls */
191 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
192 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
193 call = MC_get_call_type(req);
195 simgrid::mc::handle_simcall(req, value);
196 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
197 MC_handle_comm_pattern(call, req, value, nullptr, 1);
198 mc_model_checker->wait_for_requests();
203 /* Update statistics */
204 mc_stats->visited_states++;
205 mc_stats->executed_transitions++;
209 XBT_DEBUG("**** End Replay ****");
215 void MC_show_deadlock(void)
217 XBT_INFO("**************************");
218 XBT_INFO("*** DEAD-LOCK DETECTED ***");
219 XBT_INFO("**************************");
220 XBT_INFO("Counter-example execution trace:");
221 for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
222 XBT_INFO("%s", s.c_str());
223 MC_print_statistics(mc_stats);
226 void MC_print_statistics(mc_stats_t stats)
228 if(_sg_mc_comms_determinism) {
229 if (!simgrid::mc::initial_global_state->recv_deterministic &&
230 simgrid::mc::initial_global_state->send_deterministic){
231 XBT_INFO("******************************************************");
232 XBT_INFO("**** Only-send-deterministic communication pattern ****");
233 XBT_INFO("******************************************************");
234 XBT_INFO("%s", simgrid::mc::initial_global_state->recv_diff);
235 }else if(!simgrid::mc::initial_global_state->send_deterministic &&
236 simgrid::mc::initial_global_state->recv_deterministic) {
237 XBT_INFO("******************************************************");
238 XBT_INFO("**** Only-recv-deterministic communication pattern ****");
239 XBT_INFO("******************************************************");
240 XBT_INFO("%s", simgrid::mc::initial_global_state->send_diff);
244 if (stats->expanded_pairs == 0) {
245 XBT_INFO("Expanded states = %lu", stats->expanded_states);
246 XBT_INFO("Visited states = %lu", stats->visited_states);
248 XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
249 XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
251 XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
252 if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0')) {
253 fprintf(dot_output, "}\n");
256 if (simgrid::mc::initial_global_state != nullptr
257 && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
258 XBT_INFO("Send-deterministic : %s",
259 !simgrid::mc::initial_global_state->send_deterministic ? "No" : "Yes");
260 if (_sg_mc_comms_determinism)
261 XBT_INFO("Recv-deterministic : %s",
262 !simgrid::mc::initial_global_state->recv_deterministic ? "No" : "Yes");
264 if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
265 int ret=system("free");
266 if(ret!=0)XBT_WARN("system call did not return 0, but %d",ret);
270 void MC_automaton_load(const char *file)
272 if (simgrid::mc::property_automaton == nullptr)
273 simgrid::mc::property_automaton = xbt_automaton_new();
275 xbt_automaton_load(simgrid::mc::property_automaton, file);
281 void dumpStack(FILE* file, unw_cursor_t cursor)
288 const char * name = !unw_get_proc_name(&cursor, buffer, 100, &off) ? buffer : "?";
292 // Demangle C++ names:
293 char* realname = abi::__cxa_demangle(name, 0, 0, &status);
295 #if defined(__x86_64__)
298 unw_get_reg(&cursor, UNW_X86_64_RIP, &rip);
299 unw_get_reg(&cursor, UNW_X86_64_RSP, &rsp);
300 fprintf(file, " %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
301 nframe, realname ? realname : name, (std::uint64_t) rip, (std::uint64_t) rsp);
303 fprintf(file, " %i: %s\n", nframe, realname ? realname : name);
308 } while(unw_step(&cursor));
314 static void MC_dump_stacks(FILE* file)
317 for (auto const& stack : mc_model_checker->process().stack_areas()) {
318 fprintf(file, "Stack %i:\n", nstack++);
320 simgrid::mc::UnwindContext context;
321 unw_context_t raw_context =
322 mc_model_checker->process().read<unw_context_t>(
323 simgrid::mc::remote((unw_context_t *)stack.context));
324 context.initialize(&mc_model_checker->process(), &raw_context);
326 unw_cursor_t cursor = context.cursor();
327 simgrid::mc::dumpStack(file, cursor);
332 double MC_process_clock_get(smx_process_t process)
334 if (simgrid::mc::processes_time.empty())
336 if (process != nullptr)
337 return simgrid::mc::processes_time[process->pid];
341 void MC_process_clock_add(smx_process_t process, double amount)
343 simgrid::mc::processes_time[process->pid] += amount;
347 void MC_report_assertion_error(void)
349 XBT_INFO("**************************");
350 XBT_INFO("*** PROPERTY NOT VALID ***");
351 XBT_INFO("**************************");
352 XBT_INFO("Counter-example execution trace:");
353 simgrid::mc::dumpRecordPath();
354 for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
355 XBT_INFO("%s", s.c_str());
356 MC_print_statistics(mc_stats);
359 void MC_report_crash(int status)
361 XBT_INFO("**************************");
362 XBT_INFO("** CRASH IN THE PROGRAM **");
363 XBT_INFO("**************************");
364 if (WIFSIGNALED(status))
365 XBT_INFO("From signal: %s", strsignal(WTERMSIG(status)));
366 else if (WIFEXITED(status))
367 XBT_INFO("From exit: %i", WEXITSTATUS(status));
368 if (WCOREDUMP(status))
369 XBT_INFO("A core dump was generated by the system.");
371 XBT_INFO("No core dump was generated by the system.");
372 XBT_INFO("Counter-example execution trace:");
373 simgrid::mc::dumpRecordPath();
374 for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
375 XBT_INFO("%s", s.c_str());
376 MC_print_statistics(mc_stats);
377 XBT_INFO("Stack trace:");
378 mc_model_checker->process().dumpStack();