Merge pull request #7206 from Pinata-Consulting/orfs-test-case

Orfs test case - basis for further collaboration and discussion

Author: maliberty

.bazelignore

@@ -2,3 +2,5 @@ build/
 debug/
 src/sta/build/
 src/sta/debug/
+# delete line below when CI can handle it and it runs in minutes
+test/orfs/

MODULE.bazel

@@ -98,3 +98,25 @@ pip.parse(
     requirements_lock = "//bazel:requirements_lock_3_13.txt",
 )
 use_repo(pip, "openroad-pip")
+
+bazel_dep(name = "bazel-orfs")
+
+# To bump version, run: bazelisk run @bazel-orfs//:bump
+git_override(
+    module_name = "bazel-orfs",
+    commit = "126765508161956f8f82ae169084da0235230637",
+    remote = "https://github.com/The-OpenROAD-Project/bazel-orfs.git",
+)
+
+orfs = use_extension("@bazel-orfs//:extension.bzl", "orfs_repositories")
+
+# To bump version, run: bazelisk run @bazel-orfs//:bump
+orfs.default(
+    # Official image https://hub.docker.com/r/openroad/orfs/tags
+    image = "docker.io/openroad/orfs:v3.0-2883-ge22e4fc7",
+    # Use OpenROAD of this repo instead of from the docker image
+    openroad = "//:openroad",
+    sha256 = "6ad0b1b7fbf290f33f0050ead4da181c83c6e8a9337b65f5f9cff65d67788424",
+)
+use_repo(orfs, "com_github_nixos_patchelf_download")
+use_repo(orfs, "docker_orfs")

MODULE.bazel.lock

@@ -0,0 +1,14 @@
+# ORFS smoke tests
+
+A set of ORFS integration tests that runs in a few minutes suitable for inclusion in the local fast regression testing workflow prior to creating a PR:
+
+    bazel -c opt test ...
+
+## Updating RULES_JSON files
+
+1. Run `bazel run -c opt //test/orfs/gcd:gcd_update` to update RULES_JSON file for a design. This will build and run OpenROAD to generate a new RULES_JSON file and update the RULES_JSON source file.
+2. Create commit for RULES_JSON file
+
+## Updating ORFS and bazel-orfs
+
+`bazel run @bazel-orfs//:bump`, this will find the latest bazel-orfs and ORFS docker image and update MODULE.bazel and MODULE.bazel.lock.

test/orfs/README.md

@@ -0,0 +1,21 @@
+load("@bazel-orfs//:openroad.bzl", "orfs_flow")
+
+orfs_flow(
+    name = "gcd",
+    arguments = {
+        # Faster builds
+        "SKIP_INCREMENTAL_REPAIR": "1",
+        "GPL_TIMING_DRIVEN": "0",
+        "SKIP_LAST_GASP": "1",
+        # Various
+        "DIE_AREA": "0 0 16.2 16.2",
+        "CORE_AREA": "1.08 1.08 15.12 15.12",
+        "PLACE_DENSITY": "0.35",
+    },
+    sources = {
+        "RULES_JSON": [":rules-base.json"],
+        "SDC_FILE": [":constraint.sdc"],
+    },
+    verilog_files = ["gcd.v"],
+    tags = ["manual"],
+)

test/orfs/gcd/BUILD

@@ -0,0 +1,12 @@
+# Summary
+
+Simple GCD (greatest common denominator) core. This is an extremely small
+design mostly used to test the sanity of the flow.
+
+Originally generated using [PyMTL](https://github.com/cornell-brg/pymtl).
+
+This design has about 250 cells.
+
+# Source
+
+Re-used code derived from http://opencelerity.org/ project.

test/orfs/gcd/README.md

@@ -0,0 +1,15 @@
+current_design gcd
+
+set clk_name core_clock
+set clk_port_name clk
+set clk_period 310
+set clk_io_pct 0.2
+
+set clk_port [get_ports $clk_port_name]
+
+create_clock -name $clk_name -period $clk_period $clk_port
+
+set non_clock_inputs [lsearch -inline -all -not -exact [all_inputs] $clk_port]
+
+set_input_delay [expr $clk_period * $clk_io_pct] -clock $clk_name $non_clock_inputs
+set_output_delay [expr $clk_period * $clk_io_pct] -clock $clk_name [all_outputs]