1 /* s4u::Engine Simulation Engine and global functions. */
3 /* Copyright (c) 2006-2018. 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/Engine.hpp"
12 #include "simgrid/s4u/Host.hpp"
13 #include "simgrid/s4u/Mailbox.hpp"
14 #include "simgrid/s4u/NetZone.hpp"
15 #include "simgrid/s4u/Storage.hpp"
16 #include "simgrid/simix.h"
17 #include "src/instr/instr_private.hpp"
18 #include "src/kernel/EngineImpl.hpp"
19 #include "src/surf/network_interface.hpp"
20 #include "surf/surf.hpp" // routing_platf. FIXME:KILLME. SOON
22 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
26 xbt::signal<void()> on_platform_creation;
27 xbt::signal<void()> on_platform_created;
28 xbt::signal<void()> on_config_in_platform_done;
29 xbt::signal<void()> on_simulation_end;
30 xbt::signal<void(double)> on_time_advance;
31 xbt::signal<void(void)> on_deadlock;
33 Engine* Engine::instance_ = nullptr; /* That singleton is awful, but I don't see no other solution right now. */
35 Engine::Engine(int* argc, char** argv)
37 xbt_assert(s4u::Engine::instance_ == nullptr,
38 "It is currently forbidden to create more than one instance of s4u::Engine");
40 SIMIX_global_init(argc, argv);
42 pimpl = new kernel::EngineImpl();
43 s4u::Engine::instance_ = this;
49 s4u::Engine::instance_ = nullptr;
52 /** @brief Retrieve the engine singleton */
53 Engine* Engine::get_instance()
55 if (s4u::Engine::instance_ == nullptr)
56 return new Engine(0, nullptr);
58 return s4u::Engine::instance_;
61 void Engine::shutdown()
63 delete s4u::Engine::instance_;
64 s4u::Engine::instance_ = nullptr;
67 double Engine::get_clock()
69 return SIMIX_get_clock();
72 void Engine::load_platform(const char* platf)
74 SIMIX_create_environment(platf);
77 void Engine::register_function(const char* name, int (*code)(int, char**))
79 SIMIX_function_register(name, code);
81 void Engine::register_default(int (*code)(int, char**))
83 SIMIX_function_register_default(code);
85 void Engine::load_deployment(const char* deploy)
87 SIMIX_launch_application(deploy);
89 /** @brief Returns the amount of hosts in the platform */
90 size_t Engine::get_host_count()
92 return pimpl->hosts_.size();
94 /** @brief Fills the passed list with all hosts found in the platform
95 * @deprecated Please prefer Engine::getAllHosts()
97 void Engine::getHostList(std::vector<Host*>* list)
99 for (auto const& kv : pimpl->hosts_)
100 list->push_back(kv.second);
103 /** @brief Returns the list of all hosts found in the platform */
104 std::vector<Host*> Engine::get_all_hosts()
106 std::vector<Host*> res;
107 for (auto const& kv : pimpl->hosts_)
108 res.push_back(kv.second);
112 void Engine::host_register(std::string name, simgrid::s4u::Host* host)
114 pimpl->hosts_[name] = host;
117 void Engine::host_unregister(std::string name)
119 pimpl->hosts_.erase(name);
122 simgrid::s4u::Host* Engine::host_by_name(std::string name)
124 return pimpl->hosts_.at(name); // Will raise a std::out_of_range if the host does not exist
127 simgrid::s4u::Host* Engine::host_by_name_or_null(std::string name)
129 auto host = pimpl->hosts_.find(name);
130 return host == pimpl->hosts_.end() ? nullptr : host->second;
133 /** @brief Returns the amount of storages in the platform */
134 size_t Engine::get_storage_count()
136 return pimpl->storages_.size();
139 /** @brief Returns the list of all storages found in the platform */
140 std::vector<Storage*> Engine::get_all_storages()
142 std::vector<Storage*> res;
143 for (auto const& kv : pimpl->storages_)
144 res.push_back(kv.second);
148 simgrid::s4u::Storage* Engine::storage_by_name(std::string name)
150 return pimpl->storages_.at(name); // Will raise a std::out_of_range if the host does not exist
153 simgrid::s4u::Storage* Engine::storage_by_name_or_null(std::string name)
155 auto storage = pimpl->storages_.find(name);
156 return storage == pimpl->storages_.end() ? nullptr : storage->second;
159 void Engine::storage_register(std::string name, simgrid::s4u::Storage* storage)
161 pimpl->storages_[name] = storage;
164 void Engine::storage_unregister(std::string name)
166 pimpl->storages_.erase(name);
169 /** @brief Returns the amount of links in the platform */
170 size_t Engine::get_link_count()
172 return kernel::resource::LinkImpl::linksCount();
175 /** @brief Returns the list of all links found in the platform */
176 std::vector<Link*> Engine::get_all_links()
178 std::vector<Link*> res;
179 kernel::resource::LinkImpl::linksList(&res);
185 if (MC_is_active()) {
192 s4u::NetZone* Engine::getNetRoot()
194 return pimpl->netzone_root_;
197 static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, const char* name)
199 if (not strcmp(current->get_cname(), name))
202 for (auto const& elem : *(current->getChildren())) {
203 simgrid::s4u::NetZone* tmp = netzone_by_name_recursive(elem, name);
204 if (tmp != nullptr) {
211 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
212 NetZone* Engine::getNetzoneByNameOrNull(const char* name)
214 return netzone_by_name_recursive(getNetRoot(), name);
217 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
218 simgrid::kernel::routing::NetPoint* Engine::getNetpointByNameOrNull(std::string name)
220 auto netp = pimpl->netpoints_.find(name);
221 return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
224 /** @brief Fill the provided vector with all existing netpoints */
225 void Engine::getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*>* list)
227 for (auto const& kv : pimpl->netpoints_)
228 list->push_back(kv.second);
230 std::vector<simgrid::kernel::routing::NetPoint*> Engine::get_all_netpoints()
232 std::vector<simgrid::kernel::routing::NetPoint*> res;
233 for (auto const& kv : pimpl->netpoints_)
234 res.push_back(kv.second);
238 /** @brief Register a new netpoint to the system */
239 void Engine::netpoint_register(simgrid::kernel::routing::NetPoint* point)
241 // simgrid::simix::kernelImmediate([&]{ FIXME: this segfaults in set_thread
242 pimpl->netpoints_[point->get_name()] = point;
245 /** @brief Unregister a given netpoint */
246 void Engine::netpoint_unregister(simgrid::kernel::routing::NetPoint* point)
248 simgrid::simix::kernelImmediate([this, point] {
249 pimpl->netpoints_.erase(point->get_name());
254 bool Engine::is_initialized()
256 return Engine::instance_ != nullptr;
258 void Engine::set_config(std::string str)
260 simgrid::config::set_parse(std::move(str));
263 } // namespace simgrid