Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
1631cd2ec57ac2183ec7f941c4a6d9b70876a3a8
[simgrid.git] / 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 kernel::actor::Simcall* req = &actor->simcall_;
53       if (req->call_ != kernel::actor::Simcall::Type::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& [_, actor] : engine->get_actor_list()) {
60     // Only visible requests remain at this point, and they all have an observer
61     actor->simcall_.mc_max_consider_ = actor->simcall_.observer_->get_max_consider();
62
63     engine->add_actor_to_dynar(actor);
64   }
65 #endif
66 }
67
68 /** @brief returns if there this transition can proceed in a finite amount of time
69  *
70  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
71  *
72  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
73  * Wait operations are OK and return true in only two situations:
74  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
75  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this
76  * transition for ever.
77  * This is controlled in the is_enabled() method of the corresponding observers.
78  */
79 // Called from both MCer and MCed:
80 bool actor_is_enabled(kernel::actor::ActorImpl* actor)
81 {
82 #if SIMGRID_HAVE_MC
83   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
84 #endif
85
86   // Now, we are in the client app, no need for remote memory reading.
87   kernel::actor::Simcall* req = &actor->simcall_;
88
89   if (req->observer_ != nullptr)
90     return req->observer_->is_enabled();
91
92   if (req->call_ == kernel::actor::Simcall::Type::NONE)
93     return false;
94   else
95     /* The rest of the requests are always enabled */
96     return true;
97 }
98
99 /* This is the list of requests that are visible from the checker algorithm.
100  * Any other requests are handled right away on the application side.
101  */
102 bool request_is_visible(const kernel::actor::Simcall* req)
103 {
104 #if SIMGRID_HAVE_MC
105   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
106 #endif
107   if (req->observer_ != nullptr)
108     return req->observer_->is_visible();
109   else
110     return false;
111 }
112
113 } // namespace mc
114 } // namespace simgrid