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_dijkstra.hpp"
   8 #include "src/surf/network_interface.hpp"
   9
  10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
  11
  12 /* Free functions */
  13
  14 static void route_cache_elem_free(void *e)
  15 {
  16   route_cache_element_t elm = (route_cache_element_t) e;
  17   if (elm) {
  18     xbt_free(elm->pred_arr);
  19     xbt_free(elm);
  20   }
  21 }
  22
  23 static void graph_node_map_elem_free(void *e)
  24 {
  25   graph_node_map_element_t elm = (graph_node_map_element_t) e;
  26   xbt_free(elm);
  27 }
  28
  29 static void graph_edge_data_free(void *e) // FIXME: useless code duplication
  30 {
  31   sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t) e;
  32   if (e_route) {
  33     delete e_route->link_list;
  34     xbt_free(e_route);
  35   }
  36 }
  37
  38 /* Utility functions */
  39
  40 namespace simgrid {
  41 namespace surf {
  42 void AsDijkstra::Seal()
  43 {
  44   xbt_node_t node = NULL;
  45   unsigned int cursor2, cursor;
  46
  47   /* Create the topology graph */
  48   if(!routeGraph_)
  49     routeGraph_ = xbt_graph_new_graph(1, NULL);
  50   if(!graphNodeMap_)
  51     graphNodeMap_ = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
  52
  53   /* Add the loopback if needed */
  54   if (routing_platf->loopback_ && hierarchy_ == SURF_ROUTING_BASE) {
  55     xbt_dynar_foreach(xbt_graph_get_nodes(routeGraph_), cursor, node) {
  56       xbt_edge_t edge = NULL;
  57
  58       bool found = false;
  59       xbt_dynar_foreach(xbt_graph_node_get_outedges(node), cursor2, edge) {
  60         if (xbt_graph_edge_get_target(edge) == node) {
  61           found = true;
  62           break;
  63         }
  64       }
  65
  66       if (!found) {
  67         sg_platf_route_cbarg_t e_route = xbt_new0(s_sg_platf_route_cbarg_t, 1);
  68         e_route->link_list = new std::vector<Link*>();
  69         e_route->link_list->push_back(routing_platf->loopback_);
  70         xbt_graph_new_edge(routeGraph_, node, node, e_route);
  71       }
  72     }
  73   }
  74
  75   /* initialize graph indexes in nodes after graph has been built */
  76   xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
  77
  78   xbt_dynar_foreach(nodes, cursor, node) {
  79     graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(node);
  80     data->graph_id = cursor;
  81   }
  82 }
  83
  84 xbt_node_t AsDijkstra::routeGraphNewNode(int id, int graph_id)
  85 {
  86   xbt_node_t node = NULL;
  87   graph_node_data_t data = NULL;
  88   graph_node_map_element_t elm = NULL;
  89
  90   data = xbt_new0(struct graph_node_data, 1);
  91   data->id = id;
  92   data->graph_id = graph_id;
  93   node = xbt_graph_new_node(routeGraph_, data);
  94
  95   elm = xbt_new0(struct graph_node_map_element, 1);
  96   elm->node = node;
  97   xbt_dict_set_ext(graphNodeMap_, (char *) (&id), sizeof(int), (xbt_dictelm_t) elm, NULL);
  98
  99   return node;
 100 }
 101
 102 graph_node_map_element_t AsDijkstra::nodeMapSearch(int id)
 103 {
 104   return (graph_node_map_element_t)xbt_dict_get_or_null_ext(graphNodeMap_, (char *) (&id), sizeof(int));
 105 }
 106
 107 /* Parsing */
 108
 109 void AsDijkstra::newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route)
 110 {
 111   XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
 112   xbt_node_t src = NULL;
 113   xbt_node_t dst = NULL;
 114
 115   graph_node_map_element_t src_elm = nodeMapSearch(src_id);
 116   graph_node_map_element_t dst_elm = nodeMapSearch(dst_id);
 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 = this->routeGraphNewNode(src_id, -1);
 127     dst = src;
 128   } else {
 129     if (src == NULL) {
 130       src = this->routeGraphNewNode(src_id, -1);
 131     }
 132     if (dst == NULL) {
 133       dst = this->routeGraphNewNode(dst_id, -1);
 134     }
 135   }
 136
 137   /* add link as edge to graph */
 138   xbt_graph_new_edge(routeGraph_, src, dst, e_route);
 139 }
 140
 141 xbt_dynar_t AsDijkstra::getOneLinkRoutes()
 142 {
 143   xbt_dynar_t ret = xbt_dynar_new(sizeof(Onelink*), xbt_free_f);
 144   sg_platf_route_cbarg_t route = xbt_new0(s_sg_platf_route_cbarg_t,1);
 145   route->link_list = new std::vector<Link*>();
 146
 147   int table_size = (int)xbt_dynar_length(vertices_);
 148   for(int src=0; src < table_size; src++) {
 149     for(int dst=0; dst< table_size; dst++) {
 150       route->link_list->clear();
 151       NetCard *src_elm = xbt_dynar_get_as(vertices_, src, NetCard*);
 152       NetCard *dst_elm = xbt_dynar_get_as(vertices_, dst, NetCard*);
 153       this->getRouteAndLatency(src_elm, dst_elm,route, NULL);
 154
 155       if (route->link_list->size() == 1) {
 156         Link *link = route->link_list->at(0);
 157         Onelink *onelink;
 158         if (hierarchy_ == SURF_ROUTING_BASE)
 159           onelink = new Onelink(link, src_elm, dst_elm);
 160         else if (hierarchy_ == SURF_ROUTING_RECURSIVE)
 161           onelink = new Onelink(link, route->gw_src, route->gw_dst);
 162         else
 163           onelink = new Onelink(link, NULL, NULL);
 164         xbt_dynar_push(ret, &onelink);
 165       }
 166     }
 167   }
 168   return ret;
 169 }
 170
 171 void AsDijkstra::getRouteAndLatency(NetCard *src, NetCard *dst, sg_platf_route_cbarg_t route, double *lat)
 172 {
 173   getRouteCheckParams(src, dst);
 174   int src_id = src->id();
 175   int dst_id = dst->id();
 176
 177   int *pred_arr = NULL;
 178   sg_platf_route_cbarg_t e_route;
 179   int size = 0;
 180   xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
 181
 182   /* Use the graph_node id mapping set to quickly find the nodes */
 183   graph_node_map_element_t src_elm = nodeMapSearch(src_id);
 184   graph_node_map_element_t dst_elm = nodeMapSearch(dst_id);
 185
 186   int src_node_id = ((graph_node_data_t) xbt_graph_node_get_data(src_elm->node))->graph_id;
 187   int dst_node_id = ((graph_node_data_t) xbt_graph_node_get_data(dst_elm->node))->graph_id;
 188
 189   /* if the src and dst are the same */
 190   if (src_node_id == dst_node_id) {
 191
 192     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
 193     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
 194     xbt_edge_t edge = xbt_graph_get_edge(routeGraph_, node_s_v, node_e_v);
 195
 196     if (edge == NULL)
 197       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->name(), dst->name());
 198
 199     e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
 200
 201     for (auto link: *e_route->link_list) {
 202       route->link_list->insert(route->link_list->begin(), link);
 203       if (lat)
 204         *lat += static_cast<Link*>(link)->getLatency();
 205     }
 206
 207   }
 208
 209   route_cache_element_t elm = NULL;
 210   if (routeCache_) {  /* cache mode  */
 211     elm = (route_cache_element_t) xbt_dict_get_or_null_ext(routeCache_, (char *) (&src_id), sizeof(int));
 212   }
 213
 214   if (elm) {                    /* cached mode and cache hit */
 215     pred_arr = elm->pred_arr;
 216   } else {                      /* not cached mode, or cache miss */
 217
 218     int nr_nodes = xbt_dynar_length(nodes);
 219     double * cost_arr = xbt_new0(double, nr_nodes);      /* link cost from src to other hosts */
 220     pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
 221     xbt_heap_t pqueue = xbt_heap_new(nr_nodes, xbt_free_f);
 222
 223     /* initialize */
 224     cost_arr[src_node_id] = 0.0;
 225
 226     for (int i = 0; i < nr_nodes; i++) {
 227       if (i != src_node_id) {
 228         cost_arr[i] = DBL_MAX;
 229       }
 230
 231       pred_arr[i] = 0;
 232
 233       /* initialize priority queue */
 234       int *nodeid = xbt_new0(int, 1);
 235       *nodeid = i;
 236       xbt_heap_push(pqueue, nodeid, cost_arr[i]);
 237
 238     }
 239
 240     /* apply dijkstra using the indexes from the graph's node array */
 241     while (xbt_heap_size(pqueue) > 0) {
 242       int *v_id = (int *) xbt_heap_pop(pqueue);
 243       xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
 244       xbt_edge_t edge = NULL;
 245       unsigned int cursor;
 246
 247       xbt_dynar_foreach(xbt_graph_node_get_outedges(v_node), cursor, edge) {
 248         xbt_node_t u_node = xbt_graph_edge_get_target(edge);
 249         graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(u_node);
 250         int u_id = data->graph_id;
 251         sg_platf_route_cbarg_t tmp_e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
 252         int cost_v_u = tmp_e_route->link_list->size();    /* count of links, old model assume 1 */
 253
 254         if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
 255           pred_arr[u_id] = *v_id;
 256           cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
 257           int *nodeid = xbt_new0(int, 1);
 258           *nodeid = u_id;
 259           xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
 260         }
 261       }
 262
 263       /* free item popped from pqueue */
 264       xbt_free(v_id);
 265     }
 266
 267     xbt_free(cost_arr);
 268     xbt_heap_free(pqueue);
 269   }
 270
 271   /* compose route path with links */
 272   NetCard *gw_src = NULL, *gw_dst, *prev_gw_src, *first_gw = NULL;
 273   NetCard *gw_dst_net_elm = NULL, *prev_gw_src_net_elm = NULL;
 274
 275   for (int v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
 276     xbt_node_t node_pred_v = xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
 277     xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
 278     xbt_edge_t edge = xbt_graph_get_edge(routeGraph_, node_pred_v, node_v);
 279
 280     if (edge == NULL)
 281       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->name(), dst->name());
 282
 283     prev_gw_src = gw_src;
 284
 285     e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
 286     gw_src = e_route->gw_src;
 287     gw_dst = e_route->gw_dst;
 288
 289     if (v == dst_node_id)
 290       first_gw = gw_dst;
 291
 292     if (hierarchy_ == SURF_ROUTING_RECURSIVE && v != dst_node_id && strcmp(gw_dst->name(), prev_gw_src->name())) {
 293       std::vector<Link*> *e_route_as_to_as = new std::vector<Link*>();
 294
 295       routing_platf->getRouteAndLatency(gw_dst_net_elm, prev_gw_src_net_elm, e_route_as_to_as, NULL);
 296       auto pos = route->link_list->begin();
 297       for (auto link : *e_route_as_to_as) {
 298         route->link_list->insert(pos, link);
 299         if (lat)
 300           *lat += link->getLatency();
 301         pos++;
 302       }
 303     }
 304
 305     for (auto link: *e_route->link_list) {
 306       route->link_list->insert(route->link_list->begin(), link);
 307       if (lat)
 308         *lat += static_cast<Link*>(link)->getLatency();
 309     }
 310     size++;
 311   }
 312
 313   if (hierarchy_ == SURF_ROUTING_RECURSIVE) {
 314     route->gw_src = gw_src;
 315     route->gw_dst = first_gw;
 316   }
 317
 318   if (routeCache_ && elm == NULL) {
 319     /* add to predecessor list of the current src-host to cache */
 320     elm = xbt_new0(struct route_cache_element, 1);
 321     elm->pred_arr = pred_arr;
 322     elm->size = size;
 323     xbt_dict_set_ext(routeCache_, (char *) (&src_id), sizeof(int), (xbt_dictelm_t) elm, NULL);
 324   }
 325
 326   if (!routeCache_)
 327     xbt_free(pred_arr);
 328 }
 329
 330 AsDijkstra::~AsDijkstra()
 331 {
 332   xbt_graph_free_graph(routeGraph_, &xbt_free_f,  &graph_edge_data_free, &xbt_free_f);
 333   xbt_dict_free(&graphNodeMap_);
 334   xbt_dict_free(&routeCache_);
 335 }
 336
 337 /* Creation routing model functions */
 338
 339 AsDijkstra::AsDijkstra(const char*name, bool cached)
 340   : AsRoutedGraph(name)
 341 {
 342   if (cached)
 343     routeCache_ = xbt_dict_new_homogeneous(&route_cache_elem_free);
 344 }
 345
 346 void AsDijkstra::addRoute(sg_platf_route_cbarg_t route)
 347 {
 348   const char *srcName = route->src;
 349   const char *dstName = route->dst;
 350   NetCard *src = sg_netcard_by_name_or_null(srcName);
 351   NetCard *dst = sg_netcard_by_name_or_null(dstName);
 352
 353   addRouteCheckParams(route);
 354
 355   /* Create the topology graph */
 356   if(!routeGraph_)
 357     routeGraph_ = xbt_graph_new_graph(1, NULL);
 358   if(!graphNodeMap_)
 359     graphNodeMap_ = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
 360
 361   /* we don't check whether the route already exist, because the algorithm may find another path through some other nodes */
 362
 363   /* Add the route to the base */
 364   sg_platf_route_cbarg_t e_route = newExtendedRoute(hierarchy_, route, 1);
 365   newRoute(src->id(), dst->id(), e_route);
 366
 367   // Symmetrical YES
 368   if (route->symmetrical == TRUE) {
 369     if(!route->gw_dst && !route->gw_src)
 370       XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dstName, srcName);
 371     else
 372       XBT_DEBUG("Load ASroute from %s@%s to %s@%s", dstName, route->gw_dst->name(), srcName, route->gw_src->name());
 373
 374     xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
 375     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src->id(), xbt_node_t);
 376     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst->id(), xbt_node_t);
 377     xbt_edge_t edge = xbt_graph_get_edge(routeGraph_, node_e_v, node_s_v);
 378
 379     if (edge)
 380       THROWF(arg_error,0, "Route from %s@%s to %s@%s already exists", dstName, route->gw_dst->name(), srcName, route->gw_src->name());
 381
 382     if (route->gw_dst && route->gw_src) {
 383       NetCard *gw_tmp = route->gw_src;
 384       route->gw_src = route->gw_dst;
 385       route->gw_dst = gw_tmp;
 386     }
 387     sg_platf_route_cbarg_t link_route_back = newExtendedRoute(hierarchy_, route, 0);
 388     newRoute(dst->id(), src->id(), link_route_back);
 389   }
 390   delete route->link_list;
 391 }
 392
 393 }
 394 }