Merge pull request #10272 from The-OpenROAD-Project-staging/secure-issue10097-repair-timing-journal-stack

rsz: fix repair_timing -setup journal stack double-end crash

Author: maliberty

src/rsz/src/RepairSetup.cc

@@ -1256,12 +1256,7 @@ void RepairSetup::repairSetup_Legacy(const float setup_slack_margin,
         prev_worst_slack = worst_slack;
         decreasing_slack_passes = 0;
         resizer_->journalEnd();
-        if (pass < max_passes) {
-          // Progress, Save checkpoint so we can back up to here
-          resizer_->journalBegin();
-        } else {
-          journal_open = false;
-        }
+        resizer_->journalBegin();
       } else {
         fallback_ = true;
         // Allow slack to increase to get out of local minima.
@@ -3017,13 +3012,12 @@ void RepairSetup::repairSetup_LastGasp(const OptoParams& params,
         prev_tns = curr_tns;
         if (sta::fuzzyGreaterEqual(end_slack, params.setup_slack_margin)) {
           --num_viols;
-        }
-        resizer_->journalEnd();
-        if (pass < max_last_gasp_passes_) {
-          resizer_->journalBegin();
-        } else {
+          resizer_->journalEnd();
           journal_open = false;
+          break;
         }
+        resizer_->journalEnd();
+        resizer_->journalBegin();
       } else {
         debugPrint(logger_,
                    RSZ,

src/rsz/test/BUILD

@@ -102,6 +102,7 @@ TESTS = [
     "repair_hold9",
     "repair_hold9_verbose",
     "repair_hold_multi_output_load",
+    "repair_setup_max_iter",
     "repair_setup1",
     "repair_setup1_multi",
     "repair_setup2",

src/rsz/test/CMakeLists.txt

@@ -86,6 +86,7 @@ or_integration_tests(
     repair_hold14
     repair_hold15
     repair_hold_multi_output_load
+    repair_setup_max_iter
     repair_setup_sizedown
     repair_setup_sizeup_match
     repair_setup1

src/rsz/test/repair_setup_max_iter.ok

@@ -0,0 +1,31 @@
+[INFO ODB-0227] LEF file: Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
+[INFO ODB-0128] Design: reg1
+[INFO ODB-0130]     Created 1 pins.
+[INFO ODB-0131]     Created 17 components and 92 component-terminals.
+[INFO ODB-0132]     Created 2 special nets and 34 connections.
+[INFO ODB-0133]     Created 7 nets and 30 connections.
+[INFO RSZ-0100] Repair move sequence: UnbufferMove SizeUpMove SwapPinsMove BufferMove CloneMove SplitLoadMove 
+[INFO RSZ-0094] Found 4 endpoints with setup violations.
+[INFO RSZ-0099] Repairing 4 out of 4 (100.00%) violating endpoints...
+   Iter   | Removed | Resized | Inserted | Cloned |  Pin  |   Area   |    WNS   |   StTNS    |   EnTNS    |  Viol  |  Worst  
+          | Buffers |  Gates  | Buffers  |  Gates | Swaps |          |          |            |            | Endpts | St/EnPt 
+------------------------------------------------------------------------------------------------------------------------------
+       0* |       0 |       0 |        0 |      0 |     0 |    +0.0% |   -0.333 |       -0.3 |       -0.4 |      4 | r2/D
+       1* |       0 |       1 |        0 |      0 |     0 |    +0.9% |   -0.268 |       -0.3 |       -0.3 |      4 | r2/D
+       4* |       0 |       1 |        0 |      0 |     0 |    +0.9% |   -0.268 |       -0.3 |       -0.3 |      4 | r2/D
+    final |       0 |       1 |        0 |      0 |     0 |    +0.9% |   -0.268 |       -0.3 |       -0.3 |      1 | r2/D
+------------------------------------------------------------------------------------------------------------------------------
+[INFO RSZ-0051] Resized 1 instances: 1 up, 0 up match, 0 down, 0 VT
+[WARNING RSZ-0062] Unable to repair all setup violations.
+[INFO RSZ-0100] Repair move sequence: UnbufferMove SizeUpMove SwapPinsMove BufferMove CloneMove SplitLoadMove 
+[INFO RSZ-0094] Found 1 endpoints with setup violations.
+[INFO RSZ-0099] Repairing 1 out of 1 (100.00%) violating endpoints...
+[INFO RSZ-0221] Using custom phase sequence: LAST_GASP
+   Iter   | Removed | Resized | Inserted | Cloned |  Pin  |   Area   |    WNS   |   StTNS    |   EnTNS    |  Viol  |  Worst  
+          | Buffers |  Gates  | Buffers  |  Gates | Swaps |          |          |            |            | Endpts | St/EnPt 
+------------------------------------------------------------------------------------------------------------------------------
+       0* |       0 |       0 |        0 |      0 |     0 |    +0.0% |   -0.268 |       -0.3 |       -0.3 |      1 | r2/D
+       6* |       0 |       6 |        0 |      0 |     0 |    +3.2% |   -0.147 |       -0.1 |       -0.1 |      1 | r2/D
+    final |       0 |       6 |        0 |      0 |     0 |    +3.2% |   -0.147 |        0.0 |       -0.1 |      0 | r2/D
+------------------------------------------------------------------------------------------------------------------------------
+[INFO RSZ-0051] Resized 6 instances: 6 up, 0 up match, 0 down, 0 VT

src/rsz/test/repair_setup_max_iter.tcl

@@ -0,0 +1,14 @@
+# Regression for journal stack invariant at pass==max and LastGasp
+# num_viols double-decrement after accept-crosses-margin.
+source "helpers.tcl"
+read_liberty Nangate45/Nangate45_typ.lib
+read_lef Nangate45/Nangate45.lef
+read_def repair_setup1.def
+create_clock -period 0.3 clk
+
+source Nangate45/Nangate45.rc
+set_wire_rc -layer metal3
+estimate_parasitics -placement
+
+repair_timing -setup -max_passes 1 -max_iterations 1
+repair_timing -setup -phases LAST_GASP -setup_margin -0.15 -verbose