src/mc/checker/LivenessChecker.cpp

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