src/surf/surf_routing_dijkstra.cpp

   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_dijkstra.hpp"
   8 #include "surf_routing_private.h"
   9 #include "network.hpp"
  10
  11 /* Global vars */
  12 extern routing_platf_t routing_platf;
  13
  14 extern "C" {
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
  16 }
  17
  18 AS_t model_dijkstra_create(void){
  19   return new AsDijkstra(0);
  20 }
  21
  22 AS_t model_dijkstracache_create(void){
  23   return new AsDijkstra(1);
  24 }
  25
  26 void model_dijkstra_both_end(AS_t as)
  27 {
  28   delete as;
  29 }
  30
  31 /* Free functions */
  32
  33 static void route_cache_elem_free(void *e)
  34 {
  35   route_cache_element_t elm = (route_cache_element_t) e;
  36   if (elm) {
  37     xbt_free(elm->pred_arr);
  38     xbt_free(elm);
  39   }
  40 }
  41
  42 static void graph_node_map_elem_free(void *e)
  43 {
  44   graph_node_map_element_t elm = (graph_node_map_element_t) e;
  45   xbt_free(elm);
  46 }
  47
  48 static void graph_edge_data_free(void *e) // FIXME: useless code duplication
  49 {
  50   sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t) e;
  51   if (e_route) {
  52     xbt_dynar_free(&(e_route->link_list));
  53     xbt_free(e_route);
  54   }
  55 }
  56
  57 /* Utility functions */
  58
  59 xbt_node_t AsDijkstra::routeGraphNewNode(int id, int graph_id)
  60 {
  61   xbt_node_t node = NULL;
  62   graph_node_data_t data = NULL;
  63   graph_node_map_element_t elm = NULL;
  64
  65   data = xbt_new0(struct graph_node_data, 1);
  66   data->id = id;
  67   data->graph_id = graph_id;
  68   node = xbt_graph_new_node(p_routeGraph, data);
  69
  70   elm = xbt_new0(struct graph_node_map_element, 1);
  71   elm->node = node;
  72   xbt_dict_set_ext(p_graphNodeMap, (char *) (&id), sizeof(int),
  73       (xbt_set_elm_t) elm, NULL);
  74
  75   return node;
  76 }
  77
  78 graph_node_map_element_t AsDijkstra::nodeMapSearch(int id)
  79 {
  80   graph_node_map_element_t elm = (graph_node_map_element_t)
  81           xbt_dict_get_or_null_ext(p_graphNodeMap,
  82               (char *) (&id),
  83               sizeof(int));
  84   return elm;
  85 }
  86
  87 /* Parsing */
  88
  89 void AsDijkstra::newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route)
  90 {
  91   XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
  92   xbt_node_t src = NULL;
  93   xbt_node_t dst = NULL;
  94
  95   graph_node_map_element_t src_elm = (graph_node_map_element_t)
  96           xbt_dict_get_or_null_ext(p_graphNodeMap,
  97               (char *) (&src_id),
  98               sizeof(int));
  99   graph_node_map_element_t dst_elm = (graph_node_map_element_t)
 100           xbt_dict_get_or_null_ext(p_graphNodeMap,
 101               (char *) (&dst_id),
 102               sizeof(int));
 103
 104
 105   if (src_elm)
 106     src = src_elm->node;
 107
 108   if (dst_elm)
 109     dst = dst_elm->node;
 110
 111   /* add nodes if they don't exist in the graph */
 112   if (src_id == dst_id && src == NULL && dst == NULL) {
 113     src = this->routeGraphNewNode(src_id, -1);
 114     dst = src;
 115   } else {
 116     if (src == NULL) {
 117       src = this->routeGraphNewNode(src_id, -1);
 118     }
 119     if (dst == NULL) {
 120       dst = this->routeGraphNewNode(dst_id, -1);
 121     }
 122   }
 123
 124   /* add link as edge to graph */
 125   xbt_graph_new_edge(p_routeGraph, src, dst, e_route);
 126 }
 127
 128 void AsDijkstra::addLoopback() {
 129   xbt_dynar_t nodes = xbt_graph_get_nodes(p_routeGraph);
 130
 131   xbt_node_t node = NULL;
 132   unsigned int cursor2;
 133   xbt_dynar_foreach(nodes, cursor2, node) {
 134     xbt_dynar_t out_edges = xbt_graph_node_get_outedges(node);
 135     xbt_edge_t edge = NULL;
 136     unsigned int cursor;
 137
 138     int found = 0;
 139     xbt_dynar_foreach(out_edges, cursor, edge) {
 140       xbt_node_t other_node = xbt_graph_edge_get_target(edge);
 141       if (other_node == node) {
 142         found = 1;
 143         break;
 144       }
 145     }
 146
 147     if (!found) {
 148       sg_platf_route_cbarg_t e_route = xbt_new0(s_sg_platf_route_cbarg_t, 1);
 149       e_route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
 150       xbt_dynar_push(e_route->link_list, &routing_platf->p_loopback);
 151       xbt_graph_new_edge(p_routeGraph, node, node, e_route);
 152     }
 153   }
 154 }
 155
 156 xbt_dynar_t AsDijkstra::getOnelinkRoutes()
 157 {
 158   xbt_dynar_t ret = xbt_dynar_new(sizeof(OnelinkPtr), xbt_free);
 159   sg_platf_route_cbarg_t route = xbt_new0(s_sg_platf_route_cbarg_t,1);
 160   route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
 161
 162   int src,dst;
 163   RoutingEdgePtr src_elm, dst_elm;
 164   size_t table_size = xbt_dynar_length(p_indexNetworkElm);
 165   for(src=0; src < table_size; src++) {
 166     for(dst=0; dst< table_size; dst++) {
 167       xbt_dynar_reset(route->link_list);
 168       src_elm = xbt_dynar_get_as(p_indexNetworkElm, src, RoutingEdgePtr);
 169       dst_elm = xbt_dynar_get_as(p_indexNetworkElm, dst, RoutingEdgePtr);
 170       this->getRouteAndLatency(src_elm, dst_elm,route, NULL);
 171
 172       if (xbt_dynar_length(route->link_list) == 1) {
 173         void *link = *(void **) xbt_dynar_get_ptr(route->link_list, 0);
 174         OnelinkPtr onelink = new Onelink();
 175         onelink->p_linkPtr = link;
 176         if (p_hierarchy == SURF_ROUTING_BASE) {
 177           onelink->p_src = src_elm;
 178           onelink->p_dst = dst_elm;
 179         } else if (p_hierarchy == SURF_ROUTING_RECURSIVE) {
 180           onelink->p_src = route->gw_src;
 181           onelink->p_dst = route->gw_dst;
 182         }
 183         xbt_dynar_push(ret, &onelink);
 184       }
 185     }
 186   }
 187   return ret;
 188 }
 189
 190 void AsDijkstra::getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, sg_platf_route_cbarg_t route, double *lat)
 191 {
 192
 193   /* set utils vars */
 194
 195   srcDstCheck(src, dst);
 196   int *src_id = &(src->m_id);
 197   int *dst_id = &(dst->m_id);
 198
 199   if (!src_id || !dst_id)
 200     THROWF(arg_error,0,"No route from '%s' to '%s'",src->p_name,dst->p_name);
 201
 202   int *pred_arr = NULL;
 203   int src_node_id = 0;
 204   int dst_node_id = 0;
 205   int *nodeid = NULL;
 206   int v;
 207   sg_platf_route_cbarg_t e_route;
 208   int size = 0;
 209   unsigned int cpt;
 210   void *link;
 211   xbt_dynar_t links = NULL;
 212   route_cache_element_t elm = NULL;
 213   xbt_dynar_t nodes = xbt_graph_get_nodes(p_routeGraph);
 214
 215   /* Use the graph_node id mapping set to quickly find the nodes */
 216   graph_node_map_element_t src_elm = nodeMapSearch(*src_id);
 217   graph_node_map_element_t dst_elm = nodeMapSearch(*dst_id);
 218
 219   src_node_id = ((graph_node_data_t)
 220       xbt_graph_node_get_data(src_elm->node))->graph_id;
 221   dst_node_id = ((graph_node_data_t)
 222       xbt_graph_node_get_data(dst_elm->node))->graph_id;
 223
 224   /* if the src and dst are the same */
 225   if (src_node_id == dst_node_id) {
 226
 227     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
 228     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
 229     xbt_edge_t edge = xbt_graph_get_edge(p_routeGraph, node_s_v, node_e_v);
 230
 231     if (edge == NULL)
 232       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->p_name, dst->p_name);
 233
 234     e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
 235
 236     links = e_route->link_list;
 237     xbt_dynar_foreach(links, cpt, link) {
 238       xbt_dynar_unshift(route->link_list, &link);
 239       if (lat)
 240         *lat += dynamic_cast<NetworkCm02LinkPtr>(static_cast<ResourcePtr>(link))->getLatency();
 241     }
 242
 243   }
 244
 245   if (m_cached) {
 246     /*check if there is a cached predecessor list avail */
 247     elm = (route_cache_element_t)
 248             xbt_dict_get_or_null_ext(p_routeCache, (char *) (&src_id),
 249                 sizeof(int));
 250   }
 251
 252   if (elm) {                    /* cached mode and cache hit */
 253     pred_arr = elm->pred_arr;
 254   } else {                      /* not cached mode or cache miss */
 255     double *cost_arr = NULL;
 256     xbt_heap_t pqueue = NULL;
 257     int i = 0;
 258
 259     int nr_nodes = xbt_dynar_length(nodes);
 260     cost_arr = xbt_new0(double, nr_nodes);      /* link cost from src to other hosts */
 261     pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
 262     pqueue = xbt_heap_new(nr_nodes, xbt_free);
 263
 264     /* initialize */
 265     cost_arr[src_node_id] = 0.0;
 266
 267     for (i = 0; i < nr_nodes; i++) {
 268       if (i != src_node_id) {
 269         cost_arr[i] = DBL_MAX;
 270       }
 271
 272       pred_arr[i] = 0;
 273
 274       /* initialize priority queue */
 275       nodeid = xbt_new0(int, 1);
 276       *nodeid = i;
 277       xbt_heap_push(pqueue, nodeid, cost_arr[i]);
 278
 279     }
 280
 281     /* apply dijkstra using the indexes from the graph's node array */
 282     while (xbt_heap_size(pqueue) > 0) {
 283       int *v_id = (int *) xbt_heap_pop(pqueue);
 284       xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
 285       xbt_dynar_t out_edges = xbt_graph_node_get_outedges(v_node);
 286       xbt_edge_t edge = NULL;
 287       unsigned int cursor;
 288
 289       xbt_dynar_foreach(out_edges, cursor, edge) {
 290         xbt_node_t u_node = xbt_graph_edge_get_target(edge);
 291         graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(u_node);
 292         int u_id = data->graph_id;
 293         sg_platf_route_cbarg_t tmp_e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
 294         int cost_v_u = (tmp_e_route->link_list)->used;    /* count of links, old model assume 1 */
 295
 296         if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
 297           pred_arr[u_id] = *v_id;
 298           cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
 299           nodeid = xbt_new0(int, 1);
 300           *nodeid = u_id;
 301           xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
 302         }
 303       }
 304
 305       /* free item popped from pqueue */
 306       xbt_free(v_id);
 307     }
 308
 309     xbt_free(cost_arr);
 310     xbt_heap_free(pqueue);
 311   }
 312
 313   /* compose route path with links */
 314   RoutingEdgePtr gw_src = NULL, gw_dst, prev_gw_src, first_gw = NULL;
 315   RoutingEdgePtr gw_dst_net_elm = NULL, prev_gw_src_net_elm = NULL;
 316
 317   for (v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
 318     xbt_node_t node_pred_v =
 319         xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
 320     xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
 321     xbt_edge_t edge =
 322         xbt_graph_get_edge(p_routeGraph, node_pred_v, node_v);
 323
 324     if (edge == NULL)
 325       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->p_name, dst->p_name);
 326
 327     prev_gw_src = gw_src;
 328
 329     e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
 330     gw_src = e_route->gw_src;
 331     gw_dst = e_route->gw_dst;
 332
 333     if (v == dst_node_id)
 334       first_gw = gw_dst;
 335
 336     if (p_hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
 337         && strcmp(gw_dst->p_name, prev_gw_src->p_name)) {
 338       xbt_dynar_t e_route_as_to_as=NULL;
 339
 340       routing_platf->getRouteAndLatency(gw_dst_net_elm, prev_gw_src_net_elm, &e_route_as_to_as, NULL);
 341       if (edge == NULL)
 342         THROWF(arg_error,0,"No route from '%s' to '%s'", src->p_name, dst->p_name);
 343       links = e_route_as_to_as;
 344       int pos = 0;
 345       xbt_dynar_foreach(links, cpt, link) {
 346         xbt_dynar_insert_at(route->link_list, pos, &link);
 347         if (lat)
 348           *lat += dynamic_cast<NetworkCm02LinkPtr>(static_cast<ResourcePtr>(link))->getLatency();
 349         pos++;
 350       }
 351     }
 352
 353     links = e_route->link_list;
 354     xbt_dynar_foreach(links, cpt, link) {
 355       xbt_dynar_unshift(route->link_list, &link);
 356       if (lat)
 357         *lat += dynamic_cast<NetworkCm02LinkPtr>(static_cast<ResourcePtr>(link))->getLatency();
 358     }
 359     size++;
 360   }
 361
 362   if (p_hierarchy == SURF_ROUTING_RECURSIVE) {
 363     route->gw_src = gw_src;
 364     route->gw_dst = first_gw;
 365   }
 366
 367   if (m_cached && elm == NULL) {
 368     /* add to predecessor list of the current src-host to cache */
 369     elm = xbt_new0(struct route_cache_element, 1);
 370     elm->pred_arr = pred_arr;
 371     elm->size = size;
 372     xbt_dict_set_ext(p_routeCache, (char *) (&src_id), sizeof(int),
 373         (xbt_set_elm_t) elm, NULL);
 374   }
 375
 376   if (!m_cached)
 377     xbt_free(pred_arr);
 378 }
 379
 380 AsDijkstra::~AsDijkstra()
 381 {
 382   xbt_graph_free_graph(p_routeGraph, &xbt_free,
 383       &graph_edge_data_free, &xbt_free);
 384   xbt_dict_free(&p_graphNodeMap);
 385   if (m_cached)
 386     xbt_dict_free(&p_routeCache);
 387 }
 388
 389 /* Creation routing model functions */
 390
 391 AsDijkstra::AsDijkstra() : AsGeneric(), m_cached(0) {}
 392
 393 AsDijkstra::AsDijkstra(int cached) : AsGeneric(), m_cached(cached)
 394 {
 395   /*new_component->generic_routing.parse_route = model_dijkstra_both_parse_route;
 396   new_component->generic_routing.parse_ASroute = model_dijkstra_both_parse_route;
 397   new_component->generic_routing.get_route_and_latency = dijkstra_get_route_and_latency;
 398   new_component->generic_routing.get_onelink_routes =
 399       dijkstra_get_onelink_routes;
 400   new_component->generic_routing.get_graph = generic_get_graph;
 401   new_component->generic_routing.finalize = dijkstra_finalize;
 402   new_component->cached = cached;*/
 403 }
 404
 405 void AsDijkstra::end()
 406 {
 407   xbt_node_t node = NULL;
 408   unsigned int cursor2;
 409   xbt_dynar_t nodes = NULL;
 410
 411   /* Create the topology graph */
 412   if(!p_routeGraph)
 413         p_routeGraph = xbt_graph_new_graph(1, NULL);
 414   if(!p_graphNodeMap)
 415     p_graphNodeMap = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
 416
 417   if (m_cached && p_routeCache)
 418     p_routeCache = xbt_dict_new_homogeneous(&route_cache_elem_free);
 419
 420   /* Add the loopback if needed */
 421   if (routing_platf->p_loopback && p_hierarchy == SURF_ROUTING_BASE)
 422     addLoopback();
 423
 424   /* initialize graph indexes in nodes after graph has been built */
 425   nodes = xbt_graph_get_nodes(p_routeGraph);
 426
 427   xbt_dynar_foreach(nodes, cursor2, node) {
 428     graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(node);
 429     data->graph_id = cursor2;
 430   }
 431
 432 }
 433 void AsDijkstra::parseRoute(sg_platf_route_cbarg_t route)
 434 {
 435   char *src = (char*)(route->src);
 436   char *dst = (char*)(route->dst);
 437
 438   int as_route = 0;
 439   if(!route->gw_dst && !route->gw_src)
 440     XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
 441   else{
 442     XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
 443         route->gw_src->p_name, dst, route->gw_dst->p_name);
 444     as_route = 1;
 445     if(route->gw_dst->p_rcType == SURF_NETWORK_ELEMENT_NULL)
 446       xbt_die("The gw_dst '%s' does not exist!",route->gw_dst->p_name);
 447     if(route->gw_src->p_rcType == SURF_NETWORK_ELEMENT_NULL)
 448       xbt_die("The gw_src '%s' does not exist!",route->gw_src->p_name);
 449   }
 450
 451   RoutingEdgePtr src_net_elm, dst_net_elm;
 452
 453   src_net_elm = sg_routing_edge_by_name_or_null(src);
 454   dst_net_elm = sg_routing_edge_by_name_or_null(dst);
 455
 456   xbt_assert(src_net_elm, "Network elements %s not found", src);
 457   xbt_assert(dst_net_elm, "Network elements %s not found", dst);
 458
 459   /* Create the topology graph */
 460   if(!p_routeGraph)
 461     p_routeGraph = xbt_graph_new_graph(1, NULL);
 462   if(!p_graphNodeMap)
 463     p_graphNodeMap = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
 464
 465   if (m_cached && !p_routeCache)
 466     p_routeCache = xbt_dict_new_homogeneous(&route_cache_elem_free);
 467
 468   sg_platf_route_cbarg_t e_route = newExtendedRoute(p_hierarchy, route, 1);
 469   newRoute(src_net_elm->m_id, dst_net_elm->m_id, e_route);
 470
 471   // Symmetrical YES
 472   if ( (route->symmetrical == TRUE && as_route == 0)
 473       || (route->symmetrical == TRUE && as_route == 1)
 474   )
 475   {
 476     if(!route->gw_dst && !route->gw_src)
 477       XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dst, src);
 478     else
 479       XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", dst,
 480           route->gw_dst->p_name, src, route->gw_src->p_name);
 481
 482     xbt_dynar_t nodes = xbt_graph_get_nodes(p_routeGraph);
 483     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_net_elm->m_id, xbt_node_t);
 484     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_net_elm->m_id, xbt_node_t);
 485     xbt_edge_t edge =
 486         xbt_graph_get_edge(p_routeGraph, node_e_v, node_s_v);
 487
 488     if (edge)
 489       THROWF(arg_error,0,"(AS)Route from '%s' to '%s' already exists",src,dst);
 490
 491     if (route->gw_dst && route->gw_src) {
 492       RoutingEdgePtr gw_tmp;
 493       gw_tmp = route->gw_src;
 494       route->gw_src = route->gw_dst;
 495       route->gw_dst = gw_tmp;
 496     }
 497     sg_platf_route_cbarg_t link_route_back = newExtendedRoute(p_hierarchy, route, 0);
 498     newRoute(dst_net_elm->m_id, src_net_elm->m_id, link_route_back);
 499   }
 500   xbt_dynar_free(&route->link_list);
 501 }