src/mc/checker/LivenessChecker.cpp

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