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