Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
bd28d99cdd7856310ca38c215b9e34e591221730
[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   Engine(int* argc, char** argv);
31
32   ~Engine();
33   /** Finalize the default engine and all its dependencies */
34   static void shutdown();
35
36   /** @brief Run the simulation */
37   void run();
38
39   /** @brief Retrieve the simulation time */
40   static double get_clock();
41   /** @brief Retrieve the engine singleton */
42   static s4u::Engine* get_instance();
43
44   /** @brief Load a platform file describing the environment
45    *
46    * The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
47    * Some examples can be found in the directory examples/platforms.
48    */
49   void load_platform(const char* platf);
50
51   /** Registers the main function of an actor that will be launched from the deployment file */
52   void register_function(const char* name, int (*code)(int, char**));
53   // FIXME: provide a register_function(std::string, void (*code)(int, char**)) and deprecate the int returning one
54   // FIXME: provide a register_function(std::string, std::vector<std::string>)
55
56   /** Registers a function as the default main function of actors
57    *
58    * It will be used as fallback when the function requested from the deployment file was not registered.
59    * It is used for trace-based simulations (see examples/s4u/replay-comms and similar).
60    */
61   void register_default(int (*code)(int, char**));
62
63   template <class F> void register_actor(const char* name)
64   {
65     simgrid::simix::register_function(name, [](std::vector<std::string> args) {
66       return simgrid::simix::ActorCode([args] {
67         F code(std::move(args));
68         code();
69       });
70     });
71   }
72
73   template <class F> void register_actor(const char* name, F code)
74   {
75     simgrid::simix::register_function(name, [code](std::vector<std::string> args) {
76       return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
77     });
78   }
79
80   /** @brief Load a deployment file and launch the actors that it contains */
81   void load_deployment(const char* deploy);
82
83 protected:
84   friend s4u::Host;
85   friend s4u::Storage;
86   friend kernel::routing::NetPoint;
87   friend kernel::routing::NetZoneImpl;
88   void host_register(std::string name, simgrid::s4u::Host* host);
89   void host_unregister(std::string name);
90   void storage_register(std::string name, simgrid::s4u::Storage* storage);
91   void storage_unregister(std::string name);
92   void netpoint_register(simgrid::kernel::routing::NetPoint* card);
93   void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
94
95 public:
96   size_t get_host_count();
97   std::vector<Host*> get_all_hosts();
98   simgrid::s4u::Host* host_by_name(std::string name);
99   simgrid::s4u::Host* host_by_name_or_null(std::string name);
100
101   size_t get_link_count();
102   std::vector<Link*> get_all_links();
103
104   size_t get_storage_count();
105   std::vector<Storage*> get_all_storages();
106   simgrid::s4u::Storage* storage_by_name(std::string name);
107   simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
108
109   std::vector<simgrid::kernel::routing::NetPoint*> get_all_netpoints();
110
111   /** @brief Retrieve the root netzone, containing all others */
112   simgrid::s4u::NetZone* getNetRoot();
113
114   simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
115
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
119   /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
120   simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name);
121
122   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
123   static bool is_initialized();
124   /** @brief set a configuration variable
125    *
126    * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
127    * options).
128    *
129    * Example:
130    * e->set_config("host/model:ptask_L07");
131    */
132   void set_config(std::string str);
133
134   simgrid::kernel::EngineImpl* pimpl;
135
136 private:
137   static s4u::Engine* instance_;
138
139   //////////////// Deprecated functions
140 public:
141   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const char* platf)
142   {
143     load_platform(platf);
144   }
145   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(const char* name,
146                                                                                              int (*code)(int, char**))
147   {
148     register_function(name, code);
149   }
150   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**))
151   {
152     register_default(code);
153   }
154   template <class F>
155   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name)
156   {
157     register_actor<F>(name);
158   }
159   template <class F>
160   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name, F code)
161   {
162     register_actor<F>(name, code);
163   }
164
165   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const char* deploy)
166   {
167     load_deployment(deploy);
168   }
169   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
170   {
171     return host_by_name(name);
172   }
173   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
174       std::string name)
175   {
176     return host_by_name_or_null(name);
177   }
178   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
179       std::string name)
180   {
181     return storage_by_name(name);
182   }
183   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
184       std::string name)
185   {
186     return storage_by_name_or_null(name);
187   }
188
189   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
190   XBT_ATTRIB_DEPRECATED_v322("Engine::getHostList() is deprecated in favor of Engine::get_all_hosts(). Please switch "
191                              "before v3.22") void getHostList(std::vector<Host*>* whereTo);
192   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
193   {
194     return get_all_hosts();
195   }
196   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); }
197   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()")
198       XBT_ATTRIB_DEPRECATED_v322("Engine::getLinkList() is deprecated in favor of Engine::get_all_links(). Please "
199                                  "switch before v3.22") void getLinkList(std::vector<Link*>* list);
200   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector<Link*> getAllLinks()
201   {
202     return get_all_links();
203   }
204   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector<Storage*> getAllStorages()
205   {
206     return get_all_storages();
207   }
208   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
209   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList(
210       std::vector<simgrid::kernel::routing::NetPoint*>* list);
211   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance()
212   {
213     return get_instance();
214   }
215   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized()
216   {
217     return is_initialized();
218   }
219   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); }
220 };
221
222 /** Callback fired when the platform is created (ie, the xml file parsed),
223  * right before the actual simulation starts. */
224 extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
225
226 /** Callback fired when the platform is about to be created (ie, just before the xml file is parsed) */
227 extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
228
229 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
230 extern XBT_PUBLIC xbt::signal<void()> on_simulation_end;
231
232 /** Callback fired when the time jumps into the future */
233 extern XBT_PUBLIC xbt::signal<void(double)> on_time_advance;
234
235 /** Callback fired when the time cannot jump because of inter-actors deadlock */
236 extern XBT_PUBLIC xbt::signal<void(void)> on_deadlock;
237
238 template <class T> XBT_PRIVATE void netzoneByTypeRecursive(s4u::NetZone* current, std::vector<T*>* whereto)
239 {
240   for (auto const& elem : *(current->getChildren())) {
241     netzoneByTypeRecursive(elem, whereto);
242     if (elem == dynamic_cast<T*>(elem))
243       whereto->push_back(dynamic_cast<T*>(elem));
244   }
245 }
246 }
247 } // namespace simgrid::s4u
248
249 #endif /* SIMGRID_S4U_ENGINE_HPP */