src/kernel/routing/NetZoneImpl.cpp

   1 /* Copyright (c) 2006-2021. 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 "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"
  14
  15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_route);
  16
  17 namespace simgrid {
  18 namespace kernel {
  19 namespace routing {
  20
  21 NetZoneImpl::NetZoneImpl(NetZoneImpl* father, const std::string& name, resource::NetworkModel* network_model)
  22     : piface_(this), father_(father), name_(name), network_model_(network_model)
  23 {
  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());
  26
  27   netpoint_ = new NetPoint(name_, NetPoint::Type::NetZone, father_);
  28   XBT_DEBUG("NetZone '%s' created with the id '%u'", get_cname(), netpoint_->id());
  29 }
  30
  31 NetZoneImpl::~NetZoneImpl()
  32 {
  33   for (auto const& nz : children_)
  34     delete nz;
  35
  36   for (auto const& kv : bypass_routes_)
  37     delete kv.second;
  38
  39   s4u::Engine::get_instance()->netpoint_unregister(netpoint_);
  40 }
  41
  42 /** @brief Returns the list of the hosts found in this NetZone (not recursively)
  43  *
  44  * Only the hosts that are directly contained in this NetZone are retrieved,
  45  * not the ones contained in sub-netzones.
  46  */
  47 std::vector<s4u::Host*> NetZoneImpl::get_all_hosts() const
  48 {
  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());
  52     if (host != nullptr)
  53       res.push_back(host);
  54   }
  55   return res;
  56 }
  57 int NetZoneImpl::get_host_count() const
  58 {
  59   int count = 0;
  60   for (auto const& card : get_vertices()) {
  61     const s4u::Host* host = s4u::Host::by_name_or_null(card->get_name());
  62     if (host != nullptr)
  63       count++;
  64   }
  65   return count;
  66 }
  67
  68 s4u::Link* NetZoneImpl::create_link(const std::string& name, const std::vector<double>& bandwidths,
  69                                     s4u::Link::SharingPolicy policy)
  70 {
  71   auto* l = surf_network_model->create_link(name, bandwidths, policy);
  72
  73   return l->get_iface();
  74 }
  75
  76 s4u::Host* NetZoneImpl::create_host(const std::string& name, const std::vector<double>& speed_per_pstate,
  77                                     int coreAmount)
  78 {
  79   if (hierarchy_ == RoutingMode::unset)
  80     hierarchy_ = RoutingMode::base;
  81
  82   auto* res = (new s4u::Host(name))->set_netpoint(new NetPoint(name, NetPoint::Type::Host, this));
  83
  84   surf_cpu_model_pm->create_cpu(res, speed_per_pstate, coreAmount);
  85
  86   return res;
  87 }
  88
  89 int NetZoneImpl::add_component(NetPoint* elm)
  90 {
  91   vertices_.push_back(elm);
  92   return vertices_.size() - 1; // The rank of the newly created object
  93 }
  94
  95 void NetZoneImpl::add_route(NetPoint* /*src*/, NetPoint* /*dst*/, NetPoint* /*gw_src*/, NetPoint* /*gw_dst*/,
  96                             std::vector<resource::LinkImpl*>& /*link_list*/, bool /*symmetrical*/)
  97 {
  98   xbt_die("NetZone '%s' does not accept new routes (wrong class).", get_cname());
  99 }
 100
 101 void NetZoneImpl::add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
 102                                    std::vector<resource::LinkImpl*>& link_list, bool /* symmetrical */)
 103 {
 104   /* Argument validity checks */
 105   if (gw_dst) {
 106     XBT_DEBUG("Load bypassNetzoneRoute from %s@%s to %s@%s", src->get_cname(), gw_src->get_cname(), dst->get_cname(),
 107               gw_dst->get_cname());
 108     xbt_assert(not link_list.empty(), "Bypass route between %s@%s and %s@%s cannot be empty.", src->get_cname(),
 109                gw_src->get_cname(), dst->get_cname(), gw_dst->get_cname());
 110     xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
 111                "The bypass route between %s@%s and %s@%s already exists.", src->get_cname(), gw_src->get_cname(),
 112                dst->get_cname(), gw_dst->get_cname());
 113   } else {
 114     XBT_DEBUG("Load bypassRoute from %s to %s", src->get_cname(), dst->get_cname());
 115     xbt_assert(not link_list.empty(), "Bypass route between %s and %s cannot be empty.", src->get_cname(),
 116                dst->get_cname());
 117     xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
 118                "The bypass route between %s and %s already exists.", src->get_cname(), dst->get_cname());
 119   }
 120
 121   /* Build a copy that will be stored in the dict */
 122   auto* newRoute = new BypassRoute(gw_src, gw_dst);
 123   for (auto const& link : link_list)
 124     newRoute->links.push_back(link);
 125
 126   /* Store it */
 127   bypass_routes_.insert({{src, dst}, newRoute});
 128 }
 129
 130 /** @brief Get the common ancestor and its first children in each line leading to src and dst
 131  *
 132  * In the recursive case, this sets common_ancestor, src_ancestor and dst_ancestor are set as follows.
 133  * @verbatim
 134  *         platform root
 135  *               |
 136  *              ...                <- possibly long path
 137  *               |
 138  *         common_ancestor
 139  *           /        \
 140  *          /          \
 141  *         /            \          <- direct links
 142  *        /              \
 143  *       /                \
 144  *  src_ancestor     dst_ancestor  <- must be different in the recursive case
 145  *      |                   |
 146  *     ...                 ...     <-- possibly long paths (one hop or more)
 147  *      |                   |
 148  *     src                 dst
 149  *  @endverbatim
 150  *
 151  *  In the base case (when src and dst are in the same netzone), things are as follows:
 152  *  @verbatim
 153  *                  platform root
 154  *                        |
 155  *                       ...                      <-- possibly long path
 156  *                        |
 157  * common_ancestor==src_ancestor==dst_ancestor    <-- all the same value
 158  *                   /        \
 159  *                  /          \                  <-- direct links (exactly one hop)
 160  *                 /            \
 161  *              src              dst
 162  *  @endverbatim
 163  *
 164  * A specific recursive case occurs when src is the ancestor of dst. In this case,
 165  * the base case routing should be used so the common_ancestor is specifically set
 166  * to src_ancestor==dst_ancestor.
 167  * Naturally, things are completely symmetrical if dst is the ancestor of src.
 168  * @verbatim
 169  *            platform root
 170  *                  |
 171  *                 ...                <-- possibly long path
 172  *                  |
 173  *  src == src_ancestor==dst_ancestor==common_ancestor <-- same value
 174  *                  |
 175  *                 ...                <-- possibly long path (one hop or more)
 176  *                  |
 177  *                 dst
 178  *  @endverbatim
 179  */
 180 static void find_common_ancestors(NetPoint* src, NetPoint* dst,
 181                                   /* OUT */ NetZoneImpl** common_ancestor, NetZoneImpl** src_ancestor,
 182                                   NetZoneImpl** dst_ancestor)
 183 {
 184   /* Deal with the easy base case */
 185   if (src->get_englobing_zone() == dst->get_englobing_zone()) {
 186     *common_ancestor = src->get_englobing_zone();
 187     *src_ancestor    = *common_ancestor;
 188     *dst_ancestor    = *common_ancestor;
 189     return;
 190   }
 191
 192   /* engage the full recursive search */
 193
 194   /* (1) find the path to root of src and dst*/
 195   const NetZoneImpl* src_as = src->get_englobing_zone();
 196   const NetZoneImpl* dst_as = dst->get_englobing_zone();
 197
 198   xbt_assert(src_as, "Host %s must be in a netzone", src->get_cname());
 199   xbt_assert(dst_as, "Host %s must be in a netzone", dst->get_cname());
 200
 201   /* (2) find the path to the root routing component */
 202   std::vector<NetZoneImpl*> path_src;
 203   NetZoneImpl* current = src->get_englobing_zone();
 204   while (current != nullptr) {
 205     path_src.push_back(current);
 206     current = current->get_father();
 207   }
 208   std::vector<NetZoneImpl*> path_dst;
 209   current = dst->get_englobing_zone();
 210   while (current != nullptr) {
 211     path_dst.push_back(current);
 212     current = current->get_father();
 213   }
 214
 215   /* (3) find the common father.
 216    * Before that, index_src and index_dst may be different, they both point to nullptr in path_src/path_dst
 217    * So we move them down simultaneously as long as they point to the same content.
 218    *
 219    * This works because all SimGrid platform have a unique root element (that is the last element of both paths).
 220    */
 221   NetZoneImpl* father = nullptr; // the netzone we dropped on the previous loop iteration
 222   while (path_src.size() > 1 && path_dst.size() > 1 &&
 223          path_src.at(path_src.size() - 1) == path_dst.at(path_dst.size() - 1)) {
 224     father = path_src.at(path_src.size() - 1);
 225     path_src.pop_back();
 226     path_dst.pop_back();
 227   }
 228
 229   /* (4) we found the difference at least. Finalize the returned values */
 230   *src_ancestor = path_src.at(path_src.size() - 1); /* the first different father of src */
 231   *dst_ancestor = path_dst.at(path_dst.size() - 1); /* the first different father of dst */
 232   if (*src_ancestor == *dst_ancestor) {             // src is the ancestor of dst, or the contrary
 233     *common_ancestor = *src_ancestor;
 234   } else {
 235     *common_ancestor = father;
 236   }
 237 }
 238
 239 /* PRECONDITION: this is the common ancestor of src and dst */
 240 bool NetZoneImpl::get_bypass_route(NetPoint* src, NetPoint* dst,
 241                                    /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency)
 242 {
 243   // If never set a bypass route return nullptr without any further computations
 244   if (bypass_routes_.empty())
 245     return false;
 246
 247   /* Base case, no recursion is needed */
 248   if (dst->get_englobing_zone() == this && src->get_englobing_zone() == this) {
 249     if (bypass_routes_.find({src, dst}) != bypass_routes_.end()) {
 250       const BypassRoute* bypassedRoute = bypass_routes_.at({src, dst});
 251       for (resource::LinkImpl* const& link : bypassedRoute->links) {
 252         links.push_back(link);
 253         if (latency)
 254           *latency += link->get_latency();
 255       }
 256       XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links", src->get_cname(), dst->get_cname(),
 257                 bypassedRoute->links.size());
 258       return true;
 259     }
 260     return false;
 261   }
 262
 263   /* Engage recursive search */
 264
 265   /* (1) find the path to the root routing component */
 266   std::vector<NetZoneImpl*> path_src;
 267   NetZoneImpl* current = src->get_englobing_zone();
 268   while (current != nullptr) {
 269     path_src.push_back(current);
 270     current = current->father_;
 271   }
 272
 273   std::vector<NetZoneImpl*> path_dst;
 274   current = dst->get_englobing_zone();
 275   while (current != nullptr) {
 276     path_dst.push_back(current);
 277     current = current->father_;
 278   }
 279
 280   /* (2) find the common father */
 281   while (path_src.size() > 1 && path_dst.size() > 1 &&
 282          path_src.at(path_src.size() - 1) == path_dst.at(path_dst.size() - 1)) {
 283     path_src.pop_back();
 284     path_dst.pop_back();
 285   }
 286
 287   int max_index_src = path_src.size() - 1;
 288   int max_index_dst = path_dst.size() - 1;
 289
 290   int max_index = std::max(max_index_src, max_index_dst);
 291
 292   /* (3) Search for a bypass making the path up to the ancestor useless */
 293   const BypassRoute* bypassedRoute = nullptr;
 294   std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*> key;
 295   for (int max = 0; max <= max_index && not bypassedRoute; max++) {
 296     for (int i = 0; i < max && not bypassedRoute; i++) {
 297       if (i <= max_index_src && max <= max_index_dst) {
 298         key = {path_src.at(i)->netpoint_, path_dst.at(max)->netpoint_};
 299         auto bpr = bypass_routes_.find(key);
 300         if (bpr != bypass_routes_.end()) {
 301           bypassedRoute = bpr->second;
 302         }
 303       }
 304       if (not bypassedRoute && 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;
 309         }
 310       }
 311     }
 312
 313     if (not bypassedRoute && max <= max_index_src && max <= max_index_dst) {
 314       key = {path_src.at(max)->netpoint_, path_dst.at(max)->netpoint_};
 315       auto bpr = bypass_routes_.find(key);
 316       if (bpr != bypass_routes_.end()) {
 317         bypassedRoute = bpr->second;
 318       }
 319     }
 320   }
 321
 322   /* (4) If we have the bypass, use it. If not, caller will do the Right Thing. */
 323   if (bypassedRoute) {
 324     XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links. We may have to complete it with recursive "
 325               "calls to getRoute",
 326               src->get_cname(), dst->get_cname(), bypassedRoute->links.size());
 327     if (src != key.first)
 328       get_global_route(src, bypassedRoute->gw_src, links, latency);
 329     for (resource::LinkImpl* const& link : bypassedRoute->links) {
 330       links.push_back(link);
 331       if (latency)
 332         *latency += link->get_latency();
 333     }
 334     if (dst != key.second)
 335       get_global_route(bypassedRoute->gw_dst, dst, links, latency);
 336     return true;
 337   }
 338   XBT_DEBUG("No bypass route from '%s' to '%s'.", src->get_cname(), dst->get_cname());
 339   return false;
 340 }
 341
 342 void NetZoneImpl::get_global_route(NetPoint* src, NetPoint* dst,
 343                                    /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency)
 344 {
 345   RouteCreationArgs route;
 346
 347   XBT_DEBUG("Resolve route from '%s' to '%s'", src->get_cname(), dst->get_cname());
 348
 349   /* Find how src and dst are interconnected */
 350   NetZoneImpl *common_ancestor;
 351   NetZoneImpl *src_ancestor;
 352   NetZoneImpl *dst_ancestor;
 353   find_common_ancestors(src, dst, &common_ancestor, &src_ancestor, &dst_ancestor);
 354   XBT_DEBUG("elements_father: common ancestor '%s' src ancestor '%s' dst ancestor '%s'", common_ancestor->get_cname(),
 355             src_ancestor->get_cname(), dst_ancestor->get_cname());
 356
 357   /* Check whether a direct bypass is defined. If so, use it and bail out */
 358   if (common_ancestor->get_bypass_route(src, dst, links, latency))
 359     return;
 360
 361   /* If src and dst are in the same netzone, life is good */
 362   if (src_ancestor == dst_ancestor) { /* SURF_ROUTING_BASE */
 363     route.link_list = std::move(links);
 364     common_ancestor->get_local_route(src, dst, &route, latency);
 365     links = std::move(route.link_list);
 366     return;
 367   }
 368
 369   /* Not in the same netzone, no bypass. We'll have to find our path between the netzones recursively */
 370
 371   common_ancestor->get_local_route(src_ancestor->netpoint_, dst_ancestor->netpoint_, &route, latency);
 372   xbt_assert((route.gw_src != nullptr) && (route.gw_dst != nullptr), "Bad gateways for route from '%s' to '%s'.",
 373              src->get_cname(), dst->get_cname());
 374
 375   /* If source gateway is not our source, we have to recursively find our way up to this point */
 376   if (src != route.gw_src)
 377     get_global_route(src, route.gw_src, links, latency);
 378   for (auto const& link : route.link_list)
 379     links.push_back(link);
 380
 381   /* If dest gateway is not our destination, we have to recursively find our way from this point */
 382   if (route.gw_dst != dst)
 383     get_global_route(route.gw_dst, dst, links, latency);
 384 }
 385 } // namespace routing
 386 } // namespace kernel
 387 } // namespace simgrid