Logo AND Algorithmique Numérique Distribuée

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