Merge branch 'master' of https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts into makebash_env

Author: luarss

.github/workflows/github-actions-cron-test-installer.yml

@@ -21,7 +21,7 @@ on:
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-jobs:     
+jobs:
   testInstaller:
     strategy:
       fail-fast: false
@@ -51,11 +51,13 @@ jobs:
           ./etc/DockerHelper.sh create -target=builder -os=${{ matrix.os }}
       - name: Test build
         run: |
+          cmd="yosys -help; openroad -help; make -C flow;"
           if [[ ${{ matrix.os }} == "centos7" ]]; then
-            docker run openroad/flow-${{ matrix.os }}-builder /bin/bash -c "source /opt/rh/llvm-toolset-7.0/enable; source /opt/rh/devtoolset-8/enable; source ./env.sh; yosys -help; openroad -help; cd flow; make;"
-          else
-            docker run openroad/flow-${{ matrix.os }}-builder /bin/bash -c "source ./env.sh; yosys -help; openroad -help; cd flow; make;"
+            cmd="source /opt/rh/devtoolset-8/enable; ${cmd}"
+            cmd="source /opt/rh/llvm-toolset-7.0/enable; ${cmd}"
+            cmd="source /opt/rh/rh-python38/enable; ${cmd}"
           fi
+          docker run openroad/flow-${{ matrix.os }}-builder /bin/bash -c "${cmd}"
   testInstaller-macos:
     strategy:
       fail-fast: false
@@ -76,4 +78,4 @@ jobs:
       - name: Build project
         shell: bash
         run: |
-          ./build_openroad.sh --local
+          ./build_openroad.sh --local

build_openroad.sh

@@ -264,6 +264,11 @@ __local_build()
           export PATH="$(brew --prefix bison)/bin:$(brew --prefix flex)/bin:$(brew --prefix tcl-tk)/bin:$PATH"
           export CMAKE_PREFIX_PATH=$(brew --prefix or-tools)
         fi
+        if [[ -f "/opt/rh/rh-python38/enable" ]]; then
+            set +u
+            source /opt/rh/rh-python38/enable
+            set -u
+        fi
         if [[ -f "/opt/rh/devtoolset-8/enable" ]]; then
             # the scl script has unbound variables
             set +u

dev_env.sh

@@ -1,4 +1,5 @@
-#!/bin/bash
+#!/usr/bin/env bash
+
 function setpaths() {
     local DIR=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")")
     export PATH="$DIR/dependencies/bin:$PATH"

docs/contrib/PlatformBringUp.md

@@ -178,8 +178,8 @@ create_clock [get_ports clk] -period 8.4  #Units are in nanoseconds
 ```
 
 Refer to the
-[OpenSTA][https://github.com/The-OpenROAD-Project/OpenSTA/blob/master/doc/OpenSTA.pdf]
-for the full documentation of the `create_clock` command.
+[OpenSTA](https://github.com/The-OpenROAD-Project/OpenSTA/blob/master/doc/OpenSTA.pdf)
+User Guide for the full documentation of the `create_clock` command.
 
 ### Liberty, LEF, and GDS Files
 

docs/index.md

@@ -182,7 +182,7 @@ These platforms have a permissive license which allows us to
 redistribute the PDK and OpenROAD platform-specific files. The platform
 files and license(s) are located in `platforms/{platform}`.
 
-OpenROAD-flow-scripts also supports the following commercial platforms:
+OpenROAD-flow-scripts also supports the following proprietary platforms:
 
 - GF12
 - TSMC65LP

docs/tutorials/FlowTutorial.md

@@ -895,7 +895,7 @@ Refer to the built-in examples [here](https://github.com/The-OpenROAD-Project/Op
 Launch openroad GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
 
 ```shell
-cd ../tools/OpenROAD/src/pad/test/
+cd ../tools/OpenROAD/src/ppl/test/
 openroad -gui
 ```
 

docs/user/BuildWithDocker.md

@@ -2,8 +2,11 @@
 
 ## Prerequisites
 
-For this method you only need to install
+- For this method you only need to install
 [Docker](https://docs.docker.com/engine/install) on your machine.
+- Ensure that you have sufficient memory allocated to the Virtual Machine (VM) 
+as per our system [requirements](../index.md#system-requirements). Refer to
+this [Docker guide](https://docs.docker.com/config/containers/resource_constraints/) for setting CPU cores and memory limits.
 
 :::{Warning}
 The `build_openroad.sh` will use the host number of CPUs to compile `openroad`.

docs/user/FlowVariables.md

@@ -77,6 +77,8 @@ Note:
 | `SKIP_GATE_CLONING`                  | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `SKIP_PIN_SWAP`                      | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `TNS_END_PERCENT`                    | ?=           | ?=           |               | ?=        | ?=        |
+| `EQUIVALENCE_CHECK`                  | ?=           | ?=           | ?=            | ?=        | ?=        |
+| `REMOVE_CELLS_FOR_EQY`               | ?=           | ?=           | ?=            | ?=        | ?=        |
 | Routing                              |              |              |               |           |           |
 | `KLAYOUT_TECH_FILE`                  | =            | =            | =             | =         | =         |
 | `MAX_ROUTING_LAYER`                  | =            | =            | =             | =         | ?=        |
@@ -171,7 +173,8 @@ Note:
 | `SKIP_GATE_CLONING`   | Do not use gate cloning transform to fix timing violations (default: use gate cloning)                       |
 | `SKIP_PIN_SWAP`       | Do not use pin swapping as a transform to fix timing violations (default: use pin swapping)                  |
 | `TNS_END_PERCENT`     | Specifies how many percent of violating paths to fix [0-100]. Worst path will always be fixed                |
-
+| `EQUIVALENCE_CHECK`   | Enable running equivalence checks with to verify logical correctness of repair_timing                        |
+| `REMOVE_CELLS_FOR_EQY`| String patterns directly passed to write_verilog -remove_cells <> for equivalence checks                     |
 
 ### Routing
 

env.sh

@@ -9,6 +9,10 @@ if [ ! -d "${modroot}" ]; then
   return 1
 fi
 
+if [ -f /opt/rh/rh-python38/enable ]; then
+  source /opt/rh/rh-python38/enable
+fi
+
 export OPENROAD=${modroot}/OpenROAD
 echo "OPENROAD: ${OPENROAD}"
 

etc/DependencyInstaller.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 set -euo pipefail
 
@@ -23,10 +23,16 @@ _installORDependencies() {
 }
 
 _installCommon() {
+    if [[ -f /opt/rh/rh-python38/enable ]]; then
+        set +u
+        source /opt/rh/rh-python38/enable
+        set -u
+    fi
+    local pkgs="pandas numpy firebase_admin click pyyaml"
     if [[ $(id -u) == 0 ]]; then
-        pip3 install -U pandas
+        pip3 install -U $pkgs
     else
-        pip3 install --user -U pandas
+        pip3 install --user -U $pkgs
     fi
 }
 
@@ -38,12 +44,9 @@ _installCentosCleanUp() {
 _installCentosPackages() {
     yum update -y
     yum install -y \
-        libffi-devel \
-        tcl \
         time \
         ruby \
-        ruby-devel \
-        tcl-devel
+        ruby-devel
 
     if ! [ -x "$(command -v klayout)" ]; then
       yum install -y https://www.klayout.org/downloads/CentOS_7/klayout-${klayoutVersion}-0.x86_64.rpm
@@ -55,7 +58,7 @@ _installCentosPackages() {
         echo "KLayout version less than ${klayoutVersion}"
         sudo yum remove -y klayout
         yum install -y https://www.klayout.org/downloads/CentOS_7/klayout-${klayoutVersion}-0.x86_64.rpm
-      fi 
+      fi
     fi
 }
 
@@ -68,20 +71,16 @@ _installUbuntuPackages() {
     export DEBIAN_FRONTEND="noninteractive"
     apt-get -y update
     apt-get -y install \
-        libffi-dev \
-        tcl \
-        tcl-dev \
-        time \
-        ruby \
-        ruby-dev \
+        libqt5multimediawidgets5 \
+        libqt5svg5-dev \
+        libqt5xmlpatterns5-dev \
         libz-dev \
         python3-pip \
-        qttools5-dev \
-        libqt5xmlpatterns5-dev \
         qtmultimedia5-dev \
-        libqt5multimediawidgets5 \
-        libqt5svg5-dev
-
+        qttools5-dev \
+        ruby \
+        ruby-dev \
+        time
 
     # install KLayout
     if _versionCompare $1 -ge 23.04; then
@@ -97,7 +96,6 @@ _installUbuntuPackages() {
         baseDir=/tmp/installers
         mkdir -p "${baseDir}"
         cd ${baseDir}
-
         wget https://www.klayout.org/downloads/Ubuntu-${1%.*}/klayout_${klayoutVersion}-1_amd64.deb
         md5sum -c <(echo "${klayoutChecksum} klayout_${klayoutVersion}-1_amd64.deb") || exit 1
         dpkg -i klayout_${klayoutVersion}-1_amd64.deb
@@ -146,8 +144,12 @@ EOF
 
 # default args
 OR_INSTALLER_ARGS=""
-#default option
+# default prefix
+PREFIX=""
+# default option
 option="all"
+# default isLocal
+isLocal="false"
 
 # default values, can be overwritten by cmdline args
 while [ "$#" -gt 0 ]; do
@@ -214,7 +216,7 @@ case "${os}" in
         fi
         if [[ "${option}" == "common" || "${option}" == "all" ]]; then
             _installCommon
-        fi        
+        fi
         ;;
     "Ubuntu" )
         version=$(awk -F= '/^VERSION_ID/{print $2}' /etc/os-release | sed 's/"//g')