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