1 /* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_ENGINE_HPP
7 #define SIMGRID_S4U_ENGINE_HPP
11 #include <simgrid/forward.h>
13 #include <simgrid/kernel/resource/Model.hpp>
14 #include <simgrid/s4u/NetZone.hpp>
22 /** @brief Simulation engine
24 * This is a singleton containing all the main functions of the simulation.
26 class XBT_PUBLIC Engine {
27 friend simgrid::kernel::EngineImpl;
30 /** Constructor, taking the command line parameters of your main function */
31 explicit Engine(int* argc, char** argv);
32 /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
34 Engine(const Engine&) = delete;
35 Engine(Engine&&) = delete;
39 /** Finalize the default engine and all its dependencies */
40 static void shutdown();
42 /** Run the simulation after initialization */
45 /** @brief Retrieve the simulation time (in seconds) */
46 static double get_clock();
47 /** @brief Retrieve the engine singleton */
48 static s4u::Engine* get_instance();
50 void load_platform(const std::string& platf) const;
53 XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_function(
54 const std::string& name, int (*code)(int, char**));
55 XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_default(
56 int (*code)(int, char**));
59 void register_function(const std::string& name, const std::function<void(int, char**)>& code);
60 void register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code);
61 void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory);
63 void register_default(const std::function<void(int, char**)>& code);
64 void register_default(const kernel::actor::ActorCodeFactory& factory);
66 template <class F> void register_actor(const std::string& name)
68 kernel::actor::ActorCodeFactory code_factory = [](std::vector<std::string> args) {
69 return kernel::actor::ActorCode([args = std::move(args)]() mutable {
70 F code(std::move(args));
74 register_function(name, code_factory);
76 template <class F> void register_actor(const std::string& name, F code)
78 kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
79 return kernel::actor::ActorCode([code, args = std::move(args)]() mutable { code(std::move(args)); });
81 register_function(name, code_factory);
84 void load_deployment(const std::string& deploy) const;
88 friend surf::HostImpl;
92 friend kernel::routing::NetPoint;
93 friend kernel::routing::NetZoneImpl;
94 friend kernel::resource::LinkImpl;
95 void host_register(const std::string& name, Host* host);
96 void host_unregister(const std::string& name);
97 void link_register(const std::string& name, const Link* link);
98 void link_unregister(const std::string& name);
99 void netpoint_register(simgrid::kernel::routing::NetPoint* card);
100 void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
104 /** Returns the amount of hosts existing in the platform. */
105 size_t get_host_count() const;
106 /** Returns a vector of all hosts found in the platform.
108 * The order is generally different from the creation/declaration order in the XML platform because we use a hash
111 std::vector<Host*> get_all_hosts() const;
112 std::vector<Host*> get_filtered_hosts(const std::function<bool(Host*)>& filter) const;
113 Host* host_by_name(const std::string& name) const;
114 Host* host_by_name_or_null(const std::string& name) const;
116 size_t get_link_count() const;
117 std::vector<Link*> get_all_links() const;
118 std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter) const;
119 Link* link_by_name(const std::string& name) const;
120 Link* link_by_name_or_null(const std::string& name) const;
122 size_t get_actor_count() const;
123 std::vector<ActorPtr> get_all_actors() const;
124 std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const;
126 std::vector<kernel::routing::NetPoint*> get_all_netpoints() const;
127 kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name) const;
129 * @brief Get netpoint by its name
131 * @param name Netpoint name
132 * @throw std::invalid_argument if netpoint doesn't exist
134 kernel::routing::NetPoint* netpoint_by_name(const std::string& name) const;
136 NetZone* get_netzone_root() const;
137 void set_netzone_root(const NetZone* netzone);
139 NetZone* netzone_by_name_or_null(const std::string& name) const;
142 * @brief Add a model to engine list
144 * @param model Pointer to model
145 * @param list List of dependencies for this model (optional)
147 void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
148 const std::vector<kernel::resource::Model*>& dependencies = {});
150 /** @brief Get list of all models managed by this engine */
151 const std::vector<simgrid::kernel::resource::Model*>& get_all_models() const;
153 /** @brief Retrieves all netzones of the type indicated by the template argument */
154 template <class T> std::vector<T*> get_filtered_netzones() const
156 static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
157 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
159 get_filtered_netzones_recursive(get_netzone_root(), &res);
163 /** Returns whether SimGrid was initialized yet -- mostly for internal use */
164 static bool is_initialized();
165 /** @brief set a configuration variable
168 * Do --help on any simgrid binary to see the list of currently existing configuration variables
169 * (see also :ref:`options`).
173 * simgrid::s4u::Engine::set_config("host/model:ptask_L07");
175 static void set_config(const std::string& str);
176 static void set_config(const std::string& name, int value);
177 static void set_config(const std::string& name, bool value);
178 static void set_config(const std::string& name, double value);
179 static void set_config(const std::string& name, const std::string& value);
181 /** Callback fired when the platform is created (ie, the xml file parsed),
182 * right before the actual simulation starts. */
183 static xbt::signal<void()> on_platform_created;
185 /** Callback fired when the platform is about to be created
186 * (ie, after any configuration change and just before the resource creation) */
187 static xbt::signal<void()> on_platform_creation;
189 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
190 static xbt::signal<void()> on_simulation_end;
192 /** Callback fired when the time jumps into the future */
193 static xbt::signal<void(double)> on_time_advance;
195 /** Callback fired when the time cannot advance because of inter-actors deadlock. Note that the on_exit of each actor
196 * is also executed on deadlock. */
197 static xbt::signal<void(void)> on_deadlock;
200 kernel::EngineImpl* const pimpl;
201 static Engine* instance_;
204 #ifndef DOXYGEN /* Internal use only, no need to expose it */
206 XBT_PRIVATE void get_filtered_netzones_recursive(const s4u::NetZone* current, std::vector<T*>* whereto)
208 static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
209 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
210 for (auto const& elem : current->get_children()) {
211 get_filtered_netzones_recursive(elem, whereto);
212 auto* elem_impl = dynamic_cast<T*>(elem->get_impl());
213 if (elem_impl != nullptr)
214 whereto->push_back(elem_impl);
219 } // namespace simgrid
221 #endif /* SIMGRID_S4U_ENGINE_HPP */