Merge branch 'master' into do-gpl-skip-io-with-constraints

Signed-off-by: Matt Liberty <[email protected]>

Author: maliberty

.github/workflows/github-actions-cron-sync-fork-from-upstream.yml

@@ -10,8 +10,6 @@ on:
         description: Use GitHub --force push.
         default:
 
-  repository_dispatch:
-
 
 jobs:
   Sync-Branch-From-Upstream:

.github/workflows/github-actions-update-rules.yml

@@ -13,8 +13,12 @@ jobs:
       - name: Check out repository code recursively
         uses: actions/checkout@v3
         with:
-          submodules: recursive
           fetch-depth: 0
+      - name: Git prep
+        run: |
+          git config --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
+          git fetch
+          git checkout "origin/pr/${{ github.event.client_payload.branch }}"
       - uses: actions/setup-python@v4
         with:
           python-version: "3.10"
@@ -29,9 +33,9 @@ jobs:
           echo ${{ github.event_name }}
           echo ${{ github.event.client_payload.type }}
           if [[ "${{ github.event_name }}" == "repository_dispatch" && "${{ github.event.client_payload.type }}" == "overwrite" ]]; then
-            python flow/util/updateRules.py --keyFile "${CREDS_FILE}" --apiURL ${API_BASE_URL} --overwrite
+            python flow/util/updateRules.py --keyFile "${CREDS_FILE}" --apiURL ${API_BASE_URL} --commitSHA ${{ github.event.client_payload.commitsha }} --overwrite
           else 
-            python flow/util/updateRules.py --keyFile "${CREDS_FILE}" --apiURL ${API_BASE_URL}
+            python flow/util/updateRules.py --keyFile "${CREDS_FILE}" --apiURL ${API_BASE_URL} --commitSHA ${{ github.event.client_payload.commitsha }}
           fi
       - name: Push updated rules
         id: remote-update
@@ -44,8 +48,13 @@ jobs:
             echo "has_update=false" >> "$GITHUB_OUTPUT"
           fi
           git add .
-          git commit -m "flow: update rules based on new golden reference"
-      - if: "steps.remote-update.outputs.has_update == 'true'"
+          git commit --signoff -m "flow: update rules based on new golden reference"
+      - if: "github.event.client_payload.branch != 'master'"
+        name: update rules pr
+        id: remote-update-pr
+        run: |
+          git push origin "HEAD:refs/pull/${{ github.event.client_payload.branch }}/head"
+      - if: "steps.remote-update.outputs.has_update == 'true' && github.event.client_payload.branch == 'master'"
         name: Create Draft PR
         uses: peter-evans/create-pull-request@v5
         with:

.gitmodules

@@ -4,6 +4,3 @@
 [submodule "tools/OpenROAD"]
 	path = tools/OpenROAD
 	url = ../OpenROAD.git
-[submodule "tools/LSOracle"]
-	path = tools/LSOracle
-	url = ../../The-OpenROAD-Project/LSOracle.git

Dockerfile

@@ -5,9 +5,6 @@ WORKDIR /OpenROAD-flow-scripts
 
 # synthesis tools binaries and plugins
 COPY --from=openroad/yosys /install ./tools/install/yosys
-COPY --from=openroad/lsoracle /LSOracle/build/core/lsoracle ./tools/build/LSOracle/bin/lsoracle
-COPY --from=openroad/lsoracle /LSOracle/core/test.ini ./tools/build/LSOracle/share/lsoracle/test.ini
-COPY --from=openroad/lsoracle /LSOracle/build/yosys-plugin/oracle.so /OpenROAD-flow/tools/build/yosys/share/yosys/plugins/
 
 # openroad binary
 COPY --from=openroad/ubuntu22.04-builder-gcc /OpenROAD/build/src/openroad ./tools/install/OpenROAD/bin/openroad

build_openroad.sh

@@ -25,13 +25,6 @@ YOSYS_ARGS="CONFIG=clang"
 OPENROAD_APP_USER_ARGS=""
 OPENROAD_APP_ARGS=""
 
-LSORACLE_USER_ARGS=""
-LSORACLE_ARGS="\
--D CMAKE_BUILD_TYPE=RELEASE \
--D YOSYS_INCLUDE_DIR=$(pwd)/tools/yosys \
--D YOSYS_PLUGIN=ON \
-"
-
 DOCKER_OS_NAME="ubuntu22.04"
 PROC=-1
 
@@ -43,7 +36,6 @@ Usage: $0 [-h|--help] [-o|--local] [-l|--latest]
           [-n|--nice] [-t|--threads N]
           [--yosys-args-overwrite] [--yosys-args STRING]
           [--openroad-args-overwrite] [--openroad-args STRING]
-          [--lsoracle-args-overwrite] [--lsoracle-args STRING]
           [--install-path PATH] [--clean] [--clean-force]
 
           [-c|--copy-platforms]
@@ -79,16 +71,6 @@ Options:
     --openroad-args STRING  Aditional compilation flags for OpenROAD app
                             compilation.
 
-    --lsoracle-enable       Compile LSOracle. Disable by default as it is not
-                            currently used on the flow.
-
-    --lsoracle-args-overwrite
-                            Do not use default flags set by this script during
-                            LSOracle compilation.
-
-    --lsoracle-args STRING    Aditional compilation flags for LSOracle
-                            compilation.
-
     --install-path PATH     Path to install tools. Default is ${INSTALL_PATH}.
 
     --clean                 Call git clean interactively before compile.
@@ -159,16 +141,6 @@ while (( "$#" )); do
                         OPENROAD_APP_USER_ARGS="$2"
                         shift
                         ;;
-                --lsoracle-enable)
-                        LSORACLE_ENABLE=1
-                        ;;
-                --lsoracle-args-overwrite)
-                        LSORACLE_OVERWIRTE_ARGS=1
-                        ;;
-                --lsoracle-args)
-                        LSORACLE_USER_ARGS="$2"
-                        shift
-                        ;;
                 --install-path)
                         INSTALL_PATH="$2"
                         shift
@@ -215,10 +187,6 @@ if [ -n "$CMAKE_INSTALL_RPATH" ]; then
         OPENROAD_APP_ARGS+=" -D CMAKE_INSTALL_RPATH=${CMAKE_INSTALL_RPATH}"
         OPENROAD_APP_ARGS+=" -D CMAKE_INSTALL_RPATH_USE_LINK_PATH=TRUE"
 fi
-LSORACLE_ARGS+=" \
--D YOSYS_SHARE_DIR=${INSTALL_PATH}/yosys/share/yosys \
--D CMAKE_INSTALL_PREFIX=${INSTALL_PATH}/LSOracle \
-"
 
 __args_setup() {
         if [ ! -z "${YOSYS_OVERWIRTE_ARGS+x}" ]; then
@@ -234,13 +202,6 @@ __args_setup() {
         else
                 OPENROAD_APP_ARGS+=" ${OPENROAD_APP_USER_ARGS}"
         fi
-
-        if [ ! -z "${LSORACLE_OVERWIRTE_ARGS+x}" ]; then
-                echo "[INFO FLW-0016] Overwriting LSOracle compilation flags."
-                LSORACLE_ARGS="${LSORACLE_USER_ARGS}"
-        else
-                LSORACLE_ARGS+=" ${LSORACLE_USER_ARGS}"
-        fi
 }
 
 __docker_build()
@@ -287,12 +248,6 @@ __local_build()
         echo "[INFO FLW-0018] Compiling OpenROAD."
         eval ${NICE} cmake tools/OpenROAD -B tools/OpenROAD/build ${OPENROAD_APP_ARGS}
         ${NICE} cmake --build tools/OpenROAD/build --target install -j "${PROC}"
-
-        if [ ! -z "${LSORACLE_ENABLE+x}" ]; then
-                echo "[INFO FLW-0019] Compiling LSOracle."
-                ${NICE} cmake tools/LSOracle -B tools/LSOracle/build ${LSORACLE_ARGS}
-                ${NICE} cmake --build tools/LSOracle/build --target install -j "${PROC}"
-        fi
 }
 
 __update_openroad_app_remote()

docs/index.md

@@ -91,9 +91,6 @@ Options for `./build_openroad.sh` script
 | `--yosys-args STRING`         | Aditional compilation flags for Yosys compilation.                                    |
 | `--openroad-args-overwrite`   | Do not use default flags set by this script during OpenROAD app compilation.          |
 | `--openroad-args STRING`      | Aditional compilation flags for OpenROAD app compilation.                             |
-| `--lsoracle-enable`           | Compile LSOracle. Disable by default as it is not currently used on the flow.         |
-| `--lsoracle-args-overwrite`   | Do not use default flags set by this scrip during LSOracle compilation.               |
-| `--lsoracle-args STRING`      | Aditional compilation flags for LSOracle compilation.                                 |
 | `--install-path PATH`         | Path to install tools. Default is `${INSTALL_PATH}`.                                  |
 | `--clean`                     | Call git clean interactively before compile. Useful to remove old build files.        |
 | `--clean-force`               | Call git clean before compile. WARNING: this option will not ask for confirmation. Useful to remove old build files. |

docs/user/FlowVariables.md

@@ -144,6 +144,8 @@ Note:
 | `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).                                                                                                    |
 | `GUI_NO_TIMING`       | Skip loading timing for a faster GUI load.                                                                                                                                       |
+| `GUI_SOURCE` | Source the script. |
+| `GUI_ARGS` | OpenROAD command line options for gui_ and open_ targets, typically set tup `-exit` in combination with GUI_SOURCE to run a script and exit. |
 
 
 ### Placement

env.sh

@@ -13,7 +13,6 @@ echo "OPENROAD: ${OPENROAD}"
 
 export PATH=${DIR}/tools/install/OpenROAD/bin:$PATH
 export PATH=${DIR}/tools/install/yosys/bin:$PATH
-export PATH=${DIR}/tools/install/LSOracle/bin:$PATH
 export PATH=${DIR}/dependencies/bin:$PATH
 
 if [[ "$OSTYPE" == "darwin"* ]]; then

etc/DependencyInstaller.sh

@@ -71,6 +71,7 @@ _installUbuntuPackages() {
     export DEBIAN_FRONTEND="noninteractive"
     apt-get -y update
     apt-get -y install --no-install-recommends \
+        curl \
         libqt5multimediawidgets5 \
         libqt5svg5-dev \
         libqt5xmlpatterns5-dev \
@@ -103,24 +104,6 @@ _installUbuntuPackages() {
         cd ${lastDir}
         rm -rf "${baseDir}"
     fi
-}
-
-_installDarwinPackages() {
-    brew install libffi tcl-tk ruby
-    brew install python libomp
-    brew link --force libomp
-    brew install --cask klayout
-}
-
-_installCI() {
-    apt-get -y update
-    apt-get -y install --no-install-recommends \
-        apt-transport-https \
-        ca-certificates \
-        coreutils \
-        curl \
-        python3 \
-        software-properties-common
 
     # Add Docker's official GPG key:
     install -m 0755 -d /etc/apt/keyrings
@@ -138,8 +121,26 @@ _installCI() {
         docker-ce \
         docker-ce-cli \
         containerd.io \
-        docker-buildx-plugin \
+        docker-buildx-plugin
+}
+
+_installDarwinPackages() {
+    brew install libffi tcl-tk ruby
+    brew install python libomp
+    brew link --force libomp
+    brew install --cask klayout
+    brew install docker docker-buildx
+}
 
+_installCI() {
+    apt-get -y update
+    apt-get -y install --no-install-recommends \
+        apt-transport-https \
+        ca-certificates \
+        coreutils \
+        curl \
+        python3 \
+        software-properties-common
 }
 
 _help() {

flow/Makefile

@@ -269,17 +269,6 @@ ifeq (,$(strip $(NUM_CORES)))
 endif
 export NUM_CORES
 
-export LSORACLE_CMD ?= $(shell command -v lsoracle)
-ifeq ($(LSORACLE_CMD),)
-  LSORACLE_CMD = $(abspath $(FLOW_HOME)/../tools/install/LSOracle/bin/lsoracle)
-endif
-
-LSORACLE_PLUGIN ?= $(abspath $(FLOW_HOME)/../tools/install/yosys/share/yosys/plugin/oracle.so)
-export LSORACLE_KAHYPAR_CONFIG ?= $(abspath $(FLOW_HOME)/../tools/install/LSOracle/share/lsoracle/test.ini)
-ifneq ($(USE_LSORACLE),)
-  YOSYS_FLAGS ?= -m $(LSORACLE_PLUGIN)
-endif
-
 YOSYS_FLAGS += -v 3
 
 #-------------------------------------------------------------------------------
@@ -298,7 +287,7 @@ endif
 export OPENROAD_EXE      ?= $(abspath $(FLOW_HOME)/../tools/install/OpenROAD/bin/openroad)
 export OPENSTA_EXE       ?= $(abspath $(FLOW_HOME)/../tools/install/OpenROAD/bin/sta)
 
-OPENROAD_ARGS            = -no_init $(OR_ARGS)
+OPENROAD_ARGS            = -no_init -threads $(NUM_CORES) $(OR_ARGS)
 OPENROAD_CMD             = $(OPENROAD_EXE) -exit $(OPENROAD_ARGS)
 OPENROAD_NO_EXIT_CMD     = $(OPENROAD_EXE) $(OPENROAD_ARGS)
 OPENROAD_GUI_CMD         = $(OPENROAD_EXE) -gui $(OR_ARGS)
@@ -312,7 +301,9 @@ KLAYOUT_BIN_FROM_DIR = $(KLAYOUT_DIR)/klayout
 ifeq ($(wildcard $(KLAYOUT_BIN_FROM_DIR)), $(KLAYOUT_BIN_FROM_DIR))
 KLAYOUT_CMD ?= sh -c 'LD_LIBRARY_PATH=$(dir $(KLAYOUT_BIN_FROM_DIR)) $$0 "$$@"' $(KLAYOUT_BIN_FROM_DIR)
 else
-KLAYOUT_CMD ?= $(shell command -v klayout)
+ifeq ($(KLAYOUT_CMD),)
+KLAYOUT_CMD := $(shell command -v klayout)
+endif
 endif
 KLAYOUT_FOUND            = $(if $(KLAYOUT_CMD),,$(error KLayout not found in PATH))
 
@@ -404,7 +395,7 @@ do-klayout_tech:
 	cp $(TECH_LEF) $(OBJECTS_DIR)/klayout_tech.lef
 
 KLAYOUT_ENV_VAR_IN_PATH_VERSION = 0.28.11
-KLAYOUT_VERSION = $(shell $(KLAYOUT_CMD) -v 2>/dev/null | grep 'KLayout' | cut -d ' ' -f2)
+KLAYOUT_VERSION := $(shell $(KLAYOUT_CMD) -v 2>/dev/null | grep 'KLayout' | cut -d ' ' -f2)
 
 KLAYOUT_ENV_VAR_IN_PATH = $(shell \
 	if [ -z "$(KLAYOUT_VERSION)" ]; then \
@@ -499,7 +490,7 @@ $(SDC_FILE_CLOCK_PERIOD): $(SDC_FILE)
 	echo $(ABC_CLOCK_PERIOD_IN_PS) > $@
 
 .PHONY: yosys-dependencies
-yosys-dependencies: $(DONT_USE_LIBS) $(WRAPPED_LIBS) $(DONT_USE_SC_LIB) $(DFF_LIB_FILE) $(VERILOG_FILES) $(CACHED_NETLIST) $(LATCH_MAP_FILE) $(ADDER_MAP_FILE)
+yosys-dependencies: $(DONT_USE_LIBS) $(WRAPPED_LIBS) $(DONT_USE_SC_LIB) $(DFF_LIB_FILE) $(VERILOG_FILES) $(CACHED_NETLIST) $(LATCH_MAP_FILE) $(ADDER_MAP_FILE) $(SDC_FILE_CLOCK_PERIOD)
 
 .PHONY: do-yosys
 do-yosys:
@@ -512,10 +503,10 @@ do-yosys-canonicalize: yosys-dependencies
 	mkdir -p $(RESULTS_DIR) $(LOG_DIR) $(REPORTS_DIR) $(OBJECTS_DIR)
 	($(TIME_CMD) $(YOSYS_CMD) $(YOSYS_FLAGS) -c $(SCRIPTS_DIR)/synth_canonicalize.tcl) 2>&1 | tee $(LOG_DIR)/1_1_yosys.log
 
-$(RESULTS_DIR)/1_synth.rtlil: $(RESULTS_DIR)/1_1_yosys.v $(SDC_FILE_CLOCK_PERIOD)
+$(RESULTS_DIR)/1_synth.rtlil:
 	$(UNSET_AND_MAKE) do-yosys-canonicalize
 
-$(RESULTS_DIR)/1_1_yosys.v: $(RESULTS_DIR)/1_synth.rtlil $(SDC_FILE_CLOCK_PERIOD)
+$(RESULTS_DIR)/1_1_yosys.v: $(RESULTS_DIR)/1_synth.rtlil
 	$(UNSET_AND_MAKE) do-yosys
 
 $(RESULTS_DIR)/1_synth.sdc: $(SDC_FILE)
@@ -584,7 +575,7 @@ endef
 define OPEN_GUI
 .PHONY: $(1)_$(2)
 $(1)_$(2):
-	$(3)=$(RESULTS_DIR)/$(2) $(4) $(SCRIPTS_DIR)/gui.tcl
+	$(3)=$(RESULTS_DIR)/$(2) $(4) $(GUI_ARGS) $(SCRIPTS_DIR)/gui.tcl
 endef
 
 # Separate dependency checking and doing a step. This can
@@ -630,7 +621,7 @@ do-$(1): $(OBJECTS_DIR)/copyright.txt
 	trap 'mv $(LOG_DIR)/$(1).tmp.log $(LOG_DIR)/$(1).log' EXIT; \
 	$(OPENROAD_EXE) -exit -no_init $(SCRIPTS_DIR)/noop.tcl 2>&1 >$(LOG_DIR)/$(1).tmp.log; \
 	$(TIME_CMD) $(OPENROAD_CMD) -no_splash $(SCRIPTS_DIR)/$(3).tcl -metrics $(LOG_DIR)/$(1).json 2>&1 | \
-	tee -a $(LOG_DIR)/$(1).tmp.log)
+	tee -a $(abspath $(LOG_DIR)/$(1).tmp.log))
 endef
 
 # generate make rules to copy a file, if a dependency change and
@@ -1056,10 +1047,10 @@ $(foreach file,$(RESULTS_DEF) $(RESULTS_GDS) $(RESULTS_OAS),klayout_$(file)): kl
 
 .PHONY: gui_synth
 gui_synth:
-	$(OPENROAD_GUI_CMD) $(SCRIPTS_DIR)/sta-synth.tcl
+	$(OPENROAD_GUI_CMD) $(GUI_ARGS) $(SCRIPTS_DIR)/sta-synth.tcl
 .PHONY: open_synth
 open_synth:
-	$(OPENROAD_NO_EXIT_CMD) $(SCRIPTS_DIR)/sta-synth.tcl
+	$(OPENROAD_NO_EXIT_CMD) $(GUI_ARGS) $(SCRIPTS_DIR)/sta-synth.tcl
 
 $(eval $(call OPEN_GUI_SHORTCUT,floorplan,2_floorplan.odb))
 $(eval $(call OPEN_GUI_SHORTCUT,place,3_place.odb))