// 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 com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.common.collect.Multimap;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.config.BuildConfigurationCollection;
import com.google.devtools.build.lib.analysis.config.ConfigurationResolver;
import com.google.devtools.build.lib.analysis.config.TransitionResolver;
import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget.Mode;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.events.ExtendedEventHandler;
import com.google.devtools.build.lib.packages.BuildType;
import com.google.devtools.build.lib.packages.BuiltinProvider;
import com.google.devtools.build.lib.packages.Info;
import com.google.devtools.build.lib.packages.NativeProvider;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.packages.TriState;
import com.google.devtools.build.lib.skyframe.SkyframeExecutor;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.List;
/**
* Utility functions for use during analysis.
*/
public final class AnalysisUtils {
private AnalysisUtils() {
throw new IllegalStateException(); // utility class
}
/**
* Returns whether link stamping is enabled for a rule.
*
*
This returns false for unstampable rule classes and for rules in the
* host configuration. Otherwise it returns the value of the stamp attribute,
* or of the stamp option if the attribute value is -1.
*/
public static boolean isStampingEnabled(RuleContext ruleContext, BuildConfiguration config) {
if (config.isHostConfiguration()
|| !ruleContext.attributes().has("stamp", BuildType.TRISTATE)) {
return false;
}
TriState stamp = ruleContext.attributes().get("stamp", BuildType.TRISTATE);
return stamp == TriState.YES || (stamp == TriState.AUTO && config.stampBinaries());
}
public static boolean isStampingEnabled(RuleContext ruleContext) {
return isStampingEnabled(ruleContext, ruleContext.getConfiguration());
}
// TODO(bazel-team): These need Iterable extends TransitiveInfoCollection> because they need to
// be called with Iterable. Once the configured target lockdown is complete, we
// can eliminate the "extends" clauses.
/**
* Returns the list of providers of the specified type from a set of transitive info
* collections.
*/
public static Iterable getProviders(
Iterable extends TransitiveInfoCollection> prerequisites, Class provider) {
ImmutableList.Builder result = ImmutableList.builder();
for (TransitiveInfoCollection prerequisite : prerequisites) {
C prerequisiteProvider = prerequisite.getProvider(provider);
if (prerequisiteProvider != null) {
result.add(prerequisiteProvider);
}
}
return result.build();
}
/**
* Returns the list of declared providers (native and Skylark) of the specified Skylark key from a
* set of transitive info collections.
*/
public static Iterable getProviders(
Iterable extends TransitiveInfoCollection> prerequisites,
final NativeProvider skylarkKey) {
ImmutableList.Builder result = ImmutableList.builder();
for (TransitiveInfoCollection prerequisite : prerequisites) {
T prerequisiteProvider = prerequisite.get(skylarkKey);
if (prerequisiteProvider != null) {
result.add(prerequisiteProvider);
}
}
return result.build();
}
/**
* Returns the list of declared providers (native and Skylark) of the specified Skylark key from a
* set of transitive info collections.
*/
public static Iterable getProviders(
Iterable extends TransitiveInfoCollection> prerequisites,
final BuiltinProvider skylarkKey) {
ImmutableList.Builder result = ImmutableList.builder();
for (TransitiveInfoCollection prerequisite : prerequisites) {
T prerequisiteProvider = prerequisite.get(skylarkKey);
if (prerequisiteProvider != null) {
result.add(prerequisiteProvider);
}
}
return result.build();
}
/**
* Returns the iterable of collections that have the specified provider.
*/
public static Iterable
filterByProvider(Iterable prerequisites, final Class provider) {
return Iterables.filter(prerequisites, target -> target.getProvider(provider) != null);
}
/** Returns the iterable of collections that have the specified provider. */
public static Iterable filterByProvider(
Iterable prerequisites, final NativeProvider provider) {
return Iterables.filter(prerequisites, target -> target.get(provider) != null);
}
/**
* Returns the path of the associated manifest file for the path of a Fileset. Works for both
* exec paths and root relative paths.
*/
public static PathFragment getManifestPathFromFilesetPath(PathFragment filesetDir) {
PathFragment manifestDir = filesetDir.replaceName("_" + filesetDir.getBaseName());
PathFragment outputManifestFrag = manifestDir.getRelative("MANIFEST");
return outputManifestFrag;
}
/**
* Returns the middleman artifact on the specified attribute of the specified rule for the
* specified mode, or an empty set if it does not exist.
*/
public static NestedSet getMiddlemanFor(RuleContext rule, String attribute, Mode mode) {
TransitiveInfoCollection prereq = rule.getPrerequisite(attribute, mode);
if (prereq == null) {
return NestedSetBuilder.emptySet(Order.STABLE_ORDER);
}
MiddlemanProvider provider = prereq.getProvider(MiddlemanProvider.class);
if (provider == null) {
return NestedSetBuilder.emptySet(Order.STABLE_ORDER);
}
return provider.getMiddlemanArtifact();
}
/**
* Returns a path fragment qualified by the rule name and unique fragment to
* disambiguate artifacts produced from the source file appearing in
* multiple rules.
*
* For example "//pkg:target" -> "pkg/<fragment>/target.
*/
public static PathFragment getUniqueDirectory(Label label, PathFragment fragment) {
return label.getPackageIdentifier().getSourceRoot().getRelative(fragment)
.getRelative(label.getName());
}
/**
* Checks that the given provider class either refers to an interface or to a value class.
*/
public static void checkProvider(Class clazz) {
// Write this check in terms of getName() rather than getSimpleName(); the latter is expensive.
if (!clazz.isInterface() && clazz.getName().contains(".AutoValue_")) {
// We must have a superclass due to the generic bound above.
throw new IllegalArgumentException(
clazz + " is generated by @AutoValue; use " + clazz.getSuperclass() + " instead");
}
}
/**
* Given a set of *top-level* targets and a configuration collection, evaluate top level
* transitions, resolve configurations and return the appropriate pair for
* each target.
*
* Preserves the original input ordering.
*/
public static List getTargetsWithConfigs(
BuildConfigurationCollection configurations,
Collection targets,
ExtendedEventHandler eventHandler,
ConfiguredRuleClassProvider ruleClassProvider,
SkyframeExecutor skyframeExecutor)
throws InterruptedException {
// We use a hash set here to remove duplicate nodes; this can happen for input files and package
// groups.
LinkedHashSet nodes = new LinkedHashSet<>(targets.size());
for (BuildConfiguration config : configurations.getTargetConfigurations()) {
for (Target target : targets) {
nodes.add(new TargetAndConfiguration(target, target.isConfigurable() ? config : null));
}
}
// We'll get the configs from SkyframeExecutor#getConfigurations, which gets configurations
// for deps including transitions. So to satisfy its API we resolve transitions and repackage
// each target as a Dependency (with a NONE transition if necessary).
Multimap asDeps =
AnalysisUtils.targetsToDeps(nodes, ruleClassProvider);
return ImmutableList.copyOf(
ConfigurationResolver.getConfigurationsFromExecutor(
nodes, asDeps, eventHandler, skyframeExecutor));
}
public static Multimap targetsToDeps(
LinkedHashSet nodes, ConfiguredRuleClassProvider ruleClassProvider) {
Multimap asDeps =
ArrayListMultimap.create();
for (TargetAndConfiguration targetAndConfig : nodes) {
if (targetAndConfig.getConfiguration() != null) {
asDeps.put(
targetAndConfig.getConfiguration(),
Dependency.withTransitionAndAspects(
targetAndConfig.getLabel(),
TransitionResolver.evaluateTopLevelTransition(
targetAndConfig, ruleClassProvider.getTrimmingTransitionFactory()),
// TODO(bazel-team): support top-level aspects
AspectCollection.EMPTY));
}
}
return asDeps;
}
}