src/mc/mc_global.c

   1 #include <unistd.h>
   2 #include <sys/types.h>
   3 #include <sys/wait.h>
   4
   5 #include "../surf/surf_private.h"
   6 #include "../simix/private.h"
   7 #include "xbt/fifo.h"
   8 #include "private.h"
   9
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_global, mc,
  12                                 "Logging specific to MC (global)");
  13
  14 /* MC global data structures */
  15 mc_snapshot_t initial_snapshot = NULL;
  16 xbt_fifo_t mc_stack = NULL;
  17 mc_stats_t mc_stats = NULL;
  18 mc_state_t mc_current_state = NULL;
  19 char mc_replay_mode = FALSE;
  20 double *mc_time = NULL;
  21 /**
  22  *  \brief Initialize the model-checker data structures
  23  */
  24 void MC_init(void)
  25 {
  26   /* Check if MC is already initialized */
  27   if (initial_snapshot)
  28     return;
  29
  30   mc_time = xbt_new0(double, simix_process_maxpid);
  31
  32   /* Initialize the data structures that must be persistent across every
  33      iteration of the model-checker (in RAW memory) */
  34   MC_SET_RAW_MEM;
  35
  36   /* Initialize statistics */
  37   mc_stats = xbt_new0(s_mc_stats_t, 1);
  38   mc_stats->state_size = 1;
  39
  40   /* Create exploration stack */
  41   mc_stack = xbt_fifo_new();
  42
  43   MC_UNSET_RAW_MEM;
  44
  45   MC_dpor_init();
  46
  47   MC_SET_RAW_MEM;
  48   /* Save the initial state */
  49   initial_snapshot = xbt_new0(s_mc_snapshot_t, 1);
  50   MC_take_snapshot(initial_snapshot);
  51   MC_UNSET_RAW_MEM;
  52 }
  53
  54 void MC_modelcheck(void)
  55 {
  56   MC_init();
  57   MC_dpor();
  58   MC_exit();
  59 }
  60
  61 void MC_exit(void)
  62 {
  63   xbt_free(mc_time);
  64   MC_memory_exit();
  65 }
  66
  67 int MC_random(int min, int max)
  68 {
  69   /*FIXME: return mc_current_state->executed_transition->random.value;*/
  70   return 0;
  71 }
  72
  73 /**
  74  * \brief Schedules all the process that are ready to run
  75  */
  76 void MC_wait_for_requests(void)
  77 {
  78   char *req_str = NULL;
  79   smx_req_t req = NULL;
  80
  81   do {
  82     SIMIX_context_runall(simix_global->process_to_run);
  83     while((req = SIMIX_request_pop())){
  84       if(!MC_request_is_visible(req))
  85         SIMIX_request_pre(req, 0);
  86       else if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
  87         req_str = MC_request_to_string(req);
  88         DEBUG1("Got: %s", req_str);
  89         xbt_free(req_str);
  90       }
  91     }
  92   } while (xbt_dynar_length(simix_global->process_to_run));
  93 }
  94
  95 int MC_deadlock_check()
  96 {
  97   int deadlock = FALSE;
  98   smx_process_t process;
  99   if(xbt_swag_size(simix_global->process_list)){
 100     deadlock = TRUE;
 101     xbt_swag_foreach(process, simix_global->process_list){
 102       if(process->request.call != REQ_NO_REQ
 103          && MC_request_is_enabled(&process->request)){
 104         deadlock = FALSE;
 105         break;
 106       }
 107     }
 108   }
 109   return deadlock;
 110 }
 111
 112 /**
 113  * \brief Re-executes from the initial state all the transitions indicated by
 114  *        a given model-checker stack.
 115  * \param stack The stack with the transitions to execute.
 116 */
 117 void MC_replay(xbt_fifo_t stack)
 118 {
 119   int value;
 120   char *req_str;
 121   smx_req_t req = NULL, saved_req = NULL;
 122   xbt_fifo_item_t item;
 123   mc_state_t state;
 124
 125   DEBUG0("**** Begin Replay ****");
 126
 127   /* Restore the initial state */
 128   MC_restore_snapshot(initial_snapshot);
 129   /* At the moment of taking the snapshot the raw heap was set, so restoring
 130    * it will set it back again, we have to unset it to continue  */
 131   MC_UNSET_RAW_MEM;
 132
 133   /* Traverse the stack from the initial state and re-execute the transitions */
 134   for (item = xbt_fifo_get_last_item(stack);
 135        item != xbt_fifo_get_first_item(stack);
 136        item = xbt_fifo_get_prev_item(item)) {
 137
 138     state = (mc_state_t) xbt_fifo_get_item_content(item);
 139     saved_req = MC_state_get_executed_request(state, &value);
 140
 141     if(saved_req){
 142       /* because we got a copy of the executed request, we have to fetch the
 143          real one, pointed by the request field of the issuer process */
 144       req = &saved_req->issuer->request;
 145
 146       /* Debug information */
 147       if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
 148         req_str = MC_request_to_string(req);
 149         DEBUG2("Replay: %s (%p)", req_str, state);
 150         xbt_free(req_str);
 151       }
 152     }
 153
 154     SIMIX_request_pre(req, value);
 155     MC_wait_for_requests();
 156
 157     /* Update statistics */
 158     mc_stats->visited_states++;
 159     mc_stats->executed_transitions++;
 160   }
 161   DEBUG0("**** End Replay ****");
 162 }
 163
 164 /**
 165  * \brief Dumps the contents of a model-checker's stack and shows the actual
 166  *        execution trace
 167  * \param stack The stack to dump
 168 */
 169 void MC_dump_stack(xbt_fifo_t stack)
 170 {
 171   mc_state_t state;
 172
 173   MC_show_stack(stack);
 174
 175   MC_SET_RAW_MEM;
 176   while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
 177     MC_state_delete(state);
 178   MC_UNSET_RAW_MEM;
 179 }
 180
 181 void MC_show_stack(xbt_fifo_t stack)
 182 {
 183   int value;
 184   mc_state_t state;
 185   xbt_fifo_item_t item;
 186   smx_req_t req;
 187   char *req_str = NULL;
 188
 189   for (item = xbt_fifo_get_last_item(stack);
 190        (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
 191         : (NULL)); item = xbt_fifo_get_prev_item(item)) {
 192     req = MC_state_get_executed_request(state, &value);
 193     if(req){
 194       req_str = MC_request_to_string(req);
 195       INFO1("%s", req_str);
 196       xbt_free(req_str);
 197     }
 198   }
 199 }
 200
 201 void MC_show_deadlock(smx_req_t req)
 202 {
 203   /*char *req_str = NULL;*/
 204   INFO0("**************************");
 205   INFO0("*** DEAD-LOCK DETECTED ***");
 206   INFO0("**************************");
 207   INFO0("Locked request:");
 208   /*req_str = MC_request_to_string(req);
 209   INFO1("%s", req_str);
 210   xbt_free(req_str);*/
 211   INFO0("Counter-example execution trace:");
 212   MC_dump_stack(mc_stack);
 213 }
 214
 215 void MC_print_statistics(mc_stats_t stats)
 216 {
 217   INFO1("State space size ~= %lu", stats->state_size);
 218   INFO1("Expanded states = %lu", stats->expanded_states);
 219   INFO1("Visited states = %lu", stats->visited_states);
 220   INFO1("Executed transitions = %lu", stats->executed_transitions);
 221   INFO1("Expanded / Visited = %lf",
 222         (double) stats->visited_states / stats->expanded_states);
 223   /*INFO1("Exploration coverage = %lf",
 224      (double)stats->expanded_states / stats->state_size); */
 225 }
 226
 227 void MC_assert(int prop)
 228 {
 229   if (MC_IS_ENABLED && !prop) {
 230     INFO0("**************************");
 231     INFO0("*** PROPERTY NOT VALID ***");
 232     INFO0("**************************");
 233     INFO0("Counter-example execution trace:");
 234     MC_dump_stack(mc_stack);
 235     MC_print_statistics(mc_stats);
 236     xbt_abort();
 237   }
 238 }
 239
 240 void MC_process_clock_add(smx_process_t process, double amount)
 241 {
 242   mc_time[process->pid] += amount;
 243 }
 244
 245 double MC_process_clock_get(smx_process_t process)
 246 {
 247   if(mc_time)
 248     return mc_time[process->pid];
 249   else
 250     return 0;
 251 }