src/mc/mc_liveness.cpp

   1 /* Copyright (c) 2011-2014. 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 <unistd.h>
   8 #include <sys/wait.h>
   9
  10 #include <xbt/dynar.h>
  11 #include <xbt/automaton.h>
  12
  13 #include "mc_request.h"
  14 #include "mc_liveness.h"
  15 #include "mc_private.h"
  16 #include "mc_record.h"
  17 #include "mc_smx.h"
  18 #include "mc_client.h"
  19 #include "mc_replay.h"
  20 #include "mc_safety.h"
  21
  22 extern "C" {
  23
  24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_liveness, mc,
  25                                 "Logging specific to algorithms for liveness properties verification");
  26
  27 /********* Global variables *********/
  28
  29 xbt_dynar_t acceptance_pairs;
  30 xbt_parmap_t parmap;
  31
  32 /********* Static functions *********/
  33
  34 static xbt_dynar_t get_atomic_propositions_values()
  35 {
  36   unsigned int cursor = 0;
  37   xbt_automaton_propositional_symbol_t ps = NULL;
  38   xbt_dynar_t values = xbt_dynar_new(sizeof(int), NULL);
  39   xbt_dynar_foreach(_mc_property_automaton->propositional_symbols, cursor, ps) {
  40     int res = xbt_automaton_propositional_symbol_evaluate(ps);
  41     xbt_dynar_push_as(values, int, res);
  42   }
  43
  44   return values;
  45 }
  46
  47 static mc_visited_pair_t is_reached_acceptance_pair(mc_pair_t pair)
  48 {
  49   mc_visited_pair_t new_pair = NULL;
  50   new_pair = MC_visited_pair_new(pair->num, pair->automaton_state, pair->atomic_propositions, pair->graph_state);
  51   new_pair->acceptance_pair = 1;
  52
  53   if (xbt_dynar_is_empty(acceptance_pairs)) {
  54
  55     xbt_dynar_push(acceptance_pairs, &new_pair);
  56
  57   } else {
  58
  59     int min = -1, max = -1, index;
  60     //int res;
  61     mc_visited_pair_t pair_test;
  62     int cursor;
  63
  64     index = get_search_interval(acceptance_pairs, new_pair, &min, &max);
  65
  66     if (min != -1 && max != -1) {       // Acceptance pair with same number of processes and same heap bytes used exists
  67
  68       // Parallell implementation
  69       /*res = xbt_parmap_mc_apply(parmap, snapshot_compare, xbt_dynar_get_ptr(acceptance_pairs, min), (max-min)+1, pair);
  70          if(res != -1){
  71          return ((mc_pair_t)xbt_dynar_get_as(acceptance_pairs, (min+res)-1, mc_pair_t))->num;
  72          } */
  73
  74       cursor = min;
  75       if(pair->search_cycle == 1){
  76         while (cursor <= max) {
  77           pair_test = (mc_visited_pair_t) xbt_dynar_get_as(acceptance_pairs, cursor, mc_visited_pair_t);
  78           if (xbt_automaton_state_compare(pair_test->automaton_state, new_pair->automaton_state) == 0) {
  79             if (xbt_automaton_propositional_symbols_compare_value(pair_test->atomic_propositions, new_pair->atomic_propositions) == 0) {
  80               if (snapshot_compare(pair_test, new_pair) == 0) {
  81                 XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
  82                 xbt_fifo_shift(mc_stack);
  83                 if (dot_output != NULL)
  84                   fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, pair_test->num, initial_global_state->prev_req);
  85                 return NULL;
  86               }
  87             }
  88           }
  89           cursor++;
  90         }
  91       }
  92       xbt_dynar_insert_at(acceptance_pairs, min, &new_pair);
  93     } else {
  94       pair_test = (mc_visited_pair_t) xbt_dynar_get_as(acceptance_pairs, index, mc_visited_pair_t);
  95       if (pair_test->nb_processes < new_pair->nb_processes) {
  96         xbt_dynar_insert_at(acceptance_pairs, index + 1, &new_pair);
  97       } else {
  98         if (pair_test->heap_bytes_used < new_pair->heap_bytes_used)
  99           xbt_dynar_insert_at(acceptance_pairs, index + 1, &new_pair);
 100         else
 101           xbt_dynar_insert_at(acceptance_pairs, index, &new_pair);
 102       }
 103     }
 104   }
 105   return new_pair;
 106 }
 107
 108 static void remove_acceptance_pair(int pair_num)
 109 {
 110   unsigned int cursor = 0;
 111   mc_visited_pair_t pair_test = NULL;
 112   int pair_found = 0;
 113
 114   xbt_dynar_foreach(acceptance_pairs, cursor, pair_test) {
 115     if (pair_test->num == pair_num) {
 116        pair_found = 1;
 117       break;
 118     }
 119   }
 120
 121   if(pair_found == 1) {
 122     xbt_dynar_remove_at(acceptance_pairs, cursor, &pair_test);
 123
 124     pair_test->acceptance_removed = 1;
 125
 126     if (_sg_mc_visited == 0 || pair_test->visited_removed == 1)
 127       MC_visited_pair_delete(pair_test);
 128
 129   }
 130 }
 131
 132
 133 static int MC_automaton_evaluate_label(xbt_automaton_exp_label_t l,
 134                                        xbt_dynar_t atomic_propositions_values)
 135 {
 136
 137   switch (l->type) {
 138   case 0:{
 139       int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
 140       int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
 141       return (left_res || right_res);
 142     }
 143   case 1:{
 144       int left_res = MC_automaton_evaluate_label(l->u.or_and.left_exp, atomic_propositions_values);
 145       int right_res = MC_automaton_evaluate_label(l->u.or_and.right_exp, atomic_propositions_values);
 146       return (left_res && right_res);
 147     }
 148   case 2:{
 149       int res = MC_automaton_evaluate_label(l->u.exp_not, atomic_propositions_values);
 150       return (!res);
 151     }
 152   case 3:{
 153       unsigned int cursor = 0;
 154       xbt_automaton_propositional_symbol_t p = NULL;
 155       xbt_dynar_foreach(_mc_property_automaton->propositional_symbols, cursor, p) {
 156         if (strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
 157           return (int) xbt_dynar_get_as(atomic_propositions_values, cursor, int);
 158       }
 159       return -1;
 160     }
 161   case 4:{
 162       return 2;
 163     }
 164   default:
 165     return -1;
 166   }
 167 }
 168
 169 static void MC_modelcheck_liveness_main(void);
 170
 171 static void MC_pre_modelcheck_liveness(void)
 172 {
 173   initial_global_state->raw_mem_set = (mmalloc_get_current_heap() == mc_heap);
 174
 175   mc_pair_t initial_pair = NULL;
 176   smx_process_t process;
 177
 178   MC_wait_for_requests();
 179
 180   acceptance_pairs = xbt_dynar_new(sizeof(mc_visited_pair_t), NULL);
 181   if(_sg_mc_visited > 0)
 182     visited_pairs = xbt_dynar_new(sizeof(mc_visited_pair_t), NULL);
 183
 184   initial_global_state->snapshot = MC_take_snapshot(0);
 185   initial_global_state->prev_pair = 0;
 186
 187   unsigned int cursor = 0;
 188   xbt_automaton_state_t automaton_state;
 189
 190   xbt_dynar_foreach(_mc_property_automaton->states, cursor, automaton_state) {
 191     if (automaton_state->type == -1) {  /* Initial automaton state */
 192
 193       initial_pair = MC_pair_new();
 194       initial_pair->automaton_state = automaton_state;
 195       initial_pair->graph_state = MC_state_new();
 196       initial_pair->atomic_propositions = get_atomic_propositions_values();
 197       initial_pair->depth = 1;
 198
 199       /* Get enabled processes and insert them in the interleave set of the graph_state */
 200       MC_EACH_SIMIX_PROCESS(process,
 201         if (MC_process_is_enabled(process)) {
 202           MC_state_interleave_process(initial_pair->graph_state, process);
 203         }
 204       );
 205
 206       initial_pair->requests = MC_state_interleave_size(initial_pair->graph_state);
 207       initial_pair->search_cycle = 0;
 208
 209       xbt_fifo_unshift(mc_stack, initial_pair);
 210     }
 211   }
 212
 213   MC_modelcheck_liveness_main();
 214 }
 215
 216 static void MC_modelcheck_liveness_main(void)
 217 {
 218   smx_process_t process = NULL;
 219   mc_pair_t current_pair = NULL;
 220   int value, res, visited_num = -1;
 221   smx_simcall_t req = NULL;
 222   xbt_automaton_transition_t transition_succ = NULL;
 223   int cursor = 0;
 224   mc_pair_t next_pair = NULL;
 225   xbt_dynar_t prop_values = NULL;
 226   mc_visited_pair_t reached_pair = NULL;
 227
 228   while(xbt_fifo_size(mc_stack) > 0){
 229
 230     /* Get current pair */
 231     current_pair = (mc_pair_t) xbt_fifo_get_item_content(xbt_fifo_get_first_item(mc_stack));
 232
 233     /* Update current state in buchi automaton */
 234     _mc_property_automaton->current_state = current_pair->automaton_state;
 235
 236     XBT_DEBUG("********************* ( Depth = %d, search_cycle = %d, interleave size = %d, pair_num = %d, requests = %d)",
 237        current_pair->depth, current_pair->search_cycle,
 238        MC_state_interleave_size(current_pair->graph_state), current_pair->num,
 239        current_pair->requests);
 240
 241     if (current_pair->requests > 0) {
 242
 243       if (current_pair->automaton_state->type == 1 && current_pair->exploration_started == 0) {
 244         /* If new acceptance pair, return new pair */
 245         if ((reached_pair = is_reached_acceptance_pair(current_pair)) == NULL) {
 246           int counter_example_depth = current_pair->depth;
 247           XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
 248           XBT_INFO("|             ACCEPTANCE CYCLE            |");
 249           XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
 250           XBT_INFO("Counter-example that violates formula :");
 251           MC_show_stack_liveness(mc_stack);
 252           MC_dump_stack_liveness(mc_stack);
 253           MC_print_statistics(mc_stats);
 254           XBT_INFO("Counter-example depth : %d", counter_example_depth);
 255           xbt_abort();
 256         }
 257       }
 258
 259       /* Pair already visited ? stop the exploration on the current path */
 260       if ((current_pair->exploration_started == 0) && (visited_num = is_visited_pair(reached_pair, current_pair)) != -1) {
 261
 262         if (dot_output != NULL){
 263           fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, visited_num, initial_global_state->prev_req);
 264           fflush(dot_output);
 265         }
 266
 267         XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
 268         current_pair->requests = 0;
 269         goto backtracking;
 270
 271       }else{
 272
 273         req = MC_state_get_request(current_pair->graph_state, &value);
 274
 275          if (dot_output != NULL) {
 276            if (initial_global_state->prev_pair != 0 && initial_global_state->prev_pair != current_pair->num) {
 277              fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, current_pair->num, initial_global_state->prev_req);
 278              xbt_free(initial_global_state->prev_req);
 279            }
 280            initial_global_state->prev_pair = current_pair->num;
 281            initial_global_state->prev_req = MC_request_get_dot_output(req, value);
 282            if (current_pair->search_cycle)
 283              fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
 284            fflush(dot_output);
 285          }
 286
 287          char* req_str = MC_request_to_string(req, value, MC_REQUEST_SIMIX);
 288          XBT_DEBUG("Execute: %s", req_str);
 289          xbt_free(req_str);
 290
 291          /* Set request as executed */
 292          MC_state_set_executed_request(current_pair->graph_state, req, value);
 293
 294          /* Update mc_stats */
 295          mc_stats->executed_transitions++;
 296          if(current_pair->exploration_started == 0)
 297            mc_stats->visited_pairs++;
 298
 299          /* Answer the request */
 300          MC_simcall_handle(req, value);
 301
 302          /* Wait for requests (schedules processes) */
 303          MC_wait_for_requests();
 304
 305          current_pair->requests--;
 306          current_pair->exploration_started = 1;
 307
 308          /* Get values of atomic propositions (variables used in the property formula) */
 309          prop_values = get_atomic_propositions_values();
 310
 311          /* Evaluate enabled/true transitions in automaton according to atomic propositions values and create new pairs */
 312          cursor = xbt_dynar_length(current_pair->automaton_state->out) - 1;
 313          while (cursor >= 0) {
 314            transition_succ = (xbt_automaton_transition_t)xbt_dynar_get_as(current_pair->automaton_state->out, cursor, xbt_automaton_transition_t);
 315            res = MC_automaton_evaluate_label(transition_succ->label, prop_values);
 316            if (res == 1 || res == 2) { /* 1 = True transition (always enabled), 2 = enabled transition according to atomic prop values */
 317               next_pair = MC_pair_new();
 318               next_pair->graph_state = MC_state_new();
 319               next_pair->automaton_state = transition_succ->dst;
 320               next_pair->atomic_propositions = get_atomic_propositions_values();
 321               next_pair->depth = current_pair->depth + 1;
 322               /* Get enabled processes and insert them in the interleave set of the next graph_state */
 323               MC_EACH_SIMIX_PROCESS(process,
 324                 if (MC_process_is_enabled(process)) {
 325                   MC_state_interleave_process(next_pair->graph_state, process);
 326                 }
 327               );
 328
 329               next_pair->requests = MC_state_interleave_size(next_pair->graph_state);
 330
 331               /* FIXME : get search_cycle value for each acceptant state */
 332               if (next_pair->automaton_state->type == 1 || current_pair->search_cycle)
 333                 next_pair->search_cycle = 1;
 334
 335               /* Add new pair to the exploration stack */
 336               xbt_fifo_unshift(mc_stack, next_pair);
 337
 338            }
 339            cursor--;
 340          }
 341
 342       } /* End of visited_pair test */
 343
 344     } else {
 345
 346     backtracking:
 347       if(visited_num == -1)
 348         XBT_DEBUG("No more request to execute. Looking for backtracking point.");
 349
 350       xbt_dynar_free(&prop_values);
 351
 352       /* Traverse the stack backwards until a pair with a non empty interleave
 353          set is found, deleting all the pairs that have it empty in the way. */
 354       while ((current_pair = (mc_pair_t) xbt_fifo_shift(mc_stack)) != NULL) {
 355         if (current_pair->requests > 0) {
 356           /* We found a backtracking point */
 357           XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
 358           xbt_fifo_unshift(mc_stack, current_pair);
 359           MC_replay_liveness(mc_stack);
 360           XBT_DEBUG("Backtracking done");
 361           break;
 362         }else{
 363           /* Delete pair */
 364           XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
 365           if (current_pair->automaton_state->type == 1)
 366             remove_acceptance_pair(current_pair->num);
 367           MC_pair_delete(current_pair);
 368         }
 369       }
 370
 371     } /* End of if (current_pair->requests > 0) else ... */
 372
 373   } /* End of while(xbt_fifo_size(mc_stack) > 0) */
 374
 375 }
 376
 377 void MC_modelcheck_liveness(void)
 378 {
 379   if (mc_reduce_kind == e_mc_reduce_unset)
 380     mc_reduce_kind = e_mc_reduce_none;
 381   XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
 382   MC_automaton_load(_sg_mc_property_file);
 383   MC_wait_for_requests();
 384
 385   XBT_DEBUG("Starting the liveness algorithm");
 386   _sg_mc_liveness = 1;
 387
 388   /* Create exploration stack */
 389   mc_stack = xbt_fifo_new();
 390
 391   /* Create the initial state */
 392   initial_global_state = xbt_new0(s_mc_global_t, 1);
 393
 394   MC_pre_modelcheck_liveness();
 395
 396   /* We're done */
 397   MC_print_statistics(mc_stats);
 398   xbt_free(mc_time);
 399 }
 400
 401 }