Merge branch 'master' into secure-repair_antennas

Signed-off-by: Eder Monteiro <[email protected]>

Author: eder-matheus

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).
+

docker/Dockerfile.builder

@@ -33,6 +33,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 \

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

@@ -126,7 +126,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 +162,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 +182,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() {
@@ -315,8 +327,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 +342,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

flow/.bazelrc

@@ -0,0 +1,2 @@
+build --incompatible_strict_action_env
+try-import %workspace%/.user-bazelrc

flow/.bazelversion

@@ -0,0 +1 @@
+7.2.1