src/mc/explo/LivenessChecker.cpp

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