src/mc/explo/LivenessChecker.cpp

   1 /* Copyright (c) 2011-2022. 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/explo/LivenessChecker.hpp"
   7 #include "src/mc/api/RemoteApp.hpp"
   8 #include "src/mc/mc_config.hpp"
   9 #include "src/mc/mc_exit.hpp"
  10 #include "src/mc/mc_private.hpp"
  11
  12 #include <boost/range/algorithm.hpp>
  13 #include <cstring>
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_liveness, mc, "Logging specific to algorithms for liveness properties verification");
  16
  17 /********* Static functions *********/
  18
  19 namespace simgrid::mc {
  20
  21 VisitedPair::VisitedPair(int pair_num, xbt_automaton_state_t prop_state,
  22                          std::shared_ptr<const std::vector<int>> atomic_propositions, std::shared_ptr<State> app_state)
  23     : num(pair_num), prop_state_(prop_state)
  24 {
  25   this->app_state_ = std::move(app_state);
  26   if (not this->app_state_->get_system_state())
  27     this->app_state_->set_system_state(std::make_shared<Snapshot>(pair_num));
  28   this->heap_bytes_used     = mc_model_checker->get_remote_process().get_remote_heap_bytes();
  29   this->actor_count_        = app_state_->get_actor_count();
  30   this->other_num           = -1;
  31   this->atomic_propositions = std::move(atomic_propositions);
  32 }
  33
  34 bool LivenessChecker::evaluate_label(const xbt_automaton_exp_label* l, std::vector<int> const& values)
  35 {
  36   switch (l->type) {
  37     case xbt_automaton_exp_label::AUT_OR:
  38       return evaluate_label(l->u.or_and.left_exp, values) || evaluate_label(l->u.or_and.right_exp, values);
  39     case xbt_automaton_exp_label::AUT_AND:
  40       return evaluate_label(l->u.or_and.left_exp, values) && evaluate_label(l->u.or_and.right_exp, values);
  41     case xbt_automaton_exp_label::AUT_NOT:
  42       return not evaluate_label(l->u.exp_not, values);
  43     case xbt_automaton_exp_label::AUT_PREDICAT:
  44       return values.at(compare_automaton_exp_label(l)) != 0;
  45     case xbt_automaton_exp_label::AUT_ONE:
  46       return true;
  47     default:
  48       xbt_die("Unexpected value for automaton");
  49   }
  50 }
  51
  52 Pair::Pair(unsigned long expanded_pairs) : num(expanded_pairs) {}
  53
  54 std::shared_ptr<const std::vector<int>> LivenessChecker::get_proposition_values() const
  55 {
  56   auto values = automaton_propositional_symbol_evaluate();
  57   return std::make_shared<const std::vector<int>>(std::move(values));
  58 }
  59
  60 std::shared_ptr<VisitedPair> LivenessChecker::insert_acceptance_pair(simgrid::mc::Pair* pair)
  61 {
  62   auto new_pair =
  63       std::make_shared<VisitedPair>(pair->num, pair->prop_state_, pair->atomic_propositions, pair->app_state_);
  64
  65   auto [res_begin, res_end] = boost::range::equal_range(acceptance_pairs_, new_pair.get(), Api::get().compare_pair());
  66
  67   if (pair->search_cycle)
  68     for (auto i = res_begin; i != res_end; ++i) {
  69       std::shared_ptr<simgrid::mc::VisitedPair> const& pair_test = *i;
  70       if (xbt_automaton_state_compare(pair_test->prop_state_, new_pair->prop_state_) != 0 ||
  71           *(pair_test->atomic_propositions) != *(new_pair->atomic_propositions) ||
  72           (*pair_test->app_state_->get_system_state() != *new_pair->app_state_->get_system_state()))
  73         continue;
  74       XBT_INFO("Pair %d already reached (equal to pair %d) !", new_pair->num, pair_test->num);
  75       exploration_stack_.pop_back();
  76       mc_model_checker->dot_output("\"%d\" -> \"%d\" [%s];\n", this->previous_pair_, pair_test->num,
  77                                    this->previous_request_.c_str());
  78       return nullptr;
  79     }
  80
  81   acceptance_pairs_.insert(res_begin, new_pair);
  82   return new_pair;
  83 }
  84
  85 void LivenessChecker::remove_acceptance_pair(int pair_num)
  86 {
  87   for (auto i = acceptance_pairs_.begin(); i != acceptance_pairs_.end(); ++i)
  88     if ((*i)->num == pair_num) {
  89       acceptance_pairs_.erase(i);
  90       break;
  91     }
  92 }
  93
  94 void LivenessChecker::replay()
  95 {
  96   XBT_DEBUG("**** Begin Replay ****");
  97
  98   /* Intermediate backtracking */
  99   if (_sg_mc_checkpoint > 0) {
 100     const Pair* pair = exploration_stack_.back().get();
 101     if (const auto* system_state = pair->app_state_->get_system_state()) {
 102       system_state->restore(&get_remote_app().get_remote_process());
 103       return;
 104     }
 105   }
 106
 107   get_remote_app().restore_initial_state();
 108
 109   /* Traverse the stack from the initial state and re-execute the transitions */
 110   int depth = 1;
 111   for (std::shared_ptr<Pair> const& pair : exploration_stack_) {
 112     if (pair == exploration_stack_.back())
 113       break;
 114
 115     std::shared_ptr<State> state = pair->app_state_;
 116
 117     if (pair->exploration_started) {
 118       state->get_transition()->replay();
 119       XBT_DEBUG("Replay (depth = %d) : %s (%p)", depth, state->get_transition()->to_string().c_str(), state.get());
 120     }
 121
 122     /* Update statistics */
 123     visited_pairs_count_++;
 124     depth++;
 125   }
 126   XBT_DEBUG("**** End Replay ****");
 127 }
 128
 129 /**
 130  * @brief Checks whether a given pair has already been visited by the algorithm.
 131  */
 132 int LivenessChecker::insert_visited_pair(std::shared_ptr<VisitedPair> visited_pair, simgrid::mc::Pair* pair)
 133 {
 134   if (_sg_mc_max_visited_states == 0)
 135     return -1;
 136
 137   if (visited_pair == nullptr)
 138     visited_pair =
 139         std::make_shared<VisitedPair>(pair->num, pair->prop_state_, pair->atomic_propositions, pair->app_state_);
 140
 141   auto [range_begin, range_end] =
 142       boost::range::equal_range(visited_pairs_, visited_pair.get(), Api::get().compare_pair());
 143
 144   for (auto i = range_begin; i != range_end; ++i) {
 145     const VisitedPair* pair_test = i->get();
 146     if (xbt_automaton_state_compare(pair_test->prop_state_, visited_pair->prop_state_) != 0 ||
 147         *(pair_test->atomic_propositions) != *(visited_pair->atomic_propositions) ||
 148         (*pair_test->app_state_->get_system_state() != *visited_pair->app_state_->get_system_state()))
 149       continue;
 150     if (pair_test->other_num == -1)
 151       visited_pair->other_num = pair_test->num;
 152     else
 153       visited_pair->other_num = pair_test->other_num;
 154     XBT_DEBUG("Pair %d already visited ! (equal to pair %d (pair %d in dot_output))", visited_pair->num, pair_test->num,
 155               visited_pair->other_num);
 156     (*i) = std::move(visited_pair);
 157     return (*i)->other_num;
 158   }
 159
 160   visited_pairs_.insert(range_begin, std::move(visited_pair));
 161   this->purge_visited_pairs();
 162   return -1;
 163 }
 164
 165 void LivenessChecker::purge_visited_pairs()
 166 {
 167   if (_sg_mc_max_visited_states != 0 && visited_pairs_.size() > (std::size_t)_sg_mc_max_visited_states) {
 168     // Remove the oldest entry with a linear search:
 169     visited_pairs_.erase(
 170         boost::min_element(visited_pairs_, [](std::shared_ptr<VisitedPair> const a,
 171                                               std::shared_ptr<VisitedPair> const& b) { return a->num < b->num; }));
 172   }
 173 }
 174
 175 LivenessChecker::LivenessChecker(const std::vector<char*>& args) : Exploration(args) {}
 176 LivenessChecker::~LivenessChecker()
 177 {
 178   if (property_automaton_ != nullptr)
 179     xbt_automaton_free(property_automaton_);
 180 }
 181
 182 xbt_automaton_t LivenessChecker::property_automaton_ = nullptr;
 183
 184 void LivenessChecker::automaton_load(const char* file)
 185 {
 186   if (property_automaton_ == nullptr)
 187     property_automaton_ = xbt_automaton_new();
 188
 189   xbt_automaton_load(property_automaton_, file);
 190 }
 191
 192 std::vector<int> LivenessChecker::automaton_propositional_symbol_evaluate() const
 193 {
 194   unsigned int cursor = 0;
 195   std::vector<int> values;
 196   xbt_automaton_propositional_symbol_t ps = nullptr;
 197   xbt_dynar_foreach (property_automaton_->propositional_symbols, cursor, ps)
 198     values.push_back(xbt_automaton_propositional_symbol_evaluate(ps));
 199   return values;
 200 }
 201
 202 std::vector<xbt_automaton_state_t> LivenessChecker::get_automaton_state() const
 203 {
 204   std::vector<xbt_automaton_state_t> automaton_stack;
 205   unsigned int cursor = 0;
 206   xbt_automaton_state_t automaton_state;
 207   xbt_dynar_foreach (property_automaton_->states, cursor, automaton_state)
 208     if (automaton_state->type == -1)
 209       automaton_stack.push_back(automaton_state);
 210   return automaton_stack;
 211 }
 212
 213 int LivenessChecker::compare_automaton_exp_label(const xbt_automaton_exp_label* l) const
 214 {
 215   unsigned int cursor                    = 0;
 216   xbt_automaton_propositional_symbol_t p = nullptr;
 217   xbt_dynar_foreach (property_automaton_->propositional_symbols, cursor, p) {
 218     if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
 219       return cursor;
 220   }
 221   return -1;
 222 }
 223
 224 void LivenessChecker::set_property_automaton(xbt_automaton_state_t const& automaton_state) const
 225 {
 226   property_automaton_->current_state = automaton_state;
 227 }
 228
 229 xbt_automaton_exp_label_t LivenessChecker::get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const
 230 {
 231   const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
 232   return transition->label;
 233 }
 234
 235 xbt_automaton_state_t LivenessChecker::get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const
 236 {
 237   const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
 238   return transition->dst;
 239 }
 240 void LivenessChecker::automaton_register_symbol(RemoteProcess& remote_process, const char* name, RemotePtr<int> address)
 241 {
 242   if (property_automaton_ == nullptr)
 243     property_automaton_ = xbt_automaton_new();
 244
 245   xbt::add_proposition(property_automaton_, name,
 246                        [&remote_process, address]() { return remote_process.read(address); });
 247 }
 248
 249 RecordTrace LivenessChecker::get_record_trace() // override
 250 {
 251   RecordTrace res;
 252   for (std::shared_ptr<Pair> const& pair : exploration_stack_)
 253     res.push_back(pair->app_state_->get_transition());
 254   return res;
 255 }
 256
 257 void LivenessChecker::log_state() // override
 258 {
 259   XBT_INFO("Expanded pairs = %lu", expanded_pairs_count_);
 260   XBT_INFO("Visited pairs = %lu", visited_pairs_count_);
 261   XBT_INFO("Executed transitions = %lu", Transition::get_executed_transitions());
 262   Exploration::log_state();
 263 }
 264
 265 void LivenessChecker::show_acceptance_cycle(std::size_t depth)
 266 {
 267   XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
 268   XBT_INFO("|             ACCEPTANCE CYCLE            |");
 269   XBT_INFO("*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*");
 270   XBT_INFO("Counter-example that violates formula:");
 271   for (auto const& s : this->get_textual_trace())
 272     XBT_INFO("  %s", s.c_str());
 273   XBT_INFO("Path = %s", get_record_trace().to_string().c_str());
 274   log_state();
 275   XBT_INFO("Counter-example depth: %zu", depth);
 276 }
 277
 278 std::vector<std::string> LivenessChecker::get_textual_trace() // override
 279 {
 280   std::vector<std::string> trace;
 281   for (std::shared_ptr<Pair> const& pair : exploration_stack_)
 282     trace.push_back(pair->app_state_->get_transition()->to_string());
 283
 284   return trace;
 285 }
 286
 287 std::shared_ptr<Pair> LivenessChecker::create_pair(const Pair* current_pair, xbt_automaton_state_t state,
 288                                                    std::shared_ptr<const std::vector<int>> propositions)
 289 {
 290   ++expanded_pairs_count_;
 291   auto next_pair                 = std::make_shared<Pair>(expanded_pairs_count_);
 292   next_pair->prop_state_         = state;
 293   next_pair->app_state_          = std::make_shared<State>(get_remote_app());
 294   next_pair->atomic_propositions = std::move(propositions);
 295   if (current_pair)
 296     next_pair->depth = current_pair->depth + 1;
 297   else
 298     next_pair->depth = 1;
 299   /* Add all enabled actors to the interleave set of the initial state */
 300   for (auto const& [aid, _] : next_pair->app_state_->get_actors_list())
 301     if (next_pair->app_state_->is_actor_enabled(aid))
 302       next_pair->app_state_->mark_todo(aid);
 303
 304   next_pair->requests = next_pair->app_state_->count_todo();
 305   /* FIXME : get search_cycle value for each accepting state */
 306   if (next_pair->prop_state_->type == 1 || (current_pair && current_pair->search_cycle))
 307     next_pair->search_cycle = true;
 308   else
 309     next_pair->search_cycle = false;
 310   return next_pair;
 311 }
 312
 313 void LivenessChecker::backtrack()
 314 {
 315   /* Traverse the stack backwards until a pair with a non empty interleave
 316      set is found, deleting all the pairs that have it empty in the way. */
 317   while (not exploration_stack_.empty()) {
 318     std::shared_ptr<simgrid::mc::Pair> current_pair = exploration_stack_.back();
 319     exploration_stack_.pop_back();
 320     if (current_pair->requests > 0) {
 321       /* We found a backtracking point */
 322       XBT_DEBUG("Backtracking to depth %d", current_pair->depth);
 323       exploration_stack_.push_back(std::move(current_pair));
 324       this->replay();
 325       XBT_DEBUG("Backtracking done");
 326       break;
 327     } else {
 328       XBT_DEBUG("Delete pair %d at depth %d", current_pair->num, current_pair->depth);
 329       if (current_pair->prop_state_->type == 1)
 330         this->remove_acceptance_pair(current_pair->num);
 331     }
 332   }
 333 }
 334
 335 void LivenessChecker::run()
 336 {
 337   XBT_INFO("Check the liveness property %s", _sg_mc_property_file.get().c_str());
 338   automaton_load(_sg_mc_property_file.get().c_str());
 339
 340   XBT_DEBUG("Starting the liveness algorithm");
 341
 342   /* Initialize */
 343   this->previous_pair_ = 0;
 344
 345   std::shared_ptr<const std::vector<int>> propos = this->get_proposition_values();
 346
 347   // For each initial state of the property automaton, push a
 348   // (application_state, automaton_state) pair to the exploration stack:
 349   auto automaton_stack = get_automaton_state();
 350   for (auto* automaton_state : automaton_stack) {
 351     if (automaton_state->type == -1)
 352       exploration_stack_.push_back(this->create_pair(nullptr, automaton_state, propos));
 353   }
 354
 355   /* Actually run the double DFS search for counter-examples */
 356   while (not exploration_stack_.empty()) {
 357     std::shared_ptr<Pair> current_pair = exploration_stack_.back();
 358
 359     /* Update current state in buchi automaton */
 360     set_property_automaton(current_pair->prop_state_);
 361
 362     XBT_DEBUG(
 363         "********************* ( Depth = %d, search_cycle = %d, interleave size = %zu, pair_num = %d, requests = %d)",
 364         current_pair->depth, current_pair->search_cycle, current_pair->app_state_->count_todo(), current_pair->num,
 365         current_pair->requests);
 366
 367     if (current_pair->requests == 0) {
 368       this->backtrack();
 369       continue;
 370     }
 371
 372     std::shared_ptr<VisitedPair> reached_pair;
 373     if (current_pair->prop_state_->type == 1 && not current_pair->exploration_started) {
 374       reached_pair = this->insert_acceptance_pair(current_pair.get());
 375       if (reached_pair == nullptr) {
 376         this->show_acceptance_cycle(current_pair->depth);
 377         throw LivenessError();
 378       }
 379     }
 380
 381     /* Pair already visited ? stop the exploration on the current path */
 382     if (not current_pair->exploration_started) {
 383       int visited_num = this->insert_visited_pair(reached_pair, current_pair.get());
 384       if (visited_num != -1) {
 385         mc_model_checker->dot_output("\"%d\" -> \"%d\" [%s];\n", this->previous_pair_, visited_num,
 386                                      this->previous_request_.c_str());
 387         mc_model_checker->dot_output_flush();
 388
 389         XBT_DEBUG("Pair already visited (equal to pair %d), exploration on the current path stopped.", visited_num);
 390         current_pair->requests = 0;
 391         this->backtrack();
 392         continue;
 393       }
 394     }
 395
 396     current_pair->app_state_->execute_next(current_pair->app_state_->next_transition());
 397     XBT_DEBUG("Execute: %s", current_pair->app_state_->get_transition()->to_string().c_str());
 398
 399     /* Update the dot output */
 400     if (this->previous_pair_ != 0 && this->previous_pair_ != current_pair->num) {
 401       mc_model_checker->dot_output("\"%d\" -> \"%d\" [%s];\n", this->previous_pair_, current_pair->num,
 402                                    this->previous_request_.c_str());
 403       this->previous_request_.clear();
 404     }
 405     this->previous_pair_    = current_pair->num;
 406     this->previous_request_ = current_pair->app_state_->get_transition()->dot_string();
 407     if (current_pair->search_cycle)
 408       mc_model_checker->dot_output("%d [shape=doublecircle];\n", current_pair->num);
 409     mc_model_checker->dot_output_flush();
 410
 411     if (not current_pair->exploration_started)
 412       visited_pairs_count_++;
 413
 414     current_pair->requests--;
 415     current_pair->exploration_started = true;
 416
 417     /* Get values of atomic propositions (variables used in the property formula) */
 418     std::shared_ptr<const std::vector<int>> prop_values = this->get_proposition_values();
 419
 420     // For each enabled transition in the property automaton, push a
 421     // (application_state, automaton_state) pair to the exploration stack:
 422     for (int i = xbt_dynar_length(current_pair->prop_state_->out) - 1; i >= 0; i--) {
 423       const auto* transition_succ_label = get_automaton_transition_label(current_pair->prop_state_->out, i);
 424       auto* transition_succ_dst         = get_automaton_transition_dst(current_pair->prop_state_->out, i);
 425       if (evaluate_label(transition_succ_label, *prop_values))
 426         exploration_stack_.push_back(this->create_pair(current_pair.get(), transition_succ_dst, prop_values));
 427     }
 428   }
 429
 430   XBT_INFO("No property violation found.");
 431   log_state();
 432 }
 433
 434 Exploration* create_liveness_checker(const std::vector<char*>& args)
 435 {
 436   return new LivenessChecker(args);
 437 }
 438
 439 } // namespace simgrid::mc