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