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 Engine(int* argc, char** argv);
33 /** Finalize the default engine and all its dependencies */
34 static void shutdown();
36 /** @brief Load a platform file describing the environment
38 * The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
39 * Some examples can be found in the directory examples/platforms.
41 void load_platform(const char* platf);
43 /** Registers the main function of an actor that will be launched from the deployment file */
44 void register_function(const char* name, int (*code)(int, char**));
45 // FIXME: provide a register_function(std::string, void (*code)(int, char**)) and deprecate the int returning one
46 // FIXME: provide a register_function(std::string, std::vector<std::string>)
48 /** Registers a function as the default main function of actors
50 * It will be used as fallback when the function requested from the deployment file was not registered.
51 * It is used for trace-based simulations (see examples/s4u/replay-comms and similar).
53 void register_default(int (*code)(int, char**));
55 template <class F> void register_actor(const char* name)
57 simgrid::simix::register_function(name, [](std::vector<std::string> args) {
58 return simgrid::simix::ActorCode([args] {
59 F code(std::move(args));
65 template <class F> void register_actor(const char* name, F code)
67 simgrid::simix::register_function(name, [code](std::vector<std::string> args) {
68 return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
72 /** @brief Load a deployment file and launch the actors that it contains */
73 void load_deployment(const char* deploy);
78 friend kernel::routing::NetPoint;
79 friend kernel::routing::NetZoneImpl;
80 void host_register(std::string name, simgrid::s4u::Host* host);
81 void host_unregister(std::string name);
82 void storage_register(std::string name, simgrid::s4u::Storage* storage);
83 void storage_unregister(std::string name);
84 void netpoint_register(simgrid::kernel::routing::NetPoint* card);
85 void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
88 size_t get_host_count();
89 std::vector<Host*> get_all_hosts();
90 simgrid::s4u::Host* host_by_name(std::string name);
91 simgrid::s4u::Host* host_by_name_or_null(std::string name);
93 size_t get_link_count();
94 std::vector<Link*> get_all_links();
96 size_t get_storage_count();
97 std::vector<Storage*> get_all_storages();
98 simgrid::s4u::Storage* storage_by_name(std::string name);
99 simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
101 /** @brief Run the simulation */
104 /** @brief Retrieve the simulation time */
105 static double get_clock();
107 /** @brief Retrieve the engine singleton */
108 static s4u::Engine* getInstance();
110 /** @brief Retrieve the root netzone, containing all others */
111 simgrid::s4u::NetZone* getNetRoot();
113 /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
114 simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
116 /** @brief Retrieves all netzones of the same type than the subtype of the whereto vector */
117 template <class T> void getNetzoneByType(std::vector<T*> * whereto) { netzoneByTypeRecursive(getNetRoot(), whereto); }
118 /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
119 simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name);
120 void getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
122 /** Returns whether SimGrid was initialized yet -- mostly for internal use */
123 static bool isInitialized();
125 /** @brief set a configuration variable
127 * Do --help on any simgrid binary to see the list of currently existing configuration variables (see @ref options).
130 * e->setConfig("host/model","ptask_L07");
132 void setConfig(std::string str);
134 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const char* platf)
136 load_platform(platf);
138 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(const char* name,
139 int (*code)(int, char**))
141 register_function(name, code);
143 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**))
145 register_default(code);
148 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name)
150 register_actor<F>(name);
153 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name, F code)
155 register_actor<F>(name, code);
158 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const char* deploy)
160 load_deployment(deploy);
162 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
164 return host_by_name(name);
166 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
169 return host_by_name_or_null(name);
171 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
174 return storage_by_name(name);
176 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
179 return storage_by_name_or_null(name);
182 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
183 XBT_ATTRIB_DEPRECATED_v322("Engine::getHostList() is deprecated in favor of Engine::get_all_hosts(). Please switch "
184 "before v3.22") void getHostList(std::vector<Host*>* whereTo);
185 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
187 return get_all_hosts();
189 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); }
190 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()")
191 XBT_ATTRIB_DEPRECATED_v322("Engine::getLinkList() is deprecated in favor of Engine::get_all_links(). Please "
192 "switch before v3.22") void getLinkList(std::vector<Link*>* list);
193 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector<Link*> getAllLinks()
195 return get_all_links();
197 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector<Storage*> getAllStorages()
199 return get_all_storages();
201 XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
203 simgrid::kernel::EngineImpl* pimpl;
206 static s4u::Engine* instance_;
209 /** Callback fired when the platform is created (ie, the xml file parsed),
210 * right before the actual simulation starts. */
211 extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
213 /** Callback fired when the platform is about to be created (ie, just before the xml file is parsed) */
214 extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
216 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
217 extern XBT_PUBLIC xbt::signal<void()> onSimulationEnd;
219 /** Callback fired when the time jumps into the future */
220 extern XBT_PUBLIC xbt::signal<void(double)> onTimeAdvance;
222 /** Callback fired when the time cannot jump because of inter-actors deadlock */
223 extern XBT_PUBLIC xbt::signal<void(void)> onDeadlock;
225 template <class T> XBT_PRIVATE void netzoneByTypeRecursive(s4u::NetZone* current, std::vector<T*>* whereto)
227 for (auto const& elem : *(current->getChildren())) {
228 netzoneByTypeRecursive(elem, whereto);
229 if (elem == dynamic_cast<T*>(elem))
230 whereto->push_back(dynamic_cast<T*>(elem));
234 } // namespace simgrid::s4u
236 #endif /* SIMGRID_S4U_ENGINE_HPP */