1 /* Copyright (c) 2006-2019. 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
14 #include <xbt/functional.hpp>
16 #include <simgrid/forward.h>
17 #include <simgrid/simix.hpp>
19 #include <simgrid/s4u/NetZone.hpp>
23 /** @brief Simulation engine
25 * This class is an interface to the simulation engine.
27 class XBT_PUBLIC Engine {
29 /** Constructor, taking the command line parameters of your main function */
30 explicit Engine(int* argc, char** argv);
31 /** Currently, only one instance is allowed to exist. This is why you can't copy or move it */
32 Engine(const Engine&) = delete;
33 Engine(Engine&&) = delete;
36 /** Finalize the default engine and all its dependencies */
37 static void shutdown();
39 /** @brief Run the simulation */
42 /** @brief Retrieve the simulation time (in seconds) */
43 static double get_clock();
44 /** @brief Retrieve the engine singleton */
45 static s4u::Engine* get_instance();
47 /** @brief Load a platform file describing the environment
49 * The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
50 * Some examples can be found in the directory examples/platforms.
52 void load_platform(const std::string& platf);
54 /** Registers the main function of an actor that will be launched from the deployment file */
55 void register_function(const std::string& name, int (*code)(int, char**));
56 /** Registers the main function of an actor that will be launched from the deployment file */
57 void register_function(const std::string& name, void (*code)(std::vector<std::string>));
59 /** Registers a function as the default main function of actors
61 * It will be used as fallback when the function requested from the deployment file was not registered.
62 * It is used for trace-based simulations (see examples/s4u/replay-comms and similar).
64 void register_default(int (*code)(int, char**));
66 template <class F> void register_actor(const std::string& name)
68 simix::register_function(name, [](std::vector<std::string> args) {
69 return simix::ActorCode([args] {
70 F code(std::move(args));
76 template <class F> void register_actor(const std::string& name, F code)
78 simix::register_function(name, [code](std::vector<std::string> args) {
79 return simix::ActorCode([code, args] { code(std::move(args)); });
83 /** @brief Load a deployment file and launch the actors that it contains */
84 void load_deployment(const std::string& deploy);
91 friend kernel::routing::NetPoint;
92 friend kernel::routing::NetZoneImpl;
93 friend kernel::resource::LinkImpl;
94 void host_register(const std::string& name, Host* host);
95 void host_unregister(const std::string& name);
96 void link_register(const std::string& name, Link* link);
97 void link_unregister(const std::string& name);
98 void storage_register(const std::string& name, Storage* storage);
99 void storage_unregister(const std::string& name);
100 void netpoint_register(simgrid::kernel::routing::NetPoint* card);
101 void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
105 size_t get_host_count();
106 /** @brief Returns the list of all hosts found in the platform */
107 std::vector<Host*> get_all_hosts();
108 std::vector<Host*> get_filtered_hosts(const std::function<bool(Host*)>& filter);
109 Host* host_by_name(const std::string& name);
110 Host* host_by_name_or_null(const std::string& name);
112 size_t get_link_count();
113 std::vector<Link*> get_all_links();
114 std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter);
115 Link* link_by_name(const std::string& name);
116 Link* link_by_name_or_null(const std::string& name);
118 size_t get_actor_count();
119 std::vector<ActorPtr> get_all_actors();
120 std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter);
122 size_t get_storage_count();
123 std::vector<Storage*> get_all_storages();
124 Storage* storage_by_name(const std::string& name);
125 Storage* storage_by_name_or_null(const std::string& name);
127 std::vector<kernel::routing::NetPoint*> get_all_netpoints();
128 kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name);
130 NetZone* get_netzone_root();
131 void set_netzone_root(NetZone* netzone);
133 NetZone* netzone_by_name_or_null(const std::string& name);
135 /** @brief Retrieves all netzones of the type indicated by the template argument */
136 template <class T> std::vector<T*> get_filtered_netzones()
138 static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
139 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
141 get_filtered_netzones_recursive(get_netzone_root(), &res);
145 /** Returns whether SimGrid was initialized yet -- mostly for internal use */
146 static bool is_initialized();
147 /** @brief set a configuration variable
149 * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
153 * e->set_config("host/model:ptask_L07");
155 void set_config(const std::string& str);
158 kernel::EngineImpl* const pimpl;
159 static Engine* instance_;
161 //////////////// Deprecated functions
164 /** @deprecated See Engine::load_platform() */
165 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const std::string& platf)
167 load_platform(platf);
169 /** @deprecated See Engine::register_function() */
170 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(const std::string& name,
171 int (*code)(int, char**))
173 register_function(name, code);
175 /** @deprecated See Engine::register_default() */
176 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**))
178 register_default(code);
180 /** @deprecated See Engine::register_actor() */
182 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const std::string& name)
184 register_actor<F>(name);
186 /** @deprecated See Engine::register_actor() */
188 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const std::string& name,
191 register_actor<F>(name, code);
194 /** @deprecated See Engine::load_deployment() */
195 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const std::string& deploy)
197 load_deployment(deploy);
199 /** @deprecated See Engine::host_by_name() */
200 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(
201 const std::string& name)
203 return host_by_name(name);
205 /** @deprecated See Engine::host_by_name_or_null() */
206 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
207 const std::string& name)
209 return host_by_name_or_null(name);
211 /** @deprecated See Engine::storage_by_name() */
212 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
213 const std::string& name)
215 return storage_by_name(name);
217 /** @deprecated See Engine::storage_by_name_or_null() */
218 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
219 const std::string& name)
221 return storage_by_name_or_null(name);
224 /** @deprecated See Engine::get_host_count() */
225 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
226 /** @deprecated See Engine::get_all_hosts() */
227 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
229 return get_all_hosts();
231 /** @deprecated See Engine::get_link_count() */
232 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); }
233 /** @deprecated See Engine::get_link_list() */
234 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector<Link*> getAllLinks()
236 return get_all_links();
238 /** @deprecated See Engine::get_all_storages() */
239 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector<Storage*> getAllStorages()
241 return get_all_storages();
243 /** @deprecated See Engine::get_clock() */
244 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
245 /** @deprecated See Engine::get_all_netpoints() */
246 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList(
247 std::vector<simgrid::kernel::routing::NetPoint*>* list);
248 /** @deprecated See Engine::netpoint_by_name_or_null() */
249 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()")
250 simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(const std::string& name)
252 return netpoint_by_name_or_null(name);
254 /** @deprecated See Engine::get_netzone_root() */
255 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_netzone_root()") simgrid::s4u::NetZone* getNetRoot()
257 return get_netzone_root();
259 /** @deprecated See Engine::netzone_by_name_or_null() */
260 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netzone_by_name_or_null()")
261 simgrid::s4u::NetZone* getNetzoneByNameOrNull(const std::string& name)
263 return netzone_by_name_or_null(name);
265 /** @deprecated See Engine::filter_netzones_by_type() */
267 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::filter_netzones_by_type()") void getNetzoneByType(
268 std::vector<T*>* whereto)
270 get_filtered_netzones_recursive(get_netzone_root(), whereto);
273 /** @deprecated See Engine::get_instance() */
274 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance()
276 return get_instance();
278 /** @deprecated See Engine::is_initialized() */
279 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized()
281 return is_initialized();
283 /** @deprecated See Engine::set_config() */
284 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(const std::string& str)
291 /** Callback fired when the platform is created (ie, the xml file parsed),
292 * right before the actual simulation starts. */
293 extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
295 /** Callback fired when the platform is about to be created
296 * (ie, after any configuration change and just before the resource creation) */
297 extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
299 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
300 extern XBT_PUBLIC xbt::signal<void()> on_simulation_end;
302 /** Callback fired when the time jumps into the future */
303 extern XBT_PUBLIC xbt::signal<void(double)> on_time_advance;
305 /** Callback fired when the time cannot advance because of inter-actors deadlock */
306 extern XBT_PUBLIC xbt::signal<void(void)> on_deadlock;
308 #ifndef DOXYGEN /* Internal use only, no need to expose it */
309 template <class T> XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector<T*>* whereto)
311 static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
312 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
313 for (auto const& elem : current->get_children()) {
314 get_filtered_netzones_recursive(elem, whereto);
315 T* elem_impl = dynamic_cast<T*>(elem->get_impl());
316 if (elem_impl != nullptr)
317 whereto->push_back(elem_impl);
322 } // namespace simgrid
324 #endif /* SIMGRID_S4U_ENGINE_HPP */