Add predefined configurations to java_toolchain_default
In order for java_toolchain_default to be more usable, predefined configurations are supplied: `JVM8_TOOLCHAIN_CONFIGURATION`, `JAVABUILDER_TOOLCHAIN_CONFIGURATION`, `VANILLA_TOOLCHAIN_CONFIGURATION`, `PREBUILT_TOOLCHAIN_CONFIGURATION`.
Those configurations are going to be needed once `java_runtime` is attached to `java_toolchain`, because predefined toolchain in `BUILD.java_tools` (e.g. vanilla_toolchain) will need to be removed (as they don't have a default choice of `java_runtime`).
After that the user can use `java_toolchain_default(name="toolchain_vanilla", configuration = VANILLA_TOOLCHAIN_CONFIGURATION, java_runtime = ...)`.
Additionally to this, `jvm_opts` parameter is automatically converted to absolute labels. For example from `--patch-module=java.compiler=$(location //:java_compiler_jar)` to `--patch-module=java.compiler=$(location @bazel_java_tools_linux//:java_compiler_jar)`.
Also `java_toolchain_default.bzl` is renamed to `java_toolchain_default.bzl.java_tools` to make it accessible only from @java_tools repository and not @bazel_tools. In the latter it is was never supposed to work.
Closes #12441.
PiperOrigin-RevId: 342053742
diff --git a/tools/jdk/BUILD b/tools/jdk/BUILD
index 201096f..e41c1cf 100644
--- a/tools/jdk/BUILD
+++ b/tools/jdk/BUILD
@@ -436,7 +436,7 @@
"default_java_toolchain.bzl",
"fail_rule.bzl",
"java_toolchain_alias.bzl",
- "java_toolchain_default.bzl",
+ "java_toolchain_default.bzl.java_tools",
"jdk.BUILD",
"local_java_repository.bzl",
"nosystemjdk/README",
diff --git a/tools/jdk/BUILD.java_tools b/tools/jdk/BUILD.java_tools
index 17d0989..5d3abc7 100644
--- a/tools/jdk/BUILD.java_tools
+++ b/tools/jdk/BUILD.java_tools
@@ -7,7 +7,14 @@
load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library", "cc_proto_library")
load("@rules_java//java:defs.bzl", "java_binary", "java_import", "java_toolchain")
load("@rules_proto//proto:defs.bzl", "proto_library")
-load(":java_toolchain_default.bzl", "JDK9_JVM_OPTS", "java_toolchain_default")
+load(
+ ":java_toolchain_default.bzl",
+ "JAVABUILDER_TOOLCHAIN_CONFIGURATION",
+ "JVM8_TOOLCHAIN_CONFIGURATION",
+ "PREBUILT_TOOLCHAIN_CONFIGURATION",
+ "VANILLA_TOOLCHAIN_CONFIGURATION",
+ "java_toolchain_default",
+)
SUPRESSED_WARNINGS = select({
":windows": [],
@@ -19,26 +26,12 @@
java_toolchain_default(
name = "toolchain",
- javac = ["//:javac_jar"],
- jvm_opts = [
- # In JDK9 we have seen a ~30% slow down in JavaBuilder performance when using
- # G1 collector and having compact strings enabled.
- "-XX:+UseParallelOldGC",
- "-XX:-CompactStrings",
- # override the javac in the JDK.
- "--patch-module=java.compiler=$(location :java_compiler_jar)",
- "--patch-module=jdk.compiler=$(location :jdk_compiler_jar)",
- ] + JDK9_JVM_OPTS,
- tools = [
- "//:java_compiler_jar",
- "//:jdk_compiler_jar",
- ],
+ configuration = JAVABUILDER_TOOLCHAIN_CONFIGURATION,
)
java_toolchain_default(
name = "toolchain_hostjdk8",
- javac = ["//:javac_jar"],
- jvm_opts = ["-Xbootclasspath/p:$(location :javac_jar)"],
+ configuration = JVM8_TOOLCHAIN_CONFIGURATION,
source_version = "8",
target_version = "8",
)
@@ -47,50 +40,22 @@
# TODO(cushon): consider if/when we should increment this?
java_toolchain_default(
name = "legacy_toolchain",
- javac = ["//:javac_jar"],
- jvm_opts = [
- # override the javac in the JDK.
- "--patch-module=java.compiler=$(location :java_compiler_jar)",
- "--patch-module=jdk.compiler=$(location :jdk_compiler_jar)",
- ] + JDK9_JVM_OPTS,
+ configuration = JAVABUILDER_TOOLCHAIN_CONFIGURATION,
source_version = "8",
target_version = "8",
- tools = [
- "//:java_compiler_jar",
- "//:jdk_compiler_jar",
- ],
)
# Needed for openbsd / JVM8
java_toolchain_default(
name = "legacy_toolchain_jvm8",
- javac = ["//:javac_jar"],
- jvm_opts = ["-Xbootclasspath/p:$(location :javac_jar)"],
+ configuration = JVM8_TOOLCHAIN_CONFIGURATION,
source_version = "8",
target_version = "8",
)
-# The 'vanilla' toolchain is an unsupported alternative to the default.
-#
-# It does not provide any of the following features:
-# * Error Prone
-# * Strict Java Deps
-# * Header Compilation
-# * Reduced Classpath Optimization
-#
-# It uses the version of internal javac from the `--host_javabase` JDK instead
-# of providing a javac. Internal javac may not be source- or bug-compatible with
-# the javac that is provided with other toolchains.
-#
-# However it does allow using a wider range of `--host_javabase`s, including
-# versions newer than the current JDK.
java_toolchain_default(
name = "toolchain_vanilla",
- forcibly_disable_header_compilation = True,
- javabuilder = ["//:vanillajavabuilder"],
- jvm_opts = [],
- source_version = "",
- target_version = "",
+ configuration = VANILLA_TOOLCHAIN_CONFIGURATION,
)
RELEASES = (8, 9, 10, 11)
@@ -99,26 +64,14 @@
(
java_toolchain_default(
name = "toolchain_java%d" % release,
- javac = ["//:javac_jar"],
- jvm_opts = [
- # override the javac in the JDK.
- "--patch-module=java.compiler=$(location :java_compiler_jar)",
- "--patch-module=jdk.compiler=$(location :jdk_compiler_jar)",
- ] + JDK9_JVM_OPTS,
+ configuration = JAVABUILDER_TOOLCHAIN_CONFIGURATION,
source_version = "%s" % release,
target_version = "%s" % release,
- tools = [
- "//:java_compiler_jar",
- "//:jdk_compiler_jar",
- ],
),
# Needed for openbsd / JVM8
java_toolchain_default(
name = "toolchain_java%d_jvm8" % release,
- javac = ["//:javac_jar"],
- jvm_opts = [
- "-Xbootclasspath/p:$(location :javac_jar)",
- ],
+ configuration = JVM8_TOOLCHAIN_CONFIGURATION,
source_version = "%s" % release,
target_version = "%s" % release,
),
@@ -126,27 +79,6 @@
for release in RELEASES
]
-# A toolchain that targets java 11.
-java_toolchain_default(
- name = "toolchain_jdk_11",
- javac = ["//:javac_jar"],
- jvm_opts = [
- # In JDK9 we have seen a ~30% slow down in JavaBuilder performance when using
- # G1 collector and having compact strings enabled.
- "-XX:+UseParallelOldGC",
- "-XX:-CompactStrings",
- # override the javac in the JDK.
- "--patch-module=java.compiler=$(location :java_compiler_jar)",
- "--patch-module=jdk.compiler=$(location :jdk_compiler_jar)",
- ] + JDK9_JVM_OPTS,
- source_version = "11",
- target_version = "11",
- tools = [
- "//:java_compiler_jar",
- "//:jdk_compiler_jar",
- ],
-)
-
# A toolchain that targets java 14.
java_toolchain_default(
name = "toolchain_jdk_14",
@@ -161,29 +93,9 @@
target_version = "15",
)
-# The new toolchain is using all the pre-built tools, including
-# singlejar and ijar, even on remote execution. This toolchain
-# should be used only when host and execution platform are the
-# same, otherwise the binaries will not work on the execution
-# platform.
java_toolchain_default(
name = "prebuilt_toolchain",
- ijar = ["//:ijar_prebuilt_binary"],
- javac = ["//:javac_jar"],
- jvm_opts = [
- # In JDK9 we have seen a ~30% slow down in JavaBuilder performance when using
- # G1 collector and having compact strings enabled.
- "-XX:+UseParallelOldGC",
- "-XX:-CompactStrings",
- # override the javac in the JDK.
- "--patch-module=java.compiler=$(location :java_compiler_jar)",
- "--patch-module=jdk.compiler=$(location :jdk_compiler_jar)",
- ] + JDK9_JVM_OPTS,
- singlejar = ["//:prebuilt_singlejar"],
- tools = [
- "//:java_compiler_jar",
- "//:jdk_compiler_jar",
- ],
+ configuration = PREBUILT_TOOLCHAIN_CONFIGURATION,
)
filegroup(
@@ -326,38 +238,50 @@
config_setting(
name = "linux_x86_64",
- constraint_values = [ "@platforms//os:linux", "@platforms//cpu:x86_64" ],
+ constraint_values = [
+ "@platforms//os:linux",
+ "@platforms//cpu:x86_64",
+ ],
)
config_setting(
name = "darwin_x86_64",
- constraint_values = [ "@platforms//os:macos", "@platforms//cpu:x86_64" ],
+ constraint_values = [
+ "@platforms//os:macos",
+ "@platforms//cpu:x86_64",
+ ],
)
config_setting(
name = "darwin_arm64",
- constraint_values = [ "@platforms//os:macos", "@platforms//cpu:arm64" ],
+ constraint_values = [
+ "@platforms//os:macos",
+ "@platforms//cpu:arm64",
+ ],
)
config_setting(
name = "darwin_arm64e",
- constraint_values = [ "@platforms//os:macos", "@platforms//cpu:arm64e" ],
+ constraint_values = [
+ "@platforms//os:macos",
+ "@platforms//cpu:arm64e",
+ ],
)
config_setting(
name = "windows",
- constraint_values = [ "@platforms//os:windows" ],
+ constraint_values = ["@platforms//os:windows"],
)
config_setting(
name = "freebsd",
- constraint_values = [ "@platforms//os:freebsd" ],
+ constraint_values = ["@platforms//os:freebsd"],
visibility = ["//visibility:public"],
)
config_setting(
name = "openbsd",
- constraint_values = [ "@platforms//os:openbsd" ],
+ constraint_values = ["@platforms//os:openbsd"],
visibility = ["//visibility:public"],
)
diff --git a/tools/jdk/java_toolchain_default.bzl b/tools/jdk/java_toolchain_default.bzl
deleted file mode 100644
index cddc614..0000000
--- a/tools/jdk/java_toolchain_default.bzl
+++ /dev/null
@@ -1,104 +0,0 @@
-# Copyright 2020 The Bazel Authors. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Bazel rules for creating Java toolchains."""
-
-_DEFAULT_JAVACOPTS = [
- "-XDskipDuplicateBridges=true",
- "-XDcompilePolicy=simple",
- "-g",
- "-parameters",
-]
-
-# JVM options, without patching java.compiler and jdk.compiler modules.
-JDK9_JVM_OPTS = [
- # Allow JavaBuilder to access internal javac APIs.
- "--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
- "--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED",
- "--add-exports=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED",
- "--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
- "--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED",
- "--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED",
- "--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED",
- "--add-opens=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
-
- # quiet warnings from com.google.protobuf.UnsafeUtil,
- # see: https://github.com/google/protobuf/issues/3781
- # and: https://github.com/bazelbuild/bazel/issues/5599
- "--add-opens=java.base/java.nio=ALL-UNNAMED",
- "--add-opens=java.base/java.lang=ALL-UNNAMED",
-]
-
-# java_toolchain parameters without specifying javac, java.compiler,
-# jdk.compiler module, and jvm_opts
-_BASE_TOOLCHAIN_CONFIGURATION = dict(
- forcibly_disable_header_compilation = False,
- genclass = [Label("//:GenClass")],
- header_compiler = [Label("//:TurbineDirect")],
- header_compiler_direct = [Label("//:TurbineDirect")],
- ijar = [Label("//:ijar")],
- javabuilder = [Label("//:JavaBuilder")],
- javac_supports_workers = True,
- jacocorunner = Label("//:jacoco_coverage_runner_filegroup"),
- jvm_opts = JDK9_JVM_OPTS,
- misc = _DEFAULT_JAVACOPTS,
- singlejar = [Label("//:singlejar")],
- # Code to enumerate target JVM boot classpath uses host JVM. Because
- # java_runtime-s are involved, its implementation is in @bazel_tools.
- bootclasspath = ["@bazel_tools//tools/jdk:platformclasspath"],
- source_version = "8",
- target_version = "8",
-)
-
-_LABEL_LISTS = [
- "bootclasspath",
- "extclasspath",
- "javac",
- "tools",
- "javabuilder",
- "singlejar",
- "genclass",
- "resourcejar",
- "ijar",
- "header_compiler",
- "header_compiler_direct",
- "package_configuration",
-]
-
-_LABELS = [
- "timezone_data",
- "oneversion",
- "oneversion_whitelist",
- "jacocorunner",
- "proguard_allowlister",
- "java_runtime",
-]
-
-# Converts values to labels, so that they are resolved relative to this java_tools repository
-def _to_label(k, v):
- if k in _LABELS and type(v) == type(Label("//a")):
- return Label(v)
- if k in _LABEL_LISTS and type(v) == type([Label("//a")]):
- return [Label(label) for label in v]
- return v
-
-def java_toolchain_default(name, **kwargs):
- """Defines a java_toolchain with appropriate defaults for Bazel."""
-
- toolchain_args = dict(_BASE_TOOLCHAIN_CONFIGURATION)
- toolchain_args.update({k: _to_label(k, v) for k, v in kwargs.items()})
- native.java_toolchain(
- name = name,
- **toolchain_args
- )
diff --git a/tools/jdk/java_toolchain_default.bzl.java_tools b/tools/jdk/java_toolchain_default.bzl.java_tools
new file mode 100644
index 0000000..9f3e95e
--- /dev/null
+++ b/tools/jdk/java_toolchain_default.bzl.java_tools
@@ -0,0 +1,181 @@
+# Copyright 2020 The Bazel Authors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Bazel rules for creating Java toolchains."""
+
+_DEFAULT_JAVACOPTS = [
+ "-XDskipDuplicateBridges=true",
+ "-XDcompilePolicy=simple",
+ "-g",
+ "-parameters",
+]
+
+# JVM options, without patching java.compiler and jdk.compiler modules.
+JDK9_JVM_OPTS = [
+ # Allow JavaBuilder to access internal javac APIs.
+ "--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
+ "--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED",
+ "--add-exports=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED",
+ "--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
+ "--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED",
+ "--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED",
+ "--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED",
+ "--add-opens=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
+
+ # quiet warnings from com.google.protobuf.UnsafeUtil,
+ # see: https://github.com/google/protobuf/issues/3781
+ # and: https://github.com/bazelbuild/bazel/issues/5599
+ "--add-opens=java.base/java.nio=ALL-UNNAMED",
+ "--add-opens=java.base/java.lang=ALL-UNNAMED",
+]
+
+# java_toolchain parameters without specifying javac, java.compiler,
+# jdk.compiler module, and jvm_opts
+_BASE_TOOLCHAIN_CONFIGURATION = dict(
+ forcibly_disable_header_compilation = False,
+ genclass = ["//:GenClass"],
+ header_compiler = ["//:TurbineDirect"],
+ header_compiler_direct = ["//:TurbineDirect"],
+ ijar = ["//:ijar"],
+ javabuilder = ["//:JavaBuilder"],
+ javac_supports_workers = True,
+ jacocorunner = "//:jacoco_coverage_runner_filegroup",
+ jvm_opts = JDK9_JVM_OPTS,
+ misc = _DEFAULT_JAVACOPTS,
+ singlejar = ["//:singlejar"],
+ # Code to enumerate target JVM boot classpath uses host JVM. Because
+ # java_runtime-s are involved, its implementation is in @bazel_tools.
+ bootclasspath = ["@bazel_tools//tools/jdk:platformclasspath"],
+ source_version = "8",
+ target_version = "8",
+)
+
+JVM8_TOOLCHAIN_CONFIGURATION = dict(
+ javac = ["//:javac_jar"],
+ jvm_opts = ["-Xbootclasspath/p:$(location //:javac_jar)"],
+)
+
+JAVABUILDER_TOOLCHAIN_CONFIGURATION = dict(
+ javac = ["//:javac_jar"],
+ jvm_opts = [
+ # In JDK9 we have seen a ~30% slow down in JavaBuilder performance when using
+ # G1 collector and having compact strings enabled.
+ "-XX:+UseParallelOldGC",
+ "-XX:-CompactStrings",
+ # override the javac in the JDK.
+ "--patch-module=java.compiler=$(location //:java_compiler_jar)",
+ "--patch-module=jdk.compiler=$(location //:jdk_compiler_jar)",
+ ] + JDK9_JVM_OPTS,
+ tools = [
+ "//:java_compiler_jar",
+ "//:jdk_compiler_jar",
+ ],
+)
+
+# The 'vanilla' toolchain is an unsupported alternative to the default.
+#
+# It does not provide any of the following features:
+# * Error Prone
+# * Strict Java Deps
+# * Header Compilation
+# * Reduced Classpath Optimization
+#
+# It uses the version of internal javac from the `--host_javabase` JDK instead
+# of providing a javac. Internal javac may not be source- or bug-compatible with
+# the javac that is provided with other toolchains.
+#
+# However it does allow using a wider range of `--host_javabase`s, including
+# versions newer than the current JDK.
+VANILLA_TOOLCHAIN_CONFIGURATION = dict(
+ forcibly_disable_header_compilation = True,
+ javabuilder = ["//:VanillaJavaBuilder"],
+ jvm_opts = [],
+)
+
+# The new toolchain is using all the pre-built tools, including
+# singlejar and ijar, even on remote execution. This toolchain
+# should be used only when host and execution platform are the
+# same, otherwise the binaries will not work on the execution
+# platform.
+PREBUILT_TOOLCHAIN_CONFIGURATION = dict(
+ javac = ["//:javac_jar"],
+ jvm_opts = [
+ # In JDK9 we have seen a ~30% slow down in JavaBuilder performance when using
+ # G1 collector and having compact strings enabled.
+ "-XX:+UseParallelOldGC",
+ "-XX:-CompactStrings",
+ # override the javac in the JDK.
+ "--patch-module=java.compiler=$(location //:java_compiler_jar)",
+ "--patch-module=jdk.compiler=$(location //:jdk_compiler_jar)",
+ ] + JDK9_JVM_OPTS,
+ tools = [
+ "//:java_compiler_jar",
+ "//:jdk_compiler_jar",
+ ],
+ ijar = ["//:ijar_prebuilt_binary"],
+ singlejar = ["//:prebuilt_singlejar"],
+)
+
+_LABEL_LISTS = [
+ "bootclasspath",
+ "extclasspath",
+ "javac",
+ "tools",
+ "javabuilder",
+ "singlejar",
+ "genclass",
+ "resourcejar",
+ "ijar",
+ "header_compiler",
+ "header_compiler_direct",
+ "package_configuration",
+]
+
+_LABELS = [
+ "timezone_data",
+ "oneversion",
+ "oneversion_whitelist",
+ "jacocorunner",
+ "proguard_allowlister",
+ "java_runtime",
+]
+
+# Converts values to labels, so that they are resolved relative to this java_tools repository
+def _to_label(k, v):
+ if k in _LABELS and type(v) != type(Label("//a")):
+ return Label(v)
+ if k in _LABEL_LISTS and type(v) == type([Label("//a")]):
+ return [Label(label) if type(label) == type("") else label for label in v]
+ return v
+
+# Makes labels in jvm_opts absolute, that is replaces " //:" with " @repo//:".
+def _format_jvm_opts(toolchain_args, repo):
+ jvm_opts = toolchain_args["jvm_opts"]
+ if [opt for opt in jvm_opts if opt.find(" :") >= 0] != []:
+ fail("Relative labels are not supported in jvm_opts parameter.")
+ jvm_opts = [opt.replace(" //:", " @{repo}//:").format(repo = repo) for opt in jvm_opts]
+ return dict(toolchain_args, jvm_opts = jvm_opts)
+
+def java_toolchain_default(name, configuration = dict(), **kwargs):
+ """Defines a java_toolchain with appropriate defaults for Bazel."""
+
+ toolchain_args = dict(_BASE_TOOLCHAIN_CONFIGURATION)
+ toolchain_args.update(configuration)
+ toolchain_args.update(kwargs)
+ toolchain_args = {k: _to_label(k, v) for k, v in toolchain_args.items()}
+ toolchain_args = _format_jvm_opts(toolchain_args, Label("//x").workspace_name)
+ native.java_toolchain(
+ name = name,
+ **toolchain_args
+ )
