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