1 /* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
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. */
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/SplitDuplexLinkImpl.hpp"
15 #include "src/surf/cpu_interface.hpp"
16 #include "src/surf/network_interface.hpp"
17 #include "surf/surf.hpp"
19 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_route);
25 /* Pick the right models for CPU, net and host, and call their model_init_preparse */
26 static void surf_config_models_setup()
28 std::string host_model_name = simgrid::config::get_value<std::string>("host/model");
29 std::string network_model_name = simgrid::config::get_value<std::string>("network/model");
30 std::string cpu_model_name = simgrid::config::get_value<std::string>("cpu/model");
31 std::string disk_model_name = simgrid::config::get_value<std::string>("disk/model");
33 /* The compound host model is needed when using non-default net/cpu models */
34 if ((not simgrid::config::is_default("network/model") || not simgrid::config::is_default("cpu/model")) &&
35 simgrid::config::is_default("host/model")) {
36 host_model_name = "compound";
37 simgrid::config::set_value("host/model", host_model_name);
40 XBT_DEBUG("host model: %s", host_model_name.c_str());
41 if (host_model_name == "compound") {
42 xbt_assert(not cpu_model_name.empty(), "Set a cpu model to use with the 'compound' host model");
43 xbt_assert(not network_model_name.empty(), "Set a network model to use with the 'compound' host model");
45 const auto* cpu_model = find_model_description(surf_cpu_model_description, cpu_model_name);
46 cpu_model->model_init_preparse();
48 const auto* network_model = find_model_description(surf_network_model_description, network_model_name);
49 network_model->model_init_preparse();
52 XBT_DEBUG("Call host_model_init");
53 const auto* host_model = find_model_description(surf_host_model_description, host_model_name);
54 host_model->model_init_preparse();
56 XBT_DEBUG("Call vm_model_init");
57 /* ideally we should get back the pointer to CpuModel from model_init_preparse(), but this
58 * requires changing the declaration of surf_cpu_model_description.
59 * To be reviewed in the future */
60 surf_vm_model_init_HL13(
61 simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->get_cpu_pm_model().get());
63 XBT_DEBUG("Call disk_model_init");
64 const auto* disk_model = find_model_description(surf_disk_model_description, disk_model_name);
65 disk_model->model_init_preparse();
68 xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
69 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
70 std::vector<kernel::resource::LinkImpl*> const& link_list)>
71 NetZoneImpl::on_route_creation;
73 NetZoneImpl::NetZoneImpl(const std::string& name) : piface_(this), name_(name)
75 auto* engine = s4u::Engine::get_instance();
76 /* workaroud: first netzoneImpl will be the root netzone.
77 * Without globals and with current surf_*_model_description init functions, we need
78 * the root netzone to exist when creating the models.
79 * This was usually done at sg_platf.cpp, during XML parsing */
80 if (not engine->get_netzone_root()) {
81 engine->set_netzone_root(&piface_);
82 /* root netzone set, initialize models */
83 simgrid::s4u::Engine::on_platform_creation();
85 /* Initialize the surf models. That must be done after we got all config, and before we need the models.
86 * That is, after the last <config> tag, if any, and before the first of cluster|peer|zone|trace|trace_connect
88 * I'm not sure for <trace> and <trace_connect>, there may be a bug here
89 * (FIXME: check it out by creating a file beginning with one of these tags)
90 * but cluster and peer come down to zone creations, so putting this verification here is correct.
92 surf_config_models_setup();
95 xbt_assert(nullptr == engine->netpoint_by_name_or_null(get_name()),
96 "Refusing to create a second NetZone called '%s'.", get_cname());
97 netpoint_ = new NetPoint(name_, NetPoint::Type::NetZone);
98 XBT_DEBUG("NetZone '%s' created with the id '%lu'", get_cname(), netpoint_->id());
99 _sg_cfg_init_status = 2; /* HACK: direct access to the global controlling the level of configuration to prevent
100 * any further config now that we created some real content */
101 simgrid::s4u::NetZone::on_creation(piface_); // notify the signal
104 NetZoneImpl::~NetZoneImpl()
106 for (auto const& nz : children_)
109 for (auto const& kv : bypass_routes_)
112 s4u::Engine::get_instance()->netpoint_unregister(netpoint_);
115 void NetZoneImpl::add_child(NetZoneImpl* new_zone)
117 xbt_assert(not sealed_, "Cannot add a new child to the sealed zone %s", get_cname());
118 /* set the parent behavior */
119 hierarchy_ = RoutingMode::recursive;
120 children_.push_back(new_zone);
123 /** @brief Returns the list of the hosts found in this NetZone (not recursively)
125 * Only the hosts that are directly contained in this NetZone are retrieved,
126 * not the ones contained in sub-netzones.
128 std::vector<s4u::Host*> NetZoneImpl::get_all_hosts() const
130 std::vector<s4u::Host*> res;
131 for (auto const& card : get_vertices()) {
132 s4u::Host* host = s4u::Host::by_name_or_null(card->get_name());
138 int NetZoneImpl::get_host_count() const
141 for (auto const& card : get_vertices()) {
142 const s4u::Host* host = s4u::Host::by_name_or_null(card->get_name());
149 s4u::Host* NetZoneImpl::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
151 xbt_assert(cpu_model_pm_,
152 "Impossible to create host: %s. Invalid CPU model: nullptr. Have you set the parent of this NetZone: %s?",
153 name.c_str(), get_cname());
154 auto* res = (new surf::HostImpl(name))->get_iface();
155 res->set_netpoint((new NetPoint(name, NetPoint::Type::Host))->set_englobing_zone(this));
157 cpu_model_pm_->create_cpu(res, speed_per_pstate);
162 s4u::Link* NetZoneImpl::create_link(const std::string& name, const std::vector<double>& bandwidths)
166 "Impossible to create link: %s. Invalid network model: nullptr. Have you set the parent of this NetZone: %s?",
167 name.c_str(), get_cname());
168 return network_model_->create_link(name, bandwidths)->get_iface();
171 s4u::SplitDuplexLink* NetZoneImpl::create_split_duplex_link(const std::string& name,
172 const std::vector<double>& bandwidths)
174 auto* link_up = network_model_->create_link(name + "_UP", bandwidths);
175 auto* link_down = network_model_->create_link(name + "_DOWN", bandwidths);
176 auto link = std::make_unique<resource::SplitDuplexLinkImpl>(name, link_up, link_down);
177 auto* link_iface = link->get_iface();
178 EngineImpl::get_instance()->add_split_duplex_link(name, std::move(link));
182 s4u::Disk* NetZoneImpl::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
184 xbt_assert(disk_model_,
185 "Impossible to create disk: %s. Invalid disk model: nullptr. Have you set the parent of this NetZone: %s?",
186 name.c_str(), get_cname());
187 auto* l = disk_model_->create_disk(name, read_bandwidth, write_bandwidth);
189 return l->get_iface();
192 NetPoint* NetZoneImpl::create_router(const std::string& name)
194 xbt_assert(nullptr == s4u::Engine::get_instance()->netpoint_by_name_or_null(name),
195 "Refusing to create a router named '%s': this name already describes a node.", name.c_str());
197 return (new NetPoint(name, NetPoint::Type::Router))->set_englobing_zone(this);
200 unsigned long NetZoneImpl::add_component(NetPoint* elm)
202 vertices_.push_back(elm);
203 return vertices_.size() - 1; // The rank of the newly created object
206 std::vector<resource::LinkImpl*> NetZoneImpl::get_link_list_impl(const std::vector<s4u::LinkInRoute>& link_list,
207 bool backroute) const
209 std::vector<resource::LinkImpl*> links;
211 for (const auto& link : link_list) {
212 if (link.get_link()->get_sharing_policy() != s4u::Link::SharingPolicy::SPLITDUPLEX) {
213 links.push_back(link.get_link()->get_impl());
216 // split-duplex links
217 const auto* sd_link = dynamic_cast<const s4u::SplitDuplexLink*>(link.get_link());
219 "Add_route: cast to SpliDuplexLink impossible. This should not happen, please contact SimGrid team");
220 resource::LinkImpl* link_impl;
221 switch (link.get_direction()) {
222 case s4u::LinkInRoute::Direction::UP:
224 link_impl = sd_link->get_link_down()->get_impl();
226 link_impl = sd_link->get_link_up()->get_impl();
228 case s4u::LinkInRoute::Direction::DOWN:
230 link_impl = sd_link->get_link_up()->get_impl();
232 link_impl = sd_link->get_link_down()->get_impl();
235 throw std::invalid_argument("Invalid add_route. Split-Duplex link without a direction: " +
236 link.get_link()->get_name());
238 links.push_back(link_impl);
243 void NetZoneImpl::add_route(NetPoint* /*src*/, NetPoint* /*dst*/, NetPoint* /*gw_src*/, NetPoint* /*gw_dst*/,
244 const std::vector<s4u::LinkInRoute>& /*link_list_*/, bool /*symmetrical*/)
246 xbt_die("NetZone '%s' does not accept new routes (wrong class).", get_cname());
249 void NetZoneImpl::add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
250 const std::vector<s4u::LinkInRoute>& link_list)
252 /* Argument validity checks */
254 XBT_DEBUG("Load bypassNetzoneRoute from %s@%s to %s@%s", src->get_cname(), gw_src->get_cname(), dst->get_cname(),
255 gw_dst->get_cname());
256 xbt_assert(not link_list.empty(), "Bypass route between %s@%s and %s@%s cannot be empty.", src->get_cname(),
257 gw_src->get_cname(), dst->get_cname(), gw_dst->get_cname());
258 xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
259 "The bypass route between %s@%s and %s@%s already exists.", src->get_cname(), gw_src->get_cname(),
260 dst->get_cname(), gw_dst->get_cname());
262 XBT_DEBUG("Load bypassRoute from %s to %s", src->get_cname(), dst->get_cname());
263 xbt_assert(not link_list.empty(), "Bypass route between %s and %s cannot be empty.", src->get_cname(),
265 xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
266 "The bypass route between %s and %s already exists.", src->get_cname(), dst->get_cname());
269 /* Build a copy that will be stored in the dict */
270 auto* newRoute = new BypassRoute(gw_src, gw_dst);
271 auto converted_list = get_link_list_impl(link_list, false);
272 newRoute->links.insert(newRoute->links.end(), begin(converted_list), end(converted_list));
275 bypass_routes_.insert({{src, dst}, newRoute});
278 /** @brief Get the common ancestor and its first children in each line leading to src and dst
280 * In the recursive case, this sets common_ancestor, src_ancestor and dst_ancestor are set as follows.
284 * ... <- possibly long path
289 * / \ <- direct links
292 * src_ancestor dst_ancestor <- must be different in the recursive case
294 * ... ... <-- possibly long paths (one hop or more)
299 * In the base case (when src and dst are in the same netzone), things are as follows:
303 * ... <-- possibly long path
305 * common_ancestor==src_ancestor==dst_ancestor <-- all the same value
307 * / \ <-- direct links (exactly one hop)
312 * A specific recursive case occurs when src is the ancestor of dst. In this case,
313 * the base case routing should be used so the common_ancestor is specifically set
314 * to src_ancestor==dst_ancestor.
315 * Naturally, things are completely symmetrical if dst is the ancestor of src.
319 * ... <-- possibly long path
321 * src == src_ancestor==dst_ancestor==common_ancestor <-- same value
323 * ... <-- possibly long path (one hop or more)
328 static void find_common_ancestors(const NetPoint* src, const NetPoint* dst,
329 /* OUT */ NetZoneImpl** common_ancestor, NetZoneImpl** src_ancestor,
330 NetZoneImpl** dst_ancestor)
332 /* Deal with the easy base case */
333 if (src->get_englobing_zone() == dst->get_englobing_zone()) {
334 *common_ancestor = src->get_englobing_zone();
335 *src_ancestor = *common_ancestor;
336 *dst_ancestor = *common_ancestor;
340 /* engage the full recursive search */
342 /* (1) find the path to root of src and dst*/
343 const NetZoneImpl* src_as = src->get_englobing_zone();
344 const NetZoneImpl* dst_as = dst->get_englobing_zone();
346 xbt_assert(src_as, "Host %s must be in a netzone", src->get_cname());
347 xbt_assert(dst_as, "Host %s must be in a netzone", dst->get_cname());
349 /* (2) find the path to the root routing component */
350 std::vector<NetZoneImpl*> path_src;
351 NetZoneImpl* current = src->get_englobing_zone();
352 while (current != nullptr) {
353 path_src.push_back(current);
354 current = current->get_parent();
356 std::vector<NetZoneImpl*> path_dst;
357 current = dst->get_englobing_zone();
358 while (current != nullptr) {
359 path_dst.push_back(current);
360 current = current->get_parent();
363 /* (3) find the common parent.
364 * Before that, index_src and index_dst may be different, they both point to nullptr in path_src/path_dst
365 * So we move them down simultaneously as long as they point to the same content.
367 * This works because all SimGrid platform have a unique root element (that is the last element of both paths).
369 NetZoneImpl* parent = nullptr; // the netzone we dropped on the previous loop iteration
370 while (path_src.size() > 1 && path_dst.size() > 1 && path_src.back() == path_dst.back()) {
371 parent = path_src.back();
376 /* (4) we found the difference at least. Finalize the returned values */
377 *src_ancestor = path_src.back(); /* the first different parent of src */
378 *dst_ancestor = path_dst.back(); /* the first different parent of dst */
379 if (*src_ancestor == *dst_ancestor) { // src is the ancestor of dst, or the contrary
380 *common_ancestor = *src_ancestor;
382 xbt_assert(parent != nullptr);
383 *common_ancestor = parent;
387 /* PRECONDITION: this is the common ancestor of src and dst */
388 bool NetZoneImpl::get_bypass_route(const NetPoint* src, const NetPoint* dst,
389 /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency,
390 std::unordered_set<NetZoneImpl*>& netzones)
392 // If never set a bypass route return nullptr without any further computations
393 if (bypass_routes_.empty())
396 /* Base case, no recursion is needed */
397 if (dst->get_englobing_zone() == this && src->get_englobing_zone() == this) {
398 if (bypass_routes_.find({src, dst}) != bypass_routes_.end()) {
399 const BypassRoute* bypassedRoute = bypass_routes_.at({src, dst});
400 add_link_latency(links, bypassedRoute->links, latency);
401 XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links", src->get_cname(), dst->get_cname(),
402 bypassedRoute->links.size());
408 /* Engage recursive search */
410 /* (1) find the path to the root routing component */
411 std::vector<NetZoneImpl*> path_src;
412 NetZoneImpl* current = src->get_englobing_zone();
413 while (current != nullptr) {
414 path_src.push_back(current);
415 current = current->parent_;
418 std::vector<NetZoneImpl*> path_dst;
419 current = dst->get_englobing_zone();
420 while (current != nullptr) {
421 path_dst.push_back(current);
422 current = current->parent_;
425 /* (2) find the common parent */
426 while (path_src.size() > 1 && path_dst.size() > 1 && path_src.back() == path_dst.back()) {
431 /* (3) Search for a bypass making the path up to the ancestor useless */
432 const BypassRoute* bypassedRoute = nullptr;
433 std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*> key;
434 // Search for a bypass with the given indices. Returns true if found. Initialize variables `bypassedRoute' and `key'.
435 auto lookup = [&bypassedRoute, &key, &path_src, &path_dst, this](unsigned src_index, unsigned dst_index) {
436 if (src_index < path_src.size() && dst_index < path_dst.size()) {
437 key = {path_src[src_index]->netpoint_, path_dst[dst_index]->netpoint_};
438 auto bpr = bypass_routes_.find(key);
439 if (bpr != bypass_routes_.end()) {
440 bypassedRoute = bpr->second;
447 for (unsigned max = 0, max_index = std::max(path_src.size(), path_dst.size()); max < max_index; max++) {
448 for (unsigned i = 0; i < max; i++) {
449 if (lookup(i, max) || lookup(max, i))
452 if (bypassedRoute || lookup(max, max))
456 /* (4) If we have the bypass, use it. If not, caller will do the Right Thing. */
458 XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links. We may have to complete it with recursive "
460 src->get_cname(), dst->get_cname(), bypassedRoute->links.size());
461 if (src != key.first)
462 get_global_route_with_netzones(src, bypassedRoute->gw_src, links, latency, netzones);
463 add_link_latency(links, bypassedRoute->links, latency);
464 if (dst != key.second)
465 get_global_route_with_netzones(bypassedRoute->gw_dst, dst, links, latency, netzones);
468 XBT_DEBUG("No bypass route from '%s' to '%s'.", src->get_cname(), dst->get_cname());
472 void NetZoneImpl::get_global_route(const NetPoint* src, const NetPoint* dst,
473 /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency)
475 std::unordered_set<NetZoneImpl*> netzones;
476 get_global_route_with_netzones(src, dst, links, latency, netzones);
479 void NetZoneImpl::get_global_route_with_netzones(const NetPoint* src, const NetPoint* dst,
480 /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency,
481 std::unordered_set<NetZoneImpl*>& netzones)
485 XBT_DEBUG("Resolve route from '%s' to '%s'", src->get_cname(), dst->get_cname());
487 /* Find how src and dst are interconnected */
488 NetZoneImpl* common_ancestor;
489 NetZoneImpl* src_ancestor;
490 NetZoneImpl* dst_ancestor;
491 find_common_ancestors(src, dst, &common_ancestor, &src_ancestor, &dst_ancestor);
492 XBT_DEBUG("find_common_ancestors: common ancestor '%s' src ancestor '%s' dst ancestor '%s'",
493 common_ancestor->get_cname(), src_ancestor->get_cname(), dst_ancestor->get_cname());
495 netzones.insert(src->get_englobing_zone());
496 netzones.insert(dst->get_englobing_zone());
497 netzones.insert(common_ancestor);
498 /* Check whether a direct bypass is defined. If so, use it and bail out */
499 if (common_ancestor->get_bypass_route(src, dst, links, latency, netzones))
502 /* If src and dst are in the same netzone, life is good */
503 if (src_ancestor == dst_ancestor) { /* SURF_ROUTING_BASE */
504 route.link_list_ = std::move(links);
505 common_ancestor->get_local_route(src, dst, &route, latency);
506 links = std::move(route.link_list_);
510 /* Not in the same netzone, no bypass. We'll have to find our path between the netzones recursively */
511 common_ancestor->get_local_route(src_ancestor->netpoint_, dst_ancestor->netpoint_, &route, latency);
512 xbt_assert((route.gw_src_ != nullptr) && (route.gw_dst_ != nullptr), "Bad gateways for route from '%s' to '%s'.",
513 src->get_cname(), dst->get_cname());
515 /* If source gateway is not our source, we have to recursively find our way up to this point */
516 if (src != route.gw_src_)
517 get_global_route_with_netzones(src, route.gw_src_, links, latency, netzones);
518 links.insert(links.end(), begin(route.link_list_), end(route.link_list_));
520 /* If dest gateway is not our destination, we have to recursively find our way from this point */
521 if (route.gw_dst_ != dst)
522 get_global_route_with_netzones(route.gw_dst_, dst, links, latency, netzones);
525 void NetZoneImpl::seal()
527 /* already sealed netzone */
530 do_seal(); // derived class' specific sealing procedure
532 /* seals sub-netzones and hosts */
533 for (auto* host : get_all_hosts()) {
536 for (auto* sub_net : get_children()) {
540 s4u::NetZone::on_seal(piface_);
543 void NetZoneImpl::set_parent(NetZoneImpl* parent)
545 xbt_assert(not sealed_, "Impossible to set parent to an already sealed NetZone(%s)", this->get_cname());
547 netpoint_->set_englobing_zone(parent_);
549 /* adding this class as child */
550 parent->add_child(this);
551 /* copying models from parent host, to be reviewed when we allow multi-models */
552 set_network_model(parent->get_network_model());
553 set_cpu_pm_model(parent->get_cpu_pm_model());
554 set_cpu_vm_model(parent->get_cpu_vm_model());
555 set_disk_model(parent->get_disk_model());
556 set_host_model(parent->get_host_model());
560 void NetZoneImpl::set_network_model(std::shared_ptr<resource::NetworkModel> netmodel)
562 xbt_assert(not sealed_, "Impossible to set network model to an already sealed NetZone(%s)", this->get_cname());
563 network_model_ = std::move(netmodel);
566 void NetZoneImpl::set_cpu_vm_model(std::shared_ptr<resource::CpuModel> cpu_model)
568 xbt_assert(not sealed_, "Impossible to set CPU model to an already sealed NetZone(%s)", this->get_cname());
569 cpu_model_vm_ = std::move(cpu_model);
572 void NetZoneImpl::set_cpu_pm_model(std::shared_ptr<resource::CpuModel> cpu_model)
574 xbt_assert(not sealed_, "Impossible to set CPU model to an already sealed NetZone(%s)", this->get_cname());
575 cpu_model_pm_ = std::move(cpu_model);
578 void NetZoneImpl::set_disk_model(std::shared_ptr<resource::DiskModel> disk_model)
580 xbt_assert(not sealed_, "Impossible to set disk model to an already sealed NetZone(%s)", this->get_cname());
581 disk_model_ = std::move(disk_model);
584 void NetZoneImpl::set_host_model(std::shared_ptr<surf::HostModel> host_model)
586 xbt_assert(not sealed_, "Impossible to set host model to an already sealed NetZone(%s)", this->get_cname());
587 host_model_ = std::move(host_model);
590 const NetZoneImpl* NetZoneImpl::get_netzone_recursive(const NetPoint* netpoint) const
592 xbt_assert(netpoint && netpoint->is_netzone(), "Netpoint %s must be of the type NetZone",
593 netpoint ? netpoint->get_cname() : "nullptr");
595 if (netpoint == netpoint_)
598 for (const auto* children : children_) {
599 const NetZoneImpl* netzone = children->get_netzone_recursive(netpoint);
606 bool NetZoneImpl::is_component_recursive(const NetPoint* netpoint) const
608 /* check direct components */
609 if (std::any_of(begin(vertices_), end(vertices_), [netpoint](const auto* elem) { return elem == netpoint; }))
612 /* check childrens */
613 return std::any_of(begin(children_), end(children_),
614 [netpoint](const auto* child) { return child->is_component_recursive(netpoint); });
616 } // namespace routing
617 } // namespace kernel
618 } // namespace simgrid