1 /* Copyright (c) 2009-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/RoutedZone.hpp"
7 #include "simgrid/kernel/routing/NetPoint.hpp"
8 #include "src/surf/network_interface.hpp"
10 #include "xbt/graph.h"
12 #include "xbt/sysdep.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_routing_generic, surf_route, "Generic implementation of the surf routing");
16 /* ***************************************************************** */
17 /* *********************** GENERIC METHODS ************************* */
19 xbt_node_t new_xbt_graph_node(const s_xbt_graph_t* graph, const char* name,
20 std::map<std::string, xbt_node_t, std::less<>>* nodes)
22 auto elm = nodes->find(name);
23 if (elm == nodes->end()) {
24 xbt_node_t ret = xbt_graph_new_node(graph, xbt_strdup(name));
25 nodes->insert({name, ret});
31 xbt_edge_t new_xbt_graph_edge(const s_xbt_graph_t* graph, xbt_node_t s, xbt_node_t d,
32 std::map<std::string, xbt_edge_t, std::less<>>* edges)
34 const auto* sn = static_cast<const char*>(xbt_graph_node_get_data(s));
35 const auto* dn = static_cast<const char*>(xbt_graph_node_get_data(d));
36 std::string name = std::string(sn) + dn;
38 auto elm = edges->find(name);
39 if (elm == edges->end()) {
40 name = std::string(dn) + sn;
41 elm = edges->find(name);
44 if (elm == edges->end()) {
45 xbt_edge_t ret = xbt_graph_new_edge(graph, s, d, nullptr);
46 edges->insert({name, ret});
56 RoutedZone::RoutedZone(const std::string& name) : NetZoneImpl(name) {}
58 void RoutedZone::get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
59 std::map<std::string, xbt_edge_t, std::less<>>* edges)
61 std::vector<NetPoint*> vertices = get_vertices();
63 for (auto const& my_src : vertices) {
64 for (auto const& my_dst : vertices) {
70 get_local_route(my_src, my_dst, &route, nullptr);
72 XBT_DEBUG("get_route_and_latency %s -> %s", my_src->get_cname(), my_dst->get_cname());
76 const char* previous_name;
77 const char* current_name;
80 previous = new_xbt_graph_node(graph, route.gw_src_->get_cname(), nodes);
81 previous_name = route.gw_src_->get_cname();
83 previous = new_xbt_graph_node(graph, my_src->get_cname(), nodes);
84 previous_name = my_src->get_cname();
87 for (auto const& link : route.link_list_) {
88 const char* link_name = link->get_cname();
89 current = new_xbt_graph_node(graph, link_name, nodes);
90 current_name = link_name;
91 new_xbt_graph_edge(graph, previous, current, edges);
92 XBT_DEBUG(" %s -> %s", previous_name, current_name);
94 previous_name = current_name;
98 current = new_xbt_graph_node(graph, route.gw_dst_->get_cname(), nodes);
99 current_name = route.gw_dst_->get_cname();
101 current = new_xbt_graph_node(graph, my_dst->get_cname(), nodes);
102 current_name = my_dst->get_cname();
104 new_xbt_graph_edge(graph, previous, current, edges);
105 XBT_DEBUG(" %s -> %s", previous_name, current_name);
110 /* ************************************************************************** */
111 /* ************************* GENERIC AUX FUNCTIONS ************************** */
112 /* change a route containing link names into a route containing link entities */
113 Route* RoutedZone::new_extended_route(RoutingMode hierarchy, NetPoint* gw_src, NetPoint* gw_dst,
114 const std::vector<resource::LinkImpl*>& link_list, bool preserve_order)
116 auto* result = new Route();
118 if (hierarchy == RoutingMode::recursive) {
119 xbt_assert(gw_src && gw_dst, "nullptr is obviously a deficient gateway");
121 result->gw_src_ = gw_src;
122 result->gw_dst_ = gw_dst;
126 result->link_list_ = link_list;
128 result->link_list_.assign(link_list.rbegin(), link_list.rend()); // reversed
129 result->link_list_.shrink_to_fit();
134 void RoutedZone::get_route_check_params(const NetPoint* src, const NetPoint* dst) const
136 xbt_assert(src, "Cannot find a route from nullptr to %s", dst->get_cname());
137 xbt_assert(dst, "Cannot find a route from %s to nullptr", src->get_cname());
139 const NetZoneImpl* src_as = src->get_englobing_zone();
140 const NetZoneImpl* dst_as = dst->get_englobing_zone();
142 xbt_assert(src_as == dst_as,
143 "Internal error: %s@%s and %s@%s are not in the same netzone as expected. Please report that bug.",
144 src->get_cname(), src_as->get_cname(), dst->get_cname(), dst_as->get_cname());
146 xbt_assert(this == dst_as,
147 "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
148 "%s@%s). Please report that bug.",
149 src->get_cname(), dst->get_cname(), src_as->get_cname(), dst_as->get_cname(), get_cname());
151 void RoutedZone::add_route_check_params(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
152 const std::vector<resource::LinkImpl*>& link_list, bool symmetrical) const
154 const char* srcName = src->get_cname();
155 const char* dstName = dst->get_cname();
157 if (not gw_dst || not gw_src) {
158 XBT_DEBUG("Load Route from \"%s\" to \"%s\"", srcName, dstName);
159 xbt_assert(src, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, srcName);
160 xbt_assert(dst, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, dstName);
161 xbt_assert(not link_list.empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
162 xbt_assert(not src->is_netzone(),
163 "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
165 xbt_assert(not dst->is_netzone(),
166 "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
168 s4u::NetZone::on_route_creation(symmetrical, src, dst, gw_src, gw_dst, link_list);
170 XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, gw_src->get_cname(), dstName, gw_dst->get_cname());
171 xbt_assert(src->is_netzone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
172 xbt_assert(dst->is_netzone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
174 xbt_assert(gw_src->is_host() || gw_src->is_router(),
175 "When defining a NetzoneRoute, gw_src must be a host or a router but '%s' is not.", srcName);
176 xbt_assert(gw_dst->is_host() || gw_dst->is_router(),
177 "When defining a NetzoneRoute, gw_dst must be a host or a router but '%s' is not.", dstName);
179 xbt_assert(gw_src != gw_dst, "Cannot define a NetzoneRoute from '%s' to itself", gw_src->get_cname());
181 xbt_assert(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
182 gw_dst->get_cname(), srcName);
183 xbt_assert(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
184 gw_dst->get_cname(), dstName);
185 xbt_assert(not link_list.empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName, gw_src->get_cname(),
186 dstName, gw_dst->get_cname());
187 const auto* netzone_src = get_netzone_recursive(src);
188 xbt_assert(netzone_src->is_component_recursive(gw_src),
189 "Invalid NetzoneRoute from %s@%s to %s@%s: gw_src %s belongs to %s, not to %s.", srcName,
190 gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_src->get_cname(),
191 gw_src->get_englobing_zone()->get_cname(), srcName);
193 const auto* netzone_dst = get_netzone_recursive(dst);
194 xbt_assert(netzone_dst->is_component_recursive(gw_dst),
195 "Invalid NetzoneRoute from %s@%s to %s@%s: gw_dst %s belongs to %s, not to %s.", srcName,
196 gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_dst->get_cname(),
197 gw_dst->get_englobing_zone()->get_cname(), dst->get_cname());
198 s4u::NetZone::on_route_creation(symmetrical, gw_src, gw_dst, gw_src, gw_dst, link_list);
201 } // namespace routing
202 } // namespace kernel
203 } // namespace simgrid