src/mc/checker/LivenessChecker.cpp

   1 /* Copyright (c) 2011-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/mc/checker/LivenessChecker.hpp"
   7 #include "src/mc/Session.hpp"
   8 #include "src/mc/mc_config.hpp"
   9 #include "src/mc/mc_exit.hpp"
  10 #include "src/mc/mc_private.hpp"
  11 #include "src/mc/mc_request.hpp"
  12 #include "src/mc/mc_smx.hpp"
  13 #include "src/mc/mc_api.hpp"
  14
  15 #include <boost/range/algorithm.hpp>
  16 #include <cstring>
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_liveness, mc, "Logging specific to algorithms for liveness properties verification");
  19
  20 using mcapi = simgrid::mc::mc_api;
  21
  22 /********* Static functions *********/
  23
  24 namespace simgrid {
  25 namespace mc {
  26
  27 VisitedPair::VisitedPair(int pair_num, xbt_automaton_state_t automaton_state,
  28                          std::shared_ptr<const std::vector<int>> atomic_propositions,
  29                          std::shared_ptr<State> graph_state)
  30     : num(pair_num), automaton_state(automaton_state)
  31 {
  32   this->graph_state = std::move(graph_state);
  33   if (this->graph_state->system_state_ == nullptr)
  34     this->graph_state->system_state_ = std::make_shared<Snapshot>(pair_num);
  35   this->heap_bytes_used = mcapi::get().get_remote_heap_bytes();
  36   this->actors_count = mcapi::get().get_actors_size();
  37   this->other_num = -1;
  38   this->atomic_propositions = std::move(atomic_propositions);
  39 }
  40
  41 static bool evaluate_label(const xbt_automaton_exp_label* l, std::vector<int> const& values)
  42 {
  43   switch (l->type) {
  44   case xbt_automaton_exp_label::AUT_OR:
  45     return evaluate_label(l->u.or_and.left_exp, values)
  46       || evaluate_label(l->u.or_and.right_exp, values);
  47   case xbt_automaton_exp_label::AUT_AND:
  48     return evaluate_label(l->u.or_and.left_exp, values)
  49       && evaluate_label(l->u.or_and.right_exp, values);
  50   case xbt_automaton_exp_label::AUT_NOT:
  51     return not evaluate_label(l->u.exp_not, values);
  52   case xbt_automaton_exp_label::AUT_PREDICAT:{
  53       auto cursor = mcapi::get().compare_automaton_exp_lable(l, values);
  54       if(cursor >= 0)
  55         return values[cursor] != 0;
  56       xbt_die("Missing predicate");
  57       break;
  58     }
  59   case xbt_automaton_exp_label::AUT_ONE:
  60     return true;
  61   default:
  62     xbt_die("Unexpected value for automaton");
  63   }
  64 }
  65
  66 Pair::Pair(unsigned long expanded_pairs) : num(expanded_pairs)
  67 {}
  68
  69 std::shared_ptr<const std::vector<int>> LivenessChecker::get_proposition_values() const
  70 {
  71   auto values = mcapi::get().automaton_propositional_symbol_evaluate();
  72   return std::make_shared<const std::vector<int>>(std::move(values));
  73 }
  74
  75 std::shared_ptr<VisitedPair> LivenessChecker::insert_acceptance_pair(simgrid::mc::Pair* pair)
  76 {
  77   auto new_pair =
  78       std::make_shared<VisitedPair>(pair->num, pair->automaton_state, pair->atomic_propositions, pair->graph_state);
  79
  80   auto res = boost::range::equal_range(acceptance_pairs_, new_pair.get(), mcapi::get().compare_pair());
  81
  82   if (pair->search_cycle) for (auto i = res.first; i != res.second; ++i) {
  83     std::shared_ptr<simgrid::mc::VisitedPair> const& pair_test = *i;
  84     if (mcapi::get().automaton_state_compare(pair_test->automaton_state, new_pair->automaton_state) != 0 ||
  85         *(pair_test->atomic_propositions) != *(new_pair->atomic_propositions) ||
  86         not mcapi::get().snapshot_equal(pair_test->graph_state->system_state_.get(), new_pair->graph_state->system_state_.get()))
  87       continue;
  88     XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
  89     exploration_stack_.pop_back();
  90     if (dot_output != nullptr)
  91       fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", this->previous_pair_, pair_test->num,
  92               this->previous_request_.c_str());
  93     return nullptr;
  94   }
  95
  96   acceptance_pairs_.insert(res.first, new_pair);
  97   return new_pair;
  98 }
  99
 100 void LivenessChecker::remove_acceptance_pair(int pair_num)
 101 {
 102   for (auto i = acceptance_pairs_.begin(); i != acceptance_pairs_.end(); ++i)
 103     if ((*i)->num == pair_num) {
 104       acceptance_pairs_.erase(i);
 105       break;
 106     }
 107 }
 108
 109 void LivenessChecker::replay()
 110 {
 111   XBT_DEBUG("**** Begin Replay ****");
 112
 113   /* Intermediate backtracking */
 114   if(_sg_mc_checkpoint > 0) {
 115     const Pair* pair = exploration_stack_.back().get();
 116     if (pair->graph_state->system_state_) {
 117       mcapi::get().restore_state(pair->graph_state->system_state_);
 118       return;
 119     }
 120   }
 121
 122   /* Restore the initial state */
 123   mcapi::get().restore_initial_state();
 124
 125   /* Traverse the stack from the initial state and re-execute the transitions */
 126   int depth = 1;
 127   for (std::shared_ptr<Pair> const& pair : exploration_stack_) {
 128     if (pair == exploration_stack_.back())
 129       break;
 130
 131     std::shared_ptr<State> state = pair->graph_state;
 132
 133     if (pair->exploration_started) {
 134       int req_num             = state->transition_.argument_;
 135       const s_smx_simcall* saved_req = &state->executed_req_;
 136
 137       smx_simcall_t req = nullptr;
 138
 139       /* because we got a copy of the executed request, we have to fetch the
 140          real one, pointed by the request field of the issuer process */
 141       const smx_actor_t issuer = mcapi::get().simcall_get_issuer(saved_req);
 142       req                      = &issuer->simcall_;
 143
 144       /* Debug information */
 145       XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth,
 146                 mcapi::get().request_to_string(req, req_num, simgrid::mc::RequestType::simix).c_str(), state.get());
 147
 148       this->get_session().execute(state->transition_);
 149     }
 150
 151     /* Update statistics */
 152     visited_pairs_count_++;
 153     mc_model_checker->executed_transitions++;
 154
 155     depth++;
 156   }
 157   XBT_DEBUG("**** End Replay ****");
 158 }
 159
 160 /**
 161  * @brief Checks whether a given pair has already been visited by the algorithm.
 162  */
 163 int LivenessChecker::insert_visited_pair(std::shared_ptr<VisitedPair> visited_pair, simgrid::mc::Pair* pair)
 164 {
 165   if (_sg_mc_max_visited_states == 0)
 166     return -1;
 167
 168   if (visited_pair == nullptr)
 169     visited_pair =
 170         std::make_shared<VisitedPair>(pair->num, pair->automaton_state, pair->atomic_propositions, pair->graph_state);
 171
 172   auto range = boost::range::equal_range(visited_pairs_, visited_pair.get(), mcapi::get().compare_pair());
 173
 174   for (auto i = range.first; i != range.second; ++i) {
 175     const VisitedPair* pair_test = i->get();
 176     if (mcapi::get().automaton_state_compare(pair_test->automaton_state, visited_pair->automaton_state) != 0 ||
 177         *(pair_test->atomic_propositions) != *(visited_pair->atomic_propositions) ||
 178         not mcapi::get().snapshot_equal(pair_test->graph_state->system_state_.get(), visited_pair->graph_state->system_state_.get()))
 179       continue;
 180     if (pair_test->other_num == -1)
 181       visited_pair->other_num = pair_test->num;
 182     else
 183       visited_pair->other_num = pair_test->other_num;
 184     if (dot_output == nullptr)
 185       XBT_DEBUG("Pair %d already visited ! (equal to pair %d)", visited_pair->num, pair_test->num);
 186     else
 187       XBT_DEBUG("Pair %d already visited ! (equal to pair %d (pair %d in dot_output))",
 188         visited_pair->num, pair_test->num, visited_pair->other_num);
 189     (*i) = std::move(visited_pair);
 190     return (*i)->other_num;
 191   }
 192
 193   visited_pairs_.insert(range.first, std::move(visited_pair));
 194   this->purge_visited_pairs();
 195   return -1;
 196 }
 197
 198 void LivenessChecker::purge_visited_pairs()
 199 {
 200   if (_sg_mc_max_visited_states != 0 && visited_pairs_.size() > (std::size_t)_sg_mc_max_visited_states) {
 201     // Remove the oldest entry with a linear search:
 202     visited_pairs_.erase(
 203         boost::min_element(visited_pairs_, [](std::shared_ptr<VisitedPair> const a,
 204                                               std::shared_ptr<VisitedPair> const& b) { return a->num < b->num; }));
 205   }
 206 }
 207
 208 LivenessChecker::LivenessChecker(Session& s) : Checker(s)
 209 {
 210 }
 211
 212 RecordTrace LivenessChecker::get_record_trace() // override
 213 {
 214   RecordTrace res;
 215   for (std::shared_ptr<Pair> const& pair : exploration_stack_)
 216     res.push_back(pair->graph_state->get_transition());
 217   return res;
 218 }
 219
 220 void LivenessChecker::log_state() // override
 221 {
 222   XBT_INFO("Expanded pairs = %lu", expanded_pairs_count_);
 223   XBT_INFO("Visited pairs = %lu", visited_pairs_count_);
 224   XBT_INFO("Executed transitions = %lu", mcapi::get().mc_get_executed_trans());
 225 }
 226
 227 void LivenessChecker::show_acceptance_cycle(std::size_t depth)
 228 {
 229   XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
 230   XBT_INFO("|             ACCEPTANCE CYCLE            |");
 231   XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
 232   XBT_INFO("Counter-example that violates formula:");
 233   for (auto const& s : this->get_textual_trace())
 234     XBT_INFO("  %s", s.c_str());
 235   mcapi::get().dump_record_path();
 236   mcapi::get().log_state();
 237   XBT_INFO("Counter-example depth: %zu", depth);
 238 }
 239
 240 std::vector<std::string> LivenessChecker::get_textual_trace() // override
 241 {
 242   std::vector<std::string> trace;
 243   for (std::shared_ptr<Pair> const& pair : exploration_stack_) {
 244     int req_num       = pair->graph_state->transition_.argument_;
 245     smx_simcall_t req = &pair->graph_state->executed_req_;
 246     if (req->call_ != simix::Simcall::NONE)
 247       trace.push_back(mcapi::get().request_to_string(req, req_num, RequestType::executed));
 248   }
 249   return trace;
 250 }
 251
 252 std::shared_ptr<Pair> LivenessChecker::create_pair(const Pair* current_pair, xbt_automaton_state_t state,
 253                                                    std::shared_ptr<const std::vector<int>> propositions)
 254 {
 255   ++expanded_pairs_count_;
 256   ++expanded_states_count_;
 257   auto next_pair                  = std::make_shared<Pair>(expanded_pairs_count_);
 258   next_pair->automaton_state      = state;
 259   next_pair->graph_state          = std::make_shared<State>(expanded_states_count_);
 260   next_pair->atomic_propositions  = std::move(propositions);
 261   if (current_pair)
 262     next_pair->depth = current_pair->depth + 1;
 263   else
 264     next_pair->depth = 1;
 265   /* Get enabled actors and insert them in the interleave set of the next graph_state */
 266   auto actors = mcapi::get().get_actors();
 267   for (auto& actor : actors)
 268     if (mcapi::get().actor_is_enabled(actor.copy.get_buffer()->get_pid()))
 269       next_pair->graph_state->add_interleaving_set(actor.copy.get_buffer());
 270   next_pair->requests = next_pair->graph_state->interleave_size();
 271   /* FIXME : get search_cycle value for each accepting state */
 272   if (next_pair->automaton_state->type == 1 || (current_pair && current_pair->search_cycle))
 273     next_pair->search_cycle = true;
 274   else
 275     next_pair->search_cycle = false;
 276   return next_pair;
 277 }
 278
 279 void LivenessChecker::backtrack()
 280 {
 281   /* Traverse the stack backwards until a pair with a non empty interleave
 282      set is found, deleting all the pairs that have it empty in the way. */
 283   while (not exploration_stack_.empty()) {
 284     std::shared_ptr<simgrid::mc::Pair> current_pair = exploration_stack_.back();
 285     exploration_stack_.pop_back();
 286     if (current_pair->requests > 0) {
 287       /* We found a backtracking point */
 288       XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
 289       exploration_stack_.push_back(std::move(current_pair));
 290       this->replay();
 291       XBT_DEBUG("Backtracking done");
 292       break;
 293     } else {
 294       XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
 295       if (current_pair->automaton_state->type == 1)
 296         this->remove_acceptance_pair(current_pair->num);
 297     }
 298   }
 299 }
 300
 301 void LivenessChecker::run()
 302 {
 303   XBT_INFO("Check the liveness property %s", _sg_mc_property_file.get().c_str());
 304   mcapi::get().automaton_load(_sg_mc_property_file.get().c_str());
 305
 306   XBT_DEBUG("Starting the liveness algorithm");
 307   mcapi::get().session_initialize();
 308
 309   /* Initialize */
 310   this->previous_pair_ = 0;
 311
 312   std::shared_ptr<const std::vector<int>> propos = this->get_proposition_values();
 313
 314   // For each initial state of the property automaton, push a
 315   // (application_state, automaton_state) pair to the exploration stack:
 316   auto automaton_stack = mcapi::get().get_automaton_state();
 317   std::for_each(automaton_stack.begin(), automaton_stack.end(), [&](xbt_automaton_state_t const& automaton_state) {
 318     if (automaton_state->type == -1)
 319       exploration_stack_.push_back(this->create_pair(nullptr, automaton_state, propos));
 320   });
 321
 322   /* Actually run the double DFS search for counter-examples */
 323   while (not exploration_stack_.empty()) {
 324     std::shared_ptr<Pair> current_pair = exploration_stack_.back();
 325
 326     /* Update current state in buchi automaton */
 327     mcapi::get().set_property_automaton(current_pair->automaton_state);
 328
 329     XBT_DEBUG(
 330         "********************* ( Depth = %d, search_cycle = %d, interleave size = %zu, pair_num = %d, requests = %d)",
 331         current_pair->depth, current_pair->search_cycle, current_pair->graph_state->interleave_size(),
 332         current_pair->num, current_pair->requests);
 333
 334     if (current_pair->requests == 0) {
 335       this->backtrack();
 336       continue;
 337     }
 338
 339     std::shared_ptr<VisitedPair> reached_pair;
 340     if (current_pair->automaton_state->type == 1 && not current_pair->exploration_started) {
 341       reached_pair = this->insert_acceptance_pair(current_pair.get());
 342       if (reached_pair == nullptr) {
 343         this->show_acceptance_cycle(current_pair->depth);
 344         throw LivenessError();
 345       }
 346     }
 347
 348     /* Pair already visited ? stop the exploration on the current path */
 349     if (not current_pair->exploration_started) {
 350       int visited_num = this->insert_visited_pair(reached_pair, current_pair.get());
 351       if (visited_num != -1) {
 352         if (dot_output != nullptr) {
 353           fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", this->previous_pair_, visited_num,
 354                   this->previous_request_.c_str());
 355           fflush(dot_output);
 356         }
 357         XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
 358         current_pair->requests = 0;
 359         this->backtrack();
 360         continue;
 361       }
 362     }
 363
 364     smx_simcall_t req = mcapi::get().mc_state_choose_request(current_pair->graph_state.get());
 365     int req_num       = current_pair->graph_state->transition_.argument_;
 366
 367     if (dot_output != nullptr) {
 368       if (this->previous_pair_ != 0 && this->previous_pair_ != current_pair->num) {
 369         fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", this->previous_pair_, current_pair->num,
 370                 this->previous_request_.c_str());
 371         this->previous_request_.clear();
 372       }
 373       this->previous_pair_    = current_pair->num;
 374       this->previous_request_ = mcapi::get().request_get_dot_output(req, req_num);
 375       if (current_pair->search_cycle)
 376         fprintf(dot_output, "%d [shape=doublecircle];\n", current_pair->num);
 377       fflush(dot_output);
 378     }
 379
 380     XBT_DEBUG("Execute: %s", mcapi::get().request_to_string(req, req_num, RequestType::simix).c_str());
 381
 382     /* Update stats */
 383     mcapi::get().mc_inc_executed_trans();
 384
 385     if (not current_pair->exploration_started)
 386       visited_pairs_count_++;
 387
 388     /* Answer the request */
 389     mcapi::get().handle_simcall(current_pair->graph_state->transition_);
 390
 391     /* Wait for requests (schedules processes) */
 392     mcapi::get().mc_wait_for_requests();
 393
 394     current_pair->requests--;
 395     current_pair->exploration_started = true;
 396
 397     /* Get values of atomic propositions (variables used in the property formula) */
 398     std::shared_ptr<const std::vector<int>> prop_values = this->get_proposition_values();
 399
 400     // For each enabled transition in the property automaton, push a
 401     // (application_state, automaton_state) pair to the exploration stack:
 402     for (int i = mcapi::get().get_dynar_length(current_pair->automaton_state->out) - 1; i >= 0; i--) {
 403       auto transition_succ_label = mcapi::get().get_automaton_transition_label(current_pair->automaton_state->out, i);
 404       auto transition_succ_dst = mcapi::get().get_automaton_transition_dst(current_pair->automaton_state->out, i);
 405       if (evaluate_label(transition_succ_label, *prop_values))
 406         exploration_stack_.push_back(this->create_pair(current_pair.get(), transition_succ_dst, prop_values));
 407     }
 408   }
 409
 410   XBT_INFO("No property violation found.");
 411   mcapi::get().log_state();
 412 }
 413
 414 Checker* createLivenessChecker(Session& s)
 415 {
 416   return new LivenessChecker(s);
 417 }
 418
 419 } // namespace mc
 420 } // namespace simgrid