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