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 extern AS_t current_routing;
  12 extern routing_model_description_t current_routing_model;
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
  15
  16 typedef struct {
  17   s_as_t generic_routing;
  18   xbt_graph_t route_graph;      /* xbt_graph */
  19   xbt_dict_t graph_node_map;    /* map */
  20   xbt_dict_t route_cache;       /* use in cache mode */
  21   int cached;
  22 } s_as_dijkstra_t, *as_dijkstra_t;
  23
  24
  25 typedef struct graph_node_data {
  26   int id;
  27   int graph_id;                 /* used for caching internal graph id's */
  28 } s_graph_node_data_t, *graph_node_data_t;
  29
  30 typedef struct graph_node_map_element {
  31   xbt_node_t node;
  32 } s_graph_node_map_element_t, *graph_node_map_element_t;
  33
  34 typedef struct route_cache_element {
  35   int *pred_arr;
  36   int size;
  37 } s_route_cache_element_t, *route_cache_element_t;
  38
  39 /* Free functions */
  40
  41 static void route_cache_elem_free(void *e)
  42 {
  43   route_cache_element_t elm = (route_cache_element_t) e;
  44   if (elm) {
  45     xbt_free(elm->pred_arr);
  46     xbt_free(elm);
  47   }
  48 }
  49
  50 static void graph_node_map_elem_free(void *e)
  51 {
  52   graph_node_map_element_t elm = (graph_node_map_element_t) e;
  53   xbt_free(elm);
  54 }
  55
  56 static void graph_edge_data_free(void *e)
  57 {
  58   route_extended_t e_route = (route_extended_t) e;
  59   if (e_route) {
  60     xbt_dynar_free(&(e_route->generic_route.link_list));
  61     xbt_free(e_route->src_gateway);
  62     xbt_free(e_route->dst_gateway);
  63     xbt_free(e_route);
  64   }
  65 }
  66
  67 /* Utility functions */
  68
  69 static xbt_node_t route_graph_new_node(as_dijkstra_t as,
  70                                        int id, int graph_id)
  71 {
  72   xbt_node_t node = NULL;
  73   graph_node_data_t data = NULL;
  74   graph_node_map_element_t elm = NULL;
  75
  76   data = xbt_new0(struct graph_node_data, 1);
  77   data->id = id;
  78   data->graph_id = graph_id;
  79   node = xbt_graph_new_node(as->route_graph, data);
  80
  81   elm = xbt_new0(struct graph_node_map_element, 1);
  82   elm->node = node;
  83   xbt_dict_set_ext(as->graph_node_map, (char *) (&id), sizeof(int),
  84                    (xbt_set_elm_t) elm, &graph_node_map_elem_free);
  85
  86   return node;
  87 }
  88
  89 static graph_node_map_element_t
  90 graph_node_map_search(as_dijkstra_t as, int id)
  91 {
  92   graph_node_map_element_t elm = (graph_node_map_element_t)
  93       xbt_dict_get_or_null_ext(as->graph_node_map,
  94                                (char *) (&id),
  95                                sizeof(int));
  96   return elm;
  97 }
  98
  99 /* Parsing */
 100
 101 static void route_new_dijkstra(as_dijkstra_t as, int src_id,
 102                                int dst_id, route_extended_t e_route)
 103 {
 104   XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
 105   xbt_node_t src = NULL;
 106   xbt_node_t dst = NULL;
 107
 108   graph_node_map_element_t src_elm = (graph_node_map_element_t)
 109       xbt_dict_get_or_null_ext(as->graph_node_map,
 110                                (char *) (&src_id),
 111                                sizeof(int));
 112   graph_node_map_element_t dst_elm = (graph_node_map_element_t)
 113       xbt_dict_get_or_null_ext(as->graph_node_map,
 114                                (char *) (&dst_id),
 115                                sizeof(int));
 116
 117
 118   if (src_elm)
 119     src = src_elm->node;
 120
 121   if (dst_elm)
 122     dst = dst_elm->node;
 123
 124   /* add nodes if they don't exist in the graph */
 125   if (src_id == dst_id && src == NULL && dst == NULL) {
 126     src = route_graph_new_node(as, src_id, -1);
 127     dst = src;
 128   } else {
 129     if (src == NULL) {
 130       src = route_graph_new_node(as, src_id, -1);
 131     }
 132     if (dst == NULL) {
 133       dst = route_graph_new_node(as, dst_id, -1);
 134     }
 135   }
 136
 137   /* add link as edge to graph */
 138   xbt_graph_new_edge(as->route_graph, src, dst, e_route);
 139 }
 140
 141 static void add_loopback_dijkstra(as_dijkstra_t as) {
 142   xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
 143
 144   xbt_node_t node = NULL;
 145   unsigned int cursor2;
 146   xbt_dynar_foreach(nodes, cursor2, node) {
 147     xbt_dynar_t out_edges = xbt_graph_node_get_outedges(node);
 148     xbt_edge_t edge = NULL;
 149     unsigned int cursor;
 150
 151     int found = 0;
 152     xbt_dynar_foreach(out_edges, cursor, edge) {
 153       xbt_node_t other_node = xbt_graph_edge_get_target(edge);
 154       if (other_node == node) {
 155         found = 1;
 156         break;
 157       }
 158     }
 159
 160     if (!found) {
 161       route_extended_t e_route = xbt_new0(s_route_extended_t, 1);
 162       e_route->src_gateway = NULL;
 163       e_route->dst_gateway = NULL;
 164       e_route->generic_route.link_list =
 165           xbt_dynar_new(global_routing->size_of_link, NULL);
 166       xbt_dynar_push(e_route->generic_route.link_list,
 167                      &global_routing->loopback);
 168       xbt_graph_new_edge(as->route_graph, node, node, e_route);
 169     }
 170   }
 171 }
 172
 173 static route_extended_t dijkstra_get_route(AS_t as_generic,
 174         const char *src,
 175         const char *dst);
 176
 177 static xbt_dynar_t dijkstra_get_onelink_routes(AS_t as)
 178 {
 179  // xbt_die("\"dijkstra_get_onelink_routes\" function not implemented yet");
 180           xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
 181
 182           //size_t table_size = xbt_dict_length(routing->generic_routing.to_index);
 183           xbt_dict_cursor_t c1 = NULL, c2 = NULL;
 184           char *k1, *d1, *k2, *d2;
 185           xbt_dict_foreach(as->to_index, c1, k1, d1) {
 186             xbt_dict_foreach(as->to_index, c2, k2, d2) {
 187               route_extended_t route = dijkstra_get_route(as, k1, k2);
 188               if (route) {
 189                 if (xbt_dynar_length(route->generic_route.link_list) == 1) {
 190                   void *link =
 191                       *(void **) xbt_dynar_get_ptr(route->generic_route.link_list,
 192                                                    0);
 193                   onelink_t onelink = xbt_new0(s_onelink_t, 1);
 194                   onelink->link_ptr = link;
 195                   if (as->hierarchy == SURF_ROUTING_BASE) {
 196                     onelink->src = xbt_strdup(k1);
 197                     onelink->dst = xbt_strdup(k2);
 198                   } else if (as->hierarchy ==
 199                              SURF_ROUTING_RECURSIVE) {
 200                     onelink->src = xbt_strdup(route->src_gateway);
 201                     onelink->dst = xbt_strdup(route->dst_gateway);
 202                   }
 203                   xbt_dynar_push(ret, &onelink);
 204                 }
 205               }
 206             }
 207           }
 208           return ret;
 209 }
 210
 211 static route_extended_t dijkstra_get_route(AS_t asg,
 212                                            const char *src,
 213                                            const char *dst)
 214 {
 215   xbt_assert(asg && src
 216               && dst,
 217               "Invalid params for \"get_route\" function at AS \"%s\"",
 218               asg->name);
 219
 220   /* set utils vars */
 221   as_dijkstra_t as = (as_dijkstra_t) asg;
 222
 223   generic_src_dst_check(asg, src, dst);
 224   int *src_id = xbt_dict_get_or_null(asg->to_index, src);
 225   int *dst_id = xbt_dict_get_or_null(asg->to_index, dst);
 226   xbt_assert(src_id
 227               && dst_id,
 228               "Ask for route \"from\"(%s)  or \"to\"(%s) no found in the local table",
 229               src, dst);
 230
 231   /* create a result route */
 232   route_extended_t new_e_route = xbt_new0(s_route_extended_t, 1);
 233   new_e_route->generic_route.link_list =
 234       xbt_dynar_new(global_routing->size_of_link, NULL);
 235   new_e_route->src_gateway = NULL;
 236   new_e_route->dst_gateway = NULL;
 237
 238   int *pred_arr = NULL;
 239   int src_node_id = 0;
 240   int dst_node_id = 0;
 241   int *nodeid = NULL;
 242   int v;
 243   route_extended_t e_route;
 244   int size = 0;
 245   unsigned int cpt;
 246   void *link;
 247   xbt_dynar_t links = NULL;
 248   route_cache_element_t elm = NULL;
 249   xbt_dynar_t nodes = xbt_graph_get_nodes(as->route_graph);
 250
 251   /* Use the graph_node id mapping set to quickly find the nodes */
 252   graph_node_map_element_t src_elm =
 253       graph_node_map_search(as, *src_id);
 254   graph_node_map_element_t dst_elm =
 255       graph_node_map_search(as, *dst_id);
 256   xbt_assert(src_elm != NULL
 257               && dst_elm != NULL, "src %d or dst %d does not exist",
 258               *src_id, *dst_id);
 259   src_node_id = ((graph_node_data_t)
 260                  xbt_graph_node_get_data(src_elm->node))->graph_id;
 261   dst_node_id = ((graph_node_data_t)
 262                  xbt_graph_node_get_data(dst_elm->node))->graph_id;
 263
 264   /* if the src and dst are the same *//* fixed, missing in the previous version */
 265   if (src_node_id == dst_node_id) {
 266
 267     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
 268     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
 269     xbt_edge_t edge =
 270         xbt_graph_get_edge(as->route_graph, node_s_v, node_e_v);
 271
 272     xbt_assert(edge != NULL, "no route between host %d and %d", *src_id,
 273                 *dst_id);
 274
 275     e_route = (route_extended_t) xbt_graph_edge_get_data(edge);
 276
 277     links = e_route->generic_route.link_list;
 278     xbt_dynar_foreach(links, cpt, link) {
 279       xbt_dynar_unshift(new_e_route->generic_route.link_list, &link);
 280     }
 281
 282     return new_e_route;
 283   }
 284
 285   if (as->cached) {
 286     /*check if there is a cached predecessor list avail */
 287     elm = (route_cache_element_t)
 288         xbt_dict_get_or_null_ext(as->route_cache, (char *) (&src_id),
 289                                  sizeof(int));
 290   }
 291
 292   if (elm) {                    /* cached mode and cache hit */
 293     pred_arr = elm->pred_arr;
 294   } else {                      /* not cached mode or cache miss */
 295     double *cost_arr = NULL;
 296     xbt_heap_t pqueue = NULL;
 297     int i = 0;
 298
 299     int nr_nodes = xbt_dynar_length(nodes);
 300     cost_arr = xbt_new0(double, nr_nodes);      /* link cost from src to other hosts */
 301     pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
 302     pqueue = xbt_heap_new(nr_nodes, xbt_free);
 303
 304     /* initialize */
 305     cost_arr[src_node_id] = 0.0;
 306
 307     for (i = 0; i < nr_nodes; i++) {
 308       if (i != src_node_id) {
 309         cost_arr[i] = DBL_MAX;
 310       }
 311
 312       pred_arr[i] = 0;
 313
 314       /* initialize priority queue */
 315       nodeid = xbt_new0(int, 1);
 316       *nodeid = i;
 317       xbt_heap_push(pqueue, nodeid, cost_arr[i]);
 318
 319     }
 320
 321     /* apply dijkstra using the indexes from the graph's node array */
 322     while (xbt_heap_size(pqueue) > 0) {
 323       int *v_id = xbt_heap_pop(pqueue);
 324       xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
 325       xbt_dynar_t out_edges = xbt_graph_node_get_outedges(v_node);
 326       xbt_edge_t edge = NULL;
 327       unsigned int cursor;
 328
 329       xbt_dynar_foreach(out_edges, cursor, edge) {
 330         xbt_node_t u_node = xbt_graph_edge_get_target(edge);
 331         graph_node_data_t data = xbt_graph_node_get_data(u_node);
 332         int u_id = data->graph_id;
 333         route_extended_t tmp_e_route =
 334             (route_extended_t) xbt_graph_edge_get_data(edge);
 335         int cost_v_u = (tmp_e_route->generic_route.link_list)->used;    /* count of links, old model assume 1 */
 336
 337         if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
 338           pred_arr[u_id] = *v_id;
 339           cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
 340           nodeid = xbt_new0(int, 1);
 341           *nodeid = u_id;
 342           xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
 343         }
 344       }
 345
 346       /* free item popped from pqueue */
 347       xbt_free(v_id);
 348     }
 349
 350     xbt_free(cost_arr);
 351     xbt_heap_free(pqueue);
 352   }
 353
 354   /* compose route path with links */
 355   char *gw_src = NULL, *gw_dst = NULL, *prev_gw_src, *first_gw = NULL;
 356
 357   for (v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
 358     xbt_node_t node_pred_v =
 359         xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
 360     xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
 361     xbt_edge_t edge =
 362         xbt_graph_get_edge(as->route_graph, node_pred_v, node_v);
 363
 364     xbt_assert(edge != NULL, "no route between host %d and %d", *src_id,
 365                 *dst_id);
 366
 367     prev_gw_src = gw_src;
 368
 369     e_route = (route_extended_t) xbt_graph_edge_get_data(edge);
 370     gw_src = e_route->src_gateway;
 371     gw_dst = e_route->dst_gateway;
 372
 373     if (v == dst_node_id)
 374       first_gw = gw_dst;
 375
 376     if (asg->hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
 377         && strcmp(gw_dst, prev_gw_src)) {
 378       xbt_dynar_t e_route_as_to_as =
 379           (*(global_routing->get_route)) (gw_dst, prev_gw_src);
 380       xbt_assert(e_route_as_to_as, "no route between \"%s\" and \"%s\"",
 381                   gw_dst, prev_gw_src);
 382       links = e_route_as_to_as;
 383       int pos = 0;
 384       xbt_dynar_foreach(links, cpt, link) {
 385         xbt_dynar_insert_at(new_e_route->generic_route.link_list, pos,
 386                             &link);
 387         pos++;
 388       }
 389     }
 390
 391     links = e_route->generic_route.link_list;
 392     xbt_dynar_foreach(links, cpt, link) {
 393       xbt_dynar_unshift(new_e_route->generic_route.link_list, &link);
 394     }
 395     size++;
 396   }
 397
 398   if (asg->hierarchy == SURF_ROUTING_RECURSIVE) {
 399     new_e_route->src_gateway = xbt_strdup(gw_src);
 400     new_e_route->dst_gateway = xbt_strdup(first_gw);
 401   }
 402
 403   if (as->cached && elm == NULL) {
 404     /* add to predecessor list of the current src-host to cache */
 405     elm = xbt_new0(struct route_cache_element, 1);
 406     elm->pred_arr = pred_arr;
 407     elm->size = size;
 408     xbt_dict_set_ext(as->route_cache, (char *) (&src_id), sizeof(int),
 409                      (xbt_set_elm_t) elm, &route_cache_elem_free);
 410   }
 411
 412   if (!as->cached)
 413     xbt_free(pred_arr);
 414
 415   return new_e_route;
 416 }
 417
 418 static void dijkstra_finalize(AS_t asg)
 419 {
 420   as_dijkstra_t as = (as_dijkstra_t) asg;
 421
 422   if (as) {
 423     xbt_graph_free_graph(as->route_graph, &xbt_free,
 424                          &graph_edge_data_free, &xbt_free);
 425     xbt_dict_free(&as->graph_node_map);
 426     if (as->cached)
 427       xbt_dict_free(&as->route_cache);
 428     /* Delete bypass dict */
 429     xbt_dict_free(&as->generic_routing.bypassRoutes);
 430     /* Delete index dict */
 431     xbt_dict_free(&(as->generic_routing.to_index));
 432     /* Delete structure */
 433     xbt_free(as);
 434   }
 435 }
 436
 437 /* Creation routing model functions */
 438
 439 AS_t model_dijkstra_both_create(int cached)
 440 {
 441   as_dijkstra_t new_component = (as_dijkstra_t)
 442       routmod_generic_create(sizeof(s_as_dijkstra_t));
 443
 444   new_component->generic_routing.parse_route = model_dijkstra_both_parse_route;
 445   new_component->generic_routing.parse_ASroute = model_dijkstra_both_parse_route;
 446   new_component->generic_routing.get_route = dijkstra_get_route;
 447   new_component->generic_routing.get_onelink_routes =
 448       dijkstra_get_onelink_routes;
 449   new_component->generic_routing.finalize = dijkstra_finalize;
 450   new_component->cached = cached;
 451
 452   return (AS_t)new_component;
 453 }
 454
 455 AS_t model_dijkstra_create(void)
 456 {
 457   return model_dijkstra_both_create(0);
 458 }
 459
 460 AS_t model_dijkstracache_create(void)
 461 {
 462   return model_dijkstra_both_create(1);
 463 }
 464
 465 void model_dijkstra_both_end(void)
 466 {
 467   as_dijkstra_t routing =
 468       (as_dijkstra_t) current_routing;
 469
 470   xbt_node_t node = NULL;
 471   unsigned int cursor2;
 472   xbt_dynar_t nodes = NULL;
 473
 474   /* Create the topology graph */
 475   if(!routing->route_graph)
 476   routing->route_graph = xbt_graph_new_graph(1, NULL);
 477   if(!routing->graph_node_map)
 478   routing->graph_node_map = xbt_dict_new();
 479
 480   if (routing->cached && !routing->route_cache)
 481   routing->route_cache = xbt_dict_new();
 482
 483   /* Add the loopback if needed */
 484   if (current_routing->hierarchy == SURF_ROUTING_BASE)
 485     add_loopback_dijkstra(routing);
 486
 487   /* initialize graph indexes in nodes after graph has been built */
 488   nodes = xbt_graph_get_nodes(routing->route_graph);
 489
 490   xbt_dynar_foreach(nodes, cursor2, node) {
 491     graph_node_data_t data = xbt_graph_node_get_data(node);
 492     data->graph_id = cursor2;
 493   }
 494
 495 }
 496 void model_dijkstra_both_parse_route (AS_t asg, const char *src,
 497                      const char *dst, route_extended_t route)
 498 {
 499         as_dijkstra_t as = (as_dijkstra_t) asg;
 500         int *src_id, *dst_id;
 501         src_id = xbt_dict_get_or_null(asg->to_index, src);
 502         dst_id = xbt_dict_get_or_null(asg->to_index, dst);
 503
 504         xbt_assert(src_id, "Network elements %s not found", src);
 505         xbt_assert(dst_id, "Network elements %s not found", dst);
 506
 507     /* Create the topology graph */
 508         if(!as->route_graph)
 509         as->route_graph = xbt_graph_new_graph(1, NULL);
 510         if(!as->graph_node_map)
 511         as->graph_node_map = xbt_dict_new();
 512
 513         if (as->cached && !as->route_cache)
 514         as->route_cache = xbt_dict_new();
 515
 516         if( A_surfxml_route_symmetrical == A_surfxml_route_symmetrical_YES
 517                 || A_surfxml_ASroute_symmetrical == A_surfxml_ASroute_symmetrical_YES )
 518                 xbt_die("Route symmetrical not supported on model dijkstra");
 519
 520         if(!route->dst_gateway && !route->src_gateway)
 521           XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
 522         else{
 523           XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
 524                          route->src_gateway, dst, route->dst_gateway);
 525           if(global_routing->get_network_element_type((const char*)route->dst_gateway) == SURF_NETWORK_ELEMENT_NULL)
 526                   xbt_die("The dst_gateway '%s' does not exist!",route->dst_gateway);
 527           if(global_routing->get_network_element_type((const char*)route->src_gateway) == SURF_NETWORK_ELEMENT_NULL)
 528                   xbt_die("The src_gateway '%s' does not exist!",route->src_gateway);
 529         }
 530
 531         route_extended_t e_route =
 532                 generic_new_extended_route(current_routing->hierarchy, route, 1);
 533         route_new_dijkstra(as, *src_id, *dst_id, e_route);
 534 }