blob: 7343e6bf43364b7af147782938ab8ac384094378 [file] [log] [blame]
// 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.analysis;
import static com.google.devtools.build.lib.analysis.ExtraActionUtils.createExtraActionProvider;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.actions.ActionAnalysisMetadata;
import com.google.devtools.build.lib.actions.Actions;
import com.google.devtools.build.lib.actions.Actions.GeneratingActions;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.MutableActionGraph.ActionConflictException;
import com.google.devtools.build.lib.analysis.config.CoreOptions;
import com.google.devtools.build.lib.analysis.starlark.StarlarkApiProvider;
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.Info;
import com.google.devtools.build.lib.packages.Provider;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import java.util.Arrays;
import java.util.Map;
import java.util.TreeMap;
import javax.annotation.Nullable;
import net.starlark.java.eval.EvalException;
import net.starlark.java.eval.Starlark;
/**
* Extra information about a configured target computed on request of a dependent.
*
* <p>Analogous to {@link ConfiguredTarget}: contains a bunch of transitive info providers, which
* are merged with the providers of the associated configured target before they are passed to the
* configured target factories that depend on the configured target to which this aspect is added.
*
* <p>Aspects are created alongside configured targets on request from dependents.
*
* <p>For more information about aspects, see {@link
* com.google.devtools.build.lib.packages.AspectClass}.
*
* @see com.google.devtools.build.lib.analysis.RuleConfiguredTargetFactory
* @see com.google.devtools.build.lib.packages.AspectClass
*/
@Immutable
public final class ConfiguredAspect implements ProviderCollection {
private final ImmutableList<ActionAnalysisMetadata> actions;
private final TransitiveInfoProviderMap providers;
private ConfiguredAspect(
ImmutableList<ActionAnalysisMetadata> actions, TransitiveInfoProviderMap providers) {
this.actions = actions;
this.providers = providers;
// Initialize every StarlarkApiProvider
for (int i = 0; i < providers.getProviderCount(); i++) {
Object obj = providers.getProviderInstanceAt(i);
if (obj instanceof StarlarkApiProvider) {
((StarlarkApiProvider) obj).init(providers);
}
}
}
public ImmutableList<ActionAnalysisMetadata> getActions() {
return actions;
}
/** Returns the providers created by the aspect. */
public TransitiveInfoProviderMap getProviders() {
return providers;
}
@Override
@Nullable
public <P extends TransitiveInfoProvider> P getProvider(Class<P> providerClass) {
AnalysisUtils.checkProvider(providerClass);
return providers.getProvider(providerClass);
}
@Override
public Info get(Provider.Key key) {
return providers.get(key);
}
@Override
public Object get(String legacyKey) {
if (OutputGroupInfo.STARLARK_NAME.equals(legacyKey)) {
return get(OutputGroupInfo.STARLARK_CONSTRUCTOR.getKey());
}
return providers.get(legacyKey);
}
public static ConfiguredAspect forAlias(ConfiguredAspect real) {
return new ConfiguredAspect(real.actions, real.providers);
}
public static ConfiguredAspect forNonapplicableTarget() {
return new ConfiguredAspect(
ImmutableList.of(),
new TransitiveInfoProviderMapBuilder().add().build());
}
public static Builder builder(RuleContext ruleContext) {
return new Builder(ruleContext);
}
/**
* Builder for {@link ConfiguredAspect}.
*/
public static class Builder {
private final TransitiveInfoProviderMapBuilder providers =
new TransitiveInfoProviderMapBuilder();
private final Map<String, NestedSetBuilder<Artifact>> outputGroupBuilders = new TreeMap<>();
private final RuleContext ruleContext;
public Builder(RuleContext ruleContext) {
this.ruleContext = ruleContext;
}
@CanIgnoreReturnValue
public <T extends TransitiveInfoProvider> Builder addProvider(
Class<? extends T> providerClass, T provider) {
Preconditions.checkNotNull(provider);
checkProviderClass(providerClass);
providers.put(providerClass, provider);
return this;
}
/** Adds a provider to the aspect. */
@CanIgnoreReturnValue
public Builder addProvider(TransitiveInfoProvider provider) {
Preconditions.checkNotNull(provider);
addProvider(TransitiveInfoProviderEffectiveClassHelper.get(provider), provider);
return this;
}
private static void checkProviderClass(Class<? extends TransitiveInfoProvider> providerClass) {
Preconditions.checkNotNull(providerClass);
}
/** Adds providers to the aspect. */
@CanIgnoreReturnValue
public Builder addProviders(TransitiveInfoProviderMap providers) {
this.providers.addAll(providers);
return this;
}
/** Adds providers to the aspect. */
public Builder addProviders(TransitiveInfoProvider... providers) {
return addProviders(Arrays.asList(providers));
}
/** Adds providers to the aspect. */
@CanIgnoreReturnValue
public Builder addProviders(Iterable<TransitiveInfoProvider> providers) {
for (TransitiveInfoProvider provider : providers) {
addProvider(provider);
}
return this;
}
/** Adds a set of files to an output group. */
@CanIgnoreReturnValue
public Builder addOutputGroup(String name, NestedSet<Artifact> artifacts) {
outputGroupBuilders
.computeIfAbsent(name, k -> NestedSetBuilder.stableOrder())
.addTransitive(artifacts);
return this;
}
@CanIgnoreReturnValue
public Builder addStarlarkTransitiveInfo(String name, Object value) {
providers.put(name, value);
return this;
}
@CanIgnoreReturnValue
public Builder addStarlarkDeclaredProvider(Info declaredProvider) throws EvalException {
Provider constructor = declaredProvider.getProvider();
if (!constructor.isExported()) {
throw Starlark.errorf(
"aspect function returned an instance of a provider (defined at %s) that is not a"
+ " global",
constructor.getLocation());
}
addDeclaredProvider(declaredProvider);
return this;
}
private void addDeclaredProvider(Info declaredProvider) {
providers.put(declaredProvider);
}
@CanIgnoreReturnValue
public Builder addNativeDeclaredProvider(Info declaredProvider) {
Provider constructor = declaredProvider.getProvider();
Preconditions.checkState(constructor.isExported());
addDeclaredProvider(declaredProvider);
return this;
}
@Nullable
public ConfiguredAspect build() throws ActionConflictException, InterruptedException {
if (!outputGroupBuilders.isEmpty()) {
ImmutableMap.Builder<String, NestedSet<Artifact>> outputGroups = ImmutableMap.builder();
for (Map.Entry<String, NestedSetBuilder<Artifact>> entry : outputGroupBuilders.entrySet()) {
outputGroups.put(entry.getKey(), entry.getValue().build());
}
if (providers.contains(OutputGroupInfo.STARLARK_CONSTRUCTOR.getKey())) {
throw new IllegalStateException(
"OutputGroupInfo was provided explicitly; do not use addOutputGroup");
}
addDeclaredProvider(new OutputGroupInfo(outputGroups.buildOrThrow()));
}
addProvider(
createExtraActionProvider(/*actionsWithoutExtraAction=*/ ImmutableSet.of(), ruleContext));
AnalysisEnvironment analysisEnvironment = ruleContext.getAnalysisEnvironment();
GeneratingActions generatingActions;
try {
generatingActions =
Actions.assignOwnersAndFilterSharedActionsAndThrowActionConflict(
analysisEnvironment.getActionKeyContext(),
analysisEnvironment.getRegisteredActions(),
ruleContext.getOwner(),
/*outputFiles=*/ null);
} catch (Actions.ArtifactGeneratedByOtherRuleException e) {
ruleContext.ruleError(e.getMessage());
return null;
}
maybeAddRequiredConfigFragmentsProvider();
return new ConfiguredAspect(generatingActions.getActions(), providers.build());
}
/**
* Adds {@link RequiredConfigFragmentsProvider} if {@link
* CoreOptions#includeRequiredConfigFragmentsProvider} isn't {@link
* CoreOptions.IncludeConfigFragmentsEnum#OFF}.
*
* <p>See {@link com.google.devtools.build.lib.analysis.config.RequiredFragmentsUtil} for a
* description of the meaning of this provider's content. That class contains methods that
* populate the results of {@link RuleContext#getRequiredConfigFragments}.
*/
private void maybeAddRequiredConfigFragmentsProvider() {
if (ruleContext.shouldIncludeRequiredConfigFragmentsProvider()) {
addProvider(ruleContext.getRequiredConfigFragments());
}
}
}
}