Merge pull request #1951 from RapidSilicon/switch_segments_builder

Add  APIs rr_switch and rr_segment() to RRGraphBuilder

Author: tangxifan

utils/route_diag/src/main.cpp

@@ -104,7 +104,7 @@ static void do_one_route(int source_node, int sink_node,
             device_ctx.rr_nodes,
             &device_ctx.rr_graph,
             device_ctx.rr_rc_data,
-            device_ctx.rr_switch_inf,
+            device_ctx.rr_graph.rr_switch(),
             g_vpr_ctx.mutable_routing().rr_node_route_inf);
     enable_router_debug(router_opts, ClusterNetId(), sink_node, 1, &router);
     bool found_path;

vpr/src/base/stats.cpp

@@ -46,9 +46,10 @@ void routing_stats(bool full_stats, enum e_route_type route_type, std::vector<t_
     float area, used_area;
 
     auto& device_ctx = g_vpr_ctx.device();
+    auto& rr_graph = device_ctx.rr_graph;
     auto& cluster_ctx = g_vpr_ctx.clustering();
 
-    int num_rr_switch = device_ctx.rr_switch_inf.size();
+    int num_rr_switch = rr_graph.num_rr_switches();
 
     length_and_bends_stats();
     print_channel_stats();

vpr/src/base/vpr_context.h

@@ -168,14 +168,7 @@ struct DeviceContext : public Context {
     /* 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_graph_builder.node_lookup(), rr_indexed_data, rr_segments, rr_switch_inf};
-
-    ///@brief Autogenerated in build_rr_graph based on switch fan-in. [0..(num_rr_switches-1)]
-    vtr::vector<RRSwitchId, t_rr_switch_inf> rr_switch_inf;
-
-    ///@brief Wire segment types in RR graph
-    vtr::vector<RRSegmentId, t_segment_inf> rr_segments;
-
+    RRGraphView rr_graph{rr_nodes, rr_graph_builder.node_lookup(), rr_indexed_data, rr_graph_builder.rr_segments(), rr_graph_builder.rr_switch()};
     int num_arch_switches;
     t_arch_switch_inf* arch_switch_inf; // [0..(num_arch_switches-1)]
 

vpr/src/device/rr_graph_builder.cpp

@@ -59,6 +59,8 @@ void RRGraphBuilder::add_node_to_all_locs(RRNodeId node) {
 
 void RRGraphBuilder::clear() {
     node_lookup_.clear();
+    rr_segments_.clear();
+    rr_switch_inf_.clear();
 }
 
 void RRGraphBuilder::reorder_nodes(e_rr_node_reorder_algorithm reorder_rr_graph_nodes_algorithm,

vpr/src/device/rr_graph_builder.h

@@ -40,6 +40,47 @@ class RRGraphBuilder {
     t_rr_graph_storage& node_storage();
     /** @brief Return a writable object for update the fast look-up of rr_node */
     RRSpatialLookup& node_lookup();
+
+    /** @brief Add a rr_segment to the routing resource graph. Return an valid id if successful.
+     *  - Each rr_segment contains the detailed information of a routing track, which is denoted by a node in CHANX or CHANY type.
+     * - It is frequently used by client functions in timing and routability prediction.
+     */
+    inline RRSegmentId add_rr_segment(const t_segment_inf& segment_info) {
+        //Allocate an ID
+        RRSegmentId segment_id = RRSegmentId(segment_ids_.size());
+        segment_ids_.push_back(segment_id);
+
+        rr_segments_.push_back(segment_info);
+
+        return segment_id;
+    }
+    /** TODO @brief Return a writable list of all the rr_segments
+     * .. warning:: It is not recommended to use this API unless you have to. The API may be deprecated later, and future APIs will designed to return a specific data from the rr_segments.
+     */
+    inline vtr::vector<RRSegmentId, t_segment_inf>& rr_segments() {
+        return rr_segments_;
+    }
+
+    /** @brief Add a rr_switch to the routing resource graph. Return an valid id if successful.
+     *  - Each rr_switch contains the detailed information of a routing switch interconnecting two routing resource nodes.
+     * - It is frequently used by client functions in timing prediction.
+     */
+    inline RRSwitchId add_rr_switch(const t_rr_switch_inf& switch_info) {
+        //Allocate an ID
+        RRSwitchId switch_id = RRSwitchId(switch_ids_.size());
+        switch_ids_.push_back(switch_id);
+
+        rr_switch_inf_.push_back(switch_info);
+
+        return switch_id;
+    }
+    /** TODO @brief Return a writable list of all the rr_switches
+     * .. warning:: It is not recommended to use this API unless you have to. The API may be deprecated later, and future APIs will designed to return a specific data from the rr_switches.
+     */
+    inline vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switch() {
+        return rr_switch_inf_;
+    }
+
     /** @brief Set the type of a node with a given valid id */
     inline void set_node_type(RRNodeId id, t_rr_type type) {
         node_storage_.set_node_type(id, type);
@@ -185,15 +226,29 @@ class RRGraphBuilder {
         return node_storage_.count_rr_switches(num_arch_switches, arch_switch_inf, arch_switch_fanins);
     }
 
-    /** @brief This function reserve storage for RR nodes. */
+    /** @brief Reserve the lists of nodes, edges, switches etc. to be memory efficient.
+     * This function is mainly used to reserve memory space inside RRGraph,
+     * when adding a large number of nodes/edge/switches/segments,
+     * in order to avoid memory fragements */
     inline void reserve_nodes(size_t size) {
         node_storage_.reserve(size);
     }
-
+    inline void reserve_segments(size_t num_segments) {
+        this->segment_ids_.reserve(num_segments);
+        this->rr_segments_.reserve(num_segments);
+    }
+    inline void reserve_switches(size_t num_switches) {
+        this->switch_ids_.reserve(num_switches);
+        this->rr_switch_inf_.reserve(num_switches);
+    }
     /** @brief This function resize node storage to accomidate size RR nodes. */
     inline void resize_nodes(size_t size) {
         node_storage_.resize(size);
     }
+    /** @brief This function resize rr_switch to accomidate size RR Switch. */
+    inline void resize_switches(size_t size) {
+        rr_switch_inf_.resize(size);
+    }
 
     /** brief Validate that edge data is partitioned correctly
      * @note This function is used to validate the correctness of the routing resource graph in terms
@@ -235,6 +290,20 @@ class RRGraphBuilder {
     /* Fast look-up for rr nodes */
     RRSpatialLookup node_lookup_;
 
+    /**  Wire segment types in RR graph
+     * - Each rr_segment contains the detailed information of a routing track, which is denoted by a node in CHANX or CHANY type.
+     * - We use a fly-weight data structure here, in the same philosophy as the rr_indexed_data. See detailed explanation in the t_segment_inf data structure
+     */
+    vtr::vector<RRSegmentId, t_segment_inf> rr_segments_; /* detailed information about the segments, which are used in the RRGraph */
+    vtr::vector<RRSegmentId, RRSegmentId> segment_ids_;   /* unique identifiers for routing segments which are used in the RRGraph */
+    /* Autogenerated in build_rr_graph based on switch fan-in.
+     *  - Each rr_switch contains the detailed information of a routing switch interconnecting two routing resource nodes.
+     *  - We use a fly-weight data structure here, in the same philosophy as the rr_indexed_data. See detailed explanation in the t_rr_switch_inf data structure
+     */
+    vtr::vector<RRSwitchId, RRSwitchId> switch_ids_;
+    /* Detailed information about the switches, which are used in the RRGraph */
+    vtr::vector<RRSwitchId, t_rr_switch_inf> rr_switch_inf_;
+
     /* Metadata is an extra data on rr-nodes and edges, respectively, that is not used by vpr
      * but simply passed through the flow so that it can be used by downstream tools.
      * The main (perhaps only) current use of this metadata is the fasm tool of symbiflow,

vpr/src/device/rr_graph_view.h

@@ -379,6 +379,15 @@ class RRGraphView {
     inline const t_segment_inf& rr_segments(RRSegmentId seg_id) const {
         return rr_segments_[seg_id];
     }
+    /** @brief Return the number of rr_segments in the routing resource graph */
+    inline size_t num_rr_segments() const {
+        return rr_segments_.size();
+    }
+    /** @brief Return a read-only list of rr_segments for queries from client functions  */
+    inline const vtr::vector<RRSegmentId, t_segment_inf>& rr_segments() const {
+        return rr_segments_;
+    }
+
     /** @brief  Return the switch information that is categorized in the rr_switch_inf with a given id
      * rr_switch_inf is created to minimize memory footprint of RRGraph classs
      * While the RRG could contain millions (even much larger) of edges, there are only
@@ -397,6 +406,14 @@ class RRGraphView {
     inline const t_rr_switch_inf& rr_switch_inf(RRSwitchId switch_id) const {
         return rr_switch_inf_[switch_id];
     }
+    /** @brief Return the number of rr_segments in the routing resource graph */
+    inline size_t num_rr_switches() const {
+        return rr_switch_inf_.size();
+    }
+    /** @brief Return the rr_switch_inf_ structure for queries from client functions */
+    inline const vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switch() const {
+        return rr_switch_inf_;
+    }
 
     /** @brief Return the fast look-up data structure for queries from client functions */
     const RRSpatialLookup& node_lookup() const {

vpr/src/power/power_sizing.cpp

@@ -379,7 +379,7 @@ static double power_count_transistors_switchbox() {
 
     auto& device_ctx = g_vpr_ctx.device();
     const auto& rr_graph = device_ctx.rr_graph;
-    for (size_t seg_idx = 0; seg_idx < device_ctx.rr_segments.size(); seg_idx++) {
+    for (size_t seg_idx = 0; seg_idx < rr_graph.num_rr_segments(); seg_idx++) {
         /* In each switchbox, the different types of segments occur with relative freqencies.
          * Thus the total number of wires of each segment type is (#tracks * freq * 2).
          * The (x2) factor accounts for vertical and horizontal tracks.

vpr/src/route/check_route.cpp

@@ -56,7 +56,7 @@ void check_route(enum e_route_type route_type, e_check_route_option check_route_
     auto& cluster_ctx = g_vpr_ctx.clustering();
     auto& route_ctx = g_vpr_ctx.routing();
 
-    const int num_switches = device_ctx.rr_switch_inf.size();
+    const int num_switches = rr_graph.num_rr_switches();
 
     VTR_LOG("\n");
     VTR_LOG("Checking to ensure routing is legal...\n");

vpr/src/route/check_rr_graph.cpp

@@ -52,7 +52,7 @@ void check_rr_graph(const t_graph_type graph_type,
 
     auto total_edges_to_node = std::vector<int>(device_ctx.rr_nodes.size());
     auto switch_types_from_current_to_node = std::vector<unsigned char>(device_ctx.rr_nodes.size());
-    const int num_rr_switches = device_ctx.rr_switch_inf.size();
+    const int num_rr_switches = rr_graph.num_rr_switches();
 
     std::vector<std::pair<int, int>> edges;
 

vpr/src/route/route_timing.cpp

@@ -342,7 +342,7 @@ bool try_timing_driven_route_tmpl(const t_router_opts& router_opts,
         device_ctx.rr_nodes,
         &device_ctx.rr_graph,
         device_ctx.rr_rc_data,
-        device_ctx.rr_switch_inf,
+        device_ctx.rr_graph.rr_switch(),
         route_ctx.rr_node_route_inf);
 
     // Make sure template type ConnectionRouter is a ConnectionRouterInterface.

vpr/src/route/router_delay_profiling.cpp

@@ -19,7 +19,7 @@ RouterDelayProfiler::RouterDelayProfiler(
           g_vpr_ctx.device().rr_nodes,
           &g_vpr_ctx.device().rr_graph,
           g_vpr_ctx.device().rr_rc_data,
-          g_vpr_ctx.device().rr_switch_inf,
+          g_vpr_ctx.device().rr_graph.rr_switch(),
           g_vpr_ctx.mutable_routing().rr_node_route_inf) {}
 
 bool RouterDelayProfiler::calculate_delay(int source_node, int sink_node, const t_router_opts& router_opts, float* net_delay) {
@@ -124,7 +124,7 @@ std::vector<float> calculate_all_path_delays_from_rr_node(int src_rr_node, const
         device_ctx.rr_nodes,
         &g_vpr_ctx.device().rr_graph,
         device_ctx.rr_rc_data,
-        device_ctx.rr_switch_inf,
+        device_ctx.rr_graph.rr_switch(),
         routing_ctx.rr_node_route_inf);
     RouterStats router_stats;