Use target_compatible_with for Java runtimes

cushon · copybara-github · commit d5559c16ac00 · 2022-02-07T13:07:07.000-08:00
The JDK is a runtime. Actions like `java_binary` output an executable that
contains a JDK in its runfiles, and that JDK needs to be compatible with the
target platform. (Actions like `genrule` that execute the JDK can depend
on the JDK as a `tool`, which does an explicit transition to the `exec`
platform.)

PiperOrigin-RevId: 426995073
diff --git a/site/docs/bazel-and-java.md b/site/docs/bazel-and-java.md
@@ -181,7 +181,7 @@ remote_java_repository(
   name = "openjdk_canary_linux_arm",
   prefix = "openjdk_canary", # Can be used with --java_runtime_version=openjdk_canary_11
   version = "11",            # or --java_runtime_version=11
-  exec_compatible_with = [   # Specifies constraints this JVM is compatible with "@platforms//cpu:arm",
+  target_compatible_with = [   # Specifies constraints this JVM is compatible with "@platforms//cpu:arm",
     "@platforms//os:linux",
   ],
   urls = ...,               # Other parameters are from http_repository rule.
diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/jdk.WORKSPACE.tmpl b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/jdk.WORKSPACE.tmpl
@@ -21,7 +21,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk11_linux}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:linux",
         "@platforms//cpu:x86_64",
     ],
@@ -32,7 +32,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk11_linux_aarch64}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:linux",
         "@platforms//cpu:aarch64",
     ],
@@ -43,7 +43,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk11_linux_ppc64le}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:linux",
         "@platforms//cpu:ppc",
     ],
@@ -54,7 +54,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk11_linux_s390x}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:linux",
         "@platforms//cpu:s390x",
     ],
@@ -65,7 +65,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk11_macos}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:macos",
         "@platforms//cpu:x86_64",
     ],
@@ -76,7 +76,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk11_macos_aarch64}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:macos",
         "@platforms//cpu:aarch64",
     ],
@@ -87,7 +87,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk11_win}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:windows",
         "@platforms//cpu:x86_64",
     ],
@@ -98,7 +98,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk17_linux}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:linux",
         "@platforms//cpu:x86_64",
     ],
@@ -109,7 +109,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk17_macos}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:macos",
         "@platforms//cpu:x86_64",
     ],
@@ -120,7 +120,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk17_macos_aarch64}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:macos",
         "@platforms//cpu:aarch64",
     ],
@@ -131,7 +131,7 @@ maybe(
 maybe(
     remote_java_repository,
     {remotejdk17_win}
-    exec_compatible_with = [
+    target_compatible_with = [
         "@platforms//os:windows",
         "@platforms//cpu:x86_64",
     ],
diff --git a/tools/jdk/remote_java_repository.bzl b/tools/jdk/remote_java_repository.bzl
@@ -31,17 +31,17 @@ _toolchain_config = repository_rule(
     },
 )
 
-def remote_java_repository(name, version, exec_compatible_with, prefix = "remotejdk", **kwargs):
+def remote_java_repository(name, version, target_compatible_with = None, prefix = "remotejdk", **kwargs):
     """Imports and registers a JDK from a http archive.
 
-    Toolchain resolution is determined with exec_compatible_with
+    Toolchain resolution is determined with target_compatible_with
     parameter and constrained with --java_runtime_version flag either having value
     of "version" or "{prefix}_{version}" parameters.
 
     Args:
       name: A unique name for this rule.
       version: Version of the JDK imported.
-      exec_compatible_with: Platform constraints (CPU and OS) for this JDK.
+      target_compatible_with: Target platform constraints (CPU and OS) for this JDK.
       prefix: Optional alternative prefix for configuration flag value used to determine this JDK.
       **kwargs: Refer to http_archive documentation
     """
@@ -73,15 +73,15 @@ alias(
 )
 toolchain(
     name = "toolchain",
-    exec_compatible_with = {exec_compatible_with},
+    target_compatible_with = {target_compatible_with},
     target_settings = [":version_or_prefix_version_setting"],
     toolchain_type = "@bazel_tools//tools/jdk:runtime_toolchain_type",
     toolchain = "{toolchain}",
 )
 """.format(
             prefix = prefix,
             version = version,
-            exec_compatible_with = exec_compatible_with,
+            target_compatible_with = target_compatible_with,
             toolchain = "@{repo}//:jdk".format(repo = name),
         ),
     )
