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) // FIXME: useless code dupplication
56 route_t e_route = (route_t) e;
58 xbt_dynar_free(&(e_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_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_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);
168 static route_t dijkstra_get_route(AS_t as_generic,
172 static xbt_dynar_t dijkstra_get_onelink_routes(AS_t as)
174 // xbt_die("\"dijkstra_get_onelink_routes\" function not implemented yet");
175 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
177 //size_t table_size = xbt_dict_length(routing->generic_routing.to_index);
178 xbt_dict_cursor_t c1 = NULL, c2 = NULL;
179 char *k1, *d1, *k2, *d2;
180 xbt_dict_foreach(as->to_index, c1, k1, d1) {
181 xbt_dict_foreach(as->to_index, c2, k2, d2) {
182 route_t route = dijkstra_get_route(as, k1, k2);
184 if (xbt_dynar_length(route->link_list) == 1) {
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);
197 xbt_dynar_push(ret, &onelink);
205 static route_t dijkstra_get_route(AS_t asg,
209 xbt_assert(asg && src
211 "Invalid params for \"get_route\" function at AS \"%s\"",
215 as_dijkstra_t as = (as_dijkstra_t) asg;
217 generic_src_dst_check(asg, src, dst);
218 int *src_id = xbt_dict_get_or_null(asg->to_index, src);
219 int *dst_id = xbt_dict_get_or_null(asg->to_index, dst);
222 "Ask for route \"from\"(%s) or \"to\"(%s) no found in the local table",
225 /* create a result route */
226 route_t new_e_route = xbt_new0(s_route_t, 1);
227 new_e_route->link_list = xbt_dynar_new(global_routing->size_of_link, NULL);
228 new_e_route->src_gateway = NULL;
229 new_e_route->dst_gateway = NULL;
231 int *pred_arr = NULL;
240 xbt_dynar_t links = NULL;
241 route_cache_element_t elm = NULL;
242 xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
244 /* Use the graph_node id mapping set to quickly find the nodes */
245 graph_node_map_element_t src_elm =
246 graph_node_map_search(as, *src_id);
247 graph_node_map_element_t dst_elm =
248 graph_node_map_search(as, *dst_id);
249 xbt_assert(src_elm != NULL
250 && dst_elm != NULL, "src %d or dst %d does not exist",
252 src_node_id = ((graph_node_data_t)
253 xbt_graph_node_get_data(src_elm->node))->graph_id;
254 dst_node_id = ((graph_node_data_t)
255 xbt_graph_node_get_data(dst_elm->node))->graph_id;
257 /* if the src and dst are the same *//* fixed, missing in the previous version */
258 if (src_node_id == dst_node_id) {
260 xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
261 xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
263 xbt_graph_get_edge(as->route_graph, node_s_v, node_e_v);
265 xbt_assert(edge != NULL, "no route between host %d and %d", *src_id,
268 e_route = (route_t) xbt_graph_edge_get_data(edge);
270 links = e_route->link_list;
271 xbt_dynar_foreach(links, cpt, link) {
272 xbt_dynar_unshift(new_e_route->link_list, &link);
279 /*check if there is a cached predecessor list avail */
280 elm = (route_cache_element_t)
281 xbt_dict_get_or_null_ext(as->route_cache, (char *) (&src_id),
285 if (elm) { /* cached mode and cache hit */
286 pred_arr = elm->pred_arr;
287 } else { /* not cached mode or cache miss */
288 double *cost_arr = NULL;
289 xbt_heap_t pqueue = NULL;
292 int nr_nodes = xbt_dynar_length(nodes);
293 cost_arr = xbt_new0(double, nr_nodes); /* link cost from src to other hosts */
294 pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
295 pqueue = xbt_heap_new(nr_nodes, xbt_free);
298 cost_arr[src_node_id] = 0.0;
300 for (i = 0; i < nr_nodes; i++) {
301 if (i != src_node_id) {
302 cost_arr[i] = DBL_MAX;
307 /* initialize priority queue */
308 nodeid = xbt_new0(int, 1);
310 xbt_heap_push(pqueue, nodeid, cost_arr[i]);
314 /* apply dijkstra using the indexes from the graph's node array */
315 while (xbt_heap_size(pqueue) > 0) {
316 int *v_id = xbt_heap_pop(pqueue);
317 xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
318 xbt_dynar_t out_edges = xbt_graph_node_get_outedges(v_node);
319 xbt_edge_t edge = NULL;
322 xbt_dynar_foreach(out_edges, cursor, edge) {
323 xbt_node_t u_node = xbt_graph_edge_get_target(edge);
324 graph_node_data_t data = xbt_graph_node_get_data(u_node);
325 int u_id = data->graph_id;
326 route_t tmp_e_route = (route_t) xbt_graph_edge_get_data(edge);
327 int cost_v_u = (tmp_e_route->link_list)->used; /* count of links, old model assume 1 */
329 if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
330 pred_arr[u_id] = *v_id;
331 cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
332 nodeid = xbt_new0(int, 1);
334 xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
338 /* free item popped from pqueue */
343 xbt_heap_free(pqueue);
346 /* compose route path with links */
347 char *gw_src = NULL, *gw_dst = NULL, *prev_gw_src, *first_gw = NULL;
349 for (v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
350 xbt_node_t node_pred_v =
351 xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
352 xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
354 xbt_graph_get_edge(as->route_graph, node_pred_v, node_v);
356 xbt_assert(edge != NULL, "no route between host %d and %d", *src_id,
359 prev_gw_src = gw_src;
361 e_route = (route_t) xbt_graph_edge_get_data(edge);
362 gw_src = e_route->src_gateway;
363 gw_dst = e_route->dst_gateway;
365 if (v == dst_node_id)
368 if (asg->hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
369 && strcmp(gw_dst, prev_gw_src)) {
370 xbt_dynar_t e_route_as_to_as =
371 routing_get_route(gw_dst, prev_gw_src);
372 xbt_assert(e_route_as_to_as, "no route between \"%s\" and \"%s\"",
373 gw_dst, prev_gw_src);
374 links = e_route_as_to_as;
376 xbt_dynar_foreach(links, cpt, link) {
377 xbt_dynar_insert_at(new_e_route->link_list, pos, &link);
382 links = e_route->link_list;
383 xbt_dynar_foreach(links, cpt, link) {
384 xbt_dynar_unshift(new_e_route->link_list, &link);
389 if (asg->hierarchy == SURF_ROUTING_RECURSIVE) {
390 new_e_route->src_gateway = xbt_strdup(gw_src);
391 new_e_route->dst_gateway = xbt_strdup(first_gw);
394 if (as->cached && elm == NULL) {
395 /* add to predecessor list of the current src-host to cache */
396 elm = xbt_new0(struct route_cache_element, 1);
397 elm->pred_arr = pred_arr;
399 xbt_dict_set_ext(as->route_cache, (char *) (&src_id), sizeof(int),
400 (xbt_set_elm_t) elm, &route_cache_elem_free);
409 static void dijkstra_finalize(AS_t asg)
411 as_dijkstra_t as = (as_dijkstra_t) asg;
413 xbt_graph_free_graph(as->route_graph, &xbt_free,
414 &graph_edge_data_free, &xbt_free);
415 xbt_dict_free(&as->graph_node_map);
417 xbt_dict_free(&as->route_cache);
419 model_generic_finalize(asg);
422 /* Creation routing model functions */
424 AS_t model_dijkstra_both_create(int cached)
426 as_dijkstra_t new_component = (as_dijkstra_t)
427 model_generic_create_sized(sizeof(s_as_dijkstra_t));
429 new_component->generic_routing.parse_route = model_dijkstra_both_parse_route;
430 new_component->generic_routing.parse_ASroute = model_dijkstra_both_parse_route;
431 new_component->generic_routing.get_route = dijkstra_get_route;
432 new_component->generic_routing.get_onelink_routes =
433 dijkstra_get_onelink_routes;
434 new_component->generic_routing.finalize = dijkstra_finalize;
435 new_component->cached = cached;
437 return (AS_t)new_component;
440 AS_t model_dijkstra_create(void)
442 return model_dijkstra_both_create(0);
445 AS_t model_dijkstracache_create(void)
447 return model_dijkstra_both_create(1);
450 void model_dijkstra_both_end(AS_t as)
452 as_dijkstra_t THIS = (as_dijkstra_t) as;
454 xbt_node_t node = NULL;
455 unsigned int cursor2;
456 xbt_dynar_t nodes = NULL;
458 /* Create the topology graph */
459 if(!THIS->route_graph)
460 THIS->route_graph = xbt_graph_new_graph(1, NULL);
461 if(!THIS->graph_node_map)
462 THIS->graph_node_map = xbt_dict_new();
464 if (THIS->cached && !THIS->route_cache)
465 THIS->route_cache = xbt_dict_new();
467 /* Add the loopback if needed */
468 if (as->hierarchy == SURF_ROUTING_BASE)
469 add_loopback_dijkstra(THIS);
471 /* initialize graph indexes in nodes after graph has been built */
472 nodes = xbt_graph_get_nodes(THIS->route_graph);
474 xbt_dynar_foreach(nodes, cursor2, node) {
475 graph_node_data_t data = xbt_graph_node_get_data(node);
476 data->graph_id = cursor2;
480 void model_dijkstra_both_parse_route (AS_t asg, const char *src,
481 const char *dst, route_t route)
483 as_dijkstra_t as = (as_dijkstra_t) asg;
484 int *src_id, *dst_id;
485 src_id = xbt_dict_get_or_null(asg->to_index, src);
486 dst_id = xbt_dict_get_or_null(asg->to_index, dst);
488 xbt_assert(src_id, "Network elements %s not found", src);
489 xbt_assert(dst_id, "Network elements %s not found", dst);
491 /* Create the topology graph */
493 as->route_graph = xbt_graph_new_graph(1, NULL);
494 if(!as->graph_node_map)
495 as->graph_node_map = xbt_dict_new();
497 if (as->cached && !as->route_cache)
498 as->route_cache = xbt_dict_new();
500 if( A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES
501 || A_surfxml_ASroute_symmetrical == A_surfxml_ASroute_symmetrical_YES )
502 xbt_die("Route symmetrical not supported on model dijkstra");
504 if(!route->dst_gateway && !route->src_gateway)
505 XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
507 XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
508 route->src_gateway, dst, route->dst_gateway);
509 if(routing_get_network_element_type((const char*)route->dst_gateway) == SURF_NETWORK_ELEMENT_NULL)
510 xbt_die("The dst_gateway '%s' does not exist!",route->dst_gateway);
511 if(routing_get_network_element_type((const char*)route->src_gateway) == SURF_NETWORK_ELEMENT_NULL)
512 xbt_die("The src_gateway '%s' does not exist!",route->src_gateway);
515 route_t e_route = generic_new_extended_route(asg->hierarchy, route, 1);
516 route_new_dijkstra(as, *src_id, *dst_id, e_route);