Merge remote-tracking branch 'origin/master' into secure-opto-flow

Author: precisionmoon

docs/tutorials/FlowTutorial.md

@@ -49,69 +49,25 @@ Use the `bash` shell to run commands and scripts.
 
 #### OpenROAD-flow-scripts Installation
 
-To install OpenROAD-flow-scripts,  refer to the
+To install OpenROAD-flow-scripts, refer to the
 [Build or installing ORFS  Dependencies](https://openroad-flow-scripts.readthedocs.io/en/latest/#build-or-installing-orfs-dependencies)
 documentation.
 
 In general, we recommend using `Docker` for an efficient user
-experience. Install OpenROAD-flow-scripts using a docker as described
-here [Build from sources using Docker](../user/BuildWithDocker.md).
+experience. Please refere to the [Docker Shell](../user/DockerShell.md)
+documentation.
 
 :::{Note}
-If you need to update an existing OpenROAD-flow-scripts installation,
-follow instructions from [here](../user/FAQS.md#how-do-i-update-openroad-flow-scripts).
+If you need a custom Docker image, you can build your own with the instructions
+provided at: [Build from sources using Docker](../user/BuildWithDocker.md).
 :::
 
-OpenROAD-flow-scripts installation is complete.
-
-#### Running OpenROAD-flow-scripts inside the Docker
-
-Launch the docker with OpenROAD-flow-scripts container as follows:
-
-```shell
-docker run --rm -it -u $(id -u ${USER}):$(id -g ${USER}) -v $(pwd)/flow:/OpenROAD-flow-scripts/flow openroad/flow-ubuntu22.04-builder
-```
-
-:::{seealso}
-To launch OpenROAD GUI inside the docker, based on the OS, use the command from [here](../user/BuildWithDocker.md#enable-gui-support).
+:::{Note}
+If you need to update an existing OpenROAD-flow-scripts installation:
+- For local installs follow instructions from [here](../user/FAQS.md#how-do-i-update-openroad-flow-scripts).
+- For Docker run `docker pull openroad/orfs:latest` to update the image.
 :::
 
-Once you are entered into OpenROAD-flow-scripts container run:
-
-```shell
-source env.sh
-```
-
-If your installation is  successful, you will see the following message:
-
-```
-OPENROAD: /OpenROAD-flow-scripts/tools/OpenROAD
-```
-
-#### Verifying the Docker based  Installation
-
-To verify the installation run the built-in example design as follows:
-
-```shell
-cd flow
-make
-```
-
-A successful run end with the log:
-
-```
-[INFO] Writing out GDS/OAS 'results/nangate45/gcd/base/6_1_merged.gds'
-Elapsed time: 0:10.44[h:]min:sec. CPU time: user 2.17 sys 0.54 (26%). Peak memory: 274184KB.
-cp results/nangate45/gcd/base/6_1_merged.gds results/nangate45/gcd/base/6_final.gds
-Log                       Elapsed seconds
-1_1_yosys                          2
-3_3_place_gp                       1
-4_1_cts                            8
-5_2_route                   10
-6_1_merge                         10
-6_report                           3
-```
-
 ## Configuring The Design
 
 This section shows how to set up the necessary platform and design

docs/user/BuildWithDocker.md

@@ -1,5 +1,11 @@
 # Build from sources using Docker
 
+:::{Note}
+This document describes how to build your own Docker image.
+If your goal is to use the latest version of OpenROAD-Flow-Scripts,
+please refer to the [Docker Shell](./DockerShell.md) documentation.
+:::
+
 ## Prerequisites
 
 - For this method you only need to install
@@ -31,9 +37,9 @@ This greatly helps to reduce the compilation time needed.
 
 We recommend to use a Docker image of a supported OS
 and install OpenROAD using the pre-built binaries from
-Precision Innovations. 
-You can start the container in an interactive mode using 
-the command below. 
+Precision Innovations.
+You can start the container in an interactive mode using
+the command below.
 
 ```shell
 docker run -it ubuntu:22.04
@@ -87,7 +93,7 @@ exit
 ```
 
 Alternatively you may also use the `docker_shell` utility as follows.
-It is important that you are in the `flow` directory. 
+It is important that you are in the `flow` directory.
 
 ```shell
 cd flow
@@ -121,17 +127,17 @@ Then use:
 docker run --rm -it -e DISPLAY=<IP_LIKE_FROM_TUTORIAL>:0 --network host --privileged <IMAGE_NAME>
 ```
 
-Alternatively, you may also use the `docker_shell` utility for GUI as follows. 
-It is important that you are in the `flow` directory. 
+Alternatively, you may also use the `docker_shell` utility for GUI as follows.
+It is important that you are in the `flow` directory.
 
 ```shell
 cd flow
 util/docker_shell gui_final
 ```
 
 ```{note}
-`docker_shell` is a helpful utility to automate the 
-aforementioned Docker commands using the user's parameters. 
+`docker_shell` is a helpful utility to automate the
+aforementioned Docker commands using the user's parameters.
 Do refer to the documentation [here](./DockerShell.md).
 ```
 

docs/user/DockerShell.md

@@ -1,20 +1,24 @@
 Building example design using Docker image
 ==========================================
 
-The `docker_shell` script is used as a prefix to launch a command using a OpenROAD docker image.
+The `docker_shell` script is used to launch a command using a OpenROAD-flow-scripts docker image.
 
 Also, the current working directory is mapped into the Docker image using the current user's credentials.
 
 Build docker image
 ------------------
 
-First build the docker image:
+You can skip this step if you would like to use the latest version from the master
+branch. If you are developing ORFS/OR, you should build your own image.
 
 ```
 cd OpenROAD-flow-scripts
 ./build_openroad.sh
 ```
 
+Run ORFS using `docker_shell`
+-----------------------------
+
 Build an example design and run the GUI:
 
 ```
@@ -33,7 +37,7 @@ If you need to use a different Docker image than default, override by using the
 environment variable:
 
 ```
-OR_IMAGE=openroad/flow-ubuntu22.04-builder:v1234 util/docker_shell make
+OR_IMAGE=openroad/orfs:v1234 util/docker_shell make
 ```
 
 If you have built your OpenROAD Docker image using prebuilt binaries,

docs/user/FlowVariables.md

@@ -163,9 +163,12 @@ configuration file.
 | <a name="MACRO_WRAPPERS"></a>MACRO_WRAPPERS| The wrapper file that replaces existing macros with their wrapped version.| |
 | <a name="MAKE_TRACKS"></a>MAKE_TRACKS| Tcl file that defines add routing tracks to a floorplan.| |
 | <a name="MATCH_CELL_FOOTPRINT"></a>MATCH_CELL_FOOTPRINT| Enforce sizing operations to only swap cells that have the same layout boundary.| 0|
+| <a name="MAX_REPAIR_ANTENNAS_ITER_DRT"></a>MAX_REPAIR_ANTENNAS_ITER_DRT| Defines the maximum number of iterations post-detailed routing repair antennas will run.| 5|
+| <a name="MAX_REPAIR_ANTENNAS_ITER_GRT"></a>MAX_REPAIR_ANTENNAS_ITER_GRT| Defines the maximum number of iterations post global routing repair antennas will run.| 5|
 | <a name="MAX_ROUTING_LAYER"></a>MAX_ROUTING_LAYER| The highest metal layer name to be used in routing.| |
 | <a name="MIN_BUF_CELL_AND_PORTS"></a>MIN_BUF_CELL_AND_PORTS| Used to insert a buffer cell to pass through wires. Used in synthesis.| |
 | <a name="MIN_ROUTING_LAYER"></a>MIN_ROUTING_LAYER| The lowest metal layer name to be used in routing.| |
+| <a name="OPENROAD_HIERARCHICAL"></a>OPENROAD_HIERARCHICAL| Feature toggle to enable to run OpenROAD in hierarchical mode, otherwise considered flat. Will eventually be the default and this option will be retired.| 0|
 | <a name="PDN_TCL"></a>PDN_TCL| File path which has a set of power grid policies used by pdn to be applied to the design, such as layers to use, stripe width and spacing to generate the actual metal straps.| |
 | <a name="PLACE_DENSITY"></a>PLACE_DENSITY| The desired average placement density of cells: 1.0 = dense, 0.0 = widely spread. The intended effort is also communicated by this parameter. Use a low value for faster builds and higher value for better quality of results. If a too low value is used, the placer will not be able to place all cells and a recommended minimum placement density can be found in the logs. A too high value can lead to excessive runtimes, even timeouts and subtle failures in the flow after placement, such as in CTS or global routing when timing repair fails. The default is platform specific.| |
 | <a name="PLACE_DENSITY_LB_ADDON"></a>PLACE_DENSITY_LB_ADDON| Check the lower boundary of the PLACE_DENSITY and add PLACE_DENSITY_LB_ADDON if it exists.| |
@@ -233,6 +236,7 @@ configuration file.
 | <a name="SYNTH_MEMORY_MAX_BITS"></a>SYNTH_MEMORY_MAX_BITS| Maximum number of bits for memory synthesis.| 4096|
 | <a name="SYNTH_MINIMUM_KEEP_SIZE"></a>SYNTH_MINIMUM_KEEP_SIZE| For hierarchical synthesis, we keep modules of larger area than given by this variable and flatten smaller modules. The area unit used is the size of a basic nand2 gate from the platform's standard cell library. The default value is platform specific.| 0|
 | <a name="SYNTH_NETLIST_FILES"></a>SYNTH_NETLIST_FILES| Skips synthesis and uses the supplied netlist files. If the netlist files contains duplicate modules, which can happen when using hierarchical synthesis on indvidual netlist files and combining here, subsequent modules are silently ignored and only the first module is used.| |
+| <a name="SYNTH_RETIME_MODULES"></a>SYNTH_RETIME_MODULES| List of modules to apply retiming to. These modules must not get dissolved and as such they should either be the top module or be included in SYNTH_KEEP_MODULES. This is an experimental option and may cause adverse effects.| |
 | <a name="SYNTH_WRAPPED_OPERATORS"></a>SYNTH_WRAPPED_OPERATORS| Synthesize multiple architectural options for each arithmetic operator in the design. These options are available for switching among in later stages of the flow.| |
 | <a name="TAPCELL_TCL"></a>TAPCELL_TCL| Path to Endcap and Welltie cells file.| |
 | <a name="TAP_CELL_NAME"></a>TAP_CELL_NAME| Name of the cell to use in tap cell insertion.| |
@@ -269,6 +273,7 @@ configuration file.
 - [SYNTH_MEMORY_MAX_BITS](#SYNTH_MEMORY_MAX_BITS)
 - [SYNTH_MINIMUM_KEEP_SIZE](#SYNTH_MINIMUM_KEEP_SIZE)
 - [SYNTH_NETLIST_FILES](#SYNTH_NETLIST_FILES)
+- [SYNTH_RETIME_MODULES](#SYNTH_RETIME_MODULES)
 - [SYNTH_WRAPPED_OPERATORS](#SYNTH_WRAPPED_OPERATORS)
 - [TIEHI_CELL_AND_PORT](#TIEHI_CELL_AND_PORT)
 - [TIELO_CELL_AND_PORT](#TIELO_CELL_AND_PORT)
@@ -329,6 +334,7 @@ configuration file.
 - [SKIP_PIN_SWAP](#SKIP_PIN_SWAP)
 - [SKIP_REPORT_METRICS](#SKIP_REPORT_METRICS)
 - [SWAP_ARITH_OPERATORS](#SWAP_ARITH_OPERATORS)
+- [SYNTH_WRAPPED_OPERATORS](#SYNTH_WRAPPED_OPERATORS)
 - [TAPCELL_TCL](#TAPCELL_TCL)
 - [TIEHI_CELL_AND_PORT](#TIEHI_CELL_AND_PORT)
 - [TIELO_CELL_AND_PORT](#TIELO_CELL_AND_PORT)
@@ -355,6 +361,7 @@ configuration file.
 - [ROUTING_LAYER_ADJUSTMENT](#ROUTING_LAYER_ADJUSTMENT)
 - [SKIP_REPORT_METRICS](#SKIP_REPORT_METRICS)
 - [SWAP_ARITH_OPERATORS](#SWAP_ARITH_OPERATORS)
+- [SYNTH_WRAPPED_OPERATORS](#SYNTH_WRAPPED_OPERATORS)
 
 ## cts variables
 
@@ -380,6 +387,8 @@ configuration file.
 - [SKIP_LAST_GASP](#SKIP_LAST_GASP)
 - [SKIP_PIN_SWAP](#SKIP_PIN_SWAP)
 - [SKIP_REPORT_METRICS](#SKIP_REPORT_METRICS)
+- [SWAP_ARITH_OPERATORS](#SWAP_ARITH_OPERATORS)
+- [SYNTH_WRAPPED_OPERATORS](#SYNTH_WRAPPED_OPERATORS)
 - [TNS_END_PERCENT](#TNS_END_PERCENT)
 
 ## grt variables
@@ -388,6 +397,7 @@ configuration file.
 - [DETAILED_METRICS](#DETAILED_METRICS)
 - [GLOBAL_ROUTE_ARGS](#GLOBAL_ROUTE_ARGS)
 - [HOLD_SLACK_MARGIN](#HOLD_SLACK_MARGIN)
+- [MAX_REPAIR_ANTENNAS_ITER_GRT](#MAX_REPAIR_ANTENNAS_ITER_GRT)
 - [MAX_ROUTING_LAYER](#MAX_ROUTING_LAYER)
 - [MIN_ROUTING_LAYER](#MIN_ROUTING_LAYER)
 - [PRE_GLOBAL_ROUTE_TCL](#PRE_GLOBAL_ROUTE_TCL)
@@ -400,6 +410,8 @@ configuration file.
 - [SKIP_LAST_GASP](#SKIP_LAST_GASP)
 - [SKIP_PIN_SWAP](#SKIP_PIN_SWAP)
 - [SKIP_REPORT_METRICS](#SKIP_REPORT_METRICS)
+- [SWAP_ARITH_OPERATORS](#SWAP_ARITH_OPERATORS)
+- [SYNTH_WRAPPED_OPERATORS](#SYNTH_WRAPPED_OPERATORS)
 - [TNS_END_PERCENT](#TNS_END_PERCENT)
 
 ## route variables
@@ -408,12 +420,15 @@ configuration file.
 - [DETAILED_ROUTE_END_ITERATION](#DETAILED_ROUTE_END_ITERATION)
 - [FILL_CELLS](#FILL_CELLS)
 - [MATCH_CELL_FOOTPRINT](#MATCH_CELL_FOOTPRINT)
+- [MAX_REPAIR_ANTENNAS_ITER_DRT](#MAX_REPAIR_ANTENNAS_ITER_DRT)
 - [MAX_ROUTING_LAYER](#MAX_ROUTING_LAYER)
 - [MIN_ROUTING_LAYER](#MIN_ROUTING_LAYER)
 - [REPORT_CLOCK_SKEW](#REPORT_CLOCK_SKEW)
 - [ROUTING_LAYER_ADJUSTMENT](#ROUTING_LAYER_ADJUSTMENT)
 - [SKIP_DETAILED_ROUTE](#SKIP_DETAILED_ROUTE)
 - [SKIP_REPORT_METRICS](#SKIP_REPORT_METRICS)
+- [SWAP_ARITH_OPERATORS](#SWAP_ARITH_OPERATORS)
+- [SYNTH_WRAPPED_OPERATORS](#SYNTH_WRAPPED_OPERATORS)
 
 ## final variables
 
@@ -427,6 +442,8 @@ configuration file.
 - [ROUTING_LAYER_ADJUSTMENT](#ROUTING_LAYER_ADJUSTMENT)
 - [SKIP_DETAILED_ROUTE](#SKIP_DETAILED_ROUTE)
 - [SKIP_REPORT_METRICS](#SKIP_REPORT_METRICS)
+- [SWAP_ARITH_OPERATORS](#SWAP_ARITH_OPERATORS)
+- [SYNTH_WRAPPED_OPERATORS](#SYNTH_WRAPPED_OPERATORS)
 
 ## generate_abstract variables
 
@@ -467,6 +484,7 @@ configuration file.
 - [KLAYOUT_TECH_FILE](#KLAYOUT_TECH_FILE)
 - [LIB_FILES](#LIB_FILES)
 - [MACRO_EXTENSION](#MACRO_EXTENSION)
+- [OPENROAD_HIERARCHICAL](#OPENROAD_HIERARCHICAL)
 - [PLATFORM](#PLATFORM)
 - [PLATFORM_TCL](#PLATFORM_TCL)
 - [PROCESS](#PROCESS)

etc/DependencyInstaller.sh

@@ -10,8 +10,9 @@ else
 fi
 
 # package versions
-klayoutVersion=0.28.17
+klayoutVersion=0.30.3
 verilatorVersion=5.026
+numThreads=$(nproc)
 
 _versionCompare() {
     local a b IFS=. ; set -f
@@ -54,7 +55,7 @@ _installCommon() {
             pushd verilator
                 autoconf
                 ./configure --prefix "${verilatorPrefix}"
-                make -j`nproc`
+                make -j "${numThreads}"
                 make install
             popd
             rm -r verilator
@@ -162,17 +163,22 @@ _installUbuntuPackages() {
             if [ ! -f ${klayoutPrefix}/klayout ]; then
                 _installKlayoutDependenciesUbuntuAarch64
                 echo "Installing KLayout for aarch64 architecture"
-                git clone https://github.com/KLayout/klayout.git
+                git clone --depth=1 -b "v${klayoutVersion}" https://github.com/KLayout/klayout.git
                 cd klayout
-                ./build.sh -bin "${klayoutPrefix}"
+                ./build.sh -bin "${klayoutPrefix}" -option -j "${numThreads}"
             else
                 echo "Klayout is already installed"
         fi
         else
             if [[ $1 == 20.04 ]]; then
-                klayoutChecksum=f78d41edf5bcfa5f1990bde1a9307e9e
+                klayoutChecksum=e83be08033f2f69d83ab7bd494a7a858
+            elif [[ $1 == 22.04 ]]; then
+                klayoutChecksum=6e431b0a1a34c16eab9958a2c28f88bd
+            elif [[ $1 == 24.04 ]]; then
+                klayoutChecksum=2d186f0225dbac7ae2d790aa8fa57814
             else
-                klayoutChecksum=54748a49e1ab53e14cf5bf95feb2f25a
+                echo "Unrecognized version of Ubuntu $1. Please install KLayout manually"
+                exit 1
             fi
             wget https://www.klayout.org/downloads/Ubuntu-${1%.*}/klayout_${klayoutVersion}-1_amd64.deb
             md5sum -c <(echo "${klayoutChecksum} klayout_${klayoutVersion}-1_amd64.deb") || exit 1
@@ -317,6 +323,10 @@ while [ "$#" -gt 0 ]; do
             OR_INSTALLER_ARGS="${OR_INSTALLER_ARGS} $1"
             constantBuildDir="true"
             ;;
+        -threads=*)
+            OR_INSTALLER_ARGS="${OR_INSTALLER_ARGS} $1"
+            numThreads=${1#*=}
+            ;;
         *)
             echo "unknown option: ${1}" >&2
             _help

flow/Makefile

@@ -414,9 +414,8 @@ do-$(1)$(if $(4),$(4),):
 	cp $(RESULTS_DIR)/$(2) $(RESULTS_DIR)/$(1)$(if $(4),$(4),.odb)
 endef
 
+$(eval $(call do-step,1_3_synth,$(RESULTS_DIR)/1_synth.v $(RESULTS_DIR)/1_synth.sdc,synth_odb))
 
-# STEP 1: Translate verilog to odb
-#-------------------------------------------------------------------------------
 $(eval $(call do-step,2_1_floorplan,$(RESULTS_DIR)/1_synth.v $(RESULTS_DIR)/1_synth.sdc $(TECH_LEF) $(SC_LEF) $(ADDITIONAL_LEFS) $(FOOTPRINT) $(SIG_MAP_FILE) $(FOOTPRINT_TCL) $(DONT_USE_SC_LIB),floorplan))
 
 $(eval $(call do-copy,2_floorplan,2_1_floorplan.sdc,,.sdc))
@@ -775,13 +774,7 @@ nuke: clean_test clean_issues
 $(foreach file,$(RESULTS_DEF) $(RESULTS_GDS) $(RESULTS_OAS),klayout_$(file)): klayout_%: $(OBJECTS_DIR)/klayout.lyt
 	$(KLAYOUT_CMD) -nn $(OBJECTS_DIR)/klayout.lyt $(RESULTS_DIR)/$*
 
-.PHONY: gui_synth
-gui_synth:
-	$(OPENROAD_GUI_CMD) $(SCRIPTS_DIR)/sta-synth.tcl
-.PHONY: open_synth
-open_synth:
-	$(OPENROAD_NO_EXIT_CMD) $(SCRIPTS_DIR)/sta-synth.tcl
-
+$(eval $(call OPEN_GUI_SHORTCUT,synth,1_synth.odb))
 $(eval $(call OPEN_GUI_SHORTCUT,floorplan,2_floorplan.odb))
 $(eval $(call OPEN_GUI_SHORTCUT,place,3_place.odb))
 $(eval $(call OPEN_GUI_SHORTCUT,cts,4_cts.odb))

flow/designs/asap7/aes-block/constraint.sdc

@@ -1,6 +1,6 @@
 set clk_name clk
 set clk_port_name clk
-set clk_period 475
+set clk_period 450
 set clk_io_pct 0.2
 
 set clk_port [get_ports $clk_port_name]