Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
3450eea05720b4bb963ac460aec11831c69a8f37
[simgrid.git] / src / surf / surf_routing_dijkstra.c
1 /* Copyright (c) 2009, 2010, 2011. 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 "surf_routing_private.h"
8
9 /* Global vars */
10 extern routing_global_t global_routing;
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
13
14 typedef struct {
15   s_as_t generic_routing;
16   xbt_graph_t route_graph;      /* xbt_graph */
17   xbt_dict_t graph_node_map;    /* map */
18   xbt_dict_t route_cache;       /* use in cache mode */
19   int cached;
20 } s_as_dijkstra_t, *as_dijkstra_t;
21
22
23 typedef struct graph_node_data {
24   int id;
25   int graph_id;                 /* used for caching internal graph id's */
26 } s_graph_node_data_t, *graph_node_data_t;
27
28 typedef struct graph_node_map_element {
29   xbt_node_t node;
30 } s_graph_node_map_element_t, *graph_node_map_element_t;
31
32 typedef struct route_cache_element {
33   int *pred_arr;
34   int size;
35 } s_route_cache_element_t, *route_cache_element_t;
36
37 /* Free functions */
38
39 static void route_cache_elem_free(void *e)
40 {
41   route_cache_element_t elm = (route_cache_element_t) e;
42   if (elm) {
43     xbt_free(elm->pred_arr);
44     xbt_free(elm);
45   }
46 }
47
48 static void graph_node_map_elem_free(void *e)
49 {
50   graph_node_map_element_t elm = (graph_node_map_element_t) e;
51   xbt_free(elm);
52 }
53
54 static void graph_edge_data_free(void *e) // FIXME: useless code dupplication
55 {
56   route_t e_route = (route_t) e;
57   if (e_route) {
58     xbt_dynar_free(&(e_route->link_list));
59     xbt_free(e_route->src_gateway);
60     xbt_free(e_route->dst_gateway);
61     xbt_free(e_route);
62   }
63 }
64
65 /* Utility functions */
66
67 static xbt_node_t route_graph_new_node(as_dijkstra_t as,
68                                        int id, int graph_id)
69 {
70   xbt_node_t node = NULL;
71   graph_node_data_t data = NULL;
72   graph_node_map_element_t elm = NULL;
73
74   data = xbt_new0(struct graph_node_data, 1);
75   data->id = id;
76   data->graph_id = graph_id;
77   node = xbt_graph_new_node(as->route_graph, data);
78
79   elm = xbt_new0(struct graph_node_map_element, 1);
80   elm->node = node;
81   xbt_dict_set_ext(as->graph_node_map, (char *) (&id), sizeof(int),
82                    (xbt_set_elm_t) elm, NULL);
83
84   return node;
85 }
86
87 static graph_node_map_element_t
88 graph_node_map_search(as_dijkstra_t as, int id)
89 {
90   graph_node_map_element_t elm = (graph_node_map_element_t)
91       xbt_dict_get_or_null_ext(as->graph_node_map,
92                                (char *) (&id),
93                                sizeof(int));
94   return elm;
95 }
96
97 /* Parsing */
98
99 static void route_new_dijkstra(as_dijkstra_t as, int src_id,
100                                int dst_id, route_t e_route)
101 {
102   XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
103   xbt_node_t src = NULL;
104   xbt_node_t dst = NULL;
105
106   graph_node_map_element_t src_elm = (graph_node_map_element_t)
107       xbt_dict_get_or_null_ext(as->graph_node_map,
108                                (char *) (&src_id),
109                                sizeof(int));
110   graph_node_map_element_t dst_elm = (graph_node_map_element_t)
111       xbt_dict_get_or_null_ext(as->graph_node_map,
112                                (char *) (&dst_id),
113                                sizeof(int));
114
115
116   if (src_elm)
117     src = src_elm->node;
118
119   if (dst_elm)
120     dst = dst_elm->node;
121
122   /* add nodes if they don't exist in the graph */
123   if (src_id == dst_id && src == NULL && dst == NULL) {
124     src = route_graph_new_node(as, src_id, -1);
125     dst = src;
126   } else {
127     if (src == NULL) {
128       src = route_graph_new_node(as, src_id, -1);
129     }
130     if (dst == NULL) {
131       dst = route_graph_new_node(as, dst_id, -1);
132     }
133   }
134
135   /* add link as edge to graph */
136   xbt_graph_new_edge(as->route_graph, src, dst, e_route);
137 }
138
139 static void add_loopback_dijkstra(as_dijkstra_t as) {
140   xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
141
142   xbt_node_t node = NULL;
143   unsigned int cursor2;
144   xbt_dynar_foreach(nodes, cursor2, node) {
145     xbt_dynar_t out_edges = xbt_graph_node_get_outedges(node);
146     xbt_edge_t edge = NULL;
147     unsigned int cursor;
148
149     int found = 0;
150     xbt_dynar_foreach(out_edges, cursor, edge) {
151       xbt_node_t other_node = xbt_graph_edge_get_target(edge);
152       if (other_node == node) {
153         found = 1;
154         break;
155       }
156     }
157
158     if (!found) {
159       route_t e_route = xbt_new0(s_route_t, 1);
160       e_route->link_list = xbt_dynar_new(global_routing->size_of_link, NULL);
161       xbt_dynar_push(e_route->link_list,
162                      &global_routing->loopback);
163       xbt_graph_new_edge(as->route_graph, node, node, e_route);
164     }
165   }
166 }
167
168 static void dijkstra_get_route_and_latency(AS_t as_generic,
169         const char *src, const char *dst, route_t route, double *lat);
170
171 static xbt_dynar_t dijkstra_get_onelink_routes(AS_t as)
172 {
173           xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
174
175           //size_t table_size = xbt_dict_length(routing->generic_routing.to_index);
176           xbt_dict_cursor_t c1 = NULL, c2 = NULL;
177           char *k1, *d1, *k2, *d2;
178           xbt_dict_foreach(as->to_index, c1, k1, d1) {
179             xbt_dict_foreach(as->to_index, c2, k2, d2) {
180               route_t route = xbt_new0(s_route_t,1);
181               route->link_list = xbt_dynar_new(global_routing->size_of_link,NULL);
182               dijkstra_get_route_and_latency(as, k1, k2,route, NULL);
183
184               if (xbt_dynar_length(route->link_list) == 1) {
185                 void *link =
186                     *(void **) xbt_dynar_get_ptr(route->link_list, 0);
187                 onelink_t onelink = xbt_new0(s_onelink_t, 1);
188                 onelink->link_ptr = link;
189                 if (as->hierarchy == SURF_ROUTING_BASE) {
190                   onelink->src = xbt_strdup(k1);
191                   onelink->dst = xbt_strdup(k2);
192                 } else if (as->hierarchy ==
193                     SURF_ROUTING_RECURSIVE) {
194                   onelink->src = xbt_strdup(route->src_gateway);
195                   onelink->dst = xbt_strdup(route->dst_gateway);
196                 }
197                 xbt_dynar_push(ret, &onelink);
198               }
199             }
200           }
201           return ret;
202 }
203
204 static void dijkstra_get_route_and_latency(AS_t asg,
205                                const char *src, const char *dst,
206                                route_t route, double *lat)
207 {
208
209   /* set utils vars */
210   as_dijkstra_t as = (as_dijkstra_t) asg;
211
212   generic_src_dst_check(asg, src, dst);
213   int *src_id = xbt_dict_get_or_null(asg->to_index, src);
214   int *dst_id = xbt_dict_get_or_null(asg->to_index, dst);
215   if (!src_id || !dst_id)
216     THROWF(arg_error,0,"No route from '%s' to '%s'",src,dst);
217
218   int *pred_arr = NULL;
219   int src_node_id = 0;
220   int dst_node_id = 0;
221   int *nodeid = NULL;
222   int v;
223   route_t e_route;
224   int size = 0;
225   unsigned int cpt;
226   void *link;
227   xbt_dynar_t links = NULL;
228   route_cache_element_t elm = NULL;
229   xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
230
231   /* Use the graph_node id mapping set to quickly find the nodes */
232   graph_node_map_element_t src_elm =
233       graph_node_map_search(as, *src_id);
234   graph_node_map_element_t dst_elm =
235       graph_node_map_search(as, *dst_id);
236
237   src_node_id = ((graph_node_data_t)
238                  xbt_graph_node_get_data(src_elm->node))->graph_id;
239   dst_node_id = ((graph_node_data_t)
240                  xbt_graph_node_get_data(dst_elm->node))->graph_id;
241
242   /* if the src and dst are the same */
243   if (src_node_id == dst_node_id) {
244
245     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
246     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
247     xbt_edge_t edge =
248         xbt_graph_get_edge(as->route_graph, node_s_v, node_e_v);
249
250     if (edge == NULL)
251       THROWF(arg_error,0,"No route from '%s' to '%s'",src,dst);
252
253     e_route = (route_t) xbt_graph_edge_get_data(edge);
254
255     links = e_route->link_list;
256     xbt_dynar_foreach(links, cpt, link) {
257       xbt_dynar_unshift(route->link_list, &link);
258       if (lat)
259         *lat += surf_network_model->extension.network.get_link_latency(link);
260     }
261
262   }
263
264   if (as->cached) {
265     /*check if there is a cached predecessor list avail */
266     elm = (route_cache_element_t)
267         xbt_dict_get_or_null_ext(as->route_cache, (char *) (&src_id),
268                                  sizeof(int));
269   }
270
271   if (elm) {                    /* cached mode and cache hit */
272     pred_arr = elm->pred_arr;
273   } else {                      /* not cached mode or cache miss */
274     double *cost_arr = NULL;
275     xbt_heap_t pqueue = NULL;
276     int i = 0;
277
278     int nr_nodes = xbt_dynar_length(nodes);
279     cost_arr = xbt_new0(double, nr_nodes);      /* link cost from src to other hosts */
280     pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
281     pqueue = xbt_heap_new(nr_nodes, xbt_free);
282
283     /* initialize */
284     cost_arr[src_node_id] = 0.0;
285
286     for (i = 0; i < nr_nodes; i++) {
287       if (i != src_node_id) {
288         cost_arr[i] = DBL_MAX;
289       }
290
291       pred_arr[i] = 0;
292
293       /* initialize priority queue */
294       nodeid = xbt_new0(int, 1);
295       *nodeid = i;
296       xbt_heap_push(pqueue, nodeid, cost_arr[i]);
297
298     }
299
300     /* apply dijkstra using the indexes from the graph's node array */
301     while (xbt_heap_size(pqueue) > 0) {
302       int *v_id = xbt_heap_pop(pqueue);
303       xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
304       xbt_dynar_t out_edges = xbt_graph_node_get_outedges(v_node);
305       xbt_edge_t edge = NULL;
306       unsigned int cursor;
307
308       xbt_dynar_foreach(out_edges, cursor, edge) {
309         xbt_node_t u_node = xbt_graph_edge_get_target(edge);
310         graph_node_data_t data = xbt_graph_node_get_data(u_node);
311         int u_id = data->graph_id;
312         route_t tmp_e_route = (route_t) xbt_graph_edge_get_data(edge);
313         int cost_v_u = (tmp_e_route->link_list)->used;    /* count of links, old model assume 1 */
314
315         if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
316           pred_arr[u_id] = *v_id;
317           cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
318           nodeid = xbt_new0(int, 1);
319           *nodeid = u_id;
320           xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
321         }
322       }
323
324       /* free item popped from pqueue */
325       xbt_free(v_id);
326     }
327
328     xbt_free(cost_arr);
329     xbt_heap_free(pqueue);
330   }
331
332   /* compose route path with links */
333   char *gw_src = NULL, *gw_dst = NULL, *prev_gw_src, *first_gw = NULL;
334
335   for (v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
336     xbt_node_t node_pred_v =
337         xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
338     xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
339     xbt_edge_t edge =
340         xbt_graph_get_edge(as->route_graph, node_pred_v, node_v);
341
342     if (edge == NULL)
343       THROWF(arg_error,0,"No route from '%s' to '%s'",src,dst);
344
345     prev_gw_src = gw_src;
346
347     e_route = (route_t) xbt_graph_edge_get_data(edge);
348     gw_src = e_route->src_gateway;
349     gw_dst = e_route->dst_gateway;
350
351     if (v == dst_node_id)
352       first_gw = gw_dst;
353
354     if (asg->hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
355         && strcmp(gw_dst, prev_gw_src)) {
356       xbt_dynar_t e_route_as_to_as=NULL;
357       routing_get_route_and_latency(gw_dst, prev_gw_src,&e_route_as_to_as,NULL);
358       if (edge == NULL)
359         THROWF(arg_error,0,"No route from '%s' to '%s'",src,dst);
360       links = e_route_as_to_as;
361       int pos = 0;
362       xbt_dynar_foreach(links, cpt, link) {
363         xbt_dynar_insert_at(route->link_list, pos, &link);
364         if (lat)
365           *lat += surf_network_model->extension.network.get_link_latency(link);
366         pos++;
367       }
368     }
369
370     links = e_route->link_list;
371     xbt_dynar_foreach(links, cpt, link) {
372       xbt_dynar_unshift(route->link_list, &link);
373       if (lat)
374         *lat += surf_network_model->extension.network.get_link_latency(link);
375     }
376     size++;
377   }
378
379   if (asg->hierarchy == SURF_ROUTING_RECURSIVE) {
380     route->src_gateway = xbt_strdup(gw_src);
381     route->dst_gateway = xbt_strdup(first_gw);
382   }
383
384   if (as->cached && elm == NULL) {
385     /* add to predecessor list of the current src-host to cache */
386     elm = xbt_new0(struct route_cache_element, 1);
387     elm->pred_arr = pred_arr;
388     elm->size = size;
389     xbt_dict_set_ext(as->route_cache, (char *) (&src_id), sizeof(int),
390                      (xbt_set_elm_t) elm, NULL);
391   }
392
393   if (!as->cached)
394     xbt_free(pred_arr);
395 }
396
397 static void dijkstra_finalize(AS_t asg)
398 {
399   as_dijkstra_t as = (as_dijkstra_t) asg;
400
401   xbt_graph_free_graph(as->route_graph, &xbt_free,
402       &graph_edge_data_free, &xbt_free);
403   xbt_dict_free(&as->graph_node_map);
404   if (as->cached)
405     xbt_dict_free(&as->route_cache);
406
407   model_generic_finalize(asg);
408 }
409
410 /* Creation routing model functions */
411
412 AS_t model_dijkstra_both_create(int cached)
413 {
414   as_dijkstra_t new_component = (as_dijkstra_t)
415       model_generic_create_sized(sizeof(s_as_dijkstra_t));
416
417   new_component->generic_routing.parse_route = model_dijkstra_both_parse_route;
418   new_component->generic_routing.parse_ASroute = model_dijkstra_both_parse_route;
419   new_component->generic_routing.get_route_and_latency = dijkstra_get_route_and_latency;
420   new_component->generic_routing.get_onelink_routes =
421       dijkstra_get_onelink_routes;
422   new_component->generic_routing.finalize = dijkstra_finalize;
423   new_component->cached = cached;
424
425   return (AS_t)new_component;
426 }
427
428 AS_t model_dijkstra_create(void)
429 {
430   return model_dijkstra_both_create(0);
431 }
432
433 AS_t model_dijkstracache_create(void)
434 {
435   return model_dijkstra_both_create(1);
436 }
437
438 void model_dijkstra_both_end(AS_t as)
439 {
440   as_dijkstra_t THIS = (as_dijkstra_t) as;
441
442   xbt_node_t node = NULL;
443   unsigned int cursor2;
444   xbt_dynar_t nodes = NULL;
445
446   /* Create the topology graph */
447   if(!THIS->route_graph)
448   THIS->route_graph = xbt_graph_new_graph(1, NULL);
449   if(!THIS->graph_node_map)
450   THIS->graph_node_map = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
451
452   if (THIS->cached && !THIS->route_cache)
453   THIS->route_cache = xbt_dict_new_homogeneous(&route_cache_elem_free);
454
455   /* Add the loopback if needed */
456   if (as->hierarchy == SURF_ROUTING_BASE)
457     add_loopback_dijkstra(THIS);
458
459   /* initialize graph indexes in nodes after graph has been built */
460   nodes = xbt_graph_get_nodes(THIS->route_graph);
461
462   xbt_dynar_foreach(nodes, cursor2, node) {
463     graph_node_data_t data = xbt_graph_node_get_data(node);
464     data->graph_id = cursor2;
465   }
466
467 }
468 void model_dijkstra_both_parse_route (AS_t asg, const char *src,
469                      const char *dst, route_t route)
470 {
471         as_dijkstra_t as = (as_dijkstra_t) asg;
472         int *src_id, *dst_id;
473         src_id = xbt_dict_get_or_null(asg->to_index, src);
474         dst_id = xbt_dict_get_or_null(asg->to_index, dst);
475
476         xbt_assert(src_id, "Network elements %s not found", src);
477         xbt_assert(dst_id, "Network elements %s not found", dst);
478
479     /* Create the topology graph */
480         if(!as->route_graph)
481         as->route_graph = xbt_graph_new_graph(1, NULL);
482         if(!as->graph_node_map)
483         as->graph_node_map = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
484
485         if (as->cached && !as->route_cache)
486         as->route_cache = xbt_dict_new_homogeneous(&route_cache_elem_free);
487
488         if( A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES
489                 || A_surfxml_ASroute_symmetrical == A_surfxml_ASroute_symmetrical_YES )
490                 xbt_die("Route symmetrical not supported on model dijkstra");
491
492         if(!route->dst_gateway && !route->src_gateway)
493           XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
494         else{
495           XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
496                          route->src_gateway, dst, route->dst_gateway);
497           if(routing_get_network_element_type((const char*)route->dst_gateway) == SURF_NETWORK_ELEMENT_NULL)
498                   xbt_die("The dst_gateway '%s' does not exist!",route->dst_gateway);
499           if(routing_get_network_element_type((const char*)route->src_gateway) == SURF_NETWORK_ELEMENT_NULL)
500                   xbt_die("The src_gateway '%s' does not exist!",route->src_gateway);
501         }
502
503         route_t e_route = generic_new_extended_route(asg->hierarchy, route, 1);
504         route_new_dijkstra(as, *src_id, *dst_id, e_route);
505 }