1 /* s4u::Engine Simulation Engine and global functions. */
3 /* Copyright (c) 2006-2022. 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"
20 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_engine, s4u, "Logging specific to S4U (engine)");
23 static simgrid::kernel::actor::ActorCode maestro_code;
27 xbt::signal<void()> Engine::on_platform_creation;
28 xbt::signal<void()> Engine::on_platform_created;
29 xbt::signal<void()> Engine::on_simulation_end;
30 xbt::signal<void(double)> Engine::on_time_advance;
31 xbt::signal<void(void)> Engine::on_deadlock;
33 Engine* Engine::instance_ = nullptr; /* This singleton is awful, but I don't see no other solution right now. */
35 void Engine::initialize(int* argc, char** argv)
37 xbt_assert(Engine::instance_ == nullptr, "It is currently forbidden to create more than one instance of s4u::Engine");
38 Engine::instance_ = this;
40 pimpl->initialize(argc, argv);
41 // Either create a new context with maestro or create
42 // a context object with the current context maestro):
43 kernel::actor::create_maestro(maestro_code);
46 Engine::Engine(std::string name) : pimpl(new kernel::EngineImpl())
49 char* argv = &name[0];
50 initialize(&argc, &argv);
53 Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl())
55 initialize(argc, argv);
60 kernel::EngineImpl::shutdown();
61 Engine::instance_ = nullptr;
64 /** @brief Retrieve the engine singleton */
65 Engine* Engine::get_instance()
69 return get_instance(&argc, &argv);
71 Engine* Engine::get_instance(int* argc, char** argv)
73 if (Engine::instance_ == nullptr) {
74 auto e = new Engine(argc, argv);
75 xbt_assert(Engine::instance_ == e);
77 return Engine::instance_;
80 void Engine::shutdown() // XBT_ATTRIB_DEPRECATED_v335
82 delete Engine::instance_;
85 double Engine::get_clock()
87 if (MC_is_active() || MC_record_replay_is_active()) {
88 return MC_process_clock_get(kernel::actor::ActorImpl::self());
90 return kernel::EngineImpl::get_clock();
94 void Engine::add_model(std::shared_ptr<kernel::resource::Model> model,
95 const std::vector<kernel::resource::Model*>& dependencies)
97 kernel::actor::simcall_answered([this, &model, &dependencies] { pimpl->add_model(std::move(model), dependencies); });
100 const std::vector<simgrid::kernel::resource::Model*>& Engine::get_all_models() const
102 return pimpl->get_all_models();
106 * Creates a new platform, including hosts, links, and the routing table.
109 * See also: :ref:`platform`.
112 void Engine::load_platform(const std::string& platf) const
114 pimpl->load_platform(platf);
118 * @brief Seals the platform, finishing the creation of its resources.
120 * This method is optional. The seal() is done automatically when you call Engine::run.
122 void Engine::seal_platform() const
124 pimpl->seal_platform();
127 /** Registers the main function of an actor that will be launched from the deployment file */
128 void Engine::register_function(const std::string& name, const std::function<void(int, char**)>& code)
130 kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
131 return xbt::wrap_main(code, std::move(args));
133 register_function(name, code_factory);
136 /** Registers the main function of an actor that will be launched from the deployment file */
137 void Engine::register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code)
139 kernel::actor::ActorCodeFactory code_factory = [code{code}](std::vector<std::string> args) mutable {
140 return std::bind(std::move(code), std::move(args));
142 register_function(name, code_factory);
144 /** Registers a function as the default main function of actors
146 * It will be used as fallback when the function requested from the deployment file was not registered.
147 * It is used for trace-based simulations (see examples/cpp/replay-comms and similar).
149 void Engine::register_default(const std::function<void(int, char**)>& code)
151 register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
153 void Engine::register_default(const kernel::actor::ActorCodeFactory& code)
155 simgrid::kernel::actor::simcall_answered([this, &code]() { pimpl->register_default(code); });
158 void Engine::register_function(const std::string& name, const kernel::actor::ActorCodeFactory& code)
160 simgrid::kernel::actor::simcall_answered([this, name, &code]() { pimpl->register_function(name, code); });
163 /** Load a deployment file and launch the actors that it contains
166 * See also: :ref:`deploy`.
169 void Engine::load_deployment(const std::string& deploy) const
171 pimpl->load_deployment(deploy);
174 /** Returns the amount of hosts in the platform */
175 size_t Engine::get_host_count() const
177 return pimpl->hosts_.size();
180 std::vector<Host*> Engine::get_all_hosts() const
182 std::vector<Host*> res;
183 for (auto const& kv : pimpl->hosts_)
184 res.push_back(kv.second);
188 std::vector<Host*> Engine::get_filtered_hosts(const std::function<bool(Host*)>& filter) const
190 std::vector<Host*> hosts;
191 for (auto const& kv : pimpl->hosts_) {
192 if (filter(kv.second))
193 hosts.push_back(kv.second);
199 void Engine::host_register(const std::string& name, Host* host)
201 pimpl->hosts_[name] = host;
204 void Engine::host_unregister(const std::string& name)
206 pimpl->hosts_.erase(name);
209 /** @brief Find a host from its name.
211 * @throw std::invalid_argument if the searched host does not exist.
213 Host* Engine::host_by_name(const std::string& name) const
215 auto host = pimpl->hosts_.find(name);
216 if (host == pimpl->hosts_.end())
217 throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'"));
221 /** @brief Find a host from its name (or nullptr if that host does not exist) */
222 Host* Engine::host_by_name_or_null(const std::string& name) const
224 auto host = pimpl->hosts_.find(name);
225 return host == pimpl->hosts_.end() ? nullptr : host->second;
228 /** @brief Find a link from its name.
230 * @throw std::invalid_argument if the searched link does not exist.
232 Link* Engine::link_by_name(const std::string& name) const
234 auto link = pimpl->links_.find(name);
235 if (link == pimpl->links_.end())
236 throw std::invalid_argument(std::string("Link not found: ") + name);
237 return link->second->get_iface();
240 SplitDuplexLink* Engine::split_duplex_link_by_name(const std::string& name) const
242 auto link = pimpl->split_duplex_links_.find(name);
243 if (link == pimpl->split_duplex_links_.end())
244 throw std::invalid_argument(std::string("Link not found: ") + name);
245 return link->second->get_iface();
248 /** @brief Find a link from its name (or nullptr if that link does not exist) */
249 Link* Engine::link_by_name_or_null(const std::string& name) const
251 auto link = pimpl->links_.find(name);
252 return link == pimpl->links_.end() ? nullptr : link->second->get_iface();
255 /** @brief Find a mailox from its name or create one if it does not exist) */
256 Mailbox* Engine::mailbox_by_name_or_create(const std::string& name) const
258 /* two actors may have pushed the same mbox_create simcall at the same time */
259 kernel::activity::MailboxImpl* mbox = kernel::actor::simcall_answered([&name, this] {
260 auto m = pimpl->mailboxes_.emplace(name, nullptr);
262 m.first->second = new kernel::activity::MailboxImpl(name);
263 XBT_DEBUG("Creating a mailbox at %p with name %s", m.first->second, name.c_str());
265 return m.first->second;
267 return mbox->get_iface();
270 void Engine::link_register(const std::string& name, const Link* link)
272 pimpl->links_[name] = link->get_impl();
275 void Engine::link_unregister(const std::string& name)
277 pimpl->links_.erase(name);
280 /** @brief Returns the amount of links in the platform */
281 size_t Engine::get_link_count() const
283 return pimpl->links_.size();
286 /** @brief Returns the list of all links found in the platform */
287 std::vector<Link*> Engine::get_all_links() const
289 std::vector<Link*> res;
290 for (auto const& kv : pimpl->links_)
291 res.push_back(kv.second->get_iface());
295 std::vector<Link*> Engine::get_filtered_links(const std::function<bool(Link*)>& filter) const
297 std::vector<Link*> filtered_list;
298 for (auto const& kv : pimpl->links_) {
299 Link* l = kv.second->get_iface();
301 filtered_list.push_back(l);
303 return filtered_list;
306 size_t Engine::get_actor_count() const
308 return pimpl->get_actor_count();
311 std::vector<ActorPtr> Engine::get_all_actors() const
313 std::vector<ActorPtr> actor_list;
314 for (auto const& kv : pimpl->get_actor_list()) {
315 actor_list.push_back(kv.second->get_iface());
320 std::vector<ActorPtr> Engine::get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const
322 std::vector<ActorPtr> actor_list;
323 for (auto const& kv : pimpl->get_actor_list()) {
324 if (filter(kv.second->get_iface()))
325 actor_list.push_back(kv.second->get_iface());
330 void Engine::run() const
334 void Engine::run_until(double max_date) const
336 /* Clean IO before the run */
340 if (MC_is_active()) {
343 pimpl->run(max_date);
347 void Engine::track_vetoed_activities(std::set<Activity*>* vetoed_activities) const
349 Activity::set_vetoed_activities(vetoed_activities);
352 /** @brief Retrieve the root netzone, containing all others */
353 s4u::NetZone* Engine::get_netzone_root() const
355 if (pimpl->netzone_root_)
356 return pimpl->netzone_root_->get_iface();
359 /** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */
360 void Engine::set_netzone_root(const s4u::NetZone* netzone)
362 xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set");
363 pimpl->netzone_root_ = netzone->get_impl();
366 static NetZone* netzone_by_name_recursive(NetZone* current, const std::string& name)
368 if (current->get_name() == name)
371 for (auto const& elem : current->get_children()) {
372 NetZone* tmp = netzone_by_name_recursive(elem, name);
373 if (tmp != nullptr) {
380 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
381 NetZone* Engine::netzone_by_name_or_null(const std::string& name) const
383 return netzone_by_name_recursive(get_netzone_root(), name);
386 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
387 kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(const std::string& name) const
389 auto netp = pimpl->netpoints_.find(name);
390 return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
393 kernel::routing::NetPoint* Engine::netpoint_by_name(const std::string& name) const
395 auto netp = netpoint_by_name_or_null(name);
396 if (netp == nullptr) {
397 throw std::invalid_argument(std::string("Netpoint not found: %s") + name);
402 std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints() const
404 std::vector<kernel::routing::NetPoint*> res;
405 for (auto const& kv : pimpl->netpoints_)
406 res.push_back(kv.second);
410 /** @brief Register a new netpoint to the system */
411 void Engine::netpoint_register(kernel::routing::NetPoint* point)
413 simgrid::kernel::actor::simcall_answered([this, point] { pimpl->netpoints_[point->get_name()] = point; });
416 /** @brief Unregister a given netpoint */
417 void Engine::netpoint_unregister(kernel::routing::NetPoint* point)
419 kernel::actor::simcall_answered([this, point] {
420 pimpl->netpoints_.erase(point->get_name());
425 bool Engine::is_initialized()
427 return Engine::instance_ != nullptr;
429 void Engine::set_config(const std::string& str)
431 config::set_parse(str);
433 void Engine::set_config(const std::string& name, int value)
435 config::set_value(name.c_str(), value);
437 void Engine::set_config(const std::string& name, double value)
439 config::set_value(name.c_str(), value);
441 void Engine::set_config(const std::string& name, bool value)
443 config::set_value(name.c_str(), value);
445 void Engine::set_config(const std::string& name, const std::string& value)
447 config::set_value(name.c_str(), value);
450 Engine* Engine::set_default_comm_data_copy_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t))
452 kernel::activity::CommImpl::set_copy_data_callback(callback);
457 } // namespace simgrid
459 double SIMIX_get_clock() // XBT_ATTRIB_DEPRECATED_v332
461 return simgrid::s4u::Engine::get_clock();
464 /* **************************** Public C interface *************************** */
465 void simgrid_init(int* argc, char** argv)
467 static simgrid::s4u::Engine e(argc, argv);
469 void simgrid_load_platform(const char* file)
471 simgrid::s4u::Engine::get_instance()->load_platform(file);
474 void simgrid_load_deployment(const char* file)
476 simgrid::s4u::Engine::get_instance()->load_deployment(file);
480 simgrid::s4u::Engine::get_instance()->run();
482 void simgrid_run_until(double max_date)
484 simgrid::s4u::Engine::get_instance()->run_until(max_date);
486 void simgrid_register_function(const char* name, void (*code)(int, char**))
488 simgrid::s4u::Engine::get_instance()->register_function(name, code);
490 void simgrid_register_default(void (*code)(int, char**))
492 simgrid::s4u::Engine::get_instance()->register_default(code);
494 double simgrid_get_clock()
496 return simgrid::s4u::Engine::get_clock();
499 void simgrid_set_maestro(void (*code)(void*), void* data)
502 XBT_WARN("simgrid_set_maestro is believed to not work on windows. Please help us investigating this issue if "
503 "you need that feature");
505 maestro_code = std::bind(code, data);
507 void SIMIX_set_maestro(void (*code)(void*), void* data) // XBT_ATTRIB_DEPRECATED_v333
509 simgrid_set_maestro(code, data);