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