Merge remote-tracking branch 'origin/master' into secure-gf12-bps-incr-density

Signed-off-by: Osama <[email protected]>

Author: osamahammad21

bazel/README.md

@@ -0,0 +1,60 @@
+# OpenROAD-flow-scripts and Bazel integration
+
+`bazel-orfs` is a Bazel package containing the definitions and logic governing the build process of ORFS designs.
+The module uses the `openroad/orfs` docker image to extract the flow scripts with dependencies, builds the Bazel environment around them and defines the methods of calling the ORFS Makefiles with selected designs.
+
+## Run examples
+
+`flow/BUILD.bazel` contains definitions for various flows to serve as examples.
+
+It is recommended to run the utility [Bazelisk](https://github.com/bazelbuild/bazelisk) to manage the version of `bazel` installed on the system.
+Details on installation can be found in the `bazel-orfs` [README](https://github.com/The-OpenROAD-Project/bazel-orfs?tab=readme-ov-file#requirements)
+
+The flow can be ran with the following call structure:
+
+```bash
+bazel build <target_name>_<stage_name>
+```
+
+For example, to run the stage `final`, along with all the dependent stages, call:
+```bash
+bazel build gcd_final
+```
+
+Details on usage and defining of the flows are presented in the Usage section of the `bazel-orfs` [README](https://github.com/The-OpenROAD-Project/bazel-orfs?tab=readme-ov-file#usage)
+
+## Dependency version management
+
+In the flow scipts, the `bazel-orfs` version is defined as
+
+```starlark
+bazel_dep(name = "bazel-orfs")
+git_override(
+    module_name = "bazel-orfs",
+    commit = "<Hash of the default bazel-orfs commit>",
+    remote = "https://github.com/The-OpenROAD-Project/bazel-orfs.git",
+)
+```
+However, as the referenced documentation shows, the git-based dependency can be overridden with a local repository.
+First, remove the `git_override` call entirely and replace it with a `local_path_override` call following this convention:
+
+```starlark
+local_path_override(
+  module_name = "bazel-orfs",
+  path = "/replace/with/path/to/local/orfs/repository"
+)
+```
+
+`bazel-orfs` sets a default version of the docker image used to create the Bazel environment.
+This selection can be overridden by a following snippet inserted below the `bazel-orfs` declaration and override.
+
+```starlark
+orfs = use_extension("@bazel-orfs//:extension.bzl", "orfs_repositories")
+orfs.default(
+    image = "tag-name",
+    sha256 = "the-hash",
+)
+```
+
+Substitute `tag-name` with the tag of the version needed and `the-hash` with the digest corresponding to the selected tag (without the `sha256:` prefix).
+

build_openroad.sh

@@ -5,7 +5,8 @@
 set -eu
 
 # Make sure we are on the correct folder before beginning
-cd "$(dirname $(readlink -f $0))"
+DIR="$(dirname $(readlink -f $0))"
+cd "$DIR"
 
 # Set up paths to dependencies, such as cmake and boost. Safe no-op
 # if tools were set up elsewhere in the path.
@@ -62,13 +63,13 @@ Options:
     --yosys-args-overwrite  Do not use default flags set by this scrip during
                             Yosys compilation.
 
-    --yosys-args STRING      Aditional compilation flags for Yosys compilation.
+    --yosys-args STRING     Additional compilation flags for Yosys compilation.
 
     --openroad-args-overwrite
                             Do not use default flags set by this scrip during
                             OpenROAD app compilation.
 
-    --openroad-args STRING  Aditional compilation flags for OpenROAD app
+    --openroad-args STRING  Additional compilation flags for OpenROAD app
                             compilation.
 
     --install-path PATH     Path to install tools. Default is ${INSTALL_PATH}.
@@ -84,7 +85,7 @@ Options:
 Options valid only for Docker builds:
     -c, --copy-platforms    Copy platforms to inside docker image.
 
-    --os=DOCKER_OS_NAME     Choose beween ubuntu22.04 (default), ubuntu20.04.
+    --os=DOCKER_OS_NAME     Choose between ubuntu22.04 (default), ubuntu20.04.
 
     This script builds the OpenROAD tools: openroad, yosys and yosys plugins.
     By default, the tools will be built from the linked submodule hashes.
@@ -128,14 +129,14 @@ while (( "$#" )); do
                         DOCKER_COPY_PLATFORMS=1
                         ;;
                 --yosys-args-overwrite)
-                        YOSYS_OVERWIRTE_ARGS=1
+                        YOSYS_OVERWRITE_ARGS=1
                         ;;
                 --yosys-args)
                         YOSYS_USER_ARGS="$2"
                         shift
                         ;;
                 --openroad-args-overwrite)
-                        OPENROAD_APP_OVERWIRTE_ARGS=1
+                        OPENROAD_APP_OVERWRITE_ARGS=1
                         ;;
                 --openroad-args)
                         OPENROAD_APP_USER_ARGS="$2"
@@ -189,14 +190,14 @@ if [ -n "$CMAKE_INSTALL_RPATH" ]; then
 fi
 
 __args_setup() {
-        if [ ! -z "${YOSYS_OVERWIRTE_ARGS+x}" ]; then
+        if [ ! -z "${YOSYS_OVERWRITE_ARGS+x}" ]; then
                 echo "[INFO FLW-0014] Overwriting Yosys compilation flags."
                 YOSYS_ARGS="${YOSYS_USER_ARGS}"
         else
                 YOSYS_ARGS+=" ${YOSYS_USER_ARGS}"
         fi
 
-        if [ ! -z "${OPENROAD_APP_OVERWIRTE_ARGS+x}" ]; then
+        if [ ! -z "${OPENROAD_APP_OVERWRITE_ARGS+x}" ]; then
                 echo "[INFO FLW-0015] Overwriting OpenROAD app compilation flags."
                 OPENROAD_APP_ARGS="${OPENROAD_APP_USER_ARGS}"
         else
@@ -246,7 +247,7 @@ __local_build()
         ${NICE} make install -C tools/yosys -j "${PROC}" ${YOSYS_ARGS}
 
         echo "[INFO FLW-0018] Compiling OpenROAD."
-        eval ${NICE} cmake tools/OpenROAD -B tools/OpenROAD/build ${OPENROAD_APP_ARGS}
+        eval ${NICE} ./tools/OpenROAD/etc/Build.sh -dir="$DIR/tools/OpenROAD/build" -threads=${PROC} -cmake=\'${OPENROAD_APP_ARGS}\'
         ${NICE} cmake --build tools/OpenROAD/build --target install -j "${PROC}"
 }
 

docker/Dockerfile.builder

@@ -19,6 +19,8 @@ COPY --link tools tools
 ARG numThreads=$(nproc)
 
 RUN echo "" > tools/yosys/abc/.gitcommit && \
+  env CFLAGS="-D__TIME__=0 -D__DATE__=0 -D__TIMESTAMP__=0 -Wno-builtin-macro-redefined" \
+  CXXFLAGS="-D__TIME__=0 -D__DATE__=0 -D__TIMESTAMP__=0 -Wno-builtin-macro-redefined" \
   ./build_openroad.sh --no_init --local --threads ${numThreads}
 
 FROM orfs-base
@@ -33,6 +35,7 @@ COPY --link flow/platforms flow/platforms
 COPY --link flow/util flow/util
 COPY --link flow/scripts flow/scripts
 COPY --link flow/designs flow/designs
+COPY --link tools/AutoTuner tools/AutoTuner
 
 COPY --link --from=orfs-builder-base /OpenROAD-flow-scripts/tools/install tools/install
 COPY --link \

docker/Dockerfile.dev

@@ -13,8 +13,11 @@ COPY InstallerOpenROAD.sh \
        /tmp/installer/tools/OpenROAD/etc/DependencyInstaller.sh
 
 ARG options=""
+ARG constantBuildDir="-constant-build-dir"
 
-RUN ./DependencyInstaller.sh $options \
+RUN env CFLAGS="-D__TIME__=0 -D__DATE__=0 -D__TIMESTAMP__=0 -Wno-builtin-macro-redefined" \
+      CXXFLAGS="-D__TIME__=0 -D__DATE__=0 -D__TIMESTAMP__=0 -Wno-builtin-macro-redefined" \
+      ./DependencyInstaller.sh $options $constantBuildDir \
       && rm -rf /tmp/installer /tmp/* /var/tmp/* /var/lib/apt/lists/*
 
 ARG fromImage

docs/user/FlowVariables.md

@@ -72,6 +72,7 @@ Note:
 | `PDN_TCL`                            | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `IO_PLACER_H`                        | =            | =            | =             | =         | ?=        |
 | `IO_PLACER_V`                        | =            | =            | =             | =         | ?=        |
+| `FILL_CELLS`                         | =            | =            | =             | =         | =         |
 | Placement                            |              |              |               |           |           |
 | `CELL_PAD_IN_SITES_GLOBAL_PLACEMENT` | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `CELL_PAD_IN_SITES_DETAIL_PLACEMENT` | ?=           | ?=           | ?=            | ?=        | ?=        |
@@ -85,7 +86,6 @@ Note:
 | `EQUIVALENCE_CHECK`                  | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `REMOVE_CELLS_FOR_EQY`               | ?=           | ?=           | ?=            | ?=        | ?=        |
 | Routing                              |              |              |               |           |           |
-| `FILL_CELLS`                         | =            | =            | =             | =         | =         |
 | `KLAYOUT_TECH_FILE`                  | =            | =            | =             | =         | =         |
 | `MAX_ROUTING_LAYER`                  | =            | =            | =             | =         | ?=        |
 | `MIN_ROUTING_LAYER`                  | =            | =            | =             | =         | ?=        |
@@ -147,6 +147,8 @@ Note:
 | `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. |
+| `FILL_CELLS`          | Fill cells are used to fill empty sites. If not set or empty, fill cell insertion is skipped.	    |
+| `TAP_CELL_NAME`       | Name of the cell to use in tap cell insertion. |
 
 
 ### Placement
@@ -189,7 +191,6 @@ Note:
 
 | Variable              | Description                                                             |
 |-----------------------|---------------------------------------------------------------------------------------------------|
-| `FILL_CELLS`          | Fill cells are used to fill empty sites.    							    |
 | `MIN_ROUTING_LAYER`   | The lowest metal layer name to be used in routing.                                                |
 | `MAX_ROUTING_LAYER`   | The highest metal layer name to be used in routing.                                               |
 | `DETAILED_ROUTE_ARGS` | Add additional arguments for debugging purpose during detail route.                               |
@@ -264,16 +265,18 @@ configuration file.
 
 | Variable              | Description                                                                                                                                                                                                                                |
 |-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `CORE_UTILIZATION`    | The core utilization percentage (0-100). Overrides `DIE_AREA` and `CORE_AREA`.                                                                                                                                                                   |
-| `CORE_ASPECT_RATIO`   | The core aspect ratio (height / width). This values is ignored if `CORE_UTILIZATION` undefined.                                                                                                                                            |
-| `CORE_MARGIN`         | The margin between the core area and die area, in multiples of SITE heights. The margin is applied to each side. This variable is ignored if `CORE_UTILIZATION` is undefined.                                                              |
-| `DIE_AREA`            | The die area specified as a list of lower-left and upper-right corners in microns (X1 Y1 X2 Y2). This variable is ignored if `CORE_UTILIZATION` and `CORE_ASPECT_RATIO` are defined.                                                       |
-| `CORE_AREA`           | The core area specified as a list of lower-left and upper-right corners in microns (X1 Y1 X2 Y2). This variable is ignored if `CORE_UTILIZATION` and `CORE_ASPECT_RATIO` are defined.                                                      |
+| `CORE_UTILIZATION`    | The core utilization percentage (0-100). |
+| `CORE_ASPECT_RATIO`   | The core aspect ratio (height / width). This values is ignored if `CORE_UTILIZATION` undefined. |
+| `CORE_MARGIN`         | The margin between the core area and die area, in multiples of SITE heights. The margin is applied to each side. This variable is ignored if `CORE_UTILIZATION` is undefined. |
+| `DIE_AREA`            | The die area specified as a list of lower-left and upper-right corners in microns (X1 Y1 X2 Y2). |
+| `CORE_AREA`           | The core area specified as a list of lower-left and upper-right corners in microns (X1 Y1 X2 Y2). |
 | `RESYNTH_AREA_RECOVER` | Enable re-synthesis for area reclaim. |
 | `RESYNTH_TIMING_RECOVER` | Enable re-synthesis for timing optimization. | 
 | `MACRO_HALO_X`         | Set macro halo for x-direction. Only available for ASAP7 PDK. |
 | `MACRO_HALO_Y`         | Set macro halo for y-direction. Only available for ASAP7 PDK. |
 
+The various methods to specify the die and core area(`FLOORPLAN_DEF`, `FOOTPRINT`, `DIE_AREA` and `CORE_UTILIZATION`) are mutually exclusive. If two methods are specified, floorplan.tcl will exit with an error requiring that a single method is used.
+
 #### Placement
 
 

docs/user/InstructionsForAutoTuner.md

@@ -23,18 +23,16 @@ User-defined coefficient values (`coeff_perform`, `coeff_power`, `coeff_area`) o
 
 ## Setting up AutoTuner
 
-To setup AutoTuner, make sure you have a virtual environment set up with
-Python 3.9.X. There are plenty of ways to do this, we recommend using 
-[Miniconda](https://docs.conda.io/en/latest/miniconda.html),
-which is a free minimal installer for the package manager `conda`. 
+We have provided two convenience scripts, `./install.sh` and `./setup.sh`
+that works in Python3.8 for installation and configuration of AutoTuner,
+as shown below:
 
 ```shell
-# set up conda environment
-conda create -n autotuner_env python=3.9
-conda activate autotuner_env
+# Install prerequisites
+./tools/AutoTuner/install.sh
 
-# install requirements
-pip install -r ./tools/AutoTuner/requirements.txt
+# Start virtual environment
+./tools/AutoTuner/setup.sh
 ```
 
 ## Input JSON structure
@@ -198,6 +196,15 @@ We show three different views possible at the end, namely: `Table View`, `Scatte
 ![Parallel Coordinate View](../images/Autotuner_best_parameter_view.webp)
 <p style="text-align: center;">Parallel Coordinate View (best run is in green)</p>
 
+## Testing framework
+
+Assuming the virtual environment is setup at `./tools/AutoTuner/autotuner_env`:
+
+```
+./tools/AutoTuner/setup.sh
+python3 ./tools/AutoTuner/test/smoke_test_sweep.py
+python3 ./tools/AutoTuner/test/smoke_test_tune.py
+```
 
 ## Citation
 

etc/DependencyInstaller.sh

@@ -36,7 +36,15 @@ _installCommon() {
         pip3 install --no-cache-dir --user -U $pkgs
     fi
 
-    baseDir=$(mktemp -d /tmp/DependencyInstaller-orfs-XXXXXX)
+    if [[ "$constantBuildDir" == "true" ]]; then
+        baseDir="/tmp/DependencyInstaller-ORFS"
+        if [[ -d "$baseDir" ]]; then
+            echo "[INFO] Removing old building directory $baseDir"
+        fi
+        mkdir -p "$baseDir"
+    else
+        baseDir=$(mktemp -d /tmp/DependencyInstaller-orfs-XXXXXX)
+    fi
 
     # Install Verilator
     verilatorPrefix=`realpath ${PREFIX:-"/usr/local"}`
@@ -126,7 +134,9 @@ _installUbuntuPackages() {
         zlib1g-dev
 
     # install KLayout
-    if _versionCompare $1 -ge 23.04; then
+    if  [[ $1 == "rodete" ]]; then
+        apt-get -y install --no-install-recommends klayout python3-pandas
+    elif _versionCompare "$1" -ge 23.04; then
         apt-get -y install --no-install-recommends klayout python3-pandas
     else
         arch=$(uname -m)
@@ -160,6 +170,14 @@ _installUbuntuPackages() {
         rm -rf "${baseDir}"
     fi
 
+    if command -v docker &> /dev/null; then
+        # The user can uninstall docker if they want to reinstall it,
+        # and also this allows the user to choose drop in replacements
+        # for docker, such as podman-docker
+        echo "Docker is already installed, skip docker reinstall."
+        return 0
+    fi
+
     # Add Docker's official GPG key:
     install -m 0755 -d /etc/apt/keyrings
     curl -fsSL https://download.docker.com/linux/ubuntu/gpg \
@@ -172,11 +190,13 @@ _installUbuntuPackages() {
         tee /etc/apt/sources.list.d/docker.list > /dev/null
 
     apt-get -y update
-    apt-get -y install --no-install-recommends \
-        docker-ce \
-        docker-ce-cli \
-        containerd.io \
-        docker-buildx-plugin
+    if [[ $1 != "rodete" ]]; then
+        apt-get -y install --no-install-recommends \
+            docker-ce \
+            docker-ce-cli \
+            containerd.io \
+            docker-buildx-plugin
+    fi
 }
 
 _installDarwinPackages() {
@@ -227,6 +247,9 @@ Usage: $0
                                 #    sudo or with root access.
        $0 -ci
                                 # Installs CI tools
+       $0 -constant-build-dir
+                                #  Use constant build directory, instead of
+                                #    random one.
 EOF
     exit "${1:-1}"
 }
@@ -239,6 +262,7 @@ PREFIX=""
 option="all"
 # default isLocal
 isLocal="false"
+constantBuildDir="false"
 CI="no"
 
 # default values, can be overwritten by cmdline args
@@ -266,11 +290,16 @@ while [ "$#" -gt 0 ]; do
             ;;
         -ci)
             CI="yes"
+            OR_INSTALLER_ARGS="${OR_INSTALLER_ARGS} -save-deps-prefixes=/etc/openroad_deps_prefixes.txt"
             ;;
         -prefix=*)
             OR_INSTALLER_ARGS="${OR_INSTALLER_ARGS} $1"
             PREFIX=${1#*=}
             ;;
+        -constant-build-dir)
+            OR_INSTALLER_ARGS="${OR_INSTALLER_ARGS} $1"
+            constantBuildDir="true"
+            ;;
         *)
             echo "unknown option: ${1}" >&2
             _help
@@ -315,8 +344,11 @@ case "${os}" in
             _installCommon
         fi
         ;;
-    "Ubuntu" )
+    "Ubuntu" | "Debian GNU/Linux rodete" )
         version=$(awk -F= '/^VERSION_ID/{print $2}' /etc/os-release | sed 's/"//g')
+        if [[ -z ${version} ]]; then
+            version=$(awk -F= '/^VERSION_CODENAME/{print $2}' /etc/os-release | sed 's/"//g')
+        fi
         if [[ ${CI} == "yes" ]]; then
             echo "Installing CI Tools"
             _installCI
@@ -327,7 +359,9 @@ case "${os}" in
             _installUbuntuCleanUp
         fi
         if [[ "${option}" == "common" || "${option}" == "all" ]]; then
-            if _versionCompare ${version} -lt 23.04 ; then
+            if [[ $version == "rodete" ]]; then
+                echo "Skip common for rodete"
+            elif _versionCompare ${version} -lt 23.04 ; then
                 _installCommon
             fi
         fi