1 /* Copyright (c) 2009-2023. 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/RoutedZone.hpp"
7 #include "simgrid/kernel/routing/NetPoint.hpp"
8 #include "src/kernel/resource/StandardLinkImpl.hpp"
10 #include "xbt/graph.h"
12 #include "xbt/sysdep.h"
13 #include "xbt/asserts.hpp"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_routing_generic, ker_platform, "Kernel Generic Routing");
17 /* ***************************************************************** */
18 /* *********************** GENERIC METHODS ************************* */
20 namespace simgrid::kernel::routing {
22 RoutedZone::RoutedZone(const std::string& name) : NetZoneImpl(name) {}
24 /* ************************************************************************** */
25 /* ************************* GENERIC AUX FUNCTIONS ************************** */
26 /* change a route containing link names into a route containing link entities */
27 Route* RoutedZone::new_extended_route(RoutingMode hierarchy, NetPoint* gw_src, NetPoint* gw_dst,
28 const std::vector<resource::StandardLinkImpl*>& link_list, bool preserve_order)
30 xbt_enforce(hierarchy != RoutingMode::recursive || (gw_src && gw_dst), "nullptr is obviously a deficient gateway");
32 auto* result = new Route();
33 if (hierarchy == RoutingMode::recursive) {
34 result->gw_src_ = gw_src;
35 result->gw_dst_ = gw_dst;
39 result->link_list_ = link_list;
41 result->link_list_.assign(link_list.rbegin(), link_list.rend()); // reversed
42 result->link_list_.shrink_to_fit();
47 void RoutedZone::get_route_check_params(const NetPoint* src, const NetPoint* dst) const
49 xbt_enforce(src, "Cannot have a route with (nullptr) source");
50 xbt_enforce(dst, "Cannot have a route with (nullptr) destination");
52 const NetZoneImpl* src_as = src->get_englobing_zone();
53 const NetZoneImpl* dst_as = dst->get_englobing_zone();
55 xbt_enforce(src_as == dst_as,
56 "Internal error: %s@%s and %s@%s are not in the same netzone as expected. Please report that bug.",
57 src->get_cname(), src_as->get_cname(), dst->get_cname(), dst_as->get_cname());
59 xbt_enforce(this == dst_as,
60 "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
61 "%s@%s). Please report that bug.",
62 src->get_cname(), dst->get_cname(), src_as->get_cname(), dst_as->get_cname(), get_cname());
65 void RoutedZone::add_route_check_params(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
66 const std::vector<s4u::LinkInRoute>& link_list, bool symmetrical) const
68 get_route_check_params(src, dst);
69 const char* srcName = src->get_cname();
70 const char* dstName = dst->get_cname();
72 if (not gw_dst || not gw_src) {
73 XBT_DEBUG("Load Route from \"%s\" to \"%s\"", srcName, dstName);
74 xbt_enforce(not link_list.empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
75 xbt_enforce(not src->is_netzone(),
76 "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
78 xbt_enforce(not dst->is_netzone(),
79 "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
81 NetZoneImpl::on_route_creation(symmetrical, src, dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
83 XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, gw_src->get_cname(), dstName, gw_dst->get_cname());
84 xbt_enforce(src->is_netzone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
85 xbt_enforce(dst->is_netzone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
87 xbt_enforce(gw_src->is_host() || gw_src->is_router(),
88 "When defining a NetzoneRoute, gw_src must be a host or a router but '%s' is not.", srcName);
89 xbt_enforce(gw_dst->is_host() || gw_dst->is_router(),
90 "When defining a NetzoneRoute, gw_dst must be a host or a router but '%s' is not.", dstName);
92 xbt_enforce(gw_src != gw_dst, "Cannot define a NetzoneRoute from '%s' to itself", gw_src->get_cname());
94 xbt_enforce(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
95 gw_dst->get_cname(), srcName);
96 xbt_enforce(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
97 gw_dst->get_cname(), dstName);
98 xbt_enforce(not link_list.empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName, gw_src->get_cname(),
99 dstName, gw_dst->get_cname());
100 const auto* netzone_src = get_netzone_recursive(src);
101 xbt_enforce(netzone_src->is_component_recursive(gw_src),
102 "Invalid NetzoneRoute from %s@%s to %s@%s: gw_src %s belongs to %s, not to %s.", srcName,
103 gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_src->get_cname(),
104 gw_src->get_englobing_zone()->get_cname(), srcName);
106 const auto* netzone_dst = get_netzone_recursive(dst);
107 xbt_enforce(netzone_dst->is_component_recursive(gw_dst),
108 "Invalid NetzoneRoute from %s@%s to %s@%s: gw_dst %s belongs to %s, not to %s.", srcName,
109 gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_dst->get_cname(),
110 gw_dst->get_englobing_zone()->get_cname(), dst->get_cname());
111 NetZoneImpl::on_route_creation(symmetrical, gw_src, gw_dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
114 } // namespace simgrid::kernel::routing