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   MC_print_statistics(mc_stats);
  64   xbt_free(mc_time);
  65   MC_memory_exit();
  66 }
  67
  68 int MC_random(int min, int max)
  69 {
  70   /*FIXME: return mc_current_state->executed_transition->random.value;*/
  71   return 0;
  72 }
  73
  74 /**
  75  * \brief Schedules all the process that are ready to run
  76  */
  77 void MC_wait_for_requests(void)
  78 {
  79   smx_process_t process;
  80   smx_req_t req;
  81   unsigned int iter;
  82
  83   while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
  84     SIMIX_process_runall();
  85     xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
  86       req = &process->request;
  87       if (req->call != REQ_NO_REQ && !MC_request_is_visible(req))
  88           SIMIX_request_pre(req, 0);
  89     }
  90   }
  91 }
  92
  93 int MC_deadlock_check()
  94 {
  95   int deadlock = FALSE;
  96   smx_process_t process;
  97   if(xbt_swag_size(simix_global->process_list)){
  98     deadlock = TRUE;
  99     xbt_swag_foreach(process, simix_global->process_list){
 100       if(process->request.call != REQ_NO_REQ
 101          && MC_request_is_enabled(&process->request)){
 102         deadlock = FALSE;
 103         break;
 104       }
 105     }
 106   }
 107   return deadlock;
 108 }
 109
 110 /**
 111  * \brief Re-executes from the initial state all the transitions indicated by
 112  *        a given model-checker stack.
 113  * \param stack The stack with the transitions to execute.
 114 */
 115 void MC_replay(xbt_fifo_t stack)
 116 {
 117   int value;
 118   char *req_str;
 119   smx_req_t req = NULL, saved_req = NULL;
 120   xbt_fifo_item_t item;
 121   mc_state_t state;
 122
 123   XBT_DEBUG("**** Begin Replay ****");
 124
 125   /* Restore the initial state */
 126   MC_restore_snapshot(initial_snapshot);
 127   /* At the moment of taking the snapshot the raw heap was set, so restoring
 128    * it will set it back again, we have to unset it to continue  */
 129   MC_UNSET_RAW_MEM;
 130
 131   /* Traverse the stack from the initial state and re-execute the transitions */
 132   for (item = xbt_fifo_get_last_item(stack);
 133        item != xbt_fifo_get_first_item(stack);
 134        item = xbt_fifo_get_prev_item(item)) {
 135
 136     state = (mc_state_t) xbt_fifo_get_item_content(item);
 137     saved_req = MC_state_get_executed_request(state, &value);
 138
 139     if(saved_req){
 140       /* because we got a copy of the executed request, we have to fetch the
 141          real one, pointed by the request field of the issuer process */
 142       req = &saved_req->issuer->request;
 143
 144       /* Debug information */
 145       if(XBT_LOG_ISENABLED(mc_global, xbt_log_priority_debug)){
 146         req_str = MC_request_to_string(req, value);
 147         XBT_DEBUG("Replay: %s (%p)", req_str, state);
 148         xbt_free(req_str);
 149       }
 150     }
 151
 152     SIMIX_request_pre(req, value);
 153     MC_wait_for_requests();
 154
 155     /* Update statistics */
 156     mc_stats->visited_states++;
 157     mc_stats->executed_transitions++;
 158   }
 159   XBT_DEBUG("**** End Replay ****");
 160 }
 161
 162 /**
 163  * \brief Dumps the contents of a model-checker's stack and shows the actual
 164  *        execution trace
 165  * \param stack The stack to dump
 166 */
 167 void MC_dump_stack(xbt_fifo_t stack)
 168 {
 169   mc_state_t state;
 170
 171   MC_show_stack(stack);
 172
 173   MC_SET_RAW_MEM;
 174   while ((state = (mc_state_t) xbt_fifo_pop(stack)) != NULL)
 175     MC_state_delete(state);
 176   MC_UNSET_RAW_MEM;
 177 }
 178
 179 void MC_show_stack(xbt_fifo_t stack)
 180 {
 181   int value;
 182   mc_state_t state;
 183   xbt_fifo_item_t item;
 184   smx_req_t req;
 185   char *req_str = NULL;
 186
 187   for (item = xbt_fifo_get_last_item(stack);
 188        (item ? (state = (mc_state_t) (xbt_fifo_get_item_content(item)))
 189         : (NULL)); item = xbt_fifo_get_prev_item(item)) {
 190     req = MC_state_get_executed_request(state, &value);
 191     if(req){
 192       req_str = MC_request_to_string(req, value);
 193       XBT_INFO("%s", req_str);
 194       xbt_free(req_str);
 195     }
 196   }
 197 }
 198
 199 void MC_show_deadlock(smx_req_t req)
 200 {
 201   /*char *req_str = NULL;*/
 202   XBT_INFO("**************************");
 203   XBT_INFO("*** DEAD-LOCK DETECTED ***");
 204   XBT_INFO("**************************");
 205   XBT_INFO("Locked request:");
 206   /*req_str = MC_request_to_string(req);
 207   XBT_INFO("%s", req_str);
 208   xbt_free(req_str);*/
 209   XBT_INFO("Counter-example execution trace:");
 210   MC_dump_stack(mc_stack);
 211 }
 212
 213 void MC_print_statistics(mc_stats_t stats)
 214 {
 215   XBT_INFO("State space size ~= %lu", stats->state_size);
 216   XBT_INFO("Expanded states = %lu", stats->expanded_states);
 217   XBT_INFO("Visited states = %lu", stats->visited_states);
 218   XBT_INFO("Executed transitions = %lu", stats->executed_transitions);
 219   XBT_INFO("Expanded / Visited = %lf",
 220         (double) stats->visited_states / stats->expanded_states);
 221   /*XBT_INFO("Exploration coverage = %lf",
 222      (double)stats->expanded_states / stats->state_size); */
 223 }
 224
 225 void MC_assert(int prop)
 226 {
 227   if (MC_IS_ENABLED && !prop) {
 228     XBT_INFO("**************************");
 229     XBT_INFO("*** PROPERTY NOT VALID ***");
 230     XBT_INFO("**************************");
 231     XBT_INFO("Counter-example execution trace:");
 232     MC_dump_stack(mc_stack);
 233     MC_print_statistics(mc_stats);
 234     xbt_abort();
 235   }
 236 }
 237
 238 void MC_process_clock_add(smx_process_t process, double amount)
 239 {
 240   mc_time[process->pid] += amount;
 241 }
 242
 243 double MC_process_clock_get(smx_process_t process)
 244 {
 245   if(mc_time)
 246     return mc_time[process->pid];
 247   else
 248     return 0;
 249 }