Merge pull request #8689 from eder-matheus/rsz_max_iters

eder-matheus · web-flow · commit 69a7c633eaff · 2025-10-20T19:19:06.000-03:00
rsz: add -max_iterations option to repair_timing
diff --git a/src/rsz/README.md b/src/rsz/README.md
@@ -231,6 +231,7 @@ repair_timing
     [-skip_crit_vt_swap]
     [-repair_tns tns_end_percent]
     [-max_passes passes]
+    [-max_iterations iterations]
     [-max_repairs_per_pass max_repairs_per_pass]
     [-max_utilization util]
     [-max_buffer_percent buffer_percent]
@@ -260,6 +261,7 @@ repair_timing
 | `-repair_tns` | Percentage of violating endpoints to repair (0-100). When `tns_end_percent` is zero, only the worst endpoint is repaired. When `tns_end_percent` is 100 (default), all violating endpoints are repaired. |
 | `-max_repairs_per_pass` | Maximum repairs per pass, default is 1. On the worst paths, the maximum number of repairs is attempted. It gradually decreases until the final violations which only get 1 repair per pass. |
 | `-max_utilization` | Defines the percentage of core area used. |
+| `-max_iterations` | Defines the maximum number of iterations executed when repairing setup and hold violations. The default is `-1`, which disables the limit of iterations. |
 | `-max_buffer_percent` | Specify a maximum number of buffers to insert to repair hold violations as a percentage of the number of instances in the design. The default value is `20`, and the allowed values are integers `[0, 100]`. |
 | `-match_cell_footprint` | Obey the Liberty cell footprint when swapping gates. |
 | `-verbose` | Enable verbose logging of the repair progress. |
diff --git a/src/rsz/include/rsz/Resizer.hh b/src/rsz/include/rsz/Resizer.hh
@@ -276,6 +276,7 @@ class Resizer : public dbStaState, public dbNetworkObserver
   bool repairSetup(double setup_margin,
                    double repair_tns_end_percent,
                    int max_passes,
+                   int max_iterations,
                    int max_repairs_per_pass,
                    bool match_cell_footprint,
                    bool verbose,
@@ -304,6 +305,7 @@ class Resizer : public dbStaState, public dbNetworkObserver
                   // Max buffer count as percent of design instance count.
                   float max_buffer_percent,
                   int max_passes,
+                  int max_iterations,
                   bool match_cell_footprint,
                   bool verbose);
   void repairHold(const Pin* end_pin,
diff --git a/src/rsz/src/RepairHold.cc b/src/rsz/src/RepairHold.cc
@@ -71,6 +71,7 @@ bool RepairHold::repairHold(
     // Max buffer count as percent of design instance count.
     const float max_buffer_percent,
     const int max_passes,
+    const int max_iterations,
     const bool verbose)
 {
   bool repaired = false;
@@ -100,6 +101,7 @@ bool RepairHold::repairHold(
                           allow_setup_violations,
                           max_buffer_count,
                           max_passes,
+                          max_iterations,
                           verbose);
   }
 
@@ -135,6 +137,8 @@ void RepairHold::repairHold(const Pin* end_pin,
                allow_setup_violations,
                max_buffer_count,
                max_passes,
+               // set max_iterations to max_passes for testing
+               max_passes,
                false);
   }
 }
@@ -382,6 +386,7 @@ bool RepairHold::repairHold(VertexSeq& ends,
                             const bool allow_setup_violations,
                             const int max_buffer_count,
                             const int max_passes,
+                            const int max_iterations,
                             const bool verbose)
 {
   bool repaired = false;
@@ -399,8 +404,8 @@ bool RepairHold::repairHold(VertexSeq& ends,
     printProgress(0, true, false);
     int pass = 1;
     while (worst_slack < hold_margin && progress && !resizer_->overMaxArea()
-           && inserted_buffer_count_ <= max_buffer_count
-           && pass <= max_passes) {
+           && inserted_buffer_count_ <= max_buffer_count && pass <= max_passes
+           && (max_iterations < 0 || pass <= max_iterations)) {
       if (verbose || pass == 1) {
         printProgress(pass, false, false);
       }
diff --git a/src/rsz/src/RepairHold.hh b/src/rsz/src/RepairHold.hh
@@ -46,6 +46,7 @@ class RepairHold : public sta::dbStaState
                   // Max buffer count as percent of design instance count.
                   float max_buffer_percent,
                   int max_passes,
+                  int max_iterations,
                   bool verbose);
   void repairHold(const Pin* end_pin,
                   double setup_margin,
@@ -84,6 +85,7 @@ class RepairHold : public sta::dbStaState
                   bool allow_setup_violations,
                   int max_buffer_count,
                   int max_passes,
+                  int max_iterations,
                   bool verbose);
   void repairHoldPass(VertexSeq& hold_failures,
                       LibertyCell* buffer_cell,
diff --git a/src/rsz/src/RepairSetup.cc b/src/rsz/src/RepairSetup.cc
@@ -85,6 +85,7 @@ void RepairSetup::init()
 bool RepairSetup::repairSetup(const float setup_slack_margin,
                               const double repair_tns_end_percent,
                               const int max_passes,
+                              const int max_iterations,
                               const int max_repairs_per_pass,
                               const bool verbose,
                               const std::vector<MoveType>& sequence,
@@ -448,6 +449,9 @@ bool RepairSetup::repairSetup(const float setup_slack_margin,
         end = worst_vertex;
       }
       pass++;
+      if (max_iterations > 0 && opto_iteration >= max_iterations) {
+        break;
+      }
     }  // while pass <= max_passes
     if (verbose || opto_iteration == 1) {
       printProgress(opto_iteration, true, false, false, num_viols);
@@ -459,6 +463,9 @@ bool RepairSetup::repairSetup(const float setup_slack_margin,
       // clang-format on
       break;
     }
+    if (max_iterations > 0 && opto_iteration >= max_iterations) {
+      break;
+    }
   }  // for each violating endpoint
 
   if (!skip_last_gasp) {
@@ -473,7 +480,7 @@ bool RepairSetup::repairSetup(const float setup_slack_margin,
                       skip_vt_swap);
     params.iteration = opto_iteration;
     params.initial_tns = initial_tns;
-    repairSetupLastGasp(params, num_viols);
+    repairSetupLastGasp(params, num_viols, max_iterations);
   }
 
   if (!skip_crit_vt_swap && !skip_vt_swap
@@ -865,7 +872,9 @@ bool RepairSetup::terminateProgress(const int iteration,
 
 // Perform some last fixing based on sizing only.
 // This is a greedy opto that does not degrade WNS or TNS.
-void RepairSetup::repairSetupLastGasp(const OptoParams& params, int& num_viols)
+void RepairSetup::repairSetupLastGasp(const OptoParams& params,
+                                      int& num_viols,
+                                      const int max_iterations)
 {
   move_sequence.clear();
   if (!params.skip_vt_swap) {
@@ -926,6 +935,10 @@ void RepairSetup::repairSetupLastGasp(const OptoParams& params, int& num_viols)
   float fix_rate_threshold = inc_fix_rate_threshold_;
 
   for (const auto& end_original_slack : violating_ends) {
+    if (max_iterations > 0 && opto_iteration >= max_iterations) {
+      break;
+    }
+
     fallback_ = false;
     Vertex* end = end_original_slack.first;
     Slack end_slack = sta_->vertexSlack(end, max_);
@@ -1015,6 +1028,9 @@ void RepairSetup::repairSetupLastGasp(const OptoParams& params, int& num_viols)
         end = worst_vertex;
       }
       pass++;
+      if (max_iterations > 0 && opto_iteration >= max_iterations) {
+        break;
+      }
     }  // while pass <= max_last_gasp_passes_
     if (params.verbose || opto_iteration == 1) {
       printProgress(opto_iteration, true, false, true, num_viols);
diff --git a/src/rsz/src/RepairSetup.hh b/src/rsz/src/RepairSetup.hh
@@ -96,6 +96,7 @@ class RepairSetup : public sta::dbStaState
                    // reduce tns (0.0-1.0).
                    double repair_tns_end_percent,
                    int max_passes,
+                   int max_iterations,
                    int max_repairs_per_pass,
                    bool verbose,
                    const std::vector<MoveType>& sequence,
@@ -131,7 +132,9 @@ class RepairSetup : public sta::dbStaState
                          float& fix_rate_threshold,
                          int endpt_index,
                          int num_endpts);
-  void repairSetupLastGasp(const OptoParams& params, int& num_viols);
+  void repairSetupLastGasp(const OptoParams& params,
+                           int& num_viols,
+                           int max_iterations);
   bool swapVTCritCells(const OptoParams& params, int& num_viols);
   void traverseFaninCone(Vertex* endpoint,
                          std::unordered_map<Instance*, float>& crit_insts,
diff --git a/src/rsz/src/Resizer.cc b/src/rsz/src/Resizer.cc
@@ -4354,6 +4354,7 @@ void Resizer::cloneClkInverter(Instance* inv)
 bool Resizer::repairSetup(double setup_margin,
                           double repair_tns_end_percent,
                           int max_passes,
+                          int max_iterations,
                           int max_repairs_per_pass,
                           bool match_cell_footprint,
                           bool verbose,
@@ -4379,6 +4380,7 @@ bool Resizer::repairSetup(double setup_margin,
   return repair_setup_->repairSetup(setup_margin,
                                     repair_tns_end_percent,
                                     max_passes,
+                                    max_iterations,
                                     max_repairs_per_pass,
                                     verbose,
                                     sequence,
@@ -4419,6 +4421,7 @@ bool Resizer::repairHold(
     // Max buffer count as percent of design instance count.
     float max_buffer_percent,
     int max_passes,
+    int max_iterations,
     bool match_cell_footprint,
     bool verbose)
 {
@@ -4445,6 +4448,7 @@ bool Resizer::repairHold(
                                   allow_setup_violations,
                                   max_buffer_percent,
                                   max_passes,
+                                  max_iterations,
                                   verbose);
 }
 
diff --git a/src/rsz/src/Resizer.i b/src/rsz/src/Resizer.i
@@ -362,6 +362,7 @@ bool
 repair_setup(double setup_margin,
              double repair_tns_end_percent,
              int max_passes,
+             int max_iterations,
              int max_repairs_per_pass,
              bool match_cell_footprint,
              bool verbose,
@@ -378,9 +379,9 @@ repair_setup(double setup_margin,
   ensureLinked();
   Resizer *resizer = getResizer();
   return resizer->repairSetup(setup_margin, repair_tns_end_percent,
-                       max_passes, max_repairs_per_pass,
-                       match_cell_footprint, verbose,
-                       sequence,
+                       max_passes, max_iterations,
+                       max_repairs_per_pass, match_cell_footprint,
+                       verbose, sequence,
                        skip_pin_swap, skip_gate_cloning,
                        skip_size_down,
                        skip_buffering, skip_buffer_removal,
@@ -409,6 +410,7 @@ repair_hold(double setup_margin,
             bool allow_setup_violations,
             float max_buffer_percent,
             int max_passes,
+            int max_iterations,
             bool match_cell_footprint,
             bool verbose)
 {
@@ -417,7 +419,8 @@ repair_hold(double setup_margin,
   return resizer->repairHold(setup_margin, hold_margin,
                       allow_setup_violations,
                       max_buffer_percent, max_passes,
-                      match_cell_footprint, verbose);
+                      max_iterations, match_cell_footprint,
+                      verbose);
 }
 
 void
diff --git a/src/rsz/src/Resizer.tcl b/src/rsz/src/Resizer.tcl
@@ -251,6 +251,7 @@ sta::define_cmd_args "repair_timing" {[-setup] [-hold]\
                                         [-skip_crit_vt_swap]\
                                         [-repair_tns tns_end_percent]\
                                         [-max_passes passes]\
+                                        [-max_iterations iterations]\
                                         [-max_buffer_percent buffer_percent]\
                                         [-max_utilization util] \
                                         [-match_cell_footprint] \
@@ -261,7 +262,7 @@ proc repair_timing { args } {
   sta::parse_key_args "repair_timing" args \
     keys {-setup_margin -hold_margin -slack_margin \
             -libraries -max_utilization -max_buffer_percent -sequence \
-            -recover_power -repair_tns -max_passes -max_repairs_per_pass} \
+            -recover_power -repair_tns -max_passes -max_iterations -max_repairs_per_pass} \
     flags {-setup -hold -allow_setup_violations -skip_pin_swap -skip_gate_cloning \
              -skip_size_down -skip_buffering -skip_buffer_removal -skip_last_gasp \
              -skip_vt_swap -skip_crit_vt_swap -match_cell_footprint -verbose}
@@ -336,6 +337,11 @@ proc repair_timing { args } {
     set max_passes $keys(-max_passes)
   }
 
+  set max_iterations -1
+  if { [info exists keys(-max_iterations)] } {
+    set max_iterations $keys(-max_iterations)
+  }
+
   set match_cell_footprint [info exists flags(-match_cell_footprint)]
   if { [design_is_routed] } {
     est::set_parasitics_src "detailed_routing"
@@ -357,15 +363,15 @@ proc repair_timing { args } {
   } else {
     if { $setup } {
       set repaired_setup [rsz::repair_setup $setup_margin $repair_tns_end_percent $max_passes \
-        $max_repairs_per_pass $match_cell_footprint $verbose \
+        $max_iterations $max_repairs_per_pass $match_cell_footprint $verbose \
         $sequence \
         $skip_pin_swap $skip_gate_cloning $skip_size_down $skip_buffering \
         $skip_buffer_removal $skip_last_gasp $skip_vt_swap $skip_crit_vt_swap]
     }
     if { $hold } {
       set repaired_hold [rsz::repair_hold $setup_margin $hold_margin \
         $allow_setup_violations $max_buffer_percent $max_passes \
-        $match_cell_footprint $verbose]
+        $max_iterations $match_cell_footprint $verbose]
     }
   }
 
