Merge branch 'master' of https://github.com/openroadie/OpenROAD-flow-scripts

Author: openroadie

.gitignore

@@ -79,3 +79,7 @@ core.*
 __pycache__/
 
 dependencies/
+.vscode/
+.metals/
+perf.data
+perf.data.old

README.md

@@ -3,16 +3,51 @@
 [![Build Status](https://jenkins.openroad.tools/buildStatus/icon?job=OpenROAD-flow-scripts-Public%2Fpublic_tests_all%2Fmaster)](https://jenkins.openroad.tools/view/Public/job/OpenROAD-flow-scripts-Public/job/public_tests_all/job/master/)
 [![Docs](https://readthedocs.org/projects/openroad-flow-scripts/badge/?version=latest)](https://openroad-flow-scripts.readthedocs.io/en/latest/?badge=latest)
 
-OpenROAD Flow is a full RTL-to-GDS flow built entirely on open-source tools.
-The project aims for automated, no-human-in-the-loop digital circuit design
-with 24-hour turnaround time.
+OpenROAD-flow-scripts (ORFS) is a fully autonomous, RTL-GDSII flow
+for rapid architecture and design space exploration, early prediction
+of QoR and detailed physical design implementation. However, ORFS
+also enables manual intervention for finer user control of individual
+flow stages through Tcl commands and Python APIs.
+
+![ORFS_Flow](./docs/images/ORFS_Flow.svg)
+
+## Tool Installation
+
+### Local Installation
+
+Document for detailed local installation steps found [here](./docs/user/BuildLocally.md).
+
+### Docker Based Installation
+
+To ease dependency installation issues, ORFS uses docker images.
+Docker image includes ORFS binaries, applications as well as all
+required dependencies. All of the flow tools are encapsulated
+inside the container image.
+
+If `Docker` is not installed already, install latest docker tool
+based on OS from [here](https://docs.docker.com/engine/install/).
+
+To manage docker as non-root user and verify that you can run
+`docker` commands without `sudo` must complete steps from
+[here](https://docs.docker.com/engine/install/linux-postinstall/).
+
+#### Build ORFS with Docker
+
+Document for detailed steps on docker based installation found
+[here](./docs/user/BuildWithDocker.md).
 
 ## Using the Flow
 
-- See the OpenROAD [documentation here](https://openroad.readthedocs.io/en/latest/).
-- How to [start using OpenROAD flow here](https://openroad-flow-scripts.readthedocs.io/en/latest/user/GettingStarted.html).
-- Our [user guide here](https://openroad-flow-scripts.readthedocs.io/en/latest/user/UserGuide.html).
-- Our [Flow Tutorial here](https://openroad-flow-scripts.readthedocs.io/en/latest/tutorials/FlowTutorial.html).
+- For details about the OpenROAD and the available features and
+  individual flows commands, see the documentation
+  [here](https://openroad.readthedocs.io/en/latest/).
+- For details about automated flow setup, see ORFS docs
+  [here](https://openroad-flow-scripts.readthedocs.io/en/latest/user/GettingStarted.html).
+- Flow tutorial to run the complete OpenROAD based flow from
+  RTL-GDSII, see the tutorial
+  [here](https://openroad-flow-scripts.readthedocs.io/en/latest/tutorials/FlowTutorial.html).
+- To watch ORFS flow tutorial videos, check
+  [here](https://theopenroadproject.org/video).
 
 ## Citing this Work
 

docs/images/ORFS_Flow.svg

@@ -442,6 +442,14 @@ on how to use the [GUI](https://openroad.readthedocs.io/en/latest/main/README.ht
 aside from the layout are docking windows that can be undocked.  Also it
 can be close and reopened from the Windows menu.
 
+
+Note:  When you are using remote access, you will need to include -Y (or -X) option in your command to 
+enable X11 applications to function properly over the network. By using the command "ssh -Y" followed 
+by the remote servers' address or hostname, you can establish a secure connection and activate X11 forwarding. 
+This feature enables you to run graphical programs on the remote server and have their windows display 
+on your local machines desktop environment. 
+
+
 In this section, learn how to:
 
 1. Visualize design hierarchy

docs/images/gcd_final.webp

@@ -18,20 +18,63 @@ sudo ./setup.sh
 ``` shell
 ./build_openroad.sh --local
 ```
-> **Note:** There is a `build_openroad.log` file that is generated with every build in the main directory. In case of filing issues, it can be uploaded in the "Relevant log output" section of OpenROAD-flow-scripts repo [issue form](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/issues/new?assignees=&labels=&template=bug_report_with_orfs.yml).
+> **Note:** There is a `build_openroad.log` file that is generated with every
+> build in the main directory. In case of filing issues, it can be uploaded
+> in the "Relevant log output" section of OpenROAD-flow-scripts repo
+> [issue form](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/issues/new?assignees=&labels=&template=bug_report_with_orfs.yml).
 
 ## Verify Installation
 
-The binaries should be available on your `$PATH` after setting up the
-environment.
+The binaries should be available on your `$PATH` after setting
+up the environment.
 
 ``` shell
 source ./env.sh
 yosys -help
 openroad -help
-exit
+cd flow
+make
 ```
 
+Above `make` command run from RTL-GDSII generation for default
+design `gcd` with `nangate45` pdk. You can view final layout with
+OpenROAD GUI as,
+
+```
+make gui_final
+```
+
+![gcd_final.webp](../images/gcd_final.webp)
+
+## Using Pre-built Binaries
+
+You can download pre-built binaries with self contained dependencies
+included from the Precision Innovations github repository
+[here](https://github.com/Precision-Innovations/OpenROAD/actions/workflows/github-actions-build-deb-package.yml).
+
+Thanks to [Precision Innovations](http://www.precisioninno.com) for hosting and maintaining these binaries.
+
+The following platforms are supported currently:
+- Ubuntu 20.04/22.04
+- Debian 10/11
+
+Use following steps to download:
+
+Step 1: Click on the [Precision Innovations Github releases link](https://github.com/Precision-Innovations/OpenROAD/releases).
+
+Step 2: Download the artifacts for your distribution.
+
+Step 3: Run the install command based on platform use package installer.
+        For example Ubuntu 20.04 use:
+```shell
+sudo apt install ./openroad_2.0_amd64-ubuntu20.04.deb
+```
+
+You can install these binaries within docker as well.
+
+> **Thanks** to Precision Innovations (www.precisioninno.com) for providing
+> and supporting this daily release of pre built installers to the community.
+
 ## Compiling and debugging in Visual Studio Code
 
 Set up environment variables to point to tools that CMake from within

docs/tutorials/FlowTutorial.md

@@ -64,7 +64,7 @@ Note:
 | `TAPCELL_TCL`                        | =            | =            | =             | =         | =         |
 | `MACRO_PLACE_HALO`                   | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `MACRO_PLACE_CHANNEL`                | ?=           | ?=           | ?=            | ?=        | ?=        |
-| `PDN_CFG`                            | ?=           | ?=           | ?=            | ?=        | ?=        |
+| `PDN_TCL`                            | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `IO_PLACER_H`                        | =            | =            | =             | =         | ?=        |
 | `IO_PLACER_V`                        | =            | =            | =             | =         | ?=        |
 | Placement                            |              |              |               |           |           |
@@ -131,7 +131,7 @@ Note:
 | `MACRO_PLACE_HALO`    | horizontal/vertical halo around macros (microns). Used by automatic macro placement.                                                                               |
 | `MACRO_PLACE_CHANNEL` | horizontal/vertical channel width between macros (microns). Used by automatic macro placement when `RTLMP_FLOW` is disabled. Imagine channel=10 and halo=5. Then macros must be 10 apart but standard cells must be 5 away from a macro.|
 | `MACRO_BLOCKAGE_HALO` | Blockage width overridden from default calculation.                                                                                                                              |
-| `PDN_CFG`             | 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. |
+| `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. |
 | `MAKE_TRACKS`         | Tcl file that defines add routing tracks to a floorplan.                                                                                                                         |
 | `IO_PLACER_H`         | The metal layer on which to place the I/O pins horizontally (top and bottom of the die).                                                                                         |
 | `IO_PLACER_V`         | The metal layer on which to place the I/O pins vertically (sides of the die).                                                                                                    |

docs/user/BuildLocally.md

@@ -0,0 +1 @@
+settings.mk

docs/user/FlowVariables.md

@@ -1,3 +1,7 @@
+# settings.mk is not under source control. Put variables into this
+# file to avoid having to adding the to the make command line.
+-include settings.mk
+
 # ==============================================================================
 # Uncomment or add the design to run
 # ==============================================================================
@@ -80,6 +84,8 @@
 # DESIGN_CONFIG=./designs/intel22/aes/config.mk
 
 # DESIGN_CONFIG=./designs/gf180/aes/config.mk
+# DESIGN_CONFIG=./designs/gf180/ibex/config.mk
+# DESIGN_CONFIG=./designs/gf180/jpeg/config.mk
 #
 # Default design
 DESIGN_CONFIG ?= ./designs/nangate45/gcd/config.mk
@@ -423,6 +429,12 @@ clean_synth:
 .PHONY: floorplan
 floorplan: $(RESULTS_DIR)/2_floorplan.odb \
            $(RESULTS_DIR)/2_floorplan.sdc
+
+.PHONY: floorplan_info
+floorplan_info:
+	@echo DIE_AREA=$(DIE_AREA)
+	@echo CORE_AREA=$(CORE_AREA)
+
 # ==============================================================================
 
 ifneq ($(FOOTPRINT),)
@@ -443,7 +455,7 @@ $(RESULTS_DIR)/2_2_floorplan_io.odb: $(RESULTS_DIR)/2_1_floorplan.odb $(IO_CONST
 ifndef IS_CHIP
 	($(TIME_CMD) $(OPENROAD_CMD) $(SCRIPTS_DIR)/io_placement_random.tcl -metrics $(LOG_DIR)/2_2_floorplan_io.json) 2>&1 | tee $(LOG_DIR)/2_2_floorplan_io.log
 else
-	cp $< $@
+	ln -sf $(shell realpath --relative-to=$(dir $@) $<) $@
 endif
 
 # STEP 3: Timing Driven Mixed Sized Placement
@@ -453,7 +465,7 @@ ifeq ($(MACRO_PLACEMENT),)
 	($(TIME_CMD) $(OPENROAD_CMD) $(SCRIPTS_DIR)/tdms_place.tcl -metrics $(LOG_DIR)/2_3_tdms.json) 2>&1 | tee $(LOG_DIR)/2_3_tdms_place.log
 else
 	$(info [INFO][FLOW] Using manual macro placement file $(MACRO_PLACEMENT))
-	cp $< $@
+	ln -sf $(shell realpath --relative-to=$(dir $@) $<) $@
 endif
 
 # STEP 4: Macro Placement
@@ -469,11 +481,11 @@ $(RESULTS_DIR)/2_5_floorplan_tapcell.odb: $(RESULTS_DIR)/2_4_floorplan_macro.odb
 
 # STEP 6: PDN generation
 #-------------------------------------------------------------------------------
-$(RESULTS_DIR)/2_6_floorplan_pdn.odb: $(RESULTS_DIR)/2_5_floorplan_tapcell.odb $(PDN_CFG) $(PDN_TCL)
+$(RESULTS_DIR)/2_6_floorplan_pdn.odb: $(RESULTS_DIR)/2_5_floorplan_tapcell.odb $(PDN_TCL)
 	($(TIME_CMD) $(OPENROAD_CMD) $(SCRIPTS_DIR)/pdn.tcl -metrics $(LOG_DIR)/2_6_pdn.json) 2>&1 | tee $(LOG_DIR)/2_6_pdn.log
 
 $(RESULTS_DIR)/2_floorplan.odb: $(RESULTS_DIR)/2_6_floorplan_pdn.odb
-	cp $< $@
+	ln -sf $(shell realpath --relative-to=$(dir $@) $<) $@
 
 $(RESULTS_DIR)/2_floorplan.sdc: $(RESULTS_DIR)/2_1_floorplan.odb
 
@@ -506,7 +518,7 @@ $(RESULTS_DIR)/3_2_place_iop.odb: $(RESULTS_DIR)/3_1_place_gp_skip_io.odb $(IO_C
 ifndef IS_CHIP
 	($(TIME_CMD) $(OPENROAD_CMD) $(SCRIPTS_DIR)/io_placement.tcl -metrics $(LOG_DIR)/3_2_place_iop.json) 2>&1 | tee $(LOG_DIR)/3_2_place_iop.log
 else
-	cp $< $@
+	ln -sf $(shell realpath --relative-to=$(dir $@) $<) $@
 endif
 
 # STEP 3: Global placement with placed IOs, timing-driven, and routability-driven.
@@ -529,7 +541,7 @@ $(RESULTS_DIR)/3_5_place_dp.odb: $(RESULTS_DIR)/3_4_place_resized.odb
 	($(TIME_CMD) $(OPENROAD_CMD) $(SCRIPTS_DIR)/detail_place.tcl -metrics $(LOG_DIR)/3_5_opendp.json) 2>&1 | tee $(LOG_DIR)/3_5_opendp.log
 
 $(RESULTS_DIR)/3_place.odb: $(RESULTS_DIR)/3_5_place_dp.odb
-	cp $< $@
+	ln -sf $(shell realpath --relative-to=$(dir $@) $<) $@
 
 $(RESULTS_DIR)/3_place.sdc: $(RESULTS_DIR)/2_floorplan.sdc
 	cp $< $@
@@ -570,7 +582,7 @@ $(RESULTS_DIR)/4_2_cts_fillcell.odb: $(RESULTS_DIR)/4_1_cts.odb
 $(RESULTS_DIR)/4_cts.sdc: $(RESULTS_DIR)/4_cts.odb
 
 $(RESULTS_DIR)/4_cts.odb: $(RESULTS_DIR)/4_2_cts_fillcell.odb
-	cp $< $@
+	ln -sf $(shell realpath --relative-to=$(dir $@) $<) $@
 
 .PHONY: clean_cts
 clean_cts:
@@ -608,7 +620,7 @@ endif
 	($(TIME_CMD) $(OPENROAD_CMD) $(SCRIPTS_DIR)/detail_route.tcl -metrics $(LOG_DIR)/5_2_TritonRoute.json) 2>&1 | tee $(LOG_DIR)/5_2_TritonRoute.log
 
 $(RESULTS_DIR)/5_route.odb: $(RESULTS_DIR)/5_2_route.odb
-	cp $< $@
+	ln -sf $(shell realpath --relative-to=$(dir $@) $<) $@
 
 $(RESULTS_DIR)/5_route.sdc: $(RESULTS_DIR)/4_cts.sdc
 	cp $< $@
@@ -656,7 +668,10 @@ finish: $(LOG_DIR)/6_report.log \
         $(RESULTS_DIR)/6_final.v \
         $(RESULTS_DIR)/6_final.sdc \
         $(GDS_FINAL_FILE)
-	@printf "%-25s %10s\n" Log "Elapsed seconds"
+	-@$(UTILS_DIR)/genElapsedTime.py -d "$(LOG_DIR)"
+
+.PHONY:
+elapsed:
 	-@$(UTILS_DIR)/genElapsedTime.py -d "$(LOG_DIR)"
 
 # ==============================================================================
@@ -666,7 +681,7 @@ $(RESULTS_DIR)/6_1_fill.odb: $(RESULTS_DIR)/5_route.odb $(FILL_CONFIG)
 	($(TIME_CMD) $(OPENROAD_CMD) $(SCRIPTS_DIR)/density_fill.tcl -metrics $(LOG_DIR)/6_density_fill.json) 2>&1 | tee $(LOG_DIR)/6_density_fill.log
 else
 $(RESULTS_DIR)/6_1_fill.odb: $(RESULTS_DIR)/5_route.odb
-	cp $< $@
+	ln -sf $(shell realpath --relative-to=$(dir $@) $<) $@
 endif
 
 $(RESULTS_DIR)/6_1_fill.sdc: $(RESULTS_DIR)/5_route.sdc
@@ -690,17 +705,17 @@ skip_resize: $(RESULTS_DIR)/3_3_place_gp.odb
 .PHONY: skip_cts
 skip_cts: $(RESULTS_DIR)/3_place.odb $(RESULTS_DIR)/3_place.sdc
 	# mock all intermediate results
-	cp $(RESULTS_DIR)/3_place.odb $(RESULTS_DIR)/4_1_cts.odb
-	cp $(RESULTS_DIR)/3_place.odb $(RESULTS_DIR)/4_2_cts_fillcell.odb
-	cp $(RESULTS_DIR)/3_place.sdc $(RESULTS_DIR)/4_cts.sdc
-	cp $(RESULTS_DIR)/3_place.odb $(RESULTS_DIR)/4_cts.odb
+	cd $(RESULTS_DIR) && ln -sf 3_place.odb 4_1_cts.odb
+	cd $(RESULTS_DIR) && ln -sf 3_place.odb 4_2_cts_fillcell.odb
+	cd $(RESULTS_DIR) && ln -sf 3_place.sdc 4_cts.sdc
+	cd $(RESULTS_DIR) && ln -sf 3_place.odb 4_cts.odb
 
 # Skipping route can be useful to create a mock abstract
 .PHONY: skip_route
 skip_route: $(RESULTS_DIR)/4_cts.odb $(RESULTS_DIR)/4_cts.sdc
-	cp $(RESULTS_DIR)/3_place.odb $(RESULTS_DIR)/5_1_grt.odb
-	cp $(RESULTS_DIR)/3_place.odb $(RESULTS_DIR)/5_2_route.odb
-	cp $(RESULTS_DIR)/3_place.odb $(RESULTS_DIR)/6_1_fill.odb
+	cd $(RESULTS_DIR) && ln -sf 3_place.odb 5_1_grt.odb
+	cd $(RESULTS_DIR) && ln -sf 3_place.odb 5_2_route.odb
+	cd $(RESULTS_DIR) && ln -sf 3_place.odb 6_1_fill.odb
 	touch $(RESULTS_DIR)/6_final.spef
 
 # To create a mock abstract quickly, good enough to iterate quickly on
@@ -743,7 +758,7 @@ $(GDS_MERGED_FILE): $(RESULTS_DIR)/6_final.def $(OBJECTS_DIR)/klayout.lyt $(GDSO
 $(RESULTS_DIR)/6_final.v: $(LOG_DIR)/6_report.log
 
 $(GDS_FINAL_FILE): $(GDS_MERGED_FILE)
-	cp $^ $@
+	ln -sf $(shell realpath --relative-to=$(dir $@) $<) $@
 
 .PHONY: drc
 drc: $(REPORTS_DIR)/6_drc.lyrdb

flow/.gitignore

@@ -1,3 +1,5 @@
+include designs/asap7/mock-array-big/defaults.mk
+
 export DESIGN_NAME = Element
 export DESIGN_NICKNAME = mock-array-big_Element
 
@@ -10,9 +12,15 @@ export PLACE_DENSITY          = 0.50
 export GPL_TIMING_DRIVEN      = 0
 export GPL_ROUTABILITY_DRIVEN = 0
 
-export CORE_AREA = $(shell python3 designs/asap7/mock-array-big/ce_core_area.py)
-export DIE_AREA = $(shell python3 designs/asap7/mock-array-big/ce_die_area.py)
+export CORE_AREA = $(shell export MOCK_ARRAY_HEIGHT=$(MOCK_ARRAY_HEIGHT) && export MOCK_ARRAY_WIDTH=$(MOCK_ARRAY_WIDTH) && export MOCK_ARRAY_PITCH_SCALE=$(MOCK_ARRAY_PITCH_SCALE) && python3 designs/asap7/mock-array-big/ce_core_area.py)
+export DIE_AREA = $(shell export MOCK_ARRAY_HEIGHT=$(MOCK_ARRAY_HEIGHT) && export MOCK_ARRAY_WIDTH=$(MOCK_ARRAY_WIDTH) && export MOCK_ARRAY_PITCH_SCALE=$(MOCK_ARRAY_PITCH_SCALE) && python3 designs/asap7/mock-array-big/ce_die_area.py)
 
 export IO_CONSTRAINTS = designs/asap7/mock-array-big/Element/io.tcl
 
 export PDN_TCL = designs/asap7/mock-array-big/Element/pdn.tcl
+
+# max routing layer need to be set to M5, since M6 is needed for next level up to connect
+# to the ring and stipe
+export MAX_ROUTING_LAYER = M5
+
+export PRIVATE_DIR=designs/asap7/mock-array-big