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>
12 #define SIMIX_H_NO_DEPRECATED_WARNING // avoid deprecation warning on include (remove with XBT_ATTRIB_DEPRECATED_v333)
13 #include <simgrid/simix.h>
16 #include "src/instr/instr_private.hpp"
17 #include "src/kernel/EngineImpl.hpp"
18 #include "src/mc/mc_replay.hpp"
23 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_engine, s4u, "Logging specific to S4U (engine)");
26 static simgrid::kernel::actor::ActorCode maestro_code;
30 xbt::signal<void()> Engine::on_platform_creation;
31 xbt::signal<void()> Engine::on_platform_created;
32 xbt::signal<void()> Engine::on_simulation_start;
33 xbt::signal<void()> Engine::on_simulation_end;
34 xbt::signal<void(double)> Engine::on_time_advance;
35 xbt::signal<void(void)> Engine::on_deadlock;
37 Engine* Engine::instance_ = nullptr; /* This singleton is awful, but I don't see no other solution right now. */
39 void Engine::initialize(int* argc, char** argv)
41 xbt_assert(Engine::instance_ == nullptr, "It is currently forbidden to create more than one instance of s4u::Engine");
42 Engine::instance_ = this;
44 pimpl->initialize(argc, argv);
45 // Either create a new context with maestro or create
46 // a context object with the current context maestro):
47 kernel::actor::create_maestro(maestro_code);
50 Engine::Engine(std::string name) : pimpl(new kernel::EngineImpl())
53 char* argv = &name[0];
54 initialize(&argc, &argv);
57 Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl())
59 initialize(argc, argv);
64 kernel::EngineImpl::shutdown();
65 Engine::instance_ = nullptr;
68 /** @brief Retrieve the engine singleton */
69 Engine* Engine::get_instance()
73 return get_instance(&argc, &argv);
75 Engine* Engine::get_instance(int* argc, char** argv)
77 if (Engine::instance_ == nullptr) {
78 auto e = new Engine(argc, argv);
79 xbt_assert(Engine::instance_ == e);
81 return Engine::instance_;
84 void Engine::shutdown() // XBT_ATTRIB_DEPRECATED_v335
86 delete Engine::instance_;
89 double Engine::get_clock()
91 if (MC_is_active() || MC_record_replay_is_active()) {
92 return MC_process_clock_get(kernel::actor::ActorImpl::self());
94 return kernel::EngineImpl::get_clock();
98 void Engine::add_model(std::shared_ptr<kernel::resource::Model> model,
99 const std::vector<kernel::resource::Model*>& dependencies)
101 kernel::actor::simcall_answered([this, &model, &dependencies] { pimpl->add_model(std::move(model), dependencies); });
104 const std::vector<simgrid::kernel::resource::Model*>& Engine::get_all_models() const
106 return pimpl->get_all_models();
110 * Creates a new platform, including hosts, links, and the routing table.
113 * See also: :ref:`platform`.
116 void Engine::load_platform(const std::string& platf) const
118 pimpl->load_platform(platf);
122 * @brief Seals the platform, finishing the creation of its resources.
124 * This method is optional. The seal() is done automatically when you call Engine::run.
126 void Engine::seal_platform() const
128 pimpl->seal_platform();
131 /** Registers the main function of an actor that will be launched from the deployment file */
132 void Engine::register_function(const std::string& name, const std::function<void(int, char**)>& code)
134 kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
135 return xbt::wrap_main(code, std::move(args));
137 register_function(name, code_factory);
140 /** Registers the main function of an actor that will be launched from the deployment file */
141 void Engine::register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code)
143 kernel::actor::ActorCodeFactory code_factory = [code{code}](std::vector<std::string> args) mutable {
144 return std::bind(std::move(code), std::move(args));
146 register_function(name, code_factory);
148 /** Registers a function as the default main function of actors
150 * It will be used as fallback when the function requested from the deployment file was not registered.
151 * It is used for trace-based simulations (see examples/cpp/replay-comms and similar).
153 void Engine::register_default(const std::function<void(int, char**)>& code)
155 register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
157 void Engine::register_default(const kernel::actor::ActorCodeFactory& code)
159 simgrid::kernel::actor::simcall_answered([this, &code]() { pimpl->register_default(code); });
162 void Engine::register_function(const std::string& name, const kernel::actor::ActorCodeFactory& code)
164 simgrid::kernel::actor::simcall_answered([this, name, &code]() { pimpl->register_function(name, code); });
167 /** Load a deployment file and launch the actors that it contains
170 * See also: :ref:`deploy`.
173 void Engine::load_deployment(const std::string& deploy) const
175 pimpl->load_deployment(deploy);
178 /** Returns the amount of hosts in the platform */
179 size_t Engine::get_host_count() const
181 return pimpl->hosts_.size();
184 std::vector<Host*> Engine::get_all_hosts() const
186 std::vector<Host*> res;
187 for (auto const& kv : pimpl->hosts_)
188 res.push_back(kv.second);
192 std::vector<Host*> Engine::get_filtered_hosts(const std::function<bool(Host*)>& filter) const
194 std::vector<Host*> hosts;
195 for (auto const& kv : pimpl->hosts_) {
196 if (filter(kv.second))
197 hosts.push_back(kv.second);
203 void Engine::host_register(const std::string& name, Host* host)
205 pimpl->hosts_[name] = host;
208 void Engine::host_unregister(const std::string& name)
210 pimpl->hosts_.erase(name);
213 /** @brief Find a host from its name.
215 * @throw std::invalid_argument if the searched host does not exist.
217 Host* Engine::host_by_name(const std::string& name) const
219 auto host = pimpl->hosts_.find(name);
220 if (host == pimpl->hosts_.end())
221 throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'"));
225 /** @brief Find a host from its name (or nullptr if that host does not exist) */
226 Host* Engine::host_by_name_or_null(const std::string& name) const
228 auto host = pimpl->hosts_.find(name);
229 return host == pimpl->hosts_.end() ? nullptr : host->second;
232 /** @brief Find a link from its name.
234 * @throw std::invalid_argument if the searched link does not exist.
236 Link* Engine::link_by_name(const std::string& name) const
238 auto link = pimpl->links_.find(name);
239 if (link == pimpl->links_.end())
240 throw std::invalid_argument(std::string("Link not found: ") + name);
241 return link->second->get_iface();
244 SplitDuplexLink* Engine::split_duplex_link_by_name(const std::string& name) const
246 auto link = pimpl->split_duplex_links_.find(name);
247 if (link == pimpl->split_duplex_links_.end())
248 throw std::invalid_argument(std::string("Link not found: ") + name);
249 return link->second->get_iface();
252 /** @brief Find a link from its name (or nullptr if that link does not exist) */
253 Link* Engine::link_by_name_or_null(const std::string& name) const
255 auto link = pimpl->links_.find(name);
256 return link == pimpl->links_.end() ? nullptr : link->second->get_iface();
259 /** @brief Find a mailox from its name or create one if it does not exist) */
260 Mailbox* Engine::mailbox_by_name_or_create(const std::string& name) const
262 /* two actors may have pushed the same mbox_create simcall at the same time */
263 kernel::activity::MailboxImpl* mbox = kernel::actor::simcall_answered([&name, this] {
264 auto m = pimpl->mailboxes_.emplace(name, nullptr);
266 m.first->second = new kernel::activity::MailboxImpl(name);
267 XBT_DEBUG("Creating a mailbox at %p with name %s", m.first->second, name.c_str());
269 return m.first->second;
271 return mbox->get_iface();
274 void Engine::link_register(const std::string& name, const Link* link)
276 pimpl->links_[name] = link->get_impl();
279 void Engine::link_unregister(const std::string& name)
281 pimpl->links_.erase(name);
284 /** @brief Returns the amount of links in the platform */
285 size_t Engine::get_link_count() const
287 return pimpl->links_.size();
290 /** @brief Returns the list of all links found in the platform */
291 std::vector<Link*> Engine::get_all_links() const
293 std::vector<Link*> res;
294 for (auto const& kv : pimpl->links_)
295 res.push_back(kv.second->get_iface());
299 std::vector<Link*> Engine::get_filtered_links(const std::function<bool(Link*)>& filter) const
301 std::vector<Link*> filtered_list;
302 for (auto const& kv : pimpl->links_) {
303 Link* l = kv.second->get_iface();
305 filtered_list.push_back(l);
307 return filtered_list;
310 size_t Engine::get_actor_count() const
312 return pimpl->get_actor_count();
315 std::vector<ActorPtr> Engine::get_all_actors() const
317 std::vector<ActorPtr> actor_list;
318 for (auto const& kv : pimpl->get_actor_list()) {
319 actor_list.push_back(kv.second->get_iface());
324 std::vector<ActorPtr> Engine::get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const
326 std::vector<ActorPtr> actor_list;
327 for (auto const& kv : pimpl->get_actor_list()) {
328 if (filter(kv.second->get_iface()))
329 actor_list.push_back(kv.second->get_iface());
334 void Engine::run() const
338 void Engine::run_until(double max_date) const
340 static bool callback_called = false;
341 if (not callback_called) {
342 on_simulation_start();
343 callback_called = true;
345 /* Clean IO before the run */
349 if (MC_is_active()) {
352 pimpl->run(max_date);
356 void Engine::track_vetoed_activities(std::set<Activity*>* vetoed_activities) const
358 Activity::set_vetoed_activities(vetoed_activities);
361 /** @brief Retrieve the root netzone, containing all others */
362 s4u::NetZone* Engine::get_netzone_root() const
364 if (pimpl->netzone_root_)
365 return pimpl->netzone_root_->get_iface();
368 /** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */
369 void Engine::set_netzone_root(const s4u::NetZone* netzone)
371 xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set");
372 pimpl->netzone_root_ = netzone->get_impl();
375 static NetZone* netzone_by_name_recursive(NetZone* current, const std::string& name)
377 if (current->get_name() == name)
380 for (auto const& elem : current->get_children()) {
381 NetZone* tmp = netzone_by_name_recursive(elem, name);
382 if (tmp != nullptr) {
389 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
390 NetZone* Engine::netzone_by_name_or_null(const std::string& name) const
392 return netzone_by_name_recursive(get_netzone_root(), name);
395 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
396 kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(const std::string& name) const
398 auto netp = pimpl->netpoints_.find(name);
399 return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
402 kernel::routing::NetPoint* Engine::netpoint_by_name(const std::string& name) const
404 auto netp = netpoint_by_name_or_null(name);
405 if (netp == nullptr) {
406 throw std::invalid_argument(std::string("Netpoint not found: %s") + name);
411 std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints() const
413 std::vector<kernel::routing::NetPoint*> res;
414 for (auto const& kv : pimpl->netpoints_)
415 res.push_back(kv.second);
419 /** @brief Register a new netpoint to the system */
420 void Engine::netpoint_register(kernel::routing::NetPoint* point)
422 simgrid::kernel::actor::simcall_answered([this, point] { pimpl->netpoints_[point->get_name()] = point; });
425 /** @brief Unregister a given netpoint */
426 void Engine::netpoint_unregister(kernel::routing::NetPoint* point)
428 kernel::actor::simcall_answered([this, point] {
429 pimpl->netpoints_.erase(point->get_name());
434 bool Engine::is_initialized()
436 return Engine::instance_ != nullptr;
438 void Engine::set_config(const std::string& str)
440 config::set_parse(str);
442 void Engine::set_config(const std::string& name, int value)
444 config::set_value(name.c_str(), value);
446 void Engine::set_config(const std::string& name, double value)
448 config::set_value(name.c_str(), value);
450 void Engine::set_config(const std::string& name, bool value)
452 config::set_value(name.c_str(), value);
454 void Engine::set_config(const std::string& name, const std::string& value)
456 config::set_value(name.c_str(), value);
459 Engine* Engine::set_default_comm_data_copy_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t))
461 kernel::activity::CommImpl::set_copy_data_callback(callback);
466 } // namespace simgrid
468 double SIMIX_get_clock() // XBT_ATTRIB_DEPRECATED_v332
470 return simgrid::s4u::Engine::get_clock();
473 /* **************************** Public C interface *************************** */
474 void simgrid_init(int* argc, char** argv)
476 static simgrid::s4u::Engine e(argc, argv);
478 void simgrid_load_platform(const char* file)
480 simgrid::s4u::Engine::get_instance()->load_platform(file);
483 void simgrid_load_deployment(const char* file)
485 simgrid::s4u::Engine::get_instance()->load_deployment(file);
489 simgrid::s4u::Engine::get_instance()->run();
491 void simgrid_run_until(double max_date)
493 simgrid::s4u::Engine::get_instance()->run_until(max_date);
495 void simgrid_register_function(const char* name, void (*code)(int, char**))
497 simgrid::s4u::Engine::get_instance()->register_function(name, code);
499 void simgrid_register_default(void (*code)(int, char**))
501 simgrid::s4u::Engine::get_instance()->register_default(code);
503 double simgrid_get_clock()
505 return simgrid::s4u::Engine::get_clock();
508 void simgrid_set_maestro(void (*code)(void*), void* data)
511 XBT_WARN("simgrid_set_maestro is believed to not work on windows. Please help us investigating this issue if "
512 "you need that feature");
514 maestro_code = std::bind(code, data);
516 void SIMIX_set_maestro(void (*code)(void*), void* data) // XBT_ATTRIB_DEPRECATED_v333
518 simgrid_set_maestro(code, data);