1 /* s4u::Engine Simulation Engine and global functions. */
3 /* Copyright (c) 2006-2017. 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.h"
10 #include "simgrid/s4u/Engine.hpp"
11 #include "simgrid/s4u/Host.hpp"
12 #include "simgrid/s4u/Mailbox.hpp"
13 #include "simgrid/s4u/NetZone.hpp"
14 #include "simgrid/s4u/Storage.hpp"
15 #include "simgrid/simix.h"
16 #include "src/kernel/EngineImpl.hpp"
17 #include "src/kernel/routing/NetPoint.hpp"
18 #include "src/kernel/routing/NetZoneImpl.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) {
34 xbt_assert(s4u::Engine::instance_ == nullptr, "It is currently forbidden to create more than one instance of s4u::Engine");
36 SIMIX_global_init(argc, argv);
38 pimpl = new kernel::EngineImpl();
39 s4u::Engine::instance_ = this;
45 s4u::Engine::instance_ = nullptr;
48 Engine* Engine::getInstance()
50 if (s4u::Engine::instance_ == nullptr)
51 return new Engine(0, nullptr);
53 return s4u::Engine::instance_;
56 void Engine::shutdown() {
57 delete s4u::Engine::instance_;
58 s4u::Engine::instance_ = nullptr;
61 double Engine::getClock()
63 return SIMIX_get_clock();
66 void Engine::loadPlatform(const char *platf)
68 SIMIX_create_environment(platf);
71 void Engine::registerFunction(const char*name, int (*code)(int,char**))
73 SIMIX_function_register(name,code);
75 void Engine::registerDefault(int (*code)(int,char**))
77 SIMIX_function_register_default(code);
79 void Engine::loadDeployment(const char *deploy)
81 SIMIX_launch_application(deploy);
83 /** @brief Returns the amount of hosts in the platform */
84 size_t Engine::getHostCount()
86 return pimpl->hosts_.size();
88 /** @brief Fills the passed list with all hosts found in the platform
89 * @deprecated Please prefer Engine::getAllHosts()
91 void XBT_ATTRIB_DEPRECATED_v322("Engine::getHostList() is deprecated in favor of Engine::getAllHosts(). Please switch before v3.22")
92 Engine::getHostList(std::vector<Host*>* list)
94 for (auto const& kv : pimpl->hosts_)
95 list->push_back(kv.second);
98 /** @brief Returns the list of all hosts found in the platform */
99 std::vector<Host*> Engine::getAllHosts()
101 std::vector<Host*> res;
102 for (auto const& kv : pimpl->hosts_)
103 res.push_back(kv.second);
107 void Engine::addHost(std::string name, simgrid::s4u::Host* host)
109 pimpl->hosts_[name] = host;
112 void Engine::delHost(std::string name)
114 pimpl->hosts_.erase(name);
117 simgrid::s4u::Host* Engine::hostByName(std::string name)
119 return pimpl->hosts_.at(name); // Will raise a std::out_of_range if the host does not exist
122 simgrid::s4u::Host* Engine::hostByNameOrNull(std::string name)
124 auto host = pimpl->hosts_.find(name);
125 return host == pimpl->hosts_.end() ? nullptr : host->second;
128 /** @brief Returns the list of all storages found in the platform */
129 std::vector<Storage*> Engine::getAllStorages()
131 std::vector<Storage*> res;
132 for (auto const& kv : pimpl->storages_)
133 res.push_back(kv.second);
137 simgrid::s4u::Storage* Engine::storageByName(std::string name)
139 return pimpl->storages_.at(name); // Will raise a std::out_of_range if the host does not exist
142 simgrid::s4u::Storage* Engine::storageByNameOrNull(std::string name)
144 auto storage = pimpl->storages_.find(name);
145 return storage == pimpl->storages_.end() ? nullptr : storage->second;
148 void Engine::addStorage(std::string name, simgrid::s4u::Storage* storage)
150 pimpl->storages_[name] = storage;
153 void Engine::delStorage(std::string name)
155 pimpl->storages_.erase(name);
158 /** @brief Returns the amount of links in the platform */
159 size_t Engine::getLinkCount()
161 return simgrid::surf::LinkImpl::linksCount();
164 /** @brief Fills the passed list with all links found in the platform
166 * @deprecated. Prefer Engine::getAllLinks() */
167 void XBT_ATTRIB_DEPRECATED_v322("Engine::getLinkList() is deprecated in favor of Engine::getAllLinks(). Please switch before v3.22")
168 Engine::getLinkList(std::vector<Link*>* list)
170 simgrid::surf::LinkImpl::linksList(list);
173 /** @brief Returns the list of all links found in the platform */
174 std::vector<Link*> Engine::getAllLinks()
176 std::vector<Link*> res;
177 simgrid::surf::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->getCname(), 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::netpointRegister(simgrid::kernel::routing::NetPoint* point)
230 // simgrid::simix::kernelImmediate([&]{ FIXME: this segfaults in set_thread
231 pimpl->netpoints_[point->getName()] = point;
234 /** @brief Unregister a given netpoint */
235 void Engine::netpointUnregister(simgrid::kernel::routing::NetPoint* point)
237 simgrid::simix::kernelImmediate([this, point] {
238 pimpl->netpoints_.erase(point->getName());
243 bool Engine::isInitialized()
245 return Engine::instance_ != nullptr;
247 void Engine::setConfig(std::string str)
249 xbt_cfg_set_parse(str.c_str());