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, &graph_node_map_elem_free);
  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(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);
 164     }
 165   }
 166 }
 167
 168 static void dijkstra_get_route(AS_t as_generic,
 169         const char *src, const char *dst, route_t route);
 170
 171 static xbt_dynar_t dijkstra_get_onelink_routes(AS_t as)
 172 {
 173  // xbt_die("\"dijkstra_get_onelink_routes\" function not implemented yet");
 174           xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
 175
 176           //size_t table_size = xbt_dict_length(routing->generic_routing.to_index);
 177           xbt_dict_cursor_t c1 = NULL, c2 = NULL;
 178           char *k1, *d1, *k2, *d2;
 179           xbt_dict_foreach(as->to_index, c1, k1, d1) {
 180             xbt_dict_foreach(as->to_index, c2, k2, d2) {
 181               route_t route = xbt_new0(s_route_t,1);
 182               route->link_list = xbt_dynar_new(global_routing->size_of_link,NULL);
 183               dijkstra_get_route(as, k1, k2,route);
 184
 185               if (xbt_dynar_length(route->link_list) == 1) {
 186                 void *link =
 187                     *(void **) xbt_dynar_get_ptr(route->link_list, 0);
 188                 onelink_t onelink = xbt_new0(s_onelink_t, 1);
 189                 onelink->link_ptr = link;
 190                 if (as->hierarchy == SURF_ROUTING_BASE) {
 191                   onelink->src = xbt_strdup(k1);
 192                   onelink->dst = xbt_strdup(k2);
 193                 } else if (as->hierarchy ==
 194                     SURF_ROUTING_RECURSIVE) {
 195                   onelink->src = xbt_strdup(route->src_gateway);
 196                   onelink->dst = xbt_strdup(route->dst_gateway);
 197                 }
 198                 xbt_dynar_push(ret, &onelink);
 199               }
 200             }
 201           }
 202           return ret;
 203 }
 204
 205 static void dijkstra_get_route(AS_t asg,
 206                                const char *src, const char *dst,
 207                                route_t route)
 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 = xbt_dict_get_or_null(asg->to_index, src);
 215   int *dst_id = xbt_dict_get_or_null(asg->to_index, dst);
 216   if (!src_id || !dst_id)
 217     THROWF(arg_error,0,"No route from '%s' to '%s'",src,dst);
 218
 219   int *pred_arr = NULL;
 220   int src_node_id = 0;
 221   int dst_node_id = 0;
 222   int *nodeid = NULL;
 223   int v;
 224   route_t e_route;
 225   int size = 0;
 226   unsigned int cpt;
 227   void *link;
 228   xbt_dynar_t links = NULL;
 229   route_cache_element_t elm = NULL;
 230   xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
 231
 232   /* Use the graph_node id mapping set to quickly find the nodes */
 233   graph_node_map_element_t src_elm =
 234       graph_node_map_search(as, *src_id);
 235   graph_node_map_element_t dst_elm =
 236       graph_node_map_search(as, *dst_id);
 237
 238   src_node_id = ((graph_node_data_t)
 239                  xbt_graph_node_get_data(src_elm->node))->graph_id;
 240   dst_node_id = ((graph_node_data_t)
 241                  xbt_graph_node_get_data(dst_elm->node))->graph_id;
 242
 243   /* if the src and dst are the same */
 244   if (src_node_id == dst_node_id) {
 245
 246     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
 247     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
 248     xbt_edge_t edge =
 249         xbt_graph_get_edge(as->route_graph, node_s_v, node_e_v);
 250
 251     if (edge == NULL)
 252       THROWF(arg_error,0,"No route from '%s' to '%s'",src,dst);
 253
 254     e_route = (route_t) xbt_graph_edge_get_data(edge);
 255
 256     links = e_route->link_list;
 257     xbt_dynar_foreach(links, cpt, link) {
 258       xbt_dynar_unshift(route->link_list, &link);
 259     }
 260
 261   }
 262
 263   if (as->cached) {
 264     /*check if there is a cached predecessor list avail */
 265     elm = (route_cache_element_t)
 266         xbt_dict_get_or_null_ext(as->route_cache, (char *) (&src_id),
 267                                  sizeof(int));
 268   }
 269
 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;
 275     int i = 0;
 276
 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);
 281
 282     /* initialize */
 283     cost_arr[src_node_id] = 0.0;
 284
 285     for (i = 0; i < nr_nodes; i++) {
 286       if (i != src_node_id) {
 287         cost_arr[i] = DBL_MAX;
 288       }
 289
 290       pred_arr[i] = 0;
 291
 292       /* initialize priority queue */
 293       nodeid = xbt_new0(int, 1);
 294       *nodeid = i;
 295       xbt_heap_push(pqueue, nodeid, cost_arr[i]);
 296
 297     }
 298
 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;
 305       unsigned int cursor;
 306
 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_t tmp_e_route = (route_t) xbt_graph_edge_get_data(edge);
 312         int cost_v_u = (tmp_e_route->link_list)->used;    /* count of links, old model assume 1 */
 313
 314         if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
 315           pred_arr[u_id] = *v_id;
 316           cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
 317           nodeid = xbt_new0(int, 1);
 318           *nodeid = u_id;
 319           xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
 320         }
 321       }
 322
 323       /* free item popped from pqueue */
 324       xbt_free(v_id);
 325     }
 326
 327     xbt_free(cost_arr);
 328     xbt_heap_free(pqueue);
 329   }
 330
 331   /* compose route path with links */
 332   char *gw_src = NULL, *gw_dst = NULL, *prev_gw_src, *first_gw = NULL;
 333
 334   for (v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
 335     xbt_node_t node_pred_v =
 336         xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
 337     xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
 338     xbt_edge_t edge =
 339         xbt_graph_get_edge(as->route_graph, node_pred_v, node_v);
 340
 341     if (edge == NULL)
 342       THROWF(arg_error,0,"No route from '%s' to '%s'",src,dst);
 343
 344     prev_gw_src = gw_src;
 345
 346     e_route = (route_t) xbt_graph_edge_get_data(edge);
 347     gw_src = e_route->src_gateway;
 348     gw_dst = e_route->dst_gateway;
 349
 350     if (v == dst_node_id)
 351       first_gw = gw_dst;
 352
 353     if (asg->hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
 354         && strcmp(gw_dst, prev_gw_src)) {
 355       xbt_dynar_t e_route_as_to_as=NULL;
 356       routing_get_route_and_latency(gw_dst, prev_gw_src,&e_route_as_to_as,NULL);
 357       if (edge == NULL)
 358         THROWF(arg_error,0,"No route from '%s' to '%s'",src,dst);
 359       links = e_route_as_to_as;
 360       int pos = 0;
 361       xbt_dynar_foreach(links, cpt, link) {
 362         xbt_dynar_insert_at(route->link_list, pos, &link);
 363         pos++;
 364       }
 365     }
 366
 367     links = e_route->link_list;
 368     xbt_dynar_foreach(links, cpt, link) {
 369       xbt_dynar_unshift(route->link_list, &link);
 370     }
 371     size++;
 372   }
 373
 374   if (asg->hierarchy == SURF_ROUTING_RECURSIVE) {
 375     route->src_gateway = xbt_strdup(gw_src);
 376     route->dst_gateway = xbt_strdup(first_gw);
 377   }
 378
 379   if (as->cached && elm == NULL) {
 380     /* add to predecessor list of the current src-host to cache */
 381     elm = xbt_new0(struct route_cache_element, 1);
 382     elm->pred_arr = pred_arr;
 383     elm->size = size;
 384     xbt_dict_set_ext(as->route_cache, (char *) (&src_id), sizeof(int),
 385                      (xbt_set_elm_t) elm, &route_cache_elem_free);
 386   }
 387
 388   if (!as->cached)
 389     xbt_free(pred_arr);
 390 }
 391
 392 static void dijkstra_finalize(AS_t asg)
 393 {
 394   as_dijkstra_t as = (as_dijkstra_t) asg;
 395
 396   xbt_graph_free_graph(as->route_graph, &xbt_free,
 397       &graph_edge_data_free, &xbt_free);
 398   xbt_dict_free(&as->graph_node_map);
 399   if (as->cached)
 400     xbt_dict_free(&as->route_cache);
 401
 402   model_generic_finalize(asg);
 403 }
 404
 405 /* Creation routing model functions */
 406
 407 AS_t model_dijkstra_both_create(int cached)
 408 {
 409   as_dijkstra_t new_component = (as_dijkstra_t)
 410       model_generic_create_sized(sizeof(s_as_dijkstra_t));
 411
 412   new_component->generic_routing.parse_route = model_dijkstra_both_parse_route;
 413   new_component->generic_routing.parse_ASroute = model_dijkstra_both_parse_route;
 414   new_component->generic_routing.get_route = dijkstra_get_route;
 415   new_component->generic_routing.get_onelink_routes =
 416       dijkstra_get_onelink_routes;
 417   new_component->generic_routing.finalize = dijkstra_finalize;
 418   new_component->cached = cached;
 419
 420   return (AS_t)new_component;
 421 }
 422
 423 AS_t model_dijkstra_create(void)
 424 {
 425   return model_dijkstra_both_create(0);
 426 }
 427
 428 AS_t model_dijkstracache_create(void)
 429 {
 430   return model_dijkstra_both_create(1);
 431 }
 432
 433 void model_dijkstra_both_end(AS_t as)
 434 {
 435   as_dijkstra_t THIS = (as_dijkstra_t) as;
 436
 437   xbt_node_t node = NULL;
 438   unsigned int cursor2;
 439   xbt_dynar_t nodes = NULL;
 440
 441   /* Create the topology graph */
 442   if(!THIS->route_graph)
 443   THIS->route_graph = xbt_graph_new_graph(1, NULL);
 444   if(!THIS->graph_node_map)
 445   THIS->graph_node_map = xbt_dict_new();
 446
 447   if (THIS->cached && !THIS->route_cache)
 448   THIS->route_cache = xbt_dict_new();
 449
 450   /* Add the loopback if needed */
 451   if (as->hierarchy == SURF_ROUTING_BASE)
 452     add_loopback_dijkstra(THIS);
 453
 454   /* initialize graph indexes in nodes after graph has been built */
 455   nodes = xbt_graph_get_nodes(THIS->route_graph);
 456
 457   xbt_dynar_foreach(nodes, cursor2, node) {
 458     graph_node_data_t data = xbt_graph_node_get_data(node);
 459     data->graph_id = cursor2;
 460   }
 461
 462 }
 463 void model_dijkstra_both_parse_route (AS_t asg, const char *src,
 464                      const char *dst, route_t route)
 465 {
 466         as_dijkstra_t as = (as_dijkstra_t) asg;
 467         int *src_id, *dst_id;
 468         src_id = xbt_dict_get_or_null(asg->to_index, src);
 469         dst_id = xbt_dict_get_or_null(asg->to_index, dst);
 470
 471         xbt_assert(src_id, "Network elements %s not found", src);
 472         xbt_assert(dst_id, "Network elements %s not found", dst);
 473
 474     /* Create the topology graph */
 475         if(!as->route_graph)
 476         as->route_graph = xbt_graph_new_graph(1, NULL);
 477         if(!as->graph_node_map)
 478         as->graph_node_map = xbt_dict_new();
 479
 480         if (as->cached && !as->route_cache)
 481         as->route_cache = xbt_dict_new();
 482
 483         if( A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES
 484                 || A_surfxml_ASroute_symmetrical == A_surfxml_ASroute_symmetrical_YES )
 485                 xbt_die("Route symmetrical not supported on model dijkstra");
 486
 487         if(!route->dst_gateway && !route->src_gateway)
 488           XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
 489         else{
 490           XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
 491                          route->src_gateway, dst, route->dst_gateway);
 492           if(routing_get_network_element_type((const char*)route->dst_gateway) == SURF_NETWORK_ELEMENT_NULL)
 493                   xbt_die("The dst_gateway '%s' does not exist!",route->dst_gateway);
 494           if(routing_get_network_element_type((const char*)route->src_gateway) == SURF_NETWORK_ELEMENT_NULL)
 495                   xbt_die("The src_gateway '%s' does not exist!",route->src_gateway);
 496         }
 497
 498         route_t e_route = generic_new_extended_route(asg->hierarchy, route, 1);
 499         route_new_dijkstra(as, *src_id, *dst_id, e_route);
 500 }