1 /* s4u::Engine Simulation Engine and global functions. */
3 /* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "simgrid/kernel/routing/NetPoint.hpp"
10 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
11 #include "simgrid/s4u/Disk.hpp"
12 #include "simgrid/s4u/Engine.hpp"
13 #include "simgrid/s4u/Host.hpp"
14 #include "simgrid/s4u/Mailbox.hpp"
15 #include "simgrid/s4u/NetZone.hpp"
16 #include "simgrid/simix.h"
17 #include "src/instr/instr_private.hpp"
18 #include "src/kernel/EngineImpl.hpp"
19 #include "src/simix/smx_private.hpp" // For access to simix_global->process_list
20 #include "src/surf/network_interface.hpp"
21 #include "surf/surf.hpp" // routing_platf. FIXME:KILLME. SOON
22 #include <simgrid/Exception.hpp>
27 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_engine, s4u, "Logging specific to S4U (engine)");
32 xbt::signal<void()> Engine::on_platform_creation;
33 xbt::signal<void()> Engine::on_platform_created;
34 xbt::signal<void()> Engine::on_simulation_end;
35 xbt::signal<void(double)> Engine::on_time_advance;
36 xbt::signal<void(void)> Engine::on_deadlock;
38 Engine* Engine::instance_ = nullptr; /* That singleton is awful, but I don't see no other solution right now. */
40 Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl())
42 xbt_assert(Engine::instance_ == nullptr, "It is currently forbidden to create more than one instance of s4u::Engine");
44 SIMIX_global_init(argc, argv);
46 Engine::instance_ = this;
52 Engine::instance_ = nullptr;
55 /** @brief Retrieve the engine singleton */
56 Engine* Engine::get_instance()
58 if (Engine::instance_ == nullptr) {
59 auto e = new Engine(nullptr, nullptr);
60 xbt_assert(Engine::instance_ == e);
62 return Engine::instance_;
65 void Engine::shutdown()
67 delete Engine::instance_;
68 Engine::instance_ = nullptr;
71 double Engine::get_clock()
73 return SIMIX_get_clock();
77 * Creates a new platform, including hosts, links, and the routing table.
80 * See also: :ref:`platform`.
83 void Engine::load_platform(const std::string& platf) const
85 double start = xbt_os_time();
86 parse_platform_file(platf);
88 double end = xbt_os_time();
89 XBT_DEBUG("PARSE TIME: %g", (end - start));
92 void Engine::register_function(const std::string& name, int (*code)(int, char**)) // XBT_ATTRIB_DEPRECATED_v329
94 kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
95 return xbt::wrap_main(code, std::move(args));
97 register_function(name, code_factory);
99 void Engine::register_default(int (*code)(int, char**)) // XBT_ATTRIB_DEPRECATED_v329
101 register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
104 /** Registers the main function of an actor that will be launched from the deployment file */
105 void Engine::register_function(const std::string& name, const std::function<void(int, char**)>& code)
107 kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
108 return xbt::wrap_main(code, std::move(args));
110 register_function(name, code_factory);
113 /** Registers the main function of an actor that will be launched from the deployment file */
114 void Engine::register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code)
116 kernel::actor::ActorCodeFactory code_factory = [code{code}](std::vector<std::string> args) mutable {
117 return std::bind(std::move(code), std::move(args));
119 register_function(name, code_factory);
121 /** Registers a function as the default main function of actors
123 * It will be used as fallback when the function requested from the deployment file was not registered.
124 * It is used for trace-based simulations (see examples/cpp/replay-comms and similar).
126 void Engine::register_default(const std::function<void(int, char**)>& code)
128 register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
130 void Engine::register_default(const kernel::actor::ActorCodeFactory& code)
132 simgrid::kernel::actor::simcall([this, &code]() { pimpl->register_default(code); });
135 void Engine::register_function(const std::string& name, const kernel::actor::ActorCodeFactory& code)
137 simgrid::kernel::actor::simcall([this, name, &code]() { pimpl->register_function(name, code); });
140 /** Load a deployment file and launch the actors that it contains
143 * See also: :ref:`deploy`.
146 void Engine::load_deployment(const std::string& deploy) const
148 pimpl->load_deployment(deploy);
151 /** Returns the amount of hosts in the platform */
152 size_t Engine::get_host_count() const
154 return pimpl->hosts_.size();
157 std::vector<Host*> Engine::get_all_hosts() const
159 std::vector<Host*> res;
160 for (auto const& kv : pimpl->hosts_)
161 res.push_back(kv.second);
165 std::vector<Host*> Engine::get_filtered_hosts(const std::function<bool(Host*)>& filter) const
167 std::vector<Host*> hosts;
168 for (auto const& kv : pimpl->hosts_) {
169 if (filter(kv.second))
170 hosts.push_back(kv.second);
176 void Engine::host_register(const std::string& name, Host* host)
178 pimpl->hosts_[name] = host;
181 void Engine::host_unregister(const std::string& name)
183 pimpl->hosts_.erase(name);
186 /** @brief Find a host from its name.
188 * @throw std::invalid_argument if the searched host does not exist.
190 Host* Engine::host_by_name(const std::string& name) const
192 auto host = pimpl->hosts_.find(name);
193 if (host == pimpl->hosts_.end())
194 throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'"));
198 /** @brief Find a host from its name (or nullptr if that host does not exist) */
199 Host* Engine::host_by_name_or_null(const std::string& name) const
201 auto host = pimpl->hosts_.find(name);
202 return host == pimpl->hosts_.end() ? nullptr : host->second;
205 /** @brief Find a link from its name.
207 * @throw std::invalid_argument if the searched link does not exist.
209 Link* Engine::link_by_name(const std::string& name) const
211 auto link = pimpl->links_.find(name);
212 if (link == pimpl->links_.end())
213 throw std::invalid_argument(std::string("Link not found: ") + name);
214 return link->second->get_iface();
217 /** @brief Find a link from its name (or nullptr if that link does not exist) */
218 Link* Engine::link_by_name_or_null(const std::string& name) const
220 auto link = pimpl->links_.find(name);
221 return link == pimpl->links_.end() ? nullptr : link->second->get_iface();
224 void Engine::link_register(const std::string& name, const Link* link)
226 pimpl->links_[name] = link->get_impl();
229 void Engine::link_unregister(const std::string& name)
231 pimpl->links_.erase(name);
234 /** @brief Returns the amount of links in the platform */
235 size_t Engine::get_link_count() const
237 return pimpl->links_.size();
240 /** @brief Returns the list of all links found in the platform */
241 std::vector<Link*> Engine::get_all_links() const
243 std::vector<Link*> res;
244 for (auto const& kv : pimpl->links_)
245 res.push_back(kv.second->get_iface());
249 std::vector<Link*> Engine::get_filtered_links(const std::function<bool(Link*)>& filter) const
251 std::vector<Link*> filtered_list;
252 for (auto const& kv : pimpl->links_) {
253 Link* l = kv.second->get_iface();
255 filtered_list.push_back(l);
257 return filtered_list;
260 size_t Engine::get_actor_count() const
262 return simix_global->process_list.size();
265 std::vector<ActorPtr> Engine::get_all_actors() const
267 std::vector<ActorPtr> actor_list;
268 for (auto const& kv : simix_global->process_list) {
269 actor_list.push_back(kv.second->get_iface());
274 std::vector<ActorPtr> Engine::get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const
276 std::vector<ActorPtr> actor_list;
277 for (auto const& kv : simix_global->process_list) {
278 if (filter(kv.second->get_iface()))
279 actor_list.push_back(kv.second->get_iface());
284 void Engine::run() const
286 /* Clean IO before the run */
290 if (MC_is_active()) {
297 /** @brief Retrieve the root netzone, containing all others */
298 s4u::NetZone* Engine::get_netzone_root() const
300 return pimpl->netzone_root_->get_iface();
302 /** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */
303 void Engine::set_netzone_root(const s4u::NetZone* netzone)
305 xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set");
306 pimpl->netzone_root_ = netzone->get_impl();
309 static NetZone* netzone_by_name_recursive(NetZone* current, const std::string& name)
311 if (current->get_name() == name)
314 for (auto const& elem : current->get_children()) {
315 NetZone* tmp = netzone_by_name_recursive(elem, name);
316 if (tmp != nullptr) {
323 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
324 NetZone* Engine::netzone_by_name_or_null(const std::string& name) const
326 return netzone_by_name_recursive(get_netzone_root(), name);
329 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
330 kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(const std::string& name) const
332 auto netp = pimpl->netpoints_.find(name);
333 return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
336 std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints() const
338 std::vector<kernel::routing::NetPoint*> res;
339 for (auto const& kv : pimpl->netpoints_)
340 res.push_back(kv.second);
344 /** @brief Register a new netpoint to the system */
345 void Engine::netpoint_register(kernel::routing::NetPoint* point)
347 simgrid::kernel::actor::simcall([this, point] { pimpl->netpoints_[point->get_name()] = point; });
350 /** @brief Unregister a given netpoint */
351 void Engine::netpoint_unregister(kernel::routing::NetPoint* point)
353 kernel::actor::simcall([this, point] {
354 pimpl->netpoints_.erase(point->get_name());
359 bool Engine::is_initialized()
361 return Engine::instance_ != nullptr;
363 void Engine::set_config(const std::string& str)
365 config::set_parse(str);
367 void Engine::set_config(const std::string& name, int value)
369 config::set_value(name.c_str(), value);
371 void Engine::set_config(const std::string& name, double value)
373 config::set_value(name.c_str(), value);
375 void Engine::set_config(const std::string& name, bool value)
377 config::set_value(name.c_str(), value);
379 void Engine::set_config(const std::string& name, const std::string& value)
381 config::set_value(name.c_str(), value);
385 } // namespace simgrid
387 /* **************************** Public C interface *************************** */
388 void simgrid_init(int* argc, char** argv)
390 simgrid::s4u::Engine e(argc, argv);
392 void simgrid_load_platform(const char* file)
394 simgrid::s4u::Engine::get_instance()->load_platform(file);
397 void simgrid_load_deployment(const char* file)
399 simgrid::s4u::Engine::get_instance()->load_deployment(file);
403 simgrid::s4u::Engine::get_instance()->run();
405 void simgrid_register_function(const char* name, void (*code)(int, char**))
407 simgrid::s4u::Engine::get_instance()->register_function(name, code);
409 void simgrid_register_default(void (*code)(int, char**))
411 simgrid::s4u::Engine::get_instance()->register_default(code);
413 double simgrid_get_clock()
415 return simgrid::s4u::Engine::get_clock();
418 int simgrid_get_actor_count() // XBT_ATTRIB_DEPRECATED_v330
420 return simgrid::s4u::Engine::get_instance()->get_actor_count();