src/kernel/routing/DijkstraZone.cpp

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