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/include/simgrid/sg_config.hpp"
  11 #include "src/kernel/EngineImpl.hpp"
  12 #include "src/kernel/resource/DiskImpl.hpp"
  13 #include "src/surf/HostImpl.hpp"
  14 #include "src/surf/cpu_interface.hpp"
  15 #include "src/surf/network_interface.hpp"
  16 #include "src/surf/xml/platf_private.hpp"
  17 #include "surf/surf.hpp"
  18
  19 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_route);
  20
  21 namespace simgrid {
  22 namespace kernel {
  23 namespace routing {
  24
  25 /* Pick the right models for CPU, net and host, and call their model_init_preparse */
  26 static void surf_config_models_setup()
  27 {
  28   std::string host_model_name    = simgrid::config::get_value<std::string>("host/model");
  29   std::string network_model_name = simgrid::config::get_value<std::string>("network/model");
  30   std::string cpu_model_name     = simgrid::config::get_value<std::string>("cpu/model");
  31   std::string disk_model_name    = simgrid::config::get_value<std::string>("disk/model");
  32
  33   /* The compound host model is needed when using non-default net/cpu models */
  34   if ((not simgrid::config::is_default("network/model") || not simgrid::config::is_default("cpu/model")) &&
  35       simgrid::config::is_default("host/model")) {
  36     host_model_name = "compound";
  37     simgrid::config::set_value("host/model", host_model_name);
  38   }
  39
  40   XBT_DEBUG("host model: %s", host_model_name.c_str());
  41   if (host_model_name == "compound") {
  42     xbt_assert(not cpu_model_name.empty(), "Set a cpu model to use with the 'compound' host model");
  43     xbt_assert(not network_model_name.empty(), "Set a network model to use with the 'compound' host model");
  44
  45     int cpu_id = find_model_description(surf_cpu_model_description, cpu_model_name);
  46     surf_cpu_model_description[cpu_id].model_init_preparse();
  47
  48     int network_id = find_model_description(surf_network_model_description, network_model_name);
  49     surf_network_model_description[network_id].model_init_preparse();
  50   }
  51
  52   XBT_DEBUG("Call host_model_init");
  53   int host_id = find_model_description(surf_host_model_description, host_model_name);
  54   surf_host_model_description[host_id].model_init_preparse();
  55
  56   XBT_DEBUG("Call vm_model_init");
  57   /* ideally we should get back the pointer to CpuModel from model_init_preparse(), but this
  58    * requires changing the declaration of surf_cpu_model_description.
  59    * To be reviewed in the future */
  60   surf_vm_model_init_HL13(
  61       simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->get_cpu_pm_model().get());
  62
  63   XBT_DEBUG("Call disk_model_init");
  64   int disk_id = find_model_description(surf_disk_model_description, disk_model_name);
  65   surf_disk_model_description[disk_id].model_init_preparse();
  66 }
  67
  68 NetZoneImpl::NetZoneImpl(const std::string& name) : piface_(this), name_(name)
  69 {
  70   /* workaroud: first netzoneImpl will be the root netzone.
  71    * Without globals and with current surf_*_model_description init functions, we need
  72    * the root netzone to exist when creating the models.
  73    * This was usually done at sg_platf.cpp, during XML parsing */
  74   if (not s4u::Engine::get_instance()->get_netzone_root())
  75     s4u::Engine::get_instance()->set_netzone_root(&piface_);
  76
  77   static bool surf_parse_models_setup_already_called = false;
  78   if (not surf_parse_models_setup_already_called) {
  79     simgrid::s4u::Engine::on_platform_creation();
  80
  81     /* Initialize the surf models. That must be done after we got all config, and before we need the models.
  82      * That is, after the last <config> tag, if any, and before the first of cluster|peer|zone|trace|trace_connect
  83      *
  84      * I'm not sure for <trace> and <trace_connect>, there may be a bug here
  85      * (FIXME: check it out by creating a file beginning with one of these tags)
  86      * but cluster and peer come down to zone creations, so putting this verification here is correct.
  87      */
  88     surf_parse_models_setup_already_called = true;
  89     surf_config_models_setup();
  90   }
  91
  92   xbt_assert(nullptr == s4u::Engine::get_instance()->netpoint_by_name_or_null(get_name()),
  93              "Refusing to create a second NetZone called '%s'.", get_cname());
  94   netpoint_ = new NetPoint(name_, NetPoint::Type::NetZone);
  95   XBT_DEBUG("NetZone '%s' created with the id '%u'", get_cname(), netpoint_->id());
  96 }
  97
  98 NetZoneImpl::~NetZoneImpl()
  99 {
 100   for (auto const& nz : children_)
 101     delete nz;
 102
 103   for (auto const& kv : bypass_routes_)
 104     delete kv.second;
 105
 106   s4u::Engine::get_instance()->netpoint_unregister(netpoint_);
 107 }
 108
 109 void NetZoneImpl::add_child(NetZoneImpl* new_zone)
 110 {
 111   xbt_assert(not sealed_, "Cannot add a new child to the sealed zone %s", get_cname());
 112   /* set the father behavior */
 113   hierarchy_ = RoutingMode::recursive;
 114   children_.push_back(new_zone);
 115 }
 116
 117 /** @brief Returns the list of the hosts found in this NetZone (not recursively)
 118  *
 119  * Only the hosts that are directly contained in this NetZone are retrieved,
 120  * not the ones contained in sub-netzones.
 121  */
 122 std::vector<s4u::Host*> NetZoneImpl::get_all_hosts() const
 123 {
 124   std::vector<s4u::Host*> res;
 125   for (auto const& card : get_vertices()) {
 126     s4u::Host* host = s4u::Host::by_name_or_null(card->get_name());
 127     if (host != nullptr)
 128       res.push_back(host);
 129   }
 130   return res;
 131 }
 132 int NetZoneImpl::get_host_count() const
 133 {
 134   int count = 0;
 135   for (auto const& card : get_vertices()) {
 136     const s4u::Host* host = s4u::Host::by_name_or_null(card->get_name());
 137     if (host != nullptr)
 138       count++;
 139   }
 140   return count;
 141 }
 142
 143 s4u::Host* NetZoneImpl::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
 144 {
 145   auto* res = (new surf::HostImpl(name))->get_iface();
 146   res->set_netpoint((new NetPoint(name, NetPoint::Type::Host))->set_englobing_zone(this));
 147
 148   cpu_model_pm_->create_cpu(res, speed_per_pstate);
 149
 150   return res;
 151 }
 152
 153 s4u::Link* NetZoneImpl::create_link(const std::string& name, const std::vector<double>& bandwidths)
 154 {
 155   return network_model_->create_link(name, bandwidths)->get_iface();
 156 }
 157
 158 s4u::Disk* NetZoneImpl::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
 159 {
 160   auto* l = disk_model_->create_disk(name, read_bandwidth, write_bandwidth);
 161
 162   return l->get_iface();
 163 }
 164
 165 NetPoint* NetZoneImpl::create_router(const std::string& name)
 166 {
 167   xbt_assert(nullptr == s4u::Engine::get_instance()->netpoint_by_name_or_null(name),
 168              "Refusing to create a router named '%s': this name already describes a node.", name.c_str());
 169
 170   return (new NetPoint(name, NetPoint::Type::Router))->set_englobing_zone(this);
 171 }
 172 int NetZoneImpl::add_component(NetPoint* elm)
 173 {
 174   vertices_.push_back(elm);
 175   return vertices_.size() - 1; // The rank of the newly created object
 176 }
 177
 178 void NetZoneImpl::add_route(NetPoint* /*src*/, NetPoint* /*dst*/, NetPoint* /*gw_src*/, NetPoint* /*gw_dst*/,
 179                             const std::vector<resource::LinkImpl*>& /*link_list*/, bool /*symmetrical*/)
 180 {
 181   xbt_die("NetZone '%s' does not accept new routes (wrong class).", get_cname());
 182 }
 183
 184 void NetZoneImpl::add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
 185                                    std::vector<resource::LinkImpl*>& link_list, bool /* symmetrical */)
 186 {
 187   /* Argument validity checks */
 188   if (gw_dst) {
 189     XBT_DEBUG("Load bypassNetzoneRoute from %s@%s to %s@%s", src->get_cname(), gw_src->get_cname(), dst->get_cname(),
 190               gw_dst->get_cname());
 191     xbt_assert(not link_list.empty(), "Bypass route between %s@%s and %s@%s cannot be empty.", src->get_cname(),
 192                gw_src->get_cname(), dst->get_cname(), gw_dst->get_cname());
 193     xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
 194                "The bypass route between %s@%s and %s@%s already exists.", src->get_cname(), gw_src->get_cname(),
 195                dst->get_cname(), gw_dst->get_cname());
 196   } else {
 197     XBT_DEBUG("Load bypassRoute from %s to %s", src->get_cname(), dst->get_cname());
 198     xbt_assert(not link_list.empty(), "Bypass route between %s and %s cannot be empty.", src->get_cname(),
 199                dst->get_cname());
 200     xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
 201                "The bypass route between %s and %s already exists.", src->get_cname(), dst->get_cname());
 202   }
 203
 204   /* Build a copy that will be stored in the dict */
 205   auto* newRoute = new BypassRoute(gw_src, gw_dst);
 206   for (auto const& link : link_list)
 207     newRoute->links.push_back(link);
 208
 209   /* Store it */
 210   bypass_routes_.insert({{src, dst}, newRoute});
 211 }
 212
 213 /** @brief Get the common ancestor and its first children in each line leading to src and dst
 214  *
 215  * In the recursive case, this sets common_ancestor, src_ancestor and dst_ancestor are set as follows.
 216  * @verbatim
 217  *         platform root
 218  *               |
 219  *              ...                <- possibly long path
 220  *               |
 221  *         common_ancestor
 222  *           /        \
 223  *          /          \
 224  *         /            \          <- direct links
 225  *        /              \
 226  *       /                \
 227  *  src_ancestor     dst_ancestor  <- must be different in the recursive case
 228  *      |                   |
 229  *     ...                 ...     <-- possibly long paths (one hop or more)
 230  *      |                   |
 231  *     src                 dst
 232  *  @endverbatim
 233  *
 234  *  In the base case (when src and dst are in the same netzone), things are as follows:
 235  *  @verbatim
 236  *                  platform root
 237  *                        |
 238  *                       ...                      <-- possibly long path
 239  *                        |
 240  * common_ancestor==src_ancestor==dst_ancestor    <-- all the same value
 241  *                   /        \
 242  *                  /          \                  <-- direct links (exactly one hop)
 243  *                 /            \
 244  *              src              dst
 245  *  @endverbatim
 246  *
 247  * A specific recursive case occurs when src is the ancestor of dst. In this case,
 248  * the base case routing should be used so the common_ancestor is specifically set
 249  * to src_ancestor==dst_ancestor.
 250  * Naturally, things are completely symmetrical if dst is the ancestor of src.
 251  * @verbatim
 252  *            platform root
 253  *                  |
 254  *                 ...                <-- possibly long path
 255  *                  |
 256  *  src == src_ancestor==dst_ancestor==common_ancestor <-- same value
 257  *                  |
 258  *                 ...                <-- possibly long path (one hop or more)
 259  *                  |
 260  *                 dst
 261  *  @endverbatim
 262  */
 263 static void find_common_ancestors(NetPoint* src, NetPoint* dst,
 264                                   /* OUT */ NetZoneImpl** common_ancestor, NetZoneImpl** src_ancestor,
 265                                   NetZoneImpl** dst_ancestor)
 266 {
 267   /* Deal with the easy base case */
 268   if (src->get_englobing_zone() == dst->get_englobing_zone()) {
 269     *common_ancestor = src->get_englobing_zone();
 270     *src_ancestor    = *common_ancestor;
 271     *dst_ancestor    = *common_ancestor;
 272     return;
 273   }
 274
 275   /* engage the full recursive search */
 276
 277   /* (1) find the path to root of src and dst*/
 278   const NetZoneImpl* src_as = src->get_englobing_zone();
 279   const NetZoneImpl* dst_as = dst->get_englobing_zone();
 280
 281   xbt_assert(src_as, "Host %s must be in a netzone", src->get_cname());
 282   xbt_assert(dst_as, "Host %s must be in a netzone", dst->get_cname());
 283
 284   /* (2) 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->get_parent();
 290   }
 291   std::vector<NetZoneImpl*> path_dst;
 292   current = dst->get_englobing_zone();
 293   while (current != nullptr) {
 294     path_dst.push_back(current);
 295     current = current->get_parent();
 296   }
 297
 298   /* (3) find the common father.
 299    * Before that, index_src and index_dst may be different, they both point to nullptr in path_src/path_dst
 300    * So we move them down simultaneously as long as they point to the same content.
 301    *
 302    * This works because all SimGrid platform have a unique root element (that is the last element of both paths).
 303    */
 304   NetZoneImpl* father = nullptr; // the netzone we dropped on the previous loop iteration
 305   while (path_src.size() > 1 && path_dst.size() > 1 &&
 306          path_src.at(path_src.size() - 1) == path_dst.at(path_dst.size() - 1)) {
 307     father = path_src.at(path_src.size() - 1);
 308     path_src.pop_back();
 309     path_dst.pop_back();
 310   }
 311
 312   /* (4) we found the difference at least. Finalize the returned values */
 313   *src_ancestor = path_src.at(path_src.size() - 1); /* the first different father of src */
 314   *dst_ancestor = path_dst.at(path_dst.size() - 1); /* the first different father of dst */
 315   if (*src_ancestor == *dst_ancestor) {             // src is the ancestor of dst, or the contrary
 316     *common_ancestor = *src_ancestor;
 317   } else {
 318     *common_ancestor = father;
 319   }
 320 }
 321
 322 /* PRECONDITION: this is the common ancestor of src and dst */
 323 bool NetZoneImpl::get_bypass_route(NetPoint* src, NetPoint* dst,
 324                                    /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency)
 325 {
 326   // If never set a bypass route return nullptr without any further computations
 327   if (bypass_routes_.empty())
 328     return false;
 329
 330   /* Base case, no recursion is needed */
 331   if (dst->get_englobing_zone() == this && src->get_englobing_zone() == this) {
 332     if (bypass_routes_.find({src, dst}) != bypass_routes_.end()) {
 333       const BypassRoute* bypassedRoute = bypass_routes_.at({src, dst});
 334       for (resource::LinkImpl* const& link : bypassedRoute->links) {
 335         links.push_back(link);
 336         if (latency)
 337           *latency += link->get_latency();
 338       }
 339       XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links", src->get_cname(), dst->get_cname(),
 340                 bypassedRoute->links.size());
 341       return true;
 342     }
 343     return false;
 344   }
 345
 346   /* Engage recursive search */
 347
 348   /* (1) find the path to the root routing component */
 349   std::vector<NetZoneImpl*> path_src;
 350   NetZoneImpl* current = src->get_englobing_zone();
 351   while (current != nullptr) {
 352     path_src.push_back(current);
 353     current = current->parent_;
 354   }
 355
 356   std::vector<NetZoneImpl*> path_dst;
 357   current = dst->get_englobing_zone();
 358   while (current != nullptr) {
 359     path_dst.push_back(current);
 360     current = current->parent_;
 361   }
 362
 363   /* (2) find the common father */
 364   while (path_src.size() > 1 && path_dst.size() > 1 &&
 365          path_src.at(path_src.size() - 1) == path_dst.at(path_dst.size() - 1)) {
 366     path_src.pop_back();
 367     path_dst.pop_back();
 368   }
 369
 370   /* (3) Search for a bypass making the path up to the ancestor useless */
 371   const BypassRoute* bypassedRoute = nullptr;
 372   std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*> key;
 373   // Search for a bypass with the given indices. Returns true if found. Initialize variables `bypassedRoute' and `key'.
 374   auto lookup = [&bypassedRoute, &key, &path_src, &path_dst, this](unsigned src_index, unsigned dst_index) {
 375     if (src_index < path_src.size() && dst_index <= path_dst.size()) {
 376       key      = {path_src[src_index]->netpoint_, path_dst[dst_index]->netpoint_};
 377       auto bpr = bypass_routes_.find(key);
 378       if (bpr != bypass_routes_.end()) {
 379         bypassedRoute = bpr->second;
 380         return true;
 381       }
 382     }
 383     return false;
 384   };
 385
 386   for (unsigned max = 0, max_index = std::max(path_src.size(), path_dst.size()); max < max_index; max++) {
 387     for (unsigned i = 0; i < max; i++) {
 388       if (lookup(i, max) || lookup(max, i))
 389         break;
 390     }
 391     if (bypassedRoute || lookup(max, max))
 392       break;
 393   }
 394
 395   /* (4) If we have the bypass, use it. If not, caller will do the Right Thing. */
 396   if (bypassedRoute) {
 397     XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links. We may have to complete it with recursive "
 398               "calls to getRoute",
 399               src->get_cname(), dst->get_cname(), bypassedRoute->links.size());
 400     if (src != key.first)
 401       get_global_route(src, bypassedRoute->gw_src, links, latency);
 402     for (resource::LinkImpl* const& link : bypassedRoute->links) {
 403       links.push_back(link);
 404       if (latency)
 405         *latency += link->get_latency();
 406     }
 407     if (dst != key.second)
 408       get_global_route(bypassedRoute->gw_dst, dst, links, latency);
 409     return true;
 410   }
 411   XBT_DEBUG("No bypass route from '%s' to '%s'.", src->get_cname(), dst->get_cname());
 412   return false;
 413 }
 414
 415 void NetZoneImpl::get_global_route(NetPoint* src, NetPoint* dst,
 416                                    /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency)
 417 {
 418   RouteCreationArgs route;
 419
 420   XBT_DEBUG("Resolve route from '%s' to '%s'", src->get_cname(), dst->get_cname());
 421
 422   /* Find how src and dst are interconnected */
 423   NetZoneImpl* common_ancestor;
 424   NetZoneImpl* src_ancestor;
 425   NetZoneImpl* dst_ancestor;
 426   find_common_ancestors(src, dst, &common_ancestor, &src_ancestor, &dst_ancestor);
 427   XBT_DEBUG("elements_father: common ancestor '%s' src ancestor '%s' dst ancestor '%s'", common_ancestor->get_cname(),
 428             src_ancestor->get_cname(), dst_ancestor->get_cname());
 429
 430   /* Check whether a direct bypass is defined. If so, use it and bail out */
 431   if (common_ancestor->get_bypass_route(src, dst, links, latency))
 432     return;
 433
 434   /* If src and dst are in the same netzone, life is good */
 435   if (src_ancestor == dst_ancestor) { /* SURF_ROUTING_BASE */
 436     route.link_list = std::move(links);
 437     common_ancestor->get_local_route(src, dst, &route, latency);
 438     links = std::move(route.link_list);
 439     return;
 440   }
 441
 442   /* Not in the same netzone, no bypass. We'll have to find our path between the netzones recursively */
 443
 444   common_ancestor->get_local_route(src_ancestor->netpoint_, dst_ancestor->netpoint_, &route, latency);
 445   xbt_assert((route.gw_src != nullptr) && (route.gw_dst != nullptr), "Bad gateways for route from '%s' to '%s'.",
 446              src->get_cname(), dst->get_cname());
 447
 448   /* If source gateway is not our source, we have to recursively find our way up to this point */
 449   if (src != route.gw_src)
 450     get_global_route(src, route.gw_src, links, latency);
 451   for (auto const& link : route.link_list)
 452     links.push_back(link);
 453
 454   /* If dest gateway is not our destination, we have to recursively find our way from this point */
 455   if (route.gw_dst != dst)
 456     get_global_route(route.gw_dst, dst, links, latency);
 457 }
 458
 459 void NetZoneImpl::seal()
 460 {
 461   /* already sealed netzone */
 462   if (sealed_)
 463     return;
 464   do_seal(); // derived class' specific sealing procedure
 465
 466   /* seals sub-netzones and hosts */
 467   for (auto* host : get_all_hosts()) {
 468     host->seal();
 469   }
 470   for (auto* sub_net : get_children()) {
 471     sub_net->seal();
 472   }
 473   sealed_ = true;
 474 }
 475
 476 void NetZoneImpl::set_parent(NetZoneImpl* parent)
 477 {
 478   xbt_assert(not sealed_, "Impossible to set parent to an already sealed NetZone(%s)", this->get_cname());
 479   parent_ = parent;
 480   netpoint_->set_englobing_zone(parent_);
 481   if (parent) {
 482     /* adding this class as child */
 483     parent->add_child(this);
 484     /* copying models from parent host, to be reviewed when we allow multi-models */
 485     set_network_model(parent->get_network_model());
 486     set_cpu_pm_model(parent->get_cpu_pm_model());
 487     set_cpu_vm_model(parent->get_cpu_vm_model());
 488     set_disk_model(parent->get_disk_model());
 489     set_host_model(parent->get_host_model());
 490   }
 491 }
 492
 493 void NetZoneImpl::set_network_model(std::shared_ptr<resource::NetworkModel> netmodel)
 494 {
 495   xbt_assert(not sealed_, "Impossible to set network model to an already sealed NetZone(%s)", this->get_cname());
 496   network_model_ = std::move(netmodel);
 497 }
 498
 499 void NetZoneImpl::set_cpu_vm_model(std::shared_ptr<resource::CpuModel> cpu_model)
 500 {
 501   xbt_assert(not sealed_, "Impossible to set CPU model to an already sealed NetZone(%s)", this->get_cname());
 502   cpu_model_vm_ = std::move(cpu_model);
 503 }
 504
 505 void NetZoneImpl::set_cpu_pm_model(std::shared_ptr<resource::CpuModel> cpu_model)
 506 {
 507   xbt_assert(not sealed_, "Impossible to set CPU model to an already sealed NetZone(%s)", this->get_cname());
 508   cpu_model_pm_ = std::move(cpu_model);
 509 }
 510
 511 void NetZoneImpl::set_disk_model(std::shared_ptr<resource::DiskModel> disk_model)
 512 {
 513   xbt_assert(not sealed_, "Impossible to set disk model to an already sealed NetZone(%s)", this->get_cname());
 514   disk_model_ = std::move(disk_model);
 515 }
 516
 517 void NetZoneImpl::set_host_model(std::shared_ptr<surf::HostModel> host_model)
 518 {
 519   xbt_assert(not sealed_, "Impossible to set host model to an already sealed NetZone(%s)", this->get_cname());
 520   host_model_ = std::move(host_model);
 521 }
 522
 523 } // namespace routing
 524 } // namespace kernel
 525 } // namespace simgrid