src/mc/mc_liveness.cpp

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