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