src/mc/mc_base.cpp

   1 /* Copyright (c) 2008-2023. 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 "src/kernel/EngineImpl.hpp"
   8 #include "src/kernel/activity/CommImpl.hpp"
   9 #include "src/kernel/activity/MutexImpl.hpp"
  10 #include "src/kernel/actor/SimcallObserver.hpp"
  11 #include "src/mc/mc.h"
  12 #include "src/mc/mc_config.hpp"
  13 #include "src/mc/mc_replay.hpp"
  14
  15 #if SIMGRID_HAVE_MC
  16 #include "src/mc/api/RemoteApp.hpp"
  17 #include "src/mc/remote/AppSide.hpp"
  18 #include "src/mc/sosp/RemoteProcessMemory.hpp"
  19 #endif
  20
  21 XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
  22 bool simgrid_mc_replay_show_backtraces = false;
  23
  24 namespace simgrid::mc {
  25
  26 void execute_actors()
  27 {
  28   auto* engine = kernel::EngineImpl::get_instance();
  29
  30   XBT_DEBUG("execute_actors: %lu of %zu to run (%s)", engine->get_actor_to_run_count(), engine->get_actor_count(),
  31             (MC_record_replay_is_active() ? "replay active" : "no replay"));
  32   while (engine->has_actors_to_run()) {
  33     engine->run_all_actors();
  34     for (auto const& actor : engine->get_actors_that_ran()) {
  35       const kernel::actor::Simcall* req = &actor->simcall_;
  36       if (req->call_ != kernel::actor::Simcall::Type::NONE && not simgrid::mc::request_is_visible(req))
  37         actor->simcall_handle(0);
  38     }
  39   }
  40 }
  41
  42 /** @brief returns if there this transition can proceed in a finite amount of time
  43  *
  44  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
  45  *
  46  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
  47  * Wait operations are OK and return true in only two situations:
  48  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
  49  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this
  50  * transition for ever.
  51  * This is controlled in the is_enabled() method of the corresponding observers.
  52  */
  53 bool actor_is_enabled(kernel::actor::ActorImpl* actor)
  54 {
  55 #if SIMGRID_HAVE_MC
  56   xbt_assert(simgrid::mc::model_checking_mode != simgrid::mc::ModelCheckingMode::CHECKER_SIDE,
  57              "This should be called from the client side");
  58 #endif
  59
  60   // Now, we are in the client app, no need for remote memory reading.
  61   kernel::actor::Simcall* req = &actor->simcall_;
  62
  63   if (req->observer_ != nullptr)
  64     return req->observer_->is_enabled();
  65
  66   if (req->call_ == kernel::actor::Simcall::Type::NONE)
  67     return false;
  68   else
  69     /* The rest of the requests are always enabled */
  70     return true;
  71 }
  72
  73 /* This is the list of requests that are visible from the checker algorithm.
  74  * Any other requests are handled right away on the application side.
  75  */
  76 bool request_is_visible(const kernel::actor::Simcall* req)
  77 {
  78 #if SIMGRID_HAVE_MC
  79   xbt_assert(simgrid::mc::model_checking_mode != simgrid::mc::ModelCheckingMode::CHECKER_SIDE,
  80              "This should be called from the client side");
  81 #endif
  82   if (req->observer_ == nullptr)
  83     return false;
  84   return req->observer_->is_visible();
  85 }
  86
  87 } // namespace simgrid::mc