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