Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Remove redundant casts.
[simgrid.git] / src / kernel / routing / DijkstraZone.cpp
index b5642e3..d5c854f 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-2020. 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. */
@@ -8,6 +8,7 @@
 #include "src/surf/network_interface.hpp"
 #include "src/surf/xml/platf_private.hpp"
 #include "surf/surf.hpp"
+#include "xbt/string.hpp"
 
 #include <cfloat>
 #include <queue>
 
 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)
+class GraphNodeData {
+public:
+  explicit GraphNodeData(int id) : id_(id) {}
+  int id_;
+  int graph_id_ = -1; /* used for caching internal graph id's */
+};
+
+DijkstraZone::DijkstraZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel, bool cached)
+    : RoutedZone(father, name, netmodel), cached_(cached)
 {
-  delete static_cast<graph_node_data_t>(n);
 }
 
-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<simgrid::kernel::routing::GraphNodeData*>(n); },
+                       [](void* e) { delete static_cast<simgrid::kernel::routing::RouteCreationArgs*>(e); }, nullptr);
 }
 
-/* Utility functions */
-
-namespace simgrid {
-namespace kernel {
-namespace routing {
 void DijkstraZone::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) {
-
+  if (network_model_->loopback_ && 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);
+        RouteCreationArgs* route = new simgrid::kernel::routing::RouteCreationArgs();
+        route->link_list.push_back(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;
+    GraphNodeData* data = static_cast<GraphNodeData*>(xbt_graph_node_get_data(node));
+    data->graph_id_     = cursor;
   }
 }
 
-xbt_node_t DijkstraZone::route_graph_new_node(int id, int graph_id)
+xbt_node_t DijkstraZone::route_graph_new_node(int 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;
@@ -92,69 +89,36 @@ xbt_node_t DijkstraZone::node_map_search(int id)
 
 /* Parsing */
 
-void DijkstraZone::new_route(int src_id, int dst_id, simgrid::kernel::routing::RouteCreationArgs* e_route)
-{
-  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 = node_map_search(src_id);
-  xbt_node_t dst_elm = node_map_search(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->route_graph_new_node(src_id, -1);
-    dst = src;
-  } else {
-    if (src == nullptr) {
-      src = this->route_graph_new_node(src_id, -1);
-    }
-    if (dst == nullptr) {
-      dst = this->route_graph_new_node(dst_id, -1);
-    }
-  }
-
-  /* add link as edge to graph */
-  xbt_graph_new_edge(route_graph_, src, dst, e_route);
-}
-
 void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* route, double* lat)
 {
   get_route_check_params(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 = node_map_search(src_id);
-  xbt_node_t dst_elm = node_map_search(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;
+  int src_node_id = static_cast<GraphNodeData*>(xbt_graph_node_get_data(src_elm))->graph_id_;
+  int 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 RouteCreationArgs* e_route = static_cast<RouteCreationArgs*>(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<resource::LinkImpl*>(link)->get_latency();
+        *lat += link->get_latency();
     }
   }
 
@@ -186,15 +150,15 @@ void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationAr
     while (not pqueue.empty()) {
       int v_id = pqueue.top().second;
       pqueue.pop();
-      xbt_node_t v_node = xbt_dynar_get_as(nodes, v_id, xbt_node_t);
+      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));
+        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));
+        int u_id                           = data->graph_id_;
+        const 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 */
 
         if (cost_v_u + cost_arr[v_id] < cost_arr[u_id]) {
@@ -207,23 +171,22 @@ void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationAr
   }
 
   /* 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);
+    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 RouteCreationArgs* e_route = static_cast<RouteCreationArgs*>(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;
@@ -246,7 +209,7 @@ void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationAr
     for (auto const& link : e_route->link_list) {
       route->link_list.insert(route->link_list.begin(), link);
       if (lat)
-        *lat += static_cast<resource::LinkImpl*>(link)->get_latency();
+        *lat += link->get_latency();
     }
   }
 
@@ -259,65 +222,44 @@ void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationAr
     route_cache_.clear();
 }
 
-DijkstraZone::~DijkstraZone()
-{
-  xbt_graph_free_graph(route_graph_, &graph_node_data_free, &graph_edge_data_free, nullptr);
-}
-
-/* Creation routing model functions */
-
-DijkstraZone::DijkstraZone(NetZone* father, std::string name, bool cached) : RoutedZone(father, name), cached_(cached)
-{
-}
-
 void DijkstraZone::add_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
                              std::vector<resource::LinkImpl*>& link_list, bool symmetrical)
 {
-  const char* srcName = src->get_cname();
-  const char* dstName = dst->get_cname();
-
   add_route_check_params(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 = new_extended_route(hierarchy_, src, dst, gw_src, gw_dst, link_list, symmetrical, 1);
-  new_route(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());
-    }
+  new_edge(src->id(), dst->id(), new_extended_route(hierarchy_, src, dst, gw_src, gw_dst, link_list, symmetrical, 1));
 
-    if (gw_dst && gw_src) {
-      NetPoint* gw_tmp = gw_src;
-      gw_src           = gw_dst;
-      gw_dst           = gw_tmp;
-    }
-    RouteCreationArgs* link_route_back =
-        new_extended_route(hierarchy_, src, dst, gw_src, gw_dst, link_list, symmetrical, 0);
-    new_route(dst->id(), src->id(), link_route_back);
-  }
-}
+  if (symmetrical == true)
+    new_edge(dst->id(), src->id(), new_extended_route(hierarchy_, dst, src, gw_dst, gw_src, link_list, symmetrical, 0));
 }
+
+void DijkstraZone::new_edge(int src_id, int dst_id, RouteCreationArgs* route)
+{
+  XBT_DEBUG("Create Route from '%d' to '%d'", 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
+} // namespace routing
+} // namespace kernel
+} // namespace simgrid