src/kernel/routing/NetZoneImpl.cpp

   1 /* Copyright (c) 2006-2022. 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/NetPoint.hpp>
   7 #include <simgrid/kernel/routing/NetZoneImpl.hpp>
   8 #include <simgrid/s4u/Engine.hpp>
   9 #include <simgrid/s4u/Host.hpp>
  10 #include <simgrid/s4u/VirtualMachine.hpp>
  11
  12 #include "src/include/simgrid/sg_config.hpp"
  13 #include "src/kernel/EngineImpl.hpp"
  14 #include "src/kernel/resource/CpuImpl.hpp"
  15 #include "src/kernel/resource/DiskImpl.hpp"
  16 #include "src/kernel/resource/NetworkModel.hpp"
  17 #include "src/kernel/resource/SplitDuplexLinkImpl.hpp"
  18 #include "src/kernel/resource/StandardLinkImpl.hpp"
  19 #include "src/kernel/resource/VirtualMachineImpl.hpp"
  20 #include "src/surf/HostImpl.hpp"
  21
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_routing, kernel, "Kernel routing-related information");
  23
  24 namespace simgrid {
  25 namespace kernel {
  26 namespace routing {
  27
  28 /* Pick the right models for CPU, net and host, and call their model_init_preparse */
  29 static void surf_config_models_setup()
  30 {
  31   std::string host_model_name    = simgrid::config::get_value<std::string>("host/model");
  32   std::string network_model_name = simgrid::config::get_value<std::string>("network/model");
  33   std::string cpu_model_name     = simgrid::config::get_value<std::string>("cpu/model");
  34   std::string disk_model_name    = simgrid::config::get_value<std::string>("disk/model");
  35
  36   /* The compound host model is needed when using non-default net/cpu models */
  37   if ((not simgrid::config::is_default("network/model") || not simgrid::config::is_default("cpu/model")) &&
  38       simgrid::config::is_default("host/model")) {
  39     host_model_name = "compound";
  40     simgrid::config::set_value("host/model", host_model_name);
  41   }
  42
  43   XBT_DEBUG("host model: %s", host_model_name.c_str());
  44   if (host_model_name == "compound") {
  45     xbt_assert(not cpu_model_name.empty(), "Set a cpu model to use with the 'compound' host model");
  46     xbt_assert(not network_model_name.empty(), "Set a network model to use with the 'compound' host model");
  47
  48     const auto* cpu_model = find_model_description(surf_cpu_model_description, cpu_model_name);
  49     cpu_model->model_init_preparse();
  50
  51     const auto* network_model = find_model_description(surf_network_model_description, network_model_name);
  52     network_model->model_init_preparse();
  53   }
  54
  55   XBT_DEBUG("Call host_model_init");
  56   const auto* host_model = find_model_description(surf_host_model_description, host_model_name);
  57   host_model->model_init_preparse();
  58
  59   XBT_DEBUG("Call vm_model_init");
  60   /* ideally we should get back the pointer to CpuModel from model_init_preparse(), but this
  61    * requires changing the declaration of surf_cpu_model_description.
  62    * To be reviewed in the future */
  63   surf_vm_model_init_HL13(
  64       simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->get_cpu_pm_model().get());
  65
  66   XBT_DEBUG("Call disk_model_init");
  67   const auto* disk_model = find_model_description(surf_disk_model_description, disk_model_name);
  68   disk_model->model_init_preparse();
  69 }
  70
  71 xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  72                  kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  73                  std::vector<kernel::resource::StandardLinkImpl*> const& link_list)>
  74     NetZoneImpl::on_route_creation;
  75
  76 NetZoneImpl::NetZoneImpl(const std::string& name) : piface_(this), name_(name)
  77 {
  78   auto* engine = s4u::Engine::get_instance();
  79   /* workaroud: first netzoneImpl will be the root netzone.
  80    * Without globals and with current surf_*_model_description init functions, we need
  81    * the root netzone to exist when creating the models.
  82    * This was usually done at sg_platf.cpp, during XML parsing */
  83   if (not engine->get_netzone_root()) {
  84     engine->set_netzone_root(&piface_);
  85     /* root netzone set, initialize models */
  86     simgrid::s4u::Engine::on_platform_creation();
  87
  88     /* Initialize the surf models. That must be done after we got all config, and before we need the models.
  89      * That is, after the last <config> tag, if any, and before the first of cluster|peer|zone|trace|trace_cb
  90      *
  91      * I'm not sure for <trace> and <trace_cb>, there may be a bug here
  92      * (FIXME: check it out by creating a file beginning with one of these tags)
  93      * but cluster and peer come down to zone creations, so putting this verification here is correct.
  94      */
  95     surf_config_models_setup();
  96   }
  97
  98   xbt_assert(nullptr == engine->netpoint_by_name_or_null(get_name()),
  99              "Refusing to create a second NetZone called '%s'.", get_cname());
 100   netpoint_ = new NetPoint(name_, NetPoint::Type::NetZone);
 101   XBT_DEBUG("NetZone '%s' created with the id '%lu'", get_cname(), netpoint_->id());
 102   _sg_cfg_init_status = 2; /* HACK: direct access to the global controlling the level of configuration to prevent
 103                             * any further config now that we created some real content */
 104   simgrid::s4u::NetZone::on_creation(piface_); // notify the signal
 105 }
 106
 107 NetZoneImpl::~NetZoneImpl()
 108 {
 109   for (auto const& nz : children_)
 110     delete nz;
 111
 112   /* Since hosts_ and links_ are a std::map, the hosts are destroyed in the lexicographic order, which ensures that the
 113    * output is reproducible.
 114    */
 115   for (auto const& [_, host] : hosts_) {
 116     host->destroy();
 117   }
 118   hosts_.clear();
 119   for (auto const& [_, link] : links_) {
 120     link->destroy();
 121   }
 122   links_.clear();
 123
 124   for (auto const& [_, route] : bypass_routes_)
 125     delete route;
 126
 127   s4u::Engine::get_instance()->netpoint_unregister(netpoint_);
 128 }
 129
 130 void NetZoneImpl::add_child(NetZoneImpl* new_zone)
 131 {
 132   xbt_assert(not sealed_, "Cannot add a new child to the sealed zone %s", get_cname());
 133   /* set the parent behavior */
 134   hierarchy_ = RoutingMode::recursive;
 135   children_.push_back(new_zone);
 136 }
 137
 138 /** @brief Returns the list of the hosts found in this NetZone (not recursively)
 139  *
 140  * Only the hosts that are directly contained in this NetZone are retrieved,
 141  * not the ones contained in sub-netzones.
 142  */
 143 std::vector<s4u::Host*> NetZoneImpl::get_all_hosts() const
 144 {
 145   return s4u::Engine::get_instance()->get_filtered_hosts(
 146       [this](const s4u::Host* host) { return host->get_impl()->get_englobing_zone() == this; });
 147 }
 148 size_t NetZoneImpl::get_host_count() const
 149 {
 150   return get_all_hosts().size();
 151 }
 152
 153 std::vector<s4u::Link*> NetZoneImpl::get_filtered_links(const std::function<bool(s4u::Link*)>& filter) const
 154 {
 155   std::vector<s4u::Link*> filtered_list;
 156   for (auto const& [_, link] : links_) {
 157     s4u::Link* l = link->get_iface();
 158     if (filter(l))
 159       filtered_list.push_back(l);
 160   }
 161
 162   for (const auto* child : children_) {
 163     auto child_links = child->get_filtered_links(filter);
 164     filtered_list.insert(filtered_list.end(), std::make_move_iterator(child_links.begin()),
 165                          std::make_move_iterator(child_links.end()));
 166   }
 167   return filtered_list;
 168 }
 169
 170 std::vector<s4u::Link*> NetZoneImpl::get_all_links() const
 171 {
 172   return get_filtered_links([](const s4u::Link*) { return true; });
 173 }
 174
 175 size_t NetZoneImpl::get_link_count() const
 176 {
 177   size_t total = links_.size();
 178   for (const auto* child : children_) {
 179     total += child->get_link_count();
 180   }
 181   return total;
 182 }
 183
 184 s4u::Host* NetZoneImpl::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
 185 {
 186   xbt_assert(cpu_model_pm_,
 187              "Impossible to create host: %s. Invalid CPU model: nullptr. Have you set the parent of this NetZone: %s?",
 188              name.c_str(), get_cname());
 189   xbt_assert(not sealed_, "Impossible to create host: %s. NetZone %s already sealed", name.c_str(), get_cname());
 190   auto* host   = (new resource::HostImpl(name))->set_englobing_zone(this);
 191   hosts_[name] = host;
 192   host->get_iface()->set_netpoint((new NetPoint(name, NetPoint::Type::Host))->set_englobing_zone(this));
 193
 194   cpu_model_pm_->create_cpu(host->get_iface(), speed_per_pstate);
 195
 196   return host->get_iface();
 197 }
 198
 199 resource::StandardLinkImpl* NetZoneImpl::do_create_link(const std::string& name, const std::vector<double>& bandwidths)
 200 {
 201   return network_model_->create_link(name, bandwidths);
 202 }
 203
 204 s4u::Link* NetZoneImpl::create_link(const std::string& name, const std::vector<double>& bandwidths)
 205 {
 206   xbt_assert(
 207       network_model_,
 208       "Impossible to create link: %s. Invalid network model: nullptr. Have you set the parent of this NetZone: %s?",
 209       name.c_str(), get_cname());
 210   xbt_assert(not sealed_, "Impossible to create link: %s. NetZone %s already sealed", name.c_str(), get_cname());
 211   links_[name] = do_create_link(name, bandwidths)->set_englobing_zone(this);
 212   return links_[name]->get_iface();
 213 }
 214
 215 s4u::SplitDuplexLink* NetZoneImpl::create_split_duplex_link(const std::string& name,
 216                                                             const std::vector<double>& bandwidths)
 217 {
 218   xbt_assert(
 219       network_model_,
 220       "Impossible to create link: %s. Invalid network model: nullptr. Have you set the parent of this NetZone: %s?",
 221       name.c_str(), get_cname());
 222   xbt_assert(not sealed_, "Impossible to create link: %s. NetZone %s already sealed", name.c_str(), get_cname());
 223
 224   auto* link_up             = create_link(name + "_UP", bandwidths)->get_impl()->set_englobing_zone(this);
 225   auto* link_down           = create_link(name + "_DOWN", bandwidths)->get_impl()->set_englobing_zone(this);
 226   split_duplex_links_[name] = std::make_unique<resource::SplitDuplexLinkImpl>(name, link_up, link_down);
 227   return split_duplex_links_[name]->get_iface();
 228 }
 229
 230 s4u::Disk* NetZoneImpl::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
 231 {
 232   xbt_assert(disk_model_,
 233              "Impossible to create disk: %s. Invalid disk model: nullptr. Have you set the parent of this NetZone: %s?",
 234              name.c_str(), get_cname());
 235   xbt_assert(not sealed_, "Impossible to create disk: %s. NetZone %s already sealed", name.c_str(), get_cname());
 236   auto* l = disk_model_->create_disk(name, read_bandwidth, write_bandwidth);
 237
 238   return l->get_iface();
 239 }
 240
 241 NetPoint* NetZoneImpl::create_router(const std::string& name)
 242 {
 243   xbt_assert(nullptr == s4u::Engine::get_instance()->netpoint_by_name_or_null(name),
 244              "Refusing to create a router named '%s': this name already describes a node.", name.c_str());
 245   xbt_assert(not sealed_, "Impossible to create router: %s. NetZone %s already sealed", name.c_str(), get_cname());
 246
 247   return (new NetPoint(name, NetPoint::Type::Router))->set_englobing_zone(this);
 248 }
 249
 250 unsigned long NetZoneImpl::add_component(NetPoint* elm)
 251 {
 252   vertices_.push_back(elm);
 253   return vertices_.size() - 1; // The rank of the newly created object
 254 }
 255
 256 std::vector<resource::StandardLinkImpl*> NetZoneImpl::get_link_list_impl(const std::vector<s4u::LinkInRoute>& link_list,
 257                                                                          bool backroute) const
 258 {
 259   std::vector<resource::StandardLinkImpl*> links;
 260
 261   for (const auto& link : link_list) {
 262     if (link.get_link()->get_sharing_policy() != s4u::Link::SharingPolicy::SPLITDUPLEX) {
 263       links.push_back(link.get_link()->get_impl());
 264       continue;
 265     }
 266     // split-duplex links
 267     const auto* sd_link = dynamic_cast<const s4u::SplitDuplexLink*>(link.get_link());
 268     xbt_assert(sd_link,
 269                "Add_route: cast to SpliDuplexLink impossible. This should not happen, please contact SimGrid team");
 270     resource::StandardLinkImpl* link_impl;
 271     switch (link.get_direction()) {
 272       case s4u::LinkInRoute::Direction::UP:
 273         if (backroute)
 274           link_impl = sd_link->get_link_down()->get_impl();
 275         else
 276           link_impl = sd_link->get_link_up()->get_impl();
 277         break;
 278       case s4u::LinkInRoute::Direction::DOWN:
 279         if (backroute)
 280           link_impl = sd_link->get_link_up()->get_impl();
 281         else
 282           link_impl = sd_link->get_link_down()->get_impl();
 283         break;
 284       default:
 285         throw std::invalid_argument("Invalid add_route. Split-Duplex link without a direction: " +
 286                                     link.get_link()->get_name());
 287     }
 288     links.push_back(link_impl);
 289   }
 290   return links;
 291 }
 292
 293 resource::StandardLinkImpl* NetZoneImpl::get_link_by_name_or_null(const std::string& name) const
 294 {
 295   auto link_it = links_.find(name);
 296   if (link_it != links_.end())
 297     return link_it->second;
 298
 299   for (const auto* child : children_) {
 300     if (auto* link = child->get_link_by_name_or_null(name))
 301       return link;
 302   }
 303
 304   return nullptr;
 305 }
 306
 307 resource::SplitDuplexLinkImpl* NetZoneImpl::get_split_duplex_link_by_name_or_null(const std::string& name) const
 308 {
 309   auto link_it = split_duplex_links_.find(name);
 310   if (link_it != split_duplex_links_.end())
 311     return link_it->second.get();
 312
 313   for (const auto* child : children_) {
 314     if (auto* link = child->get_split_duplex_link_by_name_or_null(name))
 315       return link;
 316   }
 317
 318   return nullptr;
 319 }
 320
 321 resource::HostImpl* NetZoneImpl::get_host_by_name_or_null(const std::string& name) const
 322 {
 323   for (auto const& [_, host] : hosts_) {
 324     if (host->get_name() == name)
 325       return host;
 326     /* keep old behavior where host and VMs were saved together on EngineImpl::hosts_
 327      * get hosts returns VMs too */
 328     auto* vm = host->get_vm_by_name_or_null(name);
 329     if (vm)
 330       return vm;
 331   }
 332
 333   for (const auto* child : children_) {
 334     auto* host = child->get_host_by_name_or_null(name);
 335     if (host)
 336       return host;
 337   }
 338
 339   return nullptr;
 340 }
 341
 342 std::vector<s4u::Host*> NetZoneImpl::get_filtered_hosts(const std::function<bool(s4u::Host*)>& filter) const
 343 {
 344   std::vector<s4u::Host*> filtered_list;
 345   for (auto const& [_, host] : hosts_) {
 346     s4u::Host* h = host->get_iface();
 347     if (filter(h))
 348       filtered_list.push_back(h);
 349     /* Engine::get_hosts returns the VMs too */
 350     for (auto* vm : h->get_impl()->get_vms()) {
 351       if (filter(vm))
 352         filtered_list.push_back(vm);
 353     }
 354   }
 355
 356   for (const auto* child : children_) {
 357     auto child_links = child->get_filtered_hosts(filter);
 358     filtered_list.insert(filtered_list.end(), std::make_move_iterator(child_links.begin()),
 359                          std::make_move_iterator(child_links.end()));
 360   }
 361   return filtered_list;
 362 }
 363
 364 void NetZoneImpl::add_route(NetPoint* /*src*/, NetPoint* /*dst*/, NetPoint* /*gw_src*/, NetPoint* /*gw_dst*/,
 365                             const std::vector<s4u::LinkInRoute>& /*link_list_*/, bool /*symmetrical*/)
 366 {
 367   xbt_die("NetZone '%s' does not accept new routes (wrong class).", get_cname());
 368 }
 369
 370 void NetZoneImpl::add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
 371                                    const std::vector<s4u::LinkInRoute>& link_list)
 372 {
 373   /* Argument validity checks */
 374   if (gw_dst) {
 375     XBT_DEBUG("Load bypassNetzoneRoute from %s@%s to %s@%s", src->get_cname(), gw_src->get_cname(), dst->get_cname(),
 376               gw_dst->get_cname());
 377     xbt_assert(not link_list.empty(), "Bypass route between %s@%s and %s@%s cannot be empty.", src->get_cname(),
 378                gw_src->get_cname(), dst->get_cname(), gw_dst->get_cname());
 379     xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
 380                "The bypass route between %s@%s and %s@%s already exists.", src->get_cname(), gw_src->get_cname(),
 381                dst->get_cname(), gw_dst->get_cname());
 382   } else {
 383     XBT_DEBUG("Load bypassRoute from %s to %s", src->get_cname(), dst->get_cname());
 384     xbt_assert(not link_list.empty(), "Bypass route between %s and %s cannot be empty.", src->get_cname(),
 385                dst->get_cname());
 386     xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
 387                "The bypass route between %s and %s already exists.", src->get_cname(), dst->get_cname());
 388   }
 389
 390   /* Build a copy that will be stored in the dict */
 391   auto* newRoute = new BypassRoute(gw_src, gw_dst);
 392   auto converted_list = get_link_list_impl(link_list, false);
 393   newRoute->links.insert(newRoute->links.end(), begin(converted_list), end(converted_list));
 394
 395   /* Store it */
 396   bypass_routes_.try_emplace({src, dst}, newRoute);
 397 }
 398
 399 /** @brief Get the common ancestor and its first children in each line leading to src and dst
 400  *
 401  * In the recursive case, this sets common_ancestor, src_ancestor and dst_ancestor are set as follows.
 402  * @verbatim
 403  *         platform root
 404  *               |
 405  *              ...                <- possibly long path
 406  *               |
 407  *         common_ancestor
 408  *           /        \
 409  *          /          \
 410  *         /            \          <- direct links
 411  *        /              \
 412  *       /                \
 413  *  src_ancestor     dst_ancestor  <- must be different in the recursive case
 414  *      |                   |
 415  *     ...                 ...     <-- possibly long paths (one hop or more)
 416  *      |                   |
 417  *     src                 dst
 418  *  @endverbatim
 419  *
 420  *  In the base case (when src and dst are in the same netzone), things are as follows:
 421  *  @verbatim
 422  *                  platform root
 423  *                        |
 424  *                       ...                      <-- possibly long path
 425  *                        |
 426  * common_ancestor==src_ancestor==dst_ancestor    <-- all the same value
 427  *                   /        \
 428  *                  /          \                  <-- direct links (exactly one hop)
 429  *                 /            \
 430  *              src              dst
 431  *  @endverbatim
 432  *
 433  * A specific recursive case occurs when src is the ancestor of dst. In this case,
 434  * the base case routing should be used so the common_ancestor is specifically set
 435  * to src_ancestor==dst_ancestor.
 436  * Naturally, things are completely symmetrical if dst is the ancestor of src.
 437  * @verbatim
 438  *            platform root
 439  *                  |
 440  *                 ...                <-- possibly long path
 441  *                  |
 442  *  src == src_ancestor==dst_ancestor==common_ancestor <-- same value
 443  *                  |
 444  *                 ...                <-- possibly long path (one hop or more)
 445  *                  |
 446  *                 dst
 447  *  @endverbatim
 448  */
 449 static void find_common_ancestors(const NetPoint* src, const NetPoint* dst,
 450                                   /* OUT */ NetZoneImpl** common_ancestor, NetZoneImpl** src_ancestor,
 451                                   NetZoneImpl** dst_ancestor)
 452 {
 453   /* Deal with the easy base case */
 454   if (src->get_englobing_zone() == dst->get_englobing_zone()) {
 455     *common_ancestor = src->get_englobing_zone();
 456     *src_ancestor    = *common_ancestor;
 457     *dst_ancestor    = *common_ancestor;
 458     return;
 459   }
 460
 461   /* engage the full recursive search */
 462
 463   /* (1) find the path to root of src and dst*/
 464   const NetZoneImpl* src_as = src->get_englobing_zone();
 465   const NetZoneImpl* dst_as = dst->get_englobing_zone();
 466
 467   xbt_assert(src_as, "Host %s must be in a netzone", src->get_cname());
 468   xbt_assert(dst_as, "Host %s must be in a netzone", dst->get_cname());
 469
 470   /* (2) find the path to the root routing component */
 471   std::vector<NetZoneImpl*> path_src;
 472   NetZoneImpl* current = src->get_englobing_zone();
 473   while (current != nullptr) {
 474     path_src.push_back(current);
 475     current = current->get_parent();
 476   }
 477   std::vector<NetZoneImpl*> path_dst;
 478   current = dst->get_englobing_zone();
 479   while (current != nullptr) {
 480     path_dst.push_back(current);
 481     current = current->get_parent();
 482   }
 483
 484   /* (3) find the common parent.
 485    * Before that, index_src and index_dst may be different, they both point to nullptr in path_src/path_dst
 486    * So we move them down simultaneously as long as they point to the same content.
 487    *
 488    * This works because all SimGrid platform have a unique root element (that is the last element of both paths).
 489    */
 490   NetZoneImpl* parent = nullptr; // the netzone we dropped on the previous loop iteration
 491   while (path_src.size() > 1 && path_dst.size() > 1 && path_src.back() == path_dst.back()) {
 492     parent = path_src.back();
 493     path_src.pop_back();
 494     path_dst.pop_back();
 495   }
 496
 497   /* (4) we found the difference at least. Finalize the returned values */
 498   *src_ancestor = path_src.back();                  /* the first different parent of src */
 499   *dst_ancestor = path_dst.back();                  /* the first different parent of dst */
 500   if (*src_ancestor == *dst_ancestor) {             // src is the ancestor of dst, or the contrary
 501     *common_ancestor = *src_ancestor;
 502   } else {
 503     xbt_assert(parent != nullptr);
 504     *common_ancestor = parent;
 505   }
 506 }
 507
 508 /* PRECONDITION: this is the common ancestor of src and dst */
 509 bool NetZoneImpl::get_bypass_route(const NetPoint* src, const NetPoint* dst,
 510                                    /* OUT */ std::vector<resource::StandardLinkImpl*>& links, double* latency,
 511                                    std::unordered_set<NetZoneImpl*>& netzones)
 512 {
 513   // If never set a bypass route return nullptr without any further computations
 514   if (bypass_routes_.empty())
 515     return false;
 516
 517   /* Base case, no recursion is needed */
 518   if (dst->get_englobing_zone() == this && src->get_englobing_zone() == this) {
 519     if (bypass_routes_.find({src, dst}) != bypass_routes_.end()) {
 520       const BypassRoute* bypassedRoute = bypass_routes_.at({src, dst});
 521       add_link_latency(links, bypassedRoute->links, latency);
 522       XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links", src->get_cname(), dst->get_cname(),
 523                 bypassedRoute->links.size());
 524       return true;
 525     }
 526     return false;
 527   }
 528
 529   /* Engage recursive search */
 530
 531   /* (1) find the path to the root routing component */
 532   std::vector<NetZoneImpl*> path_src;
 533   NetZoneImpl* current = src->get_englobing_zone();
 534   while (current != nullptr) {
 535     path_src.push_back(current);
 536     current = current->parent_;
 537   }
 538
 539   std::vector<NetZoneImpl*> path_dst;
 540   current = dst->get_englobing_zone();
 541   while (current != nullptr) {
 542     path_dst.push_back(current);
 543     current = current->parent_;
 544   }
 545
 546   /* (2) find the common parent */
 547   while (path_src.size() > 1 && path_dst.size() > 1 && path_src.back() == path_dst.back()) {
 548     path_src.pop_back();
 549     path_dst.pop_back();
 550   }
 551
 552   /* (3) Search for a bypass making the path up to the ancestor useless */
 553   const BypassRoute* bypassedRoute = nullptr;
 554   std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*> key;
 555   // Search for a bypass with the given indices. Returns true if found. Initialize variables `bypassedRoute' and `key'.
 556   auto lookup = [&bypassedRoute, &key, &path_src, &path_dst, this](unsigned src_index, unsigned dst_index) {
 557     if (src_index < path_src.size() && dst_index < path_dst.size()) {
 558       key      = {path_src[src_index]->netpoint_, path_dst[dst_index]->netpoint_};
 559       auto bpr = bypass_routes_.find(key);
 560       if (bpr != bypass_routes_.end()) {
 561         bypassedRoute = bpr->second;
 562         return true;
 563       }
 564     }
 565     return false;
 566   };
 567
 568   for (unsigned max = 0, max_index = std::max(path_src.size(), path_dst.size()); max < max_index; max++) {
 569     for (unsigned i = 0; i < max; i++) {
 570       if (lookup(i, max) || lookup(max, i))
 571         break;
 572     }
 573     if (bypassedRoute || lookup(max, max))
 574       break;
 575   }
 576
 577   /* (4) If we have the bypass, use it. If not, caller will do the Right Thing. */
 578   if (bypassedRoute) {
 579     XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links. We may have to complete it with recursive "
 580               "calls to getRoute",
 581               src->get_cname(), dst->get_cname(), bypassedRoute->links.size());
 582     if (src != key.first)
 583       get_global_route_with_netzones(src, bypassedRoute->gw_src, links, latency, netzones);
 584     add_link_latency(links, bypassedRoute->links, latency);
 585     if (dst != key.second)
 586       get_global_route_with_netzones(bypassedRoute->gw_dst, dst, links, latency, netzones);
 587     return true;
 588   }
 589   XBT_DEBUG("No bypass route from '%s' to '%s'.", src->get_cname(), dst->get_cname());
 590   return false;
 591 }
 592
 593 void NetZoneImpl::get_global_route(const NetPoint* src, const NetPoint* dst,
 594                                    /* OUT */ std::vector<resource::StandardLinkImpl*>& links, double* latency)
 595 {
 596   std::unordered_set<NetZoneImpl*> netzones;
 597   get_global_route_with_netzones(src, dst, links, latency, netzones);
 598 }
 599
 600 void NetZoneImpl::get_global_route_with_netzones(const NetPoint* src, const NetPoint* dst,
 601                                                  /* OUT */ std::vector<resource::StandardLinkImpl*>& links,
 602                                                  double* latency, std::unordered_set<NetZoneImpl*>& netzones)
 603 {
 604   Route route;
 605
 606   XBT_DEBUG("Resolve route from '%s' to '%s'", src->get_cname(), dst->get_cname());
 607
 608   /* Find how src and dst are interconnected */
 609   NetZoneImpl* common_ancestor;
 610   NetZoneImpl* src_ancestor;
 611   NetZoneImpl* dst_ancestor;
 612   find_common_ancestors(src, dst, &common_ancestor, &src_ancestor, &dst_ancestor);
 613   XBT_DEBUG("find_common_ancestors: common ancestor '%s' src ancestor '%s' dst ancestor '%s'",
 614             common_ancestor->get_cname(), src_ancestor->get_cname(), dst_ancestor->get_cname());
 615
 616   netzones.insert(src->get_englobing_zone());
 617   netzones.insert(dst->get_englobing_zone());
 618   netzones.insert(common_ancestor);
 619   /* Check whether a direct bypass is defined. If so, use it and bail out */
 620   if (common_ancestor->get_bypass_route(src, dst, links, latency, netzones))
 621     return;
 622
 623   /* If src and dst are in the same netzone, life is good */
 624   if (src_ancestor == dst_ancestor) { /* SURF_ROUTING_BASE */
 625     route.link_list_ = std::move(links);
 626     common_ancestor->get_local_route(src, dst, &route, latency);
 627     links = std::move(route.link_list_);
 628     return;
 629   }
 630
 631   /* Not in the same netzone, no bypass. We'll have to find our path between the netzones recursively */
 632   common_ancestor->get_local_route(src_ancestor->netpoint_, dst_ancestor->netpoint_, &route, latency);
 633   xbt_assert((route.gw_src_ != nullptr) && (route.gw_dst_ != nullptr), "Bad gateways for route from '%s' to '%s'.",
 634              src->get_cname(), dst->get_cname());
 635
 636   /* If source gateway is not our source, we have to recursively find our way up to this point */
 637   if (src != route.gw_src_)
 638     get_global_route_with_netzones(src, route.gw_src_, links, latency, netzones);
 639   links.insert(links.end(), begin(route.link_list_), end(route.link_list_));
 640
 641   /* If dest gateway is not our destination, we have to recursively find our way from this point */
 642   if (route.gw_dst_ != dst)
 643     get_global_route_with_netzones(route.gw_dst_, dst, links, latency, netzones);
 644 }
 645
 646 void NetZoneImpl::seal()
 647 {
 648   /* already sealed netzone */
 649   if (sealed_)
 650     return;
 651   do_seal(); // derived class' specific sealing procedure
 652
 653   /* seals sub-netzones and hosts */
 654   for (auto* host : get_all_hosts()) {
 655     host->seal();
 656   }
 657
 658   /* sealing links */
 659   for (auto const& [_, link] : links_)
 660     link->get_iface()->seal();
 661
 662   for (auto* sub_net : get_children()) {
 663     sub_net->seal();
 664   }
 665   sealed_ = true;
 666   s4u::NetZone::on_seal(piface_);
 667 }
 668
 669 void NetZoneImpl::set_parent(NetZoneImpl* parent)
 670 {
 671   xbt_assert(not sealed_, "Impossible to set parent to an already sealed NetZone(%s)", this->get_cname());
 672   parent_ = parent;
 673   netpoint_->set_englobing_zone(parent_);
 674   if (parent) {
 675     /* adding this class as child */
 676     parent->add_child(this);
 677     /* copying models from parent host, to be reviewed when we allow multi-models */
 678     set_network_model(parent->get_network_model());
 679     set_cpu_pm_model(parent->get_cpu_pm_model());
 680     set_cpu_vm_model(parent->get_cpu_vm_model());
 681     set_disk_model(parent->get_disk_model());
 682     set_host_model(parent->get_host_model());
 683   }
 684 }
 685
 686 void NetZoneImpl::set_network_model(std::shared_ptr<resource::NetworkModel> netmodel)
 687 {
 688   xbt_assert(not sealed_, "Impossible to set network model to an already sealed NetZone(%s)", this->get_cname());
 689   network_model_ = std::move(netmodel);
 690 }
 691
 692 void NetZoneImpl::set_cpu_vm_model(std::shared_ptr<resource::CpuModel> cpu_model)
 693 {
 694   xbt_assert(not sealed_, "Impossible to set CPU model to an already sealed NetZone(%s)", this->get_cname());
 695   cpu_model_vm_ = std::move(cpu_model);
 696 }
 697
 698 void NetZoneImpl::set_cpu_pm_model(std::shared_ptr<resource::CpuModel> cpu_model)
 699 {
 700   xbt_assert(not sealed_, "Impossible to set CPU model to an already sealed NetZone(%s)", this->get_cname());
 701   cpu_model_pm_ = std::move(cpu_model);
 702 }
 703
 704 void NetZoneImpl::set_disk_model(std::shared_ptr<resource::DiskModel> disk_model)
 705 {
 706   xbt_assert(not sealed_, "Impossible to set disk model to an already sealed NetZone(%s)", this->get_cname());
 707   disk_model_ = std::move(disk_model);
 708 }
 709
 710 void NetZoneImpl::set_host_model(std::shared_ptr<resource::HostModel> host_model)
 711 {
 712   xbt_assert(not sealed_, "Impossible to set host model to an already sealed NetZone(%s)", this->get_cname());
 713   host_model_ = std::move(host_model);
 714 }
 715
 716 const NetZoneImpl* NetZoneImpl::get_netzone_recursive(const NetPoint* netpoint) const
 717 {
 718   xbt_assert(netpoint && netpoint->is_netzone(), "Netpoint %s must be of the type NetZone",
 719              netpoint ? netpoint->get_cname() : "nullptr");
 720
 721   if (netpoint == netpoint_)
 722     return this;
 723
 724   for (const auto* children : children_) {
 725     const NetZoneImpl* netzone = children->get_netzone_recursive(netpoint);
 726     if (netzone)
 727       return netzone;
 728   }
 729   return nullptr;
 730 }
 731
 732 bool NetZoneImpl::is_component_recursive(const NetPoint* netpoint) const
 733 {
 734   /* check direct components */
 735   if (std::any_of(begin(vertices_), end(vertices_), [netpoint](const auto* elem) { return elem == netpoint; }))
 736     return true;
 737
 738   /* check childrens */
 739   return std::any_of(begin(children_), end(children_),
 740                      [netpoint](const auto* child) { return child->is_component_recursive(netpoint); });
 741 }
 742 } // namespace routing
 743 } // namespace kernel
 744 } // namespace simgrid