Merge remote-tracking branch 'origin/master' into HEAD

Author: oharboe

.devcontainer/devcontainer.json

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 {
-  "image": "ghcr.io/the-openroad-project/openroad-flow-scripts:lxqt",
+  "image": "docker.io/openroad/orfs-lxqt:latest",
   "forwardPorts": [6080],
   "portsAttributes": {
     "6080": {

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

docs/conf.py

@@ -159,7 +159,7 @@ def setup(app):
     get_file_from_url(url, "contrib/GitGuide.md")
 
     # Temporarily using commit number, will change once OR commit merged.
-    url = "https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/3563176d00daeb613eed2ccf9442137b0ae2cad3/docs/index.md"
+    url = "https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/master/docs/index.md"
     get_file_from_url(url, "SupportedOS.md")
 
     # edit OpenROAD to OpenROAD-flow-scripts for GitGuide

docs/revert-links.py

@@ -361,7 +361,7 @@ The table below briefly describes the reports directory files.
 
 | File Name              | Description                                              |
 |------------------------|----------------------------------------------------------|
-| `congestion.rpt`       | Gloabl routing congestion if occurred.                   |
+| `congestion.rpt`       | Global routing congestion if occurred.                   |
 | `5_route_drc.rpt`      | DRC violations if occurred.                              |
 | `final_clocks.webp`    | OR extracted image reference after clock tree synthesis. |
 | `final_resizer.webp`   | OR extracted image reference after resizer.              |

docs/tutorials/FlowTutorial.md

@@ -4,7 +4,7 @@
 
 The `setup.sh` script installs all of the dependencies, including OpenROAD dependencies, if they are not already installed.
 
-Supported configurations are: CentOS 7, Ubuntu 20.04, Ubuntu 22.04, RHEL 8,
+Supported configurations are: CentOS 7, Ubuntu 20.04, Ubuntu 22.04, Ubuntu 22.04(aarch64), RHEL 8,
 Debian 10 and Debian 11.
 
 ``` shell

docs/user/BuildLocally.md

@@ -57,7 +57,7 @@ Export path variables accordingly.
 ```
 # these variables are used in flow/Makefile. Do make sure the yosys path is sourced.
 export OPENROAD_EXE=$(command -v openroad)
-export YOSYS_CMD=$(command -v yosys)
+export YOSYS_EXE=$(command -v yosys)
 
 # only if KLayout is built from source
 export LD_LIBRARY_PATH="<klayout_location>/bin:$PATH" 

docs/user/BuildWithPrebuilt.md

@@ -40,7 +40,7 @@ If you have built your OpenROAD Docker image using prebuilt binaries,
 you might want to source custom paths for your modules as follows.
 
 ```
-OR_IMAGE=openroad_prebuilt_image YOSYS_CMD=/oss-cad-suite/bin/yosys util/docker_shell make
+OR_IMAGE=openroad_prebuilt_image YOSYS_EXE=/oss-cad-suite/bin/yosys util/docker_shell make
 ```
 
 Using `docker_shell` from outside of `OpenROAD-flow-scripts/flow` folder

docs/user/DockerShell.md

@@ -6,11 +6,13 @@ platform, design and tool specific variables to allow finer control and
 user overrides at various flow stages. These are defined in the
 `config.mk` file located in the platform and design specific directories.
 
-### General variables for all stages
+### General variables
 
 | Variable         | Description                                                                        |
 |------------------|------------------------------------------------------------------------------------|
 | `SKIP_REPORT_METRICS`   | If set to 1, then metrics, report_metrics does nothing. Useful to speed up builds. |
+| `DETAILED_METRICS`      | If set, then calls report_metrics prior to repair operations in the CTS and global route stages |
+| `GENERATE_ARTIFACTS_ON_FAILURE` | Used with non-Makefile build systems, such as Bazel. If set to 1, artifacts are generated even if a step failed, such a failed global routing will generate a .odb file and an .rpt file. The subsequent step will not proceed, thus detecting the error. |
 
 ## Platform
 
@@ -76,15 +78,14 @@ Note:
 | `PLACE_DENSITY`                      | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `WIRE_RC_LAYER`                      | =            | =            | =             | =         | =         |
 | Clock Tree Synthesis                 |              |              |               |           |           |
-| `CTS_BUF_CELL`                       | =            | =            | =             | =         | =         |
 | `CTS_BUF_DISTANCE`                   | N/A          | N/A          | N/A           | =         | =         |
-| `FILL_CELLS`                         | =            | =            | =             | =         | =         |
 | `SKIP_GATE_CLONING`                  | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `SKIP_PIN_SWAP`                      | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `TNS_END_PERCENT`                    | ?=           | ?=           |               | ?=        | ?=        |
 | `EQUIVALENCE_CHECK`                  | ?=           | ?=           | ?=            | ?=        | ?=        |
 | `REMOVE_CELLS_FOR_EQY`               | ?=           | ?=           | ?=            | ?=        | ?=        |
 | Routing                              |              |              |               |           |           |
+| `FILL_CELLS`                         | =            | =            | =             | =         | =         |
 | `KLAYOUT_TECH_FILE`                  | =            | =            | =             | =         | =         |
 | `MAX_ROUTING_LAYER`                  | =            | =            | =             | =         | ?=        |
 | `MIN_ROUTING_LAYER`                  | =            | =            | =             | =         | ?=        |
@@ -159,7 +160,7 @@ Note:
 | `PLACE_DENSITY`                      | The desired placement density of cells. It reflects how spread the cells would be on the core area. 1.0 = closely dense. 0.0 = widely spread. |
 | `PLACE_DENSITY_LB_ADDON`             | Check the lower boundary of the PLACE_DENSITY and add PLACE_DENSITY_LB_ADDON if it exists.                                                    |
 | `REPAIR_PDN_VIA_LAYER`               | Remove power grid vias which generate DRC violations after detailed routing.                                                                  |
-| `GLOBAL_PLACEMENT_ARGS`              | Use additional tuning parameters during global placement other than default args defined in gloabl_place.tcl.                                 |
+| `GLOBAL_PLACEMENT_ARGS`              | Use additional tuning parameters during global placement other than default args defined in global_place.tcl.                                 |
 | `ENABLE_DPO`                         | Enable detail placement with improve_placement feature.                                                                                       |
 | `DPO_MAX_DISPLACEMENT`               | Specifies how far an instance can be moved when optimizing.                                                                                   |
 | `GPL_TIMING_DRIVEN`                  | Specifies whether the placer should use timing driven placement.                                                                              |
@@ -174,8 +175,6 @@ Note:
 | Variable              | Description                                                                                                  |
 |-----------------------|--------------------------------------------------------------------------------------------------------------|
 | `CTS_ARGS`            | Override `clock_tree_synthesis` arguments                           |
-| `CTS_BUF_CELL`        | The buffer cell used in the clock tree.                                                                      |
-| `FILL_CELLS`          | Fill cells are used to fill empty sites.    								                                   |
 | `HOLD_SLACK_MARGIN`   | Specifies a time margin for the slack when fixing hold violations. This option allow you to overfix.         |
 | `SETUP_SLACK_MARGIN`  | Specifies a time margin for the slack when fixing setup violations.                                          |
 | `SKIP_GATE_CLONING`   | Do not use gate cloning transform to fix timing violations (default: use gate cloning)                       |
@@ -190,6 +189,7 @@ 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.                               |
@@ -274,33 +274,35 @@ configuration file.
 | `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. |
 
-## Placement
+#### Placement
 
 
 | Variable                 | Description                                                                                        |
 |--------------------------|----------------------------------------------------------------------------------------------------|
 | `MACRO_WRAPPERS`         | The wrapper file that replace existing macros with their wrapped version.                          |
 
 
-## Clock Tree Synthesis
+#### Clock Tree Synthesis
 
 
 | Variable                 | Description                                                                                        |
 |--------------------------|----------------------------------------------------------------------------------------------------|
-| `CTS_BUF_DISTANCE`       | Distance (in microns) between buffers.                                                              |
+| `CTS_BUF_DISTANCE`       | Distance (in microns) between buffers.                                                             |
 | `CTS_CLUSTER_DIAMETER`   | Maximum diameter (in microns) of sink cluster. Default 20.                                         |
-| `CTS_CLUSTER_SIZE`       | Maximum number of sinks per cluster. Default 50.
+| `CTS_CLUSTER_SIZE`       | Maximum number of sinks per cluster. Default 50.                                                   |
+| `CTS_SNAPSHOT`           | Creates ODB/SDC files prior to clock net and setup/hold repair.                                    |
+| `POST_CTS_TCL`           | Specifies a Tcl script with commands to run after CTS is completed.                                |
 
 
-## Routing
+#### Routing
 
 
 | Variable                 | Description                                                                                        |
 |--------------------------|----------------------------------------------------------------------------------------------------|
-| `FASTROUTE_TCL`          | Specifies a Tcl scripts with commands to run before FastRoute.                                      |
+| `FASTROUTE_TCL`          | Specifies a Tcl scripts with commands to run before FastRoute.                                     |
 
 
-## GDS Streamout
+#### GDS Streamout
 
 
 | Variable                 | Description                                                                                        |

docs/user/FlowVariables.md

@@ -98,7 +98,6 @@ For Global Routing parameters that are set on `fastroute.tcl` you can use:
 * `_FR_GR_SEED`
   - Global route random seed. This will create a copy of `_FR_FILE_PATH` and modify the global route random seed.
 
-
 ## How to use
 
 ### General Information