src/mc/mc_base.cpp

   1 /* Copyright (c) 2008-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/mc_base.hpp"
   7 #include "mc/mc.h"
   8 #include "src/kernel/EngineImpl.hpp"
   9 #include "src/kernel/activity/CommImpl.hpp"
  10 #include "src/kernel/activity/MutexImpl.hpp"
  11 #include "src/kernel/actor/SimcallObserver.hpp"
  12 #include "src/mc/mc_config.hpp"
  13 #include "src/mc/mc_replay.hpp"
  14
  15 #include "xbt/random.hpp"
  16
  17 #if SIMGRID_HAVE_MC
  18 #include "src/mc/ModelChecker.hpp"
  19 #include "src/mc/Session.hpp"
  20 #include "src/mc/remote/RemoteProcess.hpp"
  21 #endif
  22
  23 XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
  24
  25 int MC_random(int min, int max)
  26 {
  27 #if SIMGRID_HAVE_MC
  28   xbt_assert(mc_model_checker == nullptr);
  29 #endif
  30   if (not MC_is_active() && not MC_record_replay_is_active()) { // no need to do a simcall in this case
  31     static simgrid::xbt::random::XbtRandom prng;
  32     return prng.uniform_int(min, max);
  33   }
  34   simgrid::kernel::actor::RandomSimcall observer{simgrid::kernel::actor::ActorImpl::self(), min, max};
  35   return simgrid::kernel::actor::simcall_answered([&observer] { return observer.get_value(); }, &observer);
  36 }
  37
  38 namespace simgrid::mc {
  39
  40 void execute_actors()
  41 {
  42   auto* engine = kernel::EngineImpl::get_instance();
  43 #if SIMGRID_HAVE_MC
  44   xbt_assert(mc_model_checker == nullptr, "This must be called from the client");
  45 #endif
  46   while (engine->has_actors_to_run()) {
  47     engine->run_all_actors();
  48     for (auto const& actor : engine->get_actors_that_ran()) {
  49       const kernel::actor::Simcall* req = &actor->simcall_;
  50       if (req->call_ != kernel::actor::Simcall::Type::NONE && not simgrid::mc::request_is_visible(req))
  51         actor->simcall_handle(0);
  52     }
  53   }
  54 #if SIMGRID_HAVE_MC
  55   engine->reset_actor_dynar();
  56   for (auto const& [_, actor] : engine->get_actor_list()) {
  57     // Only visible requests remain at this point, and they all have an observer
  58     actor->simcall_.mc_max_consider_ = actor->simcall_.observer_->get_max_consider();
  59
  60     engine->add_actor_to_dynar(actor);
  61   }
  62 #endif
  63 }
  64
  65 /** @brief returns if there this transition can proceed in a finite amount of time
  66  *
  67  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
  68  *
  69  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
  70  * Wait operations are OK and return true in only two situations:
  71  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
  72  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this
  73  * transition for ever.
  74  * This is controlled in the is_enabled() method of the corresponding observers.
  75  */
  76 // Called from both MCer and MCed:
  77 bool actor_is_enabled(kernel::actor::ActorImpl* actor)
  78 {
  79 #if SIMGRID_HAVE_MC
  80   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
  81 #endif
  82
  83   // Now, we are in the client app, no need for remote memory reading.
  84   kernel::actor::Simcall* req = &actor->simcall_;
  85
  86   if (req->observer_ != nullptr)
  87     return req->observer_->is_enabled();
  88
  89   if (req->call_ == kernel::actor::Simcall::Type::NONE)
  90     return false;
  91   else
  92     /* The rest of the requests are always enabled */
  93     return true;
  94 }
  95
  96 /* This is the list of requests that are visible from the checker algorithm.
  97  * Any other requests are handled right away on the application side.
  98  */
  99 bool request_is_visible(const kernel::actor::Simcall* req)
 100 {
 101 #if SIMGRID_HAVE_MC
 102   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
 103 #endif
 104   if (req->observer_ != nullptr)
 105     return req->observer_->is_visible();
 106   else
 107     return false;
 108 }
 109
 110 } // namespace simgrid::mc