Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Constify pointer and reference local variables in src/kernel/.
[simgrid.git] / src / kernel / routing / DijkstraZone.cpp
index b06189f..2694cdf 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-2019. 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 {
+
+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)
+{
+}
 
 static void graph_node_data_free(void* n)
 {
-  delete static_cast<graph_node_data_t>(n);
+  delete static_cast<simgrid::kernel::routing::GraphNodeData*>(n);
 }
 
 static void graph_edge_data_free(void* e)
@@ -27,38 +42,36 @@ static void graph_edge_data_free(void* e)
   delete static_cast<simgrid::kernel::routing::RouteCreationArgs*>(e);
 }
 
-/* Utility functions */
+DijkstraZone::~DijkstraZone()
+{
+  xbt_graph_free_graph(route_graph_, &graph_node_data_free, &graph_edge_data_free, nullptr);
+}
 
-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) {
+  if (network_model_->loopback_ && hierarchy_ == RoutingMode::base) {
     xbt_dynar_foreach (xbt_graph_get_nodes(route_graph_), 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_, node, node, route);
       }
     }
   }
@@ -67,18 +80,14 @@ void DijkstraZone::seal()
   xbt_dynar_t nodes = xbt_graph_get_nodes(route_graph_);
 
   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)
 {
-  graph_node_data_t data = new s_graph_node_data_t;
-  data->id       = id;
-  data->graph_id         = -1;
-
-  xbt_node_t node = xbt_graph_new_node(route_graph_, data);
+  xbt_node_t node = xbt_graph_new_node(route_graph_, new GraphNodeData(id));
   graph_node_map_.emplace(id, node);
 
   return node;
@@ -104,20 +113,19 @@ void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationAr
   xbt_node_t src_elm = node_map_search(src_id);
   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);
 
     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);
@@ -160,9 +168,9 @@ void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationAr
 
       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 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]) {
@@ -175,9 +183,8 @@ 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);
@@ -185,13 +192,13 @@ void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationAr
     xbt_edge_t edge        = xbt_graph_get_edge(route_graph_, 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;
@@ -227,18 +234,6 @@ 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(NetZoneImpl* 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)
 {
@@ -253,31 +248,33 @@ void DijkstraZone::add_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, Net
     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, simgrid::kernel::routing::RouteCreationArgs* route)
+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 = this->route_graph_new_node(src_id);
+    src = route_graph_new_node(src_id);
 
   xbt_node_t dst = node_map_search(dst_id);
   if (dst == nullptr)
-    dst = this->route_graph_new_node(dst_id);
+    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_, src, dst) != nullptr) {
     if (route->gw_dst == nullptr || route->gw_src == nullptr)
-      THROWF(arg_error, 0, "Route from %s to %s already exists", route->src->get_cname(), route->dst->get_cname());
+      throw std::invalid_argument(
+          xbt::string_printf("Route from %s to %s already exists", route->src->get_cname(), route->dst->get_cname()));
     else
-      THROWF(arg_error, 0, "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());
+      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_, src, dst, route);
 }
-}
-}
-} // namespace
+} // namespace routing
+} // namespace kernel
+} // namespace simgrid