1 /* Copyright (c) 2009, 2010, 2011. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "surf_routing_private.h"
10 extern routing_global_t global_routing;
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
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 */
20 } s_as_dijkstra_t, *as_dijkstra_t;
23 typedef struct graph_node_data {
25 int graph_id; /* used for caching internal graph id's */
26 } s_graph_node_data_t, *graph_node_data_t;
28 typedef struct graph_node_map_element {
30 } s_graph_node_map_element_t, *graph_node_map_element_t;
32 typedef struct route_cache_element {
35 } s_route_cache_element_t, *route_cache_element_t;
39 static void route_cache_elem_free(void *e)
41 route_cache_element_t elm = (route_cache_element_t) e;
43 xbt_free(elm->pred_arr);
48 static void graph_node_map_elem_free(void *e)
50 graph_node_map_element_t elm = (graph_node_map_element_t) e;
54 static void graph_edge_data_free(void *e)
56 route_extended_t e_route = (route_extended_t) e;
58 xbt_dynar_free(&(e_route->generic_route.link_list));
59 xbt_free(e_route->src_gateway);
60 xbt_free(e_route->dst_gateway);
65 /* Utility functions */
67 static xbt_node_t route_graph_new_node(as_dijkstra_t as,
70 xbt_node_t node = NULL;
71 graph_node_data_t data = NULL;
72 graph_node_map_element_t elm = NULL;
74 data = xbt_new0(struct graph_node_data, 1);
76 data->graph_id = graph_id;
77 node = xbt_graph_new_node(as->route_graph, data);
79 elm = xbt_new0(struct graph_node_map_element, 1);
81 xbt_dict_set_ext(as->graph_node_map, (char *) (&id), sizeof(int),
82 (xbt_set_elm_t) elm, &graph_node_map_elem_free);
87 static graph_node_map_element_t
88 graph_node_map_search(as_dijkstra_t as, int id)
90 graph_node_map_element_t elm = (graph_node_map_element_t)
91 xbt_dict_get_or_null_ext(as->graph_node_map,
99 static void route_new_dijkstra(as_dijkstra_t as, int src_id,
100 int dst_id, route_extended_t e_route)
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;
106 graph_node_map_element_t src_elm = (graph_node_map_element_t)
107 xbt_dict_get_or_null_ext(as->graph_node_map,
110 graph_node_map_element_t dst_elm = (graph_node_map_element_t)
111 xbt_dict_get_or_null_ext(as->graph_node_map,
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);
128 src = route_graph_new_node(as, src_id, -1);
131 dst = route_graph_new_node(as, dst_id, -1);
135 /* add link as edge to graph */
136 xbt_graph_new_edge(as->route_graph, src, dst, e_route);
139 static void add_loopback_dijkstra(as_dijkstra_t as) {
140 xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
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;
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) {
159 route_extended_t e_route = xbt_new0(s_route_extended_t, 1);
160 e_route->src_gateway = NULL;
161 e_route->dst_gateway = NULL;
162 e_route->generic_route.link_list =
163 xbt_dynar_new(global_routing->size_of_link, NULL);
164 xbt_dynar_push(e_route->generic_route.link_list,
165 &global_routing->loopback);
166 xbt_graph_new_edge(as->route_graph, node, node, e_route);
171 static route_extended_t dijkstra_get_route(AS_t as_generic,
175 static xbt_dynar_t dijkstra_get_onelink_routes(AS_t as)
177 // xbt_die("\"dijkstra_get_onelink_routes\" function not implemented yet");
178 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
180 //size_t table_size = xbt_dict_length(routing->generic_routing.to_index);
181 xbt_dict_cursor_t c1 = NULL, c2 = NULL;
182 char *k1, *d1, *k2, *d2;
183 xbt_dict_foreach(as->to_index, c1, k1, d1) {
184 xbt_dict_foreach(as->to_index, c2, k2, d2) {
185 route_extended_t route = dijkstra_get_route(as, k1, k2);
187 if (xbt_dynar_length(route->generic_route.link_list) == 1) {
189 *(void **) xbt_dynar_get_ptr(route->generic_route.link_list,
191 onelink_t onelink = xbt_new0(s_onelink_t, 1);
192 onelink->link_ptr = link;
193 if (as->hierarchy == SURF_ROUTING_BASE) {
194 onelink->src = xbt_strdup(k1);
195 onelink->dst = xbt_strdup(k2);
196 } else if (as->hierarchy ==
197 SURF_ROUTING_RECURSIVE) {
198 onelink->src = xbt_strdup(route->src_gateway);
199 onelink->dst = xbt_strdup(route->dst_gateway);
201 xbt_dynar_push(ret, &onelink);
209 static route_extended_t dijkstra_get_route(AS_t asg,
213 xbt_assert(asg && src
215 "Invalid params for \"get_route\" function at AS \"%s\"",
219 as_dijkstra_t as = (as_dijkstra_t) asg;
221 generic_src_dst_check(asg, src, dst);
222 int *src_id = xbt_dict_get_or_null(asg->to_index, src);
223 int *dst_id = xbt_dict_get_or_null(asg->to_index, dst);
226 "Ask for route \"from\"(%s) or \"to\"(%s) no found in the local table",
229 /* create a result route */
230 route_extended_t new_e_route = xbt_new0(s_route_extended_t, 1);
231 new_e_route->generic_route.link_list =
232 xbt_dynar_new(global_routing->size_of_link, NULL);
233 new_e_route->src_gateway = NULL;
234 new_e_route->dst_gateway = NULL;
236 int *pred_arr = NULL;
241 route_extended_t e_route;
245 xbt_dynar_t links = NULL;
246 route_cache_element_t elm = NULL;
247 xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
249 /* Use the graph_node id mapping set to quickly find the nodes */
250 graph_node_map_element_t src_elm =
251 graph_node_map_search(as, *src_id);
252 graph_node_map_element_t dst_elm =
253 graph_node_map_search(as, *dst_id);
254 xbt_assert(src_elm != NULL
255 && dst_elm != NULL, "src %d or dst %d does not exist",
257 src_node_id = ((graph_node_data_t)
258 xbt_graph_node_get_data(src_elm->node))->graph_id;
259 dst_node_id = ((graph_node_data_t)
260 xbt_graph_node_get_data(dst_elm->node))->graph_id;
262 /* if the src and dst are the same *//* fixed, missing in the previous version */
263 if (src_node_id == dst_node_id) {
265 xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
266 xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
268 xbt_graph_get_edge(as->route_graph, node_s_v, node_e_v);
270 xbt_assert(edge != NULL, "no route between host %d and %d", *src_id,
273 e_route = (route_extended_t) xbt_graph_edge_get_data(edge);
275 links = e_route->generic_route.link_list;
276 xbt_dynar_foreach(links, cpt, link) {
277 xbt_dynar_unshift(new_e_route->generic_route.link_list, &link);
284 /*check if there is a cached predecessor list avail */
285 elm = (route_cache_element_t)
286 xbt_dict_get_or_null_ext(as->route_cache, (char *) (&src_id),
290 if (elm) { /* cached mode and cache hit */
291 pred_arr = elm->pred_arr;
292 } else { /* not cached mode or cache miss */
293 double *cost_arr = NULL;
294 xbt_heap_t pqueue = NULL;
297 int nr_nodes = xbt_dynar_length(nodes);
298 cost_arr = xbt_new0(double, nr_nodes); /* link cost from src to other hosts */
299 pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
300 pqueue = xbt_heap_new(nr_nodes, xbt_free);
303 cost_arr[src_node_id] = 0.0;
305 for (i = 0; i < nr_nodes; i++) {
306 if (i != src_node_id) {
307 cost_arr[i] = DBL_MAX;
312 /* initialize priority queue */
313 nodeid = xbt_new0(int, 1);
315 xbt_heap_push(pqueue, nodeid, cost_arr[i]);
319 /* apply dijkstra using the indexes from the graph's node array */
320 while (xbt_heap_size(pqueue) > 0) {
321 int *v_id = xbt_heap_pop(pqueue);
322 xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
323 xbt_dynar_t out_edges = xbt_graph_node_get_outedges(v_node);
324 xbt_edge_t edge = NULL;
327 xbt_dynar_foreach(out_edges, cursor, edge) {
328 xbt_node_t u_node = xbt_graph_edge_get_target(edge);
329 graph_node_data_t data = xbt_graph_node_get_data(u_node);
330 int u_id = data->graph_id;
331 route_extended_t tmp_e_route =
332 (route_extended_t) xbt_graph_edge_get_data(edge);
333 int cost_v_u = (tmp_e_route->generic_route.link_list)->used; /* count of links, old model assume 1 */
335 if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
336 pred_arr[u_id] = *v_id;
337 cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
338 nodeid = xbt_new0(int, 1);
340 xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
344 /* free item popped from pqueue */
349 xbt_heap_free(pqueue);
352 /* compose route path with links */
353 char *gw_src = NULL, *gw_dst = NULL, *prev_gw_src, *first_gw = NULL;
355 for (v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
356 xbt_node_t node_pred_v =
357 xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
358 xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
360 xbt_graph_get_edge(as->route_graph, node_pred_v, node_v);
362 xbt_assert(edge != NULL, "no route between host %d and %d", *src_id,
365 prev_gw_src = gw_src;
367 e_route = (route_extended_t) xbt_graph_edge_get_data(edge);
368 gw_src = e_route->src_gateway;
369 gw_dst = e_route->dst_gateway;
371 if (v == dst_node_id)
374 if (asg->hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
375 && strcmp(gw_dst, prev_gw_src)) {
376 xbt_dynar_t e_route_as_to_as =
377 routing_get_route(gw_dst, prev_gw_src);
378 xbt_assert(e_route_as_to_as, "no route between \"%s\" and \"%s\"",
379 gw_dst, prev_gw_src);
380 links = e_route_as_to_as;
382 xbt_dynar_foreach(links, cpt, link) {
383 xbt_dynar_insert_at(new_e_route->generic_route.link_list, pos,
389 links = e_route->generic_route.link_list;
390 xbt_dynar_foreach(links, cpt, link) {
391 xbt_dynar_unshift(new_e_route->generic_route.link_list, &link);
396 if (asg->hierarchy == SURF_ROUTING_RECURSIVE) {
397 new_e_route->src_gateway = xbt_strdup(gw_src);
398 new_e_route->dst_gateway = xbt_strdup(first_gw);
401 if (as->cached && elm == NULL) {
402 /* add to predecessor list of the current src-host to cache */
403 elm = xbt_new0(struct route_cache_element, 1);
404 elm->pred_arr = pred_arr;
406 xbt_dict_set_ext(as->route_cache, (char *) (&src_id), sizeof(int),
407 (xbt_set_elm_t) elm, &route_cache_elem_free);
416 static void dijkstra_finalize(AS_t asg)
418 as_dijkstra_t as = (as_dijkstra_t) asg;
420 xbt_graph_free_graph(as->route_graph, &xbt_free,
421 &graph_edge_data_free, &xbt_free);
422 xbt_dict_free(&as->graph_node_map);
424 xbt_dict_free(&as->route_cache);
426 model_generic_finalize(asg);
429 /* Creation routing model functions */
431 AS_t model_dijkstra_both_create(int cached)
433 as_dijkstra_t new_component = (as_dijkstra_t)
434 model_generic_create_sized(sizeof(s_as_dijkstra_t));
436 new_component->generic_routing.parse_route = model_dijkstra_both_parse_route;
437 new_component->generic_routing.parse_ASroute = model_dijkstra_both_parse_route;
438 new_component->generic_routing.get_route = dijkstra_get_route;
439 new_component->generic_routing.get_onelink_routes =
440 dijkstra_get_onelink_routes;
441 new_component->generic_routing.finalize = dijkstra_finalize;
442 new_component->cached = cached;
444 return (AS_t)new_component;
447 AS_t model_dijkstra_create(void)
449 return model_dijkstra_both_create(0);
452 AS_t model_dijkstracache_create(void)
454 return model_dijkstra_both_create(1);
457 void model_dijkstra_both_end(AS_t as)
459 as_dijkstra_t THIS = (as_dijkstra_t) as;
461 xbt_node_t node = NULL;
462 unsigned int cursor2;
463 xbt_dynar_t nodes = NULL;
465 /* Create the topology graph */
466 if(!THIS->route_graph)
467 THIS->route_graph = xbt_graph_new_graph(1, NULL);
468 if(!THIS->graph_node_map)
469 THIS->graph_node_map = xbt_dict_new();
471 if (THIS->cached && !THIS->route_cache)
472 THIS->route_cache = xbt_dict_new();
474 /* Add the loopback if needed */
475 if (as->hierarchy == SURF_ROUTING_BASE)
476 add_loopback_dijkstra(THIS);
478 /* initialize graph indexes in nodes after graph has been built */
479 nodes = xbt_graph_get_nodes(THIS->route_graph);
481 xbt_dynar_foreach(nodes, cursor2, node) {
482 graph_node_data_t data = xbt_graph_node_get_data(node);
483 data->graph_id = cursor2;
487 void model_dijkstra_both_parse_route (AS_t asg, const char *src,
488 const char *dst, route_extended_t route)
490 as_dijkstra_t as = (as_dijkstra_t) asg;
491 int *src_id, *dst_id;
492 src_id = xbt_dict_get_or_null(asg->to_index, src);
493 dst_id = xbt_dict_get_or_null(asg->to_index, dst);
495 xbt_assert(src_id, "Network elements %s not found", src);
496 xbt_assert(dst_id, "Network elements %s not found", dst);
498 /* Create the topology graph */
500 as->route_graph = xbt_graph_new_graph(1, NULL);
501 if(!as->graph_node_map)
502 as->graph_node_map = xbt_dict_new();
504 if (as->cached && !as->route_cache)
505 as->route_cache = xbt_dict_new();
507 if( A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES
508 || A_surfxml_ASroute_symmetrical == A_surfxml_ASroute_symmetrical_YES )
509 xbt_die("Route symmetrical not supported on model dijkstra");
511 if(!route->dst_gateway && !route->src_gateway)
512 XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
514 XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
515 route->src_gateway, dst, route->dst_gateway);
516 if(routing_get_network_element_type((const char*)route->dst_gateway) == SURF_NETWORK_ELEMENT_NULL)
517 xbt_die("The dst_gateway '%s' does not exist!",route->dst_gateway);
518 if(routing_get_network_element_type((const char*)route->src_gateway) == SURF_NETWORK_ELEMENT_NULL)
519 xbt_die("The src_gateway '%s' does not exist!",route->src_gateway);
522 route_extended_t e_route =
523 generic_new_extended_route(asg->hierarchy, route, 1);
524 route_new_dijkstra(as, *src_id, *dst_id, e_route);