Merge pull request #2933 from verilog-to-routing/temp_format_try2

Another update of the code base to be consistent with code formatting rules

Author: amin1377

libs/libarchfpga/src/device_grid.h

@@ -19,7 +19,6 @@ struct t_grid_tile {
     const t_metadata_dict* meta = nullptr;
 };
 
-
 //TODO: All of the functions that use helper functions of this class should pass the layer_num to the functions, and the default value of layer_num should be deleted eventually.
 /**
  * @class DeviceGrid

libs/libarchfpga/src/physical_types.h

@@ -703,8 +703,6 @@ struct t_physical_tile_type {
      * tile_block_pin_directs_map[logical block index][logical block pin] -> physical tile pin */
     std::unordered_map<int, std::unordered_map<int, vtr::bimap<t_logical_pin, t_physical_pin>>> tile_block_pin_directs_map;
 
-
-
     // TODO: Remove is_input_type / is_output_type as part of
     // https://github.com/verilog-to-routing/vtr-verilog-to-routing/issues/1193
 
@@ -714,7 +712,7 @@ struct t_physical_tile_type {
     // Does this t_physical_tile_type contain an outpad?
     bool is_output_type = false;
 
-  public:   // Function members
+  public: // Function members
     ///@brief Returns the indices of pins that contain a clock for this physical logic block
     std::vector<int> get_clock_pins_indices() const;
 
@@ -1280,8 +1278,8 @@ struct t_pin_to_pin_annotation {
  *      flat_site_index       : Index of this primitive site within its primitive type within this cluster type.
  *                              Values are in [0...total_primitive_count-1], e.g. if there are 10 ALMs per cluster, 2 FFS
  *                              and 2 LUTs per ALM, then flat site indices for FFs would run from 0 to 19, and flat site
-                                indices for LUTs would run from 0 to 19. This member is only used by nodes corresponding
-                                to primitive sites. It is used when reconstructing clusters from a flat placement file.
+ *                              indices for LUTs would run from 0 to 19. This member is only used by nodes corresponding
+ *                              to primitive sites. It is used when reconstructing clusters from a flat placement file.
  *      illegal_modes         : vector containing illegal modes that result in conflicts during routing
  */
 class t_pb_graph_node {
@@ -1335,7 +1333,7 @@ class t_pb_graph_node {
 
     int total_pb_pins; /* only valid for top-level */
 
-    void* temp_scratch_pad;                                     /* temporary data, useful for keeping track of things when traversing data structure */
+    void* temp_scratch_pad; /* temporary data, useful for keeping track of things when traversing data structure */
 
     int* input_pin_class_size;  /* Stores the number of pins that belong to a particular input pin class */
     int num_input_pin_class;    /* number of input pin classes that this pb_graph_node has */
@@ -1345,7 +1343,6 @@ class t_pb_graph_node {
     int total_primitive_count; /* total number of this primitive type in the cluster */
     int flat_site_index;       /* index of this primitive within sites of its type in this cluster  */
 
-
     /* Interconnect instances for this pb
      * Only used for power
      */
@@ -1988,7 +1985,7 @@ struct t_switchblock_inf {
     /* We can also define a region to apply this SB to all locations falls into this region using regular expression in the architecture file*/
     t_sb_loc_spec reg_x;
     t_sb_loc_spec reg_y;
-    
+
     t_permutation_map permutation_map; /* map holding the permutation functions attributed to this switchblock */
 
     std::vector<t_wireconn_inf> wireconns; /* list of wire types/groups this SB will connect */
@@ -2145,11 +2142,11 @@ struct t_arch {
     std::vector<std::string> ipin_cblock_switch_name;
 
     std::vector<t_grid_def> grid_layouts; //Set of potential device layouts
-    
+
     //the layout that is chosen to be used with command line options
     //It is used to generate custom SB for a specific locations within the device
     //If the layout is not specified in the command line options, this variable will be set to "auto"
-    std::string device_layout; 
+    std::string device_layout;
 
     t_clock_arch_spec clock_arch; // Clock related data types
 

libs/libarchfpga/src/read_xml_arch_file_noc_tag.cpp

@@ -17,4 +17,25 @@ void process_noc_tag(pugi::xml_node noc_tag,
                      t_arch* arch,
                      const pugiutil::loc_data& loc_data);
 
+/**
+ * @brief Describes a mesh topology as specified in the architecture file.
+ *        It is assumed that NoC routers are equally distanced in each axis.
+ */
+struct t_mesh_region {
+    /// The location the bottom left NoC router on the X-axis.
+    float start_x;
+    /// The location the top right NoC router on the X-axis.
+    float end_x;
+    /// The location the bottom left NoC router on the Y-axis.
+    float start_y;
+    /// The location the top right NoC router on the Y-axis.
+    float end_y;
+    /// The layer from which the mesh start.
+    int start_layer;
+    /// The layer at which the mesh ends.
+    int end_layer;
+    /// The number of NoC routers in each row or column.
+    int mesh_size;
+};
+
 #endif //VTR_READ_XML_ARCH_FILE_NOC_TAG_H

libs/libarchfpga/src/read_xml_arch_file_noc_tag.h

@@ -148,31 +148,33 @@ TEST_CASE("Verifying mesh topology creation", "[NoC Arch Tests]") {
     t_noc_inf test_noc;
 
     // mesh parameters
-    float mesh_start_x = 10;
-    float mesh_start_y = 10;
-    float mesh_end_x = 5;
-    float mesh_end_y = 56;
-    float mesh_size = 0;
-    int mesh_start_layer = 0;
-    int mesh_end_layer = 0;
+    t_mesh_region mesh_region{
+        .start_x = 10.0f,
+        .end_x = 5.0f,
+        .start_y = 10.0f,
+        .end_y = 56.0f,
+        .start_layer = 0,
+        .end_layer = 0,
+        .mesh_size = 0
+    };
 
     SECTION("Check the error where a mesh size was illegal.") {
-        REQUIRE_THROWS_WITH(generate_noc_mesh(test, test_location, &test_noc, mesh_start_x, mesh_end_x, mesh_start_y, mesh_end_y, mesh_start_layer, mesh_end_layer, mesh_size), "The NoC mesh size cannot be 0.");
+        REQUIRE_THROWS_WITH(generate_noc_mesh(test, test_location, &test_noc, mesh_region), "The NoC mesh size cannot be 0.");
     }
     SECTION("Check the error where a mesh region size was invalid.") {
-        mesh_size = 3;
+        mesh_region.mesh_size = 3;
 
-        REQUIRE_THROWS_WITH(generate_noc_mesh(test, test_location, &test_noc, mesh_start_x, mesh_end_x, mesh_start_y, mesh_end_y, mesh_start_layer, mesh_end_layer, mesh_size), "The NoC region is invalid.");
+        REQUIRE_THROWS_WITH(generate_noc_mesh(test, test_location, &test_noc, mesh_region), "The NoC region is invalid.");
     }
     SECTION("Check the mesh creation for integer precision coordinates.") {
         // define test parameters
-        mesh_size = 3;
+        mesh_region.mesh_size = 3;
 
-        mesh_start_x = 0;
-        mesh_start_y = 0;
+        mesh_region.start_x = 0;
+        mesh_region.start_y = 0;
 
-        mesh_end_x = 4;
-        mesh_end_y = 4;
+        mesh_region.end_x = 4;
+        mesh_region.end_y = 4;
 
         // create the golden results
         float golden_results_x[9];
@@ -202,10 +204,10 @@ TEST_CASE("Verifying mesh topology creation", "[NoC Arch Tests]") {
         golden_results_x[8] = 4;
         golden_results_y[8] = 4;
 
-        generate_noc_mesh(test, test_location, &test_noc, mesh_start_x, mesh_end_x, mesh_start_y, mesh_end_y, mesh_start_layer, mesh_end_layer, mesh_size);
+        generate_noc_mesh(test, test_location, &test_noc, mesh_region);
 
         // go through all the expected routers
-        for (int expected_router_id = 0; expected_router_id < (mesh_size * mesh_size); expected_router_id++) {
+        for (int expected_router_id = 0; expected_router_id < (mesh_region.mesh_size * mesh_region.mesh_size); expected_router_id++) {
             // make sure the router ids match
             REQUIRE(test_noc.router_list[expected_router_id].id == expected_router_id);
 
@@ -218,13 +220,13 @@ TEST_CASE("Verifying mesh topology creation", "[NoC Arch Tests]") {
     }
     SECTION("Check the mesh creation for double precision coordinates.") {
         // define test parameters
-        mesh_size = 3;
+        mesh_region.mesh_size = 3;
 
-        mesh_start_x = 3.5;
-        mesh_start_y = 5.7;
+        mesh_region.start_x = 3.5;
+        mesh_region.start_y = 5.7;
 
-        mesh_end_x = 10.8;
-        mesh_end_y = 6.4;
+        mesh_region.end_x = 10.8;
+        mesh_region.end_y = 6.4;
 
         // create the golden results
         float golden_results_x[9];
@@ -254,10 +256,10 @@ TEST_CASE("Verifying mesh topology creation", "[NoC Arch Tests]") {
         golden_results_x[8] = 10.8;
         golden_results_y[8] = 6.4;
 
-        generate_noc_mesh(test, test_location, &test_noc, mesh_start_x, mesh_end_x, mesh_start_y, mesh_end_y, mesh_start_layer, mesh_end_layer, mesh_size);
+        generate_noc_mesh(test, test_location, &test_noc, mesh_region);
 
         // go through all the expected routers
-        for (int expected_router_id = 0; expected_router_id < (mesh_size * mesh_size); expected_router_id++) {
+        for (int expected_router_id = 0; expected_router_id < (mesh_region.mesh_size * mesh_region.mesh_size); expected_router_id++) {
             // make sure the router ids match
             REQUIRE(test_noc.router_list[expected_router_id].id == expected_router_id);
 

libs/libarchfpga/test/test_read_xml_arch_file.cpp

@@ -265,7 +265,7 @@ static inline void update_linear_system_with_anchors(Eigen::SparseMatrix<double>
                                                      PartialPlacement& p_placement,
                                                      size_t num_moveable_blocks,
                                                      vtr::vector<APRowId, APBlockId> row_id_to_blk_id,
-                                                        unsigned iteration) {
+                                                     unsigned iteration) {
     // Anchor weights grow exponentially with iteration.
     double coeff_pseudo_anchor = 0.01 * std::exp((double)iteration / 5);
     for (size_t row_id_idx = 0; row_id_idx < num_moveable_blocks; row_id_idx++) {

vpr/src/analytical_place/analytical_solver.cpp

@@ -23,42 +23,39 @@
 #include "vpr_types.h"
 #include "vpr_utils.h"
 
-std::unique_ptr<DetailedPlacer> make_detailed_placer(
-                        e_ap_detailed_placer detailed_placer_type,
-                        const BlkLocRegistry& curr_clustered_placement,
-                        const AtomNetlist& atom_netlist,
-                        const ClusteredNetlist& clustered_netlist,
-                        t_vpr_setup& vpr_setup,
-                        const t_arch& arch) {
+std::unique_ptr<DetailedPlacer> make_detailed_placer(e_ap_detailed_placer detailed_placer_type,
+                                                     const BlkLocRegistry& curr_clustered_placement,
+                                                     const AtomNetlist& atom_netlist,
+                                                     const ClusteredNetlist& clustered_netlist,
+                                                     t_vpr_setup& vpr_setup,
+                                                     const t_arch& arch) {
     switch (detailed_placer_type) {
         case e_ap_detailed_placer::Identity:
             return std::make_unique<IdentityDetailedPlacer>();
         case e_ap_detailed_placer::Annealer:
-            return std::make_unique<AnnealerDetailedPlacer>(
-                                                        curr_clustered_placement,
-                                                        atom_netlist,
-                                                        clustered_netlist,
-                                                        vpr_setup,
-                                                        arch);
+            return std::make_unique<AnnealerDetailedPlacer>(curr_clustered_placement,
+                                                            atom_netlist,
+                                                            clustered_netlist,
+                                                            vpr_setup,
+                                                            arch);
         default:
             VPR_FATAL_ERROR(VPR_ERROR_AP,
                             "Unrecognized detailed placer type");
     }
 }
 
-AnnealerDetailedPlacer::AnnealerDetailedPlacer(
-                                const BlkLocRegistry& curr_clustered_placement,
-                                const AtomNetlist& atom_netlist,
-                                const ClusteredNetlist& clustered_netlist,
-                                t_vpr_setup& vpr_setup,
-                                const t_arch& arch)
-            : DetailedPlacer(),
-              // TODO: These two variables needed to be stored in the class since
-              //       the Placer stores a reference to these objects. These
-              //       should really be initialized and stored into the Placer
-              //       class directly.
-              pb_gpin_lookup_(g_vpr_ctx.device().logical_block_types),
-              netlist_pin_lookup_(clustered_netlist, atom_netlist, pb_gpin_lookup_) {
+AnnealerDetailedPlacer::AnnealerDetailedPlacer(const BlkLocRegistry& curr_clustered_placement,
+                                               const AtomNetlist& atom_netlist,
+                                               const ClusteredNetlist& clustered_netlist,
+                                               t_vpr_setup& vpr_setup,
+                                               const t_arch& arch)
+    : DetailedPlacer()
+    // TODO: These two variables needed to be stored in the class since
+    //       the Placer stores a reference to these objects. These
+    //       should really be initialized and stored into the Placer
+    //       class directly.
+    , pb_gpin_lookup_(g_vpr_ctx.device().logical_block_types)
+    , netlist_pin_lookup_(clustered_netlist, atom_netlist, pb_gpin_lookup_) {
     // Initialize the place delay model.
     // TODO: This initialization is complicated. Should be moved within create_delay_model
     //       or something.
@@ -102,8 +99,7 @@ void AnnealerDetailedPlacer::optimize_placement() {
     // Copy the placement solution into the global placement solution.
     placer_->copy_locs_to_global_state(g_vpr_ctx.mutable_placement());
 
-    // Since the placement was modified, need to resyncronize the pins in the
+    // Since the placement was modified, need to resynchronize the pins in the
     // clusters.
     post_place_sync();
 }
-

vpr/src/analytical_place/detailed_placer.cpp

@@ -22,7 +22,7 @@
  * flow).
  */
 class DetailedPlacer {
-public:
+  public:
     virtual ~DetailedPlacer() {}
 
     DetailedPlacer() = default;
@@ -36,14 +36,12 @@ class DetailedPlacer {
 /**
  * @brief A factory method which creates a Detailed Placer of the given type.
  */
-std::unique_ptr<DetailedPlacer> make_detailed_placer(
-                        e_ap_detailed_placer detailed_placer_type,
-                        const BlkLocRegistry& curr_clustered_placement,
-                        const AtomNetlist& atom_netlist,
-                        const ClusteredNetlist& clustered_netlist,
-                        t_vpr_setup& vpr_setup,
-                        const t_arch& arch);
-
+std::unique_ptr<DetailedPlacer> make_detailed_placer(e_ap_detailed_placer detailed_placer_type,
+                                                     const BlkLocRegistry& curr_clustered_placement,
+                                                     const AtomNetlist& atom_netlist,
+                                                     const ClusteredNetlist& clustered_netlist,
+                                                     t_vpr_setup& vpr_setup,
+                                                     const t_arch& arch);
 
 /**
  * @brief The Identity Detailed Placer.
@@ -53,7 +51,7 @@ std::unique_ptr<DetailedPlacer> make_detailed_placer(
  * with.
  */
 class IdentityDetailedPlacer : public DetailedPlacer {
-public:
+  public:
     using DetailedPlacer::DetailedPlacer;
 
     void optimize_placement() final {}
@@ -71,7 +69,7 @@ class IdentityDetailedPlacer : public DetailedPlacer {
  * stage. So options passed to the Placer will be used in here.
  */
 class AnnealerDetailedPlacer : public DetailedPlacer {
-public:
+  public:
     /**
      * @brief Construct the Annealer Detailed Placer class.
      *
@@ -98,7 +96,7 @@ class AnnealerDetailedPlacer : public DetailedPlacer {
      */
     void optimize_placement() final;
 
-private:
+  private:
     /// @brief The placer class, which contains the annealer.
     std::unique_ptr<Placer> placer_;
 
@@ -108,4 +106,3 @@ class AnnealerDetailedPlacer : public DetailedPlacer {
     /// @brief A lookup between CLB pins and atom pins.
     ClusteredPinAtomPinsLookup netlist_pin_lookup_;
 };
-

vpr/src/analytical_place/detailed_placer.h

@@ -42,7 +42,7 @@ typedef vtr::StrongId<flat_placement_bin_tag, size_t> FlatPlacementBinId;
  * higher level classes.
  */
 class FlatPlacementBins {
-public:
+  public:
     // Iterator for the flat placement bin IDs
     typedef typename vtr::vector_map<FlatPlacementBinId, FlatPlacementBinId>::const_iterator bin_iterator;
 
@@ -110,7 +110,8 @@ class FlatPlacementBins {
      */
     inline const vtr::Rect<double>& bin_region(FlatPlacementBinId bin_id) const {
         VTR_ASSERT(bin_id.is_valid());
-        return bin_region_[bin_id];;
+        return bin_region_[bin_id];
+        ;
     }
 
     /**
@@ -179,7 +180,7 @@ class FlatPlacementBins {
         return true;
     }
 
-private:
+  private:
     /// @brief A vector of the Flat Placement Bin IDs. If any of them are invalid,
     ///        then that means that the bin has been destroyed.
     vtr::vector_map<FlatPlacementBinId, FlatPlacementBinId> bin_ids_;
@@ -194,4 +195,3 @@ class FlatPlacementBins {
     // TODO: For 3D FPGAs, this should be a 3D rectangle.
     vtr::vector_map<FlatPlacementBinId, vtr::Rect<double>> bin_region_;
 };
-