blob: 53d7632bdcf045f1a0ab0a62c2ec4bdeb8018a8e [file] [log] [blame]
// Copyright 2018 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.query2.cquery;
import static java.util.stream.Collectors.joining;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.DependencyKey;
import com.google.devtools.build.lib.analysis.DependencyKind;
import com.google.devtools.build.lib.analysis.DependencyKind.ToolchainDependencyKind;
import com.google.devtools.build.lib.analysis.DependencyResolver;
import com.google.devtools.build.lib.analysis.InconsistentAspectOrderException;
import com.google.devtools.build.lib.analysis.TargetAndConfiguration;
import com.google.devtools.build.lib.analysis.ToolchainCollection;
import com.google.devtools.build.lib.analysis.ToolchainContext;
import com.google.devtools.build.lib.analysis.config.BuildConfigurationValue;
import com.google.devtools.build.lib.analysis.config.BuildOptions;
import com.google.devtools.build.lib.analysis.config.BuildOptions.OptionsDiff;
import com.google.devtools.build.lib.analysis.config.ConfigMatchingProvider;
import com.google.devtools.build.lib.analysis.config.transitions.ConfigurationTransition;
import com.google.devtools.build.lib.analysis.config.transitions.NoTransition;
import com.google.devtools.build.lib.analysis.config.transitions.NullTransition;
import com.google.devtools.build.lib.analysis.config.transitions.TransitionFactory;
import com.google.devtools.build.lib.analysis.config.transitions.TransitionUtil;
import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget;
import com.google.devtools.build.lib.causes.Cause;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.ExtendedEventHandler;
import com.google.devtools.build.lib.packages.RuleTransitionData;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.query2.engine.QueryEnvironment.TargetAccessor;
import com.google.devtools.build.lib.skyframe.SkyframeExecutor;
import com.google.devtools.build.lib.util.OrderedSetMultimap;
import java.io.OutputStream;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
/**
* Output formatter that prints {@link ConfigurationTransition} information for rule configured
* targets in the results of a cquery call.
*/
class TransitionsOutputFormatterCallback extends CqueryThreadsafeCallback {
protected final BuildConfigurationValue hostConfiguration;
private final HashMap<Label, Target> partialResultMap;
@Nullable private final TransitionFactory<RuleTransitionData> trimmingTransitionFactory;
@Override
public String getName() {
return "transitions";
}
/**
* @param accessor provider of query result configured targets.
* @param hostConfiguration host configuration for this query.
*/
TransitionsOutputFormatterCallback(
ExtendedEventHandler eventHandler,
CqueryOptions options,
OutputStream out,
SkyframeExecutor skyframeExecutor,
TargetAccessor<KeyedConfiguredTarget> accessor,
BuildConfigurationValue hostConfiguration,
@Nullable TransitionFactory<RuleTransitionData> trimmingTransitionFactory) {
super(eventHandler, options, out, skyframeExecutor, accessor);
this.hostConfiguration = hostConfiguration;
this.trimmingTransitionFactory = trimmingTransitionFactory;
this.partialResultMap = Maps.newHashMap();
}
@Override
public void processOutput(Iterable<KeyedConfiguredTarget> partialResult)
throws InterruptedException {
CqueryOptions.Transitions verbosity = options.transitions;
if (verbosity.equals(CqueryOptions.Transitions.NONE)) {
eventHandler.handle(
Event.error(
"Instead of using --output=transitions, set the --transitions"
+ " flag explicitly to 'lite' or 'full'"));
return;
}
partialResult.forEach(kct -> partialResultMap.put(kct.getLabel(), accessor.getTarget(kct)));
for (KeyedConfiguredTarget keyedConfiguredTarget : partialResult) {
Target target = partialResultMap.get(keyedConfiguredTarget.getLabel());
BuildConfigurationValue config =
getConfiguration(keyedConfiguredTarget.getConfigurationKey());
addResult(
getRuleClassTransition(keyedConfiguredTarget.getConfiguredTarget(), target)
+ String.format(
"%s (%s)",
keyedConfiguredTarget.getConfiguredTarget().getOriginalLabel(), shortId(config)));
if (!(keyedConfiguredTarget.getConfiguredTarget() instanceof RuleConfiguredTarget)) {
continue;
}
OrderedSetMultimap<DependencyKind, DependencyKey> deps;
ImmutableMap<Label, ConfigMatchingProvider> configConditions =
keyedConfiguredTarget.getConfigConditions();
// Get a ToolchainContext to use for dependency resolution.
ToolchainCollection<ToolchainContext> toolchainContexts =
accessor.getToolchainContexts(target, config);
try {
// We don't actually use fromOptions in our implementation of
// DependencyResolver but passing to avoid passing a null and since we have the information
// anyway.
deps =
new FormatterDependencyResolver()
.dependentNodeMap(
new TargetAndConfiguration(target, config),
/*aspect=*/ null,
configConditions,
toolchainContexts,
DependencyResolver.shouldUseToolchainTransition(config, target),
trimmingTransitionFactory);
} catch (DependencyResolver.Failure | InconsistentAspectOrderException e) {
// This is an abuse of InterruptedException.
throw new InterruptedException(e.getMessage());
}
for (Map.Entry<DependencyKind, DependencyKey> attributeAndDep : deps.entries()) {
if (attributeAndDep.getValue().getTransition() == NoTransition.INSTANCE
|| attributeAndDep.getValue().getTransition() == NullTransition.INSTANCE) {
continue;
}
DependencyKey dep = attributeAndDep.getValue();
BuildOptions fromOptions = config.getOptions();
// TODO(bazel-team): support transitions on Starlark-defined build flags. These require
// Skyframe loading to get flag default values. See ConfigurationResolver.applyTransition
// for an example of the required logic.
Collection<BuildOptions> toOptions =
dep.getTransition()
.apply(TransitionUtil.restrict(dep.getTransition(), fromOptions), eventHandler)
.values();
String hostConfigurationChecksum = hostConfiguration.checksum();
String dependencyName;
if (DependencyKind.isToolchain(attributeAndDep.getKey())) {
ToolchainDependencyKind tdk = (ToolchainDependencyKind) attributeAndDep.getKey();
if (tdk.isDefaultExecGroup()) {
dependencyName = "[toolchain dependency]";
} else {
dependencyName = String.format("[toolchain dependency: %s]", tdk.getExecGroupName());
}
} else {
dependencyName = attributeAndDep.getKey().getAttribute().getName();
}
addResult(
" "
.concat(dependencyName)
.concat("#")
.concat(dep.getLabel().toString())
.concat("#")
.concat(dep.getTransition().getName())
.concat(" -> ")
.concat(
toOptions.stream()
.map(
options -> {
String checksum = options.checksum();
return checksum.equals(hostConfigurationChecksum)
? "HOST"
: shortId(checksum);
})
.collect(joining(", "))));
if (verbosity == CqueryOptions.Transitions.LITE) {
continue;
}
OptionsDiff diff = new OptionsDiff();
for (BuildOptions options : toOptions) {
diff = BuildOptions.diff(diff, fromOptions, options);
}
diff.getPrettyPrintList().forEach(singleDiff -> addResult(" " + singleDiff));
}
}
}
private static String getRuleClassTransition(ConfiguredTarget ct, Target target) {
String output = "";
if (ct instanceof RuleConfiguredTarget) {
TransitionFactory<RuleTransitionData> factory =
target.getAssociatedRule().getRuleClassObject().getTransitionFactory();
if (factory != null) {
output =
factory
.create(RuleTransitionData.create(target.getAssociatedRule()))
.getName()
.concat(" -> ");
}
}
return output;
}
private class FormatterDependencyResolver extends DependencyResolver {
@Override
protected Map<Label, Target> getTargets(
OrderedSetMultimap<DependencyKind, Label> labelMap,
TargetAndConfiguration fromNode,
NestedSetBuilder<Cause> rootCauses) {
return labelMap.values().stream()
.distinct()
.filter(Objects::nonNull)
.filter(partialResultMap::containsKey)
.collect(Collectors.toMap(Function.identity(), partialResultMap::get));
}
}
}