1 /* Copyright (c) 2009-2015. 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 "src/surf/surf_routing_private.hpp"
8 #include "src/surf/surf_routing_dijkstra.hpp"
9 #include "src/surf/network_interface.hpp"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
15 static void route_cache_elem_free(void *e)
17 route_cache_element_t elm = (route_cache_element_t) e;
19 xbt_free(elm->pred_arr);
24 static void graph_node_map_elem_free(void *e)
26 graph_node_map_element_t elm = (graph_node_map_element_t) e;
30 static void graph_edge_data_free(void *e) // FIXME: useless code duplication
32 sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t) e;
34 xbt_dynar_free(&(e_route->link_list));
39 AS_t model_dijkstra_create(void){
40 return new simgrid::surf::AsDijkstra(0);
43 AS_t model_dijkstracache_create(void){
44 return new simgrid::surf::AsDijkstra(1);
47 void model_dijkstra_both_end(AS_t as)
49 simgrid::surf::AsDijkstra *THIS_AS
50 = static_cast<simgrid::surf::AsDijkstra*>(as);
51 xbt_node_t node = NULL;
53 xbt_dynar_t nodes = NULL;
55 /* Create the topology graph */
56 if(!THIS_AS->p_routeGraph)
57 THIS_AS->p_routeGraph = xbt_graph_new_graph(1, NULL);
58 if(!THIS_AS->p_graphNodeMap)
59 THIS_AS->p_graphNodeMap = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
61 if (THIS_AS->m_cached && !THIS_AS->p_routeCache)
62 THIS_AS->p_routeCache = xbt_dict_new_homogeneous(&route_cache_elem_free);
64 /* Add the loopback if needed */
65 if (routing_platf->p_loopback && as->p_hierarchy == SURF_ROUTING_BASE)
66 THIS_AS->addLoopback();
68 /* initialize graph indexes in nodes after graph has been built */
69 nodes = xbt_graph_get_nodes(THIS_AS->p_routeGraph);
71 xbt_dynar_foreach(nodes, cursor2, node) {
72 graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(node);
73 data->graph_id = cursor2;
77 /* Utility functions */
82 xbt_node_t AsDijkstra::routeGraphNewNode(int id, int graph_id)
84 xbt_node_t node = NULL;
85 graph_node_data_t data = NULL;
86 graph_node_map_element_t elm = NULL;
88 data = xbt_new0(struct graph_node_data, 1);
90 data->graph_id = graph_id;
91 node = xbt_graph_new_node(p_routeGraph, data);
93 elm = xbt_new0(struct graph_node_map_element, 1);
95 xbt_dict_set_ext(p_graphNodeMap, (char *) (&id), sizeof(int),
96 (xbt_set_elm_t) elm, NULL);
101 graph_node_map_element_t AsDijkstra::nodeMapSearch(int id)
103 graph_node_map_element_t elm = (graph_node_map_element_t)
104 xbt_dict_get_or_null_ext(p_graphNodeMap,
112 void AsDijkstra::newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route)
114 XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
115 xbt_node_t src = NULL;
116 xbt_node_t dst = NULL;
118 graph_node_map_element_t src_elm = (graph_node_map_element_t)
119 xbt_dict_get_or_null_ext(p_graphNodeMap,
122 graph_node_map_element_t dst_elm = (graph_node_map_element_t)
123 xbt_dict_get_or_null_ext(p_graphNodeMap,
134 /* add nodes if they don't exist in the graph */
135 if (src_id == dst_id && src == NULL && dst == NULL) {
136 src = this->routeGraphNewNode(src_id, -1);
140 src = this->routeGraphNewNode(src_id, -1);
143 dst = this->routeGraphNewNode(dst_id, -1);
147 /* add link as edge to graph */
148 xbt_graph_new_edge(p_routeGraph, src, dst, e_route);
151 void AsDijkstra::addLoopback() {
152 xbt_dynar_t nodes = xbt_graph_get_nodes(p_routeGraph);
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 sg_platf_route_cbarg_t e_route = xbt_new0(s_sg_platf_route_cbarg_t, 1);
172 e_route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
173 xbt_dynar_push(e_route->link_list, &routing_platf->p_loopback);
174 xbt_graph_new_edge(p_routeGraph, node, node, e_route);
179 xbt_dynar_t AsDijkstra::getOnelinkRoutes()
181 xbt_dynar_t ret = xbt_dynar_new(sizeof(Onelink*), xbt_free_f);
182 sg_platf_route_cbarg_t route = xbt_new0(s_sg_platf_route_cbarg_t,1);
183 route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
186 NetCard *src_elm, *dst_elm;
187 int table_size = (int)xbt_dynar_length(p_indexNetworkElm);
188 for(src=0; src < table_size; src++) {
189 for(dst=0; dst< table_size; dst++) {
190 xbt_dynar_reset(route->link_list);
191 src_elm = xbt_dynar_get_as(p_indexNetworkElm, src, NetCard*);
192 dst_elm = xbt_dynar_get_as(p_indexNetworkElm, dst, NetCard*);
193 this->getRouteAndLatency(src_elm, dst_elm,route, NULL);
195 if (xbt_dynar_length(route->link_list) == 1) {
196 void *link = *(void **) xbt_dynar_get_ptr(route->link_list, 0);
198 if (p_hierarchy == SURF_ROUTING_BASE)
199 onelink = new Onelink(link, src_elm, dst_elm);
200 else if (p_hierarchy == SURF_ROUTING_RECURSIVE)
201 onelink = new Onelink(link, route->gw_src, route->gw_dst);
203 onelink = new Onelink(link, NULL, NULL);
204 xbt_dynar_push(ret, &onelink);
211 void AsDijkstra::getRouteAndLatency(NetCard *src, NetCard *dst, sg_platf_route_cbarg_t route, double *lat)
216 srcDstCheck(src, dst);
217 int *src_id = src->getIdPtr();
218 int *dst_id = dst->getIdPtr();
220 if (!src_id || !dst_id)
221 THROWF(arg_error,0,"No route from '%s' to '%s'",src->getName(),dst->getName());
223 int *pred_arr = NULL;
228 sg_platf_route_cbarg_t e_route;
232 xbt_dynar_t links = NULL;
233 route_cache_element_t elm = NULL;
234 xbt_dynar_t nodes = xbt_graph_get_nodes(p_routeGraph);
236 /* Use the graph_node id mapping set to quickly find the nodes */
237 graph_node_map_element_t src_elm = nodeMapSearch(*src_id);
238 graph_node_map_element_t dst_elm = nodeMapSearch(*dst_id);
240 src_node_id = ((graph_node_data_t)
241 xbt_graph_node_get_data(src_elm->node))->graph_id;
242 dst_node_id = ((graph_node_data_t)
243 xbt_graph_node_get_data(dst_elm->node))->graph_id;
245 /* if the src and dst are the same */
246 if (src_node_id == dst_node_id) {
248 xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
249 xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
250 xbt_edge_t edge = xbt_graph_get_edge(p_routeGraph, node_s_v, node_e_v);
253 THROWF(arg_error, 0, "No route from '%s' to '%s'", src->getName(), dst->getName());
255 e_route = (sg_platf_route_cbarg_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 += static_cast<Link*>(link)->getLatency();
267 /*check if there is a cached predecessor list avail */
268 elm = (route_cache_element_t)
269 xbt_dict_get_or_null_ext(p_routeCache, (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_f);
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 = (int *) 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 = (graph_node_data_t) xbt_graph_node_get_data(u_node);
313 int u_id = data->graph_id;
314 sg_platf_route_cbarg_t tmp_e_route = (sg_platf_route_cbarg_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 NetCard *gw_src = NULL, *gw_dst, *prev_gw_src, *first_gw = NULL;
336 NetCard *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(p_routeGraph, node_pred_v, node_v);
346 THROWF(arg_error, 0, "No route from '%s' to '%s'", src->getName(), dst->getName());
348 prev_gw_src = gw_src;
350 e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
351 gw_src = e_route->gw_src;
352 gw_dst = e_route->gw_dst;
354 if (v == dst_node_id)
357 if (p_hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
358 && strcmp(gw_dst->getName(), prev_gw_src->getName())) {
359 xbt_dynar_t e_route_as_to_as=NULL;
361 routing_platf->getRouteAndLatency(gw_dst_net_elm, prev_gw_src_net_elm, &e_route_as_to_as, NULL);
363 THROWF(arg_error,0,"No route from '%s' to '%s'", src->getName(), dst->getName());
364 links = e_route_as_to_as;
366 xbt_dynar_foreach(links, cpt, link) {
367 xbt_dynar_insert_at(route->link_list, pos, &link);
369 *lat += static_cast<Link*>(link)->getLatency();
374 links = e_route->link_list;
375 xbt_dynar_foreach(links, cpt, link) {
376 xbt_dynar_unshift(route->link_list, &link);
378 *lat += static_cast<Link*>(link)->getLatency();
383 if (p_hierarchy == SURF_ROUTING_RECURSIVE) {
384 route->gw_src = gw_src;
385 route->gw_dst = first_gw;
388 if (m_cached && elm == NULL) {
389 /* add to predecessor list of the current src-host to cache */
390 elm = xbt_new0(struct route_cache_element, 1);
391 elm->pred_arr = pred_arr;
393 xbt_dict_set_ext(p_routeCache, (char *) (&src_id), sizeof(int),
394 (xbt_set_elm_t) elm, NULL);
401 AsDijkstra::~AsDijkstra()
403 xbt_graph_free_graph(p_routeGraph, &xbt_free_f,
404 &graph_edge_data_free, &xbt_free_f);
405 xbt_dict_free(&p_graphNodeMap);
407 xbt_dict_free(&p_routeCache);
410 /* Creation routing model functions */
412 AsDijkstra::AsDijkstra() : AsGeneric(), m_cached(0) {
414 p_graphNodeMap = NULL;
418 AsDijkstra::AsDijkstra(int cached) : AsGeneric(), m_cached(cached)
421 p_graphNodeMap = NULL;
423 /*new_component->generic_routing.parse_route = model_dijkstra_both_parse_route;
424 new_component->generic_routing.parse_ASroute = model_dijkstra_both_parse_route;
425 new_component->generic_routing.get_route_and_latency = dijkstra_get_route_and_latency;
426 new_component->generic_routing.get_onelink_routes =
427 dijkstra_get_onelink_routes;
428 new_component->generic_routing.get_graph = generic_get_graph;
429 new_component->generic_routing.finalize = dijkstra_finalize;
430 new_component->cached = cached;*/
433 void AsDijkstra::end()
435 xbt_node_t node = NULL;
436 unsigned int cursor2;
437 xbt_dynar_t nodes = NULL;
439 /* Create the topology graph */
441 p_routeGraph = xbt_graph_new_graph(1, NULL);
443 p_graphNodeMap = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
445 if (m_cached && !p_routeCache)
446 p_routeCache = xbt_dict_new_homogeneous(&route_cache_elem_free);
448 /* Add the loopback if needed */
449 if (routing_platf->p_loopback && p_hierarchy == SURF_ROUTING_BASE)
452 /* initialize graph indexes in nodes after graph has been built */
453 nodes = xbt_graph_get_nodes(p_routeGraph);
455 xbt_dynar_foreach(nodes, cursor2, node) {
456 graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(node);
457 data->graph_id = cursor2;
462 void AsDijkstra::parseASroute(sg_platf_route_cbarg_t route)
467 void AsDijkstra::parseRoute(sg_platf_route_cbarg_t route)
469 char *src = (char*)(route->src);
470 char *dst = (char*)(route->dst);
473 if(!route->gw_dst && !route->gw_src)
474 XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
476 XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
477 route->gw_src->getName(), dst, route->gw_dst->getName());
479 if(route->gw_dst->getRcType() == SURF_NETWORK_ELEMENT_NULL)
480 surf_parse_error("The gw_dst '%s' does not exist!",route->gw_dst->getName());
481 if(route->gw_src->getRcType() == SURF_NETWORK_ELEMENT_NULL)
482 surf_parse_error("The gw_src '%s' does not exist!",route->gw_src->getName());
485 NetCard *src_net_elm, *dst_net_elm;
487 src_net_elm = sg_netcard_by_name_or_null(src);
488 dst_net_elm = sg_netcard_by_name_or_null(dst);
490 xbt_assert(src_net_elm, "Network elements %s not found", src);
491 xbt_assert(dst_net_elm, "Network elements %s not found", dst);
493 /* Create the topology graph */
495 p_routeGraph = xbt_graph_new_graph(1, NULL);
497 p_graphNodeMap = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
499 if (m_cached && !p_routeCache)
500 p_routeCache = xbt_dict_new_homogeneous(&route_cache_elem_free);
502 sg_platf_route_cbarg_t e_route = newExtendedRoute(p_hierarchy, route, 1);
503 newRoute(src_net_elm->getId(), dst_net_elm->getId(), e_route);
506 if ( (route->symmetrical == TRUE && as_route == 0)
507 || (route->symmetrical == TRUE && as_route == 1)
510 if(!route->gw_dst && !route->gw_src)
511 XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dst, src);
513 XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", dst,
514 route->gw_dst->getName(), src, route->gw_src->getName());
516 xbt_dynar_t nodes = xbt_graph_get_nodes(p_routeGraph);
517 xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_net_elm->getId(), xbt_node_t);
518 xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_net_elm->getId(), xbt_node_t);
520 xbt_graph_get_edge(p_routeGraph, node_e_v, node_s_v);
523 THROWF(arg_error,0,"(AS)Route from '%s' to '%s' already exists",src,dst);
525 if (route->gw_dst && route->gw_src) {
527 gw_tmp = route->gw_src;
528 route->gw_src = route->gw_dst;
529 route->gw_dst = gw_tmp;
531 sg_platf_route_cbarg_t link_route_back = newExtendedRoute(p_hierarchy, route, 0);
532 newRoute(dst_net_elm->getId(), src_net_elm->getId(), link_route_back);
534 xbt_dynar_free(&route->link_list);