blob: 10a63fbb9930927466f3ad994c0e67d8c041661c [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.skyframe;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.ActionExecutionException;
import com.google.devtools.build.lib.actions.ActionInputMap;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.ArtifactPathResolver;
import com.google.devtools.build.lib.actions.ArtifactSkyKey;
import com.google.devtools.build.lib.actions.FilesetOutputSymlink;
import com.google.devtools.build.lib.actions.MissingInputFileException;
import com.google.devtools.build.lib.analysis.AspectCompleteEvent;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.TargetCompleteEvent;
import com.google.devtools.build.lib.analysis.TopLevelArtifactContext;
import com.google.devtools.build.lib.analysis.TopLevelArtifactHelper;
import com.google.devtools.build.lib.analysis.TopLevelArtifactHelper.ArtifactsToBuild;
import com.google.devtools.build.lib.buildeventstream.BuildEventId;
import com.google.devtools.build.lib.causes.Cause;
import com.google.devtools.build.lib.causes.LabelCause;
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.events.Event;
import com.google.devtools.build.lib.events.ExtendedEventHandler;
import com.google.devtools.build.lib.skyframe.AspectCompletionValue.AspectCompletionKey;
import com.google.devtools.build.lib.skyframe.AspectValue.AspectKey;
import com.google.devtools.build.lib.skyframe.TargetCompletionValue.TargetCompletionKey;
import com.google.devtools.build.skyframe.SkyFunction;
import com.google.devtools.build.skyframe.SkyFunctionException;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import com.google.devtools.build.skyframe.ValueOrException2;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.Nullable;
/**
* CompletionFunction builds the artifactsToBuild collection of a {@link ConfiguredTarget}.
*/
public final class CompletionFunction<TValue extends SkyValue, TResult extends SkyValue>
implements SkyFunction {
interface PathResolverFactory {
ArtifactPathResolver createPathResolverForArtifactValues(
ActionInputMap actionInputMap,
Map<Artifact, Collection<Artifact>> expandedArtifacts,
Iterable<Artifact> filesets);
boolean shouldCreatePathResolverForArtifactValues();
}
/** A strategy for completing the build. */
interface Completor<TValue, TResult extends SkyValue> {
/** Obtains an analysis result value from environment. */
TValue getValueFromSkyKey(SkyKey skyKey, Environment env) throws InterruptedException;
/**
* Returns the options which determine the artifacts to build for the top-level targets.
* <p>
* For the Top level targets we made a conscious decision to include the TopLevelArtifactContext
* within the SkyKey as an argument to the CompletionFunction rather than a separate SkyKey.
* As a result we do have <num top level targets> extra SkyKeys for every unique
* TopLevelArtifactContexts used over the lifetime of Blaze. This is a minor tradeoff,
* since it significantly improves null build times when we're switching the
* TopLevelArtifactContexts frequently (common for IDEs), by reusing existing SkyKeys
* from earlier runs, instead of causing an eager invalidation
* were the TopLevelArtifactContext modeled as a separate SkyKey.
*/
TopLevelArtifactContext getTopLevelArtifactContext(SkyKey skyKey);
/**
* Returns all artifacts that need to be built to complete the {@code value}
*/
ArtifactsToBuild getAllArtifactsToBuild(TValue value, TopLevelArtifactContext context);
/** Creates an event reporting an absent input artifact. */
Event getRootCauseError(TValue value, Cause rootCause, Environment env)
throws InterruptedException;
/** Creates an error message reporting {@code missingCount} missing input files. */
MissingInputFileException getMissingFilesException(
TValue value, int missingCount, Environment env) throws InterruptedException;
/** Provides a successful completion value. */
TResult getResult();
/** Creates a failed completion value. */
ExtendedEventHandler.Postable createFailed(
TValue value, NestedSet<Cause> rootCauses, Environment env) throws InterruptedException;
/** Creates a succeeded completion value. */
ExtendedEventHandler.Postable createSucceeded(
SkyKey skyKey,
TValue value,
ArtifactPathResolver pathResolver,
TopLevelArtifactContext topLevelArtifactContext,
Environment env)
throws InterruptedException;
/**
* Extracts a tag given the {@link SkyKey}.
*/
String extractTag(SkyKey skyKey);
}
private static class TargetCompletor
implements Completor<ConfiguredTargetValue, TargetCompletionValue> {
@Override
public ConfiguredTargetValue getValueFromSkyKey(SkyKey skyKey, Environment env)
throws InterruptedException {
TargetCompletionKey tcKey = (TargetCompletionKey) skyKey.argument();
return (ConfiguredTargetValue) env.getValue(tcKey.configuredTargetKey());
}
@Override
public TopLevelArtifactContext getTopLevelArtifactContext(SkyKey skyKey) {
TargetCompletionKey tcKey = (TargetCompletionKey) skyKey.argument();
return tcKey.topLevelArtifactContext();
}
@Override
public ArtifactsToBuild getAllArtifactsToBuild(
ConfiguredTargetValue value, TopLevelArtifactContext topLevelContext) {
return TopLevelArtifactHelper.getAllArtifactsToBuild(
value.getConfiguredTarget(), topLevelContext);
}
@Override
public Event getRootCauseError(ConfiguredTargetValue ctValue, Cause rootCause, Environment env)
throws InterruptedException {
ConfiguredTargetAndData configuredTargetAndData =
ConfiguredTargetAndData.fromConfiguredTargetInSkyframe(
ctValue.getConfiguredTarget(), env);
return Event.error(
configuredTargetAndData == null
? null
: configuredTargetAndData.getTarget().getLocation(),
String.format(
"%s: missing input file '%s'", ctValue.getConfiguredTarget().getLabel(), rootCause));
}
@Override
@Nullable
public MissingInputFileException getMissingFilesException(
ConfiguredTargetValue value, int missingCount, Environment env)
throws InterruptedException {
ConfiguredTargetAndData configuredTargetAndData =
ConfiguredTargetAndData.fromConfiguredTargetInSkyframe(value.getConfiguredTarget(), env);
if (configuredTargetAndData == null) {
return null;
}
return new MissingInputFileException(
configuredTargetAndData.getTarget().getLocation()
+ " "
+ missingCount
+ " input file(s) do not exist",
configuredTargetAndData.getTarget().getLocation());
}
@Override
public TargetCompletionValue getResult() {
return TargetCompletionValue.INSTANCE;
}
@Override
@Nullable
public ExtendedEventHandler.Postable createFailed(
ConfiguredTargetValue value, NestedSet<Cause> rootCauses, Environment env)
throws InterruptedException {
ConfiguredTargetAndData configuredTargetAndData =
ConfiguredTargetAndData.fromConfiguredTargetInSkyframe(value.getConfiguredTarget(), env);
if (configuredTargetAndData == null) {
return null;
}
return TargetCompleteEvent.createFailed(configuredTargetAndData, rootCauses);
}
@Override
public String extractTag(SkyKey skyKey) {
return Label.print(
((TargetCompletionKey) skyKey.argument()).configuredTargetKey().getLabel());
}
@Override
@Nullable
public ExtendedEventHandler.Postable createSucceeded(
SkyKey skyKey,
ConfiguredTargetValue value,
ArtifactPathResolver pathResolver,
TopLevelArtifactContext topLevelArtifactContext,
Environment env)
throws InterruptedException {
ConfiguredTarget target = value.getConfiguredTarget();
ConfiguredTargetAndData configuredTargetAndData =
ConfiguredTargetAndData.fromConfiguredTargetInSkyframe(target, env);
if (configuredTargetAndData == null) {
return null;
}
ArtifactsToBuild artifactsToBuild =
TopLevelArtifactHelper.getAllArtifactsToBuild(target, topLevelArtifactContext);
if (((TargetCompletionKey) skyKey.argument()).willTest()) {
return TargetCompleteEvent.successfulBuildSchedulingTest(
configuredTargetAndData, pathResolver, artifactsToBuild.getAllArtifactsByOutputGroup());
} else {
return TargetCompleteEvent.successfulBuild(
configuredTargetAndData, pathResolver, artifactsToBuild.getAllArtifactsByOutputGroup());
}
}
}
private static class AspectCompletor implements Completor<AspectValue, AspectCompletionValue> {
@Override
public AspectValue getValueFromSkyKey(SkyKey skyKey, Environment env)
throws InterruptedException {
AspectCompletionKey acKey = (AspectCompletionKey) skyKey.argument();
AspectKey aspectKey = acKey.aspectKey();
return (AspectValue) env.getValue(aspectKey);
}
@Override
public TopLevelArtifactContext getTopLevelArtifactContext(SkyKey skyKey) {
AspectCompletionKey acKey = (AspectCompletionKey) skyKey.argument();
return acKey.topLevelArtifactContext();
}
@Override
public ArtifactsToBuild getAllArtifactsToBuild(
AspectValue value, TopLevelArtifactContext topLevelArtifactContext) {
return TopLevelArtifactHelper.getAllArtifactsToBuild(value, topLevelArtifactContext);
}
@Override
public Event getRootCauseError(AspectValue value, Cause rootCause, Environment env) {
return Event.error(
value.getLocation(),
String.format(
"%s, aspect %s: missing input file '%s'",
value.getLabel(),
value.getConfiguredAspect().getName(),
rootCause));
}
@Override
public MissingInputFileException getMissingFilesException(
AspectValue value, int missingCount, Environment env) {
return new MissingInputFileException(
value.getLabel()
+ ", aspect "
+ value.getConfiguredAspect().getName()
+ missingCount
+ " input file(s) do not exist",
value.getLocation());
}
@Override
public AspectCompletionValue getResult() {
return AspectCompletionValue.INSTANCE;
}
@Override
public ExtendedEventHandler.Postable createFailed(
AspectValue value, NestedSet<Cause> rootCauses, Environment env)
throws InterruptedException {
BuildEventId configurationEventId = getConfigurationEventIdFromAspectValue(value, env);
if (configurationEventId == null) {
return null;
}
return AspectCompleteEvent.createFailed(value, rootCauses, configurationEventId);
}
@Override
public String extractTag(SkyKey skyKey) {
return Label.print(((AspectCompletionKey) skyKey.argument()).aspectKey().getLabel());
}
@Nullable
private BuildEventId getConfigurationEventIdFromAspectValue(AspectValue value, Environment env)
throws InterruptedException {
if (value.getKey().getBaseConfiguredTargetKey().getConfigurationKey() == null) {
return BuildEventId.nullConfigurationId();
} else {
BuildConfigurationValue buildConfigurationValue =
(BuildConfigurationValue)
env.getValue(value.getKey().getBaseConfiguredTargetKey().getConfigurationKey());
if (buildConfigurationValue == null) {
return null;
}
return buildConfigurationValue.getConfiguration().getEventId();
}
}
@Override
public ExtendedEventHandler.Postable createSucceeded(
SkyKey skyKey,
AspectValue value,
ArtifactPathResolver pathResolver,
TopLevelArtifactContext topLevelArtifactContext,
Environment env)
throws InterruptedException {
ArtifactsToBuild artifacts =
TopLevelArtifactHelper.getAllArtifactsToBuild(value, topLevelArtifactContext);
BuildEventId configurationEventId = getConfigurationEventIdFromAspectValue(value, env);
if (configurationEventId == null) {
return null;
}
return AspectCompleteEvent.createSuccessful(
value, pathResolver, artifacts, configurationEventId);
}
}
public static SkyFunction targetCompletionFunction(PathResolverFactory pathResolverFactory) {
return new CompletionFunction<>(pathResolverFactory, new TargetCompletor());
}
public static SkyFunction aspectCompletionFunction(PathResolverFactory pathResolverFactory) {
return new CompletionFunction<>(pathResolverFactory, new AspectCompletor());
}
private final PathResolverFactory pathResolverFactory;
private final Completor<TValue, TResult> completor;
private CompletionFunction(
PathResolverFactory pathResolverFactory, Completor<TValue, TResult> completor) {
this.pathResolverFactory = pathResolverFactory;
this.completor = completor;
}
@Nullable
@Override
public SkyValue compute(SkyKey skyKey, Environment env)
throws CompletionFunctionException, InterruptedException {
TValue value = completor.getValueFromSkyKey(skyKey, env);
TopLevelArtifactContext topLevelContext = completor.getTopLevelArtifactContext(skyKey);
if (env.valuesMissing()) {
return null;
}
Map<SkyKey, ValueOrException2<MissingInputFileException, ActionExecutionException>> inputDeps =
env.getValuesOrThrow(
completor.getAllArtifactsToBuild(value, topLevelContext).getAllArtifacts(),
MissingInputFileException.class,
ActionExecutionException.class);
boolean createPathResolver = pathResolverFactory.shouldCreatePathResolverForArtifactValues();
ActionInputMap inputMap = null;
Map<Artifact, Collection<Artifact>> expandedArtifacts = null;
Map<Artifact, ImmutableList<FilesetOutputSymlink>> expandedFilesets = null;
if (createPathResolver) {
inputMap = new ActionInputMap(inputDeps.size());
expandedArtifacts = new HashMap<>();
expandedFilesets = new HashMap<>();
}
int missingCount = 0;
ActionExecutionException firstActionExecutionException = null;
MissingInputFileException missingInputException = null;
NestedSetBuilder<Cause> rootCausesBuilder = NestedSetBuilder.stableOrder();
for (Map.Entry<SkyKey, ValueOrException2<MissingInputFileException, ActionExecutionException>>
depsEntry : inputDeps.entrySet()) {
Artifact input = ArtifactSkyKey.artifact(depsEntry.getKey());
try {
SkyValue artifactValue = depsEntry.getValue().get();
if (createPathResolver && artifactValue != null) {
ActionInputMapHelper.addToMap(
inputMap,
expandedArtifacts,
expandedFilesets,
input,
artifactValue,
env);
if (input.isFileset()) {
expandedFilesets.put(input, ActionInputMapHelper.getFilesets(env, input));
}
}
} catch (MissingInputFileException e) {
missingCount++;
final Label inputOwner = input.getOwner();
if (inputOwner != null) {
Cause cause = new LabelCause(inputOwner, e.getMessage());
rootCausesBuilder.add(cause);
env.getListener().handle(completor.getRootCauseError(value, cause, env));
}
} catch (ActionExecutionException e) {
rootCausesBuilder.addTransitive(e.getRootCauses());
// Prefer a catastrophic exception as the one we propagate.
if (firstActionExecutionException == null
|| !firstActionExecutionException.isCatastrophe() && e.isCatastrophe()) {
firstActionExecutionException = e;
}
}
}
if (missingCount > 0) {
missingInputException = completor.getMissingFilesException(value, missingCount, env);
if (missingInputException == null) {
return null;
}
}
NestedSet<Cause> rootCauses = rootCausesBuilder.build();
if (!rootCauses.isEmpty()) {
ExtendedEventHandler.Postable postable = completor.createFailed(value, rootCauses, env);
if (postable == null) {
return null;
}
env.getListener().post(postable);
if (firstActionExecutionException != null) {
throw new CompletionFunctionException(firstActionExecutionException);
} else {
throw new CompletionFunctionException(missingInputException);
}
}
// Only check for missing values *after* reporting errors: if there are missing files in a build
// with --nokeep_going, there may be missing dependencies during error bubbling, we still need
// to report the error.
if (env.valuesMissing()) {
return null;
}
ArtifactPathResolver pathResolver =
createPathResolver
? pathResolverFactory.createPathResolverForArtifactValues(
inputMap, expandedArtifacts, expandedFilesets.keySet())
: ArtifactPathResolver.IDENTITY;
ExtendedEventHandler.Postable postable =
completor.createSucceeded(skyKey, value, pathResolver, topLevelContext, env);
if (postable == null) {
return null;
}
env.getListener().post(postable);
return completor.getResult();
}
@Override
public String extractTag(SkyKey skyKey) {
return completor.extractTag(skyKey);
}
private static final class CompletionFunctionException extends SkyFunctionException {
private final ActionExecutionException actionException;
public CompletionFunctionException(ActionExecutionException e) {
super(e, Transience.PERSISTENT);
this.actionException = e;
}
public CompletionFunctionException(MissingInputFileException e) {
super(e, Transience.TRANSIENT);
this.actionException = null;
}
@Override
public boolean isCatastrophic() {
return actionException != null && actionException.isCatastrophe();
}
}
}