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
  44   while (engine->has_actors_to_run()) {
  45     engine->run_all_actors();
  46     for (auto const& actor : engine->get_actors_that_ran()) {
  47       const kernel::actor::Simcall* req = &actor->simcall_;
  48       if (req->call_ != kernel::actor::Simcall::Type::NONE && not simgrid::mc::request_is_visible(req))
  49         actor->simcall_handle(0);
  50     }
  51   }
  52 }
  53
  54 /** @brief returns if there this transition can proceed in a finite amount of time
  55  *
  56  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
  57  *
  58  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
  59  * Wait operations are OK and return true in only two situations:
  60  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
  61  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this
  62  * transition for ever.
  63  * This is controlled in the is_enabled() method of the corresponding observers.
  64  */
  65 // Called from both MCer and MCed:
  66 bool actor_is_enabled(kernel::actor::ActorImpl* actor)
  67 {
  68 #if SIMGRID_HAVE_MC
  69   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
  70 #endif
  71
  72   // Now, we are in the client app, no need for remote memory reading.
  73   kernel::actor::Simcall* req = &actor->simcall_;
  74
  75   if (req->observer_ != nullptr)
  76     return req->observer_->is_enabled();
  77
  78   if (req->call_ == kernel::actor::Simcall::Type::NONE)
  79     return false;
  80   else
  81     /* The rest of the requests are always enabled */
  82     return true;
  83 }
  84
  85 /* This is the list of requests that are visible from the checker algorithm.
  86  * Any other requests are handled right away on the application side.
  87  */
  88 bool request_is_visible(const kernel::actor::Simcall* req)
  89 {
  90 #if SIMGRID_HAVE_MC
  91   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
  92 #endif
  93   if (req->observer_ != nullptr)
  94     return req->observer_->is_visible();
  95   else
  96     return false;
  97 }
  98
  99 } // namespace simgrid::mc