Merge branch 'master' into flatRecon_result_collection

haydar-c · web-flow · commit e4dff26e88fc · 2025-09-17T11:15:34.000-04:00
diff --git a/doc/src/vpr/command_line_usage.rst b/doc/src/vpr/command_line_usage.rst
@@ -840,6 +840,18 @@ If any of init_t, exit_t or alpha_t is specified, the user schedule, with a fixe
 
     **Default:** ``1.0``
 
+.. option:: --anneal_auto_init_t_estimator {cost_variance, equilibrium}
+
+   Controls which estimation method is used when selecting the starting temperature
+   for the automatic annealing schedule.
+
+   The options for estimators are:
+
+   * ``cost_variance``: Estimates the initial temperature using the variance of cost after a set of trial swaps. The initial temperature is set to a value proportional to the variance.
+   * ``equilibrium``: Estimates the initial temperature by trying to predict the equilibrium temperature for the initial placement (i.e. the temperature that would result in no change in cost).
+
+    **Default** ``cost_variance``
+
 .. option:: --init_t <float>
 
     The starting temperature of the anneal for the manual annealing schedule.
diff --git a/libs/libarchfpga/src/read_xml_arch_file_sg.cpp b/libs/libarchfpga/src/read_xml_arch_file_sg.cpp
@@ -4,6 +4,7 @@
 #include "pugixml_util.hpp"
 #include "arch_error.h"
 #include "switchblock_types.h"
+#include "vtr_util.h"
 
 /**
  * @brief Parses all <sg_link> tags under a <sg_link_list> tag.
@@ -26,32 +27,12 @@ static std::vector<t_sg_link> parse_sg_link_tags(pugi::xml_node sg_link_list_tag
         sg_link.seg_type = pugiutil::get_attribute(node, "seg_type", loc_data).as_string();
 
         // Since the offset attributes are optional and might not exist, the as_int method will return a value of zero if the attribute is empty
-        int x_offset = pugiutil::get_attribute(node, "x_offset", loc_data, pugiutil::OPTIONAL).as_int(0);
-        int y_offset = pugiutil::get_attribute(node, "y_offset", loc_data, pugiutil::OPTIONAL).as_int(0);
-        int z_offset = pugiutil::get_attribute(node, "z_offset", loc_data, pugiutil::OPTIONAL).as_int(0);
+        sg_link.x_offset = pugiutil::get_attribute(node, "x_offset", loc_data, pugiutil::OPTIONAL).as_int(0);
+        sg_link.y_offset = pugiutil::get_attribute(node, "y_offset", loc_data, pugiutil::OPTIONAL).as_int(0);
+        sg_link.z_offset = pugiutil::get_attribute(node, "z_offset", loc_data, pugiutil::OPTIONAL).as_int(0);
 
-        if (x_offset == 0 && y_offset == 0 && z_offset == 0) {
-            archfpga_throw(loc_data.filename_c_str(), loc_data.line(node), "All offset fields in the <sg_link> are zero or missing.");
-        }
-
-        // We expect exactly one non-zero offset so the gather and scatter points are joined by a node that can be represented by a straight wire.
-        if (x_offset != 0) {
-            sg_link.x_offset = x_offset;
-            if (y_offset != 0 || z_offset != 0) {
-                archfpga_throw(loc_data.filename_c_str(), loc_data.line(node), "More than one of the offset fields in the <sg_link> are non-zero.");
-            }
-        }
-        if (y_offset != 0) {
-            sg_link.y_offset = y_offset;
-            if (x_offset != 0 || z_offset != 0) {
-                archfpga_throw(loc_data.filename_c_str(), loc_data.line(node), "More than one of the offset fields in the <sg_link> are non-zero.");
-            }
-        }
-        if (z_offset != 0) {
-            sg_link.z_offset = z_offset;
-            if (y_offset != 0 || x_offset != 0) {
-                archfpga_throw(loc_data.filename_c_str(), loc_data.line(node), "More than one of the offset fields in the <sg_link> are non-zero.");
-            }
+        if (!vtr::exactly_k_conditions(1, sg_link.x_offset != 0, sg_link.y_offset != 0, sg_link.z_offset != 0)) {
+            archfpga_throw(loc_data.filename_c_str(), loc_data.line(node), "One and only one of the offset fields in the <sg_link> should be non-zero.");
         }
 
         sg_link_list.push_back(sg_link);
diff --git a/libs/libarchfpga/src/switchblock_types.h b/libs/libarchfpga/src/switchblock_types.h
@@ -18,7 +18,8 @@ enum e_directionality {
 /**
  * @brief At the intersection of routing channels, left, right, top and bottom specify the x- and y-directed channels
  * while above and under specify the switch block wires one a layer above or below the current one. above and below
- * are only used for multi-layer FPGAs. 
+ * are only used for multi-layer FPGAs. Note that the order of 2D sides is important, as it corresponds to the bit 
+ * order in t_rr_node_data::dir_side_.sides.
  */
 enum e_side : unsigned char {
     TOP = 0,
diff --git a/libs/librrgraph/src/base/check_rr_graph.cpp b/libs/librrgraph/src/base/check_rr_graph.cpp
@@ -473,6 +473,8 @@ void check_rr_node(const RRGraphView& rr_graph,
 
     e_pin_type class_type = e_pin_type::OPEN;
     int class_num_pins = -1;
+    std::vector<e_side> rr_graph_sides;
+    std::vector<e_side> arch_side_vec;
     switch (rr_type) {
         case e_rr_type::SOURCE:
         case e_rr_type::SINK:
@@ -511,6 +513,19 @@ void check_rr_node(const RRGraphView& rr_graph,
                 VPR_FATAL_ERROR(VPR_ERROR_ROUTE,
                                 "in check_rr_node: inode %d (type %d) has a capacity of %d.\n", inode, rr_type, capacity);
             }
+            rr_graph_sides = rr_graph.node_sides(rr_node);
+            std::tie(std::ignore, std::ignore, arch_side_vec) = get_pin_coordinates(type, ptc_num, std::vector<e_side>(TOTAL_2D_SIDES.begin(), TOTAL_2D_SIDES.end()));
+            // sides in the architecture are a superset of the sides for a pin in RR Graph. We iterate over the sides stored
+            // in the RR Graph to ensure that all of them also exist in the architecture.   
+            for (size_t i = 0; i < rr_graph_sides.size(); i++) {
+                if (std::find(arch_side_vec.begin(), arch_side_vec.end(), rr_graph_sides[i]) == arch_side_vec.end()) {
+                    VPR_FATAL_ERROR(VPR_ERROR_ROUTE,
+                                "in check_rr_node: inode %d (type %d) has a different side '%s' in the RR graph and the architecture.\n", 
+                                inode, 
+                                rr_type, 
+                                TOTAL_2D_SIDE_STRINGS[rr_graph_sides[i]]);
+                }
+            }
             break;
 
         case e_rr_type::CHANX:
diff --git a/libs/librrgraph/src/base/rr_graph_storage.cpp b/libs/librrgraph/src/base/rr_graph_storage.cpp
@@ -631,6 +631,17 @@ const std::string& t_rr_graph_storage::node_direction_string(RRNodeId id) const
     return CONST_DIRECTION_STRING[int_direction];
 }
 
+
+const std::vector<e_side> t_rr_graph_storage::node_sides(RRNodeId id) const {
+    std::vector<e_side> sides;
+    for (const e_side& side : TOTAL_2D_SIDES) {
+        if (is_node_on_specific_side(id, side)) {
+            sides.push_back(side);
+        }
+    }
+    return sides;
+}
+
 const char* t_rr_graph_storage::node_side_string(RRNodeId id) const {
     for (const e_side& side : TOTAL_2D_SIDES) {
         if (is_node_on_specific_side(id, side)) {
@@ -807,7 +818,7 @@ void t_rr_graph_storage::set_node_direction(RRNodeId id, Direction new_direction
 
 void t_rr_graph_storage::add_node_side(RRNodeId id, e_side new_side) {
     if (node_type(id) != e_rr_type::IPIN && node_type(id) != e_rr_type::OPIN) {
-        VTR_LOG_ERROR("Attempted to set RR node 'side' for non-channel type '%s'", node_type_string(id));
+        VTR_LOG_ERROR("Attempted to set RR node 'side' for non-pin type '%s'", node_type_string(id));
     }
     std::bitset<NUM_2D_SIDES> side_bits = node_storage_[id].dir_side_.sides;
     side_bits[size_t(new_side)] = true;
diff --git a/libs/librrgraph/src/base/rr_graph_storage.h b/libs/librrgraph/src/base/rr_graph_storage.h
@@ -220,6 +220,9 @@ class t_rr_graph_storage {
             id, side);
     }
 
+    /** @brief Get the sides where the node locates on. */
+    const std::vector<e_side> node_sides(RRNodeId id) const;
+
     /* FIXME: This function should be DEPRECATED!
      * Developers can easily use the following codes with more flexibility
      *
diff --git a/libs/librrgraph/src/base/rr_graph_view.h b/libs/librrgraph/src/base/rr_graph_view.h
@@ -432,6 +432,11 @@ class RRGraphView {
         return node_storage_.is_node_on_specific_side(node, side);
     }
 
+    /** @brief Get the sides where the node locates on. */
+    inline const std::vector<e_side> node_sides(RRNodeId node) const {
+        return node_storage_.node_sides(node);
+    }
+
     /** @brief Return a string representing the side of a routing resource node. 
      */
     inline const char* node_side_string(RRNodeId node) const {
diff --git a/vpr/src/analytical_place/full_legalizer.cpp b/vpr/src/analytical_place/full_legalizer.cpp
@@ -59,6 +59,9 @@
 
 #include "setup_grid.h"
 #include "stats.h"
+#ifndef NO_GRAPHICS
+#include "draw_global.h"
+#endif
 
 std::unique_ptr<FullLegalizer> make_full_legalizer(e_ap_full_legalizer full_legalizer_type,
                                                    const APNetlist& ap_netlist,
@@ -1001,6 +1004,7 @@ void FlatRecon::legalize(const PartialPlacement& p_placement) {
 
     // Perform the initial placement on created clusters.
     place_clusters(p_placement);
+    update_drawing_data_structures();
 }
 
 void NaiveFullLegalizer::create_clusters(const PartialPlacement& p_placement) {
@@ -1217,6 +1221,7 @@ void NaiveFullLegalizer::legalize(const PartialPlacement& p_placement) {
     //       made part of the placement and verify placement should check for
     //       it.
     post_place_sync();
+    update_drawing_data_structures();
 }
 
 void APPack::legalize(const PartialPlacement& p_placement) {
@@ -1302,4 +1307,14 @@ void APPack::legalize(const PartialPlacement& p_placement) {
 
     // Synchronize the pins in the clusters after placement.
     post_place_sync();
+    update_drawing_data_structures();
 }
+
+void FullLegalizer::update_drawing_data_structures() {
+#ifndef NO_GRAPHICS
+    // update graphic resources incase of clustering changes
+    if (get_draw_state_vars()) {
+        get_draw_state_vars()->refresh_graphic_resources_after_cluster_change();
+    }
+#endif
+}
diff --git a/vpr/src/analytical_place/full_legalizer.h b/vpr/src/analytical_place/full_legalizer.h
@@ -59,6 +59,9 @@ class FullLegalizer {
      *                      device grid and fixed blocks are observed.
      */
     virtual void legalize(const PartialPlacement& p_placement) = 0;
+    
+    /// @brief Update drawing data structure for current placement
+    void update_drawing_data_structures();
 
   protected:
     /// @brief The AP Netlist to fully legalize the flat placement of.
diff --git a/vpr/src/base/read_options.cpp b/vpr/src/base/read_options.cpp
@@ -6,6 +6,7 @@
 #include "argparse.hpp"
 
 #include "ap_flow_enums.h"
+#include "vpr_types.h"
 #include "vtr_log.h"
 #include "vtr_path.h"
 #include "vtr_util.h"
@@ -690,6 +691,44 @@ struct ParsePlaceAgentSpace {
     }
 };
 
+struct ParsePlaceInitTEstimator {
+    ConvertedValue<e_anneal_init_t_estimator> from_str(const std::string& str) {
+        ConvertedValue<e_anneal_init_t_estimator> conv_value;
+        if (str == "cost_variance")
+            conv_value.set_value(e_anneal_init_t_estimator::COST_VARIANCE);
+        else if (str == "equilibrium")
+            conv_value.set_value(e_anneal_init_t_estimator::EQUILIBRIUM);
+        else {
+            std::stringstream msg;
+            msg << "Invalid conversion from '" << str << "' to e_anneal_init_t_estimator (expected one of: " << argparse::join(default_choices(), ", ") << ")";
+            conv_value.set_error(msg.str());
+        }
+        return conv_value;
+    }
+
+    ConvertedValue<std::string> to_str(e_anneal_init_t_estimator val) {
+        ConvertedValue<std::string> conv_value;
+        switch (val) {
+            case e_anneal_init_t_estimator::COST_VARIANCE:
+                conv_value.set_value("cost_variance");
+                break;
+            case e_anneal_init_t_estimator::EQUILIBRIUM:
+                conv_value.set_value("equilibrium");
+                break;
+            default: {
+                std::stringstream msg;
+                msg << "Unknown e_anneal_init_t_estimator type.";
+                conv_value.set_error(msg.str());
+            }
+        }
+        return conv_value;
+    }
+
+    std::vector<std::string> default_choices() {
+        return {"cost_variance", "equilibrium"};
+    }
+};
+
 struct ParseFixPins {
     ConvertedValue<e_pad_loc_type> from_str(const std::string& str) {
         ConvertedValue<e_pad_loc_type> conv_value;
@@ -2273,6 +2312,20 @@ argparse::ArgumentParser create_arg_parser(const std::string& prog_name, t_optio
         .default_value("1.0")
         .show_in(argparse::ShowIn::HELP_ONLY);
 
+    place_grp.add_argument<e_anneal_init_t_estimator, ParsePlaceInitTEstimator>(args.place_init_t_estimator, "--anneal_auto_init_t_estimator")
+        .help(
+            "Controls which estimation method is used when selecting the starting temperature "
+            "for the automatic annealing schedule.\n"
+            "\n"
+            "The options for estimators are:\n"
+            "\tcost_variance: Estimates the initial temperature using the variance "
+            "of cost after a set of trial swaps.\n"
+            "\tequilibrium: Estimates the initial temperature by trying to "
+            "predict the equilibrium temperature for the initial placement "
+            "(i.e. the temperature that would result in no change in cost).")
+        .default_value("cost_variance")
+        .show_in(argparse::ShowIn::HELP_ONLY);
+
     place_grp.add_argument(args.PlaceInitT, "--init_t")
         .help("Initial temperature for manual annealing schedule")
         .default_value("100.0")
diff --git a/vpr/src/base/read_options.h b/vpr/src/base/read_options.h
@@ -133,6 +133,7 @@ struct t_options {
     argparse::ArgValue<bool> ShowPlaceTiming;
     argparse::ArgValue<float> PlaceInnerNum;
     argparse::ArgValue<float> place_auto_init_t_scale;
+    argparse::ArgValue<e_anneal_init_t_estimator> place_init_t_estimator;
     argparse::ArgValue<float> PlaceInitT;
     argparse::ArgValue<float> PlaceExitT;
     argparse::ArgValue<float> PlaceAlphaT;
diff --git a/vpr/src/base/setup_vpr.cpp b/vpr/src/base/setup_vpr.cpp
@@ -729,6 +729,7 @@ static void setup_placer_opts(const t_options& Options, t_placer_opts* PlacerOpt
     PlacerOpts->placer_debug_net = Options.placer_debug_net;
 
     PlacerOpts->place_auto_init_t_scale = Options.place_auto_init_t_scale.value();
+    PlacerOpts->anneal_init_t_estimator = Options.place_init_t_estimator.value();
 }
 
 static void setup_analysis_opts(const t_options& Options, t_analysis_opts& analysis_opts) {
diff --git a/vpr/src/base/vpr_types.h b/vpr/src/base/vpr_types.h
@@ -967,6 +967,15 @@ enum class e_place_delta_delay_algorithm {
     DIJKSTRA_EXPANSION,
 };
 
+/**
+ * @brief Enumeration of the different initial temperature estimators available
+ *        for the placer.
+ */
+enum class e_anneal_init_t_estimator {
+    COST_VARIANCE,      ///<Estimate the initial temperature using the variance in cost of a set of trial swaps.
+    EQUILIBRIUM,        ///<Estimate the initial temperature by predicting the equilibrium temperature for the initial placement.
+};
+
 enum class e_move_type;
 
 /**
@@ -1024,6 +1033,9 @@ enum class e_move_type;
  *   @param place_auto_init_t_scale
  *              When the annealer is using the automatic schedule, this option
  *              scales the initial temperature selected.
+ *   @param anneal_init_t_estimator
+ *              When the annealer is using the automatic schedule, this option
+ *              selects which estimator is used to select an initial temperature.
  */
 struct t_placer_opts {
     t_place_algorithm place_algorithm;
@@ -1097,6 +1109,8 @@ struct t_placer_opts {
     e_place_delta_delay_algorithm place_delta_delay_matrix_calculation_method;
 
     float place_auto_init_t_scale;
+
+    e_anneal_init_t_estimator anneal_init_t_estimator;
 };
 
 /******************************************************************
diff --git a/vpr/src/draw/draw_types.cpp b/vpr/src/draw/draw_types.cpp
@@ -43,6 +43,24 @@ void t_draw_state::reset_block_colors() {
               true);
 }
 
+void t_draw_state::refresh_graphic_resources_after_cluster_change() {
+    const ClusteringContext& cluster_ctx = g_vpr_ctx.clustering();
+    const AtomContext& atom_ctx = g_vpr_ctx.atom();
+
+    // Resize block color vectors to match the possibly new clustered size
+    block_color_.resize(cluster_ctx.clb_nlist.blocks().size());
+    use_default_block_color_.resize(cluster_ctx.clb_nlist.blocks().size());
+    reset_block_colors();
+
+    // Resize net color as well since they might be rebuild in analytical placement
+    if (is_flat) {
+        net_color.resize(atom_ctx.netlist().nets().size());
+    } else {
+        net_color.resize(cluster_ctx.clb_nlist.nets().size());
+    }
+    std::fill(net_color.begin(), net_color.end(), ezgl::BLACK);
+}
+
 /**************************************************
  * begin t_draw_pb_type_info function definitions *
  **************************************************/
diff --git a/vpr/src/draw/draw_types.h b/vpr/src/draw/draw_types.h
@@ -333,6 +333,9 @@ struct t_draw_state {
     void reset_block_color(ClusterBlockId blk);
     void reset_block_colors();
 
+    ///@brief Refresh graphics resources' size after update to cluster blocks size
+    void refresh_graphic_resources_after_cluster_change();
+
     std::vector<std::pair<t_pl_loc, ezgl::color>> colored_locations;
 
     /// @brief Stores UI checkbox struct for passing into the callback functions
diff --git a/vpr/src/place/annealer.cpp b/vpr/src/place/annealer.cpp
diff --git a/vpr/src/place/annealer.h b/vpr/src/place/annealer.h
diff --git a/vpr/src/util/vpr_utils.cpp b/vpr/src/util/vpr_utils.cpp
diff --git a/vpr/test/test_undefined_value.cpp b/vpr/test/test_undefined_value.cpp
diff --git a/vtr_flow/tasks/regression_tests/vtr_reg_strong/strong_place_init_t_est/config/config.txt b/vtr_flow/tasks/regression_tests/vtr_reg_strong/strong_place_init_t_est/config/config.txt
diff --git a/vtr_flow/tasks/regression_tests/vtr_reg_strong/strong_place_init_t_est/config/golden_results.txt b/vtr_flow/tasks/regression_tests/vtr_reg_strong/strong_place_init_t_est/config/golden_results.txt
diff --git a/vtr_flow/tasks/regression_tests/vtr_reg_strong/task_list.txt b/vtr_flow/tasks/regression_tests/vtr_reg_strong/task_list.txt

Original file line number	Diff line number	Diff line change
`@@ -220,6 +220,9 @@ class t_rr_graph_storage {`
`220`	`220`	`id, side);`
`221`	`221`	`}`
`222`	`222`
	`223`	`+ /** @brief Get the sides where the node locates on. */`
	`224`	`+ const std::vector<e_side> node_sides(RRNodeId id) const;`
	`225`	`+`
`223`	`226`	`/* FIXME: This function should be DEPRECATED!`
`224`	`227`	`* Developers can easily use the following codes with more flexibility`
`225`	`228`	`*`