[VPR] Reworked RRSpatialLookup: added a private API find_nodes() to avoid duplicated codes

Author: tangxifan

vpr/src/device/rr_spatial_lookup.cpp

@@ -74,17 +74,18 @@ RRNodeId RRSpatialLookup::find_node(int x,
     return RRNodeId(rr_node_indices_[type][node_x][node_y][node_side][ptc]);
 }
 
-std::vector<RRNodeId> RRSpatialLookup::find_channel_nodes(int x,
-                                                          int y,
-                                                          t_rr_type type) const {
+std::vector<RRNodeId> RRSpatialLookup::find_nodes(int x,
+                                                  int y,
+                                                  t_rr_type type,
+                                                  e_side side) const {
     /* TODO: The implementation of this API should be worked 
      * when rr_node_indices adapts RRNodeId natively!
      */
-    std::vector<RRNodeId> channel_nodes;
+    std::vector<RRNodeId> nodes;
 
     /* Pre-check: the x, y, type are valid! Otherwise, return an empty vector */
-    if ((x < 0 || y < 0) && (type == CHANX || type == CHANY)) {
-        return channel_nodes;
+    if (x < 0 || y < 0) {
+        return nodes;
     }
 
     /* Currently need to swap x and y for CHANX because of chan, seg convention 
@@ -106,76 +107,44 @@ std::vector<RRNodeId> RRSpatialLookup::find_channel_nodes(int x,
      * - Return an empty list if any out-of-range is detected
      */
     if (size_t(type) >= rr_node_indices_.size()) {
-        return channel_nodes;
+        return nodes;
     }
 
     if (node_x >= rr_node_indices_[type].dim_size(0)) {
-        return channel_nodes;
+        return nodes;
     }
 
     if (node_y >= rr_node_indices_[type].dim_size(1)) {
-        return channel_nodes;
+        return nodes;
     }
 
-    /* By default, we always added the channel nodes to the TOP side (to save memory) */
-    e_side node_side = TOP;
-    if (node_side >= rr_node_indices_[type].dim_size(2)) {
-        return channel_nodes;
+    if (side >= rr_node_indices_[type].dim_size(2)) {
+        return nodes;
     }
 
-    for (const auto& node : rr_node_indices_[type][node_x][node_y][node_side]) {
+    for (const auto& node : rr_node_indices_[type][node_x][node_y][side]) {
         if (RRNodeId(node)) {
-            channel_nodes.push_back(RRNodeId(node));
+            nodes.push_back(RRNodeId(node));
         }
     }
 
-    return channel_nodes;
+    return nodes;
 }
 
-std::vector<RRNodeId> RRSpatialLookup::find_sink_nodes(int x,
-                                                       int y) const {
-    /* TODO: The implementation of this API should be worked 
-     * when rr_node_indices adapts RRNodeId natively!
-     */
-    std::vector<RRNodeId> sink_nodes;
-
-    /* Pre-check: the x, y, type are valid! Otherwise, return an empty vector */
-    if (x < 0 || y < 0) {
-        return sink_nodes;
-    }
-
-    VTR_ASSERT_SAFE(3 == rr_node_indices_[SINK].ndims());
-
-    /* Sanity check to ensure the x, y, side are in range 
-     * - Return a list of valid ids by searching in look-up when all the parameters are in range
-     * - Return an empty list if any out-of-range is detected
-     */
-    if (size_t(SINK) >= rr_node_indices_.size()) {
-        return sink_nodes;
-    }
-
-    if (size_t(x) >= rr_node_indices_[SINK].dim_size(0)) {
-        return sink_nodes;
-    }
-
-    if (size_t(y) >= rr_node_indices_[SINK].dim_size(1)) {
-        return sink_nodes;
-    }
-
-    /* By default, we always added the sink nodes to the TOP side (to save memory) */
-    e_side node_side = TOP;
-    if (node_side >= rr_node_indices_[SINK].dim_size(2)) {
-        return sink_nodes;
+std::vector<RRNodeId> RRSpatialLookup::find_channel_nodes(int x,
+                                                          int y,
+                                                          t_rr_type type) const {
+    /* Pre-check: node type should be routing tracks! */
+    if (type != CHANX && type != CHANY) {
+        return std::vector<RRNodeId>();
     }
 
-    /* Only insert valid ids in the returned vector */
-    for (const auto& node : rr_node_indices_[SINK][x][y][node_side]) {
-        if (RRNodeId(node)) {
-            sink_nodes.push_back(RRNodeId(node));
-        }
-    }
+    return find_nodes(x, y, type);
+}
 
-    return sink_nodes;
+std::vector<RRNodeId> RRSpatialLookup::find_sink_nodes(int x,
+                                                       int y) const {
+    return find_nodes(x, y, SINK);
 }
 
 std::vector<RRNodeId> RRSpatialLookup::find_nodes_at_all_sides(int x,

vpr/src/device/rr_spatial_lookup.h

@@ -180,6 +180,18 @@ class RRSpatialLookup {
                       t_rr_type type,
                       e_side side);
 
+    /* -- Internal data queries -- */
+  private:
+    /* An internal API to find all the nodes in a specific location with a given type
+     * For OPIN/IPIN nodes that may exist on multiple sides, a specific side must be provided  
+     * This API is NOT public because its too powerful for developers with very limited sanity checks 
+     * But it is used to build the public APIs find_channel_nodes() etc., where sufficient sanity checks are applied
+     */
+    std::vector<RRNodeId> find_nodes(int x,
+                                     int y,
+                                     t_rr_type type,
+                                     e_side side = SIDES[0]) const;
+
     /* -- Internal data storage -- */
   private:
     /* TODO: When the refactoring effort finishes,