src/mc/checker/LivenessChecker.cpp

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