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, NULL);
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 void dijkstra_get_route_and_latency(AS_t as_generic,
169 network_element_t src, network_element_t dst, route_t route, double *lat);
171 static xbt_dynar_t dijkstra_get_onelink_routes(AS_t as)
173 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
174 route_t route = xbt_new0(s_route_t,1);
175 route->link_list = xbt_dynar_new(global_routing->size_of_link,NULL);
178 network_element_t src_elm, dst_elm;
179 size_t table_size = xbt_dynar_length(as->index_network_elm);
180 for(src=0; src < table_size; src++) {
181 for(dst=0; dst< table_size; dst++) {
182 xbt_dynar_reset(route->link_list);
183 src_elm = xbt_dynar_get_as(as->index_network_elm,src,network_element_t);
184 dst_elm = xbt_dynar_get_as(as->index_network_elm,dst,network_element_t);
185 dijkstra_get_route_and_latency(as, src_elm, dst_elm,route, NULL);
187 if (xbt_dynar_length(route->link_list) == 1) {
188 void *link = *(void **) xbt_dynar_get_ptr(route->link_list, 0);
189 onelink_t onelink = xbt_new0(s_onelink_t, 1);
190 onelink->link_ptr = link;
191 if (as->hierarchy == SURF_ROUTING_BASE) {
192 onelink->src = src_elm;
193 onelink->dst = dst_elm;
194 } else if (as->hierarchy == SURF_ROUTING_RECURSIVE) {
195 onelink->src = route->src_gateway;
196 onelink->dst = route->dst_gateway;
198 xbt_dynar_push(ret, &onelink);
205 static void dijkstra_get_route_and_latency(AS_t asg,
206 network_element_t src, network_element_t dst,
207 route_t route, double *lat)
211 as_dijkstra_t as = (as_dijkstra_t) asg;
213 generic_src_dst_check(asg, src, dst);
214 int *src_id = &(src->id);
215 int *dst_id = &(dst->id);
217 if (!src_id || !dst_id)
218 THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
220 int *pred_arr = NULL;
229 xbt_dynar_t links = NULL;
230 route_cache_element_t elm = NULL;
231 xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
233 /* Use the graph_node id mapping set to quickly find the nodes */
234 graph_node_map_element_t src_elm =
235 graph_node_map_search(as, *src_id);
236 graph_node_map_element_t dst_elm =
237 graph_node_map_search(as, *dst_id);
239 src_node_id = ((graph_node_data_t)
240 xbt_graph_node_get_data(src_elm->node))->graph_id;
241 dst_node_id = ((graph_node_data_t)
242 xbt_graph_node_get_data(dst_elm->node))->graph_id;
244 /* if the src and dst are the same */
245 if (src_node_id == dst_node_id) {
247 xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
248 xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
250 xbt_graph_get_edge(as->route_graph, node_s_v, node_e_v);
253 THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
255 e_route = (route_t) xbt_graph_edge_get_data(edge);
257 links = e_route->link_list;
258 xbt_dynar_foreach(links, cpt, link) {
259 xbt_dynar_unshift(route->link_list, &link);
261 *lat += surf_network_model->extension.network.get_link_latency(link);
267 /*check if there is a cached predecessor list avail */
268 elm = (route_cache_element_t)
269 xbt_dict_get_or_null_ext(as->route_cache, (char *) (&src_id),
273 if (elm) { /* cached mode and cache hit */
274 pred_arr = elm->pred_arr;
275 } else { /* not cached mode or cache miss */
276 double *cost_arr = NULL;
277 xbt_heap_t pqueue = NULL;
280 int nr_nodes = xbt_dynar_length(nodes);
281 cost_arr = xbt_new0(double, nr_nodes); /* link cost from src to other hosts */
282 pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
283 pqueue = xbt_heap_new(nr_nodes, xbt_free);
286 cost_arr[src_node_id] = 0.0;
288 for (i = 0; i < nr_nodes; i++) {
289 if (i != src_node_id) {
290 cost_arr[i] = DBL_MAX;
295 /* initialize priority queue */
296 nodeid = xbt_new0(int, 1);
298 xbt_heap_push(pqueue, nodeid, cost_arr[i]);
302 /* apply dijkstra using the indexes from the graph's node array */
303 while (xbt_heap_size(pqueue) > 0) {
304 int *v_id = xbt_heap_pop(pqueue);
305 xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
306 xbt_dynar_t out_edges = xbt_graph_node_get_outedges(v_node);
307 xbt_edge_t edge = NULL;
310 xbt_dynar_foreach(out_edges, cursor, edge) {
311 xbt_node_t u_node = xbt_graph_edge_get_target(edge);
312 graph_node_data_t data = xbt_graph_node_get_data(u_node);
313 int u_id = data->graph_id;
314 route_t tmp_e_route = (route_t) xbt_graph_edge_get_data(edge);
315 int cost_v_u = (tmp_e_route->link_list)->used; /* count of links, old model assume 1 */
317 if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
318 pred_arr[u_id] = *v_id;
319 cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
320 nodeid = xbt_new0(int, 1);
322 xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
326 /* free item popped from pqueue */
331 xbt_heap_free(pqueue);
334 /* compose route path with links */
335 network_element_t gw_src = NULL, gw_dst, prev_gw_src, first_gw = NULL;
336 network_element_t gw_dst_net_elm = NULL, prev_gw_src_net_elm = NULL;
338 for (v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
339 xbt_node_t node_pred_v =
340 xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
341 xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
343 xbt_graph_get_edge(as->route_graph, node_pred_v, node_v);
346 THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
348 prev_gw_src = gw_src;
350 e_route = (route_t) xbt_graph_edge_get_data(edge);
351 gw_src = e_route->src_gateway;
352 gw_dst = e_route->dst_gateway;
354 if (v == dst_node_id)
357 if (asg->hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
358 && strcmp(gw_dst->name, prev_gw_src->name)) {
359 xbt_dynar_t e_route_as_to_as=NULL;
360 routing_get_route_and_latency(gw_dst_net_elm, prev_gw_src_net_elm, &e_route_as_to_as, NULL);
362 THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
363 links = e_route_as_to_as;
365 xbt_dynar_foreach(links, cpt, link) {
366 xbt_dynar_insert_at(route->link_list, pos, &link);
368 *lat += surf_network_model->extension.network.get_link_latency(link);
373 links = e_route->link_list;
374 xbt_dynar_foreach(links, cpt, link) {
375 xbt_dynar_unshift(route->link_list, &link);
377 *lat += surf_network_model->extension.network.get_link_latency(link);
382 if (asg->hierarchy == SURF_ROUTING_RECURSIVE) {
383 route->src_gateway = gw_src;
384 route->dst_gateway = first_gw;
387 if (as->cached && elm == NULL) {
388 /* add to predecessor list of the current src-host to cache */
389 elm = xbt_new0(struct route_cache_element, 1);
390 elm->pred_arr = pred_arr;
392 xbt_dict_set_ext(as->route_cache, (char *) (&src_id), sizeof(int),
393 (xbt_set_elm_t) elm, NULL);
400 static void dijkstra_finalize(AS_t asg)
402 as_dijkstra_t as = (as_dijkstra_t) asg;
404 xbt_graph_free_graph(as->route_graph, &xbt_free,
405 &graph_edge_data_free, &xbt_free);
406 xbt_dict_free(&as->graph_node_map);
408 xbt_dict_free(&as->route_cache);
410 model_generic_finalize(asg);
413 /* Creation routing model functions */
415 AS_t model_dijkstra_both_create(int cached)
417 as_dijkstra_t new_component = (as_dijkstra_t)
418 model_generic_create_sized(sizeof(s_as_dijkstra_t));
420 new_component->generic_routing.parse_route = model_dijkstra_both_parse_route;
421 new_component->generic_routing.parse_ASroute = model_dijkstra_both_parse_route;
422 new_component->generic_routing.get_route_and_latency = dijkstra_get_route_and_latency;
423 new_component->generic_routing.get_onelink_routes =
424 dijkstra_get_onelink_routes;
425 new_component->generic_routing.finalize = dijkstra_finalize;
426 new_component->cached = cached;
428 return (AS_t)new_component;
431 AS_t model_dijkstra_create(void)
433 return model_dijkstra_both_create(0);
436 AS_t model_dijkstracache_create(void)
438 return model_dijkstra_both_create(1);
441 void model_dijkstra_both_end(AS_t as)
443 as_dijkstra_t THIS_AS = (as_dijkstra_t) as;
445 xbt_node_t node = NULL;
446 unsigned int cursor2;
447 xbt_dynar_t nodes = NULL;
449 /* Create the topology graph */
450 if(!THIS_AS->route_graph)
451 THIS_AS->route_graph = xbt_graph_new_graph(1, NULL);
452 if(!THIS_AS->graph_node_map)
453 THIS_AS->graph_node_map = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
455 if (THIS_AS->cached && !THIS_AS->route_cache)
456 THIS_AS->route_cache = xbt_dict_new_homogeneous(&route_cache_elem_free);
458 /* Add the loopback if needed */
459 if (global_routing->loopback && as->hierarchy == SURF_ROUTING_BASE)
460 add_loopback_dijkstra(THIS_AS);
462 /* initialize graph indexes in nodes after graph has been built */
463 nodes = xbt_graph_get_nodes(THIS_AS->route_graph);
465 xbt_dynar_foreach(nodes, cursor2, node) {
466 graph_node_data_t data = xbt_graph_node_get_data(node);
467 data->graph_id = cursor2;
471 void model_dijkstra_both_parse_route (AS_t asg, const char *src,
472 const char *dst, route_t route)
474 as_dijkstra_t as = (as_dijkstra_t) asg;
475 network_element_t src_net_elm, dst_net_elm;
477 src_net_elm = xbt_lib_get_or_null(host_lib, src, ROUTING_HOST_LEVEL);
478 dst_net_elm = xbt_lib_get_or_null(host_lib, dst, ROUTING_HOST_LEVEL);
480 src_net_elm = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
482 dst_net_elm = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
484 xbt_assert(src_net_elm, "Network elements %s not found", src);
485 xbt_assert(dst_net_elm, "Network elements %s not found", dst);
487 /* Create the topology graph */
489 as->route_graph = xbt_graph_new_graph(1, NULL);
490 if(!as->graph_node_map)
491 as->graph_node_map = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
493 if (as->cached && !as->route_cache)
494 as->route_cache = xbt_dict_new_homogeneous(&route_cache_elem_free);
496 if( A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES
497 || A_surfxml_ASroute_symmetrical == A_surfxml_ASroute_symmetrical_YES )
498 xbt_die("Route symmetrical not supported on model dijkstra");
500 if(!route->dst_gateway && !route->src_gateway)
501 XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
503 XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
504 route->src_gateway->name, dst, route->dst_gateway->name);
505 if(route->dst_gateway->rc_type == SURF_NETWORK_ELEMENT_NULL)
506 xbt_die("The dst_gateway '%s' does not exist!",route->dst_gateway->name);
507 if(route->src_gateway->rc_type == SURF_NETWORK_ELEMENT_NULL)
508 xbt_die("The src_gateway '%s' does not exist!",route->src_gateway->name);
511 route_t e_route = generic_new_extended_route(asg->hierarchy, route, 1);
512 route_new_dijkstra(as, src_net_elm->id, dst_net_elm->id, e_route);