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(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_and_latency(AS_t as_generic,
 169     network_element_t src, network_element_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           THROW_UNIMPLEMENTED;
 175 //        //size_t table_size = xbt_dict_length(routing->generic_routing.to_index);
 176 //        xbt_dict_cursor_t c1 = NULL, c2 = NULL;
 177 //        char *k1, *d1, *k2, *d2;
 178 //        xbt_dict_foreach(as->to_index, c1, k1, d1) {
 179 //          xbt_dict_foreach(as->to_index, c2, k2, d2) {
 180 //            route_t route = xbt_new0(s_route_t,1);
 181 //            route->link_list = xbt_dynar_new(global_routing->size_of_link,NULL);
 182 //            dijkstra_get_route_and_latency(as, k1, k2,route, NULL);
 183 //
 184 //            if (xbt_dynar_length(route->link_list) == 1) {
 185 //              void *link =
 186 //                  *(void **) xbt_dynar_get_ptr(route->link_list, 0);
 187 //              onelink_t onelink = xbt_new0(s_onelink_t, 1);
 188 //              onelink->link_ptr = link;
 189 //              if (as->hierarchy == SURF_ROUTING_BASE) {
 190 //                onelink->src = xbt_strdup(k1);
 191 //                onelink->dst = xbt_strdup(k2);
 192 //              } else if (as->hierarchy ==
 193 //                  SURF_ROUTING_RECURSIVE) {
 194 //                onelink->src = route->src_gateway;
 195 //                onelink->dst = route->dst_gateway;
 196 //              }
 197 //              xbt_dynar_push(ret, &onelink);
 198 //            }
 199 //          }
 200 //        }
 201           return ret;
 202 }
 203
 204 static void dijkstra_get_route_and_latency(AS_t asg,
 205     network_element_t src, network_element_t dst,
 206                                route_t route, double *lat)
 207 {
 208
 209   /* set utils vars */
 210   as_dijkstra_t as = (as_dijkstra_t) asg;
 211
 212   generic_src_dst_check(asg, src, dst);
 213   int *src_id = &(src->id);
 214   int *dst_id = &(dst->id);
 215
 216   if (!src_id || !dst_id)
 217     THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
 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->name,dst->name);
 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       if (lat)
 260         *lat += surf_network_model->extension.network.get_link_latency(link);
 261     }
 262
 263   }
 264
 265   if (as->cached) {
 266     /*check if there is a cached predecessor list avail */
 267     elm = (route_cache_element_t)
 268         xbt_dict_get_or_null_ext(as->route_cache, (char *) (&src_id),
 269                                  sizeof(int));
 270   }
 271
 272   if (elm) {                    /* cached mode and cache hit */
 273     pred_arr = elm->pred_arr;
 274   } else {                      /* not cached mode or cache miss */
 275     double *cost_arr = NULL;
 276     xbt_heap_t pqueue = NULL;
 277     int i = 0;
 278
 279     int nr_nodes = xbt_dynar_length(nodes);
 280     cost_arr = xbt_new0(double, nr_nodes);      /* link cost from src to other hosts */
 281     pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
 282     pqueue = xbt_heap_new(nr_nodes, xbt_free);
 283
 284     /* initialize */
 285     cost_arr[src_node_id] = 0.0;
 286
 287     for (i = 0; i < nr_nodes; i++) {
 288       if (i != src_node_id) {
 289         cost_arr[i] = DBL_MAX;
 290       }
 291
 292       pred_arr[i] = 0;
 293
 294       /* initialize priority queue */
 295       nodeid = xbt_new0(int, 1);
 296       *nodeid = i;
 297       xbt_heap_push(pqueue, nodeid, cost_arr[i]);
 298
 299     }
 300
 301     /* apply dijkstra using the indexes from the graph's node array */
 302     while (xbt_heap_size(pqueue) > 0) {
 303       int *v_id = xbt_heap_pop(pqueue);
 304       xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
 305       xbt_dynar_t out_edges = xbt_graph_node_get_outedges(v_node);
 306       xbt_edge_t edge = NULL;
 307       unsigned int cursor;
 308
 309       xbt_dynar_foreach(out_edges, cursor, edge) {
 310         xbt_node_t u_node = xbt_graph_edge_get_target(edge);
 311         graph_node_data_t data = xbt_graph_node_get_data(u_node);
 312         int u_id = data->graph_id;
 313         route_t tmp_e_route = (route_t) xbt_graph_edge_get_data(edge);
 314         int cost_v_u = (tmp_e_route->link_list)->used;    /* count of links, old model assume 1 */
 315
 316         if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
 317           pred_arr[u_id] = *v_id;
 318           cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
 319           nodeid = xbt_new0(int, 1);
 320           *nodeid = u_id;
 321           xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
 322         }
 323       }
 324
 325       /* free item popped from pqueue */
 326       xbt_free(v_id);
 327     }
 328
 329     xbt_free(cost_arr);
 330     xbt_heap_free(pqueue);
 331   }
 332
 333   /* compose route path with links */
 334   network_element_t gw_src, gw_dst, prev_gw_src, first_gw;
 335   network_element_t gw_dst_net_elm = NULL, prev_gw_src_net_elm = NULL;
 336
 337   for (v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
 338     xbt_node_t node_pred_v =
 339         xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
 340     xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
 341     xbt_edge_t edge =
 342         xbt_graph_get_edge(as->route_graph, node_pred_v, node_v);
 343
 344     if (edge == NULL)
 345       THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
 346
 347     prev_gw_src = gw_src;
 348
 349     e_route = (route_t) xbt_graph_edge_get_data(edge);
 350     gw_src = e_route->src_gateway;
 351     gw_dst = e_route->dst_gateway;
 352
 353     if (v == dst_node_id)
 354       first_gw = gw_dst;
 355
 356     if (asg->hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
 357         && strcmp(gw_dst->name, prev_gw_src->name)) {
 358       xbt_dynar_t e_route_as_to_as=NULL;
 359       routing_get_route_and_latency(gw_dst_net_elm, prev_gw_src_net_elm, &e_route_as_to_as, NULL);
 360       if (edge == NULL)
 361         THROWF(arg_error,0,"No route from '%s' to '%s'",src->name,dst->name);
 362       links = e_route_as_to_as;
 363       int pos = 0;
 364       xbt_dynar_foreach(links, cpt, link) {
 365         xbt_dynar_insert_at(route->link_list, pos, &link);
 366         if (lat)
 367           *lat += surf_network_model->extension.network.get_link_latency(link);
 368         pos++;
 369       }
 370     }
 371
 372     links = e_route->link_list;
 373     xbt_dynar_foreach(links, cpt, link) {
 374       xbt_dynar_unshift(route->link_list, &link);
 375       if (lat)
 376         *lat += surf_network_model->extension.network.get_link_latency(link);
 377     }
 378     size++;
 379   }
 380
 381   if (asg->hierarchy == SURF_ROUTING_RECURSIVE) {
 382     route->src_gateway = gw_src;
 383     route->dst_gateway = first_gw;
 384   }
 385
 386   if (as->cached && elm == NULL) {
 387     /* add to predecessor list of the current src-host to cache */
 388     elm = xbt_new0(struct route_cache_element, 1);
 389     elm->pred_arr = pred_arr;
 390     elm->size = size;
 391     xbt_dict_set_ext(as->route_cache, (char *) (&src_id), sizeof(int),
 392                      (xbt_set_elm_t) elm, NULL);
 393   }
 394
 395   if (!as->cached)
 396     xbt_free(pred_arr);
 397 }
 398
 399 static void dijkstra_finalize(AS_t asg)
 400 {
 401   as_dijkstra_t as = (as_dijkstra_t) asg;
 402
 403   xbt_graph_free_graph(as->route_graph, &xbt_free,
 404       &graph_edge_data_free, &xbt_free);
 405   xbt_dict_free(&as->graph_node_map);
 406   if (as->cached)
 407     xbt_dict_free(&as->route_cache);
 408
 409   model_generic_finalize(asg);
 410 }
 411
 412 /* Creation routing model functions */
 413
 414 AS_t model_dijkstra_both_create(int cached)
 415 {
 416   as_dijkstra_t new_component = (as_dijkstra_t)
 417       model_generic_create_sized(sizeof(s_as_dijkstra_t));
 418
 419   new_component->generic_routing.parse_route = model_dijkstra_both_parse_route;
 420   new_component->generic_routing.parse_ASroute = model_dijkstra_both_parse_route;
 421   new_component->generic_routing.get_route_and_latency = dijkstra_get_route_and_latency;
 422   new_component->generic_routing.get_onelink_routes =
 423       dijkstra_get_onelink_routes;
 424   new_component->generic_routing.finalize = dijkstra_finalize;
 425   new_component->cached = cached;
 426
 427   return (AS_t)new_component;
 428 }
 429
 430 AS_t model_dijkstra_create(void)
 431 {
 432   return model_dijkstra_both_create(0);
 433 }
 434
 435 AS_t model_dijkstracache_create(void)
 436 {
 437   return model_dijkstra_both_create(1);
 438 }
 439
 440 void model_dijkstra_both_end(AS_t as)
 441 {
 442   as_dijkstra_t THIS_AS = (as_dijkstra_t) as;
 443
 444   xbt_node_t node = NULL;
 445   unsigned int cursor2;
 446   xbt_dynar_t nodes = NULL;
 447
 448   /* Create the topology graph */
 449   if(!THIS_AS->route_graph)
 450   THIS_AS->route_graph = xbt_graph_new_graph(1, NULL);
 451   if(!THIS_AS->graph_node_map)
 452   THIS_AS->graph_node_map = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
 453
 454   if (THIS_AS->cached && !THIS_AS->route_cache)
 455   THIS_AS->route_cache = xbt_dict_new_homogeneous(&route_cache_elem_free);
 456
 457   /* Add the loopback if needed */
 458   if (global_routing->loopback && as->hierarchy == SURF_ROUTING_BASE)
 459     add_loopback_dijkstra(THIS_AS);
 460
 461   /* initialize graph indexes in nodes after graph has been built */
 462   nodes = xbt_graph_get_nodes(THIS_AS->route_graph);
 463
 464   xbt_dynar_foreach(nodes, cursor2, node) {
 465     graph_node_data_t data = xbt_graph_node_get_data(node);
 466     data->graph_id = cursor2;
 467   }
 468
 469 }
 470 void model_dijkstra_both_parse_route (AS_t asg, const char *src,
 471                      const char *dst, route_t route)
 472 {
 473         as_dijkstra_t as = (as_dijkstra_t) asg;
 474     network_element_t src_net_elm, dst_net_elm;
 475
 476     src_net_elm = (network_element_t)xbt_lib_get_or_null(host_lib, src, ROUTING_HOST_LEVEL);
 477     dst_net_elm = (network_element_t)xbt_lib_get_or_null(host_lib, dst, ROUTING_HOST_LEVEL);
 478     if(!src_net_elm) src_net_elm = (network_element_t)xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
 479     if(!dst_net_elm) dst_net_elm = (network_element_t)xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
 480
 481     xbt_assert(src_net_elm, "Network elements %s not found", src);
 482     xbt_assert(dst_net_elm, "Network elements %s not found", dst);
 483
 484     /* Create the topology graph */
 485         if(!as->route_graph)
 486         as->route_graph = xbt_graph_new_graph(1, NULL);
 487         if(!as->graph_node_map)
 488         as->graph_node_map = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
 489
 490         if (as->cached && !as->route_cache)
 491         as->route_cache = xbt_dict_new_homogeneous(&route_cache_elem_free);
 492
 493         if( A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES
 494                 || A_surfxml_ASroute_symmetrical == A_surfxml_ASroute_symmetrical_YES )
 495                 xbt_die("Route symmetrical not supported on model dijkstra");
 496
 497         if(!route->dst_gateway && !route->src_gateway)
 498           XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
 499         else{
 500           XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
 501                          route->src_gateway->name, dst, route->dst_gateway->name);
 502           if(route->dst_gateway->rc_type == SURF_NETWORK_ELEMENT_NULL)
 503                   xbt_die("The dst_gateway '%s' does not exist!",route->dst_gateway->name);
 504           if(route->src_gateway->rc_type == SURF_NETWORK_ELEMENT_NULL)
 505                   xbt_die("The src_gateway '%s' does not exist!",route->src_gateway->name);
 506         }
 507
 508         route_t e_route = generic_new_extended_route(asg->hierarchy, route, 1);
 509         route_new_dijkstra(as, src_net_elm->id, dst_net_elm->id, e_route);
 510 }