[VPR] Remove the legacy data structure rr_node_indices from DeviceContext, as it is now fully shadowed by the data structure RRSpatialLookup

Author: tangxifan

vpr/src/base/vpr_context.h

@@ -160,26 +160,15 @@ struct DeviceContext : public Context {
     ///@brief Reverse look-up from RR node to non-configurably connected node set (index into rr_nonconf_node_sets)
     std::unordered_map<int, int> rr_node_to_non_config_node_set;
 
-    ///@brief The indicies of rr nodes of a given type at a specific x,y grid location
-    t_rr_node_indices rr_node_indices; // [0..NUM_RR_TYPES-1][0..grid.width()-1][0..grid.width()-1][0..size-1]
-
-    /* TODO: remove this interface from device_context once the code refactoring is completed
-     * because it should be part of the rr_graph view
-     * TODO: Currently, we use reference pointers to ensure that the rr_spatial_lookup is always
-     * synchronized with the rr_node_indices but this causes a lot of confusion for developers
-     * The temporary fix should be patched as soon as possible.
+    /* A writeable view of routing resource graph to be the ONLY database 
+     * for routing resource graph builder functions.
      */
-    RRSpatialLookup rr_spatial_lookup{rr_node_indices};
+    RRGraphBuilder rr_graph_builder{&rr_nodes};
 
     /* A read-only view of routing resource graph to be the ONLY database 
      * for client functions: GUI, placer, router, timing analyzer etc.
      */
-    RRGraphView rr_graph{rr_nodes, rr_spatial_lookup};
-
-    /* A writeable view of routing resource graph to be the ONLY database 
-     * for routing resource graph builder functions.
-     */
-    RRGraphBuilder rr_graph_builder{&rr_nodes, &rr_spatial_lookup};
+    RRGraphView rr_graph{rr_nodes, rr_graph_builder.node_lookup()};
 
     ///@brief Autogenerated in build_rr_graph based on switch fan-in. [0..(num_rr_switches-1)]
     std::vector<t_rr_switch_inf> rr_switch_inf;

vpr/src/device/rr_graph_builder.cpp

@@ -1,10 +1,8 @@
 #include "vtr_log.h"
 #include "rr_graph_builder.h"
 
-RRGraphBuilder::RRGraphBuilder(t_rr_graph_storage* node_storage,
-                               RRSpatialLookup* node_lookup)
-    : node_storage_(*node_storage)
-    , node_lookup_(*node_lookup) {
+RRGraphBuilder::RRGraphBuilder(t_rr_graph_storage* node_storage)
+    : node_storage_(*node_storage) {
 }
 
 t_rr_graph_storage& RRGraphBuilder::node_storage() {
@@ -48,3 +46,7 @@ void RRGraphBuilder::add_node_to_all_locs(RRNodeId node) {
         }
     }
 }
+
+void RRGraphBuilder::clear() {
+    node_lookup_.clear();
+}

vpr/src/device/rr_graph_builder.h

@@ -19,8 +19,7 @@ class RRGraphBuilder {
     /* -- Constructors -- */
   public:
     /* See detailed comments about the data structures in the internal data storage section of this file */
-    RRGraphBuilder(t_rr_graph_storage* node_storage,
-                   RRSpatialLookup* node_lookup);
+    RRGraphBuilder(t_rr_graph_storage* node_storage);
 
     /* Disable copy constructors and copy assignment operator
      * This is to avoid accidental copy because it could be an expensive operation considering that the 
@@ -49,6 +48,9 @@ class RRGraphBuilder {
      */
     void add_node_to_all_locs(RRNodeId node);
 
+    /* Clear all the underlying data storage */
+    void clear();
+
     /* -- Internal data storage -- */
   private:
     /* TODO: When the refactoring effort finishes, 
@@ -63,7 +65,7 @@ class RRGraphBuilder {
     /* node-level storage including edge storages */
     t_rr_graph_storage& node_storage_;
     /* Fast look-up for rr nodes */
-    RRSpatialLookup& node_lookup_;
+    RRSpatialLookup node_lookup_;
 };
 
 #endif

vpr/src/device/rr_graph_view.h

@@ -1,8 +1,7 @@
 #ifndef RR_GRAPH_VIEW_H
 #define RR_GRAPH_VIEW_H
 
-#include "rr_graph_storage.h"
-#include "rr_spatial_lookup.h"
+#include "rr_graph_builder.h"
 
 /* An read-only routing resource graph
  * which is an unified object including pointors to

vpr/src/device/rr_spatial_lookup.cpp

@@ -1,8 +1,7 @@
 #include "vtr_assert.h"
 #include "rr_spatial_lookup.h"
 
-RRSpatialLookup::RRSpatialLookup(t_rr_node_indices& rr_node_indices)
-    : rr_node_indices_(rr_node_indices) {
+RRSpatialLookup::RRSpatialLookup() {
 }
 
 RRNodeId RRSpatialLookup::find_node(int x,
@@ -273,3 +272,27 @@ void RRSpatialLookup::resize_nodes(int x,
                                        std::max(rr_node_indices_[type].dim_size(2), size_t(side) + 1)});
     }
 }
+
+void RRSpatialLookup::reorder(const vtr::vector<RRNodeId, RRNodeId> dest_order) {
+    // update rr_node_indices, a map to optimize rr_index lookups
+    for (auto& grid : rr_node_indices_) {
+        for (size_t x = 0; x < grid.dim_size(0); x++) {
+            for (size_t y = 0; y < grid.dim_size(1); y++) {
+                for (size_t s = 0; s < grid.dim_size(2); s++) {
+                    for (auto& node : grid[x][y][s]) {
+                        if (node != OPEN) {
+                            node = size_t(dest_order[RRNodeId(node)]);
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+}
+
+void RRSpatialLookup::clear() {
+    for (auto& data : rr_node_indices_) {
+        data.clear();
+    }
+}

vpr/src/device/rr_spatial_lookup.h

@@ -2,6 +2,7 @@
 #define RR_SPATIAL_LOOKUP_H
 
 #include "vtr_geometry.h"
+#include "vtr_vector.h"
 #include "vpr_types.h"
 
 /******************************************************************** 
@@ -17,7 +18,7 @@ class RRSpatialLookup {
     /* -- Constructors -- */
   public:
     /* Explicitly define the only way to create an object */
-    explicit RRSpatialLookup(t_rr_node_indices& rr_node_indices);
+    explicit RRSpatialLookup();
 
     /* Disable copy constructors and copy assignment operator
      * This is to avoid accidental copy because it could be an expensive operation considering that the 
@@ -185,6 +186,12 @@ class RRSpatialLookup {
                       t_rr_type type,
                       e_side side);
 
+    /* Reorder the internal look up to be more memory efficient */
+    void reorder(const vtr::vector<RRNodeId, RRNodeId> dest_order);
+
+    /* Clear all the data inside */
+    void clear();
+
     /* -- Internal data queries -- */
   private:
     /* An internal API to find all the nodes in a specific location with a given type
@@ -199,17 +206,8 @@ class RRSpatialLookup {
 
     /* -- Internal data storage -- */
   private:
-    /* TODO: When the refactoring effort finishes, 
-     * the data structure will be the owner of the data storages. 
-     * That is why the reference is used here.
-     * It can avoid a lot of code changes once the refactoring is finished 
-     * (there is no function get data directly through the rr_node_indices in DeviceContext).
-     * If pointers are used, it may cause many codes in client functions 
-     * or inside the data structures to be changed later.
-     * That explains why the reference is used here temporarily
-     */
     /* Fast look-up: TODO: Should rework the data type. Currently it is based on a 3-dimensional arrqay mater where some dimensions must always be accessed with a specific index. Such limitation should be overcome */
-    t_rr_node_indices& rr_node_indices_;
+    t_rr_node_indices rr_node_indices_;
 };
 
 #endif

vpr/src/route/rr_graph.cpp

@@ -1342,12 +1342,10 @@ void free_rr_graph() {
 
     device_ctx.read_rr_graph_filename.clear();
 
-    for (auto& data : device_ctx.rr_node_indices) {
-        data.clear();
-    }
-
     device_ctx.rr_nodes.clear();
 
+    device_ctx.rr_graph_builder.clear();
+
     device_ctx.rr_indexed_data.clear();
 
     device_ctx.rr_switch_inf.clear();

vpr/src/route/rr_graph_util.cpp

@@ -156,20 +156,7 @@ void reorder_rr_graph_nodes(const t_router_opts& router_opts) {
 
     graph.reorder(dest_order, src_order);
 
-    // update rr_node_indices, a map to optimize rr_index lookups
-    for (auto& grid : device_ctx.rr_node_indices) {
-        for (size_t x = 0; x < grid.dim_size(0); x++) {
-            for (size_t y = 0; y < grid.dim_size(1); y++) {
-                for (size_t s = 0; s < grid.dim_size(2); s++) {
-                    for (auto& node : grid[x][y][s]) {
-                        if (node != OPEN) {
-                            node = size_t(dest_order[RRNodeId(node)]);
-                        }
-                    }
-                }
-            }
-        }
-    }
+    device_ctx.rr_graph_builder.node_lookup().reorder(dest_order);
 
     device_ctx.rr_node_metadata.remap_keys([&](int node) { return size_t(dest_order[RRNodeId(node)]); });
     device_ctx.rr_edge_metadata.remap_keys([&](std::tuple<int, int, short> edge) {