From fcd6390936ac61d76b5c00f1f33a505045d11888 Mon Sep 17 00:00:00 2001 From: Matt Clarkson Date: Wed, 8 May 2024 18:06:23 +0100 Subject: [PATCH] feat(mode): add `purego` tag when `pure` (#3901) The community has agreed[1] that "pure" builds of Go code should use the `purego` build tag. This change adds that de-facto tag. The minimum version of Gazelle is bumped to `0.36.0` which includes a patch[2] for ignoring the `purego` tag so that the source flies are passed to the compiler for conditional compilation decisions. [1]: https://github.com/golang/go/issues/23172 [2]: https://github.com/bazelbuild/bazel-gazelle/pull/1767 --- .bazelci/presubmit.yml | 1 + WORKSPACE | 6 +++--- go/modes.rst | 2 ++ go/private/mode.bzl | 2 ++ tests/core/cgo/BUILD.bazel | 12 ++++++++++++ tests/core/cgo/tag_purego.go | 9 +++++++++ tests/core/cgo/tag_purego_err.c | 1 + tests/core/cgo/tag_purego_err.go | 6 ++++++ tests/core/cgo/tag_test.go | 3 +++ tests/integration/gazelle/gazelle_test.go | 2 +- third_party/org_golang_google_protobuf-gazelle.patch | 10 +++++++--- 11 files changed, 47 insertions(+), 7 deletions(-) create mode 100644 tests/core/cgo/tag_purego.go create mode 100644 tests/core/cgo/tag_purego_err.c create mode 100644 tests/core/cgo/tag_purego_err.go diff --git a/.bazelci/presubmit.yml b/.bazelci/presubmit.yml index f27efbb689..fc0102748d 100644 --- a/.bazelci/presubmit.yml +++ b/.bazelci/presubmit.yml @@ -62,6 +62,7 @@ tasks: - "//..." bcr_tests: name: BCR test module + bazel: 6.3.0 # silent ignore override in `gazelle@0.36.0` platform: ${{ platform }} working_directory: tests/bcr build_flags: diff --git a/WORKSPACE b/WORKSPACE index 849414cc35..39e2a61b04 100644 --- a/WORKSPACE +++ b/WORKSPACE @@ -71,10 +71,10 @@ bazel_skylib_workspace() http_archive( name = "bazel_gazelle", - sha256 = "b7387f72efb59f876e4daae42f1d3912d0d45563eac7cb23d1de0b094ab588cf", + sha256 = "75df288c4b31c81eb50f51e2e14f4763cb7548daae126817247064637fd9ea62", urls = [ - "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.34.0/bazel-gazelle-v0.34.0.tar.gz", - "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.34.0/bazel-gazelle-v0.34.0.tar.gz", + "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.36.0/bazel-gazelle-v0.36.0.tar.gz", + "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.36.0/bazel-gazelle-v0.36.0.tar.gz", ], ) diff --git a/go/modes.rst b/go/modes.rst index 431049d53d..54681d9b56 100644 --- a/go/modes.rst +++ b/go/modes.rst @@ -68,6 +68,8 @@ or using `Bazel configuration transitions`_. | Disables cgo, even when a C/C++ toolchain is configured (similar to setting | | ``CGO_ENABLED=0``). Packages that contain cgo code may still be built, but | | the cgo code will be filtered out, and the ``cgo`` build tag will be false. | +| Sets the de-facto ``purego`` build tag for conditional inclusion of source | +| files. | +-------------------+---------------------+------------------------------------+ | :param:`debug` | :type:`bool` | :value:`false` | +-------------------+---------------------+------------------------------------+ diff --git a/go/private/mode.bzl b/go/private/mode.bzl index 2318fd094c..2babb7f742 100644 --- a/go/private/mode.bzl +++ b/go/private/mode.bzl @@ -122,6 +122,8 @@ def get_mode(ctx, go_toolchain, cgo_context_info, go_config_info): tags.append("race") if msan: tags.append("msan") + if pure: + tags.append("purego") return struct( static = static, diff --git a/tests/core/cgo/BUILD.bazel b/tests/core/cgo/BUILD.bazel index 3fcd9875ef..16bae440b5 100644 --- a/tests/core/cgo/BUILD.bazel +++ b/tests/core/cgo/BUILD.bazel @@ -334,6 +334,7 @@ go_test( data = [ ":tag_cgo_bin", ":tag_pure_bin", + ":tag_purego_bin", ], rundir = ".", deps = ["//go/tools/bazel:go_default_library"], @@ -350,6 +351,17 @@ go_binary( pure = "on", ) +go_binary( + name = "tag_purego_bin", + srcs = [ + "tag_purego.go", + "tag_purego_err.c", + "tag_purego_err.go", + ], + cgo = True, + pure = "on", +) + go_binary( name = "tag_cgo_bin", srcs = [ diff --git a/tests/core/cgo/tag_purego.go b/tests/core/cgo/tag_purego.go new file mode 100644 index 0000000000..31d2375fac --- /dev/null +++ b/tests/core/cgo/tag_purego.go @@ -0,0 +1,9 @@ +// +build purego + +package main + +import "fmt" + +func main() { + fmt.Println("purego") +} diff --git a/tests/core/cgo/tag_purego_err.c b/tests/core/cgo/tag_purego_err.c new file mode 100644 index 0000000000..c92fa97ca8 --- /dev/null +++ b/tests/core/cgo/tag_purego_err.c @@ -0,0 +1 @@ +#error should not be compiled diff --git a/tests/core/cgo/tag_purego_err.go b/tests/core/cgo/tag_purego_err.go new file mode 100644 index 0000000000..059c2bafbd --- /dev/null +++ b/tests/core/cgo/tag_purego_err.go @@ -0,0 +1,6 @@ +// +build !purego + +package main + +// this file should not be compiled +!!! diff --git a/tests/core/cgo/tag_test.go b/tests/core/cgo/tag_test.go index b1ad4c9906..1e62747761 100644 --- a/tests/core/cgo/tag_test.go +++ b/tests/core/cgo/tag_test.go @@ -15,6 +15,9 @@ func Test(t *testing.T) { { name: "tag_pure_bin", want: "pure", + }, { + name: "tag_purego_bin", + want: "purego", }, { name: "tag_cgo_bin", want: "cgo", diff --git a/tests/integration/gazelle/gazelle_test.go b/tests/integration/gazelle/gazelle_test.go index 42ad91db12..0f29ca5800 100644 --- a/tests/integration/gazelle/gazelle_test.go +++ b/tests/integration/gazelle/gazelle_test.go @@ -53,8 +53,8 @@ func TestUpdate(t *testing.T) { } got := strings.TrimSpace(string(data)) want := strings.TrimSpace(` -load("@io_bazel_rules_go//go:def.bzl", "go_library") load("@bazel_gazelle//:def.bzl", "gazelle") +load("@io_bazel_rules_go//go:def.bzl", "go_library") # gazelle:prefix example.com/hello gazelle( diff --git a/third_party/org_golang_google_protobuf-gazelle.patch b/third_party/org_golang_google_protobuf-gazelle.patch index a43d9d5fd7..2db6d2ace1 100644 --- a/third_party/org_golang_google_protobuf-gazelle.patch +++ b/third_party/org_golang_google_protobuf-gazelle.patch @@ -1635,7 +1635,7 @@ diff -urN a/internal/genid/BUILD.bazel b/internal/genid/BUILD.bazel diff -urN a/internal/impl/BUILD.bazel b/internal/impl/BUILD.bazel --- a/internal/impl/BUILD.bazel 1970-01-01 00:00:00.000000000 +0000 +++ b/internal/impl/BUILD.bazel 2000-01-01 00:00:00.000000000 -0000 -@@ -0,0 +1,111 @@ +@@ -0,0 +1,113 @@ +load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test") + +go_library( @@ -1651,6 +1651,7 @@ diff -urN a/internal/impl/BUILD.bazel b/internal/impl/BUILD.bazel + "codec_map_go112.go", + "codec_message.go", + "codec_messageset.go", ++ "codec_reflect.go", + "codec_tables.go", + "codec_unsafe.go", + "convert.go", @@ -1671,6 +1672,7 @@ diff -urN a/internal/impl/BUILD.bazel b/internal/impl/BUILD.bazel + "message_reflect.go", + "message_reflect_field.go", + "message_reflect_gen.go", ++ "pointer_reflect.go", + "pointer_unsafe.go", + "validate.go", + "weak.go", @@ -1917,13 +1919,14 @@ diff -urN a/internal/set/BUILD.bazel b/internal/set/BUILD.bazel diff -urN a/internal/strs/BUILD.bazel b/internal/strs/BUILD.bazel --- a/internal/strs/BUILD.bazel 1970-01-01 00:00:00.000000000 +0000 +++ b/internal/strs/BUILD.bazel 2000-01-01 00:00:00.000000000 -0000 -@@ -0,0 +1,28 @@ +@@ -0,0 +1,29 @@ +load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test") + +go_library( + name = "strs", + srcs = [ + "strings.go", ++ "strings_pure.go", + "strings_unsafe_go120.go", + "strings_unsafe_go121.go", + ], @@ -3352,7 +3355,7 @@ diff -urN a/reflect/protorange/BUILD.bazel b/reflect/protorange/BUILD.bazel diff -urN a/reflect/protoreflect/BUILD.bazel b/reflect/protoreflect/BUILD.bazel --- a/reflect/protoreflect/BUILD.bazel 1970-01-01 00:00:00.000000000 +0000 +++ b/reflect/protoreflect/BUILD.bazel 2000-01-01 00:00:00.000000000 -0000 -@@ -0,0 +1,39 @@ +@@ -0,0 +1,40 @@ +load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test") + +go_library( @@ -3365,6 +3368,7 @@ diff -urN a/reflect/protoreflect/BUILD.bazel b/reflect/protoreflect/BUILD.bazel + "type.go", + "value.go", + "value_equal.go", ++ "value_pure.go", + "value_union.go", + "value_unsafe_go120.go", + "value_unsafe_go121.go",