Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
reorganize *LinkImpl stuff
[simgrid.git] / src / kernel / routing / DijkstraZone.cpp
index 42a622c..65580e9 100644 (file)
@@ -1,89 +1,82 @@
-/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-2021. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "simgrid/kernel/routing/DijkstraZone.hpp"
-#include "simgrid/kernel/routing/NetPoint.hpp"
-#include "src/surf/network_interface.hpp"
-#include "src/surf/xml/platf_private.hpp"
+#include <simgrid/kernel/routing/DijkstraZone.hpp>
+#include <simgrid/kernel/routing/NetPoint.hpp>
+#include <xbt/string.hpp>
 
-#include <cfloat>
+#include "src/kernel/resource/StandardLinkImpl.hpp"
+
+#include <climits>
 #include <queue>
 #include <vector>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
 
-/* Free functions */
+namespace simgrid {
+namespace kernel {
+namespace routing {
 
-static void graph_node_data_free(void* n)
-{
-  delete static_cast<graph_node_data_t>(n);
-}
+class GraphNodeData {
+public:
+  explicit GraphNodeData(unsigned long id) : id_(id) {}
+  unsigned long id_;
+  unsigned long graph_id_ = UINT_MAX; /* used for caching internal graph id's */
+};
 
-static void graph_edge_data_free(void* e)
+void DijkstraZone::route_graph_delete(xbt_graph_t g)
 {
-  delete static_cast<simgrid::kernel::routing::RouteCreationArgs*>(e);
+  xbt_graph_free_graph(
+      g, [](void* n) { delete static_cast<GraphNodeData*>(n); }, [](void* e) { delete static_cast<Route*>(e); },
+      nullptr);
 }
 
-/* Utility functions */
-
-namespace simgrid {
-namespace kernel {
-namespace routing {
-void DijkstraZone::seal()
+void DijkstraZone::do_seal()
 {
   unsigned int cursor;
   xbt_node_t node = nullptr;
 
-  /* Create the topology graph */
-  if (not route_graph_)
-    route_graph_ = xbt_graph_new_graph(1, nullptr);
-
   /* Add the loopback if needed */
-  if (surf_network_model->loopback_ && hierarchy_ == RoutingMode::base) {
-    xbt_dynar_foreach (xbt_graph_get_nodes(route_graph_), cursor, node) {
-
-      bool found = false;
+  if (get_network_model()->loopback_ && get_hierarchy() == RoutingMode::base) {
+    xbt_dynar_foreach (xbt_graph_get_nodes(route_graph_.get()), cursor, node) {
+      bool found      = false;
       xbt_edge_t edge = nullptr;
       unsigned int cursor2;
       xbt_dynar_foreach (xbt_graph_node_get_outedges(node), cursor2, edge) {
-        if (xbt_graph_edge_get_target(edge) == node) {
+        if (xbt_graph_edge_get_target(edge) == node) { // There is an edge from node to itself
           found = true;
           break;
         }
       }
 
       if (not found) {
-        RouteCreationArgs* e_route = new simgrid::kernel::routing::RouteCreationArgs();
-        e_route->link_list.push_back(surf_network_model->loopback_);
-        xbt_graph_new_edge(route_graph_, node, node, e_route);
+        auto* route = new Route();
+        route->link_list_.push_back(get_network_model()->loopback_);
+        xbt_graph_new_edge(route_graph_.get(), node, node, route);
       }
     }
   }
 
   /* initialize graph indexes in nodes after graph has been built */
-  xbt_dynar_t nodes = xbt_graph_get_nodes(route_graph_);
+  const_xbt_dynar_t nodes = xbt_graph_get_nodes(route_graph_.get());
 
   xbt_dynar_foreach (nodes, cursor, node) {
-    graph_node_data_t data = static_cast<graph_node_data_t>(xbt_graph_node_get_data(node));
-    data->graph_id         = cursor;
+    auto* data      = static_cast<GraphNodeData*>(xbt_graph_node_get_data(node));
+    data->graph_id_ = cursor;
   }
 }
 
-xbt_node_t DijkstraZone::routeGraphNewNode(int id, int graph_id)
+xbt_node_t DijkstraZone::route_graph_new_node(unsigned long id)
 {
-  graph_node_data_t data = new s_graph_node_data_t;
-  data->id       = id;
-  data->graph_id = graph_id;
-
-  xbt_node_t node = xbt_graph_new_node(route_graph_, data);
+  xbt_node_t node = xbt_graph_new_node(route_graph_.get(), new GraphNodeData(id));
   graph_node_map_.emplace(id, node);
 
   return node;
 }
 
-xbt_node_t DijkstraZone::nodeMapSearch(int id)
+xbt_node_t DijkstraZone::node_map_search(unsigned long id)
 {
   auto ret = graph_node_map_.find(id);
   return ret == graph_node_map_.end() ? nullptr : ret->second;
@@ -91,88 +84,51 @@ xbt_node_t DijkstraZone::nodeMapSearch(int id)
 
 /* Parsing */
 
-void DijkstraZone::newRoute(int src_id, int dst_id, simgrid::kernel::routing::RouteCreationArgs* e_route)
+void DijkstraZone::get_local_route(const NetPoint* src, const NetPoint* dst, Route* route, double* lat)
 {
-  XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
-  xbt_node_t src = nullptr;
-  xbt_node_t dst = nullptr;
-
-  xbt_node_t src_elm = nodeMapSearch(src_id);
-  xbt_node_t dst_elm = nodeMapSearch(dst_id);
-
-  if (src_elm)
-    src = src_elm;
-
-  if (dst_elm)
-    dst = dst_elm;
-
-  /* add nodes if they don't exist in the graph */
-  if (src_id == dst_id && src == nullptr && dst == nullptr) {
-    src = this->routeGraphNewNode(src_id, -1);
-    dst = src;
-  } else {
-    if (src == nullptr) {
-      src = this->routeGraphNewNode(src_id, -1);
-    }
-    if (dst == nullptr) {
-      dst = this->routeGraphNewNode(dst_id, -1);
-    }
-  }
+  get_route_check_params(src, dst);
+  unsigned long src_id = src->id();
+  unsigned long dst_id = dst->id();
 
-  /* add link as edge to graph */
-  xbt_graph_new_edge(route_graph_, src, dst, e_route);
-}
-
-void DijkstraZone::getLocalRoute(NetPoint* src, NetPoint* dst, RouteCreationArgs* route, double* lat)
-{
-  getRouteCheckParams(src, dst);
-  int src_id = src->id();
-  int dst_id = dst->id();
-
-  xbt_dynar_t nodes = xbt_graph_get_nodes(route_graph_);
+  const_xbt_dynar_t nodes = xbt_graph_get_nodes(route_graph_.get());
 
   /* Use the graph_node id mapping set to quickly find the nodes */
-  xbt_node_t src_elm = nodeMapSearch(src_id);
-  xbt_node_t dst_elm = nodeMapSearch(dst_id);
+  const s_xbt_node_t* src_elm = node_map_search(src_id);
+  const s_xbt_node_t* dst_elm = node_map_search(dst_id);
 
-  int src_node_id = static_cast<graph_node_data_t>(xbt_graph_node_get_data(src_elm))->graph_id;
-  int dst_node_id = static_cast<graph_node_data_t>(xbt_graph_node_get_data(dst_elm))->graph_id;
+  unsigned long src_node_id = static_cast<GraphNodeData*>(xbt_graph_node_get_data(src_elm))->graph_id_;
+  unsigned long dst_node_id = static_cast<GraphNodeData*>(xbt_graph_node_get_data(dst_elm))->graph_id_;
 
   /* if the src and dst are the same */
   if (src_node_id == dst_node_id) {
-
-    xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
-    xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
-    xbt_edge_t edge     = xbt_graph_get_edge(route_graph_, node_s_v, node_e_v);
+    const s_xbt_node_t* node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
+    const s_xbt_node_t* node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
+    const s_xbt_edge_t* edge     = xbt_graph_get_edge(route_graph_.get(), node_s_v, node_e_v);
 
     if (edge == nullptr)
-      THROWF(arg_error, 0, "No route from '%s' to '%s'", src->get_cname(), dst->get_cname());
+      throw std::invalid_argument(xbt::string_printf("No route from '%s' to '%s'", src->get_cname(), dst->get_cname()));
 
-    RouteCreationArgs* e_route = static_cast<RouteCreationArgs*>(xbt_graph_edge_get_data(edge));
+    const Route* e_route = static_cast<Route*>(xbt_graph_edge_get_data(edge));
 
-    for (auto const& link : e_route->link_list) {
-      route->link_list.insert(route->link_list.begin(), link);
-      if (lat)
-        *lat += static_cast<surf::LinkImpl*>(link)->latency();
-    }
+    insert_link_latency(route->link_list_, e_route->link_list_, lat);
   }
 
-  auto elm                   = route_cache_.emplace(src_id, std::vector<int>());
-  std::vector<int>& pred_arr = elm.first->second;
+  auto elm                             = route_cache_.emplace(src_id, std::vector<unsigned long>());
+  std::vector<unsigned long>& pred_arr = elm.first->second;
 
   if (elm.second) { /* new element was inserted (not cached mode, or cache miss) */
-    int nr_nodes      = xbt_dynar_length(nodes);
-    std::vector<double> cost_arr(nr_nodes); /* link cost from src to other hosts */
+    unsigned long nr_nodes = xbt_dynar_length(nodes);
+    std::vector<unsigned long> cost_arr(nr_nodes); /* link cost from src to other hosts */
     pred_arr.resize(nr_nodes);              /* predecessors in path from src */
-    typedef std::pair<double, int> Qelt;
-    std::priority_queue<Qelt, std::vector<Qelt>, std::greater<Qelt>> pqueue;
+    using Qelt = std::pair<double, unsigned long>;
+    std::priority_queue<Qelt, std::vector<Qelt>, std::greater<>> pqueue;
 
     /* initialize */
-    cost_arr[src_node_id] = 0.0;
+    cost_arr[src_node_id] = 0;
 
-    for (int i = 0; i < nr_nodes; i++) {
+    for (unsigned long i = 0; i < nr_nodes; i++) {
       if (i != src_node_id) {
-        cost_arr[i] = DBL_MAX;
+        cost_arr[i] = ULONG_MAX;
       }
 
       pred_arr[i] = 0;
@@ -183,18 +139,18 @@ void DijkstraZone::getLocalRoute(NetPoint* src, NetPoint* dst, RouteCreationArgs
 
     /* apply dijkstra using the indexes from the graph's node array */
     while (not pqueue.empty()) {
-      int v_id = pqueue.top().second;
+      unsigned long v_id = pqueue.top().second;
       pqueue.pop();
-      xbt_node_t v_node = xbt_dynar_get_as(nodes, v_id, xbt_node_t);
-      xbt_edge_t edge   = nullptr;
+      const s_xbt_node_t* v_node = xbt_dynar_get_as(nodes, v_id, xbt_node_t);
+      xbt_edge_t edge            = nullptr;
       unsigned int cursor;
 
       xbt_dynar_foreach (xbt_graph_node_get_outedges(v_node), cursor, edge) {
-        xbt_node_t u_node                  = xbt_graph_edge_get_target(edge);
-        graph_node_data_t data             = static_cast<graph_node_data_t>(xbt_graph_node_get_data(u_node));
-        int u_id                           = data->graph_id;
-        RouteCreationArgs* tmp_e_route     = static_cast<RouteCreationArgs*>(xbt_graph_edge_get_data(edge));
-        int cost_v_u                       = tmp_e_route->link_list.size(); /* count of links, old model assume 1 */
+        const s_xbt_node_t* u_node           = xbt_graph_edge_get_target(edge);
+        const GraphNodeData* data            = static_cast<GraphNodeData*>(xbt_graph_node_get_data(u_node));
+        unsigned long u_id                   = data->graph_id_;
+        const Route* tmp_e_route             = static_cast<Route*>(xbt_graph_edge_get_data(edge));
+        unsigned long cost_v_u               = tmp_e_route->link_list_.size(); /* count of links, old model assume 1 */
 
         if (cost_v_u + cost_arr[v_id] < cost_arr[u_id]) {
           pred_arr[u_id] = v_id;
@@ -206,118 +162,97 @@ void DijkstraZone::getLocalRoute(NetPoint* src, NetPoint* dst, RouteCreationArgs
   }
 
   /* compose route path with links */
-  NetPoint* gw_src = nullptr;
-  NetPoint* gw_dst;
-  NetPoint* first_gw            = nullptr;
+  NetPoint* gw_src   = nullptr;
+  NetPoint* first_gw = nullptr;
 
-  for (int v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
-    xbt_node_t node_pred_v = xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
-    xbt_node_t node_v      = xbt_dynar_get_as(nodes, v, xbt_node_t);
-    xbt_edge_t edge        = xbt_graph_get_edge(route_graph_, node_pred_v, node_v);
+  for (unsigned long v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
+    const s_xbt_node_t* node_pred_v = xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
+    const s_xbt_node_t* node_v      = xbt_dynar_get_as(nodes, v, xbt_node_t);
+    const s_xbt_edge_t* edge        = xbt_graph_get_edge(route_graph_.get(), node_pred_v, node_v);
 
     if (edge == nullptr)
-      THROWF(arg_error, 0, "No route from '%s' to '%s'", src->get_cname(), dst->get_cname());
+      throw std::invalid_argument(xbt::string_printf("No route from '%s' to '%s'", src->get_cname(), dst->get_cname()));
 
-    RouteCreationArgs* e_route = static_cast<RouteCreationArgs*>(xbt_graph_edge_get_data(edge));
+    const Route* e_route = static_cast<Route*>(xbt_graph_edge_get_data(edge));
 
-    NetPoint* prev_gw_src          = gw_src;
-    gw_src                         = e_route->gw_src;
-    gw_dst                         = e_route->gw_dst;
+    const NetPoint* prev_gw_src = gw_src;
+    gw_src                      = e_route->gw_src_;
+    NetPoint* gw_dst            = e_route->gw_dst_;
 
     if (v == dst_node_id)
       first_gw = gw_dst;
 
-    if (hierarchy_ == RoutingMode::recursive && v != dst_node_id && gw_dst->get_name() != prev_gw_src->get_name()) {
-      std::vector<surf::LinkImpl*> e_route_as_to_as;
-
-      NetPoint* gw_dst_net_elm      = nullptr;
-      NetPoint* prev_gw_src_net_elm = nullptr;
-      getGlobalRoute(gw_dst_net_elm, prev_gw_src_net_elm, e_route_as_to_as, nullptr);
-      auto pos = route->link_list.begin();
-      for (auto const& link : e_route_as_to_as) {
-        route->link_list.insert(pos, link);
-        if (lat)
-          *lat += link->latency();
-        pos++;
-      }
-    }
+    if (get_hierarchy() == RoutingMode::recursive && v != dst_node_id &&
+        gw_dst->get_name() != prev_gw_src->get_name()) {
+      std::vector<resource::StandardLinkImpl*> e_route_as_to_as;
 
-    for (auto const& link : e_route->link_list) {
-      route->link_list.insert(route->link_list.begin(), link);
-      if (lat)
-        *lat += static_cast<surf::LinkImpl*>(link)->latency();
+      const NetPoint* gw_dst_net_elm      = nullptr;
+      const NetPoint* prev_gw_src_net_elm = nullptr;
+      get_global_route(gw_dst_net_elm, prev_gw_src_net_elm, e_route_as_to_as, nullptr);
+      std::reverse(begin(e_route_as_to_as), end(e_route_as_to_as));
+      insert_link_latency(route->link_list_, e_route_as_to_as, lat);
     }
+
+    insert_link_latency(route->link_list_, e_route->link_list_, lat);
   }
 
-  if (hierarchy_ == RoutingMode::recursive) {
-    route->gw_src = gw_src;
-    route->gw_dst = first_gw;
+  if (get_hierarchy() == RoutingMode::recursive) {
+    route->gw_src_ = gw_src;
+    route->gw_dst_ = first_gw;
   }
 
   if (not cached_)
     route_cache_.clear();
 }
 
-DijkstraZone::~DijkstraZone()
+void DijkstraZone::add_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
+                             const std::vector<s4u::LinkInRoute>& link_list, bool symmetrical)
 {
-  xbt_graph_free_graph(route_graph_, &graph_node_data_free, &graph_edge_data_free, nullptr);
-}
+  add_route_check_params(src, dst, gw_src, gw_dst, link_list, symmetrical);
 
-/* Creation routing model functions */
+  new_edge(src->id(), dst->id(),
+           new_extended_route(get_hierarchy(), gw_src, gw_dst, get_link_list_impl(link_list, false), true));
 
-DijkstraZone::DijkstraZone(NetZone* father, std::string name, bool cached) : RoutedZone(father, name), cached_(cached)
-{
+  if (symmetrical)
+    new_edge(dst->id(), src->id(),
+             new_extended_route(get_hierarchy(), gw_dst, gw_src, get_link_list_impl(link_list, true), false));
 }
 
-void DijkstraZone::addRoute(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
-                            kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
-                            std::vector<simgrid::surf::LinkImpl*>& link_list, bool symmetrical)
+void DijkstraZone::new_edge(unsigned long src_id, unsigned long dst_id, Route* route)
 {
-  const char* srcName = src->get_cname();
-  const char* dstName = dst->get_cname();
-
-  addRouteCheckParams(src, dst, gw_src, gw_dst, link_list, symmetrical);
-
-  /* Create the topology graph */
-  if (not route_graph_)
-    route_graph_ = xbt_graph_new_graph(1, nullptr);
-
-  /* we don't check whether the route already exist, because the algorithm may find another path through some other
-   * nodes */
-
-  /* Add the route to the base */
-  RouteCreationArgs* e_route = newExtendedRoute(hierarchy_, src, dst, gw_src, gw_dst, link_list, symmetrical, 1);
-  newRoute(src->id(), dst->id(), e_route);
-
-  // Symmetrical YES
-  if (symmetrical == true) {
-
-    xbt_dynar_t nodes   = xbt_graph_get_nodes(route_graph_);
-    xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src->id(), xbt_node_t);
-    xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst->id(), xbt_node_t);
-    xbt_edge_t edge     = xbt_graph_get_edge(route_graph_, node_e_v, node_s_v);
-
-    if (not gw_dst || not gw_src) {
-      XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dstName, srcName);
-      if (edge)
-        THROWF(arg_error, 0, "Route from %s to %s already exists", dstName, srcName);
-    } else {
-      XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", dstName, gw_dst->get_cname(), srcName, gw_src->get_cname());
-      if (edge)
-        THROWF(arg_error, 0, "Route from %s@%s to %s@%s already exists", dstName, gw_dst->get_cname(), srcName,
-               gw_src->get_cname());
-    }
-
-    if (gw_dst && gw_src) {
-      NetPoint* gw_tmp = gw_src;
-      gw_src           = gw_dst;
-      gw_dst           = gw_tmp;
-    }
-    RouteCreationArgs* link_route_back =
-        newExtendedRoute(hierarchy_, src, dst, gw_src, gw_dst, link_list, symmetrical, 0);
-    newRoute(dst->id(), src->id(), link_route_back);
+  XBT_DEBUG("Create Route from '%lu' to '%lu'", src_id, dst_id);
+
+  // Get the extremities, or create them if they don't exist yet
+  xbt_node_t src = node_map_search(src_id);
+  if (src == nullptr)
+    src = route_graph_new_node(src_id);
+
+  xbt_node_t dst = node_map_search(dst_id);
+  if (dst == nullptr)
+    dst = route_graph_new_node(dst_id);
+
+  // Make sure that this graph edge was not already added to the graph
+  if (xbt_graph_get_edge(route_graph_.get(), src, dst) != nullptr) {
+    if (route->gw_dst_ == nullptr || route->gw_src_ == nullptr)
+      throw std::invalid_argument(
+          xbt::string_printf("Route from %s to %s already exists", route->src_->get_cname(), route->dst_->get_cname()));
+    else
+      throw std::invalid_argument(xbt::string_printf("Route from %s@%s to %s@%s already exists",
+                                                     route->src_->get_cname(), route->gw_src_->get_cname(),
+                                                     route->dst_->get_cname(), route->gw_dst_->get_cname()));
   }
+
+  // Finally add it
+  xbt_graph_new_edge(route_graph_.get(), src, dst, route);
 }
+} // namespace routing
+} // namespace kernel
+
+namespace s4u {
+NetZone* create_dijkstra_zone(const std::string& name, bool cache)
+{
+  return (new kernel::routing::DijkstraZone(name, cache))->get_iface();
 }
-}
-} // namespace
+} // namespace s4u
+
+} // namespace simgrid