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/simix/smx_private.hpp" // For access to simix_global->process_list
18 #include "src/instr/instr_private.hpp"
19 #include "src/kernel/EngineImpl.hpp"
20 #include "src/surf/network_interface.hpp"
21 #include "surf/surf.hpp" // routing_platf. FIXME:KILLME. SOON
25 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
29 xbt::signal<void()> on_platform_creation;
30 xbt::signal<void()> on_platform_created;
31 xbt::signal<void()> on_simulation_end;
32 xbt::signal<void(double)> on_time_advance;
33 xbt::signal<void(void)> on_deadlock;
35 Engine* Engine::instance_ = nullptr; /* That singleton is awful, but I don't see no other solution right now. */
37 Engine::Engine(int* argc, char** argv)
39 xbt_assert(s4u::Engine::instance_ == nullptr,
40 "It is currently forbidden to create more than one instance of s4u::Engine");
42 SIMIX_global_init(argc, argv);
44 pimpl = new kernel::EngineImpl();
45 s4u::Engine::instance_ = this;
51 s4u::Engine::instance_ = nullptr;
54 /** @brief Retrieve the engine singleton */
55 Engine* Engine::get_instance()
57 if (s4u::Engine::instance_ == nullptr)
58 return new Engine(0, nullptr);
60 return s4u::Engine::instance_;
63 void Engine::shutdown()
65 delete s4u::Engine::instance_;
66 s4u::Engine::instance_ = nullptr;
69 double Engine::get_clock()
71 return SIMIX_get_clock();
74 void Engine::load_platform(std::string platf)
76 SIMIX_create_environment(platf);
79 void Engine::register_function(std::string name, int (*code)(int, char**))
81 SIMIX_function_register(name, code);
83 void Engine::register_default(int (*code)(int, char**))
85 SIMIX_function_register_default(code);
87 void Engine::load_deployment(std::string deploy)
89 SIMIX_launch_application(deploy);
91 /** @brief Returns the amount of hosts in the platform */
92 size_t Engine::get_host_count()
94 return pimpl->hosts_.size();
96 /** @brief Fills the passed list with all hosts found in the platform
97 * @deprecated Please prefer Engine::getAllHosts()
99 void Engine::getHostList(std::vector<Host*>* list)
101 for (auto const& kv : pimpl->hosts_)
102 list->push_back(kv.second);
105 /** @brief Returns the list of all hosts found in the platform */
106 std::vector<Host*> Engine::get_all_hosts()
108 std::vector<Host*> res;
109 for (auto const& kv : pimpl->hosts_)
110 res.push_back(kv.second);
114 std::vector<Host*> Engine::get_filtered_hosts(std::function<bool(Host*)> filter)
116 std::vector<Host*> hosts;
117 for (auto const& kv : pimpl->hosts_) {
118 if (filter(kv.second))
119 hosts.push_back(kv.second);
125 void Engine::host_register(std::string name, simgrid::s4u::Host* host)
127 pimpl->hosts_[name] = host;
130 void Engine::host_unregister(std::string name)
132 pimpl->hosts_.erase(name);
135 /** @brief Find an host from its name.
137 * @throw std::invalid_argument if the searched host does not exist.
139 simgrid::s4u::Host* Engine::host_by_name(std::string name)
141 if (pimpl->hosts_.find(name) == pimpl->hosts_.end())
142 throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'"));
143 return pimpl->hosts_.at(name);
146 /** @brief Find an host from its name (or nullptr if that host does not exist) */
147 simgrid::s4u::Host* Engine::host_by_name_or_null(std::string name)
149 auto host = pimpl->hosts_.find(name);
150 return host == pimpl->hosts_.end() ? nullptr : host->second;
153 /** @brief Find a link from its name.
155 * @throw std::invalid_argument if the searched link does not exist.
157 simgrid::s4u::Link* Engine::link_by_name(std::string name)
159 if (pimpl->links_.find(name) == pimpl->links_.end())
160 throw std::invalid_argument(std::string("Link not found: ") + name);
162 return pimpl->links_.at(name);
165 /** @brief Find an link from its name (or nullptr if that link does not exist) */
166 simgrid::s4u::Link* Engine::link_by_name_or_null(std::string name)
168 auto link = pimpl->links_.find(name);
169 return link == pimpl->links_.end() ? nullptr : link->second;
172 void Engine::link_register(std::string name, simgrid::s4u::Link* link)
174 pimpl->links_[name] = link;
177 void Engine::link_unregister(std::string name)
179 pimpl->links_.erase(name);
182 /** @brief Returns the amount of storages in the platform */
183 size_t Engine::get_storage_count()
185 return pimpl->storages_.size();
188 /** @brief Returns the list of all storages found in the platform */
189 std::vector<Storage*> Engine::get_all_storages()
191 std::vector<Storage*> res;
192 for (auto const& kv : pimpl->storages_)
193 res.push_back(kv.second);
197 /** @brief Find a storage from its name.
199 * @throw std::invalid_argument if the searched storage does not exist.
201 simgrid::s4u::Storage* Engine::storage_by_name(std::string name)
203 if (pimpl->storages_.find(name) == pimpl->storages_.end())
204 throw std::invalid_argument(std::string("Storage not found: ") + name);
206 return pimpl->storages_.at(name);
209 /** @brief Find a storage from its name (or nullptr if that storage does not exist) */
210 simgrid::s4u::Storage* Engine::storage_by_name_or_null(std::string name)
212 auto storage = pimpl->storages_.find(name);
213 return storage == pimpl->storages_.end() ? nullptr : storage->second;
216 void Engine::storage_register(std::string name, simgrid::s4u::Storage* storage)
218 pimpl->storages_[name] = storage;
221 void Engine::storage_unregister(std::string name)
223 pimpl->storages_.erase(name);
226 /** @brief Returns the amount of links in the platform */
227 size_t Engine::get_link_count()
229 return pimpl->links_.size();
232 /** @brief Returns the list of all links found in the platform */
233 std::vector<Link*> Engine::get_all_links()
235 std::vector<Link*> res;
236 for (auto const& kv : pimpl->links_)
237 res.push_back(kv.second);
241 std::vector<Link*> Engine::get_filtered_links(std::function<bool(Link*)> filter)
243 std::vector<Link*> filtered_list;
244 for (auto const& kv : pimpl->links_)
245 if (filter(kv.second))
246 filtered_list.push_back(kv.second);
247 return filtered_list;
250 size_t Engine::get_actor_count()
252 return simix_global->process_list.size();
255 std::vector<ActorPtr> Engine::get_all_actors()
257 std::vector<ActorPtr> actor_list;
258 actor_list.push_back(simgrid::s4u::Actor::self());
259 for (auto& kv : simix_global->process_list) {
260 actor_list.push_back(kv.second->iface());
265 std::vector<ActorPtr> Engine::get_filtered_actors(std::function<bool(ActorPtr)> filter)
267 std::vector<ActorPtr> actor_list;
268 for (auto& kv : simix_global->process_list) {
269 if (filter(kv.second->iface()))
270 actor_list.push_back(kv.second->iface());
277 /* Clean IO before the run */
281 if (MC_is_active()) {
288 /** @brief Retrieve the root netzone, containing all others */
289 s4u::NetZone* Engine::get_netzone_root()
291 return pimpl->netzone_root_->get_iface();
293 /** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */
294 void Engine::set_netzone_root(s4u::NetZone* netzone)
296 xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set");
297 pimpl->netzone_root_ = netzone->get_impl();
300 static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, std::string name)
302 if (current->get_name() == name)
305 for (auto const& elem : current->get_children()) {
306 simgrid::s4u::NetZone* tmp = netzone_by_name_recursive(elem, name);
307 if (tmp != nullptr) {
314 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
315 NetZone* Engine::netzone_by_name_or_null(std::string name)
317 return netzone_by_name_recursive(get_netzone_root(), name);
320 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
321 simgrid::kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(std::string name)
323 auto netp = pimpl->netpoints_.find(name);
324 return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
327 /** @brief Fill the provided vector with all existing netpoints */
328 void Engine::getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*>* list)
330 for (auto const& kv : pimpl->netpoints_)
331 list->push_back(kv.second);
333 std::vector<simgrid::kernel::routing::NetPoint*> Engine::get_all_netpoints()
335 std::vector<simgrid::kernel::routing::NetPoint*> res;
336 for (auto const& kv : pimpl->netpoints_)
337 res.push_back(kv.second);
341 /** @brief Register a new netpoint to the system */
342 void Engine::netpoint_register(simgrid::kernel::routing::NetPoint* point)
344 // simgrid::simix::simcall([&]{ FIXME: this segfaults in set_thread
345 pimpl->netpoints_[point->get_name()] = point;
348 /** @brief Unregister a given netpoint */
349 void Engine::netpoint_unregister(simgrid::kernel::routing::NetPoint* point)
351 simgrid::simix::simcall([this, point] {
352 pimpl->netpoints_.erase(point->get_name());
357 bool Engine::is_initialized()
359 return Engine::instance_ != nullptr;
361 void Engine::set_config(std::string str)
363 simgrid::config::set_parse(std::move(str));
366 } // namespace simgrid
368 /* **************************** Public C interface *************************** */
369 void simgrid_init(int* argc, char** argv)
371 simgrid::s4u::Engine e(argc, argv);
373 void simgrid_load_platform(const char* file)
375 simgrid::s4u::Engine::get_instance()->load_platform(file);
378 void simgrid_load_deployment(const char* file)
380 simgrid::s4u::Engine::get_instance()->load_deployment(file);
384 simgrid::s4u::Engine::get_instance()->run();
386 void simgrid_register_function(const char* name, int (*code)(int, char**))
388 simgrid::s4u::Engine::get_instance()->register_function(name, code);
390 void simgrid_register_default(int (*code)(int, char**))
392 simgrid::s4u::Engine::get_instance()->register_default(code);
394 double simgrid_get_clock()
396 return simgrid::s4u::Engine::get_clock();