Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
de449bfe3fd0aa9bff8c5a9dce3d3370e2174e59
[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 "mc_base.h"
17
18 #include "mc/mc.h"
19
20 #ifndef _WIN32
21 #include <unistd.h>
22 #include <sys/wait.h>
23 #include <sys/time.h>
24 #endif
25
26 #include "src/simix/smx_process_private.h"
27
28 #if HAVE_MC
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"
38 #endif
39
40 #include "src/mc/mc_record.h"
41 #include "src/mc/mc_protocol.h"
42 #include "src/mc/Client.hpp"
43
44 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc, "Logging specific to MC (global)");
45
46 e_mc_mode_t mc_mode;
47
48 namespace simgrid {
49 namespace mc {
50
51 std::vector<double> processes_time;
52
53 }
54 }
55
56 #if HAVE_MC
57 int user_max_depth_reached = 0;
58
59 /* MC global data structures */
60 simgrid::mc::State* mc_current_state = nullptr;
61 char mc_replay_mode = false;
62
63 mc_stats_t mc_stats = nullptr;
64
65 /* Liveness */
66
67 namespace simgrid {
68 namespace mc {
69
70 std::unique_ptr<s_mc_global_t> initial_global_state = nullptr;
71 xbt_automaton_t property_automaton = nullptr;
72
73 }
74 }
75
76 /* Dot output */
77 FILE *dot_output = nullptr;
78
79
80 /*******************************  Initialisation of MC *******************************/
81 /*********************************************************************************/
82
83 void MC_init_dot_output()
84 {
85   dot_output = fopen(_sg_mc_dot_output_file, "w");
86
87   if (dot_output == nullptr) {
88     perror("Error open dot output file");
89     xbt_abort();
90   }
91
92   fprintf(dot_output,
93           "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");
94
95 }
96
97 /*******************************  Core of MC *******************************/
98 /**************************************************************************/
99
100 void MC_run()
101 {
102   simgrid::mc::processes_time.resize(simix_process_maxpid);
103   MC_ignore_heap(simgrid::mc::processes_time.data(),
104     simgrid::mc::processes_time.size() * sizeof(simgrid::mc::processes_time[0]));
105   smx_process_t process;
106   xbt_swag_foreach(process, simix_global->process_list)
107     MC_ignore_heap(&(process->process_hookup), sizeof(process->process_hookup));
108   simgrid::mc::Client::get()->mainLoop();
109   simgrid::mc::processes_time.clear();
110 }
111
112 /**
113  * \brief Re-executes from the state at position start all the transitions indicated by
114  *        a given model-checker stack.
115  * \param stack The stack with the transitions to execute.
116  * \param start Start index to begin the re-execution.
117  */
118 void MC_replay(xbt_fifo_t stack)
119 {
120   int value, count = 1;
121   char *req_str;
122   smx_simcall_t req = nullptr, saved_req = NULL;
123   xbt_fifo_item_t item, start_item;
124   simgrid::mc::State* state;
125   
126   XBT_DEBUG("**** Begin Replay ****");
127
128   /* Intermediate backtracking */
129   if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
130     start_item = xbt_fifo_get_first_item(stack);
131     state = (simgrid::mc::State*)xbt_fifo_get_item_content(start_item);
132     if(state->system_state){
133       simgrid::mc::restore_snapshot(state->system_state);
134       if(_sg_mc_comms_determinism || _sg_mc_send_determinism) 
135         MC_restore_communications_pattern(state);
136       return;
137     }
138   }
139
140
141   /* Restore the initial state */
142   simgrid::mc::restore_snapshot(simgrid::mc::initial_global_state->snapshot);
143   /* At the moment of taking the snapshot the raw heap was set, so restoring
144    * it will set it back again, we have to unset it to continue  */
145
146   start_item = xbt_fifo_get_last_item(stack);
147
148   if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
149     // int n = xbt_dynar_length(incomplete_communications_pattern);
150     unsigned n = MC_smx_get_maxpid();
151     assert(n == xbt_dynar_length(incomplete_communications_pattern));
152     assert(n == xbt_dynar_length(initial_communications_pattern));
153     for (unsigned j=0; j < n ; j++) {
154       xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
155       xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t)->index_comm = 0;
156     }
157   }
158
159   /* Traverse the stack from the state at position start and re-execute the transitions */
160   for (item = start_item;
161        item != xbt_fifo_get_first_item(stack);
162        item = xbt_fifo_get_prev_item(item)) {
163
164     state = (simgrid::mc::State*) xbt_fifo_get_item_content(item);
165     saved_req = MC_state_get_executed_request(state, &value);
166     
167     if (saved_req) {
168       /* because we got a copy of the executed request, we have to fetch the  
169          real one, pointed by the request field of the issuer process */
170
171       const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
172       req = &issuer->simcall;
173
174       /* Debug information */
175       if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
176         req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
177         XBT_DEBUG("Replay: %s (%p)", req_str, state);
178         xbt_free(req_str);
179       }
180
181       /* TODO : handle test and testany simcalls */
182       e_mc_call_type_t call = MC_CALL_TYPE_NONE;
183       if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
184         call = MC_get_call_type(req);
185
186       simgrid::mc::handle_simcall(req, value);
187
188       if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
189         MC_handle_comm_pattern(call, req, value, nullptr, 1);
190
191       mc_model_checker->wait_for_requests();
192
193       count++;
194     }
195
196     /* Update statistics */
197     mc_stats->visited_states++;
198     mc_stats->executed_transitions++;
199
200   }
201
202   XBT_DEBUG("**** End Replay ****");
203 }
204
205 void MC_show_deadlock(void)
206 {
207   XBT_INFO("**************************");
208   XBT_INFO("*** DEAD-LOCK DETECTED ***");
209   XBT_INFO("**************************");
210   XBT_INFO("Counter-example execution trace:");
211   for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
212     XBT_INFO("%s", s.c_str());
213   MC_print_statistics(mc_stats);
214 }
215
216 void MC_print_statistics(mc_stats_t stats)
217 {
218   if(_sg_mc_comms_determinism) {
219     if (!simgrid::mc::initial_global_state->recv_deterministic &&
220         simgrid::mc::initial_global_state->send_deterministic){
221       XBT_INFO("******************************************************");
222       XBT_INFO("**** Only-send-deterministic communication pattern ****");
223       XBT_INFO("******************************************************");
224       XBT_INFO("%s", simgrid::mc::initial_global_state->recv_diff);
225     }else if(!simgrid::mc::initial_global_state->send_deterministic &&
226         simgrid::mc::initial_global_state->recv_deterministic) {
227       XBT_INFO("******************************************************");
228       XBT_INFO("**** Only-recv-deterministic communication pattern ****");
229       XBT_INFO("******************************************************");
230       XBT_INFO("%s", simgrid::mc::initial_global_state->send_diff);
231     }
232   }
233
234   if (stats->expanded_pairs == 0) {
235     XBT_INFO("Expanded states = %lu", stats->expanded_states);
236     XBT_INFO("Visited states = %lu", stats->visited_states);
237   } else {
238     XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
239     XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
240   }
241   XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
242   if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0')) {
243     fprintf(dot_output, "}\n");
244     fclose(dot_output);
245   }
246   if (simgrid::mc::initial_global_state != nullptr
247       && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
248     XBT_INFO("Send-deterministic : %s",
249       !simgrid::mc::initial_global_state->send_deterministic ? "No" : "Yes");
250     if (_sg_mc_comms_determinism)
251       XBT_INFO("Recv-deterministic : %s",
252         !simgrid::mc::initial_global_state->recv_deterministic ? "No" : "Yes");
253   }
254   if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
255     int ret=system("free");
256     if(ret!=0)XBT_WARN("system call did not return 0, but %d",ret);
257   }
258 }
259
260 void MC_automaton_load(const char *file)
261 {
262   if (simgrid::mc::property_automaton == nullptr)
263     simgrid::mc::property_automaton = xbt_automaton_new();
264
265   xbt_automaton_load(simgrid::mc::property_automaton, file);
266 }
267
268 namespace simgrid {
269 namespace mc {
270
271 void dumpStack(FILE* file, unw_cursor_t cursor)
272 {
273   int nframe = 0;
274   char buffer[100];
275
276   unw_word_t off;
277   do {
278     const char * name = !unw_get_proc_name(&cursor, buffer, 100, &off) ? buffer : "?";
279
280     int status;
281
282     // Demangle C++ names:
283     char* realname = abi::__cxa_demangle(name, 0, 0, &status);
284
285 #if defined(__x86_64__)
286     unw_word_t rip = 0;
287     unw_word_t rsp = 0;
288     unw_get_reg(&cursor, UNW_X86_64_RIP, &rip);
289     unw_get_reg(&cursor, UNW_X86_64_RSP, &rsp);
290     fprintf(file, "  %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
291       nframe, realname ? realname : name, (std::uint64_t) rip, (std::uint64_t) rsp);
292 #else
293     fprintf(file, "  %i: %s\n", nframe, realname ? realname : name);
294 #endif
295
296     free(realname);
297     ++nframe;
298   } while(unw_step(&cursor));
299 }
300
301 }
302 }
303
304 static void MC_dump_stacks(FILE* file)
305 {
306   int nstack = 0;
307   for (auto const& stack : mc_model_checker->process().stack_areas()) {
308     fprintf(file, "Stack %i:\n", nstack++);
309
310     simgrid::mc::UnwindContext context;
311     unw_context_t raw_context =
312       mc_model_checker->process().read<unw_context_t>(
313         simgrid::mc::remote((unw_context_t *)stack.context));
314     context.initialize(&mc_model_checker->process(), &raw_context);
315
316     unw_cursor_t cursor = context.cursor();
317     simgrid::mc::dumpStack(file, cursor);
318   }
319 }
320 #endif
321
322 double MC_process_clock_get(smx_process_t process)
323 {
324   if (simgrid::mc::processes_time.empty())
325     return 0;
326   if (process != nullptr)
327     return simgrid::mc::processes_time[process->pid];
328   return -1;
329 }
330
331 void MC_process_clock_add(smx_process_t process, double amount)
332 {
333   simgrid::mc::processes_time[process->pid] += amount;
334 }
335
336 #if HAVE_MC
337 void MC_report_assertion_error(void)
338 {
339   XBT_INFO("**************************");
340   XBT_INFO("*** PROPERTY NOT VALID ***");
341   XBT_INFO("**************************");
342   XBT_INFO("Counter-example execution trace:");
343   simgrid::mc::dumpRecordPath();
344   for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
345     XBT_INFO("%s", s.c_str());
346   MC_print_statistics(mc_stats);
347 }
348
349 void MC_report_crash(int status)
350 {
351   XBT_INFO("**************************");
352   XBT_INFO("** CRASH IN THE PROGRAM **");
353   XBT_INFO("**************************");
354   if (WIFSIGNALED(status))
355     XBT_INFO("From signal: %s", strsignal(WTERMSIG(status)));
356   else if (WIFEXITED(status))
357     XBT_INFO("From exit: %i", WEXITSTATUS(status));
358   if (WCOREDUMP(status))
359     XBT_INFO("A core dump was generated by the system.");
360   else
361     XBT_INFO("No core dump was generated by the system.");
362   XBT_INFO("Counter-example execution trace:");
363   simgrid::mc::dumpRecordPath();
364   for (auto& s : mc_model_checker->getChecker()->getTextualTrace())
365     XBT_INFO("%s", s.c_str());
366   MC_print_statistics(mc_stats);
367   XBT_INFO("Stack trace:");
368   mc_model_checker->process().dumpStack();
369 }
370
371 #endif