| // Copyright 2017 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. |
| |
| package com.google.devtools.build.lib.rules.java; |
| |
| import static com.google.devtools.build.lib.packages.BuildType.LABEL; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.devtools.build.lib.actions.Artifact; |
| import com.google.devtools.build.lib.analysis.RuleContext; |
| import com.google.devtools.build.lib.analysis.TransitiveInfoCollection; |
| import com.google.devtools.build.lib.analysis.platform.ToolchainInfo; |
| import com.google.devtools.build.lib.collect.nestedset.Depset; |
| import com.google.devtools.build.lib.collect.nestedset.NestedSet; |
| import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder; |
| import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable; |
| import com.google.devtools.build.lib.packages.BuiltinProvider; |
| import com.google.devtools.build.lib.packages.NativeInfo; |
| import com.google.devtools.build.lib.rules.cpp.CcInfo; |
| import com.google.devtools.build.lib.rules.cpp.LibraryToLink; |
| import com.google.devtools.build.lib.starlarkbuildapi.java.JavaRuntimeInfoApi; |
| import com.google.devtools.build.lib.vfs.PathFragment; |
| import javax.annotation.Nullable; |
| import net.starlark.java.eval.EvalException; |
| import net.starlark.java.eval.Sequence; |
| import net.starlark.java.eval.StarlarkList; |
| |
| /** Information about the Java runtime used by the <code>java_*</code> rules. */ |
| @Immutable |
| public final class JavaRuntimeInfo extends NativeInfo implements JavaRuntimeInfoApi { |
| |
| public static final BuiltinProvider<JavaRuntimeInfo> PROVIDER = |
| new BuiltinProvider<JavaRuntimeInfo>("JavaRuntimeInfo", JavaRuntimeInfo.class) {}; |
| |
| public static JavaRuntimeInfo create( |
| NestedSet<Artifact> javaBaseInputs, |
| PathFragment javaHome, |
| PathFragment javaBinaryExecPath, |
| PathFragment javaHomeRunfilesPath, |
| PathFragment javaBinaryRunfilesPath, |
| NestedSet<Artifact> hermeticInputs, |
| @Nullable Artifact libModules, |
| ImmutableList<CcInfo> hermeticStaticLibs) { |
| return new JavaRuntimeInfo( |
| javaBaseInputs, |
| javaHome, |
| javaBinaryExecPath, |
| javaHomeRunfilesPath, |
| javaBinaryRunfilesPath, |
| hermeticInputs, |
| libModules, |
| hermeticStaticLibs); |
| } |
| |
| @Override |
| public boolean isImmutable() { |
| return true; // immutable and Starlark-hashable |
| } |
| |
| // Helper methods to access an instance of JavaRuntimeInfo. |
| |
| public static JavaRuntimeInfo forHost(RuleContext ruleContext) { |
| return JavaToolchainProvider.from(ruleContext).getJavaRuntime(); |
| } |
| |
| public static JavaRuntimeInfo from(RuleContext ruleContext) { |
| ToolchainInfo toolchainInfo = |
| ruleContext |
| .getToolchainContext() |
| .forToolchainType( |
| ruleContext |
| .getPrerequisite(JavaRuleClasses.JAVA_RUNTIME_TOOLCHAIN_TYPE_ATTRIBUTE_NAME) |
| .getLabel()); |
| return from(ruleContext, toolchainInfo); |
| } |
| |
| @Nullable |
| public static JavaRuntimeInfo from(RuleContext ruleContext, String attributeName) { |
| if (!ruleContext.attributes().has(attributeName, LABEL)) { |
| return null; |
| } |
| TransitiveInfoCollection prerequisite = ruleContext.getPrerequisite(attributeName); |
| if (prerequisite == null) { |
| return null; |
| } |
| |
| ToolchainInfo toolchainInfo = prerequisite.get(ToolchainInfo.PROVIDER); |
| return from(ruleContext, toolchainInfo); |
| } |
| |
| @Nullable |
| private static JavaRuntimeInfo from(RuleContext ruleContext, ToolchainInfo toolchainInfo) { |
| if (toolchainInfo != null) { |
| try { |
| JavaRuntimeInfo result = (JavaRuntimeInfo) toolchainInfo.getValue("java_runtime"); |
| if (result != null) { |
| return result; |
| } |
| } catch (EvalException e) { |
| ruleContext.ruleError(String.format("There was an error reading the Java runtime: %s", e)); |
| return null; |
| } |
| } |
| ruleContext.ruleError("The selected Java runtime is not a JavaRuntimeInfo"); |
| return null; |
| } |
| |
| private final NestedSet<Artifact> javaBaseInputs; |
| private final PathFragment javaHome; |
| private final PathFragment javaBinaryExecPath; |
| private final PathFragment javaHomeRunfilesPath; |
| private final PathFragment javaBinaryRunfilesPath; |
| private final NestedSet<Artifact> hermeticInputs; |
| @Nullable private final Artifact libModules; |
| private final ImmutableList<CcInfo> hermeticStaticLibs; |
| |
| private JavaRuntimeInfo( |
| NestedSet<Artifact> javaBaseInputs, |
| PathFragment javaHome, |
| PathFragment javaBinaryExecPath, |
| PathFragment javaHomeRunfilesPath, |
| PathFragment javaBinaryRunfilesPath, |
| NestedSet<Artifact> hermeticInputs, |
| @Nullable Artifact libModules, |
| ImmutableList<CcInfo> hermeticStaticLibs) { |
| this.javaBaseInputs = javaBaseInputs; |
| this.javaHome = javaHome; |
| this.javaBinaryExecPath = javaBinaryExecPath; |
| this.javaHomeRunfilesPath = javaHomeRunfilesPath; |
| this.javaBinaryRunfilesPath = javaBinaryRunfilesPath; |
| this.hermeticInputs = hermeticInputs; |
| this.libModules = libModules; |
| this.hermeticStaticLibs = hermeticStaticLibs; |
| } |
| |
| /** All input artifacts in the javabase. */ |
| public NestedSet<Artifact> javaBaseInputs() { |
| return javaBaseInputs; |
| } |
| |
| /** The root directory of the Java installation. */ |
| @Override |
| public String javaHome() { |
| return javaHome.toString(); |
| } |
| |
| public PathFragment javaHomePathFragment() { |
| return javaHome; |
| } |
| |
| /** The execpath of the Java binary. */ |
| @Override |
| public String javaBinaryExecPath() { |
| return javaBinaryExecPath.toString(); |
| } |
| |
| public PathFragment javaBinaryExecPathFragment() { |
| return javaBinaryExecPath; |
| } |
| |
| /** The runfiles path of the root directory of the Java installation. */ |
| @Override |
| public String javaHomeRunfilesPath() { |
| return javaHomeRunfilesPath.toString(); |
| } |
| |
| /** The runfiles path of the Java binary. */ |
| @Override |
| public String javaBinaryRunfilesPath() { |
| return javaBinaryRunfilesPath.toString(); |
| } |
| |
| public PathFragment javaBinaryRunfilesPathFragment() { |
| return javaBinaryRunfilesPath; |
| } |
| |
| /** Input artifacts required for hermetic deployments. */ |
| public NestedSet<Artifact> hermeticInputs() { |
| return hermeticInputs; |
| } |
| |
| @Override |
| public Depset starlarkHermeticInputs() { |
| return Depset.of(Artifact.TYPE, hermeticInputs()); |
| } |
| |
| @Override |
| @Nullable |
| public Artifact libModules() { |
| return libModules; |
| } |
| |
| public ImmutableList<CcInfo> hermeticStaticLibs() { |
| return hermeticStaticLibs; |
| } |
| |
| public NestedSet<LibraryToLink> collectHermeticStaticLibrariesToLink() { |
| NestedSetBuilder<LibraryToLink> result = NestedSetBuilder.stableOrder(); |
| for (CcInfo lib : hermeticStaticLibs()) { |
| result.addTransitive(lib.getCcLinkingContext().getLibraries()); |
| } |
| return result.build(); |
| } |
| |
| @Override |
| public Sequence<CcInfo> starlarkHermeticStaticLibs() { |
| return StarlarkList.immutableCopyOf(hermeticStaticLibs()); |
| } |
| |
| @Override |
| public Depset starlarkJavaBaseInputs() { |
| return Depset.of(Artifact.TYPE, javaBaseInputs()); |
| } |
| |
| @Override |
| public com.google.devtools.build.lib.packages.Provider getProvider() { |
| return PROVIDER; |
| } |
| |
| // Not all of JavaRuntimeInfo is exposed to Starlark, which makes implementing deep equality |
| // impossible: if Java-only parts are considered, the behavior is surprising in Starlark, if they |
| // are not, the behavior is surprising in Java. Thus, object identity it is. |
| @Override |
| public boolean equals(Object other) { |
| return other == this; |
| } |
| |
| @Override |
| public int hashCode() { |
| return System.identityHashCode(this); |
| } |
| } |