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