src/mc/LivenessChecker.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 <algorithm>
  10 #include <memory>
  11 #include <list>
  12
  13 #include <unistd.h>
  14 #include <sys/wait.h>
  15
  16 #include <xbt/automaton.h>
  17 #include <xbt/dynar.h>
  18 #include <xbt/dynar.hpp>
  19 #include <xbt/log.h>
  20 #include <xbt/sysdep.h>
  21
  22 #include "src/mc/mc_request.h"
  23 #include "src/mc/LivenessChecker.hpp"
  24 #include "src/mc/mc_private.h"
  25 #include "src/mc/mc_record.h"
  26 #include "src/mc/mc_smx.h"
  27 #include "src/mc/Client.hpp"
  28 #include "src/mc/mc_private.h"
  29 #include "src/mc/mc_replay.h"
  30 #include "src/mc/mc_safety.h"
  31 #include "src/mc/mc_exit.h"
  32
  33 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_liveness, mc,
  34                                 "Logging specific to algorithms for liveness properties verification");
  35
  36 /********* Static functions *********/
  37
  38 namespace simgrid {
  39 namespace mc {
  40
  41 VisitedPair::VisitedPair(
  42   int pair_num, xbt_automaton_state_t automaton_state,
  43   std::vector<int> const& atomic_propositions, std::shared_ptr<simgrid::mc::State> graph_state)
  44 {
  45   simgrid::mc::Process* process = &(mc_model_checker->process());
  46
  47   this->graph_state = std::move(graph_state);
  48   if(this->graph_state->system_state == nullptr)
  49     this->graph_state->system_state = simgrid::mc::take_snapshot(pair_num);
  50   this->heap_bytes_used = mmalloc_get_bytes_used_remote(
  51     process->get_heap()->heaplimit,
  52     process->get_malloc_info());
  53
  54   this->nb_processes =
  55     mc_model_checker->process().simix_processes().size();
  56
  57   this->automaton_state = automaton_state;
  58   this->num = pair_num;
  59   this->other_num = -1;
  60   this->atomic_propositions = atomic_propositions;
  61 }
  62
  63 VisitedPair::~VisitedPair()
  64 {
  65 }
  66
  67 static int MC_automaton_evaluate_label(
  68   xbt_automaton_exp_label_t l,
  69   std::vector<int> const& atomic_propositions_values)
  70 {
  71
  72   switch (l->type) {
  73   case xbt_automaton_exp_label::AUT_OR:{
  74       int left_res = MC_automaton_evaluate_label(
  75         l->u.or_and.left_exp, atomic_propositions_values);
  76       int right_res = MC_automaton_evaluate_label(
  77         l->u.or_and.right_exp, atomic_propositions_values);
  78       return (left_res || right_res);
  79     }
  80   case xbt_automaton_exp_label::AUT_AND:{
  81       int left_res = MC_automaton_evaluate_label(
  82         l->u.or_and.left_exp, atomic_propositions_values);
  83       int right_res = MC_automaton_evaluate_label(
  84         l->u.or_and.right_exp, atomic_propositions_values);
  85       return (left_res && right_res);
  86     }
  87   case xbt_automaton_exp_label::AUT_NOT:{
  88       int res = MC_automaton_evaluate_label(
  89         l->u.exp_not, atomic_propositions_values);
  90       return (!res);
  91     }
  92   case xbt_automaton_exp_label::AUT_PREDICAT:{
  93       unsigned int cursor = 0;
  94       xbt_automaton_propositional_symbol_t p = nullptr;
  95       xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
  96         if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
  97           return atomic_propositions_values[cursor];
  98       }
  99       return -1;
 100     }
 101   case xbt_automaton_exp_label::AUT_ONE:
 102     return 2;
 103   default:
 104     return -1;
 105   }
 106 }
 107
 108 Pair::Pair() : num(++mc_stats->expanded_pairs)
 109 {}
 110
 111 Pair::~Pair() {}
 112
 113 std::vector<int> LivenessChecker::getPropositionValues()
 114 {
 115   std::vector<int> values;
 116   unsigned int cursor = 0;
 117   xbt_automaton_propositional_symbol_t ps = nullptr;
 118   xbt_dynar_foreach(simgrid::mc::property_automaton->propositional_symbols, cursor, ps)
 119     values.push_back(xbt_automaton_propositional_symbol_evaluate(ps));
 120   return values;
 121 }
 122
 123 int LivenessChecker::compare(simgrid::mc::VisitedPair* state1, simgrid::mc::VisitedPair* state2)
 124 {
 125   simgrid::mc::Snapshot* s1 = state1->graph_state->system_state.get();
 126   simgrid::mc::Snapshot* s2 = state2->graph_state->system_state.get();
 127   int num1 = state1->num;
 128   int num2 = state2->num;
 129   return simgrid::mc::snapshot_compare(num1, s1, num2, s2);
 130 }
 131
 132 std::shared_ptr<VisitedPair> LivenessChecker::insertAcceptancePair(simgrid::mc::Pair* pair)
 133 {
 134   std::shared_ptr<VisitedPair> new_pair = std::make_shared<VisitedPair>(
 135     pair->num, pair->automaton_state, pair->atomic_propositions,
 136     pair->graph_state);
 137
 138   auto res = std::equal_range(acceptancePairs_.begin(), acceptancePairs_.end(),
 139     new_pair.get(), simgrid::mc::DerefAndCompareByNbProcessesAndUsedHeap());
 140
 141   if (pair->search_cycle)
 142     for (auto i = res.first; i != res.second; ++i) {
 143       std::shared_ptr<simgrid::mc::VisitedPair> const& pair_test = *i;
 144       if (xbt_automaton_state_compare(pair_test->automaton_state, new_pair->automaton_state) == 0) {
 145         if (pair_test->atomic_propositions == new_pair->atomic_propositions) {
 146           if (this->compare(pair_test.get(), new_pair.get()) == 0) {
 147             XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
 148             livenessStack_.pop_back();
 149             if (dot_output != nullptr)
 150               fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, pair_test->num, initial_global_state->prev_req);
 151             return nullptr;
 152           }
 153         }
 154       }
 155     }
 156
 157   acceptancePairs_.insert(res.first, new_pair);
 158   return new_pair;
 159 }
 160
 161 void LivenessChecker::removeAcceptancePair(int pair_num)
 162 {
 163   for (auto i = acceptancePairs_.begin(); i != acceptancePairs_.end(); ++i)
 164     if ((*i)->num == pair_num) {
 165       acceptancePairs_.erase(i);
 166       break;
 167     }
 168 }
 169
 170 void LivenessChecker::prepare(void)
 171 {
 172   simgrid::mc::Pair* initial_pair = nullptr;
 173   mc_model_checker->wait_for_requests();
 174
 175   initial_global_state->snapshot = simgrid::mc::take_snapshot(0);
 176   initial_global_state->prev_pair = 0;
 177
 178   unsigned int cursor = 0;
 179   xbt_automaton_state_t automaton_state;
 180
 181   xbt_dynar_foreach(simgrid::mc::property_automaton->states, cursor, automaton_state) {
 182     if (automaton_state->type == -1) {  /* Initial automaton state */
 183
 184       initial_pair = new Pair();
 185       initial_pair->automaton_state = automaton_state;
 186       initial_pair->graph_state = std::shared_ptr<simgrid::mc::State>(MC_state_new());
 187       initial_pair->atomic_propositions = this->getPropositionValues();
 188       initial_pair->depth = 1;
 189
 190       /* Get enabled processes and insert them in the interleave set of the graph_state */
 191       for (auto& p : mc_model_checker->process().simix_processes())
 192         if (simgrid::mc::process_is_enabled(&p.copy))
 193           MC_state_interleave_process(initial_pair->graph_state.get(), &p.copy);
 194
 195       initial_pair->requests = MC_state_interleave_size(initial_pair->graph_state.get());
 196       initial_pair->search_cycle = false;
 197
 198       livenessStack_.push_back(initial_pair);
 199     }
 200   }
 201 }
 202
 203
 204 void LivenessChecker::replay()
 205 {
 206   smx_simcall_t req = nullptr, saved_req = NULL;
 207   int value, depth = 1;
 208   char *req_str;
 209
 210   XBT_DEBUG("**** Begin Replay ****");
 211
 212   /* Intermediate backtracking */
 213   if(_sg_mc_checkpoint > 0) {
 214     simgrid::mc::Pair* pair = livenessStack_.back();
 215     if(pair->graph_state->system_state){
 216       simgrid::mc::restore_snapshot(pair->graph_state->system_state);
 217       return;
 218     }
 219   }
 220
 221   /* Restore the initial state */
 222   simgrid::mc::restore_snapshot(initial_global_state->snapshot);
 223
 224   /* Traverse the stack from the initial state and re-execute the transitions */
 225   for (simgrid::mc::Pair* pair : livenessStack_) {
 226     if (pair == livenessStack_.back())
 227       break;
 228
 229       std::shared_ptr<State> state = pair->graph_state;
 230
 231       if (pair->exploration_started) {
 232
 233         saved_req = MC_state_get_executed_request(state.get(), &value);
 234
 235         if (saved_req != nullptr) {
 236           /* because we got a copy of the executed request, we have to fetch the
 237              real one, pointed by the request field of the issuer process */
 238           const smx_process_t issuer = MC_smx_simcall_get_issuer(saved_req);
 239           req = &issuer->simcall;
 240
 241           /* Debug information */
 242           if (XBT_LOG_ISENABLED(mc_liveness, xbt_log_priority_debug)) {
 243             req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
 244             XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, req_str, state.get());
 245             xbt_free(req_str);
 246           }
 247
 248         }
 249
 250         simgrid::mc::handle_simcall(req, value);
 251         mc_model_checker->wait_for_requests();
 252       }
 253
 254       /* Update statistics */
 255       mc_stats->visited_pairs++;
 256       mc_stats->executed_transitions++;
 257
 258       depth++;
 259
 260   }
 261
 262   XBT_DEBUG("**** End Replay ****");
 263 }
 264
 265 /**
 266  * \brief Checks whether a given pair has already been visited by the algorithm.
 267  */
 268 int LivenessChecker::insertVisitedPair(std::shared_ptr<VisitedPair> visited_pair, simgrid::mc::Pair* pair)
 269 {
 270   if (_sg_mc_visited == 0)
 271     return -1;
 272
 273   if (visited_pair == nullptr)
 274     visited_pair = std::make_shared<VisitedPair>(
 275       pair->num, pair->automaton_state, pair->atomic_propositions,
 276       pair->graph_state);
 277
 278   auto range = std::equal_range(visitedPairs_.begin(), visitedPairs_.end(),
 279     visited_pair.get(), simgrid::mc::DerefAndCompareByNbProcessesAndUsedHeap());
 280
 281   for (auto i = range.first; i != range.second; ++i) {
 282     VisitedPair* pair_test = i->get();
 283     if (xbt_automaton_state_compare(pair_test->automaton_state, visited_pair->automaton_state) == 0) {
 284       if (pair_test->atomic_propositions == visited_pair->atomic_propositions) {
 285         if (this->compare(pair_test, visited_pair.get()) == 0) {
 286           if (pair_test->other_num == -1)
 287             visited_pair->other_num = pair_test->num;
 288           else
 289             visited_pair->other_num = pair_test->other_num;
 290           if (dot_output == nullptr)
 291             XBT_DEBUG("Pair %d already visited ! (equal to pair %d)",
 292             visited_pair->num, pair_test->num);
 293           else
 294             XBT_DEBUG("Pair %d already visited ! (equal to pair %d (pair %d in dot_output))",
 295               visited_pair->num, pair_test->num, visited_pair->other_num);
 296           (*i) = std::move(visited_pair);
 297           return (*i)->other_num;
 298         }
 299       }
 300     }
 301   }
 302
 303   visitedPairs_.insert(range.first, std::move(visited_pair));
 304
 305   if (visitedPairs_.size() > (std::size_t) _sg_mc_visited) {
 306     int min2 = mc_stats->expanded_pairs;
 307
 308     std::list<std::shared_ptr<VisitedPair>>::iterator index2;
 309     for (auto i = visitedPairs_.begin(); i != visitedPairs_.end(); ++i) {
 310       if ((*i)->num < min2) {
 311         index2 = i;
 312         min2 = (*i)->num;
 313       }
 314     }
 315
 316     visitedPairs_.erase(index2);
 317   }
 318
 319   return -1;
 320 }
 321
 322 LivenessChecker::LivenessChecker(Session& session) : Checker(session)
 323 {
 324 }
 325
 326 LivenessChecker::~LivenessChecker()
 327 {
 328 }
 329
 330 RecordTrace LivenessChecker::getRecordTrace() // override
 331 {
 332   RecordTrace res;
 333   for (simgrid::mc::Pair* pair : livenessStack_) {
 334     int value;
 335     smx_simcall_t req = MC_state_get_executed_request(pair->graph_state.get(), &value);
 336     if (req && req->call != SIMCALL_NONE) {
 337       smx_process_t issuer = MC_smx_simcall_get_issuer(req);
 338       const int pid = issuer->pid;
 339
 340       // Serialization the (pid, value) pair:
 341       res.push_back(RecordTraceElement(pid, value));
 342     }
 343   }
 344   return res;
 345 }
 346
 347 void LivenessChecker::showAcceptanceCycle(std::size_t depth)
 348 {
 349   XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
 350   XBT_INFO("|             ACCEPTANCE CYCLE            |");
 351   XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
 352   XBT_INFO("Counter-example that violates formula :");
 353   simgrid::mc::dumpRecordPath();
 354   for (auto& s : this->getTextualTrace())
 355     XBT_INFO("%s", s.c_str());
 356   MC_print_statistics(mc_stats);
 357   XBT_INFO("Counter-example depth : %zd", depth);
 358 }
 359
 360 std::vector<std::string> LivenessChecker::getTextualTrace() // override
 361 {
 362   std::vector<std::string> trace;
 363   for (simgrid::mc::Pair* pair : livenessStack_) {
 364     int value;
 365     smx_simcall_t req = MC_state_get_executed_request(pair->graph_state.get(), &value);
 366     if (req && req->call != SIMCALL_NONE) {
 367       char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::executed);
 368       trace.push_back(std::string(req_str));
 369       xbt_free(req_str);
 370     }
 371   }
 372   return trace;
 373 }
 374
 375 int LivenessChecker::main(void)
 376 {
 377   simgrid::mc::Pair* current_pair = nullptr;
 378   int value, res, visited_num = -1;
 379   smx_simcall_t req = nullptr;
 380   xbt_automaton_transition_t transition_succ = nullptr;
 381   int cursor = 0;
 382   std::shared_ptr<VisitedPair> reached_pair = nullptr;
 383
 384   while (!livenessStack_.empty()){
 385
 386     /* Get current pair */
 387     current_pair = livenessStack_.back();
 388
 389     /* Update current state in buchi automaton */
 390     simgrid::mc::property_automaton->current_state = current_pair->automaton_state;
 391
 392     XBT_DEBUG("********************* ( Depth = %d, search_cycle = %d, interleave size = %d, pair_num = %d, requests = %d)",
 393        current_pair->depth, current_pair->search_cycle,
 394        MC_state_interleave_size(current_pair->graph_state.get()), current_pair->num,
 395        current_pair->requests);
 396
 397     if (current_pair->requests > 0) {
 398
 399       if (current_pair->automaton_state->type == 1 && !current_pair->exploration_started) {
 400         /* If new acceptance pair, return new pair */
 401         if ((reached_pair = this->insertAcceptancePair(current_pair)) == nullptr) {
 402           this->showAcceptanceCycle(current_pair->depth);
 403           return SIMGRID_MC_EXIT_LIVENESS;
 404         }
 405       }
 406
 407       /* Pair already visited ? stop the exploration on the current path */
 408       if ((!current_pair->exploration_started)
 409         && (visited_num = this->insertVisitedPair(
 410           reached_pair, current_pair)) != -1) {
 411
 412         if (dot_output != nullptr){
 413           fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, visited_num, initial_global_state->prev_req);
 414           fflush(dot_output);
 415         }
 416
 417         XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
 418         current_pair->requests = 0;
 419         goto backtracking;
 420
 421       }else{
 422
 423         req = MC_state_get_request(current_pair->graph_state.get(), &value);
 424
 425          if (dot_output != nullptr) {
 426            if (initial_global_state->prev_pair != 0 && initial_global_state->prev_pair != current_pair->num) {
 427              fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", initial_global_state->prev_pair, current_pair->num, initial_global_state->prev_req);
 428              xbt_free(initial_global_state->prev_req);
 429            }
 430            initial_global_state->prev_pair = current_pair->num;
 431            initial_global_state->prev_req = simgrid::mc::request_get_dot_output(req, value);
 432            if (current_pair->search_cycle)
 433              fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
 434            fflush(dot_output);
 435          }
 436
 437          char* req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
 438          XBT_DEBUG("Execute: %s", req_str);
 439          xbt_free(req_str);
 440
 441          /* Set request as executed */
 442          MC_state_set_executed_request(current_pair->graph_state.get(), req, value);
 443
 444          /* Update mc_stats */
 445          mc_stats->executed_transitions++;
 446          if (!current_pair->exploration_started)
 447            mc_stats->visited_pairs++;
 448
 449          /* Answer the request */
 450          simgrid::mc::handle_simcall(req, value);
 451
 452          /* Wait for requests (schedules processes) */
 453          mc_model_checker->wait_for_requests();
 454
 455          current_pair->requests--;
 456          current_pair->exploration_started = true;
 457
 458          /* Get values of atomic propositions (variables used in the property formula) */
 459          std::vector<int> prop_values = this->getPropositionValues();
 460
 461          /* Evaluate enabled/true transitions in automaton according to atomic propositions values and create new pairs */
 462          cursor = xbt_dynar_length(current_pair->automaton_state->out) - 1;
 463          while (cursor >= 0) {
 464            transition_succ = (xbt_automaton_transition_t)xbt_dynar_get_as(current_pair->automaton_state->out, cursor, xbt_automaton_transition_t);
 465            res = MC_automaton_evaluate_label(transition_succ->label, prop_values);
 466            if (res == 1 || res == 2) { /* 1 = True transition (always enabled), 2 = enabled transition according to atomic prop values */
 467               Pair* next_pair = new Pair();
 468               next_pair->graph_state = std::shared_ptr<simgrid::mc::State>(MC_state_new());
 469               next_pair->automaton_state = transition_succ->dst;
 470               next_pair->atomic_propositions = this->getPropositionValues();
 471               next_pair->depth = current_pair->depth + 1;
 472               /* Get enabled processes and insert them in the interleave set of the next graph_state */
 473               for (auto& p : mc_model_checker->process().simix_processes())
 474                 if (simgrid::mc::process_is_enabled(&p.copy))
 475                   MC_state_interleave_process(next_pair->graph_state.get(), &p.copy);
 476
 477               next_pair->requests = MC_state_interleave_size(next_pair->graph_state.get());
 478
 479               /* FIXME : get search_cycle value for each acceptant state */
 480               if (next_pair->automaton_state->type == 1 || current_pair->search_cycle)
 481                 next_pair->search_cycle = true;
 482
 483               /* Add new pair to the exploration stack */
 484               livenessStack_.push_back(next_pair);
 485
 486            }
 487            cursor--;
 488          }
 489
 490       } /* End of visited_pair test */
 491
 492     } else {
 493
 494     backtracking:
 495       if(visited_num == -1)
 496         XBT_DEBUG("No more request to execute. Looking for backtracking point.");
 497
 498       /* Traverse the stack backwards until a pair with a non empty interleave
 499          set is found, deleting all the pairs that have it empty in the way. */
 500       while (!livenessStack_.empty()) {
 501         current_pair = livenessStack_.back();
 502         livenessStack_.pop_back();
 503         if (current_pair->requests > 0) {
 504           /* We found a backtracking point */
 505           XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
 506           livenessStack_.push_back(current_pair);
 507           this->replay();
 508           XBT_DEBUG("Backtracking done");
 509           break;
 510         }else{
 511           /* Delete pair */
 512           XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
 513           if (current_pair->automaton_state->type == 1)
 514             this->removeAcceptancePair(current_pair->num);
 515           delete current_pair;
 516         }
 517       }
 518
 519     } /* End of if (current_pair->requests > 0) else ... */
 520
 521   }
 522
 523   XBT_INFO("No property violation found.");
 524   MC_print_statistics(mc_stats);
 525   return SIMGRID_MC_EXIT_SUCCESS;
 526 }
 527
 528 int LivenessChecker::run()
 529 {
 530   XBT_INFO("Check the liveness property %s", _sg_mc_property_file);
 531   MC_automaton_load(_sg_mc_property_file);
 532   mc_model_checker->wait_for_requests();
 533
 534   XBT_DEBUG("Starting the liveness algorithm");
 535
 536   /* Create the initial state */
 537   simgrid::mc::initial_global_state = std::unique_ptr<s_mc_global_t>(new s_mc_global_t());
 538
 539   this->prepare();
 540   int res = this->main();
 541   simgrid::mc::initial_global_state = nullptr;
 542
 543   return res;
 544 }
 545
 546 Checker* createLivenessChecker(Session& session)
 547 {
 548   return new LivenessChecker(session);
 549 }
 550
 551 }
 552 }