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