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;
11 extern routing_component_t current_routing;
12 extern model_type_t current_routing_model;
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf");
17 s_routing_component_t generic_routing;
18 xbt_graph_t route_graph; /* xbt_graph */
19 xbt_dict_t graph_node_map; /* map */
20 xbt_dict_t route_cache; /* use in cache mode */
22 } s_routing_component_dijkstra_t, *routing_component_dijkstra_t;
25 typedef struct graph_node_data {
27 int graph_id; /* used for caching internal graph id's */
28 } s_graph_node_data_t, *graph_node_data_t;
30 typedef struct graph_node_map_element {
32 } s_graph_node_map_element_t, *graph_node_map_element_t;
34 typedef struct route_cache_element {
37 } s_route_cache_element_t, *route_cache_element_t;
41 static void route_cache_elem_free(void *e)
43 route_cache_element_t elm = (route_cache_element_t) e;
45 xbt_free(elm->pred_arr);
50 static void graph_node_map_elem_free(void *e)
52 graph_node_map_element_t elm = (graph_node_map_element_t) e;
58 static void graph_edge_data_free(void *e)
60 route_extended_t e_route = (route_extended_t) e;
62 xbt_dynar_free(&(e_route->generic_route.link_list));
63 if (e_route->src_gateway)
64 xbt_free(e_route->src_gateway);
65 if (e_route->dst_gateway)
66 xbt_free(e_route->dst_gateway);
71 /* Utility functions */
73 static xbt_node_t route_graph_new_node(routing_component_dijkstra_t rc,
76 routing_component_dijkstra_t routing = (routing_component_dijkstra_t) rc;
77 xbt_node_t node = NULL;
78 graph_node_data_t data = NULL;
79 graph_node_map_element_t elm = NULL;
81 data = xbt_new0(struct graph_node_data, 1);
83 data->graph_id = graph_id;
84 node = xbt_graph_new_node(routing->route_graph, data);
86 elm = xbt_new0(struct graph_node_map_element, 1);
88 xbt_dict_set_ext(routing->graph_node_map, (char *) (&id), sizeof(int),
89 (xbt_set_elm_t) elm, &graph_node_map_elem_free);
94 static graph_node_map_element_t
95 graph_node_map_search(routing_component_dijkstra_t rc, int id)
97 routing_component_dijkstra_t routing = (routing_component_dijkstra_t) rc;
98 graph_node_map_element_t elm = (graph_node_map_element_t)
99 xbt_dict_get_or_null_ext(routing->graph_node_map,
107 static void route_new_dijkstra(routing_component_dijkstra_t rc, int src_id,
108 int dst_id, route_extended_t e_route)
110 routing_component_dijkstra_t routing = (routing_component_dijkstra_t) rc;
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;
115 graph_node_map_element_t src_elm = (graph_node_map_element_t)
116 xbt_dict_get_or_null_ext(routing->graph_node_map,
119 graph_node_map_element_t dst_elm = (graph_node_map_element_t)
120 xbt_dict_get_or_null_ext(routing->graph_node_map,
131 /* add nodes if they don't exist in the graph */
132 if (src_id == dst_id && src == NULL && dst == NULL) {
133 src = route_graph_new_node(rc, src_id, -1);
137 src = route_graph_new_node(rc, src_id, -1);
140 dst = route_graph_new_node(rc, dst_id, -1);
144 /* add link as edge to graph */
145 xbt_graph_new_edge(routing->route_graph, src, dst, e_route);
148 static void add_loopback_dijkstra(routing_component_dijkstra_t rc)
150 routing_component_dijkstra_t routing = (routing_component_dijkstra_t) rc;
152 xbt_dynar_t nodes = xbt_graph_get_nodes(routing->route_graph);
154 xbt_node_t node = NULL;
155 unsigned int cursor2;
156 xbt_dynar_foreach(nodes, cursor2, node) {
157 xbt_dynar_t out_edges = xbt_graph_node_get_outedges(node);
158 xbt_edge_t edge = NULL;
162 xbt_dynar_foreach(out_edges, cursor, edge) {
163 xbt_node_t other_node = xbt_graph_edge_get_target(edge);
164 if (other_node == node) {
171 route_extended_t e_route = xbt_new0(s_route_extended_t, 1);
172 e_route->src_gateway = NULL;
173 e_route->dst_gateway = NULL;
174 e_route->generic_route.link_list =
175 xbt_dynar_new(global_routing->size_of_link, NULL);
176 xbt_dynar_push(e_route->generic_route.link_list,
177 &global_routing->loopback);
178 xbt_graph_new_edge(routing->route_graph, node, node, e_route);
183 /* Business methods */
184 static xbt_dynar_t dijkstra_get_onelink_routes(routing_component_t rc)
186 xbt_die("\"dijkstra_get_onelink_routes\" function not implemented yet");
189 static route_extended_t dijkstra_get_route(routing_component_t rc,
195 "Invalid params for \"get_route\" function at AS \"%s\"",
199 routing_component_dijkstra_t routing = (routing_component_dijkstra_t) rc;
201 generic_src_dst_check(rc, src, dst);
202 int *src_id = xbt_dict_get_or_null(routing->generic_routing.to_index, src);
203 int *dst_id = xbt_dict_get_or_null(routing->generic_routing.to_index, dst);
206 "Ask for route \"from\"(%s) or \"to\"(%s) no found in the local table",
209 /* create a result route */
210 route_extended_t new_e_route = xbt_new0(s_route_extended_t, 1);
211 new_e_route->generic_route.link_list =
212 xbt_dynar_new(global_routing->size_of_link, NULL);
213 new_e_route->src_gateway = NULL;
214 new_e_route->dst_gateway = NULL;
216 int *pred_arr = NULL;
221 route_extended_t e_route;
225 xbt_dynar_t links = NULL;
226 route_cache_element_t elm = NULL;
227 xbt_dynar_t nodes = xbt_graph_get_nodes(routing->route_graph);
229 /* Use the graph_node id mapping set to quickly find the nodes */
230 graph_node_map_element_t src_elm =
231 graph_node_map_search(routing, *src_id);
232 graph_node_map_element_t dst_elm =
233 graph_node_map_search(routing, *dst_id);
234 xbt_assert(src_elm != NULL
235 && dst_elm != NULL, "src %d or dst %d does not exist",
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;
242 /* if the src and dst are the same *//* fixed, missing in the previous version */
243 if (src_node_id == dst_node_id) {
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);
248 xbt_graph_get_edge(routing->route_graph, node_s_v, node_e_v);
250 xbt_assert(edge != NULL, "no route between host %d and %d", *src_id,
253 e_route = (route_extended_t) xbt_graph_edge_get_data(edge);
255 links = e_route->generic_route.link_list;
256 xbt_dynar_foreach(links, cpt, link) {
257 xbt_dynar_unshift(new_e_route->generic_route.link_list, &link);
263 if (routing->cached) {
264 /*check if there is a cached predecessor list avail */
265 elm = (route_cache_element_t)
266 xbt_dict_get_or_null_ext(routing->route_cache, (char *) (&src_id),
270 if (elm) { /* cached mode and cache hit */
271 pred_arr = elm->pred_arr;
272 } else { /* not cached mode or cache miss */
273 double *cost_arr = NULL;
274 xbt_heap_t pqueue = NULL;
277 int nr_nodes = xbt_dynar_length(nodes);
278 cost_arr = xbt_new0(double, nr_nodes); /* link cost from src to other hosts */
279 pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
280 pqueue = xbt_heap_new(nr_nodes, xbt_free);
283 cost_arr[src_node_id] = 0.0;
285 for (i = 0; i < nr_nodes; i++) {
286 if (i != src_node_id) {
287 cost_arr[i] = DBL_MAX;
292 /* initialize priority queue */
293 nodeid = xbt_new0(int, 1);
295 xbt_heap_push(pqueue, nodeid, cost_arr[i]);
299 /* apply dijkstra using the indexes from the graph's node array */
300 while (xbt_heap_size(pqueue) > 0) {
301 int *v_id = xbt_heap_pop(pqueue);
302 xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
303 xbt_dynar_t out_edges = xbt_graph_node_get_outedges(v_node);
304 xbt_edge_t edge = NULL;
307 xbt_dynar_foreach(out_edges, cursor, edge) {
308 xbt_node_t u_node = xbt_graph_edge_get_target(edge);
309 graph_node_data_t data = xbt_graph_node_get_data(u_node);
310 int u_id = data->graph_id;
311 route_extended_t tmp_e_route =
312 (route_extended_t) xbt_graph_edge_get_data(edge);
313 int cost_v_u = (tmp_e_route->generic_route.link_list)->used; /* count of links, old model assume 1 */
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);
320 xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
324 /* free item popped from pqueue */
329 xbt_heap_free(pqueue);
332 /* compose route path with links */
333 char *gw_src = NULL, *gw_dst =
334 NULL, *prev_gw_src, *prev_gw_dst, *first_gw = NULL;
336 for (v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
337 xbt_node_t node_pred_v =
338 xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
339 xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
341 xbt_graph_get_edge(routing->route_graph, node_pred_v, node_v);
343 xbt_assert(edge != NULL, "no route between host %d and %d", *src_id,
346 prev_gw_src = gw_src;
347 prev_gw_dst = gw_dst;
349 e_route = (route_extended_t) xbt_graph_edge_get_data(edge);
350 gw_src = e_route->src_gateway;
351 gw_dst = e_route->dst_gateway;
353 if (v == dst_node_id)
356 if (rc->hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
357 && strcmp(gw_dst, prev_gw_src)) {
358 xbt_dynar_t e_route_as_to_as =
359 (*(global_routing->get_route)) (gw_dst, prev_gw_src);
360 xbt_assert(e_route_as_to_as, "no route between \"%s\" and \"%s\"",
361 gw_dst, prev_gw_src);
362 links = e_route_as_to_as;
364 xbt_dynar_foreach(links, cpt, link) {
365 xbt_dynar_insert_at(new_e_route->generic_route.link_list, pos,
371 links = e_route->generic_route.link_list;
372 xbt_dynar_foreach(links, cpt, link) {
373 xbt_dynar_unshift(new_e_route->generic_route.link_list, &link);
378 if (rc->hierarchy == SURF_ROUTING_RECURSIVE) {
379 new_e_route->src_gateway = xbt_strdup(gw_src);
380 new_e_route->dst_gateway = xbt_strdup(first_gw);
383 if (routing->cached && elm == NULL) {
384 /* add to predecessor list of the current src-host to cache */
385 elm = xbt_new0(struct route_cache_element, 1);
386 elm->pred_arr = pred_arr;
388 xbt_dict_set_ext(routing->route_cache, (char *) (&src_id), sizeof(int),
389 (xbt_set_elm_t) elm, &route_cache_elem_free);
392 if (!routing->cached)
398 static void dijkstra_finalize(routing_component_t rc)
400 routing_component_dijkstra_t routing = (routing_component_dijkstra_t) rc;
403 xbt_graph_free_graph(routing->route_graph, &xbt_free,
404 &graph_edge_data_free, &xbt_free);
405 xbt_dict_free(&routing->graph_node_map);
407 xbt_dict_free(&routing->route_cache);
408 /* Delete bypass dict */
409 xbt_dict_free(&routing->generic_routing.bypassRoutes);
410 /* Delete index dict */
411 xbt_dict_free(&(routing->generic_routing.to_index));
412 /* Delete structure */
417 /* Creation routing model functions */
419 void *model_dijkstra_both_create(int cached)
421 routing_component_dijkstra_t new_component =
422 xbt_new0(s_routing_component_dijkstra_t, 1);
423 new_component->generic_routing.set_processing_unit =
424 generic_set_processing_unit;
425 new_component->generic_routing.set_autonomous_system =
426 generic_set_autonomous_system;
427 new_component->generic_routing.set_route = model_dijkstra_both_set_route;
428 new_component->generic_routing.set_ASroute = model_dijkstra_both_set_route;
429 new_component->generic_routing.set_bypassroute = generic_set_bypassroute;
430 new_component->generic_routing.get_route = dijkstra_get_route;
431 new_component->generic_routing.get_latency = generic_get_link_latency;
432 new_component->generic_routing.get_onelink_routes =
433 dijkstra_get_onelink_routes;
434 new_component->generic_routing.get_bypass_route =
435 generic_get_bypassroute;
436 new_component->generic_routing.finalize = dijkstra_finalize;
437 new_component->cached = cached;
438 new_component->generic_routing.to_index = xbt_dict_new();
439 new_component->generic_routing.bypassRoutes = xbt_dict_new();
440 new_component->generic_routing.get_network_element_type = get_network_element_type;
441 return new_component;
444 void *model_dijkstra_create(void)
446 return model_dijkstra_both_create(0);
449 void *model_dijkstracache_create(void)
451 return model_dijkstra_both_create(1);
454 void model_dijkstra_both_load(void)
456 /* use "surfxml_add_callback" to add a parse function call */
459 void model_dijkstra_both_unload(void)
461 /* use "surfxml_del_callback" to remove a parse function call */
464 void model_dijkstra_both_end(void)
466 routing_component_dijkstra_t routing =
467 (routing_component_dijkstra_t) current_routing;
469 xbt_node_t node = NULL;
470 unsigned int cursor2;
471 xbt_dynar_t nodes = NULL;
473 /* Create the topology graph */
474 if(!routing->route_graph)
475 routing->route_graph = xbt_graph_new_graph(1, NULL);
476 if(!routing->graph_node_map)
477 routing->graph_node_map = xbt_dict_new();
479 if (routing->cached && !routing->route_cache)
480 routing->route_cache = xbt_dict_new();
482 /* Add the loopback if needed */
483 if (current_routing->hierarchy == SURF_ROUTING_BASE)
484 add_loopback_dijkstra(routing);
486 /* initialize graph indexes in nodes after graph has been built */
487 nodes = xbt_graph_get_nodes(routing->route_graph);
489 xbt_dynar_foreach(nodes, cursor2, node) {
490 graph_node_data_t data = xbt_graph_node_get_data(node);
491 data->graph_id = cursor2;
495 void model_dijkstra_both_set_route (routing_component_t rc, const char *src,
496 const char *dst, name_route_extended_t route)
498 routing_component_dijkstra_t routing = (routing_component_dijkstra_t) rc;
499 int *src_id, *dst_id;
500 src_id = xbt_dict_get_or_null(rc->to_index, src);
501 dst_id = xbt_dict_get_or_null(rc->to_index, dst);
503 xbt_assert(src_id, "Network elements %s not found", src);
504 xbt_assert(dst_id, "Network elements %s not found", dst);
506 /* Create the topology graph */
507 if(!routing->route_graph)
508 routing->route_graph = xbt_graph_new_graph(1, NULL);
509 if(!routing->graph_node_map)
510 routing->graph_node_map = xbt_dict_new();
512 if (routing->cached && !routing->route_cache)
513 routing->route_cache = xbt_dict_new();
515 if( A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES
516 || A_surfxml_ASroute_symmetrical == A_surfxml_ASroute_symmetrical_YES )
517 xbt_die("Route symmetrical not supported on model dijkstra");
519 if(!route->dst_gateway && !route->src_gateway)
520 XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
522 XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
523 route->src_gateway, dst, route->dst_gateway);
524 if(global_routing->get_network_element_type((const char*)route->dst_gateway) == SURF_NETWORK_ELEMENT_NULL)
525 xbt_die("The dst_gateway '%s' does not exist!",route->dst_gateway);
526 if(global_routing->get_network_element_type((const char*)route->src_gateway) == SURF_NETWORK_ELEMENT_NULL)
527 xbt_die("The src_gateway '%s' does not exist!",route->src_gateway);
530 route_extended_t e_route =
531 generic_new_extended_route(current_routing->hierarchy, route, 1);
532 route_new_dijkstra(routing, *src_id, *dst_id, e_route);