Merge pull request The-OpenROAD-Project#8903 from Pinata-Consulting/mock-array-logic-equivalence-check

test/orfs: mock-array logic equivalence check

Author: maliberty

test/orfs/README.md

@@ -112,3 +112,19 @@ To hunt down missing `tags = ["manual"]` run a query like:
     bazelisk query 'kind(".*", //test/orfs/mock-array/...) except attr(tags, "manual", //test/orfs/mock-array/...)'
 
 Note that OpenROAD *does* want `bazelisk test ...` to run all tests, so test targets should be marked `tags = ["orfs"]` instead, so that `.bazelrc` can skip builds of those targets with the `build --build_tag_filters=-orfs` line.
+
+## eqy tests
+
+`eqy_test` is used to run equivalence checks before and after an ORFS stage, such as before and after floorplan for mock-array. To run the test and keep all the files from the test and see interactive output, run:
+
+    bazelisk test //test/orfs/mock-array:MockArray_4x4_eqy_test --test_output=streamed --sandbox_debug
+
+If this fails, then it will output the line below. `eqy` uses a very, very large number of files and copying out these files to the bazel-testlogs folder for inspection takes some time:
+
+    Copying 114462 files to bazel-testlogs/test/orfs/mock-array/MockArray_4x4_eqy_test/test.outputs for inspection.
+
+If you just want the files needed to run a locally installed `eqy`, build all the files used in the run above by:
+
+    bazelisk build //test/orfs/mock-array:MockArray_4x4_eqy_test
+
+The files used to run the test are then in `bazel-bin/test/orfs/mock-array/`.

test/orfs/mock-array/BUILD

@@ -1,3 +1,4 @@
+load("@bazel-orfs//:eqy.bzl", "eqy_test")
 load("@bazel-orfs//:openroad.bzl", "orfs_run")
 load("@bazel-orfs//toolchains/scala:chisel.bzl", "chisel_binary")
 load(":mock-array.bzl", "config", "element", "mock_array", "verilog")
@@ -99,3 +100,47 @@ orfs_run(
     script = ":write_pin_placement.tcl",
     tags = ["manual"],
 )
+
+[
+    orfs_run(
+        name = "{}_floorplan_verilog".format(module),
+        src = ":{}_base_floorplan".format(module),
+        outs = [
+            "{}_floorplan.v".format(module),
+        ],
+        arguments = {
+            "OUTPUT": "$(location :{}_floorplan.v)".format(module),
+        },
+        script = ":write_verilog.tcl",
+        tags = ["manual"],
+    )
+    for module in [
+        "MockArray_4x4",
+        "Element_4x4",
+    ]
+]
+
+ASAP7_DEPS = [
+    "asap7/asap7sc7p5t_AO_RVT_TT_201020.v",
+    "asap7/asap7sc7p5t_INVBUF_RVT_TT_201020.v",
+    "asap7/asap7sc7p5t_OA_RVT_TT_201020.v",
+    "asap7/asap7sc7p5t_SIMPLE_RVT_TT_201020.v",
+    "@docker_orfs//:OpenROAD-flow-scripts/flow/platforms/asap7/verilog/stdcell/dff.v",
+    "@docker_orfs//:OpenROAD-flow-scripts/flow/platforms/asap7/verilog/stdcell/empty.v",
+]
+
+eqy_test(
+    name = "MockArray_4x4_eqy_test",
+    depth = 1,
+    gate_verilog_files = [
+        ":MockArray_4x4_floorplan.v",
+        ":Element_4x4_floorplan.v",
+        "src/main/resources/multiplier.v",
+    ] + ASAP7_DEPS,
+    gold_verilog_files = [
+        ":4x4_array.sv",
+        "src/main/resources/multiplier.v",
+    ] + ASAP7_DEPS,
+    module_top = "MockArray",
+    tags = ["manual"],
+)

test/orfs/mock-array/asap7/README.md

@@ -0,0 +1,3 @@
+# Hacked asap7 files
+
+These are a few asap7 files hacked and slashed until eqy was able to parse them, hence a copy here specific to the tests in this module.