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