src/kernel/routing/NetZoneImpl.cpp

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