Merge pull request #9021 from gudeh/gpl-routability-plot

gpl: debug changes, new routability plot

Author: eder-matheus

src/gpl/README.md

@@ -57,7 +57,7 @@ if the RC is not decreasing for three consecutive iterations.
 
 Routability-driven arguments
 - They begin with `-routability`.
-- `-routability_target_rc_metric`, `-routability_check_overflow`, `-routability_max_density`, `-routability_max_inflation_iter`, `-routability_inflation_ratio_coef`, `-routability_max_inflation_ratio`, `-routability_rc_coefficients`
+- `-routability_target_rc_metric`, `-routability_snapshot_overflow`, `-routability_check_overflow`, `-routability_max_density`, `-routability_inflation_ratio_coef`, `-routability_max_inflation_ratio`, `-routability_rc_coefficients`
 
 Timing-driven arguments
 - They begin with `-timing_driven`.
@@ -85,9 +85,9 @@ global_placement
     [-skip_nesterov_place]
     [-routability_use_grt]
     [-routability_target_rc_metric routability_target_rc_metric]
+    [-routability_snapshot_overflow routability_snapshot_overflow]
     [-routability_check_overflow routability_check_overflow]
-    [-routability_max_density routability_max_density]
-    [-routability_max_inflation_iter routability_max_inflation_iter]    
+    [-routability_max_density routability_max_density]   
     [-routability_inflation_ratio_coef routability_inflation_ratio_coef]
     [-routability_max_inflation_ratio routability_max_inflation_ratio]
     [-routability_rc_coefficients routability_rc_coefficients]
@@ -112,12 +112,12 @@ global_placement
 | `-init_density_penalty` | Set initial density penalty. The default value is `8e-5`. Allowed values are floats `[1e-6, 1e6]`. |
 | `-init_wirelength_coef` | Set initial wirelength coefficient. The default value is `0.25`. Allowed values are floats. |
 | `-min_phi_coef` | Set `pcof_min` ($\mu_k$ Lower Bound). The default value is `0.95`. Allowed values are floats `[0.95, 1.05]`. |
-| `-max_phi_coef` | Set `pcof_max` ($\mu_k$ Upper Bound). Default value is 1.05. Allowed values are `[1.00-1.20, float]`. |
+| `-max_phi_coef` | Set `pcof_max` ($\mu_k$ Upper Bound). Default value is `1.05`. Allowed values are `[1.00-1.20, float]`. |
 | `-overflow` | Set target overflow for termination condition. The default value is `0.1`. Allowed values are floats `[0, 1]`. |
-| `-initial_place_max_iter` | Set maximum iterations in the initial place. The default value is 20. Allowed values are integers `[0, MAX_INT]`. |
+| `-initial_place_max_iter` | Set maximum iterations in the initial place. The default value is `20`. Allowed values are integers `[0, MAX_INT]`. |
 | `-initial_place_max_fanout` | Set net escape condition in initial place when $fanout \geq initial\_place\_max\_fanout$. The default value is 200. Allowed values are integers `[1, MAX_INT]`. |
-| `-pad_left` | Set left padding in terms of number of sites. The default value is 0, and the allowed values are integers `[1, MAX_INT]` |
-| `-pad_right` | Set right padding in terms of number of sites. The default value is 0, and the allowed values are integers `[1, MAX_INT]` |
+| `-pad_left` | Set left padding in terms of number of sites. The default value is `0`, and the allowed values are integers `[1, MAX_INT]` |
+| `-pad_right` | Set right padding in terms of number of sites. The default value is `0`, and the allowed values are integers `[1, MAX_INT]` |
 | `-skip_io` | Flag to ignore the IO ports when computing wirelength during placement. The default value is False, allowed values are boolean. |
 | `-disable_revert_if_diverge` | Flag to make gpl store the placement state along iterations, if a divergence is detected, gpl reverts to the snapshot state. The default value is disabled. |
 | `-enable_routing_congestion` | Flag to run global routing after global placement, enabling the Routing Congestion Heatmap.|
@@ -128,12 +128,12 @@ global_placement
 | ----- | ----- |
 | `-routability_use_grt` | Use this tag to execute routability using FastRoute from grt for routing congestion, which is more precise but has a high runtime cost. By default, routability mode uses RUDY, which is faster. |
 | `-routability_target_rc_metric` | Set target RC metric for routability mode. The algorithm will try to reach this RC value. The default value is `1.01`, and the allowed values are floats. |
+| `-routability_snapshot_overflow` | Set the overflow threshold for saving a snapshot during routability-driven placement. The default value is `0.6` and the allowed values are floats `[0, 1]`. |
 | `-routability_check_overflow` | Set overflow threshold for routability mode. The default value is `0.3`, and the allowed values are floats `[0, 1]`. |
 | `-routability_max_density` | Set density threshold for routability mode. The default value is `0.99`, and the allowed values are floats `[0, 1]`. |
-| `-routability_max_inflation_iter` | Set inflation iteration threshold for routability mode. The default value is `4`, and the allowed values are integers `[1, MAX_INT]`. |
 | `-routability_inflation_ratio_coef` | Set inflation ratio coefficient for routability mode. The default value is `2`, and the allowed values are floats. |
 | `-routability_max_inflation_ratio` | Set inflation ratio threshold for routability mode to prevent overly aggressive adjustments. The default value is `3`, and the allowed values are floats. |
-| `-routability_rc_coefficients` | Set routability RC coefficients for calculating the final RC. They relate to the 0.5%, 1%, 2%, and 5% most congested tiles. It comes in the form of a Tcl List `{k1, k2, k3, k4}`. The default value for each coefficient is `{1.0, 1.0, 0.0, 0.0}` respectively, and the allowed values are floats. |
+| `-routability_rc_coefficients` | Set routability RC coefficients for calculating the averate routing congestion. They relate to the 0.5%, 1%, 2%, and 5% most congested tiles. It comes in the form of a Tcl List `{k1, k2, k3, k4}`. The default value for each coefficient is `{1.0, 1.0, 0.0, 0.0}` respectively, and the allowed values are floats. |
 
 #### Timing-Driven Arguments
 
@@ -142,7 +142,7 @@ global_placement
 | `-timing_driven_net_reweight_overflow` | Set overflow threshold for timing-driven net reweighting. Allowed value is a Tcl list of integers where each number is `[0, 100]`. Default values are [64, 20] |
 | `-timing_driven_net_weight_max` | Set the multiplier for the most timing-critical nets. The default value is `5`, and the allowed values are floats. |
 | `-timing_driven_nets_percentage` | Set the reweighted percentage of nets in timing-driven mode. The default value is 10. Allowed values are floats `[0, 100]`. |
-| `-keep_resize_below_overflow` | When the overflow is below the set value, timing-driven iterations will retain the resizer changes instead of reverting them. The default value is 0.3. Allowed values are floats `[0, 1]`. |
+| `-keep_resize_below_overflow` | When the overflow is below the value, timing-driven iterations will retain (non-virtual) the resizer changes instead of reverting them (virtual). The default value is `1.0`, making all timing-driven iterations non-virtual. Allowed values are floats `[0, 1]`. |
 
 ### Cluster Flops
 
@@ -200,7 +200,7 @@ global_placement_debug
 | `-draw_bins` | Activates visualization of placement bins, showcasing their density (indicated by the shade of white) and the direction of forces acting on them (depicted in red). The default setting is disabled. |
 | `-initial` | Pauses the debug process during the initial placement phase. The default setting is disabled. |
 | `-start_iter` | Start debug mode from such iteration. |
-| `-generate_images` | Generates a GIF animation showing the placement progression. Also generates snapshot images at the end of each routability and timing-driven iteration, including heatmaps. |
+| `-generate_images` | Generates a GIF animation showing the placement progression and a GIF composed of images right before each routability revert. Also saves snapshot images at the end of each routability and timing-driven iteration, including heatmaps. |
 
 Example: `global_placement_debug -pause 100 -update 1 -initial -draw_bins -inst _614_`
 This command configures the debugger to pause every 100 iterations, with layout updates occurring every iteration. It enables initial placement stage visualization, bin drawing, and specifically highlights instance 614.

src/gpl/include/gpl/Replace.h

@@ -75,11 +75,11 @@ struct PlaceOptions
   float density = 0.7;
 
   float routabilityCheckOverflow = 0.3;
+  float routabilitySnapshotOverflow = 0.6;
   float routabilityMaxDensity = 0.99;
   float routabilityTargetRcMetric = 1.01;
   float routabilityInflationRatioCoef = 2;
   float routabilityMaxInflationRatio = 3;
-  int routabilityMaxInflationIter = 4;
 
   // routability RC metric coefficients
   float routabilityRcK1 = 1.0;
@@ -135,6 +135,8 @@ class Replace
                 bool initial,
                 odb::dbInst* inst,
                 int start_iter,
+                int start_rudy,
+                int rudy_stride,
                 bool generate_images,
                 const std::string& images_path);
 
@@ -171,6 +173,8 @@ class Replace
   int gui_debug_initial_ = false;
   odb::dbInst* gui_debug_inst_ = nullptr;
   int gui_debug_start_iter_ = 0;
+  int gui_debug_rudy_start_ = 0;
+  int gui_debug_rudy_stride_ = 0;
   bool gui_debug_generate_images_ = false;
   std::string gui_debug_images_path_ = "REPORTS_DIR";
 };

src/gpl/src/AbstractGraphics.h

@@ -11,6 +11,7 @@
 
 #include "odb/db.h"
 #include "odb/geom.h"
+#include "routeBase.h"
 
 namespace gpl {
 
@@ -48,6 +49,7 @@ class AbstractGraphics
       NesterovPlace* np,
       std::shared_ptr<PlacerBaseCommon> pbc,
       std::shared_ptr<NesterovBaseCommon> nbc,
+      std::shared_ptr<RouteBase> rb,
       std::vector<std::shared_ptr<PlacerBase>>& pbVec,
       std::vector<std::shared_ptr<NesterovBase>>& nbVec,
       bool draw_bins,
@@ -103,16 +105,19 @@ class AbstractGraphics
   }
 
   // Gui functions.
-  virtual void gifStart(std::string_view path) = 0;
-  void gifAddFrame(const odb::Rect& region = odb::Rect(),
+  // Gui functions.
+  virtual int gifStart(std::string_view path) = 0;
+  void gifAddFrame(int key,
+                   const odb::Rect& region = odb::Rect(),
                    int width_px = 0,
                    double dbu_per_pixel = 0,
                    std::optional<int> delay = std::nullopt)
   {
-    gifAddFrameImpl(region, width_px, dbu_per_pixel, delay);
+    gifAddFrameImpl(key, region, width_px, dbu_per_pixel, delay);
   }
   virtual void deleteLabel(std::string_view label_name) = 0;
-  virtual void gifEnd() = 0;
+  virtual void gifEnd(int key) = 0;
+  virtual void setDisplayControl(std::string_view name, bool value) = 0;
 
  protected:
   virtual void cellPlotImpl(bool pause) = 0;
@@ -128,7 +133,8 @@ class AbstractGraphics
                                     std::string_view heatmap_control,
                                     int image_width_px)
       = 0;
-  virtual void gifAddFrameImpl(const odb::Rect& region,
+  virtual void gifAddFrameImpl(int key,
+                               const odb::Rect& region,
                                int width_px,
                                double dbu_per_pixel,
                                std::optional<int> delay)