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