// Copyright 2014 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.Objects; import com.google.devtools.build.lib.actions.ActionAnalysisMetadata; import com.google.devtools.build.lib.analysis.AspectDescriptor; import com.google.devtools.build.lib.analysis.ConfiguredAspect; import com.google.devtools.build.lib.analysis.config.BuildConfiguration; import com.google.devtools.build.lib.cmdline.Label; import com.google.devtools.build.lib.collect.nestedset.NestedSet; import com.google.devtools.build.lib.events.Location; import com.google.devtools.build.lib.packages.Aspect; import com.google.devtools.build.lib.packages.AspectClass; import com.google.devtools.build.lib.packages.AspectParameters; import com.google.devtools.build.lib.packages.Package; import com.google.devtools.build.lib.syntax.SkylarkImport; import com.google.devtools.build.skyframe.SkyFunctionName; import javax.annotation.Nullable; /** * An aspect in the context of the Skyframe graph. */ public final class AspectValue extends ActionLookupValue { /** * A base class for keys that have AspectValue as a Sky value. */ public abstract static class AspectValueKey extends ActionLookupKey { public abstract String getDescription(); } /** * A base class for a key representing an aspect applied to a particular target. */ public static final class AspectKey extends AspectValueKey { private final Label label; private final AspectKey baseKey; private final BuildConfiguration aspectConfiguration; private final BuildConfiguration baseConfiguration; private final AspectClass aspectClass; private final AspectParameters parameters; private AspectKey( Label label, BuildConfiguration aspectConfiguration, BuildConfiguration baseConfiguration, AspectClass aspectClass, AspectParameters parameters) { this.baseKey = null; this.label = label; this.aspectConfiguration = aspectConfiguration; this.baseConfiguration = baseConfiguration; this.aspectClass = aspectClass; this.parameters = parameters; } private AspectKey( AspectKey baseKey, AspectClass aspectClass, AspectParameters aspectParameters, BuildConfiguration aspectConfiguration) { this.baseKey = baseKey; this.label = baseKey.label; this.baseConfiguration = baseKey.getBaseConfiguration(); this.aspectConfiguration = aspectConfiguration; this.aspectClass = aspectClass; this.parameters = aspectParameters; } @Override SkyFunctionName getType() { return SkyFunctions.ASPECT; } @Override public Label getLabel() { return label; } public AspectClass getAspectClass() { return aspectClass; } @Nullable public AspectParameters getParameters() { return parameters; } @Nullable public AspectKey getBaseKey() { return baseKey; } @Override public String getDescription() { if (baseKey == null) { return String.format("%s of %s", aspectClass.getName(), getLabel()); } else { return String.format("%s on top of %s", aspectClass.getName(), baseKey.toString()); } } /** * Returns the configuration to be used for the evaluation of the aspect itself. * *
In dynamic 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. * *
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. * *
Because of these properties, this configuration is always a superset of that returned by * {@link #getBaseConfiguration()}. In static configuration mode, this configuration will be * equivalent to that returned by {@link #getBaseConfiguration()}. * * @see #getBaseConfiguration() */ public BuildConfiguration getAspectConfiguration() { return aspectConfiguration; } /** * Returns the configuration to be used for the base target. * *
In dynamic configuration mode, the configured target this aspect is attached to may have
* a different configuration than the aspect itself (see the documentation for
* {@link #getAspectConfiguration()} for an explanation why). The base configuration is the one
* used to construct a key to look up the base configured target.
*
* @see #getAspectConfiguration()
*/
public BuildConfiguration getBaseConfiguration() {
return baseConfiguration;
}
@Override
public int hashCode() {
return Objects.hashCode(
label,
baseKey,
aspectConfiguration,
baseConfiguration,
aspectClass,
parameters);
}
@Override
public boolean equals(Object other) {
if (this == other) {
return true;
}
if (!(other instanceof AspectKey)) {
return false;
}
AspectKey that = (AspectKey) other;
return Objects.equal(label, that.label)
&& Objects.equal(baseKey, that.baseKey)
&& Objects.equal(aspectConfiguration, that.aspectConfiguration)
&& Objects.equal(baseConfiguration, that.baseConfiguration)
&& Objects.equal(aspectClass, that.aspectClass)
&& Objects.equal(parameters, that.parameters);
}
public String prettyPrint() {
if (label == null) {
return "null";
}
return String.format("%s with aspect %s%s",
baseKey == null ? label.toString() : baseKey.prettyPrint(),
aspectClass.getName(),
(aspectConfiguration != null && aspectConfiguration.isHostConfiguration())
? "(host) " : "");
}
@Override
public String toString() {
return (baseKey == null ? label : baseKey.toString())
+ "#"
+ aspectClass.getName()
+ " "
+ (aspectConfiguration == null ? "null" : aspectConfiguration.checksum())
+ " "
+ (baseConfiguration == null ? "null" : baseConfiguration.checksum())
+ " "
+ parameters;
}
public AspectKey withLabel(Label label) {
if (baseKey == null) {
return new AspectKey(
label, aspectConfiguration, baseConfiguration, aspectClass, parameters);
} else {
return new AspectKey(
baseKey.withLabel(label), aspectClass, parameters, aspectConfiguration);
}
}
}
/**
* The key for a skylark aspect.
*/
public static class SkylarkAspectLoadingKey extends AspectValueKey {
private final Label targetLabel;
private final BuildConfiguration aspectConfiguration;
private final BuildConfiguration targetConfiguration;
private final SkylarkImport skylarkImport;
private final String skylarkValueName;
private SkylarkAspectLoadingKey(
Label targetLabel,
BuildConfiguration aspectConfiguration,
BuildConfiguration targetConfiguration,
SkylarkImport skylarkImport,
String skylarkFunctionName) {
this.targetLabel = targetLabel;
this.aspectConfiguration = aspectConfiguration;
this.targetConfiguration = targetConfiguration;
this.skylarkImport = skylarkImport;
this.skylarkValueName = skylarkFunctionName;
}
@Override
SkyFunctionName getType() {
return SkyFunctions.LOAD_SKYLARK_ASPECT;
}
public Label getTargetLabel() {
return targetLabel;
}
public String getSkylarkValueName() {
return skylarkValueName;
}
public SkylarkImport getSkylarkImport() {
return skylarkImport;
}
/**
* @see AspectKey#getAspectConfiguration()
*/
public BuildConfiguration getAspectConfiguration() {
return aspectConfiguration;
}
/**
* @see AspectKey#getBaseConfiguration()
*/
public BuildConfiguration getTargetConfiguration() {
return targetConfiguration;
}
@Override
public String getDescription() {
// Skylark aspects are referred to on command line with