src/surf/surf_routing_dijkstra.c

   1 /* Copyright (c) 2009, 2010, 2011. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   7 #include "surf_routing_private.h"
   8
   9 /* Global vars */
  10 extern routing_global_t global_routing;
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
  13
  14 typedef struct {
  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 */
  19   int cached;
  20 } s_as_dijkstra_t, *as_dijkstra_t;
  21
  22
  23 typedef struct graph_node_data {
  24   int id;
  25   int graph_id;                 /* used for caching internal graph id's */
  26 } s_graph_node_data_t, *graph_node_data_t;
  27
  28 typedef struct graph_node_map_element {
  29   xbt_node_t node;
  30 } s_graph_node_map_element_t, *graph_node_map_element_t;
  31
  32 typedef struct route_cache_element {
  33   int *pred_arr;
  34   int size;
  35 } s_route_cache_element_t, *route_cache_element_t;
  36
  37 /* Free functions */
  38
  39 static void route_cache_elem_free(void *e)
  40 {
  41   route_cache_element_t elm = (route_cache_element_t) e;
  42   if (elm) {
  43     xbt_free(elm->pred_arr);
  44     xbt_free(elm);
  45   }
  46 }
  47
  48 static void graph_node_map_elem_free(void *e)
  49 {
  50   graph_node_map_element_t elm = (graph_node_map_element_t) e;
  51   xbt_free(elm);
  52 }
  53
  54 static void graph_edge_data_free(void *e) // FIXME: useless code dupplication
  55 {
  56   route_t e_route = (route_t) e;
  57   if (e_route) {
  58     xbt_dynar_free(&(e_route->link_list));
  59     xbt_free(e_route->src_gateway);
  60     xbt_free(e_route->dst_gateway);
  61     xbt_free(e_route);
  62   }
  63 }
  64
  65 /* Utility functions */
  66
  67 static xbt_node_t route_graph_new_node(as_dijkstra_t as,
  68     int id, int graph_id)
  69 {
  70   xbt_node_t node = NULL;
  71   graph_node_data_t data = NULL;
  72   graph_node_map_element_t elm = NULL;
  73
  74   data = xbt_new0(struct graph_node_data, 1);
  75   data->id = id;
  76   data->graph_id = graph_id;
  77   node = xbt_graph_new_node(as->route_graph, data);
  78
  79   elm = xbt_new0(struct graph_node_map_element, 1);
  80   elm->node = node;
  81   xbt_dict_set_ext(as->graph_node_map, (char *) (&id), sizeof(int),
  82       (xbt_set_elm_t) elm, NULL);
  83
  84   return node;
  85 }
  86
  87 static graph_node_map_element_t
  88 graph_node_map_search(as_dijkstra_t as, int id)
  89 {
  90   graph_node_map_element_t elm = (graph_node_map_element_t)
  91           xbt_dict_get_or_null_ext(as->graph_node_map,
  92               (char *) (&id),
  93               sizeof(int));
  94   return elm;
  95 }
  96
  97 /* Parsing */
  98
  99 static void route_new_dijkstra(as_dijkstra_t as, int src_id,
 100     int dst_id, route_t e_route)
 101 {
 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;
 105
 106   graph_node_map_element_t src_elm = (graph_node_map_element_t)
 107           xbt_dict_get_or_null_ext(as->graph_node_map,
 108               (char *) (&src_id),
 109               sizeof(int));
 110   graph_node_map_element_t dst_elm = (graph_node_map_element_t)
 111           xbt_dict_get_or_null_ext(as->graph_node_map,
 112               (char *) (&dst_id),
 113               sizeof(int));
 114
 115
 116   if (src_elm)
 117     src = src_elm->node;
 118
 119   if (dst_elm)
 120     dst = dst_elm->node;
 121
 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);
 125     dst = src;
 126   } else {
 127     if (src == NULL) {
 128       src = route_graph_new_node(as, src_id, -1);
 129     }
 130     if (dst == NULL) {
 131       dst = route_graph_new_node(as, dst_id, -1);
 132     }
 133   }
 134
 135   /* add link as edge to graph */
 136   xbt_graph_new_edge(as->route_graph, src, dst, e_route);
 137 }
 138
 139 static void add_loopback_dijkstra(as_dijkstra_t as) {
 140   xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
 141
 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;
 147     unsigned int cursor;
 148
 149     int found = 0;
 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) {
 153         found = 1;
 154         break;
 155       }
 156     }
 157
 158     if (!found) {
 159       route_t e_route = xbt_new0(s_route_t, 1);
 160       e_route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t), 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);
 164     }
 165   }
 166 }
 167
 168 static void dijkstra_get_route_and_latency(AS_t as_generic,
 169     sg_routing_edge_t src, sg_routing_edge_t dst, route_t route, double *lat);
 170
 171 static xbt_dynar_t dijkstra_get_onelink_routes(AS_t as)
 172 {
 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(sizeof(sg_routing_link_t),NULL);
 176
 177   int src,dst;
 178   sg_routing_edge_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,sg_routing_edge_t);
 184       dst_elm = xbt_dynar_get_as(as->index_network_elm,dst,sg_routing_edge_t);
 185       dijkstra_get_route_and_latency(as, src_elm, dst_elm,route, NULL);
 186
 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;
 197         }
 198         xbt_dynar_push(ret, &onelink);
 199       }
 200     }
 201   }
 202   return ret;
 203 }
 204
 205 static void dijkstra_get_route_and_latency(AS_t asg,
 206     sg_routing_edge_t src, sg_routing_edge_t dst,
 207     route_t route, double *lat)
 208 {
 209
 210   /* set utils vars */
 211   as_dijkstra_t as = (as_dijkstra_t) asg;
 212
 213   generic_src_dst_check(asg, src, dst);
 214   int *src_id = &(src->id);
 215   int *dst_id = &(dst->id);
 216
 217   if (!src_id || !dst_id)
 218     THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
 219
 220   int *pred_arr = NULL;
 221   int src_node_id = 0;
 222   int dst_node_id = 0;
 223   int *nodeid = NULL;
 224   int v;
 225   route_t e_route;
 226   int size = 0;
 227   unsigned int cpt;
 228   void *link;
 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);
 232
 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);
 238
 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;
 243
 244   /* if the src and dst are the same */
 245   if (src_node_id == dst_node_id) {
 246
 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);
 249     xbt_edge_t edge =
 250         xbt_graph_get_edge(as->route_graph, node_s_v, node_e_v);
 251
 252     if (edge == NULL)
 253       THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
 254
 255     e_route = (route_t) xbt_graph_edge_get_data(edge);
 256
 257     links = e_route->link_list;
 258     xbt_dynar_foreach(links, cpt, link) {
 259       xbt_dynar_unshift(route->link_list, &link);
 260       if (lat)
 261         *lat += surf_network_model->extension.network.get_link_latency(link);
 262     }
 263
 264   }
 265
 266   if (as->cached) {
 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),
 270                 sizeof(int));
 271   }
 272
 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;
 278     int i = 0;
 279
 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);
 284
 285     /* initialize */
 286     cost_arr[src_node_id] = 0.0;
 287
 288     for (i = 0; i < nr_nodes; i++) {
 289       if (i != src_node_id) {
 290         cost_arr[i] = DBL_MAX;
 291       }
 292
 293       pred_arr[i] = 0;
 294
 295       /* initialize priority queue */
 296       nodeid = xbt_new0(int, 1);
 297       *nodeid = i;
 298       xbt_heap_push(pqueue, nodeid, cost_arr[i]);
 299
 300     }
 301
 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;
 308       unsigned int cursor;
 309
 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 */
 316
 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);
 321           *nodeid = u_id;
 322           xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
 323         }
 324       }
 325
 326       /* free item popped from pqueue */
 327       xbt_free(v_id);
 328     }
 329
 330     xbt_free(cost_arr);
 331     xbt_heap_free(pqueue);
 332   }
 333
 334   /* compose route path with links */
 335   sg_routing_edge_t gw_src = NULL, gw_dst, prev_gw_src, first_gw = NULL;
 336   sg_routing_edge_t gw_dst_net_elm = NULL, prev_gw_src_net_elm = NULL;
 337
 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);
 342     xbt_edge_t edge =
 343         xbt_graph_get_edge(as->route_graph, node_pred_v, node_v);
 344
 345     if (edge == NULL)
 346       THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
 347
 348     prev_gw_src = gw_src;
 349
 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;
 353
 354     if (v == dst_node_id)
 355       first_gw = gw_dst;
 356
 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);
 361       if (edge == NULL)
 362         THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
 363       links = e_route_as_to_as;
 364       int pos = 0;
 365       xbt_dynar_foreach(links, cpt, link) {
 366         xbt_dynar_insert_at(route->link_list, pos, &link);
 367         if (lat)
 368           *lat += surf_network_model->extension.network.get_link_latency(link);
 369         pos++;
 370       }
 371     }
 372
 373     links = e_route->link_list;
 374     xbt_dynar_foreach(links, cpt, link) {
 375       xbt_dynar_unshift(route->link_list, &link);
 376       if (lat)
 377         *lat += surf_network_model->extension.network.get_link_latency(link);
 378     }
 379     size++;
 380   }
 381
 382   if (asg->hierarchy == SURF_ROUTING_RECURSIVE) {
 383     route->src_gateway = gw_src;
 384     route->dst_gateway = first_gw;
 385   }
 386
 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;
 391     elm->size = size;
 392     xbt_dict_set_ext(as->route_cache, (char *) (&src_id), sizeof(int),
 393         (xbt_set_elm_t) elm, NULL);
 394   }
 395
 396   if (!as->cached)
 397     xbt_free(pred_arr);
 398 }
 399
 400 static void dijkstra_finalize(AS_t asg)
 401 {
 402   as_dijkstra_t as = (as_dijkstra_t) asg;
 403
 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);
 407   if (as->cached)
 408     xbt_dict_free(&as->route_cache);
 409
 410   model_generic_finalize(asg);
 411 }
 412
 413 /* Creation routing model functions */
 414
 415 AS_t model_dijkstra_both_create(int cached)
 416 {
 417   as_dijkstra_t new_component = (as_dijkstra_t)
 418           model_generic_create_sized(sizeof(s_as_dijkstra_t));
 419
 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;
 427
 428   return (AS_t)new_component;
 429 }
 430
 431 AS_t model_dijkstra_create(void)
 432 {
 433   return model_dijkstra_both_create(0);
 434 }
 435
 436 AS_t model_dijkstracache_create(void)
 437 {
 438   return model_dijkstra_both_create(1);
 439 }
 440
 441 void model_dijkstra_both_end(AS_t as)
 442 {
 443   as_dijkstra_t THIS_AS = (as_dijkstra_t) as;
 444
 445   xbt_node_t node = NULL;
 446   unsigned int cursor2;
 447   xbt_dynar_t nodes = NULL;
 448
 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);
 454
 455   if (THIS_AS->cached && !THIS_AS->route_cache)
 456     THIS_AS->route_cache = xbt_dict_new_homogeneous(&route_cache_elem_free);
 457
 458   /* Add the loopback if needed */
 459   if (global_routing->loopback && as->hierarchy == SURF_ROUTING_BASE)
 460     add_loopback_dijkstra(THIS_AS);
 461
 462   /* initialize graph indexes in nodes after graph has been built */
 463   nodes = xbt_graph_get_nodes(THIS_AS->route_graph);
 464
 465   xbt_dynar_foreach(nodes, cursor2, node) {
 466     graph_node_data_t data = xbt_graph_node_get_data(node);
 467     data->graph_id = cursor2;
 468   }
 469
 470 }
 471 void model_dijkstra_both_parse_route (AS_t asg, const char *src,
 472     const char *dst, route_t route)
 473 {
 474   int as_route = 0;
 475   if(!route->dst_gateway && !route->src_gateway)
 476     XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
 477   else{
 478     XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
 479         route->src_gateway->name, dst, route->dst_gateway->name);
 480     as_route = 1;
 481     if(route->dst_gateway->rc_type == SURF_NETWORK_ELEMENT_NULL)
 482       xbt_die("The dst_gateway '%s' does not exist!",route->dst_gateway->name);
 483     if(route->src_gateway->rc_type == SURF_NETWORK_ELEMENT_NULL)
 484       xbt_die("The src_gateway '%s' does not exist!",route->src_gateway->name);
 485   }
 486
 487   as_dijkstra_t as = (as_dijkstra_t) asg;
 488   sg_routing_edge_t src_net_elm, dst_net_elm;
 489
 490   src_net_elm = sg_routing_edge_by_name_or_null(src);
 491   dst_net_elm = sg_routing_edge_by_name_or_null(dst);
 492
 493   xbt_assert(src_net_elm, "Network elements %s not found", src);
 494   xbt_assert(dst_net_elm, "Network elements %s not found", dst);
 495
 496   /* Create the topology graph */
 497   if(!as->route_graph)
 498     as->route_graph = xbt_graph_new_graph(1, NULL);
 499   if(!as->graph_node_map)
 500     as->graph_node_map = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
 501
 502   if (as->cached && !as->route_cache)
 503     as->route_cache = xbt_dict_new_homogeneous(&route_cache_elem_free);
 504
 505   route_t e_route = generic_new_extended_route(asg->hierarchy, route, 1);
 506   route_new_dijkstra(as, src_net_elm->id, dst_net_elm->id, e_route);
 507
 508   // Symmetrical YES
 509   if ( (A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES && as_route == 0)
 510       || (A_surfxml_ASroute_symmetrical == A_surfxml_ASroute_symmetrical_YES && as_route == 1)
 511   )
 512   {
 513     if(!route->dst_gateway && !route->src_gateway)
 514       XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dst, src);
 515     else
 516       XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", dst,
 517           route->dst_gateway->name, src, route->src_gateway->name);
 518
 519     xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
 520     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_net_elm->id, xbt_node_t);
 521     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_net_elm->id, xbt_node_t);
 522     xbt_edge_t edge =
 523         xbt_graph_get_edge(as->route_graph, node_e_v, node_s_v);
 524
 525     if (edge)
 526       THROWF(arg_error,0,"(AS)Route from '%s' to '%s' already exists",src,dst);
 527
 528     if (route->dst_gateway && route->src_gateway) {
 529       sg_routing_edge_t gw_tmp;
 530       gw_tmp = route->src_gateway;
 531       route->src_gateway = route->dst_gateway;
 532       route->dst_gateway = gw_tmp;
 533     }
 534     route_t link_route_back = generic_new_extended_route(asg->hierarchy, route, 0);
 535     route_new_dijkstra(as, dst_net_elm->id, src_net_elm->id, link_route_back);
 536   }
 537 }