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