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"
9 #include "src/surf/xml/platf_private.hpp"
11 #include "xbt/graph.h"
13 #include "xbt/sysdep.h"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_routing_generic, surf_route, "Generic implementation of the surf routing");
17 /* ***************************************************************** */
18 /* *********************** GENERIC METHODS ************************* */
20 xbt_node_t new_xbt_graph_node(const s_xbt_graph_t* graph, const char* name,
21 std::map<std::string, xbt_node_t, std::less<>>* nodes)
23 auto elm = nodes->find(name);
24 if (elm == nodes->end()) {
25 xbt_node_t ret = xbt_graph_new_node(graph, xbt_strdup(name));
26 nodes->insert({name, ret});
32 xbt_edge_t new_xbt_graph_edge(const s_xbt_graph_t* graph, xbt_node_t s, xbt_node_t d,
33 std::map<std::string, xbt_edge_t, std::less<>>* edges)
35 const auto* sn = static_cast<const char*>(xbt_graph_node_get_data(s));
36 const auto* dn = static_cast<const char*>(xbt_graph_node_get_data(d));
37 std::string name = std::string(sn) + dn;
39 auto elm = edges->find(name);
40 if (elm == edges->end()) {
41 name = std::string(dn) + sn;
42 elm = edges->find(name);
45 if (elm == edges->end()) {
46 xbt_edge_t ret = xbt_graph_new_edge(graph, s, d, nullptr);
47 edges->insert({name, ret});
57 RoutedZone::RoutedZone(const std::string& name) : NetZoneImpl(name) {}
59 void RoutedZone::get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
60 std::map<std::string, xbt_edge_t, std::less<>>* edges)
62 std::vector<NetPoint*> vertices = get_vertices();
64 for (auto const& my_src : vertices) {
65 for (auto const& my_dst : vertices) {
69 RouteCreationArgs route;
71 get_local_route(my_src, my_dst, &route, nullptr);
73 XBT_DEBUG("get_route_and_latency %s -> %s", my_src->get_cname(), my_dst->get_cname());
77 const char* previous_name;
78 const char* current_name;
81 previous = new_xbt_graph_node(graph, route.gw_src->get_cname(), nodes);
82 previous_name = route.gw_src->get_cname();
84 previous = new_xbt_graph_node(graph, my_src->get_cname(), nodes);
85 previous_name = my_src->get_cname();
88 for (auto const& link : route.link_list) {
89 const char* link_name = link->get_cname();
90 current = new_xbt_graph_node(graph, link_name, nodes);
91 current_name = link_name;
92 new_xbt_graph_edge(graph, previous, current, edges);
93 XBT_DEBUG(" %s -> %s", previous_name, current_name);
95 previous_name = current_name;
99 current = new_xbt_graph_node(graph, route.gw_dst->get_cname(), nodes);
100 current_name = route.gw_dst->get_cname();
102 current = new_xbt_graph_node(graph, my_dst->get_cname(), nodes);
103 current_name = my_dst->get_cname();
105 new_xbt_graph_edge(graph, previous, current, edges);
106 XBT_DEBUG(" %s -> %s", previous_name, current_name);
111 /* ************************************************************************** */
112 /* ************************* GENERIC AUX FUNCTIONS ************************** */
113 /* change a route containing link names into a route containing link entities */
114 RouteCreationArgs* RoutedZone::new_extended_route(RoutingMode hierarchy, NetPoint* gw_src, NetPoint* gw_dst,
115 const std::vector<resource::LinkImpl*>& link_list,
118 auto* result = new RouteCreationArgs();
120 xbt_assert(hierarchy == RoutingMode::base || hierarchy == RoutingMode::recursive,
121 "The hierarchy of this netzone is neither BASIC nor RECURSIVE, I'm lost here.");
123 if (hierarchy == RoutingMode::recursive) {
124 xbt_assert(gw_src && gw_dst, "nullptr is obviously a deficient gateway");
126 result->gw_src = gw_src;
127 result->gw_dst = gw_dst;
131 result->link_list = link_list;
133 result->link_list.assign(link_list.rbegin(), link_list.rend()); // reversed
134 result->link_list.shrink_to_fit();
139 void RoutedZone::get_route_check_params(NetPoint* src, NetPoint* dst) const
141 xbt_assert(src, "Cannot find a route from nullptr to %s", dst->get_cname());
142 xbt_assert(dst, "Cannot find a route from %s to nullptr", src->get_cname());
144 const NetZoneImpl* src_as = src->get_englobing_zone();
145 const NetZoneImpl* dst_as = dst->get_englobing_zone();
147 xbt_assert(src_as == dst_as,
148 "Internal error: %s@%s and %s@%s are not in the same netzone as expected. Please report that bug.",
149 src->get_cname(), src_as->get_cname(), dst->get_cname(), dst_as->get_cname());
151 xbt_assert(this == dst_as,
152 "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
153 "%s@%s). Please report that bug.",
154 src->get_cname(), dst->get_cname(), src_as->get_cname(), dst_as->get_cname(), get_cname());
156 void RoutedZone::add_route_check_params(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
157 const std::vector<resource::LinkImpl*>& link_list, bool symmetrical) const
159 const char* srcName = src->get_cname();
160 const char* dstName = dst->get_cname();
162 if (not gw_dst || not gw_src) {
163 XBT_DEBUG("Load Route from \"%s\" to \"%s\"", srcName, dstName);
164 xbt_assert(src, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, srcName);
165 xbt_assert(dst, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, dstName);
166 xbt_assert(not link_list.empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
167 xbt_assert(not src->is_netzone(),
168 "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
170 xbt_assert(not dst->is_netzone(),
171 "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
173 s4u::NetZone::on_route_creation(symmetrical, src, dst, gw_src, gw_dst, link_list);
175 XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, gw_src->get_cname(), dstName, gw_dst->get_cname());
176 xbt_assert(src->is_netzone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
177 xbt_assert(dst->is_netzone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
179 xbt_assert(gw_src->is_host() || gw_src->is_router(),
180 "When defining a NetzoneRoute, gw_src must be a host or a router but '%s' is not.", srcName);
181 xbt_assert(gw_dst->is_host() || gw_dst->is_router(),
182 "When defining a NetzoneRoute, gw_dst must be a host or a router but '%s' is not.", dstName);
184 xbt_assert(gw_src != gw_dst, "Cannot define a NetzoneRoute from '%s' to itself", gw_src->get_cname());
186 xbt_assert(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
187 gw_dst->get_cname(), srcName);
188 xbt_assert(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
189 gw_dst->get_cname(), dstName);
190 xbt_assert(not link_list.empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName, gw_src->get_cname(),
191 dstName, gw_dst->get_cname());
192 s4u::NetZone::on_route_creation(symmetrical, gw_src, gw_dst, gw_src, gw_dst, link_list);
195 } // namespace routing
196 } // namespace kernel
197 } // namespace simgrid