address remaining PR comments on auto and commenting

Author: soheilshahrouz

libs/libarchfpga/src/read_xml_arch_file.cpp

@@ -345,7 +345,7 @@ static void process_clock_routing(pugi::xml_node parent,
                                   const std::vector<t_arch_switch_inf>& switches,
                                   pugiutil::loc_data& loc_data);
 
-static std::vector<t_segment_inf> process_segments(pugi::xml_node Parent,
+static std::vector<t_segment_inf> process_segments(pugi::xml_node parent,
                                                    const std::vector<t_arch_switch_inf>& switches,
                                                    int num_layers,
                                                    const bool timing_enabled,
@@ -3804,7 +3804,7 @@ static void process_complex_blocks(pugi::xml_node Node,
     }
 }
 
-static std::vector<t_segment_inf> process_segments(pugi::xml_node Parent,
+static std::vector<t_segment_inf> process_segments(pugi::xml_node parent,
                                                    const std::vector<t_arch_switch_inf>& switches,
                                                    int num_layers,
                                                    const bool timing_enabled,
@@ -3817,16 +3817,16 @@ static std::vector<t_segment_inf> process_segments(pugi::xml_node Parent,
     pugi::xml_node SubElem;
     pugi::xml_node Node;
 
-    // Count the number of segs and check they are in fact of segment elements.
-    int num_segs = count_children(Parent, "segment", loc_data);
+    // Count the number of segs specified in the architecture file.
+    int num_segs = count_children(parent, "segment", loc_data);
 
     // Alloc segment list
     if (num_segs > 0) {
         Segs.resize(num_segs);
     }
 
     // Load the segments.
-    Node = get_first_child(Parent, "segment", loc_data);
+    Node = get_first_child(parent, "segment", loc_data);
 
     bool x_axis_seg_found = false; // Flags to see if we have any x-directed segment type specified
     bool y_axis_seg_found = false; // Flags to see if we have any y-directed segment type specified

libs/librrgraph/src/base/check_rr_graph.cpp

@@ -348,7 +348,7 @@ void check_rr_node(const RRGraphView& rr_graph,
     int ylow = rr_graph.node_ylow(rr_node);
     int yhigh = rr_graph.node_yhigh(rr_node);
     int layer_low = rr_graph.node_layer_low(rr_node);
-    int layer_high = rr_graph.node_layer_low(rr_node);
+    int layer_high = rr_graph.node_layer_high(rr_node);
     int ptc_num = rr_graph.node_ptc_num(rr_node);
     int capacity = rr_graph.node_capacity(rr_node);
     RRIndexedDataId cost_index = rr_graph.node_cost_index(rr_node);

libs/librrgraph/src/base/get_parallel_segs.cpp

@@ -7,6 +7,10 @@ std::vector<t_segment_inf> get_parallel_segs(const std::vector<t_segment_inf>& s
     std::vector<t_segment_inf> result;
     for (size_t i = 0; i < segment_inf.size(); ++i) {
         e_parallel_axis seg_axis = segment_inf[i].parallel_axis;
+
+        // Keep this segment if:
+        //   1. Its axis exactly matches the requested parallel_axis, OR
+        //   2. The requested axis is X or Y (not Z), and the segment is marked BOTH_AXIS.
         if (seg_axis == parallel_axis
             || (parallel_axis != e_parallel_axis::Z_AXIS && seg_axis == e_parallel_axis::BOTH_AXIS)) {
             result.push_back(segment_inf[i]);

libs/librrgraph/src/base/get_parallel_segs.h

@@ -4,11 +4,11 @@
 #include "physical_types.h"
 
 /**
- * @brief Returns segments aligned with a given axis, including BOTH_AXIS segments.
+ * @brief Filters segments aligned with a given axis and records index mappings.
  *
- * Filters the unified segment list (`segment_inf`) to include only segments matching
- * the specified `parallel_axis` or marked as `BOTH_AXIS`. Also populates `seg_index_map`
- * to map unified indices to axis-specific ones.
+ * Iterates through the unified segment list (`segment_inf`) and selects segments
+ * whose `parallel_axis` matches the requested `parallel_axis`. If the requested
+ * axis is not `Z_AXIS`, segments marked as `BOTH_AXIS` are also included.
  *
  * @param segment_inf    Unified list of all segments.
  * @param seg_index_map  Map from unified to axis-specific segment indices.

libs/librrgraph/src/base/rr_graph_utils.cpp

@@ -154,7 +154,7 @@ void rr_set_sink_locs(const RRGraphView& rr_graph, RRGraphBuilder& rr_graph_buil
     for (size_t node = 0; node < rr_graph.num_nodes(); ++node) {
         auto node_id = RRNodeId(node);
 
-        if (rr_graph.node_type((RRNodeId)node_id) != e_rr_type::SINK) {
+        if (rr_graph.node_type(node_id) != e_rr_type::SINK) {
             continue;
         }
 
@@ -170,10 +170,7 @@ void rr_set_sink_locs(const RRGraphView& rr_graph, RRGraphBuilder& rr_graph_buil
         }
 
         const int node_layer = rr_graph.node_layer_low(node_id);
-        // Only CHANZ nodes spand across multiple layers. We're processing SINK nodes
-        if (node_layer !=  rr_graph.node_layer_high(node_id)) {
-            continue;
-        }
+        VTR_ASSERT(node_layer == rr_graph.node_layer_high(node_id));
 
         int node_ptc = rr_graph.node_ptc_num(node_id);
 

libs/librrgraph/src/base/rr_graph_view.h

@@ -416,7 +416,7 @@ class RRGraphView {
             else {                                                      // signal travels in increasing direction, stays at same point, or can travel both directions
                 start_x = " (" + std::to_string(node_xlow(node)) + ","; //start coordinates have smaller value
                 start_y = std::to_string(node_ylow(node)) + ",";
-                start_layer_str = std::to_string(node_layer_high(node)) + ")";
+                start_layer_str = std::to_string(node_layer_low(node)) + ")";
                 end_x = " (" + std::to_string(node_xhigh(node)) + ","; //end coordinates have larger value
                 end_y = std::to_string(node_yhigh(node)) + ",";
                 end_layer_str = std::to_string(node_layer_high(node)) + ")"; //layer number

libs/librrgraph/src/io/rr_graph_uxsdcxx_serializer.h

@@ -431,8 +431,8 @@ class RrGraphSerializer final : public uxsd::RrGraphBase<RrGraphContextTypes> {
             segment_inf_vec_ptr = &segment_inf_z_;
         }
 
-        for(std::vector<t_segment_inf>::size_type i=0; i < segment_inf_vec_ptr->size(); i++){
-            if((*segment_inf_vec_ptr)[i].seg_index == segment_id)
+        for (size_t i = 0; i < segment_inf_vec_ptr->size(); i++){
+            if ((*segment_inf_vec_ptr)[i].seg_index == segment_id)
                 return static_cast<int>(i);
         }
 
@@ -741,7 +741,7 @@ class RrGraphSerializer final : public uxsd::RrGraphBase<RrGraphContextTypes> {
     }
 
     inline void set_node_loc_layer_low(int layer_num, int& inode) final {
-        auto node = (*rr_nodes_)[inode];
+        const t_rr_node& node = (*rr_nodes_)[inode];
         RRNodeId node_id = node.id();
 
         // Currently, we only support two layers
@@ -750,7 +750,7 @@ class RrGraphSerializer final : public uxsd::RrGraphBase<RrGraphContextTypes> {
     }
 
     inline void set_node_loc_layer_high(int layer_num, int& inode) final {
-        auto node = (*rr_nodes_)[inode];
+        const t_rr_node& node = (*rr_nodes_)[inode];
         RRNodeId node_id = node.id();
 
         // Currently, we only support two layers