src/surf/surf_routing_dijkstra.cpp

   1 /* Copyright (c) 2009-2015. 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 "src/surf/surf_routing_private.hpp"
   8 #include "src/surf/surf_routing_dijkstra.hpp"
   9 #include "src/surf/network_interface.hpp"
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
  12
  13 /* Free functions */
  14
  15 static void route_cache_elem_free(void *e)
  16 {
  17   route_cache_element_t elm = (route_cache_element_t) e;
  18   if (elm) {
  19     xbt_free(elm->pred_arr);
  20     xbt_free(elm);
  21   }
  22 }
  23
  24 static void graph_node_map_elem_free(void *e)
  25 {
  26   graph_node_map_element_t elm = (graph_node_map_element_t) e;
  27   xbt_free(elm);
  28 }
  29
  30 static void graph_edge_data_free(void *e) // FIXME: useless code duplication
  31 {
  32   sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t) e;
  33   if (e_route) {
  34     xbt_dynar_free(&(e_route->link_list));
  35     xbt_free(e_route);
  36   }
  37 }
  38
  39 AS_t model_dijkstra_create(void){
  40   return new simgrid::surf::AsDijkstra(0);
  41 }
  42
  43 AS_t model_dijkstracache_create(void){
  44   return new simgrid::surf::AsDijkstra(1);
  45 }
  46
  47 void model_dijkstra_both_end(AS_t as)
  48 {
  49   simgrid::surf::AsDijkstra *THIS_AS
  50     = static_cast<simgrid::surf::AsDijkstra*>(as);
  51   xbt_node_t node = NULL;
  52   unsigned int cursor2;
  53   xbt_dynar_t nodes = NULL;
  54
  55   /* Create the topology graph */
  56   if(!THIS_AS->p_routeGraph)
  57     THIS_AS->p_routeGraph = xbt_graph_new_graph(1, NULL);
  58   if(!THIS_AS->p_graphNodeMap)
  59     THIS_AS->p_graphNodeMap = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
  60
  61   if (THIS_AS->m_cached && !THIS_AS->p_routeCache)
  62     THIS_AS->p_routeCache = xbt_dict_new_homogeneous(&route_cache_elem_free);
  63
  64   /* Add the loopback if needed */
  65   if (routing_platf->p_loopback && as->p_hierarchy == SURF_ROUTING_BASE)
  66     THIS_AS->addLoopback();
  67
  68   /* initialize graph indexes in nodes after graph has been built */
  69   nodes = xbt_graph_get_nodes(THIS_AS->p_routeGraph);
  70
  71   xbt_dynar_foreach(nodes, cursor2, node) {
  72     graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(node);
  73     data->graph_id = cursor2;
  74   }
  75 }
  76
  77 /* Utility functions */
  78
  79 namespace simgrid {
  80 namespace surf {
  81
  82 xbt_node_t AsDijkstra::routeGraphNewNode(int id, int graph_id)
  83 {
  84   xbt_node_t node = NULL;
  85   graph_node_data_t data = NULL;
  86   graph_node_map_element_t elm = NULL;
  87
  88   data = xbt_new0(struct graph_node_data, 1);
  89   data->id = id;
  90   data->graph_id = graph_id;
  91   node = xbt_graph_new_node(p_routeGraph, data);
  92
  93   elm = xbt_new0(struct graph_node_map_element, 1);
  94   elm->node = node;
  95   xbt_dict_set_ext(p_graphNodeMap, (char *) (&id), sizeof(int),
  96       (xbt_dictelm_t) elm, NULL);
  97
  98   return node;
  99 }
 100
 101 graph_node_map_element_t AsDijkstra::nodeMapSearch(int id)
 102 {
 103   graph_node_map_element_t elm = (graph_node_map_element_t)
 104           xbt_dict_get_or_null_ext(p_graphNodeMap,
 105               (char *) (&id),
 106               sizeof(int));
 107   return elm;
 108 }
 109
 110 /* Parsing */
 111
 112 void AsDijkstra::newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route)
 113 {
 114   XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
 115   xbt_node_t src = NULL;
 116   xbt_node_t dst = NULL;
 117
 118   graph_node_map_element_t src_elm = (graph_node_map_element_t)
 119           xbt_dict_get_or_null_ext(p_graphNodeMap,
 120               (char *) (&src_id),
 121               sizeof(int));
 122   graph_node_map_element_t dst_elm = (graph_node_map_element_t)
 123           xbt_dict_get_or_null_ext(p_graphNodeMap,
 124               (char *) (&dst_id),
 125               sizeof(int));
 126
 127
 128   if (src_elm)
 129     src = src_elm->node;
 130
 131   if (dst_elm)
 132     dst = dst_elm->node;
 133
 134   /* add nodes if they don't exist in the graph */
 135   if (src_id == dst_id && src == NULL && dst == NULL) {
 136     src = this->routeGraphNewNode(src_id, -1);
 137     dst = src;
 138   } else {
 139     if (src == NULL) {
 140       src = this->routeGraphNewNode(src_id, -1);
 141     }
 142     if (dst == NULL) {
 143       dst = this->routeGraphNewNode(dst_id, -1);
 144     }
 145   }
 146
 147   /* add link as edge to graph */
 148   xbt_graph_new_edge(p_routeGraph, src, dst, e_route);
 149 }
 150
 151 void AsDijkstra::addLoopback() {
 152   xbt_dynar_t nodes = xbt_graph_get_nodes(p_routeGraph);
 153
 154   xbt_node_t node = NULL;
 155   unsigned int cursor2;
 156   xbt_dynar_foreach(nodes, cursor2, node) {
 157     xbt_dynar_t out_edges = xbt_graph_node_get_outedges(node);
 158     xbt_edge_t edge = NULL;
 159     unsigned int cursor;
 160
 161     int found = 0;
 162     xbt_dynar_foreach(out_edges, cursor, edge) {
 163       xbt_node_t other_node = xbt_graph_edge_get_target(edge);
 164       if (other_node == node) {
 165         found = 1;
 166         break;
 167       }
 168     }
 169
 170     if (!found) {
 171       sg_platf_route_cbarg_t e_route = xbt_new0(s_sg_platf_route_cbarg_t, 1);
 172       e_route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
 173       xbt_dynar_push(e_route->link_list, &routing_platf->p_loopback);
 174       xbt_graph_new_edge(p_routeGraph, node, node, e_route);
 175     }
 176   }
 177 }
 178
 179 xbt_dynar_t AsDijkstra::getOneLinkRoutes()
 180 {
 181   xbt_dynar_t ret = xbt_dynar_new(sizeof(Onelink*), xbt_free_f);
 182   sg_platf_route_cbarg_t route = xbt_new0(s_sg_platf_route_cbarg_t,1);
 183   route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
 184
 185   int src,dst;
 186   NetCard *src_elm, *dst_elm;
 187   int table_size = (int)xbt_dynar_length(p_indexNetworkElm);
 188   for(src=0; src < table_size; src++) {
 189     for(dst=0; dst< table_size; dst++) {
 190       xbt_dynar_reset(route->link_list);
 191       src_elm = xbt_dynar_get_as(p_indexNetworkElm, src, NetCard*);
 192       dst_elm = xbt_dynar_get_as(p_indexNetworkElm, dst, NetCard*);
 193       this->getRouteAndLatency(src_elm, dst_elm,route, NULL);
 194
 195       if (xbt_dynar_length(route->link_list) == 1) {
 196         void *link = *(void **) xbt_dynar_get_ptr(route->link_list, 0);
 197         Onelink *onelink;
 198         if (p_hierarchy == SURF_ROUTING_BASE)
 199           onelink = new Onelink(link, src_elm, dst_elm);
 200         else if (p_hierarchy == SURF_ROUTING_RECURSIVE)
 201           onelink = new Onelink(link, route->gw_src, route->gw_dst);
 202         else
 203           onelink = new Onelink(link, NULL, NULL);
 204         xbt_dynar_push(ret, &onelink);
 205       }
 206     }
 207   }
 208   return ret;
 209 }
 210
 211 void AsDijkstra::getRouteAndLatency(NetCard *src, NetCard *dst, sg_platf_route_cbarg_t route, double *lat)
 212 {
 213
 214   /* set utils vars */
 215
 216   srcDstCheck(src, dst);
 217   int *src_id = src->getIdPtr();
 218   int *dst_id = dst->getIdPtr();
 219
 220   if (!src_id || !dst_id)
 221     THROWF(arg_error,0,"No route from '%s' to '%s'",src->getName(),dst->getName());
 222
 223   int *pred_arr = NULL;
 224   int src_node_id = 0;
 225   int dst_node_id = 0;
 226   int *nodeid = NULL;
 227   int v;
 228   sg_platf_route_cbarg_t e_route;
 229   int size = 0;
 230   unsigned int cpt;
 231   void *link;
 232   xbt_dynar_t links = NULL;
 233   route_cache_element_t elm = NULL;
 234   xbt_dynar_t nodes = xbt_graph_get_nodes(p_routeGraph);
 235
 236   /* Use the graph_node id mapping set to quickly find the nodes */
 237   graph_node_map_element_t src_elm = nodeMapSearch(*src_id);
 238   graph_node_map_element_t dst_elm = nodeMapSearch(*dst_id);
 239
 240   src_node_id = ((graph_node_data_t)
 241       xbt_graph_node_get_data(src_elm->node))->graph_id;
 242   dst_node_id = ((graph_node_data_t)
 243       xbt_graph_node_get_data(dst_elm->node))->graph_id;
 244
 245   /* if the src and dst are the same */
 246   if (src_node_id == dst_node_id) {
 247
 248     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
 249     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
 250     xbt_edge_t edge = xbt_graph_get_edge(p_routeGraph, node_s_v, node_e_v);
 251
 252     if (edge == NULL)
 253       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->getName(), dst->getName());
 254
 255     e_route = (sg_platf_route_cbarg_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 += static_cast<Link*>(link)->getLatency();
 262     }
 263
 264   }
 265
 266   if (m_cached) {
 267     /*check if there is a cached predecessor list avail */
 268     elm = (route_cache_element_t)
 269             xbt_dict_get_or_null_ext(p_routeCache, (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_f);
 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 = (int *) 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 = (graph_node_data_t) xbt_graph_node_get_data(u_node);
 313         int u_id = data->graph_id;
 314         sg_platf_route_cbarg_t tmp_e_route = (sg_platf_route_cbarg_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   NetCard *gw_src = NULL, *gw_dst, *prev_gw_src, *first_gw = NULL;
 336   NetCard *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(p_routeGraph, node_pred_v, node_v);
 344
 345     if (edge == NULL)
 346       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->getName(), dst->getName());
 347
 348     prev_gw_src = gw_src;
 349
 350     e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
 351     gw_src = e_route->gw_src;
 352     gw_dst = e_route->gw_dst;
 353
 354     if (v == dst_node_id)
 355       first_gw = gw_dst;
 356
 357     if (p_hierarchy == SURF_ROUTING_RECURSIVE && v != dst_node_id
 358         && strcmp(gw_dst->getName(), prev_gw_src->getName())) {
 359       xbt_dynar_t e_route_as_to_as=NULL;
 360
 361       routing_platf->getRouteAndLatency(gw_dst_net_elm, prev_gw_src_net_elm, &e_route_as_to_as, NULL);
 362       if (edge == NULL)
 363         THROWF(arg_error,0,"No route from '%s' to '%s'", src->getName(), dst->getName());
 364       links = e_route_as_to_as;
 365       int pos = 0;
 366       xbt_dynar_foreach(links, cpt, link) {
 367         xbt_dynar_insert_at(route->link_list, pos, &link);
 368         if (lat)
 369           *lat += static_cast<Link*>(link)->getLatency();
 370         pos++;
 371       }
 372     }
 373
 374     links = e_route->link_list;
 375     xbt_dynar_foreach(links, cpt, link) {
 376       xbt_dynar_unshift(route->link_list, &link);
 377       if (lat)
 378         *lat += static_cast<Link*>(link)->getLatency();
 379     }
 380     size++;
 381   }
 382
 383   if (p_hierarchy == SURF_ROUTING_RECURSIVE) {
 384     route->gw_src = gw_src;
 385     route->gw_dst = first_gw;
 386   }
 387
 388   if (m_cached && elm == NULL) {
 389     /* add to predecessor list of the current src-host to cache */
 390     elm = xbt_new0(struct route_cache_element, 1);
 391     elm->pred_arr = pred_arr;
 392     elm->size = size;
 393     xbt_dict_set_ext(p_routeCache, (char *) (&src_id), sizeof(int),
 394         (xbt_dictelm_t) elm, NULL);
 395   }
 396
 397   if (!m_cached)
 398     xbt_free(pred_arr);
 399 }
 400
 401 AsDijkstra::~AsDijkstra()
 402 {
 403   xbt_graph_free_graph(p_routeGraph, &xbt_free_f,
 404       &graph_edge_data_free, &xbt_free_f);
 405   xbt_dict_free(&p_graphNodeMap);
 406   if (m_cached)
 407     xbt_dict_free(&p_routeCache);
 408 }
 409
 410 /* Creation routing model functions */
 411
 412 AsDijkstra::AsDijkstra() : AsGeneric() {
 413 }
 414
 415 AsDijkstra::AsDijkstra(bool cached) : AsGeneric(), m_cached(cached)
 416 {
 417   p_routeGraph = NULL;
 418   p_graphNodeMap = NULL;
 419   p_routeCache = NULL;
 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.get_graph = generic_get_graph;
 426   new_component->generic_routing.finalize = dijkstra_finalize;
 427   new_component->cached = cached;*/
 428 }
 429
 430 void AsDijkstra::end()
 431 {
 432   xbt_node_t node = NULL;
 433   unsigned int cursor2;
 434   xbt_dynar_t nodes = NULL;
 435
 436   /* Create the topology graph */
 437   if(!p_routeGraph)
 438         p_routeGraph = xbt_graph_new_graph(1, NULL);
 439   if(!p_graphNodeMap)
 440     p_graphNodeMap = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
 441
 442   if (m_cached && !p_routeCache)
 443     p_routeCache = xbt_dict_new_homogeneous(&route_cache_elem_free);
 444
 445   /* Add the loopback if needed */
 446   if (routing_platf->p_loopback && p_hierarchy == SURF_ROUTING_BASE)
 447     addLoopback();
 448
 449   /* initialize graph indexes in nodes after graph has been built */
 450   nodes = xbt_graph_get_nodes(p_routeGraph);
 451
 452   xbt_dynar_foreach(nodes, cursor2, node) {
 453     graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(node);
 454     data->graph_id = cursor2;
 455   }
 456
 457 }
 458
 459 void AsDijkstra::parseASroute(sg_platf_route_cbarg_t route)
 460 {
 461   parseRoute(route);
 462 }
 463
 464 void AsDijkstra::parseRoute(sg_platf_route_cbarg_t route)
 465 {
 466   char *src = (char*)(route->src);
 467   char *dst = (char*)(route->dst);
 468
 469   int as_route = 0;
 470   if(!route->gw_dst && !route->gw_src)
 471     XBT_DEBUG("Load Route from \"%s\" to \"%s\"", src, dst);
 472   else{
 473     XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", src,
 474         route->gw_src->getName(), dst, route->gw_dst->getName());
 475     as_route = 1;
 476     if(route->gw_dst->getRcType() == SURF_NETWORK_ELEMENT_NULL)
 477       surf_parse_error("The gw_dst '%s' does not exist!",route->gw_dst->getName());
 478     if(route->gw_src->getRcType() == SURF_NETWORK_ELEMENT_NULL)
 479       surf_parse_error("The gw_src '%s' does not exist!",route->gw_src->getName());
 480   }
 481
 482   NetCard *src_net_elm, *dst_net_elm;
 483
 484   src_net_elm = sg_netcard_by_name_or_null(src);
 485   dst_net_elm = sg_netcard_by_name_or_null(dst);
 486
 487   xbt_assert(src_net_elm, "Network elements %s not found", src);
 488   xbt_assert(dst_net_elm, "Network elements %s not found", dst);
 489
 490   /* Create the topology graph */
 491   if(!p_routeGraph)
 492     p_routeGraph = xbt_graph_new_graph(1, NULL);
 493   if(!p_graphNodeMap)
 494     p_graphNodeMap = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
 495
 496   if (m_cached && !p_routeCache)
 497     p_routeCache = xbt_dict_new_homogeneous(&route_cache_elem_free);
 498
 499   sg_platf_route_cbarg_t e_route = newExtendedRoute(p_hierarchy, route, 1);
 500   newRoute(src_net_elm->getId(), dst_net_elm->getId(), e_route);
 501
 502   // Symmetrical YES
 503   if ( (route->symmetrical == TRUE && as_route == 0)
 504       || (route->symmetrical == TRUE && as_route == 1)
 505   )
 506   {
 507     if(!route->gw_dst && !route->gw_src)
 508       XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dst, src);
 509     else
 510       XBT_DEBUG("Load ASroute from \"%s(%s)\" to \"%s(%s)\"", dst,
 511           route->gw_dst->getName(), src, route->gw_src->getName());
 512
 513     xbt_dynar_t nodes = xbt_graph_get_nodes(p_routeGraph);
 514     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_net_elm->getId(), xbt_node_t);
 515     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_net_elm->getId(), xbt_node_t);
 516     xbt_edge_t edge =
 517         xbt_graph_get_edge(p_routeGraph, node_e_v, node_s_v);
 518
 519     if (edge)
 520       THROWF(arg_error,0,"(AS)Route from '%s' to '%s' already exists",src,dst);
 521
 522     if (route->gw_dst && route->gw_src) {
 523       NetCard *gw_tmp;
 524       gw_tmp = route->gw_src;
 525       route->gw_src = route->gw_dst;
 526       route->gw_dst = gw_tmp;
 527     }
 528     sg_platf_route_cbarg_t link_route_back = newExtendedRoute(p_hierarchy, route, 0);
 529     newRoute(dst_net_elm->getId(), src_net_elm->getId(), link_route_back);
 530   }
 531   xbt_dynar_free(&route->link_list);
 532 }
 533
 534 }
 535 }