Merge pull request #8287 from Pinata-Consulting/bazel-creature-comforts

bazel: creature comforts

Author: maliberty

.bazelrc

@@ -97,4 +97,7 @@ build:openroad-dev --google_default_credentials=true
 build:openroad-dev --disk_cache=/workspace/.cache/bazel-disk-cache
 build:openroad-dev --repository_cache=/workspace/.cache/bazel-repository-cache
 
+# Without this, bazelisk build ... builds the bazel-orfs tests
+build --build_tag_filters=-orfs
+
 try-import %workspace%/user.bazelrc

test/orfs/README.md

@@ -94,3 +94,15 @@ This is a bit more verbose, but eliminates any concerns about what the `/tmp/pla
     [INFO GPL-1013] Final placement area: 94.65 (+0.00%)
     [ERROR GPL-0305] RePlAce diverged during gradient descent calculation, resulting in an invalid step length (Inf or NaN). This is often caused by numerical instability or high placement density. Consider reducing placement density to potentially resolve the issue.
     Error: global_place_skip_io.tcl, 12 GPL-0305
+
+## Adding `tags = ["manual"]` and `test_kwargs = ["orfs"]` to BUILD files
+
+In OpenROAD, `bazelisk build ...` should not build ORFS targets, only OpenROAD binaries.
+
+Since bazel-orfs also has build targets, builds in Bazel can build anything, not just executables, the policy in OpenROAD is to mark non-binary build targets as `tags = ["manual"]`.
+
+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.

test/orfs/gcd/BUILD

@@ -17,4 +17,8 @@ orfs_flow(
         "SDC_FILE": [":constraint.sdc"],
     },
     verilog_files = ["gcd.v"],
+    tags = ["manual"],
+    test_kwargs = {
+        "tags": ["orfs"],
+    },
 )

test/orfs/mock-array/BUILD

@@ -150,6 +150,10 @@ VARIANTS = [
     },
     variant = variant,
     verilog_files = [":verilog"],
+    tags = ["manual"],
+    test_kwargs = {
+        "tags": ["orfs"],
+    },
 ) for variant in VARIANTS]
 
 filegroup(
@@ -198,6 +202,7 @@ orfs_flow(
         "IO_CONSTRAINTS": [":mock-array-element-io"],
         "SDC_FILE": [":mock-array-constraints"],
     },
+    tags = ["manual"],
     verilog_files = [":verilog"],
 )
 
@@ -209,6 +214,7 @@ chisel_binary(
     deps = [
         "@openroad_maven//:com_github_scopt_scopt_2_13",
     ],
+    tags = ["manual"],
 )
 
 genrule(
@@ -220,6 +226,7 @@ genrule(
         ":generate_verilog",
         "@circt//:bin/firtool",
     ],
+    tags = ["manual"],
 )
 
 filegroup(
@@ -228,6 +235,7 @@ filegroup(
         "src/main/resources/multiplier.v",
         ":genverilog",
     ],
+    tags = ["manual"],
 )
 
 MACROS = [
@@ -290,6 +298,7 @@ verilog_library(
         "@docker_orfs//:OpenROAD-flow-scripts/flow/platforms/asap7/verilog/stdcell/dff.v",
         "@docker_orfs//:OpenROAD-flow-scripts/flow/platforms/asap7/verilog/stdcell/empty.v",
     ],
+    tags = ["manual"],
 )
 
 verilator_cc_library(
@@ -313,6 +322,7 @@ verilator_cc_library(
         # No-op option to retrigger a build
         # "-Wfuture-blah",
     ],
+    tags = ["manual"],
 )
 
 cc_binary(
@@ -326,6 +336,7 @@ cc_binary(
     deps = [
         ":array_verilator",
     ],
+    tags = ["manual"],
 )
 
 genrule(
@@ -338,6 +349,7 @@ genrule(
     cmd = "$(execpath :simulator) $(location :MockArrayTestbench.vcd)",
     tools = [
     ],
+    tags = ["manual"],
 )
 
 # If we want to measure power after final, instead of with estimated parasitics,
@@ -393,6 +405,7 @@ sh_test(
     data = [
         ":MockArray_power",
     ],
+    tags = ["manual"],
 )
 
 # FIXME why is this needed to ensure that cfg=exec of OpenSTA has runfiles?
@@ -404,4 +417,5 @@ genrule(
     $(location //src/sta:opensta) >$@
     """,
     tools = ["//src/sta:opensta"],
+    tags = ["manual"],
 )