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. */
8 #include "instr/instr_interface.hpp"
10 #include "simgrid/kernel/routing/NetPoint.hpp"
11 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
12 #include "simgrid/s4u/Engine.hpp"
13 #include "simgrid/s4u/Host.hpp"
14 #include "simgrid/s4u/Mailbox.hpp"
15 #include "simgrid/s4u/NetZone.hpp"
16 #include "simgrid/s4u/Storage.hpp"
17 #include "simgrid/simix.h"
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()> onPlatformCreated;
27 xbt::signal<void()> onSimulationEnd;
28 xbt::signal<void(double)> onTimeAdvance;
29 xbt::signal<void(void)> onDeadlock;
31 Engine* Engine::instance_ = nullptr; /* That singleton is awful, but I don't see no other solution right now. */
33 Engine::Engine(int* argc, char** argv)
35 xbt_assert(s4u::Engine::instance_ == nullptr,
36 "It is currently forbidden to create more than one instance of s4u::Engine");
38 SIMIX_global_init(argc, argv);
40 pimpl = new kernel::EngineImpl();
41 s4u::Engine::instance_ = this;
47 s4u::Engine::instance_ = nullptr;
50 Engine* Engine::getInstance()
52 if (s4u::Engine::instance_ == nullptr)
53 return new Engine(0, nullptr);
55 return s4u::Engine::instance_;
58 void Engine::shutdown()
60 delete s4u::Engine::instance_;
61 s4u::Engine::instance_ = nullptr;
64 double Engine::get_clock()
66 return SIMIX_get_clock();
69 void Engine::load_platform(const char* platf)
71 SIMIX_create_environment(platf);
74 void Engine::register_function(const char* name, int (*code)(int, char**))
76 SIMIX_function_register(name, code);
78 void Engine::register_default(int (*code)(int, char**))
80 SIMIX_function_register_default(code);
82 void Engine::load_deployment(const char* deploy)
84 SIMIX_launch_application(deploy);
86 /** @brief Returns the amount of hosts in the platform */
87 size_t Engine::get_host_count()
89 return pimpl->hosts_.size();
91 /** @brief Fills the passed list with all hosts found in the platform
92 * @deprecated Please prefer Engine::getAllHosts()
94 void Engine::getHostList(std::vector<Host*>* list)
96 for (auto const& kv : pimpl->hosts_)
97 list->push_back(kv.second);
100 /** @brief Returns the list of all hosts found in the platform */
101 std::vector<Host*> Engine::get_all_hosts()
103 std::vector<Host*> res;
104 for (auto const& kv : pimpl->hosts_)
105 res.push_back(kv.second);
109 void Engine::host_register(std::string name, simgrid::s4u::Host* host)
111 pimpl->hosts_[name] = host;
114 void Engine::host_unregister(std::string name)
116 pimpl->hosts_.erase(name);
119 simgrid::s4u::Host* Engine::host_by_name(std::string name)
121 return pimpl->hosts_.at(name); // Will raise a std::out_of_range if the host does not exist
124 simgrid::s4u::Host* Engine::host_by_name_or_null(std::string name)
126 auto host = pimpl->hosts_.find(name);
127 return host == pimpl->hosts_.end() ? nullptr : host->second;
130 /** @brief Returns the amount of storages in the platform */
131 size_t Engine::get_storage_count()
133 return pimpl->storages_.size();
136 /** @brief Returns the list of all storages found in the platform */
137 std::vector<Storage*> Engine::get_all_storages()
139 std::vector<Storage*> res;
140 for (auto const& kv : pimpl->storages_)
141 res.push_back(kv.second);
145 simgrid::s4u::Storage* Engine::storage_by_name(std::string name)
147 return pimpl->storages_.at(name); // Will raise a std::out_of_range if the host does not exist
150 simgrid::s4u::Storage* Engine::storage_by_name_or_null(std::string name)
152 auto storage = pimpl->storages_.find(name);
153 return storage == pimpl->storages_.end() ? nullptr : storage->second;
156 void Engine::storage_register(std::string name, simgrid::s4u::Storage* storage)
158 pimpl->storages_[name] = storage;
161 void Engine::storage_unregister(std::string name)
163 pimpl->storages_.erase(name);
166 /** @brief Returns the amount of links in the platform */
167 size_t Engine::get_link_count()
169 return kernel::resource::LinkImpl::linksCount();
172 /** @brief Returns the list of all links found in the platform */
173 std::vector<Link*> Engine::get_all_links()
175 std::vector<Link*> res;
176 kernel::resource::LinkImpl::linksList(&res);
182 if (MC_is_active()) {
189 s4u::NetZone* Engine::getNetRoot()
191 return pimpl->netRoot_;
194 static s4u::NetZone* netzoneByNameRecursive(s4u::NetZone* current, const char* name)
196 if (not strcmp(current->get_cname(), name))
199 for (auto const& elem : *(current->getChildren())) {
200 simgrid::s4u::NetZone* tmp = netzoneByNameRecursive(elem, name);
201 if (tmp != nullptr) {
208 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
209 NetZone* Engine::getNetzoneByNameOrNull(const char* name)
211 return netzoneByNameRecursive(getNetRoot(), name);
214 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
215 simgrid::kernel::routing::NetPoint* Engine::getNetpointByNameOrNull(std::string name)
217 auto netp = pimpl->netpoints_.find(name);
218 return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
221 /** @brief Fill the provided vector with all existing netpoints */
222 void Engine::getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*>* list)
224 for (auto const& kv : pimpl->netpoints_)
225 list->push_back(kv.second);
227 /** @brief Register a new netpoint to the system */
228 void Engine::netpoint_register(simgrid::kernel::routing::NetPoint* point)
230 // simgrid::simix::kernelImmediate([&]{ FIXME: this segfaults in set_thread
231 pimpl->netpoints_[point->get_name()] = point;
234 /** @brief Unregister a given netpoint */
235 void Engine::netpoint_unregister(simgrid::kernel::routing::NetPoint* point)
237 simgrid::simix::kernelImmediate([this, point] {
238 pimpl->netpoints_.erase(point->get_name());
243 bool Engine::isInitialized()
245 return Engine::instance_ != nullptr;
247 void Engine::setConfig(std::string str)
249 simgrid::config::set_parse(std::move(str));
252 } // namespace simgrid