1 /* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
7 #include "simgrid/kernel/routing/NetPoint.hpp"
8 #include "simgrid/s4u/Engine.hpp"
9 #include "simgrid/s4u/Host.hpp"
10 #include "src/surf/cpu_interface.hpp"
11 #include "src/surf/network_interface.hpp"
12 #include "src/surf/xml/platf_private.hpp"
13 #include "surf/surf.hpp"
15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_route);
21 NetZoneImpl::NetZoneImpl(NetZoneImpl* father, const std::string& name, resource::NetworkModel* network_model)
22 : piface_(this), father_(father), name_(name), network_model_(network_model)
24 xbt_assert(nullptr == s4u::Engine::get_instance()->netpoint_by_name_or_null(get_name()),
25 "Refusing to create a second NetZone called '%s'.", get_cname());
27 netpoint_ = new NetPoint(name_, NetPoint::Type::NetZone, father_);
28 XBT_DEBUG("NetZone '%s' created with the id '%u'", get_cname(), netpoint_->id());
31 NetZoneImpl::~NetZoneImpl()
33 for (auto const& nz : children_)
36 for (auto const& kv : bypass_routes_)
39 s4u::Engine::get_instance()->netpoint_unregister(netpoint_);
42 /** @brief Returns the list of the hosts found in this NetZone (not recursively)
44 * Only the hosts that are directly contained in this NetZone are retrieved,
45 * not the ones contained in sub-netzones.
47 std::vector<s4u::Host*> NetZoneImpl::get_all_hosts() const
49 std::vector<s4u::Host*> res;
50 for (auto const& card : get_vertices()) {
51 s4u::Host* host = s4u::Host::by_name_or_null(card->get_name());
57 int NetZoneImpl::get_host_count() const
60 for (auto const& card : get_vertices()) {
61 const s4u::Host* host = s4u::Host::by_name_or_null(card->get_name());
68 s4u::Host* NetZoneImpl::create_host(const std::string& name, const std::vector<double>& speed_per_pstate,
69 int coreAmount, const std::map<std::string, std::string>* props)
71 auto* res = new s4u::Host(name);
73 if (hierarchy_ == RoutingMode::unset)
74 hierarchy_ = RoutingMode::base;
76 res->set_netpoint(new NetPoint(name, NetPoint::Type::Host, this));
78 surf_cpu_model_pm->create_cpu(res, speed_per_pstate, coreAmount);
81 res->set_properties(*props);
83 s4u::Host::on_creation(*res); // notify the signal
88 int NetZoneImpl::add_component(NetPoint* elm)
90 vertices_.push_back(elm);
91 return vertices_.size() - 1; // The rank of the newly created object
94 void NetZoneImpl::add_route(NetPoint* /*src*/, NetPoint* /*dst*/, NetPoint* /*gw_src*/, NetPoint* /*gw_dst*/,
95 std::vector<resource::LinkImpl*>& /*link_list*/, bool /*symmetrical*/)
97 xbt_die("NetZone '%s' does not accept new routes (wrong class).", get_cname());
100 void NetZoneImpl::add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
101 std::vector<resource::LinkImpl*>& link_list, bool /* symmetrical */)
103 /* Argument validity checks */
105 XBT_DEBUG("Load bypassNetzoneRoute from %s@%s to %s@%s", src->get_cname(), gw_src->get_cname(), dst->get_cname(),
106 gw_dst->get_cname());
107 xbt_assert(not link_list.empty(), "Bypass route between %s@%s and %s@%s cannot be empty.", src->get_cname(),
108 gw_src->get_cname(), dst->get_cname(), gw_dst->get_cname());
109 xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
110 "The bypass route between %s@%s and %s@%s already exists.", src->get_cname(), gw_src->get_cname(),
111 dst->get_cname(), gw_dst->get_cname());
113 XBT_DEBUG("Load bypassRoute from %s to %s", src->get_cname(), dst->get_cname());
114 xbt_assert(not link_list.empty(), "Bypass route between %s and %s cannot be empty.", src->get_cname(),
116 xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
117 "The bypass route between %s and %s already exists.", src->get_cname(), dst->get_cname());
120 /* Build a copy that will be stored in the dict */
121 auto* newRoute = new BypassRoute(gw_src, gw_dst);
122 for (auto const& link : link_list)
123 newRoute->links.push_back(link);
126 bypass_routes_.insert({{src, dst}, newRoute});
129 /** @brief Get the common ancestor and its first children in each line leading to src and dst
131 * In the recursive case, this sets common_ancestor, src_ancestor and dst_ancestor are set as follows.
135 * ... <- possibly long path
140 * / \ <- direct links
143 * src_ancestor dst_ancestor <- must be different in the recursive case
145 * ... ... <-- possibly long paths (one hop or more)
150 * In the base case (when src and dst are in the same netzone), things are as follows:
154 * ... <-- possibly long path
156 * common_ancestor==src_ancestor==dst_ancestor <-- all the same value
158 * / \ <-- direct links (exactly one hop)
163 * A specific recursive case occurs when src is the ancestor of dst. In this case,
164 * the base case routing should be used so the common_ancestor is specifically set
165 * to src_ancestor==dst_ancestor.
166 * Naturally, things are completely symmetrical if dst is the ancestor of src.
170 * ... <-- possibly long path
172 * src == src_ancestor==dst_ancestor==common_ancestor <-- same value
174 * ... <-- possibly long path (one hop or more)
179 static void find_common_ancestors(NetPoint* src, NetPoint* dst,
180 /* OUT */ NetZoneImpl** common_ancestor, NetZoneImpl** src_ancestor,
181 NetZoneImpl** dst_ancestor)
183 /* Deal with the easy base case */
184 if (src->get_englobing_zone() == dst->get_englobing_zone()) {
185 *common_ancestor = src->get_englobing_zone();
186 *src_ancestor = *common_ancestor;
187 *dst_ancestor = *common_ancestor;
191 /* engage the full recursive search */
193 /* (1) find the path to root of src and dst*/
194 const NetZoneImpl* src_as = src->get_englobing_zone();
195 const NetZoneImpl* dst_as = dst->get_englobing_zone();
197 xbt_assert(src_as, "Host %s must be in a netzone", src->get_cname());
198 xbt_assert(dst_as, "Host %s must be in a netzone", dst->get_cname());
200 /* (2) find the path to the root routing component */
201 std::vector<NetZoneImpl*> path_src;
202 NetZoneImpl* current = src->get_englobing_zone();
203 while (current != nullptr) {
204 path_src.push_back(current);
205 current = current->get_father();
207 std::vector<NetZoneImpl*> path_dst;
208 current = dst->get_englobing_zone();
209 while (current != nullptr) {
210 path_dst.push_back(current);
211 current = current->get_father();
214 /* (3) find the common father.
215 * Before that, index_src and index_dst may be different, they both point to nullptr in path_src/path_dst
216 * So we move them down simultaneously as long as they point to the same content.
218 * This works because all SimGrid platform have a unique root element (that is the last element of both paths).
220 NetZoneImpl* father = nullptr; // the netzone we dropped on the previous loop iteration
221 while (path_src.size() > 1 && path_dst.size() > 1 &&
222 path_src.at(path_src.size() - 1) == path_dst.at(path_dst.size() - 1)) {
223 father = path_src.at(path_src.size() - 1);
228 /* (4) we found the difference at least. Finalize the returned values */
229 *src_ancestor = path_src.at(path_src.size() - 1); /* the first different father of src */
230 *dst_ancestor = path_dst.at(path_dst.size() - 1); /* the first different father of dst */
231 if (*src_ancestor == *dst_ancestor) { // src is the ancestor of dst, or the contrary
232 *common_ancestor = *src_ancestor;
234 *common_ancestor = father;
238 /* PRECONDITION: this is the common ancestor of src and dst */
239 bool NetZoneImpl::get_bypass_route(NetPoint* src, NetPoint* dst,
240 /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency)
242 // If never set a bypass route return nullptr without any further computations
243 if (bypass_routes_.empty())
246 /* Base case, no recursion is needed */
247 if (dst->get_englobing_zone() == this && src->get_englobing_zone() == this) {
248 if (bypass_routes_.find({src, dst}) != bypass_routes_.end()) {
249 const BypassRoute* bypassedRoute = bypass_routes_.at({src, dst});
250 for (resource::LinkImpl* const& link : bypassedRoute->links) {
251 links.push_back(link);
253 *latency += link->get_latency();
255 XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links", src->get_cname(), dst->get_cname(),
256 bypassedRoute->links.size());
262 /* Engage recursive search */
264 /* (1) find the path to the root routing component */
265 std::vector<NetZoneImpl*> path_src;
266 NetZoneImpl* current = src->get_englobing_zone();
267 while (current != nullptr) {
268 path_src.push_back(current);
269 current = current->father_;
272 std::vector<NetZoneImpl*> path_dst;
273 current = dst->get_englobing_zone();
274 while (current != nullptr) {
275 path_dst.push_back(current);
276 current = current->father_;
279 /* (2) find the common father */
280 while (path_src.size() > 1 && path_dst.size() > 1 &&
281 path_src.at(path_src.size() - 1) == path_dst.at(path_dst.size() - 1)) {
286 int max_index_src = path_src.size() - 1;
287 int max_index_dst = path_dst.size() - 1;
289 int max_index = std::max(max_index_src, max_index_dst);
291 /* (3) Search for a bypass making the path up to the ancestor useless */
292 const BypassRoute* bypassedRoute = nullptr;
293 std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*> key;
294 for (int max = 0; max <= max_index; max++) {
295 for (int i = 0; i < max; i++) {
296 if (i <= max_index_src && max <= max_index_dst) {
297 key = {path_src.at(i)->netpoint_, path_dst.at(max)->netpoint_};
298 auto bpr = bypass_routes_.find(key);
299 if (bpr != bypass_routes_.end()) {
300 bypassedRoute = bpr->second;
304 if (max <= max_index_src && i <= max_index_dst) {
305 key = {path_src.at(max)->netpoint_, path_dst.at(i)->netpoint_};
306 auto bpr = bypass_routes_.find(key);
307 if (bpr != bypass_routes_.end()) {
308 bypassedRoute = bpr->second;
317 if (max <= max_index_src && max <= max_index_dst) {
318 key = {path_src.at(max)->netpoint_, path_dst.at(max)->netpoint_};
319 auto bpr = bypass_routes_.find(key);
320 if (bpr != bypass_routes_.end()) {
321 bypassedRoute = bpr->second;
327 /* (4) If we have the bypass, use it. If not, caller will do the Right Thing. */
329 XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links. We may have to complete it with recursive "
331 src->get_cname(), dst->get_cname(), bypassedRoute->links.size());
332 if (src != key.first)
333 get_global_route(src, bypassedRoute->gw_src, links, latency);
334 for (resource::LinkImpl* const& link : bypassedRoute->links) {
335 links.push_back(link);
337 *latency += link->get_latency();
339 if (dst != key.second)
340 get_global_route(bypassedRoute->gw_dst, dst, links, latency);
343 XBT_DEBUG("No bypass route from '%s' to '%s'.", src->get_cname(), dst->get_cname());
347 void NetZoneImpl::get_global_route(NetPoint* src, NetPoint* dst,
348 /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency)
350 RouteCreationArgs route;
352 XBT_DEBUG("Resolve route from '%s' to '%s'", src->get_cname(), dst->get_cname());
354 /* Find how src and dst are interconnected */
355 NetZoneImpl *common_ancestor;
356 NetZoneImpl *src_ancestor;
357 NetZoneImpl *dst_ancestor;
358 find_common_ancestors(src, dst, &common_ancestor, &src_ancestor, &dst_ancestor);
359 XBT_DEBUG("elements_father: common ancestor '%s' src ancestor '%s' dst ancestor '%s'", common_ancestor->get_cname(),
360 src_ancestor->get_cname(), dst_ancestor->get_cname());
362 /* Check whether a direct bypass is defined. If so, use it and bail out */
363 if (common_ancestor->get_bypass_route(src, dst, links, latency))
366 /* If src and dst are in the same netzone, life is good */
367 if (src_ancestor == dst_ancestor) { /* SURF_ROUTING_BASE */
368 route.link_list = std::move(links);
369 common_ancestor->get_local_route(src, dst, &route, latency);
370 links = std::move(route.link_list);
374 /* Not in the same netzone, no bypass. We'll have to find our path between the netzones recursively */
376 common_ancestor->get_local_route(src_ancestor->netpoint_, dst_ancestor->netpoint_, &route, latency);
377 xbt_assert((route.gw_src != nullptr) && (route.gw_dst != nullptr), "bad gateways for route from \"%s\" to \"%s\"",
378 src->get_cname(), dst->get_cname());
380 /* If source gateway is not our source, we have to recursively find our way up to this point */
381 if (src != route.gw_src)
382 get_global_route(src, route.gw_src, links, latency);
383 for (auto const& link : route.link_list)
384 links.push_back(link);
386 /* If dest gateway is not our destination, we have to recursively find our way from this point */
387 if (route.gw_dst != dst)
388 get_global_route(route.gw_dst, dst, links, latency);
390 } // namespace routing
391 } // namespace kernel
392 } // namespace simgrid