[vpr] apply code format rules to tileable RR Graph files

amin1377 · amin1377 · commit 1d1318d90e4e · 2025-06-25T16:26:41.000-04:00
diff --git a/libs/librrgraph/src/base/rr_graph_storage.cpp b/libs/librrgraph/src/base/rr_graph_storage.cpp
@@ -575,12 +575,12 @@ t_edge_size t_rr_graph_storage::num_non_configurable_edges(RRNodeId node, const
 }
 
 bool t_rr_graph_storage::edge_is_configurable(RREdgeId edge, const vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switches) const {
-  auto iswitch = edge_switch(edge);
+  short iswitch = edge_switch(edge);
   return rr_switches[RRSwitchId(iswitch)].configurable();
 }
 
 bool t_rr_graph_storage::edge_is_configurable(RRNodeId id, t_edge_size iedge, const vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switches) const {
-  auto iswitch = edge_switch(id, iedge);
+  short iswitch = edge_switch(id, iedge);
   return rr_switches[RRSwitchId(iswitch)].configurable();
 }
 
@@ -715,7 +715,7 @@ static int get_node_mux_num(
     vtr::array_view_id<RRNodeId, const t_rr_node_data> node_storage,
     vtr::array_view_id<RRNodeId, const t_rr_node_ptc_data> node_ptc,
     RRNodeId id) {
-    auto node_type = node_storage[id].type_;
+    e_rr_type node_type = node_storage[id].type_;
     if (node_type != e_rr_type::MUX) {
         VTR_LOG_ERROR("Attempted to access RR node 'mux_num' for non-MUX type '%s'\n", rr_node_typename[node_type]);
     }
@@ -755,7 +755,7 @@ void t_rr_graph_storage::set_node_name(RRNodeId id, const std::string& new_name)
     node_name_.insert(std::make_pair(id, new_name));
 }
 void t_rr_graph_storage::set_node_coordinates(RRNodeId id, short x1, short y1, short x2, short y2) {
-    auto& node = node_storage_[id];
+    t_rr_node_data& node = node_storage_[id];
     if (x1 < x2) {
         node.xlow_ = x1;
         node.xhigh_ = x2;
@@ -782,7 +782,7 @@ void t_rr_graph_storage::set_node_bend_end(RRNodeId id, size_t bend_end) {
 }
 
 void t_rr_graph_storage::set_node_cost_index(RRNodeId id, RRIndexedDataId new_cost_index) {
-    auto& node = node_storage_[id];
+    t_rr_node_data& node = node_storage_[id];
     if ((size_t)new_cost_index >= std::numeric_limits<decltype(node.cost_index_)>::max()) {
         VTR_LOG_ERROR("Attempted to set cost_index_ %zu above cost_index storage max value.\n",
                       new_cost_index);
@@ -835,15 +835,19 @@ void t_rr_graph_storage::set_virtual_clock_network_root_idx(RRNodeId virtual_clo
 int t_rr_graph_view::node_ptc_num(RRNodeId id) const {
     return node_ptc_[id].ptc_.pin_num;
 }
+
 int t_rr_graph_view::node_pin_num(RRNodeId id) const {
     return get_node_pin_num(node_storage_, node_ptc_, id);
 }
+
 int t_rr_graph_view::node_track_num(RRNodeId id) const {
     return get_node_track_num(node_storage_, node_ptc_, id);
 }
+
 int t_rr_graph_view::node_class_num(RRNodeId id) const {
     return get_node_class_num(node_storage_, node_ptc_, id);
 }
+
 int t_rr_graph_view::node_mux_num(RRNodeId id) const {
     return get_node_mux_num(node_storage_, node_ptc_, id);
 }
@@ -889,7 +893,7 @@ void t_rr_graph_storage::reorder(const vtr::vector<RRNodeId, RRNodeId>& order,
 
         // Reorder nodes
         for (size_t i = 0; i < node_storage_.size(); i++) {
-            auto n = RRNodeId(i);
+            RRNodeId n = RRNodeId(i);
             VTR_ASSERT(n == inverse_order[order[n]]);
             node_storage_[order[n]] = old_node_storage[n];
         }
@@ -905,8 +909,8 @@ void t_rr_graph_storage::reorder(const vtr::vector<RRNodeId, RRNodeId>& order,
         // Reorder edges by source node
         for (size_t i = 0; i < node_storage_.size(); i++) {
             node_first_edge_[RRNodeId(i)] = cur_edge;
-            auto n = inverse_order[RRNodeId(i)];
-            for (auto e = old_node_first_edge[n];
+            RRNodeId n = inverse_order[RRNodeId(i)];
+            for (RREdgeId e = old_node_first_edge[n];
                  e < old_node_first_edge[RRNodeId(size_t(n) + 1)];
                  e = RREdgeId(size_t(e) + 1)) {
                 edge_src_node_[cur_edge] = order[old_edge_src_node[e]]; // == n?
diff --git a/libs/librrgraph/src/base/rr_graph_storage.h b/libs/librrgraph/src/base/rr_graph_storage.h
@@ -187,6 +187,7 @@ class t_rr_graph_storage {
     short node_bend_start(RRNodeId id) const {
         return node_bend_start_[id];
     }
+    
     short node_bend_end(RRNodeId id) const {
         return node_bend_end_[id];
     }
@@ -228,7 +229,7 @@ class t_rr_graph_storage {
     int node_pin_num(RRNodeId id) const;   //Same as ptc_num() but checks that type() is consistent
     int node_track_num(RRNodeId id) const; //Same as ptc_num() but checks that type() is consistent
     int node_class_num(RRNodeId id) const; //Same as ptc_num() but checks that type() is consistent
-    int node_mux_num(RRNodeId id) const; //Same as ptc_num() but checks that type() is consistent
+    int node_mux_num(RRNodeId id) const;   //Same as ptc_num() but checks that type() is consistent
 
     /** @brief Retrieve fan_in for RRNodeId, init_fan_in must have been called first. */
     t_edge_size fan_in(RRNodeId id) const {
@@ -337,18 +338,18 @@ class t_rr_graph_storage {
      *
      * Only call these methods after partition_edges has been invoked.
      */
-    edge_idx_range edges(const RRNodeId& id) const {
+    edge_idx_range edges(const RRNodeId id) const {
         return vtr::make_range(edge_idx_iterator(0), edge_idx_iterator(num_edges(id)));
     }
 
-    edge_idx_range configurable_edges(const RRNodeId& id, const vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switches) const {
+    edge_idx_range configurable_edges(const RRNodeId id, const vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switches) const {
         return vtr::make_range(edge_idx_iterator(0), edge_idx_iterator(num_edges(id) - num_non_configurable_edges(id, rr_switches)));
     }
-    edge_idx_range non_configurable_edges(const RRNodeId& id, const vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switches) const {
+    edge_idx_range non_configurable_edges(const RRNodeId id, const vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switches) const {
         return vtr::make_range(edge_idx_iterator(num_edges(id) - num_non_configurable_edges(id, rr_switches)), edge_idx_iterator(num_edges(id)));
     }
 
-    t_edge_size num_edges(const RRNodeId& id) const {
+    t_edge_size num_edges(const RRNodeId id) const {
         return size_t(last_edge(id)) - size_t(first_edge(id));
     }
     bool edge_is_configurable(RREdgeId edge, const vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switches) const;
@@ -363,7 +364,7 @@ class t_rr_graph_storage {
      *
      * If first_edge == last_edge, then a RRNodeId has no edges.
      */
-     RREdgeId first_edge(const RRNodeId& id) const {
+     RREdgeId first_edge(const RRNodeId id) const {
         return node_first_edge_[id];
     }
 
@@ -372,7 +373,7 @@ class t_rr_graph_storage {
      * we always allocate that dummy node. We also assume that the edges have
      * been sorted by rr_node, which is true after partition_edges().
      */
-    RREdgeId last_edge(const RRNodeId& id) const {
+    RREdgeId last_edge(const RRNodeId id) const {
         return (&node_first_edge_[id])[1];
     }
 
@@ -411,19 +412,19 @@ class t_rr_graph_storage {
     }
 
     /** @brief Get the source node for the specified edge. */
-    RRNodeId edge_src_node(const RREdgeId& edge) const {
+    RRNodeId edge_src_node(const RREdgeId edge) const {
         VTR_ASSERT_DEBUG(edge.is_valid());
         return edge_src_node_[edge];
     }
 
     /** @brief Get the destination node for the specified edge. */
-    RRNodeId edge_sink_node(const RREdgeId& edge) const {
+    RRNodeId edge_sink_node(const RREdgeId edge) const {
         VTR_ASSERT_DEBUG(edge.is_valid());
         return edge_dest_node_[edge];
     }
 
     // Get the source node for the specified edge.
-    RRNodeId edge_source_node(const RREdgeId& edge) const {
+    RRNodeId edge_source_node(const RREdgeId edge) const {
         return edge_src_node_[edge];
     }
 
@@ -440,17 +441,17 @@ class t_rr_graph_storage {
      * This method should generally not be used, and instead first_edge and
      * last_edge should be used.
      */
-    RRNodeId edge_sink_node(const RRNodeId& id, t_edge_size iedge) const {
+    RRNodeId edge_sink_node(const RRNodeId id, t_edge_size iedge) const {
         return edge_sink_node(edge_id(id, iedge));
     }
 
     // Get the source node for the iedge'th edge from specified RRNodeId.
-    RRNodeId edge_source_node(const RRNodeId& id, t_edge_size iedge) const {
+    RRNodeId edge_source_node(const RRNodeId id, t_edge_size iedge) const {
         return edge_source_node(edge_id(id, iedge));
     }
 
     /** @brief Get the switch used for the specified edge. */
-    short edge_switch(const RREdgeId& edge) const {
+    short edge_switch(const RREdgeId edge) const {
         return edge_switch_[edge];
     }
 
@@ -459,7 +460,7 @@ class t_rr_graph_storage {
      * This method should generally not be used, and instead first_edge and
      * last_edge should be used.
      */
-    short edge_switch(const RRNodeId& id, t_edge_size iedge) const {
+    short edge_switch(const RRNodeId id, t_edge_size iedge) const {
         return edge_switch(edge_id(id, iedge));
     }
 
@@ -791,8 +792,8 @@ class t_rr_graph_storage {
      */
     static inline bool is_node_on_specific_side(
         vtr::array_view_id<RRNodeId, const t_rr_node_data> node_storage,
-        const RRNodeId& id,
-        const e_side& side) {
+        const RRNodeId id,
+        const e_side side) {
         auto& node_data = node_storage[id];
         if (node_data.type_ != e_rr_type::IPIN && node_data.type_ != e_rr_type::OPIN) {
             VTR_LOG_ERROR("Attempted to access RR node 'side' for non-IPIN/OPIN type '%s'",
@@ -1035,7 +1036,7 @@ class t_rr_graph_view {
     int node_pin_num(RRNodeId id) const;   //Same as ptc_num() but checks that type() is consistent
     int node_track_num(RRNodeId id) const; //Same as ptc_num() but checks that type() is consistent
     int node_class_num(RRNodeId id) const; //Same as ptc_num() but checks that type() is consistent
-    int node_mux_num(RRNodeId id) const; //Same as ptc_num() but checks that type() is consistent
+    int node_mux_num(RRNodeId id) const;   //Same as ptc_num() but checks that type() is consistent
 
     /**
     * @brief Retrieve the fan-in for a given RRNodeId.
diff --git a/vpr/src/base/read_blif.cpp b/vpr/src/base/read_blif.cpp
@@ -695,7 +695,7 @@ bool is_real_param(const std::string& param) {
     }
 
     /* The string must match the regular expression */
-    static const std::regex real_number_expr("[+-]?([0-9]*\\.[0-9]+)|([0-9]+\\.[0-9]*)");
+    const std::regex real_number_expr("[+-]?([0-9]*\\.[0-9]+)|([0-9]+\\.[0-9]*)");
     if (!std::regex_match(param, real_number_expr)) {
         return false;
     }
diff --git a/vpr/src/base/setup_vib_grid.cpp b/vpr/src/base/setup_vib_grid.cpp
@@ -100,7 +100,7 @@ static VibDeviceGrid build_vib_device_grid(const t_vib_grid_def& grid_def, size_
     FormulaParser p;
     std::set<const VibInf*> seen_types;
     for (int layer = 0; layer < num_layers; layer++) {
-        for (const auto& grid_loc_def : grid_def.layers.at(layer).loc_defs) {
+        for (const t_vib_grid_loc_def& grid_loc_def : grid_def.layers.at(layer).loc_defs) {
             //Fill in the block types according to the specification
             const VibInf* type = nullptr;
             for (size_t vib_type = 0; vib_type < device_ctx.arch->vib_infs.size(); vib_type++) {
diff --git a/vpr/src/base/setup_vpr.cpp b/vpr/src/base/setup_vpr.cpp
@@ -1124,7 +1124,7 @@ static void process_from_or_to_tokens(const std::vector<std::string> Tokens, con
                     parse_pin_name(Token_char, &start_pin_index, &end_pin_index, pb_type_name, port_name);
 
                     std::vector<int> all_sub_tile_to_tile_pin_indices;
-                    for (t_sub_tile& sub_tile : PhysicalTileTypes[i_phy_type].sub_tiles) {
+                    for (const t_sub_tile& sub_tile : PhysicalTileTypes[i_phy_type].sub_tiles) {
                         int sub_tile_capacity = sub_tile.capacity.total();
 
                         int start = 0;
diff --git a/vpr/src/base/vpr_context.h b/vpr/src/base/vpr_context.h
@@ -179,7 +179,8 @@ struct DeviceContext : public Context {
     DeviceGrid grid;
 
     /**
-     * @brief The VIB device grid
+     * @brief The VIB device grid. For details about this layout
+     * refer to https://doi.org/10.1109/ICFPT59805.2023.00014
      */
     VibDeviceGrid vib_grid;
 
@@ -242,7 +243,16 @@ 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_graph_builder.rr_nodes(), rr_graph_builder.node_lookup(), rr_graph_builder.rr_node_metadata(), rr_graph_builder.rr_edge_metadata(), rr_indexed_data, rr_rc_data, rr_graph_builder.rr_segments(), rr_graph_builder.rr_switch(), rr_graph_builder.node_in_edge_storage(), rr_graph_builder.node_ptc_storage()};
+    RRGraphView rr_graph{rr_graph_builder.rr_nodes(),
+                         rr_graph_builder.node_lookup(),
+                         rr_graph_builder.rr_node_metadata(),
+                         rr_graph_builder.rr_edge_metadata(),
+                         rr_indexed_data,
+                         rr_rc_data,
+                         rr_graph_builder.rr_segments(),
+                         rr_graph_builder.rr_switch(),
+                         rr_graph_builder.node_in_edge_storage(),
+                         rr_graph_builder.node_ptc_storage()};
 
     /* Track ids for each rr_node in the rr_graph.
      * This is used by drawer for tileable routing resource graph
diff --git a/vpr/src/base/vpr_types.h b/vpr/src/base/vpr_types.h
@@ -1407,20 +1407,40 @@ struct t_det_routing_arch {
     /// the CUSTOM switch block type. See comment at top of SRC/route/build_switchblocks.c
     std::vector<t_switchblock_inf> switchblocks;
 
-    /// Subtype of switch blocks.
     /// Sub type and Fs are applied to pass tracks
     int sub_fs;
+
+    /// Subtype of switch blocks.
     enum e_switch_block_type switch_block_subtype;
 
-    /// Tileable routing parameters
+    // Following options are used only for tileable routing architecture
+
+    /// Whether the routing architecture is tileable
     bool tileable;
+
+    /// Allow connection blocks to appear around the perimeter programmable block (mainly I/Os)
     bool perimeter_cb;
+
+    /// Remove all the routing wires in empty regions
     bool shrink_boundary;
+
+    /// Allow routing channels to pass through multi-width and multi-height programmable blocks.
     bool through_channel;
+
+    /// Allow each output pin of a programmable block to drive the routing tracks on all the 
+    /// sides of its adjacent switch block
     bool opin2all_sides;
+
+    ///In each switch block, allow each routing track which ends to drive another 
+    /// routing track on the opposite side
     bool concat_wire;
+
+    /// In each switch block, allow each routing track which passes to drive 
+    /// another routing track on the opposite side
     bool concat_pass_wire;
 
+    // End of tileable routing architecture-specific options
+
     short global_route_switch;
 
     /// Index of a zero delay switch (used to connect things that should have no delay).
diff --git a/vpr/src/route/rr_graph_generation/clb2clb_directs.h b/vpr/src/route/rr_graph_generation/clb2clb_directs.h

Original file line number	Diff line number	Diff line change
`@@ -695,7 +695,7 @@ bool is_real_param(const std::string& param) {`
`695`	`695`	`}`
`696`	`696`
`697`	`697`	`/* The string must match the regular expression */`
`698`		`- static const std::regex real_number_expr("[+-]?([0-9]\\.[0-9]+)\|([0-9]+\\.[0-9])");`
	`698`	`+ const std::regex real_number_expr("[+-]?([0-9]\\.[0-9]+)\|([0-9]+\\.[0-9])");`
`699`	`699`	`if (!std::regex_match(param, real_number_expr)) {`
`700`	`700`	`return false;`
`701`	`701`	`}`