Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
refactor AsImpl::RoutingMode after mc::ReductionMode
[simgrid.git] / src / surf / surf_routing_dijkstra.cpp
1 /* Copyright (c) 2009-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include "src/surf/surf_routing_dijkstra.hpp"
8 #include "src/surf/network_interface.hpp"
9
10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
11
12 /* Free functions */
13
14 static void route_cache_elem_free(void *e)
15 {
16   route_cache_element_t elm = (route_cache_element_t) e;
17   if (elm) {
18     xbt_free(elm->pred_arr);
19     xbt_free(elm);
20   }
21 }
22
23 static void graph_node_map_elem_free(void *e)
24 {
25   graph_node_map_element_t elm = (graph_node_map_element_t) e;
26   xbt_free(elm);
27 }
28
29 static void graph_edge_data_free(void *e) // FIXME: useless code duplication
30 {
31   sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t) e;
32   if (e_route) {
33     delete e_route->link_list;
34     xbt_free(e_route);
35   }
36 }
37
38 /* Utility functions */
39
40 namespace simgrid {
41 namespace surf {
42 void AsDijkstra::Seal()
43 {
44   xbt_node_t node = NULL;
45   unsigned int cursor2, cursor;
46
47   /* Create the topology graph */
48   if(!routeGraph_)
49     routeGraph_ = xbt_graph_new_graph(1, NULL);
50   if(!graphNodeMap_)
51     graphNodeMap_ = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
52
53   /* Add the loopback if needed */
54   if (routing_platf->loopback_ && hierarchy_ == RoutingMode::base) {
55     xbt_dynar_foreach(xbt_graph_get_nodes(routeGraph_), cursor, node) {
56       xbt_edge_t edge = NULL;
57
58       bool found = false;
59       xbt_dynar_foreach(xbt_graph_node_get_outedges(node), cursor2, edge) {
60         if (xbt_graph_edge_get_target(edge) == node) {
61           found = true;
62           break;
63         }
64       }
65
66       if (!found) {
67         sg_platf_route_cbarg_t e_route = xbt_new0(s_sg_platf_route_cbarg_t, 1);
68         e_route->link_list = new std::vector<Link*>();
69         e_route->link_list->push_back(routing_platf->loopback_);
70         xbt_graph_new_edge(routeGraph_, node, node, e_route);
71       }
72     }
73   }
74
75   /* initialize graph indexes in nodes after graph has been built */
76   xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
77
78   xbt_dynar_foreach(nodes, cursor, node) {
79     graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(node);
80     data->graph_id = cursor;
81   }
82 }
83
84 xbt_node_t AsDijkstra::routeGraphNewNode(int id, int graph_id)
85 {
86   xbt_node_t node = NULL;
87   graph_node_data_t data = NULL;
88   graph_node_map_element_t elm = NULL;
89
90   data = xbt_new0(struct graph_node_data, 1);
91   data->id = id;
92   data->graph_id = graph_id;
93   node = xbt_graph_new_node(routeGraph_, data);
94
95   elm = xbt_new0(struct graph_node_map_element, 1);
96   elm->node = node;
97   xbt_dict_set_ext(graphNodeMap_, (char *) (&id), sizeof(int), (xbt_dictelm_t) elm, NULL);
98
99   return node;
100 }
101
102 graph_node_map_element_t AsDijkstra::nodeMapSearch(int id)
103 {
104   return (graph_node_map_element_t)xbt_dict_get_or_null_ext(graphNodeMap_, (char *) (&id), sizeof(int));
105 }
106
107 /* Parsing */
108
109 void AsDijkstra::newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route)
110 {
111   XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
112   xbt_node_t src = NULL;
113   xbt_node_t dst = NULL;
114
115   graph_node_map_element_t src_elm = nodeMapSearch(src_id);
116   graph_node_map_element_t dst_elm = nodeMapSearch(dst_id);
117
118   if (src_elm)
119     src = src_elm->node;
120
121   if (dst_elm)
122     dst = dst_elm->node;
123
124   /* add nodes if they don't exist in the graph */
125   if (src_id == dst_id && src == NULL && dst == NULL) {
126     src = this->routeGraphNewNode(src_id, -1);
127     dst = src;
128   } else {
129     if (src == NULL) {
130       src = this->routeGraphNewNode(src_id, -1);
131     }
132     if (dst == NULL) {
133       dst = this->routeGraphNewNode(dst_id, -1);
134     }
135   }
136
137   /* add link as edge to graph */
138   xbt_graph_new_edge(routeGraph_, src, dst, e_route);
139 }
140
141 void AsDijkstra::getRouteAndLatency(NetCard *src, NetCard *dst, sg_platf_route_cbarg_t route, double *lat)
142 {
143   getRouteCheckParams(src, dst);
144   int src_id = src->id();
145   int dst_id = dst->id();
146
147   int *pred_arr = NULL;
148   sg_platf_route_cbarg_t e_route;
149   int size = 0;
150   xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
151
152   /* Use the graph_node id mapping set to quickly find the nodes */
153   graph_node_map_element_t src_elm = nodeMapSearch(src_id);
154   graph_node_map_element_t dst_elm = nodeMapSearch(dst_id);
155
156   int src_node_id = ((graph_node_data_t) xbt_graph_node_get_data(src_elm->node))->graph_id;
157   int dst_node_id = ((graph_node_data_t) xbt_graph_node_get_data(dst_elm->node))->graph_id;
158
159   /* if the src and dst are the same */
160   if (src_node_id == dst_node_id) {
161
162     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
163     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
164     xbt_edge_t edge = xbt_graph_get_edge(routeGraph_, node_s_v, node_e_v);
165
166     if (edge == NULL)
167       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->name(), dst->name());
168
169     e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
170
171     for (auto link: *e_route->link_list) {
172       route->link_list->insert(route->link_list->begin(), link);
173       if (lat)
174         *lat += static_cast<Link*>(link)->getLatency();
175     }
176
177   }
178
179   route_cache_element_t elm = NULL;
180   if (routeCache_) {  /* cache mode  */
181     elm = (route_cache_element_t) xbt_dict_get_or_null_ext(routeCache_, (char *) (&src_id), sizeof(int));
182   }
183
184   if (elm) {                    /* cached mode and cache hit */
185     pred_arr = elm->pred_arr;
186   } else {                      /* not cached mode, or cache miss */
187
188     int nr_nodes = xbt_dynar_length(nodes);
189     double * cost_arr = xbt_new0(double, nr_nodes);      /* link cost from src to other hosts */
190     pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
191     xbt_heap_t pqueue = xbt_heap_new(nr_nodes, xbt_free_f);
192
193     /* initialize */
194     cost_arr[src_node_id] = 0.0;
195
196     for (int i = 0; i < nr_nodes; i++) {
197       if (i != src_node_id) {
198         cost_arr[i] = DBL_MAX;
199       }
200
201       pred_arr[i] = 0;
202
203       /* initialize priority queue */
204       int *nodeid = xbt_new0(int, 1);
205       *nodeid = i;
206       xbt_heap_push(pqueue, nodeid, cost_arr[i]);
207
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 = NULL;
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   NetCard *gw_src = NULL, *gw_dst, *prev_gw_src, *first_gw = NULL;
243   NetCard *gw_dst_net_elm = NULL, *prev_gw_src_net_elm = NULL;
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 == NULL)
251       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->name(), dst->name());
252
253     prev_gw_src = gw_src;
254
255     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 && strcmp(gw_dst->name(), prev_gw_src->name())) {
263       std::vector<Link*> *e_route_as_to_as = new std::vector<Link*>();
264
265       routing_platf->getRouteAndLatency(gw_dst_net_elm, prev_gw_src_net_elm, e_route_as_to_as, NULL);
266       auto pos = route->link_list->begin();
267       for (auto link : *e_route_as_to_as) {
268         route->link_list->insert(pos, link);
269         if (lat)
270           *lat += link->getLatency();
271         pos++;
272       }
273     }
274
275     for (auto link: *e_route->link_list) {
276       route->link_list->insert(route->link_list->begin(), link);
277       if (lat)
278         *lat += static_cast<Link*>(link)->getLatency();
279     }
280     size++;
281   }
282
283   if (hierarchy_ == RoutingMode::recursive) {
284     route->gw_src = gw_src;
285     route->gw_dst = first_gw;
286   }
287
288   if (routeCache_ && elm == NULL) {
289     /* add to predecessor list of the current src-host to cache */
290     elm = xbt_new0(struct route_cache_element, 1);
291     elm->pred_arr = pred_arr;
292     elm->size = size;
293     xbt_dict_set_ext(routeCache_, (char *) (&src_id), sizeof(int), (xbt_dictelm_t) elm, NULL);
294   }
295
296   if (!routeCache_)
297     xbt_free(pred_arr);
298 }
299
300 AsDijkstra::~AsDijkstra()
301 {
302   xbt_graph_free_graph(routeGraph_, &xbt_free_f,  &graph_edge_data_free, &xbt_free_f);
303   xbt_dict_free(&graphNodeMap_);
304   xbt_dict_free(&routeCache_);
305 }
306
307 /* Creation routing model functions */
308
309 AsDijkstra::AsDijkstra(const char*name, bool cached)
310   : AsRoutedGraph(name)
311 {
312   if (cached)
313     routeCache_ = xbt_dict_new_homogeneous(&route_cache_elem_free);
314 }
315
316 void AsDijkstra::addRoute(sg_platf_route_cbarg_t route)
317 {
318   const char *srcName = route->src;
319   const char *dstName = route->dst;
320   NetCard *src = sg_netcard_by_name_or_null(srcName);
321   NetCard *dst = sg_netcard_by_name_or_null(dstName);
322
323   addRouteCheckParams(route);
324
325   /* Create the topology graph */
326   if(!routeGraph_)
327     routeGraph_ = xbt_graph_new_graph(1, NULL);
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 nodes */
332
333   /* Add the route to the base */
334   sg_platf_route_cbarg_t e_route = newExtendedRoute(hierarchy_, route, 1);
335   newRoute(src->id(), dst->id(), e_route);
336
337   // Symmetrical YES
338   if (route->symmetrical == TRUE) {
339     if(!route->gw_dst && !route->gw_src)
340       XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dstName, srcName);
341     else
342       XBT_DEBUG("Load ASroute from %s@%s to %s@%s", dstName, route->gw_dst->name(), srcName, route->gw_src->name());
343
344     xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
345     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src->id(), xbt_node_t);
346     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst->id(), xbt_node_t);
347     xbt_edge_t edge = xbt_graph_get_edge(routeGraph_, node_e_v, node_s_v);
348
349     if (edge)
350       THROWF(arg_error,0, "Route from %s@%s to %s@%s already exists", dstName, route->gw_dst->name(), srcName, route->gw_src->name());
351
352     if (route->gw_dst && route->gw_src) {
353       NetCard *gw_tmp = route->gw_src;
354       route->gw_src = route->gw_dst;
355       route->gw_dst = gw_tmp;
356     }
357     sg_platf_route_cbarg_t link_route_back = newExtendedRoute(hierarchy_, route, 0);
358     newRoute(dst->id(), src->id(), link_route_back);
359   }
360   delete route->link_list;
361 }
362
363 }
364 }