src/kernel/routing/DijkstraZone.cpp

   1 /* Copyright (c) 2009-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/kernel/routing/DijkstraZone.hpp"
   7 #include "src/kernel/routing/NetPoint.hpp"
   8 #include "src/surf/network_interface.hpp"
   9
  10 #include <cfloat>
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
  13
  14 /* Free functions */
  15
  16 static void graph_node_data_free(void* n)
  17 {
  18   graph_node_data_t data = static_cast<graph_node_data_t>(n);
  19   delete data;
  20 }
  21
  22 static void graph_edge_data_free(void* e) // FIXME: useless code duplication
  23 {
  24   sg_platf_route_cbarg_t e_route = static_cast<sg_platf_route_cbarg_t>(e);
  25   if (e_route) {
  26     delete e_route->link_list;
  27     delete e_route;
  28   }
  29 }
  30
  31 /* Utility functions */
  32
  33 namespace simgrid {
  34 namespace kernel {
  35 namespace routing {
  36 void DijkstraZone::seal()
  37 {
  38   unsigned int cursor;
  39   xbt_node_t node = nullptr;
  40
  41   /* Create the topology graph */
  42   if (not routeGraph_)
  43     routeGraph_ = xbt_graph_new_graph(1, nullptr);
  44
  45   /* Add the loopback if needed */
  46   if (surf_network_model->loopback_ && hierarchy_ == RoutingMode::base) {
  47     xbt_dynar_foreach (xbt_graph_get_nodes(routeGraph_), cursor, node) {
  48
  49       bool found = false;
  50       xbt_edge_t edge = nullptr;
  51       unsigned int cursor2;
  52       xbt_dynar_foreach (xbt_graph_node_get_outedges(node), cursor2, edge) {
  53         if (xbt_graph_edge_get_target(edge) == node) {
  54           found = true;
  55           break;
  56         }
  57       }
  58
  59       if (not found) {
  60         sg_platf_route_cbarg_t e_route = new s_sg_platf_route_cbarg_t;
  61         e_route->link_list             = new std::vector<surf::LinkImpl*>();
  62         e_route->link_list->push_back(surf_network_model->loopback_);
  63         xbt_graph_new_edge(routeGraph_, node, node, e_route);
  64       }
  65     }
  66   }
  67
  68   /* initialize graph indexes in nodes after graph has been built */
  69   xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
  70
  71   xbt_dynar_foreach (nodes, cursor, node) {
  72     graph_node_data_t data = static_cast<graph_node_data_t>(xbt_graph_node_get_data(node));
  73     data->graph_id         = cursor;
  74   }
  75 }
  76
  77 xbt_node_t DijkstraZone::routeGraphNewNode(int id, int graph_id)
  78 {
  79   graph_node_data_t data = new s_graph_node_data_t;
  80   data->id       = id;
  81   data->graph_id = graph_id;
  82
  83   xbt_node_t node                = xbt_graph_new_node(routeGraph_, data);
  84   graphNodeMap_.emplace(id, node);
  85
  86   return node;
  87 }
  88
  89 xbt_node_t DijkstraZone::nodeMapSearch(int id)
  90 {
  91   auto ret = graphNodeMap_.find(id);
  92   return ret == graphNodeMap_.end() ? nullptr : ret->second;
  93 }
  94
  95 /* Parsing */
  96
  97 void DijkstraZone::newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route)
  98 {
  99   XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
 100   xbt_node_t src = nullptr;
 101   xbt_node_t dst = nullptr;
 102
 103   xbt_node_t src_elm = nodeMapSearch(src_id);
 104   xbt_node_t dst_elm = nodeMapSearch(dst_id);
 105
 106   if (src_elm)
 107     src = src_elm;
 108
 109   if (dst_elm)
 110     dst = dst_elm;
 111
 112   /* add nodes if they don't exist in the graph */
 113   if (src_id == dst_id && src == nullptr && dst == nullptr) {
 114     src = this->routeGraphNewNode(src_id, -1);
 115     dst = src;
 116   } else {
 117     if (src == nullptr) {
 118       src = this->routeGraphNewNode(src_id, -1);
 119     }
 120     if (dst == nullptr) {
 121       dst = this->routeGraphNewNode(dst_id, -1);
 122     }
 123   }
 124
 125   /* add link as edge to graph */
 126   xbt_graph_new_edge(routeGraph_, src, dst, e_route);
 127 }
 128
 129 void DijkstraZone::getLocalRoute(NetPoint* src, NetPoint* dst, sg_platf_route_cbarg_t route, double* lat)
 130 {
 131   getRouteCheckParams(src, dst);
 132   int src_id = src->id();
 133   int dst_id = dst->id();
 134
 135   xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
 136
 137   /* Use the graph_node id mapping set to quickly find the nodes */
 138   xbt_node_t src_elm = nodeMapSearch(src_id);
 139   xbt_node_t dst_elm = nodeMapSearch(dst_id);
 140
 141   int src_node_id = static_cast<graph_node_data_t>(xbt_graph_node_get_data(src_elm))->graph_id;
 142   int dst_node_id = static_cast<graph_node_data_t>(xbt_graph_node_get_data(dst_elm))->graph_id;
 143
 144   /* if the src and dst are the same */
 145   if (src_node_id == dst_node_id) {
 146
 147     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
 148     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
 149     xbt_edge_t edge     = xbt_graph_get_edge(routeGraph_, node_s_v, node_e_v);
 150
 151     if (edge == nullptr)
 152       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->getCname(), dst->getCname());
 153
 154     sg_platf_route_cbarg_t e_route = static_cast<sg_platf_route_cbarg_t>(xbt_graph_edge_get_data(edge));
 155
 156     for (auto const& link : *e_route->link_list) {
 157       route->link_list->insert(route->link_list->begin(), link);
 158       if (lat)
 159         *lat += static_cast<surf::LinkImpl*>(link)->latency();
 160     }
 161   }
 162
 163   auto elm                   = routeCache_.emplace(src_id, std::vector<int>());
 164   std::vector<int>& pred_arr = elm.first->second;
 165
 166   if (elm.second) { /* new element was inserted (not cached mode, or cache miss) */
 167     int nr_nodes      = xbt_dynar_length(nodes);
 168     std::vector<double> cost_arr(nr_nodes); /* link cost from src to other hosts */
 169     pred_arr.resize(nr_nodes);              /* predecessors in path from src */
 170     xbt_heap_t pqueue = xbt_heap_new(nr_nodes, nullptr);
 171
 172     /* initialize */
 173     cost_arr[src_node_id] = 0.0;
 174
 175     for (int i = 0; i < nr_nodes; i++) {
 176       if (i != src_node_id) {
 177         cost_arr[i] = DBL_MAX;
 178       }
 179
 180       pred_arr[i] = 0;
 181
 182       /* initialize priority queue */
 183       int* nodeid = new int(i);
 184       xbt_heap_push(pqueue, nodeid, cost_arr[i]);
 185     }
 186
 187     /* apply dijkstra using the indexes from the graph's node array */
 188     while (xbt_heap_size(pqueue) > 0) {
 189       int* v_id         = static_cast<int*>(xbt_heap_pop(pqueue));
 190       xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
 191       xbt_edge_t edge   = nullptr;
 192       unsigned int cursor;
 193
 194       xbt_dynar_foreach (xbt_graph_node_get_outedges(v_node), cursor, edge) {
 195         xbt_node_t u_node                  = xbt_graph_edge_get_target(edge);
 196         graph_node_data_t data             = static_cast<graph_node_data_t>(xbt_graph_node_get_data(u_node));
 197         int u_id                           = data->graph_id;
 198         sg_platf_route_cbarg_t tmp_e_route = static_cast<sg_platf_route_cbarg_t>(xbt_graph_edge_get_data(edge));
 199         int cost_v_u                       = tmp_e_route->link_list->size(); /* count of links, old model assume 1 */
 200
 201         if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
 202           pred_arr[u_id] = *v_id;
 203           cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
 204           int* nodeid    = new int(u_id);
 205           xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
 206         }
 207       }
 208
 209       /* free item popped from pqueue */
 210       delete v_id;
 211     }
 212     xbt_heap_free(pqueue);
 213   }
 214
 215   /* compose route path with links */
 216   NetPoint* gw_src = nullptr;
 217   NetPoint* gw_dst;
 218   NetPoint* first_gw            = nullptr;
 219
 220   for (int v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
 221     xbt_node_t node_pred_v = xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
 222     xbt_node_t node_v      = xbt_dynar_get_as(nodes, v, xbt_node_t);
 223     xbt_edge_t edge        = xbt_graph_get_edge(routeGraph_, node_pred_v, node_v);
 224
 225     if (edge == nullptr)
 226       THROWF(arg_error, 0, "No route from '%s' to '%s'", src->getCname(), dst->getCname());
 227
 228     sg_platf_route_cbarg_t e_route = static_cast<sg_platf_route_cbarg_t>(xbt_graph_edge_get_data(edge));
 229
 230     NetPoint* prev_gw_src          = gw_src;
 231     gw_src                         = e_route->gw_src;
 232     gw_dst                         = e_route->gw_dst;
 233
 234     if (v == dst_node_id)
 235       first_gw = gw_dst;
 236
 237     if (hierarchy_ == RoutingMode::recursive && v != dst_node_id && gw_dst->getName() != prev_gw_src->getName()) {
 238       std::vector<surf::LinkImpl*> e_route_as_to_as;
 239
 240       NetPoint* gw_dst_net_elm      = nullptr;
 241       NetPoint* prev_gw_src_net_elm = nullptr;
 242       getGlobalRoute(gw_dst_net_elm, prev_gw_src_net_elm, &e_route_as_to_as, nullptr);
 243       auto pos = route->link_list->begin();
 244       for (auto const& link : e_route_as_to_as) {
 245         route->link_list->insert(pos, link);
 246         if (lat)
 247           *lat += link->latency();
 248         pos++;
 249       }
 250     }
 251
 252     for (auto const& link : *e_route->link_list) {
 253       route->link_list->insert(route->link_list->begin(), link);
 254       if (lat)
 255         *lat += static_cast<surf::LinkImpl*>(link)->latency();
 256     }
 257   }
 258
 259   if (hierarchy_ == RoutingMode::recursive) {
 260     route->gw_src = gw_src;
 261     route->gw_dst = first_gw;
 262   }
 263
 264   if (not cached_)
 265     routeCache_.clear();
 266 }
 267
 268 DijkstraZone::~DijkstraZone()
 269 {
 270   xbt_graph_free_graph(routeGraph_, &graph_node_data_free, &graph_edge_data_free, nullptr);
 271 }
 272
 273 /* Creation routing model functions */
 274
 275 DijkstraZone::DijkstraZone(NetZone* father, std::string name, bool cached) : RoutedZone(father, name), cached_(cached)
 276 {
 277 }
 278
 279 void DijkstraZone::addRoute(sg_platf_route_cbarg_t route)
 280 {
 281   NetPoint* src       = route->src;
 282   NetPoint* dst       = route->dst;
 283   const char* srcName = src->getCname();
 284   const char* dstName = dst->getCname();
 285
 286   addRouteCheckParams(route);
 287
 288   /* Create the topology graph */
 289   if (not routeGraph_)
 290     routeGraph_ = xbt_graph_new_graph(1, nullptr);
 291
 292   /* we don't check whether the route already exist, because the algorithm may find another path through some other
 293    * nodes */
 294
 295   /* Add the route to the base */
 296   sg_platf_route_cbarg_t e_route = newExtendedRoute(hierarchy_, route, 1);
 297   newRoute(src->id(), dst->id(), e_route);
 298
 299   // Symmetrical YES
 300   if (route->symmetrical == true) {
 301
 302     xbt_dynar_t nodes   = xbt_graph_get_nodes(routeGraph_);
 303     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src->id(), xbt_node_t);
 304     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst->id(), xbt_node_t);
 305     xbt_edge_t edge     = xbt_graph_get_edge(routeGraph_, node_e_v, node_s_v);
 306
 307     if (not route->gw_dst || not route->gw_src){
 308       XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dstName, srcName);
 309       if (edge)
 310         THROWF(arg_error, 0, "Route from %s to %s already exists", dstName, srcName);
 311     } else {
 312       XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", dstName, route->gw_dst->getCname(), srcName,
 313                 route->gw_src->getCname());
 314       if (edge)
 315         THROWF(arg_error, 0, "Route from %s@%s to %s@%s already exists", dstName, route->gw_dst->getCname(), srcName,
 316                route->gw_src->getCname());
 317     }
 318
 319     if (route->gw_dst && route->gw_src) {
 320       NetPoint* gw_tmp = route->gw_src;
 321       route->gw_src   = route->gw_dst;
 322       route->gw_dst   = gw_tmp;
 323     }
 324     sg_platf_route_cbarg_t link_route_back = newExtendedRoute(hierarchy_, route, 0);
 325     newRoute(dst->id(), src->id(), link_route_back);
 326   }
 327 }
 328 }
 329 }
 330 } // namespace