Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Dijkstra is so ugly, I could spend weeks cleaning it up
[simgrid.git] / src / kernel / routing / DijkstraZone.cpp
index f6ae5a1..54396c5 100644 (file)
 
 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:
+  GraphNodeData(int id) : id_(id) {}
+  int id_;
+  int graph_id_ = -1; /* used for caching internal graph id's */
+};
+
+DijkstraZone::DijkstraZone(NetZoneImpl* father, std::string name, bool cached)
+    : RoutedZone(father, name), 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,29 +41,28 @@ 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) {
-    xbt_dynar_foreach (xbt_graph_get_nodes(route_graph_), cursor, node) {
 
+    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;
         }
@@ -67,24 +80,20 @@ 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::routeGraphNewNode(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_, 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(int id)
 {
   auto ret = graph_node_map_.find(id);
   return ret == graph_node_map_.end() ? nullptr : ret->second;
@@ -92,52 +101,20 @@ xbt_node_t DijkstraZone::nodeMapSearch(int id)
 
 /* Parsing */
 
-void DijkstraZone::newRoute(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 = 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);
-    }
-  }
-
-  /* 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)
 {
-  getRouteCheckParams(src, dst);
+  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_);
 
   /* 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);
+  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) {
@@ -154,7 +131,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<surf::LinkImpl*>(link)->latency();
+        *lat += static_cast<resource::LinkImpl*>(link)->get_latency();
     }
   }
 
@@ -192,8 +169,8 @@ 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;
+        GraphNodeData* data                = static_cast<GraphNodeData*>(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 */
 
@@ -207,9 +184,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);
@@ -221,15 +197,15 @@ void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationAr
 
     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;
+    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;
+      std::vector<resource::LinkImpl*> e_route_as_to_as;
 
       NetPoint* gw_dst_net_elm      = nullptr;
       NetPoint* prev_gw_src_net_elm = nullptr;
@@ -238,7 +214,7 @@ void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationAr
       for (auto const& link : e_route_as_to_as) {
         route->link_list.insert(pos, link);
         if (lat)
-          *lat += link->latency();
+          *lat += link->get_latency();
         pos++;
       }
     }
@@ -246,7 +222,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<surf::LinkImpl*>(link)->latency();
+        *lat += static_cast<resource::LinkImpl*>(link)->get_latency();
     }
   }
 
@@ -259,65 +235,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(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::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);
 
-  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());
-    }
+  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 =
-        newExtendedRoute(hierarchy_, src, dst, gw_src, gw_dst, link_list, symmetrical, 0);
-    newRoute(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, simgrid::kernel::routing::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_, 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());
+    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());
   }
+
+  // Finally add it
+  xbt_graph_new_edge(route_graph_, src, dst, route);
 }
 }
 }