Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Redundant initializations.
[simgrid.git] / src / kernel / EngineImpl.hpp
1 /* Copyright (c) 2016-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 #ifndef SIMGRID_KERNEL_ENGINEIMPL_HPP
7 #define SIMGRID_KERNEL_ENGINEIMPL_HPP
8
9 #include <simgrid/kernel/resource/Model.hpp>
10 #include <simgrid/s4u/Engine.hpp>
11 #include <simgrid/s4u/NetZone.hpp>
12 #include <simgrid/simix.hpp>
13 #include <xbt/dynar.h>
14 #include <xbt/functional.hpp>
15
16 #include "src/kernel/activity/ExecImpl.hpp"
17 #include "src/kernel/activity/IoImpl.hpp"
18 #include "src/kernel/activity/MailboxImpl.hpp"
19 #include "src/kernel/activity/SleepImpl.hpp"
20 #include "src/kernel/activity/Synchro.hpp"
21 #include "src/kernel/actor/ActorImpl.hpp"
22 #include "src/kernel/resource/SplitDuplexLinkImpl.hpp"
23
24 #include <boost/intrusive/list.hpp>
25 #include <map>
26 #include <mutex>
27 #include <set>
28 #include <string>
29 #include <unordered_map>
30 #include <vector>
31
32 namespace simgrid::kernel {
33
34 class EngineImpl {
35   std::unordered_map<std::string, routing::NetPoint*> netpoints_;
36   std::unordered_map<std::string, activity::MailboxImpl*> mailboxes_;
37
38   std::unordered_map<std::string, actor::ActorCodeFactory> registered_functions; // Maps function names to actor code
39   actor::ActorCodeFactory default_function; // Function to use as a fallback when the provided name matches nothing
40   std::vector<resource::Model*> models_;
41   std::unordered_map<std::string, std::shared_ptr<resource::Model>> models_prio_;
42   routing::NetZoneImpl* netzone_root_ = nullptr;
43   std::set<actor::ActorImpl*> daemons_;
44   std::vector<actor::ActorImpl*> actors_to_run_;
45   std::vector<actor::ActorImpl*> actors_that_ran_;
46   std::map<aid_t, actor::ActorImpl*> actor_list_;
47   boost::intrusive::list<actor::ActorImpl,
48                          boost::intrusive::member_hook<actor::ActorImpl, boost::intrusive::list_member_hook<>,
49                                                        &actor::ActorImpl::kernel_destroy_list_hook>>
50       actors_to_destroy_;
51 #if SIMGRID_HAVE_MC
52   /* MCer cannot read members actor_list_ above in the remote process, so we copy the info it needs in a dynar.
53    * FIXME: This is supposed to be a temporary hack.
54    * A better solution would be to change the split between MCer and MCed, where the responsibility
55    *   to compute the list of the enabled transitions goes to the MCed.
56    * That way, the MCer would not need to have the list of actors on its side.
57    * These info could be published by the MCed to the MCer in a way inspired of vd.so
58    */
59   xbt_dynar_t actors_vector_      = xbt_dynar_new(sizeof(actor::ActorImpl*), nullptr);
60 #endif
61
62   static double now_;
63   static EngineImpl* instance_;
64   actor::ActorImpl* maestro_ = nullptr;
65   context::ContextFactory* context_factory_ = nullptr;
66
67   std::unique_ptr<void, std::function<int(void*)>> platf_handle_; //!< handle for platform library
68   friend s4u::Engine;
69
70 public:
71   EngineImpl() = default;
72
73   /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
74 #ifndef DOXYGEN
75   EngineImpl(const EngineImpl&) = delete;
76   EngineImpl& operator=(const EngineImpl&) = delete;
77   virtual ~EngineImpl();
78   static void shutdown();
79 #endif
80
81   void initialize(int* argc, char** argv);
82   void load_platform(const std::string& platf);
83   void load_deployment(const std::string& file) const;
84   void seal_platform() const;
85   void register_function(const std::string& name, const actor::ActorCodeFactory& code);
86   void register_default(const actor::ActorCodeFactory& code);
87
88   bool is_maestro(const actor::ActorImpl* actor) const { return actor == maestro_; }
89   void set_maestro(actor::ActorImpl* actor) { maestro_ = actor; }
90   actor::ActorImpl* get_maestro() const { return maestro_; }
91
92   context::ContextFactory* get_context_factory() const { return context_factory_; }
93   void set_context_factory(context::ContextFactory* factory) { context_factory_ = factory; }
94   bool has_context_factory() const { return context_factory_ != nullptr; }
95
96   void context_mod_init() const;
97   /**
98    * @brief Add a model to engine list
99    *
100    * @param model Pointer to model
101    * @param list  List of dependencies for this model
102    */
103   void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
104                  const std::vector<resource::Model*>& dep_models = {});
105
106   /** @brief Get list of all models managed by this engine */
107   const std::vector<resource::Model*>& get_all_models() const { return models_; }
108
109   static bool has_instance() { return s4u::Engine::has_instance(); }
110   static EngineImpl* get_instance() { return s4u::Engine::get_instance()->pimpl; }
111   static EngineImpl* get_instance(int* argc, char** argv) { return s4u::Engine::get_instance(argc, argv)->pimpl; }
112
113   actor::ActorCodeFactory get_function(const std::string& name)
114   {
115     auto res = registered_functions.find(name);
116     if (res == registered_functions.end())
117       return default_function;
118     else
119       return res->second;
120   }
121
122   routing::NetZoneImpl* get_netzone_root() const { return netzone_root_; }
123
124   void add_daemon(actor::ActorImpl* d) { daemons_.insert(d); }
125   void remove_daemon(actor::ActorImpl* d);
126   void add_actor_to_run_list(actor::ActorImpl* actor);
127   void add_actor_to_run_list_no_check(actor::ActorImpl* actor);
128   void add_actor_to_destroy_list(actor::ActorImpl& actor) { actors_to_destroy_.push_back(actor); }
129
130   bool has_actors_to_run() const { return not actors_to_run_.empty(); }
131   const actor::ActorImpl* get_first_actor_to_run() const { return actors_to_run_.front(); }
132   const actor::ActorImpl* get_actor_to_run_at(unsigned long int i) const { return actors_to_run_[i]; }
133   unsigned long int get_actor_to_run_count() const { return actors_to_run_.size(); }
134   size_t get_actor_count() const { return actor_list_.size(); }
135   actor::ActorImpl* get_actor_by_pid(aid_t pid);
136   void add_actor(aid_t pid, actor::ActorImpl* actor) { actor_list_[pid] = actor; }
137   void remove_actor(aid_t pid) { actor_list_.erase(pid); }
138
139 #if SIMGRID_HAVE_MC
140   void reset_actor_dynar() { xbt_dynar_reset(actors_vector_); }
141   void add_actor_to_dynar(actor::ActorImpl* actor) { xbt_dynar_push_as(actors_vector_, actor::ActorImpl*, actor); }
142 #endif
143
144   const std::map<aid_t, actor::ActorImpl*>& get_actor_list() const { return actor_list_; }
145   const std::vector<actor::ActorImpl*>& get_actors_to_run() const { return actors_to_run_; }
146   const std::vector<actor::ActorImpl*>& get_actors_that_ran() const { return actors_that_ran_; }
147
148   void handle_ended_actions() const;
149   /**
150    * Garbage collection
151    *
152    * Should be called some time to time to free the memory allocated for actors that have finished (or killed).
153    */
154   void empty_trash();
155   void display_all_actor_status() const;
156   void run_all_actors();
157
158   /*  @brief Finish simulation initialization
159    *  This function must be called before the first call to solve()
160    */
161   void presolve() const;
162   /** @brief Performs a part of the simulation
163    *  @param max_date Maximum date to update the simulation to, or -1
164    *  @return the elapsed time, or -1.0 if no event could be executed
165    *
166    *  This function execute all possible events, update the action states  and returns the time elapsed.
167    *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
168    *  when you call solve().
169    *  Note that the returned elapsed time can be zero.
170    */
171   double solve(double max_date) const;
172
173   /** @brief Run the main simulation loop until the specified date (or infinitly if max_date is negative). */
174   void run(double max_date);
175
176   /** @brief Return the current time in milliseconds. */
177   static double get_clock();
178 };
179
180 } // namespace simgrid::kernel
181
182 #endif