Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
finish the transition netcards->netpoints in the code
[simgrid.git] / src / kernel / routing / NetZoneImpl.cpp
1 /* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "src/kernel/routing/NetZoneImpl.hpp"
7 #include "simgrid/s4u/engine.hpp"
8 #include "simgrid/s4u/host.hpp"
9 #include "src/kernel/routing/NetPoint.hpp"
10 #include "src/surf/cpu_interface.hpp"
11 #include "src/surf/network_interface.hpp"
12
13 #include "xbt/log.h"
14
15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_route);
16
17 namespace simgrid {
18 namespace kernel {
19 namespace routing {
20
21 class BypassRoute {
22 public:
23   explicit BypassRoute(NetPoint* gwSrc, NetPoint* gwDst) : gw_src(gwSrc), gw_dst(gwDst) {}
24   const NetPoint* gw_src;
25   const NetPoint* gw_dst;
26   std::vector<Link*> links;
27 };
28
29 NetZoneImpl::NetZoneImpl(NetZone* father, const char* name) : NetZone(father, name)
30 {
31   xbt_assert(nullptr == simgrid::s4u::Engine::instance()->netpointByNameOrNull(name),
32              "Refusing to create a second NetZone called '%s'.", name);
33
34   netpoint_ = new NetPoint(name, NetPoint::Type::NetZone, static_cast<NetZoneImpl*>(father));
35   XBT_DEBUG("NetZone '%s' created with the id '%d'", name, netpoint_->id());
36 }
37 NetZoneImpl::~NetZoneImpl()
38 {
39   for (auto& kv : bypassRoutes_)
40     delete kv.second;
41
42   simgrid::s4u::Engine::instance()->netpointUnregister(netpoint_);
43 }
44
45 simgrid::s4u::Host* NetZoneImpl::createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount,
46                                             std::unordered_map<std::string, std::string>* props)
47 {
48   simgrid::s4u::Host* res = new simgrid::s4u::Host(name);
49
50   if (hierarchy_ == RoutingMode::unset)
51     hierarchy_ = RoutingMode::base;
52
53   res->pimpl_netpoint = new NetPoint(name, NetPoint::Type::Host, this);
54
55   surf_cpu_model_pm->createCpu(res, speedPerPstate, coreAmount);
56
57   if (props != nullptr)
58     for (auto kv : *props)
59       res->setProperty(kv.first.c_str(), kv.second.c_str());
60
61   simgrid::s4u::Host::onCreation(*res);
62
63   return res;
64 }
65
66 void NetZoneImpl::addBypassRoute(sg_platf_route_cbarg_t e_route)
67 {
68   /* Argument validity checks */
69   if (e_route->gw_dst) {
70     XBT_DEBUG("Load bypassNetzoneRoute from %s@%s to %s@%s", e_route->src->cname(), e_route->gw_src->cname(),
71               e_route->dst->cname(), e_route->gw_dst->cname());
72     xbt_assert(!e_route->link_list->empty(), "Bypass route between %s@%s and %s@%s cannot be empty.",
73                e_route->src->cname(), e_route->gw_src->cname(), e_route->dst->cname(), e_route->gw_dst->cname());
74     xbt_assert(bypassRoutes_.find({e_route->src, e_route->dst}) == bypassRoutes_.end(),
75                "The bypass route between %s@%s and %s@%s already exists.", e_route->src->cname(),
76                e_route->gw_src->cname(), e_route->dst->cname(), e_route->gw_dst->cname());
77   } else {
78     XBT_DEBUG("Load bypassRoute from %s to %s", e_route->src->cname(), e_route->dst->cname());
79     xbt_assert(!e_route->link_list->empty(), "Bypass route between %s and %s cannot be empty.", e_route->src->cname(),
80                e_route->dst->cname());
81     xbt_assert(bypassRoutes_.find({e_route->src, e_route->dst}) == bypassRoutes_.end(),
82                "The bypass route between %s and %s already exists.", e_route->src->cname(), e_route->dst->cname());
83   }
84
85   /* Build a copy that will be stored in the dict */
86   kernel::routing::BypassRoute* newRoute = new kernel::routing::BypassRoute(e_route->gw_src, e_route->gw_dst);
87   for (auto link : *e_route->link_list)
88     newRoute->links.push_back(link);
89
90   /* Store it */
91   bypassRoutes_.insert({{e_route->src, e_route->dst}, newRoute});
92 }
93
94 /** @brief Get the common ancestor and its first children in each line leading to src and dst
95  *
96  * In the recursive case, this sets common_ancestor, src_ancestor and dst_ancestor are set as follows.
97  * @verbatim
98  *         platform root
99  *               |
100  *              ...                <- possibly long path
101  *               |
102  *         common_ancestor
103  *           /        \
104  *          /          \
105  *         /            \          <- direct links
106  *        /              \
107  *       /                \
108  *  src_ancestor     dst_ancestor  <- must be different in the recursive case
109  *      |                   |
110  *     ...                 ...     <-- possibly long paths (one hop or more)
111  *      |                   |
112  *     src                 dst
113  *  @endverbatim
114  *
115  *  In the base case (when src and dst are in the same netzone), things are as follows:
116  *  @verbatim
117  *                  platform root
118  *                        |
119  *                       ...                      <-- possibly long path
120  *                        |
121  * common_ancestor==src_ancestor==dst_ancestor    <-- all the same value
122  *                   /        \
123  *                  /          \                  <-- direct links (exactly one hop)
124  *                 /            \
125  *              src              dst
126  *  @endverbatim
127  *
128  * A specific recursive case occurs when src is the ancestor of dst. In this case,
129  * the base case routing should be used so the common_ancestor is specifically set
130  * to src_ancestor==dst_ancestor.
131  * Naturally, things are completely symmetrical if dst is the ancestor of src.
132  * @verbatim
133  *            platform root
134  *                  |
135  *                 ...                <-- possibly long path
136  *                  |
137  *  src == src_ancestor==dst_ancestor==common_ancestor <-- same value
138  *                  |
139  *                 ...                <-- possibly long path (one hop or more)
140  *                  |
141  *                 dst
142  *  @endverbatim
143  */
144 static void find_common_ancestors(NetPoint* src, NetPoint* dst,
145                                   /* OUT */ NetZoneImpl** common_ancestor, NetZoneImpl** src_ancestor,
146                                   NetZoneImpl** dst_ancestor)
147 {
148   /* Deal with the easy base case */
149   if (src->netzone() == dst->netzone()) {
150     *common_ancestor = src->netzone();
151     *src_ancestor    = *common_ancestor;
152     *dst_ancestor    = *common_ancestor;
153     return;
154   }
155
156   /* engage the full recursive search */
157
158   /* (1) find the path to root of src and dst*/
159   NetZoneImpl* src_as = src->netzone();
160   NetZoneImpl* dst_as = dst->netzone();
161
162   xbt_assert(src_as, "Host %s must be in a netzone", src->cname());
163   xbt_assert(dst_as, "Host %s must be in a netzone", dst->cname());
164
165   /* (2) find the path to the root routing component */
166   std::vector<NetZoneImpl*> path_src;
167   NetZoneImpl* current = src->netzone();
168   while (current != nullptr) {
169     path_src.push_back(current);
170     current = static_cast<NetZoneImpl*>(current->father());
171   }
172   std::vector<NetZoneImpl*> path_dst;
173   current = dst->netzone();
174   while (current != nullptr) {
175     path_dst.push_back(current);
176     current = static_cast<NetZoneImpl*>(current->father());
177   }
178
179   /* (3) find the common father.
180    * Before that, index_src and index_dst may be different, they both point to nullptr in path_src/path_dst
181    * So we move them down simultaneously as long as they point to the same content.
182    *
183    * This works because all SimGrid platform have a unique root element (that is the last element of both paths).
184    */
185   NetZoneImpl* father = nullptr; // the netzone we dropped on the previous loop iteration
186   while (path_src.size() > 1 && path_dst.size() > 1 &&
187          path_src.at(path_src.size() - 1) == path_dst.at(path_dst.size() - 1)) {
188     father = path_src.at(path_src.size() - 1);
189     path_src.pop_back();
190     path_dst.pop_back();
191   }
192
193   /* (4) we found the difference at least. Finalize the returned values */
194   *src_ancestor = path_src.at(path_src.size() - 1); /* the first different father of src */
195   *dst_ancestor = path_dst.at(path_dst.size() - 1); /* the first different father of dst */
196   if (*src_ancestor == *dst_ancestor) {             // src is the ancestor of dst, or the contrary
197     *common_ancestor = *src_ancestor;
198   } else {
199     *common_ancestor = father;
200   }
201 }
202
203 /* PRECONDITION: this is the common ancestor of src and dst */
204 bool NetZoneImpl::getBypassRoute(routing::NetPoint* src, routing::NetPoint* dst,
205                                  /* OUT */ std::vector<surf::Link*>* links, double* latency)
206 {
207   // If never set a bypass route return nullptr without any further computations
208   if (bypassRoutes_.empty())
209     return false;
210
211   /* Base case, no recursion is needed */
212   if (dst->netzone() == this && src->netzone() == this) {
213     if (bypassRoutes_.find({src, dst}) != bypassRoutes_.end()) {
214       BypassRoute* bypassedRoute = bypassRoutes_.at({src, dst});
215       for (surf::Link* link : bypassedRoute->links) {
216         links->push_back(link);
217         if (latency)
218           *latency += link->latency();
219       }
220       XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links", src->cname(), dst->cname(),
221                 bypassedRoute->links.size());
222       return true;
223     }
224     return false;
225   }
226
227   /* Engage recursive search */
228
229   /* (1) find the path to the root routing component */
230   std::vector<NetZoneImpl*> path_src;
231   NetZone* current = src->netzone();
232   while (current != nullptr) {
233     path_src.push_back(static_cast<NetZoneImpl*>(current));
234     current = current->father_;
235   }
236
237   std::vector<NetZoneImpl*> path_dst;
238   current = dst->netzone();
239   while (current != nullptr) {
240     path_dst.push_back(static_cast<NetZoneImpl*>(current));
241     current = current->father_;
242   }
243
244   /* (2) find the common father */
245   while (path_src.size() > 1 && path_dst.size() > 1 &&
246          path_src.at(path_src.size() - 1) == path_dst.at(path_dst.size() - 1)) {
247     path_src.pop_back();
248     path_dst.pop_back();
249   }
250
251   int max_index_src = path_src.size() - 1;
252   int max_index_dst = path_dst.size() - 1;
253
254   int max_index = std::max(max_index_src, max_index_dst);
255
256   /* (3) Search for a bypass making the path up to the ancestor useless */
257   BypassRoute* bypassedRoute = nullptr;
258   std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*> key;
259   for (int max = 0; max <= max_index; max++) {
260     for (int i = 0; i < max; i++) {
261       if (i <= max_index_src && max <= max_index_dst) {
262         key = {path_src.at(i)->netpoint_, path_dst.at(max)->netpoint_};
263         if (bypassRoutes_.find(key) != bypassRoutes_.end()) {
264           bypassedRoute = bypassRoutes_.at(key);
265           break;
266         }
267       }
268       if (max <= max_index_src && i <= max_index_dst) {
269         key = {path_src.at(max)->netpoint_, path_dst.at(i)->netpoint_};
270         if (bypassRoutes_.find(key) != bypassRoutes_.end()) {
271           bypassedRoute = bypassRoutes_.at(key);
272           break;
273         }
274       }
275     }
276
277     if (bypassedRoute)
278       break;
279
280     if (max <= max_index_src && max <= max_index_dst) {
281       key = {path_src.at(max)->netpoint_, path_dst.at(max)->netpoint_};
282       if (bypassRoutes_.find(key) != bypassRoutes_.end()) {
283         bypassedRoute = bypassRoutes_.at(key);
284         break;
285       }
286     }
287   }
288
289   /* (4) If we have the bypass, use it. If not, caller will do the Right Thing. */
290   if (bypassedRoute) {
291     XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links. We may have to complete it with recursive "
292               "calls to getRoute",
293               src->cname(), dst->cname(), bypassedRoute->links.size());
294     if (src != key.first)
295       getGlobalRoute(src, const_cast<NetPoint*>(bypassedRoute->gw_src), links, latency);
296     for (surf::Link* link : bypassedRoute->links) {
297       links->push_back(link);
298       if (latency)
299         *latency += link->latency();
300     }
301     if (dst != key.second)
302       getGlobalRoute(const_cast<NetPoint*>(bypassedRoute->gw_dst), dst, links, latency);
303     return true;
304   }
305   XBT_DEBUG("No bypass route from '%s' to '%s'.", src->cname(), dst->cname());
306   return false;
307 }
308
309 void NetZoneImpl::getGlobalRoute(routing::NetPoint* src, routing::NetPoint* dst,
310                                  /* OUT */ std::vector<surf::Link*>* links, double* latency)
311 {
312   s_sg_platf_route_cbarg_t route;
313   memset(&route, 0, sizeof(route));
314
315   XBT_DEBUG("Resolve route from '%s' to '%s'", src->cname(), dst->cname());
316
317   /* Find how src and dst are interconnected */
318   NetZoneImpl *common_ancestor, *src_ancestor, *dst_ancestor;
319   find_common_ancestors(src, dst, &common_ancestor, &src_ancestor, &dst_ancestor);
320   XBT_DEBUG("elements_father: common ancestor '%s' src ancestor '%s' dst ancestor '%s'", common_ancestor->name(),
321             src_ancestor->name(), dst_ancestor->name());
322
323   /* Check whether a direct bypass is defined. If so, use it and bail out */
324   if (common_ancestor->getBypassRoute(src, dst, links, latency))
325     return;
326
327   /* If src and dst are in the same netzone, life is good */
328   if (src_ancestor == dst_ancestor) { /* SURF_ROUTING_BASE */
329     route.link_list = links;
330     common_ancestor->getLocalRoute(src, dst, &route, latency);
331     return;
332   }
333
334   /* Not in the same netzone, no bypass. We'll have to find our path between the netzones recursively */
335
336   route.link_list = new std::vector<surf::Link*>();
337
338   common_ancestor->getLocalRoute(src_ancestor->netpoint_, dst_ancestor->netpoint_, &route, latency);
339   xbt_assert((route.gw_src != nullptr) && (route.gw_dst != nullptr), "bad gateways for route from \"%s\" to \"%s\"",
340              src->cname(), dst->cname());
341
342   /* If source gateway is not our source, we have to recursively find our way up to this point */
343   if (src != route.gw_src)
344     getGlobalRoute(src, route.gw_src, links, latency);
345   for (auto link : *route.link_list)
346     links->push_back(link);
347   delete route.link_list;
348
349   /* If dest gateway is not our destination, we have to recursively find our way from this point */
350   if (route.gw_dst != dst)
351     getGlobalRoute(route.gw_dst, dst, links, latency);
352 }
353 }
354 }
355 } // namespace