Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
6bb6e896ca373da7dc4ffd2ed71ea68c6c5d1f40
[simgrid.git] / include / simgrid / s4u / Engine.hpp
1 /* Copyright (c) 2006-2018. 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_S4U_ENGINE_HPP
7 #define SIMGRID_S4U_ENGINE_HPP
8
9 #include <string>
10 #include <utility>
11 #include <vector>
12
13 #include <xbt/base.h>
14 #include <xbt/functional.hpp>
15
16 #include <simgrid/forward.h>
17 #include <simgrid/simix.hpp>
18
19 #include <simgrid/s4u/NetZone.hpp>
20
21 namespace simgrid {
22 namespace s4u {
23 /** @brief Simulation engine
24  *
25  * This class is an interface to the simulation engine.
26  */
27 class XBT_PUBLIC Engine {
28 public:
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;
34
35   ~Engine();
36   /** Finalize the default engine and all its dependencies */
37   static void shutdown();
38
39   /** @brief Run the simulation */
40   void run();
41
42   /** @brief Retrieve the simulation time */
43   static double get_clock();
44   /** @brief Retrieve the engine singleton */
45   static s4u::Engine* get_instance();
46
47   /** @brief Load a platform file describing the environment
48    *
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.
51    */
52   void load_platform(std::string platf);
53
54   /** Registers the main function of an actor that will be launched from the deployment file */
55   void register_function(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(std::string name, void (*code)(std::vector<std::string>));
58
59   /** Registers a function as the default main function of actors
60    *
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).
63    */
64   void register_default(int (*code)(int, char**));
65
66   template <class F> void register_actor(std::string name)
67   {
68     simgrid::simix::register_function(name, [](std::vector<std::string> args) {
69       return simgrid::simix::ActorCode([args] {
70         F code(std::move(args));
71         code();
72       });
73     });
74   }
75
76   template <class F> void register_actor(std::string name, F code)
77   {
78     simgrid::simix::register_function(name, [code](std::vector<std::string> args) {
79       return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
80     });
81   }
82
83   /** @brief Load a deployment file and launch the actors that it contains */
84   void load_deployment(std::string deploy);
85
86 protected:
87 #ifndef DOXYGEN
88   friend Host;
89   friend Link;
90   friend Storage;
91   friend kernel::routing::NetPoint;
92   friend kernel::routing::NetZoneImpl;
93   friend kernel::resource::LinkImpl;
94   void host_register(std::string name, Host* host);
95   void host_unregister(std::string name);
96   void link_register(std::string name, Link* link);
97   void link_unregister(std::string name);
98   void storage_register(std::string name, Storage* storage);
99   void storage_unregister(std::string name);
100   void netpoint_register(simgrid::kernel::routing::NetPoint* card);
101   void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
102 #endif /*DOXYGEN*/
103
104 public:
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(std::function<bool(Host*)> filter);
109   simgrid::s4u::Host* host_by_name(std::string name);
110   simgrid::s4u::Host* host_by_name_or_null(std::string name);
111
112   size_t get_link_count();
113   std::vector<Link*> get_all_links();
114   std::vector<Link*> get_filtered_links(std::function<bool(Link*)> filter);
115   simgrid::s4u::Link* link_by_name(std::string name);
116   simgrid::s4u::Link* link_by_name_or_null(std::string name);
117
118   size_t get_actor_count();
119   std::vector<ActorPtr> get_all_actors();
120   std::vector<ActorPtr> get_filtered_actors(std::function<bool(ActorPtr)> filter);
121
122   size_t get_storage_count();
123   std::vector<Storage*> get_all_storages();
124   simgrid::s4u::Storage* storage_by_name(std::string name);
125   simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
126
127   std::vector<simgrid::kernel::routing::NetPoint*> get_all_netpoints();
128   simgrid::kernel::routing::NetPoint* netpoint_by_name_or_null(std::string name);
129
130   simgrid::s4u::NetZone* get_netzone_root();
131   void set_netzone_root(s4u::NetZone* netzone);
132
133   simgrid::s4u::NetZone* netzone_by_name_or_null(std::string name);
134
135   /** @brief Retrieves all netzones of the type indicated by the template argument */
136   template <class T> std::vector<T*> get_filtered_netzones()
137   {
138     static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
139                   "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
140     std::vector<T*> res;
141     get_filtered_netzones_recursive(get_netzone_root(), &res);
142     return res;
143   }
144
145   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
146   static bool is_initialized();
147   /** @brief set a configuration variable
148    *
149    * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
150    * options).
151    *
152    * Example:
153    * e->set_config("host/model:ptask_L07");
154    */
155   void set_config(std::string str);
156
157 private:
158   simgrid::kernel::EngineImpl* pimpl;
159   static s4u::Engine* instance_;
160
161   //////////////// Deprecated functions
162 public:
163   /** @deprecated See Engine::load_platform() */
164   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(std::string platf)
165   {
166     load_platform(platf);
167   }
168   /** @deprecated See Engine::register_function() */
169   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(std::string name,
170                                                                                              int (*code)(int, char**))
171   {
172     register_function(name, code);
173   }
174   /** @deprecated See Engine::register_default() */
175   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**))
176   {
177     register_default(code);
178   }
179   /** @deprecated See Engine::register_actor() */
180   template <class F>
181   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name)
182   {
183     register_actor<F>(name);
184   }
185   /** @deprecated See Engine::register_actor() */
186   template <class F>
187   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name, F code)
188   {
189     register_actor<F>(name, code);
190   }
191
192   /** @deprecated See Engine::load_deployment() */
193   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(std::string deploy)
194   {
195     load_deployment(deploy);
196   }
197   /** @deprecated See Engine::host_by_name() */
198   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
199   {
200     return host_by_name(name);
201   }
202   /** @deprecated See Engine::host_by_name_or_null() */
203   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
204       std::string name)
205   {
206     return host_by_name_or_null(name);
207   }
208   /** @deprecated See Engine::storage_by_name() */
209   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
210       std::string name)
211   {
212     return storage_by_name(name);
213   }
214   /** @deprecated See Engine::storage_by_name_or_null() */
215   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
216       std::string name)
217   {
218     return storage_by_name_or_null(name);
219   }
220
221   /** @deprecated See Engine::get_host_count() */
222   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
223   /** @deprecated See Engine::get_all_hosts() */
224   XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_hosts()") void getHostList(std::vector<Host*>* whereTo);
225   /** @deprecated See Engine::get_all_hosts() */
226   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
227   {
228     return get_all_hosts();
229   }
230   /** @deprecated See Engine::get_link_count() */
231   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); }
232   /** @deprecated See Engine::get_all_links() */
233   XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_links()") void getLinkList(std::vector<Link*>* list);
234   /** @deprecated See Engine::get_link_list() */
235   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector<Link*> getAllLinks()
236   {
237     return get_all_links();
238   }
239   /** @deprecated See Engine::get_all_storages() */
240   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector<Storage*> getAllStorages()
241   {
242     return get_all_storages();
243   }
244   /** @deprecated See Engine::get_clock() */
245   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
246   /** @deprecated See Engine::get_all_netpoints() */
247   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList(
248       std::vector<simgrid::kernel::routing::NetPoint*>* list);
249   /** @deprecated See Engine::netpoint_by_name_or_null() */
250   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()") simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name)
251   {
252     return netpoint_by_name_or_null(name);
253   }
254   /** @deprecated See Engine::get_netzone_root() */
255   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_netzone_root()") simgrid::s4u::NetZone* getNetRoot()
256   {
257     return get_netzone_root();
258   }
259   /** @deprecated See Engine::netzone_by_name_or_null() */
260   XBT_ATTRIB_DEPRECATED_v323(
261       "Please use Engine::netzone_by_name_or_null()") simgrid::s4u::NetZone* getNetzoneByNameOrNull(std::string name)
262   {
263     return netzone_by_name_or_null(name);
264   }
265   /** @deprecated See Engine::filter_netzones_by_type() */
266   template <class T>
267   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::filter_netzones_by_type()") void getNetzoneByType(
268       std::vector<T*>* whereto)
269   {
270     get_filtered_netzones_recursive(get_netzone_root(), whereto);
271   }
272
273   /** @deprecated See Engine::get_instance() */
274   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance()
275   {
276     return get_instance();
277   }
278   /** @deprecated See Engine::is_initialized() */
279   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized()
280   {
281     return is_initialized();
282   }
283   /** @deprecated See Engine::set_config() */
284   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); }
285 };
286
287 /** Callback fired when the platform is created (ie, the xml file parsed),
288  * right before the actual simulation starts. */
289 extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
290
291 /** Callback fired when the platform is about to be created
292  * (ie, after any configuration change and just before the resource creation) */
293 extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
294
295 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
296 extern XBT_PUBLIC xbt::signal<void()> on_simulation_end;
297
298 /** Callback fired when the time jumps into the future */
299 extern XBT_PUBLIC xbt::signal<void(double)> on_time_advance;
300
301 /** Callback fired when the time cannot advance because of inter-actors deadlock */
302 extern XBT_PUBLIC xbt::signal<void(void)> on_deadlock;
303
304 template <class T> XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector<T*>* whereto)
305 {
306   static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
307                 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
308   for (auto const& elem : current->get_children()) {
309     get_filtered_netzones_recursive(elem, whereto);
310     if (elem->get_impl() == dynamic_cast<T*>(elem->get_impl()))
311       whereto->push_back(dynamic_cast<T*>(elem->get_impl()));
312   }
313 }
314 }
315 } // namespace simgrid::s4u
316
317 #endif /* SIMGRID_S4U_ENGINE_HPP */