| // 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. | |
| package com.google.devtools.build.lib.skyframe; | |
| import com.google.common.base.MoreObjects; | |
| import com.google.common.base.Objects; | |
| import com.google.common.collect.ImmutableList; | |
| import com.google.common.collect.ImmutableSet; | |
| import com.google.common.collect.Interner; | |
| import com.google.devtools.build.lib.actions.ActionLookupKey; | |
| import com.google.devtools.build.lib.analysis.config.BuildConfiguration; | |
| import com.google.devtools.build.lib.cmdline.Label; | |
| import com.google.devtools.build.lib.concurrent.BlazeInterners; | |
| import com.google.devtools.build.lib.packages.AspectClass; | |
| import com.google.devtools.build.lib.packages.AspectDescriptor; | |
| import com.google.devtools.build.lib.packages.AspectParameters; | |
| import com.google.devtools.build.lib.packages.RequiredProviders; | |
| import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec; | |
| import com.google.devtools.build.skyframe.SkyFunctionName; | |
| import javax.annotation.Nullable; | |
| /** A base class for keys that have AspectValue as a Sky value. */ | |
| public abstract class AspectValueKey implements ActionLookupKey { | |
| private static final Interner<AspectKey> aspectKeyInterner = BlazeInterners.newWeakInterner(); | |
| private static final Interner<StarlarkAspectLoadingKey> starlarkAspectKeyInterner = | |
| BlazeInterners.newWeakInterner(); | |
| /** | |
| * Gets the name of the aspect that would be returned by the corresponding value's {@code | |
| * aspectValue.getAspect().getAspectClass().getName()}, if the value could be produced. | |
| * | |
| * <p>Only needed for reporting errors in BEP when the key's AspectValue fails evaluation. | |
| */ | |
| public abstract String getAspectName(); | |
| public abstract String getDescription(); | |
| @Nullable | |
| abstract BuildConfigurationValue.Key getAspectConfigurationKey(); | |
| /** Returns the key for the base configured target for this aspect. */ | |
| public abstract ConfiguredTargetKey getBaseConfiguredTargetKey(); | |
| public static AspectKey createAspectKey( | |
| Label label, | |
| @Nullable BuildConfiguration baseConfiguration, | |
| ImmutableList<AspectKey> baseKeys, | |
| AspectDescriptor aspectDescriptor, | |
| @Nullable BuildConfiguration aspectConfiguration) { | |
| return AspectKey.createAspectKey( | |
| ConfiguredTargetKey.builder().setLabel(label).setConfiguration(baseConfiguration).build(), | |
| baseKeys, | |
| aspectDescriptor, | |
| aspectConfiguration == null ? null : BuildConfigurationValue.key(aspectConfiguration)); | |
| } | |
| public static AspectKey createAspectKey( | |
| AspectDescriptor aspectDescriptor, | |
| ImmutableList<AspectKey> baseKeys, | |
| BuildConfigurationValue.Key aspectConfigurationKey, | |
| ConfiguredTargetKey baseConfiguredTargetKey) { | |
| return AspectKey.createAspectKey( | |
| baseConfiguredTargetKey, baseKeys, aspectDescriptor, aspectConfigurationKey); | |
| } | |
| public static AspectKey createAspectKey( | |
| Label label, | |
| @Nullable BuildConfiguration baseConfiguration, | |
| AspectDescriptor aspectDescriptor, | |
| @Nullable BuildConfiguration aspectConfiguration) { | |
| return AspectKey.createAspectKey( | |
| ConfiguredTargetKey.builder().setLabel(label).setConfiguration(baseConfiguration).build(), | |
| ImmutableList.of(), | |
| aspectDescriptor, | |
| aspectConfiguration == null ? null : BuildConfigurationValue.key(aspectConfiguration)); | |
| } | |
| public static StarlarkAspectLoadingKey createStarlarkAspectKey( | |
| Label targetLabel, | |
| @Nullable BuildConfiguration aspectConfiguration, | |
| @Nullable BuildConfiguration targetConfiguration, | |
| Label starlarkFileLabel, | |
| String starlarkExportName) { | |
| return StarlarkAspectLoadingKey.createInternal( | |
| targetLabel, | |
| aspectConfiguration == null ? null : BuildConfigurationValue.key(aspectConfiguration), | |
| ConfiguredTargetKey.builder() | |
| .setLabel(targetLabel) | |
| .setConfiguration(targetConfiguration) | |
| .build(), | |
| starlarkFileLabel, | |
| starlarkExportName); | |
| } | |
| // Specific subtypes of aspect keys. | |
| /** Represents an aspect applied to a particular target. */ | |
| @AutoCodec | |
| public static final class AspectKey extends AspectValueKey { | |
| private final ConfiguredTargetKey baseConfiguredTargetKey; | |
| private final ImmutableList<AspectKey> baseKeys; | |
| @Nullable private final BuildConfigurationValue.Key aspectConfigurationKey; | |
| private final AspectDescriptor aspectDescriptor; | |
| private final int hashCode; | |
| private AspectKey( | |
| ConfiguredTargetKey baseConfiguredTargetKey, | |
| ImmutableList<AspectKey> baseKeys, | |
| AspectDescriptor aspectDescriptor, | |
| @Nullable BuildConfigurationValue.Key aspectConfigurationKey, | |
| int hashCode) { | |
| this.baseKeys = baseKeys; | |
| this.aspectConfigurationKey = aspectConfigurationKey; | |
| this.baseConfiguredTargetKey = baseConfiguredTargetKey; | |
| this.aspectDescriptor = aspectDescriptor; | |
| this.hashCode = hashCode; | |
| } | |
| @AutoCodec.VisibleForSerialization | |
| @AutoCodec.Instantiator | |
| static AspectKey createAspectKey( | |
| ConfiguredTargetKey baseConfiguredTargetKey, | |
| ImmutableList<AspectKey> baseKeys, | |
| AspectDescriptor aspectDescriptor, | |
| @Nullable BuildConfigurationValue.Key aspectConfigurationKey) { | |
| return aspectKeyInterner.intern( | |
| new AspectKey( | |
| baseConfiguredTargetKey, | |
| baseKeys, | |
| aspectDescriptor, | |
| aspectConfigurationKey, | |
| Objects.hashCode( | |
| baseConfiguredTargetKey, baseKeys, aspectDescriptor, aspectConfigurationKey))); | |
| } | |
| @Override | |
| public SkyFunctionName functionName() { | |
| return SkyFunctions.ASPECT; | |
| } | |
| @Override | |
| public String getAspectName() { | |
| return aspectDescriptor.getDescription(); | |
| } | |
| @Override | |
| public Label getLabel() { | |
| return baseConfiguredTargetKey.getLabel(); | |
| } | |
| public AspectClass getAspectClass() { | |
| return aspectDescriptor.getAspectClass(); | |
| } | |
| @Nullable | |
| public AspectParameters getParameters() { | |
| return aspectDescriptor.getParameters(); | |
| } | |
| public RequiredProviders getInheritedRequiredProviders() { | |
| return aspectDescriptor.getInheritedRequiredProviders(); | |
| } | |
| @Nullable | |
| public ImmutableSet<String> getInheritedAttributeAspects() { | |
| return aspectDescriptor.getInheritedAttributeAspects(); | |
| } | |
| public AspectDescriptor getAspectDescriptor() { | |
| return aspectDescriptor; | |
| } | |
| @Nullable | |
| ImmutableList<AspectKey> getBaseKeys() { | |
| return baseKeys; | |
| } | |
| @Override | |
| public String getDescription() { | |
| if (baseKeys.isEmpty()) { | |
| return String.format("%s of %s", aspectDescriptor.getAspectClass().getName(), getLabel()); | |
| } else { | |
| return String.format( | |
| "%s on top of %s", aspectDescriptor.getAspectClass().getName(), baseKeys); | |
| } | |
| } | |
| /** | |
| * Returns the key of the configured target of the aspect; that is, the configuration in which | |
| * the aspect will be evaluated. | |
| * | |
| * <p>In trimmed configuration mode, the aspect may require more fragments than the target on | |
| * which it is being evaluated; in addition to configuration fragments required by the target | |
| * and its dependencies, an aspect has configuration fragment requirements of its own, as well | |
| * as dependencies of its own with their own configuration fragment requirements. | |
| * | |
| * <p>The aspect configuration contains all of these fragments, and is used to create the | |
| * aspect's RuleContext and to retrieve the dependencies. Note that dependencies will have their | |
| * configurations trimmed from this one as normal. | |
| * | |
| * <p>Because of these properties, this configuration is always a superset of the base target's | |
| * configuration. In untrimmed configuration mode, this configuration will be equivalent to the | |
| * base target's configuration. | |
| */ | |
| @Nullable | |
| @Override | |
| BuildConfigurationValue.Key getAspectConfigurationKey() { | |
| return aspectConfigurationKey; | |
| } | |
| /** Returns the key for the base configured target for this aspect. */ | |
| @Override | |
| public ConfiguredTargetKey getBaseConfiguredTargetKey() { | |
| return baseConfiguredTargetKey; | |
| } | |
| @Override | |
| public int hashCode() { | |
| return hashCode; | |
| } | |
| @Override | |
| public boolean equals(Object other) { | |
| if (this == other) { | |
| return true; | |
| } | |
| if (!(other instanceof AspectKey)) { | |
| return false; | |
| } | |
| AspectKey that = (AspectKey) other; | |
| return hashCode == that.hashCode | |
| && Objects.equal(baseKeys, that.baseKeys) | |
| && Objects.equal(aspectConfigurationKey, that.aspectConfigurationKey) | |
| && Objects.equal(baseConfiguredTargetKey, that.baseConfiguredTargetKey) | |
| && Objects.equal(aspectDescriptor, that.aspectDescriptor); | |
| } | |
| public String prettyPrint() { | |
| if (getLabel() == null) { | |
| return "null"; | |
| } | |
| String baseKeysString = baseKeys.isEmpty() ? "" : String.format(" (over %s)", baseKeys); | |
| return String.format( | |
| "%s with aspect %s%s", | |
| getLabel(), aspectDescriptor.getAspectClass().getName(), baseKeysString); | |
| } | |
| @Override | |
| public String toString() { | |
| return (baseKeys == null ? getLabel() : baseKeys.toString()) | |
| + "#" | |
| + aspectDescriptor | |
| + " " | |
| + aspectConfigurationKey | |
| + " " | |
| + baseConfiguredTargetKey | |
| + " " | |
| + aspectDescriptor.getParameters(); | |
| } | |
| AspectKey withLabel(Label label) { | |
| ImmutableList.Builder<AspectKey> newBaseKeys = ImmutableList.builder(); | |
| for (AspectKey baseKey : baseKeys) { | |
| newBaseKeys.add(baseKey.withLabel(label)); | |
| } | |
| return createAspectKey( | |
| ConfiguredTargetKey.builder() | |
| .setLabel(label) | |
| .setConfigurationKey(baseConfiguredTargetKey.getConfigurationKey()) | |
| .build(), | |
| newBaseKeys.build(), | |
| aspectDescriptor, | |
| aspectConfigurationKey); | |
| } | |
| } | |
| /** The key for a Starlark aspect. */ | |
| @AutoCodec | |
| public static final class StarlarkAspectLoadingKey extends AspectValueKey { | |
| private final Label targetLabel; | |
| private final BuildConfigurationValue.Key aspectConfigurationKey; | |
| private final ConfiguredTargetKey baseConfiguredTargetKey; | |
| private final Label starlarkFileLabel; | |
| private final String starlarkValueName; | |
| private final int hashCode; | |
| @AutoCodec.Instantiator | |
| @AutoCodec.VisibleForSerialization | |
| static StarlarkAspectLoadingKey createInternal( | |
| Label targetLabel, | |
| BuildConfigurationValue.Key aspectConfigurationKey, | |
| ConfiguredTargetKey baseConfiguredTargetKey, | |
| Label starlarkFileLabel, | |
| String starlarkValueName) { | |
| return starlarkAspectKeyInterner.intern( | |
| new StarlarkAspectLoadingKey( | |
| targetLabel, | |
| aspectConfigurationKey, | |
| baseConfiguredTargetKey, | |
| starlarkFileLabel, | |
| starlarkValueName, | |
| Objects.hashCode( | |
| targetLabel, | |
| aspectConfigurationKey, | |
| baseConfiguredTargetKey, | |
| starlarkFileLabel, | |
| starlarkValueName))); | |
| } | |
| private StarlarkAspectLoadingKey( | |
| Label targetLabel, | |
| BuildConfigurationValue.Key aspectConfigurationKey, | |
| ConfiguredTargetKey baseConfiguredTargetKey, | |
| Label starlarkFileLabel, | |
| String starlarkValueName, | |
| int hashCode) { | |
| this.targetLabel = targetLabel; | |
| this.aspectConfigurationKey = aspectConfigurationKey; | |
| this.baseConfiguredTargetKey = baseConfiguredTargetKey; | |
| this.starlarkFileLabel = starlarkFileLabel; | |
| this.starlarkValueName = starlarkValueName; | |
| this.hashCode = hashCode; | |
| } | |
| @Override | |
| public SkyFunctionName functionName() { | |
| return SkyFunctions.LOAD_STARLARK_ASPECT; | |
| } | |
| String getStarlarkValueName() { | |
| return starlarkValueName; | |
| } | |
| Label getStarlarkFileLabel() { | |
| return starlarkFileLabel; | |
| } | |
| @Override | |
| public String getAspectName() { | |
| return String.format("%s%%%s", starlarkFileLabel, starlarkValueName); | |
| } | |
| @Override | |
| public Label getLabel() { | |
| return targetLabel; | |
| } | |
| @Override | |
| public String getDescription() { | |
| // Starlark aspects are referred to on command line with <file>%<value ame> | |
| return String.format("%s%%%s of %s", starlarkFileLabel, starlarkValueName, targetLabel); | |
| } | |
| @Nullable | |
| @Override | |
| BuildConfigurationValue.Key getAspectConfigurationKey() { | |
| return aspectConfigurationKey; | |
| } | |
| /** Returns the key for the base configured target for this aspect. */ | |
| @Override | |
| public ConfiguredTargetKey getBaseConfiguredTargetKey() { | |
| return baseConfiguredTargetKey; | |
| } | |
| @Override | |
| public int hashCode() { | |
| return hashCode; | |
| } | |
| @Override | |
| public boolean equals(Object o) { | |
| if (o == this) { | |
| return true; | |
| } | |
| if (!(o instanceof StarlarkAspectLoadingKey)) { | |
| return false; | |
| } | |
| StarlarkAspectLoadingKey that = (StarlarkAspectLoadingKey) o; | |
| return hashCode == that.hashCode | |
| && Objects.equal(targetLabel, that.targetLabel) | |
| && Objects.equal(aspectConfigurationKey, that.aspectConfigurationKey) | |
| && Objects.equal(baseConfiguredTargetKey, that.baseConfiguredTargetKey) | |
| && Objects.equal(starlarkFileLabel, that.starlarkFileLabel) | |
| && Objects.equal(starlarkValueName, that.starlarkValueName); | |
| } | |
| @Override | |
| public String toString() { | |
| return MoreObjects.toStringHelper(this) | |
| .add("targetLabel", targetLabel) | |
| .add("aspectConfigurationKey", aspectConfigurationKey) | |
| .add("baseConfiguredTargetKey", baseConfiguredTargetKey) | |
| .add("starlarkFileLabel", starlarkFileLabel) | |
| .add("starlarkValueName", starlarkValueName) | |
| .toString(); | |
| } | |
| AspectKey toAspectKey(AspectClass aspectClass) { | |
| return AspectKey.createAspectKey( | |
| baseConfiguredTargetKey, | |
| ImmutableList.of(), | |
| new AspectDescriptor(aspectClass, AspectParameters.EMPTY), | |
| aspectConfigurationKey); | |
| } | |
| } | |
| } |