Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
dff7174aaf2d261e5b38c359184616d6827912fe
[simgrid.git] / src / kernel / routing / RoutedZone.cpp
1 /* Copyright (c) 2009-2019. 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 "xbt/dict.h"
7 #include "xbt/graph.h"
8 #include "xbt/log.h"
9 #include "xbt/sysdep.h"
10 #include "simgrid/kernel/routing/NetPoint.hpp"
11 #include "simgrid/kernel/routing/RoutedZone.hpp"
12 #include "src/surf/network_interface.hpp"
13 #include "src/surf/xml/platf_private.hpp"
14
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_routing_generic, surf_route, "Generic implementation of the surf routing");
16
17 /* ***************************************************************** */
18 /* *********************** GENERIC METHODS ************************* */
19
20 static const char* instr_node_name(xbt_node_t node)
21 {
22   void* data = xbt_graph_node_get_data(node);
23   return static_cast<const char*>(data);
24 }
25
26 xbt_node_t new_xbt_graph_node(xbt_graph_t graph, const char* name, std::map<std::string, xbt_node_t>* nodes)
27 {
28   auto elm = nodes->find(name);
29   if (elm == nodes->end()) {
30     xbt_node_t ret = xbt_graph_new_node(graph, xbt_strdup(name));
31     nodes->insert({name, ret});
32     return ret;
33   } else
34     return elm->second;
35 }
36
37 xbt_edge_t new_xbt_graph_edge(xbt_graph_t graph, xbt_node_t s, xbt_node_t d, std::map<std::string, xbt_edge_t>* edges)
38 {
39   const char* sn = instr_node_name(s);
40   const char* dn = instr_node_name(d);
41   std::string name = std::string(sn) + dn;
42
43   auto elm = edges->find(name);
44   if (elm == edges->end()) {
45     name = std::string(dn) + sn;
46     elm  = edges->find(name);
47   }
48
49   if (elm == edges->end()) {
50     xbt_edge_t ret = xbt_graph_new_edge(graph, s, d, nullptr);
51     edges->insert({name, ret});
52     return ret;
53   } else
54     return elm->second;
55 }
56
57 namespace simgrid {
58 namespace kernel {
59 namespace routing {
60
61 RoutedZone::RoutedZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel)
62     : NetZoneImpl(father, name, netmodel)
63 {
64 }
65
66 void RoutedZone::get_graph(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
67                            std::map<std::string, xbt_edge_t>* edges)
68 {
69   std::vector<NetPoint*> vertices = get_vertices();
70
71   for (auto const& my_src : vertices) {
72     for (auto const& my_dst : vertices) {
73       if (my_src == my_dst)
74         continue;
75
76       RouteCreationArgs* route = new RouteCreationArgs();
77
78       get_local_route(my_src, my_dst, route, nullptr);
79
80       XBT_DEBUG("get_route_and_latency %s -> %s", my_src->get_cname(), my_dst->get_cname());
81
82       xbt_node_t current;
83       xbt_node_t previous;
84       const char *previous_name;
85       const char *current_name;
86
87       if (route->gw_src) {
88         previous      = new_xbt_graph_node(graph, route->gw_src->get_cname(), nodes);
89         previous_name = route->gw_src->get_cname();
90       } else {
91         previous      = new_xbt_graph_node(graph, my_src->get_cname(), nodes);
92         previous_name = my_src->get_cname();
93       }
94
95       for (auto const& link : route->link_list) {
96         const char* link_name = link->get_cname();
97         current               = new_xbt_graph_node(graph, link_name, nodes);
98         current_name          = link_name;
99         new_xbt_graph_edge(graph, previous, current, edges);
100         XBT_DEBUG("  %s -> %s", previous_name, current_name);
101         previous      = current;
102         previous_name = current_name;
103       }
104
105       if (route->gw_dst) {
106         current      = new_xbt_graph_node(graph, route->gw_dst->get_cname(), nodes);
107         current_name = route->gw_dst->get_cname();
108       } else {
109         current      = new_xbt_graph_node(graph, my_dst->get_cname(), nodes);
110         current_name = my_dst->get_cname();
111       }
112       new_xbt_graph_edge(graph, previous, current, edges);
113       XBT_DEBUG("  %s -> %s", previous_name, current_name);
114
115       delete route;
116     }
117   }
118 }
119
120 /* ************************************************************************** */
121 /* ************************* GENERIC AUX FUNCTIONS ************************** */
122 /* change a route containing link names into a route containing link entities */
123 RouteCreationArgs* RoutedZone::new_extended_route(RoutingMode hierarchy, NetPoint* /* src */, NetPoint* /* dst */,
124                                                   NetPoint* gw_src, NetPoint* gw_dst,
125                                                   std::vector<resource::LinkImpl*>& link_list, bool /* symmetrical */,
126                                                   bool change_order)
127 {
128   RouteCreationArgs* result = new RouteCreationArgs();
129
130   xbt_assert(hierarchy == RoutingMode::base || hierarchy == RoutingMode::recursive,
131              "The hierarchy of this netzone is neither BASIC nor RECURSIVE, I'm lost here.");
132
133   if (hierarchy == RoutingMode::recursive) {
134     xbt_assert(gw_src && gw_dst, "nullptr is obviously a deficient gateway");
135
136     result->gw_src = gw_src;
137     result->gw_dst = gw_dst;
138   }
139
140   for (auto const& link : link_list) {
141     if (change_order)
142       result->link_list.push_back(link);
143     else
144       result->link_list.insert(result->link_list.begin(), link);
145   }
146   result->link_list.shrink_to_fit();
147
148   return result;
149 }
150
151 void RoutedZone::get_route_check_params(NetPoint* src, NetPoint* dst)
152 {
153   xbt_assert(src, "Cannot find a route from nullptr to %s", dst->get_cname());
154   xbt_assert(dst, "Cannot find a route from %s to nullptr", src->get_cname());
155
156   NetZoneImpl* src_as = src->get_englobing_zone();
157   NetZoneImpl* dst_as = dst->get_englobing_zone();
158
159   xbt_assert(src_as == dst_as,
160              "Internal error: %s@%s and %s@%s are not in the same netzone as expected. Please report that bug.",
161              src->get_cname(), src_as->get_cname(), dst->get_cname(), dst_as->get_cname());
162
163   xbt_assert(this == dst_as,
164              "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
165              "%s@%s). Please report that bug.",
166              src->get_cname(), dst->get_cname(), src_as->get_cname(), dst_as->get_cname(), get_cname());
167 }
168 void RoutedZone::add_route_check_params(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
169                                         std::vector<resource::LinkImpl*>& link_list, bool symmetrical)
170 {
171   const char* srcName = src->get_cname();
172   const char* dstName = dst->get_cname();
173
174   if (not gw_dst || not gw_src) {
175     XBT_DEBUG("Load Route from \"%s\" to \"%s\"", srcName, dstName);
176     xbt_assert(src, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, srcName);
177     xbt_assert(dst, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, dstName);
178     xbt_assert(not link_list.empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
179     xbt_assert(not src->is_netzone(),
180                "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have an NetzoneRoute?",
181                srcName);
182     xbt_assert(not dst->is_netzone(),
183                "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have an NetzoneRoute?",
184                dstName);
185   } else {
186     XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, gw_src->get_cname(), dstName, gw_dst->get_cname());
187     xbt_assert(src->is_netzone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
188     xbt_assert(dst->is_netzone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
189
190     xbt_assert(gw_src->is_host() || gw_src->is_router(),
191                "When defining a NetzoneRoute, gw_src must be a host or a router but '%s' is not.", srcName);
192     xbt_assert(gw_dst->is_host() || gw_dst->is_router(),
193                "When defining a NetzoneRoute, gw_dst must be a host or a router but '%s' is not.", dstName);
194
195     xbt_assert(gw_src != gw_dst, "Cannot define an NetzoneRoute from '%s' to itself", gw_src->get_cname());
196
197     xbt_assert(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
198                gw_dst->get_cname(), srcName);
199     xbt_assert(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
200                gw_dst->get_cname(), dstName);
201     xbt_assert(not link_list.empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName, gw_src->get_cname(),
202                dstName, gw_dst->get_cname());
203   }
204
205   s4u::NetZone::on_route_creation(symmetrical, src, dst, gw_src, gw_dst, link_list);
206 }
207 } // namespace routing
208 } // namespace kernel
209 } // namespace simgrid