Merge pull request #3991 from Pinata-Consulting/delta-debug-pruned

retire deltaDebug.py references, replace with whittle.py

Author: maliberty

docs/user/FlowVariables.md

@@ -234,7 +234,7 @@ configuration file.
 | <a name="REMOVE_CELLS_FOR_LEC"></a>REMOVE_CELLS_FOR_LEC| String patterns directly passed to write_verilog -remove_cells <> for lec checks.| |
 | <a name="REPAIR_PDN_VIA_LAYER"></a>REPAIR_PDN_VIA_LAYER| Remove power grid vias which generate DRC violations after detailed routing.| |
 | <a name="REPORT_CLOCK_SKEW"></a>REPORT_CLOCK_SKEW| Report clock skew as part of reporting metrics, starting at CTS, before which there is no clock skew. This metric can be quite time-consuming, so it can be useful to disable.| 1|
-| <a name="ROUTING_LAYER_ADJUSTMENT"></a>ROUTING_LAYER_ADJUSTMENT| Adjusts routing layer capacities to manage congestion and improve detailed routing. High values ease detailed routing but risk excessive detours and long global routing times, while low values reduce global routing failure but can complicate detailed routing. The global routing running time normally reduces dramatically (entirely design specific, but going from hours to minutes has been observed) when the value is low (such as 0.10). Sometimes, global routing will succeed with lower values and fail with higher values. Exploring results with different values can help shed light on the problem. Start with a too low value, such as 0.10, and bisect to value that works by doing multiple global routing runs. As a last resort, `make global_route_issue` and using the tools/OpenROAD/etc/deltaDebug.py can be useful to debug global routing errors. If there is something specific that is impossible to route, such as a clock line over a macro, global routing will terminate with DRC errors routes that could have been routed were it not for the specific impossible routes. deltaDebug.py should weed out the possible routes and leave a minimal failing case that pinpoints the problem.| 0.5|
+| <a name="ROUTING_LAYER_ADJUSTMENT"></a>ROUTING_LAYER_ADJUSTMENT| Adjusts routing layer capacities to manage congestion and improve detailed routing. High values ease detailed routing but risk excessive detours and long global routing times, while low values reduce global routing failure but can complicate detailed routing. The global routing running time normally reduces dramatically (entirely design specific, but going from hours to minutes has been observed) when the value is low (such as 0.10). Sometimes, global routing will succeed with lower values and fail with higher values. Exploring results with different values can help shed light on the problem. Start with a too low value, such as 0.10, and bisect to value that works by doing multiple global routing runs. As a last resort, `make global_route_issue` and using the tools/OpenROAD/etc/whittle.py can be useful to debug global routing errors. If there is something specific that is impossible to route, such as a clock line over a macro, global routing will terminate with DRC errors routes that could have been routed were it not for the specific impossible routes. whittle.py should weed out the possible routes and leave a minimal failing case that pinpoints the problem.| 0.5|
 | <a name="RTLMP_AREA_WT"></a>RTLMP_AREA_WT| Weight for the area of the current floorplan.| 0.1|
 | <a name="RTLMP_ARGS"></a>RTLMP_ARGS| Overrides all other RTL macro placer arguments.| |
 | <a name="RTLMP_BOUNDARY_WT"></a>RTLMP_BOUNDARY_WT| Weight for the boundary or how far the hard macro clusters are from boundaries.| 50.0|

flow/scripts/variables.yaml

@@ -52,12 +52,12 @@ ROUTING_LAYER_ADJUSTMENT:
     a too low value, such as 0.10, and bisect
     to value that works by doing multiple global routing runs.
     As a last resort, `make global_route_issue` and using
-    the tools/OpenROAD/etc/deltaDebug.py can be useful to debug
+    the tools/OpenROAD/etc/whittle.py can be useful to debug
     global routing errors. If there is something specific that is
     impossible to route, such as a clock line over a macro, global
     routing will terminate with DRC errors routes that could
     have been routed were it not for the specific impossible routes.
-    deltaDebug.py should weed out the possible routes and leave
+    whittle.py should weed out the possible routes and leave
     a minimal failing case that pinpoints the problem.
   stages:
     - floorplan

flow/test/test_delta_debug.sh

@@ -1,27 +1,4 @@
 #!/usr/bin/env bash
 #
-# deltaDebug.py integration smoke-test, run from ORFS/flow folder.
-#
-# Exit with error if anything is amiss, including evaluation of
-# variable names such as $(false), unused variables, etc.
-set -ue -o pipefail
-
-cd "$(dirname "$0")/.."
-. ../env.sh
-
-echo "Test deltaDebug.py with a make invocation"
-make DESIGN_CONFIG=designs/asap7/gcd/config.mk clean_all floorplan
-openroad -exit -python ../tools/OpenROAD/etc/deltaDebug.py --persistence 2 --use_stdout --error_string "      100 |   " --base_db_path results/asap7/gcd/base/2_floorplan.odb --step "make DESIGN_CONFIG=designs/asap7/gcd/config.mk do-3_1_place_gp_skip_io"
+# Delete me when this file is no longer invoked from Jenkins CI
 
-echo "Test deltaDebug.py with a make issue"
-testname=uart
-make DESIGN_CONFIG=designs/asap7/$testname/config.mk place
-make DESIGN_CONFIG=designs/asap7/$testname/config.mk global_place_issue
-latest_file=$(ls -t global_place_${testname}_asap7_base*.tar.gz | head -n1)
-echo "Testing $latest_file"
-rm -rf results/delta-debug/
-mkdir -p results/delta-debug/
-cd results/delta-debug/
-tar --strip-components=1 -xzf ../../$latest_file
-sed -i 's/openroad -no_init/openroad -exit -no_init/g' run-me-$testname-asap7-base.sh
-openroad -exit -python ../../../tools/OpenROAD/etc/deltaDebug.py --persistence 3 --use_stdout --error_string "      100 |   " --base_db_path results/asap7/$testname/base/3_2_place_iop.odb --step ./run-me-$testname-asap7-base.sh --multiplier 2

flow/test/test_outoftree.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 #
-# deltaDebug.py integration smoke-test, run from ORFS/flow folder.
+# Out of tree integration smoke-test, run from ORFS/flow folder.
 #
 # Exit with error if anything is amiss, including evaluation of
 # variable names such as $(false), unused variables, etc.