Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
b3766019239aaf90cdc696eb27a82b0612354410
[simgrid.git] / src / kernel / routing / DijkstraZone.cpp
1 /* Copyright (c) 2009-2016. 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 "src/kernel/routing/DijkstraZone.hpp"
7 #include "src/kernel/routing/NetPoint.hpp"
8 #include "src/surf/network_interface.hpp"
9
10 #include <float.h>
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
13
14 /* Free functions */
15
16 static void route_cache_elem_free(void* e)
17 {
18   route_cache_element_t elm = (route_cache_element_t)e;
19   if (elm) {
20     xbt_free(elm->pred_arr);
21     xbt_free(elm);
22   }
23 }
24
25 static void graph_node_map_elem_free(void* e)
26 {
27   graph_node_map_element_t elm = (graph_node_map_element_t)e;
28   xbt_free(elm);
29 }
30
31 static void graph_edge_data_free(void* e) // FIXME: useless code duplication
32 {
33   sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t)e;
34   if (e_route) {
35     delete e_route->link_list;
36     xbt_free(e_route);
37   }
38 }
39
40 /* Utility functions */
41
42 namespace simgrid {
43 namespace kernel {
44 namespace routing {
45 void DijkstraZone::seal()
46 {
47   xbt_node_t node = nullptr;
48   unsigned int cursor2, cursor;
49
50   /* Create the topology graph */
51   if (!routeGraph_)
52     routeGraph_ = xbt_graph_new_graph(1, nullptr);
53   if (!graphNodeMap_)
54     graphNodeMap_ = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
55
56   /* Add the loopback if needed */
57   if (surf_network_model->loopback_ && hierarchy_ == RoutingMode::base) {
58     xbt_dynar_foreach (xbt_graph_get_nodes(routeGraph_), cursor, node) {
59       xbt_edge_t edge = nullptr;
60
61       bool found = false;
62       xbt_dynar_foreach (xbt_graph_node_get_outedges(node), cursor2, edge) {
63         if (xbt_graph_edge_get_target(edge) == node) {
64           found = true;
65           break;
66         }
67       }
68
69       if (!found) {
70         sg_platf_route_cbarg_t e_route = xbt_new0(s_sg_platf_route_cbarg_t, 1);
71         e_route->link_list             = new std::vector<surf::LinkImpl*>();
72         e_route->link_list->push_back(surf_network_model->loopback_);
73         xbt_graph_new_edge(routeGraph_, node, node, e_route);
74       }
75     }
76   }
77
78   /* initialize graph indexes in nodes after graph has been built */
79   xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
80
81   xbt_dynar_foreach (nodes, cursor, node) {
82     graph_node_data_t data = (graph_node_data_t)xbt_graph_node_get_data(node);
83     data->graph_id         = cursor;
84   }
85 }
86
87 xbt_node_t DijkstraZone::routeGraphNewNode(int id, int graph_id)
88 {
89   xbt_node_t node              = nullptr;
90   graph_node_data_t data       = nullptr;
91   graph_node_map_element_t elm = nullptr;
92
93   data           = xbt_new0(struct graph_node_data, 1);
94   data->id       = id;
95   data->graph_id = graph_id;
96   node           = xbt_graph_new_node(routeGraph_, data);
97
98   elm       = xbt_new0(struct graph_node_map_element, 1);
99   elm->node = node;
100   xbt_dict_set_ext(graphNodeMap_, (char*)(&id), sizeof(int), (xbt_dictelm_t)elm, nullptr);
101
102   return node;
103 }
104
105 graph_node_map_element_t DijkstraZone::nodeMapSearch(int id)
106 {
107   return (graph_node_map_element_t)xbt_dict_get_or_null_ext(graphNodeMap_, (char*)(&id), sizeof(int));
108 }
109
110 /* Parsing */
111
112 void DijkstraZone::newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route)
113 {
114   XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
115   xbt_node_t src = nullptr;
116   xbt_node_t dst = nullptr;
117
118   graph_node_map_element_t src_elm = nodeMapSearch(src_id);
119   graph_node_map_element_t dst_elm = nodeMapSearch(dst_id);
120
121   if (src_elm)
122     src = src_elm->node;
123
124   if (dst_elm)
125     dst = dst_elm->node;
126
127   /* add nodes if they don't exist in the graph */
128   if (src_id == dst_id && src == nullptr && dst == nullptr) {
129     src = this->routeGraphNewNode(src_id, -1);
130     dst = src;
131   } else {
132     if (src == nullptr) {
133       src = this->routeGraphNewNode(src_id, -1);
134     }
135     if (dst == nullptr) {
136       dst = this->routeGraphNewNode(dst_id, -1);
137     }
138   }
139
140   /* add link as edge to graph */
141   xbt_graph_new_edge(routeGraph_, src, dst, e_route);
142 }
143
144 void DijkstraZone::getLocalRoute(NetPoint* src, NetPoint* dst, sg_platf_route_cbarg_t route, double* lat)
145 {
146   getRouteCheckParams(src, dst);
147   int src_id = src->id();
148   int dst_id = dst->id();
149
150   int* pred_arr     = nullptr;
151   int size          = 0;
152   xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
153
154   /* Use the graph_node id mapping set to quickly find the nodes */
155   graph_node_map_element_t src_elm = nodeMapSearch(src_id);
156   graph_node_map_element_t dst_elm = nodeMapSearch(dst_id);
157
158   int src_node_id = ((graph_node_data_t)xbt_graph_node_get_data(src_elm->node))->graph_id;
159   int dst_node_id = ((graph_node_data_t)xbt_graph_node_get_data(dst_elm->node))->graph_id;
160
161   /* if the src and dst are the same */
162   if (src_node_id == dst_node_id) {
163
164     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
165     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
166     xbt_edge_t edge     = xbt_graph_get_edge(routeGraph_, node_s_v, node_e_v);
167
168     if (edge == nullptr)
169       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->name().c_str(), dst->name().c_str());
170
171     sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t)xbt_graph_edge_get_data(edge);
172
173     for (auto link : *e_route->link_list) {
174       route->link_list->insert(route->link_list->begin(), link);
175       if (lat)
176         *lat += static_cast<surf::LinkImpl*>(link)->latency();
177     }
178   }
179
180   route_cache_element_t elm = nullptr;
181   if (routeCache_) { /* cache mode  */
182     elm = (route_cache_element_t)xbt_dict_get_or_null_ext(routeCache_, (char*)(&src_id), sizeof(int));
183   }
184
185   if (elm) { /* cached mode and cache hit */
186     pred_arr = elm->pred_arr;
187   } else { /* not cached mode, or cache miss */
188
189     int nr_nodes      = xbt_dynar_length(nodes);
190     double* cost_arr  = xbt_new0(double, nr_nodes); /* link cost from src to other hosts */
191     pred_arr          = xbt_new0(int, nr_nodes);    /* predecessors in path from src */
192     xbt_heap_t pqueue = xbt_heap_new(nr_nodes, xbt_free_f);
193
194     /* initialize */
195     cost_arr[src_node_id] = 0.0;
196
197     for (int i = 0; i < nr_nodes; i++) {
198       if (i != src_node_id) {
199         cost_arr[i] = DBL_MAX;
200       }
201
202       pred_arr[i] = 0;
203
204       /* initialize priority queue */
205       int* nodeid = xbt_new0(int, 1);
206       *nodeid     = i;
207       xbt_heap_push(pqueue, nodeid, cost_arr[i]);
208     }
209
210     /* apply dijkstra using the indexes from the graph's node array */
211     while (xbt_heap_size(pqueue) > 0) {
212       int* v_id         = (int*)xbt_heap_pop(pqueue);
213       xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
214       xbt_edge_t edge   = nullptr;
215       unsigned int cursor;
216
217       xbt_dynar_foreach (xbt_graph_node_get_outedges(v_node), cursor, edge) {
218         xbt_node_t u_node                  = xbt_graph_edge_get_target(edge);
219         graph_node_data_t data             = (graph_node_data_t)xbt_graph_node_get_data(u_node);
220         int u_id                           = data->graph_id;
221         sg_platf_route_cbarg_t tmp_e_route = (sg_platf_route_cbarg_t)xbt_graph_edge_get_data(edge);
222         int cost_v_u                       = tmp_e_route->link_list->size(); /* count of links, old model assume 1 */
223
224         if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
225           pred_arr[u_id] = *v_id;
226           cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
227           int* nodeid    = xbt_new0(int, 1);
228           *nodeid        = u_id;
229           xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
230         }
231       }
232
233       /* free item popped from pqueue */
234       xbt_free(v_id);
235     }
236
237     xbt_free(cost_arr);
238     xbt_heap_free(pqueue);
239   }
240
241   /* compose route path with links */
242   NetPoint *gw_src = nullptr, *gw_dst, *prev_gw_src, *first_gw = nullptr;
243   NetPoint *gw_dst_net_elm = nullptr, *prev_gw_src_net_elm = nullptr;
244
245   for (int v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
246     xbt_node_t node_pred_v = xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
247     xbt_node_t node_v      = xbt_dynar_get_as(nodes, v, xbt_node_t);
248     xbt_edge_t edge        = xbt_graph_get_edge(routeGraph_, node_pred_v, node_v);
249
250     if (edge == nullptr)
251       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->name().c_str(), dst->name().c_str());
252
253     prev_gw_src = gw_src;
254
255     sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t)xbt_graph_edge_get_data(edge);
256     gw_src                         = e_route->gw_src;
257     gw_dst                         = e_route->gw_dst;
258
259     if (v == dst_node_id)
260       first_gw = gw_dst;
261
262     if (hierarchy_ == RoutingMode::recursive && v != dst_node_id &&
263         strcmp(gw_dst->name().c_str(), prev_gw_src->name().c_str())) {
264       std::vector<surf::LinkImpl*> e_route_as_to_as;
265
266       getGlobalRoute(gw_dst_net_elm, prev_gw_src_net_elm, &e_route_as_to_as, nullptr);
267       auto pos = route->link_list->begin();
268       for (auto link : e_route_as_to_as) {
269         route->link_list->insert(pos, link);
270         if (lat)
271           *lat += link->latency();
272         pos++;
273       }
274     }
275
276     for (auto link : *e_route->link_list) {
277       route->link_list->insert(route->link_list->begin(), link);
278       if (lat)
279         *lat += static_cast<surf::LinkImpl*>(link)->latency();
280     }
281     size++;
282   }
283
284   if (hierarchy_ == RoutingMode::recursive) {
285     route->gw_src = gw_src;
286     route->gw_dst = first_gw;
287   }
288
289   if (routeCache_ && elm == nullptr) {
290     /* add to predecessor list of the current src-host to cache */
291     elm           = xbt_new0(struct route_cache_element, 1);
292     elm->pred_arr = pred_arr;
293     elm->size     = size;
294     xbt_dict_set_ext(routeCache_, (char*)(&src_id), sizeof(int), (xbt_dictelm_t)elm, nullptr);
295   }
296
297   if (!routeCache_)
298     xbt_free(pred_arr);
299 }
300
301 DijkstraZone::~DijkstraZone()
302 {
303   xbt_graph_free_graph(routeGraph_, &xbt_free_f, &graph_edge_data_free, &xbt_free_f);
304   xbt_dict_free(&graphNodeMap_);
305   xbt_dict_free(&routeCache_);
306 }
307
308 /* Creation routing model functions */
309
310 DijkstraZone::DijkstraZone(NetZone* father, const char* name, bool cached) : RoutedZone(father, name)
311 {
312   if (cached)
313     routeCache_ = xbt_dict_new_homogeneous(&route_cache_elem_free);
314 }
315
316 void DijkstraZone::addRoute(sg_platf_route_cbarg_t route)
317 {
318   NetPoint* src       = route->src;
319   NetPoint* dst       = route->dst;
320   const char* srcName = src->name().c_str();
321   const char* dstName = dst->name().c_str();
322
323   addRouteCheckParams(route);
324
325   /* Create the topology graph */
326   if (!routeGraph_)
327     routeGraph_ = xbt_graph_new_graph(1, nullptr);
328   if (!graphNodeMap_)
329     graphNodeMap_ = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
330
331   /* we don't check whether the route already exist, because the algorithm may find another path through some other
332    * nodes */
333
334   /* Add the route to the base */
335   sg_platf_route_cbarg_t e_route = newExtendedRoute(hierarchy_, route, 1);
336   newRoute(src->id(), dst->id(), e_route);
337
338   // Symmetrical YES
339   if (route->symmetrical == true) {
340     if (!route->gw_dst && !route->gw_src)
341       XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dstName, srcName);
342     else
343       XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", dstName, route->gw_dst->name().c_str(), srcName,
344                 route->gw_src->name().c_str());
345
346     xbt_dynar_t nodes   = xbt_graph_get_nodes(routeGraph_);
347     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src->id(), xbt_node_t);
348     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst->id(), xbt_node_t);
349     xbt_edge_t edge     = xbt_graph_get_edge(routeGraph_, node_e_v, node_s_v);
350
351     if (edge)
352       THROWF(arg_error, 0, "Route from %s@%s to %s@%s already exists", dstName, route->gw_dst->name().c_str(), srcName,
353              route->gw_src->name().c_str());
354
355     if (route->gw_dst && route->gw_src) {
356       NetPoint* gw_tmp = route->gw_src;
357       route->gw_src   = route->gw_dst;
358       route->gw_dst   = gw_tmp;
359     }
360     sg_platf_route_cbarg_t link_route_back = newExtendedRoute(hierarchy_, route, 0);
361     newRoute(dst->id(), src->id(), link_route_back);
362   }
363 }
364 }
365 }
366 } // namespace