Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Fix #includes
[simgrid.git] / src / mc / mc_global.cpp
1 /* Copyright (c) 2008-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include <cinttypes>
8 #include <cassert>
9 #include <cstddef>
10 #include <cstdint>
11
12 #include <cxxabi.h>
13
14 #include <vector>
15
16 #include <xbt/dynar.h>
17 #include <xbt/automaton.h>
18 #include <xbt/swag.h>
19
20 #include "mc_base.h"
21
22 #include "mc/mc.h"
23
24 #ifndef _WIN32
25 #include <unistd.h>
26 #include <sys/wait.h>
27 #include <sys/time.h>
28 #endif
29
30 #include "src/simix/smx_process_private.h"
31
32 #if HAVE_MC
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"
42 #endif
43
44 #include "src/mc/mc_record.h"
45 #include "src/mc/mc_protocol.h"
46 #include "src/mc/Client.hpp"
47
48 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc, "Logging specific to MC (global)");
49
50 e_mc_mode_t mc_mode;
51
52 namespace simgrid {
53 namespace mc {
54
55 std::vector<double> processes_time;
56
57 }
58 }
59
60 #if HAVE_MC
61
62 /* MC global data structures */
63 simgrid::mc::State* mc_current_state = nullptr;
64 char mc_replay_mode = false;
65
66 mc_stats_t mc_stats = nullptr;
67
68 /* Liveness */
69
70 namespace simgrid {
71 namespace mc {
72
73 std::unique_ptr<s_mc_global_t> initial_global_state = nullptr;
74 xbt_automaton_t property_automaton = nullptr;
75
76 }
77 }
78
79 /* Dot output */
80 FILE *dot_output = nullptr;
81
82
83 /*******************************  Initialisation of MC *******************************/
84 /*********************************************************************************/
85
86 void MC_init_dot_output()
87 {
88   dot_output = fopen(_sg_mc_dot_output_file, "w");
89
90   if (dot_output == nullptr) {
91     perror("Error open dot output file");
92     xbt_abort();
93   }
94
95   fprintf(dot_output,
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");
97
98 }
99
100 /*******************************  Core of MC *******************************/
101 /**************************************************************************/
102
103 void MC_run()
104 {
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();
113 }
114
115 namespace simgrid {
116 namespace mc {
117
118 /**
119  * \brief Re-executes from the state at position start all the transitions indicated by
120  *        a given model-checker stack.
121  * \param stack The stack with the transitions to execute.
122  * \param start Start index to begin the re-execution.
123  */
124 void replay(std::list<std::unique_ptr<simgrid::mc::State>> const& stack)
125 {
126   XBT_DEBUG("**** Begin Replay ****");
127
128   /* Intermediate backtracking */
129   if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
130     simgrid::mc::State* state = stack.back().get();
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);
135       return;
136     }
137   }
138
139
140   /* Restore the initial state */
141   simgrid::mc::restore_snapshot(simgrid::mc::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  */
144
145   if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
146     // int n = xbt_dynar_length(incomplete_communications_pattern);
147     unsigned n = MC_smx_get_maxpid();
148     assert(n == xbt_dynar_length(incomplete_communications_pattern));
149     assert(n == xbt_dynar_length(initial_communications_pattern));
150     for (unsigned j=0; j < n ; j++) {
151       xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
152       xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t)->index_comm = 0;
153     }
154   }
155
156   int count = 1;
157
158   /* Traverse the stack from the state at position start and re-execute the transitions */
159   for (std::unique_ptr<simgrid::mc::State> const& state : stack) {
160     if (state == stack.back())
161       break;
162
163     int value;
164     smx_simcall_t saved_req = MC_state_get_executed_request(state.get(), &value);
165     
166     if (saved_req) {
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 */
169
170       const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
171       smx_simcall_t req = &issuer->simcall;
172
173       /* Debug information */
174       XBT_DEBUG("Replay: %s (%p)",
175         simgrid::mc::request_to_string(
176           req, value, simgrid::mc::RequestType::simix).c_str(),
177         state.get());
178
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);
183
184       simgrid::mc::handle_simcall(req, value);
185
186       if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
187         MC_handle_comm_pattern(call, req, value, nullptr, 1);
188
189       mc_model_checker->wait_for_requests();
190
191       count++;
192     }
193
194     /* Update statistics */
195     mc_stats->visited_states++;
196     mc_stats->executed_transitions++;
197
198   }
199
200   XBT_DEBUG("**** End Replay ****");
201 }
202
203 }
204 }
205
206 void MC_show_deadlock(void)
207 {
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);
215 }
216
217 void MC_print_statistics(mc_stats_t stats)
218 {
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);
232     }
233   }
234
235   if (stats->expanded_pairs == 0) {
236     XBT_INFO("Expanded states = %lu", stats->expanded_states);
237     XBT_INFO("Visited states = %lu", stats->visited_states);
238   } else {
239     XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
240     XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
241   }
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");
245     fclose(dot_output);
246   }
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");
254   }
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);
258   }
259 }
260
261 void MC_automaton_load(const char *file)
262 {
263   if (simgrid::mc::property_automaton == nullptr)
264     simgrid::mc::property_automaton = xbt_automaton_new();
265
266   xbt_automaton_load(simgrid::mc::property_automaton, file);
267 }
268
269 namespace simgrid {
270 namespace mc {
271
272 void dumpStack(FILE* file, unw_cursor_t cursor)
273 {
274   int nframe = 0;
275   char buffer[100];
276
277   unw_word_t off;
278   do {
279     const char * name = !unw_get_proc_name(&cursor, buffer, 100, &off) ? buffer : "?";
280
281     int status;
282
283     // Demangle C++ names:
284     char* realname = abi::__cxa_demangle(name, 0, 0, &status);
285
286 #if defined(__x86_64__)
287     unw_word_t rip = 0;
288     unw_word_t rsp = 0;
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);
293 #else
294     fprintf(file, "  %i: %s\n", nframe, realname ? realname : name);
295 #endif
296
297     free(realname);
298     ++nframe;
299   } while(unw_step(&cursor));
300 }
301
302 }
303 }
304
305 static void MC_dump_stacks(FILE* file)
306 {
307   int nstack = 0;
308   for (auto const& stack : mc_model_checker->process().stack_areas()) {
309     fprintf(file, "Stack %i:\n", nstack++);
310
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);
316
317     unw_cursor_t cursor = context.cursor();
318     simgrid::mc::dumpStack(file, cursor);
319   }
320 }
321 #endif
322
323 double MC_process_clock_get(smx_process_t process)
324 {
325   if (simgrid::mc::processes_time.empty())
326     return 0;
327   if (process != nullptr)
328     return simgrid::mc::processes_time[process->pid];
329   return -1;
330 }
331
332 void MC_process_clock_add(smx_process_t process, double amount)
333 {
334   simgrid::mc::processes_time[process->pid] += amount;
335 }
336
337 #if HAVE_MC
338 void MC_report_assertion_error(void)
339 {
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);
348 }
349
350 void MC_report_crash(int status)
351 {
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.");
361   else
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();
370 }
371
372 #endif