1 /* Copyright (c) 2006-2018. 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 */
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 char* platf);
54 /** Registers the main function of an actor that will be launched from the deployment file */
55 void register_function(const char* name, int (*code)(int, char**));
56 // FIXME: provide a register_function(std::string, void (*code)(int, char**)) and deprecate the int returning one
57 // FIXME: provide a register_function(std::string, 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 char* name)
68 simgrid::simix::register_function(name, [](std::vector<std::string> args) {
69 return simgrid::simix::ActorCode([args] {
70 F code(std::move(args));
76 template <class F> void register_actor(const char* name, F code)
78 simgrid::simix::register_function(name, [code](std::vector<std::string> args) {
79 return simgrid::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 char* deploy);
89 friend kernel::routing::NetPoint;
90 friend kernel::routing::NetZoneImpl;
91 void host_register(std::string name, simgrid::s4u::Host* host);
92 void host_unregister(std::string name);
93 void storage_register(std::string name, simgrid::s4u::Storage* storage);
94 void storage_unregister(std::string name);
95 void netpoint_register(simgrid::kernel::routing::NetPoint* card);
96 void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
99 size_t get_host_count();
100 std::vector<Host*> get_all_hosts();
101 std::vector<Host*> get_filtered_hosts(std::function<bool(Host*)> filter);
102 simgrid::s4u::Host* host_by_name(std::string name);
103 simgrid::s4u::Host* host_by_name_or_null(std::string name);
105 size_t get_link_count();
106 std::vector<Link*> get_all_links();
107 std::vector<Link*> get_filtered_links(std::function<bool(Link*)> filter);
109 size_t get_actor_count();
110 std::vector<ActorPtr> get_all_actors();
111 std::vector<ActorPtr> get_filtered_actors(std::function<bool(ActorPtr)> filter);
113 size_t get_storage_count();
114 std::vector<Storage*> get_all_storages();
115 simgrid::s4u::Storage* storage_by_name(std::string name);
116 simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
118 std::vector<simgrid::kernel::routing::NetPoint*> get_all_netpoints();
119 simgrid::kernel::routing::NetPoint* netpoint_by_name_or_null(std::string name);
121 simgrid::s4u::NetZone* get_netzone_root();
122 void set_netzone_root(s4u::NetZone* netzone);
124 simgrid::s4u::NetZone* netzone_by_name_or_null(const char* name);
126 /** @brief Retrieves all netzones of the type indicated by the template argument */
127 template <class T> std::vector<T*> filter_netzones_by_type()
130 filter_netzones_by_type_recursive(get_netzone_root(), &res);
134 /** Returns whether SimGrid was initialized yet -- mostly for internal use */
135 static bool is_initialized();
136 /** @brief set a configuration variable
138 * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
142 * e->set_config("host/model:ptask_L07");
144 void set_config(std::string str);
147 simgrid::kernel::EngineImpl* pimpl;
148 static s4u::Engine* instance_;
150 //////////////// Deprecated functions
152 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const char* platf)
154 load_platform(platf);
156 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(const char* name,
157 int (*code)(int, char**))
159 register_function(name, code);
161 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**))
163 register_default(code);
166 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name)
168 register_actor<F>(name);
171 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name, F code)
173 register_actor<F>(name, code);
176 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const char* deploy)
178 load_deployment(deploy);
180 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
182 return host_by_name(name);
184 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
187 return host_by_name_or_null(name);
189 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
192 return storage_by_name(name);
194 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
197 return storage_by_name_or_null(name);
200 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
201 XBT_ATTRIB_DEPRECATED_v322("Engine::getHostList() is deprecated in favor of Engine::get_all_hosts(). Please switch "
202 "before v3.22") void getHostList(std::vector<Host*>* whereTo);
203 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
205 return get_all_hosts();
207 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); }
208 XBT_ATTRIB_DEPRECATED_v322("Engine::getLinkList() is deprecated in favor of Engine::get_all_links(). Please "
209 "switch before v3.22") void getLinkList(std::vector<Link*>* list);
210 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector<Link*> getAllLinks()
212 return get_all_links();
214 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector<Storage*> getAllStorages()
216 return get_all_storages();
218 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
219 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList(
220 std::vector<simgrid::kernel::routing::NetPoint*>* list);
221 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()")
222 simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name)
224 return netpoint_by_name_or_null(name);
226 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_netzone_root()") simgrid::s4u::NetZone* getNetRoot()
228 return get_netzone_root();
230 XBT_ATTRIB_DEPRECATED_v323(
231 "Please use Engine::netzone_by_name_or_null()") simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name)
233 return netzone_by_name_or_null(name);
236 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::filter_netzones_by_type()") void getNetzoneByType(
237 std::vector<T*>* whereto)
239 filter_netzones_by_type_recursive(get_netzone_root(), whereto);
242 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance()
244 return get_instance();
246 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized()
248 return is_initialized();
250 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); }
253 /** Callback fired when the platform is created (ie, the xml file parsed),
254 * right before the actual simulation starts. */
255 extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
257 /** Callback fired when the platform is about to be created
258 * (ie, after any configuration change and just before the resource creation) */
259 extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
261 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
262 extern XBT_PUBLIC xbt::signal<void()> on_simulation_end;
264 /** Callback fired when the time jumps into the future */
265 extern XBT_PUBLIC xbt::signal<void(double)> on_time_advance;
267 /** Callback fired when the time cannot jump because of inter-actors deadlock */
268 extern XBT_PUBLIC xbt::signal<void(void)> on_deadlock;
270 template <class T> XBT_PRIVATE void filter_netzones_by_type_recursive(s4u::NetZone* current, std::vector<T*>* whereto)
272 for (auto const& elem : *(current->getChildren())) {
273 filter_netzones_by_type_recursive(elem, whereto);
274 if (elem == dynamic_cast<T*>(elem))
275 whereto->push_back(dynamic_cast<T*>(elem));
279 } // namespace simgrid::s4u
281 #endif /* SIMGRID_S4U_ENGINE_HPP */