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