src/kernel/routing/NetZoneImpl.cpp

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