Merge pull request #1872 from RapidSilicon/api_set_node_x_num

Add a new API set_node_x_num() to RRGraphBuilder

Author: tangxifan

vpr/src/device/rr_graph_builder.h

@@ -69,10 +69,39 @@ class RRGraphBuilder {
         node_storage_.set_node_coordinates(id, x1, y1, x2, y2);
     }
 
+    /** @brief Set the node_ptc_num; The ptc (pin, track, or class) number is an integer
+     * that allows you to differentiate between wires, pins or sources/sinks with overlapping x,y coordinates or extent.
+     * This is useful for drawing rr-graphs nicely.
+     *
+     * The ptc_num carries different meanings for different node types
+     * (true in VPR RRG that is currently supported, may not be true in customized RRG)
+     * CHANX or CHANY: the track id in routing channels
+     * OPIN or IPIN: the index of pins in the logic block data structure
+     * SOURCE and SINK: the class id of a pin (indicating logic equivalence of pins) in the logic block data structure */
+    inline void set_node_ptc_num(RRNodeId id, short new_ptc_num) {
+        node_storage_.set_node_ptc_num(id, new_ptc_num);
+    }
+
+    /** @brief set_node_pin_num() is designed for logic blocks, which are IPIN and OPIN nodes */
+    inline void set_node_pin_num(RRNodeId id, short new_pin_num) {
+        node_storage_.set_node_pin_num(id, new_pin_num);
+    }
+
+    /** @brief set_node_track_num() is designed for routing tracks, which are CHANX and CHANY nodes */
+    inline void set_node_track_num(RRNodeId id, short new_track_num) {
+        node_storage_.set_node_track_num(id, new_track_num);
+    }
+
+    /** @brief set_ node_class_num() is designed for routing source and sinks, which are SOURCE and SINK nodes */
+    inline void set_node_class_num(RRNodeId id, short new_class_num) {
+        node_storage_.set_node_class_num(id, new_class_num);
+    }
+
     /** @brief Set the node direction; The node direction is only available of routing channel nodes, such as x-direction routing tracks (CHANX) and y-direction routing tracks (CHANY). For other nodes types, this value is not meaningful and should be set to NONE. */
     inline void set_node_direction(RRNodeId id, Direction new_direction) {
         node_storage_.set_node_direction(id, new_direction);
     }
+
     /* -- Internal data storage -- */
   private:
     /* TODO: When the refactoring effort finishes, 

vpr/src/route/clock_connection_builders.cpp

@@ -106,11 +106,11 @@ RRNodeId RoutingToClockConnection::create_virtual_clock_network_sink_node(int x,
     }
     int ptc = max_ptc + 1;
 
-    rr_graph.set_node_ptc_num(node_index, ptc);
+    rr_graph_builder.set_node_type(node_index, SINK);
+    rr_graph_builder.set_node_class_num(node_index, ptc);
     rr_graph_builder.set_node_coordinates(node_index, x, y, x, y);
     rr_graph_builder.set_node_capacity(node_index, 1);
     rr_graph.set_node_cost_index(node_index, RRIndexedDataId(SINK_COST_INDEX));
-    rr_graph_builder.set_node_type(node_index, SINK);
 
     float R = 0.;
     float C = 0.;

vpr/src/route/clock_network_builders.cpp

@@ -322,7 +322,7 @@ int ClockRib::create_chanx_wire(int x_start,
     rr_graph_builder.set_node_type(chanx_node, CHANX);
     rr_graph_builder.set_node_coordinates(chanx_node, x_start, y, x_end, y);
     rr_graph_builder.set_node_capacity(chanx_node, 1);
-    node.set_track_num(ptc_num);
+    rr_graph_builder.set_node_track_num(chanx_node, ptc_num);
     node.set_rc_index(find_create_rr_rc_data(
         x_chan_wire.layer.r_metal, x_chan_wire.layer.c_metal));
     rr_graph_builder.set_node_direction(chanx_node, direction);
@@ -628,7 +628,7 @@ int ClockSpine::create_chany_wire(int y_start,
     rr_graph_builder.set_node_type(chany_node, CHANY);
     rr_graph_builder.set_node_coordinates(chany_node, x, y_start, x, y_end);
     rr_graph_builder.set_node_capacity(chany_node, 1);
-    node.set_track_num(ptc_num);
+    rr_graph_builder.set_node_track_num(chany_node, ptc_num);
     node.set_rc_index(find_create_rr_rc_data(
         y_chan_wire.layer.r_metal, y_chan_wire.layer.c_metal));
     rr_graph_builder.set_node_direction(chany_node, direction);

vpr/src/route/rr_graph.cpp

@@ -1438,7 +1438,7 @@ static void build_rr_sinks_sources(RRGraphBuilder& rr_graph_builder,
         float R = 0.;
         float C = 0.;
         L_rr_node.set_node_rc_index(inode, find_create_rr_rc_data(R, C));
-        L_rr_node.set_node_ptc_num(inode, iclass);
+        rr_graph_builder.set_node_class_num(inode, iclass);
     }
 
     /* Connect IPINS to SINKS and initialize OPINS */
@@ -1486,7 +1486,7 @@ static void build_rr_sinks_sources(RRGraphBuilder& rr_graph_builder,
                             float R = 0.;
                             float C = 0.;
                             L_rr_node.set_node_rc_index(inode, find_create_rr_rc_data(R, C));
-                            L_rr_node.set_node_ptc_num(inode, ipin);
+                            rr_graph_builder.set_node_pin_num(inode, ipin);
 
                             //Note that we store the grid tile location and side where the pin is located,
                             //which greatly simplifies the drawing code
@@ -1676,8 +1676,8 @@ static void build_rr_chan(RRGraphBuilder& rr_graph_builder,
         float C = length * seg_details[track].Cmetal();
         L_rr_node.set_node_rc_index(node, find_create_rr_rc_data(R, C));
 
-        L_rr_node.set_node_ptc_num(node, track);
         rr_graph_builder.set_node_type(node, chan_type);
+        rr_graph_builder.set_node_track_num(node, track);
         rr_graph_builder.set_node_direction(node, seg_details[track].direction());
     }
 }

vpr/src/route/rr_graph_uxsdcxx_serializer.h

@@ -604,7 +604,7 @@ class RrGraphSerializer final : public uxsd::RrGraphBase<RrGraphContextTypes> {
         RRNodeId node_id = node.id();
 
         rr_graph_builder_->set_node_coordinates(node_id, xlow, ylow, xhigh, yhigh);
-        node.set_ptc_num(ptc);
+        rr_graph_builder_->set_node_ptc_num(node_id, ptc);
         return inode;
     }
     inline void finish_node_loc(int& /*inode*/) final {}

vpr/src/route/rr_node.cpp

@@ -51,22 +51,6 @@ bool t_rr_node::validate() const {
     return true;
 }
 
-void t_rr_node::set_ptc_num(short new_ptc_num) {
-    storage_->set_node_ptc_num(id_, new_ptc_num);
-}
-
-void t_rr_node::set_pin_num(short new_pin_num) {
-    storage_->set_node_pin_num(id_, new_pin_num);
-}
-
-void t_rr_node::set_track_num(short new_track_num) {
-    storage_->set_node_track_num(id_, new_track_num);
-}
-
-void t_rr_node::set_class_num(short new_class_num) {
-    storage_->set_node_class_num(id_, new_class_num);
-}
-
 void t_rr_node::set_cost_index(RRIndexedDataId new_cost_index) {
     storage_->set_node_cost_index(id_, new_cost_index);
 }

vpr/src/route/rr_node.h

@@ -106,11 +106,6 @@ class t_rr_node {
     bool validate() const;
 
   public: //Mutators
-    void set_ptc_num(short);
-    void set_pin_num(short);   //Same as set_ptc_num() by checks type() is consistent
-    void set_track_num(short); //Same as set_ptc_num() by checks type() is consistent
-    void set_class_num(short); //Same as set_ptc_num() by checks type() is consistent
-
     void set_cost_index(RRIndexedDataId);
     void set_rc_index(short);