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