1 /* Copyright (c) 2006-2023. 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
11 #include <simgrid/forward.h>
13 #include <simgrid/kernel/resource/Model.hpp>
14 #include <simgrid/s4u/NetZone.hpp>
23 /** @brief Simulation engine
25 * This is a singleton containing all the main functions of the simulation.
27 class XBT_PUBLIC Engine {
29 friend simgrid::kernel::EngineImpl;
33 /** Constructor, taking only the name of your main function */
34 explicit Engine(std::string name);
35 /** Constructor, taking the command line parameters of your main function */
36 explicit Engine(int* argc, char** argv);
37 /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
39 Engine(const Engine&) = delete;
40 Engine(Engine&&) = delete;
44 /** Finalize the default engine and all its dependencies */
45 XBT_ATTRIB_DEPRECATED_v335("Users are not supposed to shutdown the Engine") void shutdown();
47 /** Run the simulation until its end */
50 /** Run the simulation until the specified date */
51 void run_until(double max_date) const;
53 /** @brief Retrieve the simulation time (in seconds) */
54 static double get_clock();
55 /** @brief Retrieve the engine singleton */
56 static s4u::Engine* get_instance();
57 static s4u::Engine* get_instance(int* argc, char** argv);
58 static bool has_instance() { return instance_ != nullptr; }
61 * Creates a new platform, including hosts, links, and the routing table.
64 * See also: :ref:`platform`.
67 void load_platform(const std::string& platf) const;
69 * @brief Seals the platform, finishing the creation of its resources.
71 * This method is optional. The seal() is done automatically when you call Engine::run.
73 void seal_platform() const;
74 /** @brief Get a debug output of the platform.
76 * It looks like a XML platform file, but it may be very different from the input platform file: All netzones are
77 * flatified into a unique zone. This representation is mostly useful to debug your platform configuration and ensure
78 * that your assumptions over your configuration hold. This enables you to verify the exact list of links traversed
79 * between any two hosts, and the characteristics of every host and link. But you should not use the resulting file as
80 * an input platform file: it is very verbose, and thus much less efficient (in parsing time and runtime performance)
81 * than a regular platform file with the sufficient amount of intermediary netzones. Even if you use one zone only,
82 * specialized zones (such as clusters) are more efficient than the one with fully explicit routing used here.
84 std::string flatify_platform() const;
86 /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function taking classical argc/argv parameters. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
87 void register_function(const std::string& name, const std::function<void(int, char**)>& code);
88 /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function taking a vector of strings as a parameter. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
89 void register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code);
90 void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory);
92 /** @verbatim embed:rst:inline Provide a default function to be used when the name used in a :ref:`pf_tag_actor` tag was not binded with ``register_function`` nor ``register_actor``. @endverbatim */
93 void register_default(const std::function<void(int, char**)>& code);
94 void register_default(const kernel::actor::ActorCodeFactory& factory);
96 /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a class name passed as a template parameter. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
97 template <class F> void register_actor(const std::string& name)
99 kernel::actor::ActorCodeFactory code_factory = [](std::vector<std::string> args) {
100 return kernel::actor::ActorCode([args = std::move(args)]() mutable {
101 F code(std::move(args));
105 register_function(name, code_factory);
107 /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function name passed as a parameter. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
108 template <class F> void register_actor(const std::string& name, F code)
110 kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
111 return kernel::actor::ActorCode([code, args = std::move(args)]() mutable { code(std::move(args)); });
113 register_function(name, code_factory);
116 /** If non-null, the provided set will be filled with all activities that fail to start because of a veto */
117 void track_vetoed_activities(std::set<Activity*>* vetoed_activities) const;
119 /** @verbatim embed:rst:inline Load a deployment file. See:ref:`deploy` and the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
120 void load_deployment(const std::string& deploy) const;
127 friend kernel::routing::NetPoint;
128 friend kernel::routing::NetZoneImpl;
129 friend kernel::resource::HostImpl;
130 friend kernel::resource::StandardLinkImpl;
131 void netpoint_register(simgrid::kernel::routing::NetPoint* card);
132 void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
133 void set_netzone_root(const NetZone* netzone);
137 /** Returns the amount of hosts existing in the platform. */
138 size_t get_host_count() const;
139 /** Returns a vector of all hosts found in the platform.
141 * The order is generally different from the creation/declaration order in the XML platform because we use a hash
144 std::vector<Host*> get_all_hosts() const;
145 std::vector<Host*> get_filtered_hosts(const std::function<bool(Host*)>& filter) const;
146 Host* host_by_name(const std::string& name) const;
147 Host* host_by_name_or_null(const std::string& name) const;
149 size_t get_link_count() const;
150 std::vector<Link*> get_all_links() const;
151 std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter) const;
152 Link* link_by_name(const std::string& name) const;
154 * @brief Find a split-duplex link from its name.
155 * @throw std::invalid_argument if the searched link does not exist.
157 SplitDuplexLink* split_duplex_link_by_name(const std::string& name) const;
158 Link* link_by_name_or_null(const std::string& name) const;
160 Mailbox* mailbox_by_name_or_create(const std::string& name) const;
162 size_t get_actor_count() const;
163 std::vector<ActorPtr> get_all_actors() const;
164 std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const;
166 std::vector<kernel::routing::NetPoint*> get_all_netpoints() const;
167 kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name) const;
169 * @brief Get netpoint by its name
171 * @param name Netpoint name
172 * @throw std::invalid_argument if netpoint doesn't exist
174 kernel::routing::NetPoint* netpoint_by_name(const std::string& name) const;
176 NetZone* get_netzone_root() const;
178 NetZone* netzone_by_name_or_null(const std::string& name) const;
181 * @brief Add a model to engine list
183 * @param model Pointer to model
184 * @param dependencies List of dependencies for this model (optional)
186 void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
187 const std::vector<kernel::resource::Model*>& dependencies = {});
189 /** @brief Get list of all models managed by this engine */
190 const std::vector<simgrid::kernel::resource::Model*>& get_all_models() const;
192 /** @brief Retrieves all netzones of the type indicated by the template argument */
193 template <class T> std::vector<T*> get_filtered_netzones() const
195 static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
196 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
198 get_filtered_netzones_recursive(get_netzone_root(), &res);
202 kernel::EngineImpl* get_impl() const { return pimpl; }
204 /** Returns whether SimGrid was initialized yet -- mostly for internal use */
205 static bool is_initialized();
206 /** @brief set a configuration variable
209 * Do --help on any simgrid binary to see the list of currently existing configuration variables
210 * (see also :ref:`options`).
214 * simgrid::s4u::Engine::set_config("host/model:ptask_L07");
216 static void set_config(const std::string& str);
217 static void set_config(const std::string& name, int value);
218 static void set_config(const std::string& name, bool value);
219 static void set_config(const std::string& name, double value);
220 static void set_config(const std::string& name, const std::string& value);
223 set_default_comm_data_copy_callback(const std::function<void(kernel::activity::CommImpl*, void*, size_t)>& callback);
225 /** Add a callback fired when the platform is created (ie, the xml file parsed),
226 * right before the actual simulation starts. */
227 static void on_platform_created_cb(const std::function<void()>& cb) { on_platform_created.connect(cb); }
228 /** Add a callback fired when the platform is about to be created
229 * (ie, after any configuration change and just before the resource creation) */
230 static void on_platform_creation_cb(const std::function<void()>& cb) { on_platform_creation.connect(cb); }
231 /** Add a callback fired when the main simulation loop starts, at the beginning of the first call to Engine::run() */
232 static void on_simulation_start_cb(const std::function<void()>& cb) { on_simulation_start.connect(cb); }
233 /** Add a callback fired when the main simulation loop ends, just before the end of Engine::run() */
234 static void on_simulation_end_cb(const std::function<void()>& cb) { on_simulation_end.connect(cb); }
236 /** Add a callback fired when the time jumps into the future.
238 * It is fired right after the time change (use get_clock() to get the new timestamp).
239 * The callback parameter is the time delta since previous timestamp. */
240 static void on_time_advance_cb(const std::function<void(double)>& cb) { on_time_advance.connect(cb); }
242 /** Add a callback fired when the time cannot advance because of inter-actors deadlock. Note that the on_exit of each
243 * actor is also executed on deadlock. */
244 static void on_deadlock_cb(const std::function<void(void)>& cb) { on_deadlock.connect(cb); }
247 /* FIXME signals should be private */
248 static xbt::signal<void()> on_platform_created;
249 static xbt::signal<void()> on_platform_creation;
253 static xbt::signal<void()> on_simulation_start;
254 static xbt::signal<void(double)> on_time_advance;
255 static xbt::signal<void(void)> on_deadlock;
256 static xbt::signal<void()> on_simulation_end;
258 kernel::EngineImpl* const pimpl;
259 static Engine* instance_;
260 void initialize(int* argc, char** argv);
263 std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename);
264 std::vector<ActivityPtr> create_DAG_from_DAX(const std::string& filename);
266 #ifndef DOXYGEN /* Internal use only, no need to expose it */
268 XBT_PRIVATE void get_filtered_netzones_recursive(const s4u::NetZone* current, std::vector<T*>* whereto)
270 static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
271 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
272 for (auto const& elem : current->get_children()) {
273 get_filtered_netzones_recursive(elem, whereto);
274 auto* elem_impl = dynamic_cast<T*>(elem->get_impl());
275 if (elem_impl != nullptr)
276 whereto->push_back(elem_impl);
281 } // namespace simgrid
283 #endif /* SIMGRID_S4U_ENGINE_HPP */