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