src/kernel/routing/DijkstraZone.cpp

   1 /* Copyright (c) 2009-2019. 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 "simgrid/kernel/routing/DijkstraZone.hpp"
   7 #include "simgrid/kernel/routing/NetPoint.hpp"
   8 #include "src/surf/network_interface.hpp"
   9 #include "src/surf/xml/platf_private.hpp"
  10 #include "surf/surf.hpp"
  11 #include "xbt/string.hpp"
  12
  13 #include <cfloat>
  14 #include <queue>
  15 #include <vector>
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
  18
  19 namespace simgrid {
  20 namespace kernel {
  21 namespace routing {
  22
  23 class GraphNodeData {
  24 public:
  25   explicit GraphNodeData(int id) : id_(id) {}
  26   int id_;
  27   int graph_id_ = -1; /* used for caching internal graph id's */
  28 };
  29
  30 DijkstraZone::DijkstraZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel, bool cached)
  31     : RoutedZone(father, name, netmodel), cached_(cached)
  32 {
  33 }
  34
  35 static void graph_node_data_free(void* n)
  36 {
  37   delete static_cast<simgrid::kernel::routing::GraphNodeData*>(n);
  38 }
  39
  40 static void graph_edge_data_free(void* e)
  41 {
  42   delete static_cast<simgrid::kernel::routing::RouteCreationArgs*>(e);
  43 }
  44
  45 DijkstraZone::~DijkstraZone()
  46 {
  47   xbt_graph_free_graph(route_graph_, &graph_node_data_free, &graph_edge_data_free, nullptr);
  48 }
  49
  50 void DijkstraZone::seal()
  51 {
  52   unsigned int cursor;
  53   xbt_node_t node = nullptr;
  54
  55   if (not route_graph_)
  56     route_graph_ = xbt_graph_new_graph(1, nullptr);
  57
  58   /* Add the loopback if needed */
  59   if (network_model_->loopback_ && hierarchy_ == RoutingMode::base) {
  60     xbt_dynar_foreach (xbt_graph_get_nodes(route_graph_), cursor, node) {
  61       bool found = false;
  62       xbt_edge_t edge = nullptr;
  63       unsigned int cursor2;
  64       xbt_dynar_foreach (xbt_graph_node_get_outedges(node), cursor2, edge) {
  65         if (xbt_graph_edge_get_target(edge) == node) { // There is an edge from node to itself
  66           found = true;
  67           break;
  68         }
  69       }
  70
  71       if (not found) {
  72         RouteCreationArgs* route = new simgrid::kernel::routing::RouteCreationArgs();
  73         route->link_list.push_back(network_model_->loopback_);
  74         xbt_graph_new_edge(route_graph_, node, node, route);
  75       }
  76     }
  77   }
  78
  79   /* initialize graph indexes in nodes after graph has been built */
  80   const_xbt_dynar_t nodes = xbt_graph_get_nodes(route_graph_);
  81
  82   xbt_dynar_foreach (nodes, cursor, node) {
  83     GraphNodeData* data = static_cast<GraphNodeData*>(xbt_graph_node_get_data(node));
  84     data->graph_id_     = cursor;
  85   }
  86 }
  87
  88 xbt_node_t DijkstraZone::route_graph_new_node(int id)
  89 {
  90   xbt_node_t node = xbt_graph_new_node(route_graph_, new GraphNodeData(id));
  91   graph_node_map_.emplace(id, node);
  92
  93   return node;
  94 }
  95
  96 xbt_node_t DijkstraZone::node_map_search(int id)
  97 {
  98   auto ret = graph_node_map_.find(id);
  99   return ret == graph_node_map_.end() ? nullptr : ret->second;
 100 }
 101
 102 /* Parsing */
 103
 104 void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* route, double* lat)
 105 {
 106   get_route_check_params(src, dst);
 107   int src_id = src->id();
 108   int dst_id = dst->id();
 109
 110   xbt_dynar_t nodes = xbt_graph_get_nodes(route_graph_);
 111
 112   /* Use the graph_node id mapping set to quickly find the nodes */
 113   xbt_node_t src_elm = node_map_search(src_id);
 114   xbt_node_t dst_elm = node_map_search(dst_id);
 115
 116   int src_node_id = static_cast<GraphNodeData*>(xbt_graph_node_get_data(src_elm))->graph_id_;
 117   int dst_node_id = static_cast<GraphNodeData*>(xbt_graph_node_get_data(dst_elm))->graph_id_;
 118
 119   /* if the src and dst are the same */
 120   if (src_node_id == dst_node_id) {
 121     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
 122     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
 123     xbt_edge_t edge     = xbt_graph_get_edge(route_graph_, node_s_v, node_e_v);
 124
 125     if (edge == nullptr)
 126       throw std::invalid_argument(xbt::string_printf("No route from '%s' to '%s'", src->get_cname(), dst->get_cname()));
 127
 128     const RouteCreationArgs* e_route = static_cast<RouteCreationArgs*>(xbt_graph_edge_get_data(edge));
 129
 130     for (auto const& link : e_route->link_list) {
 131       route->link_list.insert(route->link_list.begin(), link);
 132       if (lat)
 133         *lat += static_cast<resource::LinkImpl*>(link)->get_latency();
 134     }
 135   }
 136
 137   auto elm                   = route_cache_.emplace(src_id, std::vector<int>());
 138   std::vector<int>& pred_arr = elm.first->second;
 139
 140   if (elm.second) { /* new element was inserted (not cached mode, or cache miss) */
 141     int nr_nodes      = xbt_dynar_length(nodes);
 142     std::vector<double> cost_arr(nr_nodes); /* link cost from src to other hosts */
 143     pred_arr.resize(nr_nodes);              /* predecessors in path from src */
 144     typedef std::pair<double, int> Qelt;
 145     std::priority_queue<Qelt, std::vector<Qelt>, std::greater<Qelt>> pqueue;
 146
 147     /* initialize */
 148     cost_arr[src_node_id] = 0.0;
 149
 150     for (int i = 0; i < nr_nodes; i++) {
 151       if (i != src_node_id) {
 152         cost_arr[i] = DBL_MAX;
 153       }
 154
 155       pred_arr[i] = 0;
 156
 157       /* initialize priority queue */
 158       pqueue.emplace(cost_arr[i], i);
 159     }
 160
 161     /* apply dijkstra using the indexes from the graph's node array */
 162     while (not pqueue.empty()) {
 163       int v_id = pqueue.top().second;
 164       pqueue.pop();
 165       xbt_node_t v_node = xbt_dynar_get_as(nodes, v_id, xbt_node_t);
 166       xbt_edge_t edge   = nullptr;
 167       unsigned int cursor;
 168
 169       xbt_dynar_foreach (xbt_graph_node_get_outedges(v_node), cursor, edge) {
 170         xbt_node_t u_node                  = xbt_graph_edge_get_target(edge);
 171         const GraphNodeData* data            = static_cast<GraphNodeData*>(xbt_graph_node_get_data(u_node));
 172         int u_id                           = data->graph_id_;
 173         const RouteCreationArgs* tmp_e_route = static_cast<RouteCreationArgs*>(xbt_graph_edge_get_data(edge));
 174         int cost_v_u                       = tmp_e_route->link_list.size(); /* count of links, old model assume 1 */
 175
 176         if (cost_v_u + cost_arr[v_id] < cost_arr[u_id]) {
 177           pred_arr[u_id] = v_id;
 178           cost_arr[u_id] = cost_v_u + cost_arr[v_id];
 179           pqueue.emplace(cost_arr[u_id], u_id);
 180         }
 181       }
 182     }
 183   }
 184
 185   /* compose route path with links */
 186   NetPoint* gw_src   = nullptr;
 187   NetPoint* first_gw = nullptr;
 188
 189   for (int v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
 190     xbt_node_t node_pred_v = xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
 191     xbt_node_t node_v      = xbt_dynar_get_as(nodes, v, xbt_node_t);
 192     xbt_edge_t edge        = xbt_graph_get_edge(route_graph_, node_pred_v, node_v);
 193
 194     if (edge == nullptr)
 195       throw std::invalid_argument(xbt::string_printf("No route from '%s' to '%s'", src->get_cname(), dst->get_cname()));
 196
 197     const RouteCreationArgs* e_route = static_cast<RouteCreationArgs*>(xbt_graph_edge_get_data(edge));
 198
 199     const NetPoint* prev_gw_src = gw_src;
 200     gw_src                = e_route->gw_src;
 201     NetPoint* gw_dst      = e_route->gw_dst;
 202
 203     if (v == dst_node_id)
 204       first_gw = gw_dst;
 205
 206     if (hierarchy_ == RoutingMode::recursive && v != dst_node_id && gw_dst->get_name() != prev_gw_src->get_name()) {
 207       std::vector<resource::LinkImpl*> e_route_as_to_as;
 208
 209       NetPoint* gw_dst_net_elm      = nullptr;
 210       NetPoint* prev_gw_src_net_elm = nullptr;
 211       get_global_route(gw_dst_net_elm, prev_gw_src_net_elm, e_route_as_to_as, nullptr);
 212       auto pos = route->link_list.begin();
 213       for (auto const& link : e_route_as_to_as) {
 214         route->link_list.insert(pos, link);
 215         if (lat)
 216           *lat += link->get_latency();
 217         pos++;
 218       }
 219     }
 220
 221     for (auto const& link : e_route->link_list) {
 222       route->link_list.insert(route->link_list.begin(), link);
 223       if (lat)
 224         *lat += static_cast<resource::LinkImpl*>(link)->get_latency();
 225     }
 226   }
 227
 228   if (hierarchy_ == RoutingMode::recursive) {
 229     route->gw_src = gw_src;
 230     route->gw_dst = first_gw;
 231   }
 232
 233   if (not cached_)
 234     route_cache_.clear();
 235 }
 236
 237 void DijkstraZone::add_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
 238                              std::vector<resource::LinkImpl*>& link_list, bool symmetrical)
 239 {
 240   add_route_check_params(src, dst, gw_src, gw_dst, link_list, symmetrical);
 241
 242   if (not route_graph_)
 243     route_graph_ = xbt_graph_new_graph(1, nullptr);
 244
 245   new_edge(src->id(), dst->id(), new_extended_route(hierarchy_, src, dst, gw_src, gw_dst, link_list, symmetrical, 1));
 246
 247   if (symmetrical == true)
 248     new_edge(dst->id(), src->id(), new_extended_route(hierarchy_, dst, src, gw_dst, gw_src, link_list, symmetrical, 0));
 249 }
 250
 251 void DijkstraZone::new_edge(int src_id, int dst_id, RouteCreationArgs* route)
 252 {
 253   XBT_DEBUG("Create Route from '%d' to '%d'", src_id, dst_id);
 254
 255   // Get the extremities, or create them if they don't exist yet
 256   xbt_node_t src = node_map_search(src_id);
 257   if (src == nullptr)
 258     src = route_graph_new_node(src_id);
 259
 260   xbt_node_t dst = node_map_search(dst_id);
 261   if (dst == nullptr)
 262     dst = route_graph_new_node(dst_id);
 263
 264   // Make sure that this graph edge was not already added to the graph
 265   if (xbt_graph_get_edge(route_graph_, src, dst) != nullptr) {
 266     if (route->gw_dst == nullptr || route->gw_src == nullptr)
 267       throw std::invalid_argument(
 268           xbt::string_printf("Route from %s to %s already exists", route->src->get_cname(), route->dst->get_cname()));
 269     else
 270       throw std::invalid_argument(xbt::string_printf("Route from %s@%s to %s@%s already exists",
 271                                                      route->src->get_cname(), route->gw_src->get_cname(),
 272                                                      route->dst->get_cname(), route->gw_dst->get_cname()));
 273   }
 274
 275   // Finally add it
 276   xbt_graph_new_edge(route_graph_, src, dst, route);
 277 }
 278 } // namespace routing
 279 } // namespace kernel
 280 } // namespace simgrid