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. */
8 #include <simgrid/kernel/routing/NetPoint.hpp>
9 #include <simgrid/modelchecker.h>
10 #include <simgrid/s4u/Engine.hpp>
13 #include "src/instr/instr_private.hpp"
14 #include "src/kernel/EngineImpl.hpp"
15 #include "src/mc/mc_replay.hpp"
16 #include "surf/surf.hpp"
21 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_engine, s4u, "Logging specific to S4U (engine)");
24 static simgrid::kernel::actor::ActorCode maestro_code;
28 xbt::signal<void()> Engine::on_platform_creation;
29 xbt::signal<void()> Engine::on_platform_created;
30 xbt::signal<void()> Engine::on_simulation_end;
31 xbt::signal<void(double)> Engine::on_time_advance;
32 xbt::signal<void(void)> Engine::on_deadlock;
34 Engine* Engine::instance_ = nullptr; /* This singleton is awful, but I don't see no other solution right now. */
36 void Engine::initialize(int* argc, char** argv)
38 xbt_assert(Engine::instance_ == nullptr, "It is currently forbidden to create more than one instance of s4u::Engine");
39 Engine::instance_ = this;
41 pimpl->initialize(argc, argv);
42 // Either create a new context with maestro or create
43 // a context object with the current context maestro):
44 kernel::actor::create_maestro(maestro_code);
47 Engine::Engine(std::string name) : pimpl(new kernel::EngineImpl())
50 char* argv = &name[0];
51 initialize(&argc, &argv);
54 Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl())
56 initialize(argc, argv);
61 kernel::EngineImpl::shutdown();
62 Engine::instance_ = nullptr;
65 /** @brief Retrieve the engine singleton */
66 Engine* Engine::get_instance()
68 return get_instance(nullptr, nullptr);
70 Engine* Engine::get_instance(int* argc, char** argv)
72 if (Engine::instance_ == nullptr) {
73 auto e = new Engine(argc, argv);
74 xbt_assert(Engine::instance_ == e);
76 return Engine::instance_;
79 void Engine::shutdown()
81 delete Engine::instance_;
84 double Engine::get_clock()
86 if (MC_is_active() || MC_record_replay_is_active()) {
87 return MC_process_clock_get(kernel::actor::ActorImpl::self());
89 return surf_get_clock();
93 void Engine::add_model(std::shared_ptr<kernel::resource::Model> model,
94 const std::vector<kernel::resource::Model*>& dependencies)
96 kernel::actor::simcall([this, &model, &dependencies] { pimpl->add_model(std::move(model), dependencies); });
99 const std::vector<simgrid::kernel::resource::Model*>& Engine::get_all_models() const
101 return pimpl->get_all_models();
105 * Creates a new platform, including hosts, links, and the routing table.
108 * See also: :ref:`platform`.
111 void Engine::load_platform(const std::string& platf) const
113 pimpl->load_platform(platf);
116 /** Registers the main function of an actor that will be launched from the deployment file */
117 void Engine::register_function(const std::string& name, const std::function<void(int, char**)>& code)
119 kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
120 return xbt::wrap_main(code, std::move(args));
122 register_function(name, code_factory);
125 /** Registers the main function of an actor that will be launched from the deployment file */
126 void Engine::register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code)
128 kernel::actor::ActorCodeFactory code_factory = [code{code}](std::vector<std::string> args) mutable {
129 return std::bind(std::move(code), std::move(args));
131 register_function(name, code_factory);
133 /** Registers a function as the default main function of actors
135 * It will be used as fallback when the function requested from the deployment file was not registered.
136 * It is used for trace-based simulations (see examples/cpp/replay-comms and similar).
138 void Engine::register_default(const std::function<void(int, char**)>& code)
140 register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
142 void Engine::register_default(const kernel::actor::ActorCodeFactory& code)
144 simgrid::kernel::actor::simcall([this, &code]() { pimpl->register_default(code); });
147 void Engine::register_function(const std::string& name, const kernel::actor::ActorCodeFactory& code)
149 simgrid::kernel::actor::simcall([this, name, &code]() { pimpl->register_function(name, code); });
152 /** Load a deployment file and launch the actors that it contains
155 * See also: :ref:`deploy`.
158 void Engine::load_deployment(const std::string& deploy) const
160 pimpl->load_deployment(deploy);
163 /** Returns the amount of hosts in the platform */
164 size_t Engine::get_host_count() const
166 return pimpl->hosts_.size();
169 std::vector<Host*> Engine::get_all_hosts() const
171 std::vector<Host*> res;
172 for (auto const& kv : pimpl->hosts_)
173 res.push_back(kv.second);
177 std::vector<Host*> Engine::get_filtered_hosts(const std::function<bool(Host*)>& filter) const
179 std::vector<Host*> hosts;
180 for (auto const& kv : pimpl->hosts_) {
181 if (filter(kv.second))
182 hosts.push_back(kv.second);
188 void Engine::host_register(const std::string& name, Host* host)
190 pimpl->hosts_[name] = host;
193 void Engine::host_unregister(const std::string& name)
195 pimpl->hosts_.erase(name);
198 /** @brief Find a host from its name.
200 * @throw std::invalid_argument if the searched host does not exist.
202 Host* Engine::host_by_name(const std::string& name) const
204 auto host = pimpl->hosts_.find(name);
205 if (host == pimpl->hosts_.end())
206 throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'"));
210 /** @brief Find a host from its name (or nullptr if that host does not exist) */
211 Host* Engine::host_by_name_or_null(const std::string& name) const
213 auto host = pimpl->hosts_.find(name);
214 return host == pimpl->hosts_.end() ? nullptr : host->second;
217 /** @brief Find a link from its name.
219 * @throw std::invalid_argument if the searched link does not exist.
221 Link* Engine::link_by_name(const std::string& name) const
223 auto link = pimpl->links_.find(name);
224 if (link == pimpl->links_.end())
225 throw std::invalid_argument(std::string("Link not found: ") + name);
226 return link->second->get_iface();
229 SplitDuplexLink* Engine::split_duplex_link_by_name(const std::string& name) const
231 auto link = pimpl->split_duplex_links_.find(name);
232 if (link == pimpl->split_duplex_links_.end())
233 throw std::invalid_argument(std::string("Link not found: ") + name);
234 return link->second->get_iface();
237 /** @brief Find a link from its name (or nullptr if that link does not exist) */
238 Link* Engine::link_by_name_or_null(const std::string& name) const
240 auto link = pimpl->links_.find(name);
241 return link == pimpl->links_.end() ? nullptr : link->second->get_iface();
244 /** @brief Find a mailox from its name or create one if it does not exist) */
245 Mailbox* Engine::mailbox_by_name_or_create(const std::string& name) const
247 /* two actors may have pushed the same mbox_create simcall at the same time */
248 kernel::activity::MailboxImpl* mbox = kernel::actor::simcall([&name, this] {
249 auto m = pimpl->mailboxes_.emplace(name, nullptr);
251 m.first->second = new kernel::activity::MailboxImpl(name);
252 XBT_DEBUG("Creating a mailbox at %p with name %s", m.first->second, name.c_str());
254 return m.first->second;
256 return mbox->get_iface();
259 void Engine::link_register(const std::string& name, const Link* link)
261 pimpl->links_[name] = link->get_impl();
264 void Engine::link_unregister(const std::string& name)
266 pimpl->links_.erase(name);
269 /** @brief Returns the amount of links in the platform */
270 size_t Engine::get_link_count() const
272 return pimpl->links_.size();
275 /** @brief Returns the list of all links found in the platform */
276 std::vector<Link*> Engine::get_all_links() const
278 std::vector<Link*> res;
279 for (auto const& kv : pimpl->links_)
280 res.push_back(kv.second->get_iface());
284 std::vector<Link*> Engine::get_filtered_links(const std::function<bool(Link*)>& filter) const
286 std::vector<Link*> filtered_list;
287 for (auto const& kv : pimpl->links_) {
288 Link* l = kv.second->get_iface();
290 filtered_list.push_back(l);
292 return filtered_list;
295 size_t Engine::get_actor_count() const
297 return pimpl->get_actor_count();
300 std::vector<ActorPtr> Engine::get_all_actors() const
302 std::vector<ActorPtr> actor_list;
303 for (auto const& kv : pimpl->get_actor_list()) {
304 actor_list.push_back(kv.second->get_iface());
309 std::vector<ActorPtr> Engine::get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const
311 std::vector<ActorPtr> actor_list;
312 for (auto const& kv : pimpl->get_actor_list()) {
313 if (filter(kv.second->get_iface()))
314 actor_list.push_back(kv.second->get_iface());
319 void Engine::run() const
321 /* sealing resources before run: links */
322 for (auto* link : get_all_links())
324 /* seal netzone root, recursively seal children netzones, hosts and disks */
325 get_netzone_root()->seal();
327 /* Clean IO before the run */
331 if (MC_is_active()) {
338 /** @brief Retrieve the root netzone, containing all others */
339 s4u::NetZone* Engine::get_netzone_root() const
341 if (pimpl->netzone_root_)
342 return pimpl->netzone_root_->get_iface();
345 /** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */
346 void Engine::set_netzone_root(const s4u::NetZone* netzone)
348 xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set");
349 pimpl->netzone_root_ = netzone->get_impl();
352 static NetZone* netzone_by_name_recursive(NetZone* current, const std::string& name)
354 if (current->get_name() == name)
357 for (auto const& elem : current->get_children()) {
358 NetZone* tmp = netzone_by_name_recursive(elem, name);
359 if (tmp != nullptr) {
366 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
367 NetZone* Engine::netzone_by_name_or_null(const std::string& name) const
369 return netzone_by_name_recursive(get_netzone_root(), name);
372 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
373 kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(const std::string& name) const
375 auto netp = pimpl->netpoints_.find(name);
376 return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
379 kernel::routing::NetPoint* Engine::netpoint_by_name(const std::string& name) const
381 auto netp = netpoint_by_name_or_null(name);
382 if (netp == nullptr) {
383 throw std::invalid_argument(std::string("Netpoint not found: %s") + name);
388 std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints() const
390 std::vector<kernel::routing::NetPoint*> res;
391 for (auto const& kv : pimpl->netpoints_)
392 res.push_back(kv.second);
396 /** @brief Register a new netpoint to the system */
397 void Engine::netpoint_register(kernel::routing::NetPoint* point)
399 simgrid::kernel::actor::simcall([this, point] { pimpl->netpoints_[point->get_name()] = point; });
402 /** @brief Unregister a given netpoint */
403 void Engine::netpoint_unregister(kernel::routing::NetPoint* point)
405 kernel::actor::simcall([this, point] {
406 pimpl->netpoints_.erase(point->get_name());
411 bool Engine::is_initialized()
413 return Engine::instance_ != nullptr;
415 void Engine::set_config(const std::string& str)
417 config::set_parse(str);
419 void Engine::set_config(const std::string& name, int value)
421 config::set_value(name.c_str(), value);
423 void Engine::set_config(const std::string& name, double value)
425 config::set_value(name.c_str(), value);
427 void Engine::set_config(const std::string& name, bool value)
429 config::set_value(name.c_str(), value);
431 void Engine::set_config(const std::string& name, const std::string& value)
433 config::set_value(name.c_str(), value);
436 Engine* Engine::set_default_comm_data_copy_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t))
438 kernel::activity::CommImpl::set_copy_data_callback(callback);
443 } // namespace simgrid
445 double SIMIX_get_clock() // XBT_ATTRIB_DEPRECATED_v332
447 return simgrid::s4u::Engine::get_clock();
450 /* **************************** Public C interface *************************** */
451 void simgrid_init(int* argc, char** argv)
453 static simgrid::s4u::Engine e(argc, argv);
455 void simgrid_load_platform(const char* file)
457 simgrid::s4u::Engine::get_instance()->load_platform(file);
460 void simgrid_load_deployment(const char* file)
462 simgrid::s4u::Engine::get_instance()->load_deployment(file);
466 simgrid::s4u::Engine::get_instance()->run();
468 void simgrid_register_function(const char* name, void (*code)(int, char**))
470 simgrid::s4u::Engine::get_instance()->register_function(name, code);
472 void simgrid_register_default(void (*code)(int, char**))
474 simgrid::s4u::Engine::get_instance()->register_default(code);
476 double simgrid_get_clock()
478 return simgrid::s4u::Engine::get_clock();
481 void simgrid_set_maestro(void (*code)(void*), void* data)
484 XBT_WARN("simgrid_set_maestro is believed to not work on windows. Please help us investigating this issue if "
485 "you need that feature");
487 maestro_code = std::bind(code, data);
489 void SIMIX_set_maestro(void (*code)(void*), void* data) // XBT_ATTRIB_DEPRECATED_v333
491 simgrid_set_maestro(code, data);