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 <vector>
  13
  14 #include "mc_base.h"
  15
  16 #include "mc/mc.h"
  17
  18 #ifndef _WIN32
  19 #include <unistd.h>
  20 #include <sys/wait.h>
  21 #include <sys/time.h>
  22 #endif
  23
  24 #include "src/simix/smx_process_private.h"
  25
  26 #if HAVE_MC
  27 #include <libunwind.h>
  28 #include "src/mc/mc_comm_pattern.h"
  29 #include "src/mc/mc_request.h"
  30 #include "src/mc/mc_safety.h"
  31 #include "src/mc/mc_snapshot.h"
  32 #include "src/mc/mc_liveness.h"
  33 #include "src/mc/mc_private.h"
  34 #include "src/mc/mc_unw.h"
  35 #include "src/mc/mc_smx.h"
  36 #endif
  37
  38 #include "src/mc/mc_record.h"
  39 #include "src/mc/mc_protocol.h"
  40 #include "src/mc/Client.hpp"
  41
  42 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc, "Logging specific to MC (global)");
  43
  44 e_mc_mode_t mc_mode;
  45
  46 namespace simgrid {
  47 namespace mc {
  48
  49 std::vector<double> processes_time;
  50
  51 }
  52 }
  53
  54 #if HAVE_MC
  55 int user_max_depth_reached = 0;
  56
  57 /* MC global data structures */
  58 mc_state_t mc_current_state = nullptr;
  59 char mc_replay_mode = false;
  60
  61 mc_stats_t mc_stats = nullptr;
  62 mc_global_t initial_global_state = nullptr;
  63 xbt_fifo_t mc_stack = nullptr;
  64
  65 /* Liveness */
  66
  67 namespace simgrid {
  68 namespace mc {
  69
  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 /**
 112  * \brief Re-executes from the state at position start all the transitions indicated by
 113  *        a given model-checker stack.
 114  * \param stack The stack with the transitions to execute.
 115  * \param start Start index to begin the re-execution.
 116  */
 117 void MC_replay(xbt_fifo_t stack)
 118 {
 119   int value, count = 1;
 120   char *req_str;
 121   smx_simcall_t req = nullptr, saved_req = NULL;
 122   xbt_fifo_item_t item, start_item;
 123   mc_state_t state;
 124
 125   XBT_DEBUG("**** Begin Replay ****");
 126
 127   /* Intermediate backtracking */
 128   if(_sg_mc_checkpoint > 0 || _sg_mc_termination || _sg_mc_visited > 0) {
 129     start_item = xbt_fifo_get_first_item(stack);
 130     state = (mc_state_t)xbt_fifo_get_item_content(start_item);
 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(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   start_item = xbt_fifo_get_last_item(stack);
 146
 147   if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
 148     // int n = xbt_dynar_length(incomplete_communications_pattern);
 149     unsigned n = MC_smx_get_maxpid();
 150     assert(n == xbt_dynar_length(incomplete_communications_pattern));
 151     assert(n == xbt_dynar_length(initial_communications_pattern));
 152     for (unsigned j=0; j < n ; j++) {
 153       xbt_dynar_reset((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, j, xbt_dynar_t));
 154       xbt_dynar_get_as(initial_communications_pattern, j, mc_list_comm_pattern_t)->index_comm = 0;
 155     }
 156   }
 157
 158   /* Traverse the stack from the state at position start and re-execute the transitions */
 159   for (item = start_item;
 160        item != xbt_fifo_get_first_item(stack);
 161        item = xbt_fifo_get_prev_item(item)) {
 162
 163     state = (mc_state_t) xbt_fifo_get_item_content(item);
 164     saved_req = MC_state_get_executed_request(state, &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       req = &issuer->simcall;
 172
 173       /* Debug information */
 174       if (XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)) {
 175         req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
 176         XBT_DEBUG("Replay: %s (%p)", req_str, state);
 177         xbt_free(req_str);
 178       }
 179
 180       /* TODO : handle test and testany simcalls */
 181       e_mc_call_type_t call = MC_CALL_TYPE_NONE;
 182       if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
 183         call = MC_get_call_type(req);
 184
 185       simgrid::mc::handle_simcall(req, value);
 186
 187       if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
 188         MC_handle_comm_pattern(call, req, value, nullptr, 1);
 189
 190       mc_model_checker->wait_for_requests();
 191
 192       count++;
 193     }
 194
 195     /* Update statistics */
 196     mc_stats->visited_states++;
 197     mc_stats->executed_transitions++;
 198
 199   }
 200
 201   XBT_DEBUG("**** End Replay ****");
 202 }
 203
 204 /**
 205  * \brief Dumps the contents of a model-checker's stack and shows the actual
 206  *        execution trace
 207  * \param stack The stack to dump
 208  */
 209 void MC_dump_stack_safety(xbt_fifo_t stack)
 210 {
 211   MC_show_stack_safety(stack);
 212
 213   mc_state_t state;
 214
 215   while ((state = (mc_state_t) xbt_fifo_pop(stack)) != nullptr)
 216     MC_state_delete(state, !state->in_visited_states ? 1 : 0);
 217 }
 218
 219
 220 void MC_show_stack_safety(xbt_fifo_t stack)
 221 {
 222   int value;
 223   mc_state_t state;
 224   xbt_fifo_item_t item;
 225   smx_simcall_t req;
 226   char *req_str = nullptr;
 227
 228   for (item = xbt_fifo_get_last_item(stack);
 229        item; item = xbt_fifo_get_prev_item(item)) {
 230     state = (mc_state_t)xbt_fifo_get_item_content(item);
 231     req = MC_state_get_executed_request(state, &value);
 232     if (req) {
 233       req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
 234       XBT_INFO("%s", req_str);
 235       xbt_free(req_str);
 236     }
 237   }
 238 }
 239
 240 void MC_show_deadlock(void)
 241 {
 242   XBT_INFO("**************************");
 243   XBT_INFO("*** DEAD-LOCK DETECTED ***");
 244   XBT_INFO("**************************");
 245   XBT_INFO("Counter-example execution trace:");
 246   MC_dump_stack_safety(mc_stack);
 247   MC_print_statistics(mc_stats);
 248 }
 249
 250 void MC_show_non_termination(void){
 251   XBT_INFO("******************************************");
 252   XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
 253   XBT_INFO("******************************************");
 254   XBT_INFO("Counter-example execution trace:");
 255   MC_dump_stack_safety(mc_stack);
 256   MC_print_statistics(mc_stats);
 257 }
 258
 259 void MC_print_statistics(mc_stats_t stats)
 260 {
 261   if(_sg_mc_comms_determinism) {
 262     if (!initial_global_state->recv_deterministic && initial_global_state->send_deterministic){
 263       XBT_INFO("******************************************************");
 264       XBT_INFO("**** Only-send-deterministic communication pattern ****");
 265       XBT_INFO("******************************************************");
 266       XBT_INFO("%s", initial_global_state->recv_diff);
 267     }else if(!initial_global_state->send_deterministic && initial_global_state->recv_deterministic) {
 268       XBT_INFO("******************************************************");
 269       XBT_INFO("**** Only-recv-deterministic communication pattern ****");
 270       XBT_INFO("******************************************************");
 271       XBT_INFO("%s", initial_global_state->send_diff);
 272     }
 273   }
 274
 275   if (stats->expanded_pairs == 0) {
 276     XBT_INFO("Expanded states = %lu", stats->expanded_states);
 277     XBT_INFO("Visited states = %lu", stats->visited_states);
 278   } else {
 279     XBT_INFO("Expanded pairs = %lu", stats->expanded_pairs);
 280     XBT_INFO("Visited pairs = %lu", stats->visited_pairs);
 281   }
 282   XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
 283   if ((_sg_mc_dot_output_file != nullptr) && (_sg_mc_dot_output_file[0] != '\0')) {
 284     fprintf(dot_output, "}\n");
 285     fclose(dot_output);
 286   }
 287   if (initial_global_state != nullptr && (_sg_mc_comms_determinism || _sg_mc_send_determinism)) {
 288     XBT_INFO("Send-deterministic : %s", !initial_global_state->send_deterministic ? "No" : "Yes");
 289     if (_sg_mc_comms_determinism)
 290       XBT_INFO("Recv-deterministic : %s", !initial_global_state->recv_deterministic ? "No" : "Yes");
 291   }
 292   if (getenv("SIMGRID_MC_SYSTEM_STATISTICS")){
 293     int ret=system("free");
 294     if(ret!=0)XBT_WARN("system call did not return 0, but %d",ret);
 295   }
 296 }
 297
 298 void MC_automaton_load(const char *file)
 299 {
 300   if (simgrid::mc::property_automaton == nullptr)
 301     simgrid::mc::property_automaton = xbt_automaton_new();
 302
 303   xbt_automaton_load(simgrid::mc::property_automaton, file);
 304 }
 305
 306 static void MC_dump_stacks(FILE* file)
 307 {
 308   int nstack = 0;
 309   for (auto const& stack : mc_model_checker->process().stack_areas()) {
 310
 311     fprintf(file, "Stack %i:\n", nstack);
 312
 313     int nframe = 0;
 314     char buffer[100];
 315
 316     simgrid::mc::UnwindContext context;
 317     unw_context_t raw_context =
 318       mc_model_checker->process().read<unw_context_t>(
 319         simgrid::mc::remote((unw_context_t *)stack.context));
 320     context.initialize(&mc_model_checker->process(), &raw_context);
 321
 322     unw_cursor_t cursor = context.cursor();
 323
 324     unw_word_t off;
 325     do {
 326       const char * name = !unw_get_proc_name(&cursor, buffer, 100, &off) ? buffer : "?";
 327 #if defined(__x86_64__)
 328       unw_word_t rip = 0;
 329       unw_word_t rsp = 0;
 330       unw_get_reg(&cursor, UNW_X86_64_RIP, &rip);
 331       unw_get_reg(&cursor, UNW_X86_64_RSP, &rsp);
 332       fprintf(file, "  %i: %s (RIP=0x%" PRIx64 " RSP=0x%" PRIx64 ")\n",
 333         nframe, name, (std::uint64_t) rip, (std::uint64_t) rsp);
 334 #else
 335       fprintf(file, "  %i: %s\n", nframe, name);
 336 #endif
 337       ++nframe;
 338     } while(unw_step(&cursor));
 339
 340     ++nstack;
 341   }
 342 }
 343 #endif
 344
 345 double MC_process_clock_get(smx_process_t process)
 346 {
 347   if (simgrid::mc::processes_time.empty())
 348     return 0;
 349   if (process != nullptr)
 350     return simgrid::mc::processes_time[process->pid];
 351   return -1;
 352 }
 353
 354 void MC_process_clock_add(smx_process_t process, double amount)
 355 {
 356   simgrid::mc::processes_time[process->pid] += amount;
 357 }
 358
 359 #if HAVE_MC
 360 void MC_report_assertion_error(void)
 361 {
 362   XBT_INFO("**************************");
 363   XBT_INFO("*** PROPERTY NOT VALID ***");
 364   XBT_INFO("**************************");
 365   XBT_INFO("Counter-example execution trace:");
 366   MC_record_dump_path(mc_stack);
 367   MC_dump_stack_safety(mc_stack);
 368   MC_print_statistics(mc_stats);
 369 }
 370
 371 void MC_report_crash(int status)
 372 {
 373   XBT_INFO("**************************");
 374   XBT_INFO("** CRASH IN THE PROGRAM **");
 375   XBT_INFO("**************************");
 376   if (WIFSIGNALED(status))
 377     XBT_INFO("From signal: %s", strsignal(WTERMSIG(status)));
 378   else if (WIFEXITED(status))
 379     XBT_INFO("From exit: %i", WEXITSTATUS(status));
 380   if (WCOREDUMP(status))
 381     XBT_INFO("A core dump was generated by the system.");
 382   else
 383     XBT_INFO("No core dump was generated by the system.");
 384   XBT_INFO("Counter-example execution trace:");
 385   MC_record_dump_path(mc_stack);
 386   MC_dump_stack_safety(mc_stack);
 387   MC_print_statistics(mc_stats);
 388 }
 389
 390 #endif