Google Git
Sign in
bazel / bazel / fbf9277975ceb7be5255fd5cf449e22706d25d3f / . / src / main / java / com / google / devtools / build / lib / skyframe / SkyframeExecutor.java
blob: b2cae6896fabbc281d4f27b708f966583cd8aaa2 [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 static com.google.common.collect.ImmutableList.toImmutableList;
import static com.google.devtools.build.lib.concurrent.Uninterruptibles.callUninterruptibly;
import static com.google.devtools.build.lib.skyframe.ArtifactConflictFinder.ACTION_CONFLICTS;
import static com.google.devtools.build.lib.skyframe.ArtifactConflictFinder.NUM_JOBS;
import static java.util.stream.Collectors.toMap;
import com.github.benmanes.caffeine.cache.Cache;
import com.github.benmanes.caffeine.cache.Caffeine;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Functions;
import com.google.common.base.Preconditions;
import com.google.common.base.Predicate;
import com.google.common.base.Stopwatch;
import com.google.common.base.Throwables;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Collections2;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Multimap;
import com.google.common.collect.Range;
import com.google.common.collect.Sets;
import com.google.common.eventbus.EventBus;
import com.google.common.flogger.GoogleLogger;
import com.google.devtools.build.lib.actions.ActionAnalysisMetadata;
import com.google.devtools.build.lib.actions.ActionCacheChecker;
import com.google.devtools.build.lib.actions.ActionExecutionStatusReporter;
import com.google.devtools.build.lib.actions.ActionGraph;
import com.google.devtools.build.lib.actions.ActionInputMap;
import com.google.devtools.build.lib.actions.ActionInputPrefetcher;
import com.google.devtools.build.lib.actions.ActionKeyContext;
import com.google.devtools.build.lib.actions.ActionLogBufferPathGenerator;
import com.google.devtools.build.lib.actions.ActionLookupData;
import com.google.devtools.build.lib.actions.ActionLookupKey;
import com.google.devtools.build.lib.actions.ActionLookupValue;
import com.google.devtools.build.lib.actions.Actions;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.ArtifactFactory;
import com.google.devtools.build.lib.actions.ArtifactPathResolver;
import com.google.devtools.build.lib.actions.ArtifactRoot;
import com.google.devtools.build.lib.actions.CompletionContext.PathResolverFactory;
import com.google.devtools.build.lib.actions.DiscoveredModulesPruner;
import com.google.devtools.build.lib.actions.EnvironmentalExecException;
import com.google.devtools.build.lib.actions.Executor;
import com.google.devtools.build.lib.actions.FileStateValue;
import com.google.devtools.build.lib.actions.FileValue;
import com.google.devtools.build.lib.actions.FilesetOutputSymlink;
import com.google.devtools.build.lib.actions.MapBasedActionGraph;
import com.google.devtools.build.lib.actions.MetadataProvider;
import com.google.devtools.build.lib.actions.ResourceManager;
import com.google.devtools.build.lib.actions.ThreadStateReceiver;
import com.google.devtools.build.lib.actions.UserExecException;
import com.google.devtools.build.lib.analysis.AnalysisOptions;
import com.google.devtools.build.lib.analysis.AspectCollection.AspectDeps;
import com.google.devtools.build.lib.analysis.AspectValue;
import com.google.devtools.build.lib.analysis.BlazeDirectories;
import com.google.devtools.build.lib.analysis.ConfigurationsCollector;
import com.google.devtools.build.lib.analysis.ConfigurationsResult;
import com.google.devtools.build.lib.analysis.ConfiguredAspect;
import com.google.devtools.build.lib.analysis.ConfiguredRuleClassProvider;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.ConfiguredTargetValue;
import com.google.devtools.build.lib.analysis.Dependency;
import com.google.devtools.build.lib.analysis.DependencyKey;
import com.google.devtools.build.lib.analysis.DuplicateException;
import com.google.devtools.build.lib.analysis.PlatformOptions;
import com.google.devtools.build.lib.analysis.TopLevelArtifactContext;
import com.google.devtools.build.lib.analysis.ViewCreationFailedException;
import com.google.devtools.build.lib.analysis.WorkspaceStatusAction;
import com.google.devtools.build.lib.analysis.WorkspaceStatusAction.Factory;
import com.google.devtools.build.lib.analysis.config.BuildConfigurationCollection;
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.BuildOptionsView;
import com.google.devtools.build.lib.analysis.config.ConfigurationResolver;
import com.google.devtools.build.lib.analysis.config.CoreOptions;
import com.google.devtools.build.lib.analysis.config.HostTransition;
import com.google.devtools.build.lib.analysis.config.InvalidConfigurationException;
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.configuredtargets.InputFileConfiguredTarget;
import com.google.devtools.build.lib.analysis.configuredtargets.MergedConfiguredTarget;
import com.google.devtools.build.lib.analysis.configuredtargets.OutputFileConfiguredTarget;
import com.google.devtools.build.lib.analysis.constraints.RuleContextConstraintSemantics;
import com.google.devtools.build.lib.analysis.starlark.StarlarkTransition;
import com.google.devtools.build.lib.analysis.starlark.StarlarkTransition.TransitionException;
import com.google.devtools.build.lib.bazel.bzlmod.BzlmodRepoRuleHelperImpl;
import com.google.devtools.build.lib.bazel.bzlmod.BzlmodRepoRuleValue;
import com.google.devtools.build.lib.bugreport.BugReport;
import com.google.devtools.build.lib.bugreport.BugReporter;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos;
import com.google.devtools.build.lib.buildtool.BuildRequestOptions;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.cmdline.TargetParsingException;
import com.google.devtools.build.lib.concurrent.ExecutorUtil;
import com.google.devtools.build.lib.concurrent.NamedForkJoinPool;
import com.google.devtools.build.lib.concurrent.Sharder;
import com.google.devtools.build.lib.concurrent.ThreadSafety;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadCompatible;
import com.google.devtools.build.lib.events.ErrorSensingEventHandler;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.events.ExtendedEventHandler;
import com.google.devtools.build.lib.events.Reporter;
import com.google.devtools.build.lib.io.FileSymlinkCycleUniquenessFunction;
import com.google.devtools.build.lib.io.FileSymlinkInfiniteExpansionUniquenessFunction;
import com.google.devtools.build.lib.packages.BuildFileContainsErrorsException;
import com.google.devtools.build.lib.packages.BuildFileName;
import com.google.devtools.build.lib.packages.NoSuchPackageException;
import com.google.devtools.build.lib.packages.NoSuchTargetException;
import com.google.devtools.build.lib.packages.NoSuchThingException;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.packages.Package.Builder.PackageSettings;
import com.google.devtools.build.lib.packages.Package.ConfigSettingVisibilityPolicy;
import com.google.devtools.build.lib.packages.PackageFactory;
import com.google.devtools.build.lib.packages.RuleClassProvider;
import com.google.devtools.build.lib.packages.RuleVisibility;
import com.google.devtools.build.lib.packages.WorkspaceFileValue;
import com.google.devtools.build.lib.packages.semantics.BuildLanguageOptions;
import com.google.devtools.build.lib.pkgcache.LoadingOptions;
import com.google.devtools.build.lib.pkgcache.PackageManager;
import com.google.devtools.build.lib.pkgcache.PackageOptions;
import com.google.devtools.build.lib.pkgcache.PathPackageLocator;
import com.google.devtools.build.lib.pkgcache.TargetParsingPhaseTimeEvent;
import com.google.devtools.build.lib.pkgcache.TargetPatternPreloader;
import com.google.devtools.build.lib.pkgcache.TestFilter;
import com.google.devtools.build.lib.profiler.AutoProfiler;
import com.google.devtools.build.lib.profiler.GoogleAutoProfilerUtils;
import com.google.devtools.build.lib.profiler.Profiler;
import com.google.devtools.build.lib.profiler.SilentCloseable;
import com.google.devtools.build.lib.query2.common.QueryTransitivePackagePreloader;
import com.google.devtools.build.lib.query2.common.UniverseScope;
import com.google.devtools.build.lib.remote.options.RemoteOptions;
import com.google.devtools.build.lib.remote.options.RemoteOutputsMode;
import com.google.devtools.build.lib.repository.ExternalPackageHelper;
import com.google.devtools.build.lib.rules.repository.ResolvedFileFunction;
import com.google.devtools.build.lib.rules.repository.ResolvedHashesFunction;
import com.google.devtools.build.lib.runtime.KeepGoingOption;
import com.google.devtools.build.lib.server.FailureDetails;
import com.google.devtools.build.lib.server.FailureDetails.BuildConfiguration.Code;
import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
import com.google.devtools.build.lib.server.FailureDetails.TargetPatterns;
import com.google.devtools.build.lib.skyframe.ActionTemplateExpansionValue.ActionTemplateExpansionKey;
import com.google.devtools.build.lib.skyframe.ArtifactConflictFinder.ConflictException;
import com.google.devtools.build.lib.skyframe.AspectKeyCreator.AspectKey;
import com.google.devtools.build.lib.skyframe.AspectKeyCreator.TopLevelAspectsKey;
import com.google.devtools.build.lib.skyframe.BuildDriverFunction.ActionLookupValuesCollectionResult;
import com.google.devtools.build.lib.skyframe.BuildDriverFunction.TransitiveActionLookupValuesHelper;
import com.google.devtools.build.lib.skyframe.ExternalFilesHelper.ExternalFileAction;
import com.google.devtools.build.lib.skyframe.MetadataConsumerForMetrics.FilesMetricConsumer;
import com.google.devtools.build.lib.skyframe.PackageFunction.ActionOnIOExceptionReadingBuildFile;
import com.google.devtools.build.lib.skyframe.PackageFunction.GlobbingStrategy;
import com.google.devtools.build.lib.skyframe.PackageLookupFunction.CrossRepositoryLabelViolationStrategy;
import com.google.devtools.build.lib.skyframe.SkyframeActionExecutor.ActionCompletedReceiver;
import com.google.devtools.build.lib.skyframe.SkyframeActionExecutor.ProgressSupplier;
import com.google.devtools.build.lib.util.AbruptExitException;
import com.google.devtools.build.lib.util.DetailedExitCode;
import com.google.devtools.build.lib.util.ResourceUsage;
import com.google.devtools.build.lib.util.TestType;
import com.google.devtools.build.lib.util.io.TimestampGranularityMonitor;
import com.google.devtools.build.lib.vfs.DigestHashFunction;
import com.google.devtools.build.lib.vfs.FileStateKey;
import com.google.devtools.build.lib.vfs.FileSystem;
import com.google.devtools.build.lib.vfs.ModifiedFileSet;
import com.google.devtools.build.lib.vfs.OutputService;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.build.lib.vfs.Root;
import com.google.devtools.build.lib.vfs.RootedPath;
import com.google.devtools.build.lib.vfs.SyscallCache;
import com.google.devtools.build.skyframe.CyclesReporter;
import com.google.devtools.build.skyframe.Differencer;
import com.google.devtools.build.skyframe.ErrorInfo;
import com.google.devtools.build.skyframe.EvaluationContext;
import com.google.devtools.build.skyframe.EvaluationContext.UnnecessaryTemporaryStateDropper;
import com.google.devtools.build.skyframe.EvaluationContext.UnnecessaryTemporaryStateDropperReceiver;
import com.google.devtools.build.skyframe.EvaluationProgressReceiver;
import com.google.devtools.build.skyframe.EvaluationResult;
import com.google.devtools.build.skyframe.EventFilter;
import com.google.devtools.build.skyframe.ImmutableDiff;
import com.google.devtools.build.skyframe.InMemoryMemoizingEvaluator;
import com.google.devtools.build.skyframe.Injectable;
import com.google.devtools.build.skyframe.MemoizingEvaluator;
import com.google.devtools.build.skyframe.MemoizingEvaluator.EmittedEventState;
import com.google.devtools.build.skyframe.NodeEntry;
import com.google.devtools.build.skyframe.SkyFunction;
import com.google.devtools.build.skyframe.SkyFunctionName;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import com.google.devtools.build.skyframe.WalkableGraph;
import com.google.devtools.build.skyframe.WalkableGraph.WalkableGraphFactory;
import com.google.devtools.common.options.OptionsParsingException;
import com.google.devtools.common.options.OptionsProvider;
import com.google.errorprone.annotations.ForOverride;
import java.io.PrintStream;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.Future;
import java.util.concurrent.RecursiveAction;
import java.util.concurrent.Semaphore;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import java.util.function.Supplier;
import javax.annotation.Nullable;
import net.starlark.java.eval.StarlarkSemantics;
/**
* A helper object to support Skyframe-driven execution.
*
* <p>This object is mostly used to inject external state, such as the executor engine or some
* additional artifacts (workspace status and build info artifacts) into SkyFunctions for use during
* the build.
*/
public abstract class SkyframeExecutor implements WalkableGraphFactory, ConfigurationsCollector {
private static final GoogleLogger logger = GoogleLogger.forEnclosingClass();
protected MemoizingEvaluator memoizingEvaluator;
private final MemoizingEvaluator.EmittedEventState emittedEventState =
new MemoizingEvaluator.EmittedEventState();
protected final PackageFactory pkgFactory;
private final WorkspaceStatusAction.Factory workspaceStatusActionFactory;
private final FileSystem fileSystem;
protected final BlazeDirectories directories;
protected final ExternalFilesHelper externalFilesHelper;
protected final BugReporter bugReporter;
/**
* Measures source artifacts read this build. Does not include cached artifacts, so is less useful
* on incremental builds.
*/
private final FilesMetricConsumer sourceArtifactsSeen = new FilesMetricConsumer();
private final FilesMetricConsumer outputArtifactsSeen = new FilesMetricConsumer();
private final FilesMetricConsumer outputArtifactsFromActionCache = new FilesMetricConsumer();
private final FilesMetricConsumer topLevelArtifactsMetric = new FilesMetricConsumer();
@Nullable protected OutputService outputService;
// TODO(bazel-team): Figure out how to handle value builders that block internally. Blocking
// operations may need to be handled in another (bigger?) thread pool. Also, we should detect
// the number of cores and use that as the thread-pool size for CPU-bound operations.
// I just bumped this to 200 to get reasonable execution phase performance; that may cause
// significant overhead for CPU-bound processes (i.e. analysis). [skyframe-analysis]
public static final int DEFAULT_THREAD_COUNT =
// Reduce thread count while running tests of Bazel. Test cases are typically small, and large
// thread pools vying for a relatively small number of CPU cores may induce non-optimal
// performance.
TestType.isInTest() ? 5 : 200;
// The limit of how many times we will traverse through an exception chain when catching a
// target parsing exception.
private static final int EXCEPTION_TRAVERSAL_LIMIT = 10;
// Cache of parsed bzl files, for use when we're inlining BzlCompileFunction in
// BzlLoadFunction. See the comments in BzlLoadFunction for motivations and details.
private final Cache<BzlCompileValue.Key, BzlCompileValue> bzlCompileCache =
Caffeine.newBuilder().build();
private final AtomicInteger numPackagesSuccessfullyLoaded = new AtomicInteger(0);
@Nullable private final PackageProgressReceiver packageProgress;
@Nullable private final ConfiguredTargetProgressReceiver configuredTargetProgress;
final SyscallCache perCommandSyscallCache;
private final SkyframeBuildView skyframeBuildView;
private ActionLogBufferPathGenerator actionLogBufferPathGenerator;
private final Consumer<SkyframeExecutor> skyframeExecutorConsumerOnInit;
// AtomicReferences are used here as mutable boxes shared with value builders.
private final AtomicBoolean showLoadingProgress = new AtomicBoolean();
protected final AtomicReference<PathPackageLocator> pkgLocator = new AtomicReference<>();
protected final AtomicReference<ImmutableSet<PackageIdentifier>> deletedPackages =
new AtomicReference<>(ImmutableSet.of());
private final AtomicReference<EventBus> eventBus = new AtomicReference<>();
protected final AtomicReference<TimestampGranularityMonitor> tsgm = new AtomicReference<>();
protected final AtomicReference<Map<String, String>> clientEnv = new AtomicReference<>();
private final ArtifactFactory artifactFactory;
private final ActionKeyContext actionKeyContext;
protected boolean active = true;
private final SkyframePackageManager packageManager;
private final QueryTransitivePackagePreloader queryTransitivePackagePreloader;
/** Used to lock evaluator on legacy calls to get existing values. */
private final Object valueLookupLock = new Object();
private final AtomicReference<ActionExecutionStatusReporter> statusReporterRef =
new AtomicReference<>();
protected final SkyframeActionExecutor skyframeActionExecutor;
private ActionExecutionFunction actionExecutionFunction;
private GlobFunction globFunction;
protected SkyframeProgressReceiver progressReceiver;
private CyclesReporter cyclesReporter = null;
@VisibleForTesting boolean lastAnalysisDiscarded = false;
/**
* True if analysis was not incremental because {@link #handleAnalysisInvalidatingChange} was
* called, typically because a configuration-related option changed.
*/
private boolean analysisCacheInvalidated = false;
/** True if loading and analysis nodes were cleared (discarded) after analysis to save memory. */
private boolean analysisCacheCleared;
private final ImmutableMap<SkyFunctionName, SkyFunction> extraSkyFunctions;
protected SkyframeIncrementalBuildMonitor incrementalBuildMonitor =
new SkyframeIncrementalBuildMonitor();
private final SkyFunction ignoredPackagePrefixesFunction;
private final ConfiguredRuleClassProvider ruleClassProvider;
private final CrossRepositoryLabelViolationStrategy crossRepositoryLabelViolationStrategy;
private final ImmutableList<BuildFileName> buildFilesByPriority;
private final ExternalPackageHelper externalPackageHelper;
private final ActionOnIOExceptionReadingBuildFile actionOnIOExceptionReadingBuildFile;
private final boolean shouldUnblockCpuWorkWhenFetchingDeps;
private final SkyKeyStateReceiver skyKeyStateReceiver;
private final PathResolverFactory pathResolverFactory = new PathResolverFactoryImpl();
// A Semaphore to limit the number of in-flight execution of certain SkyFunctions to prevent OOM.
// TODO(b/185987566): Remove this semaphore.
private static final int DEFAULT_SEMAPHORE_SIZE = ResourceUsage.getAvailableProcessors();
private final AtomicReference<Semaphore> oomSensitiveSkyFunctionsSemaphore =
new AtomicReference<>(new Semaphore(DEFAULT_SEMAPHORE_SIZE));
private Map<String, String> lastRemoteDefaultExecProperties;
private RemoteOutputsMode lastRemoteOutputsMode;
private Boolean lastRemoteCacheEnabled;
// Reset after each build.
private IncrementalArtifactConflictFinder incrementalArtifactConflictFinder;
// Reset after each build.
private IncrementalTransitiveActionLookupKeysCollector
incrementalTransitiveActionLookupKeysCollector;
// A set of ActionLookupKeys which have been confirmed to be conflict-free. This is used for
// pruning while going through the ActionLookupKeys in the build for conflict checking.
// Reset after each build.
private Set<SkyKey> conflictFreeActionLookupKeysGlobalSet;
private RuleContextConstraintSemantics ruleContextConstraintSemantics;
class PathResolverFactoryImpl implements PathResolverFactory {
@Override
public boolean shouldCreatePathResolverForArtifactValues() {
return outputService != null && outputService.supportsPathResolverForArtifactValues();
}
@Override
public ArtifactPathResolver createPathResolverForArtifactValues(
ActionInputMap actionInputMap,
Map<Artifact, ImmutableCollection<? extends Artifact>> expandedArtifacts,
Map<Artifact, ImmutableList<FilesetOutputSymlink>> filesets,
String workspaceName) {
Preconditions.checkState(shouldCreatePathResolverForArtifactValues());
return outputService.createPathResolverForArtifactValues(
directories.getExecRoot(workspaceName).asFragment(),
directories.getRelativeOutputPath(),
fileSystem,
getPathEntries(),
actionInputMap,
expandedArtifacts,
filesets);
}
}
protected SkyframeExecutor(
Consumer<SkyframeExecutor> skyframeExecutorConsumerOnInit,
PackageFactory pkgFactory,
FileSystem fileSystem,
BlazeDirectories directories,
ActionKeyContext actionKeyContext,
Factory workspaceStatusActionFactory,
ImmutableMap<SkyFunctionName, SkyFunction> extraSkyFunctions,
SyscallCache perCommandSyscallCache,
ExternalFileAction externalFileAction,
SkyFunction ignoredPackagePrefixesFunction,
CrossRepositoryLabelViolationStrategy crossRepositoryLabelViolationStrategy,
ImmutableList<BuildFileName> buildFilesByPriority,
ExternalPackageHelper externalPackageHelper,
ActionOnIOExceptionReadingBuildFile actionOnIOExceptionReadingBuildFile,
boolean shouldUnblockCpuWorkWhenFetchingDeps,
@Nullable PackageProgressReceiver packageProgress,
@Nullable ConfiguredTargetProgressReceiver configuredTargetProgress,
SkyKeyStateReceiver skyKeyStateReceiver,
BugReporter bugReporter) {
// Strictly speaking, these arguments are not required for initialization, but all current
// callsites have them at hand, so we might as well set them during construction.
this.skyframeExecutorConsumerOnInit = skyframeExecutorConsumerOnInit;
this.pkgFactory = pkgFactory;
this.shouldUnblockCpuWorkWhenFetchingDeps = shouldUnblockCpuWorkWhenFetchingDeps;
this.skyKeyStateReceiver = skyKeyStateReceiver;
this.bugReporter = bugReporter;
this.perCommandSyscallCache = perCommandSyscallCache;
this.pkgFactory.setSyscallCache(this.perCommandSyscallCache);
this.workspaceStatusActionFactory = workspaceStatusActionFactory;
this.queryTransitivePackagePreloader =
new QueryTransitivePackagePreloader(
() -> memoizingEvaluator, this::newEvaluationContextBuilder, bugReporter);
this.packageManager =
new SkyframePackageManager(
new SkyframePackageLoader(),
this.perCommandSyscallCache,
pkgLocator::get,
numPackagesSuccessfullyLoaded);
this.fileSystem = fileSystem;
this.directories = Preconditions.checkNotNull(directories);
this.actionKeyContext = Preconditions.checkNotNull(actionKeyContext);
this.ignoredPackagePrefixesFunction = ignoredPackagePrefixesFunction;
this.extraSkyFunctions = extraSkyFunctions;
this.ruleClassProvider = (ConfiguredRuleClassProvider) pkgFactory.getRuleClassProvider();
this.skyframeActionExecutor =
new SkyframeActionExecutor(
actionKeyContext,
outputArtifactsSeen,
outputArtifactsFromActionCache,
statusReporterRef,
this::getPathEntries,
this.perCommandSyscallCache,
skyKeyStateReceiver::makeThreadStateReceiver);
this.artifactFactory =
new ArtifactFactory(
/*execRootParent=*/ directories.getExecRootBase(), directories.getRelativeOutputPath());
this.skyframeBuildView =
new SkyframeBuildView(artifactFactory, this, ruleClassProvider, actionKeyContext);
this.externalFilesHelper =
ExternalFilesHelper.create(pkgLocator, externalFileAction, directories);
this.crossRepositoryLabelViolationStrategy = crossRepositoryLabelViolationStrategy;
this.buildFilesByPriority = buildFilesByPriority;
this.externalPackageHelper = externalPackageHelper;
this.actionOnIOExceptionReadingBuildFile = actionOnIOExceptionReadingBuildFile;
this.packageProgress = packageProgress;
this.configuredTargetProgress = configuredTargetProgress;
}
private ImmutableMap<SkyFunctionName, SkyFunction> skyFunctions() {
BzlLoadFunction bzlLoadFunctionForInliningPackageAndWorkspaceNodes =
getBzlLoadFunctionForInliningPackageAndWorkspaceNodes();
// We don't check for duplicates in order to allow extraSkyfunctions to override existing
// entries.
Map<SkyFunctionName, SkyFunction> map = new HashMap<>();
// IF YOU ADD A NEW SKYFUNCTION: If your Skyfunction can be used transitively by package
// loading, make sure to register it in AbstractPackageLoader as well.
map.put(SkyFunctions.PRECOMPUTED, new PrecomputedFunction());
map.put(SkyFunctions.CLIENT_ENVIRONMENT_VARIABLE, new ClientEnvironmentFunction(clientEnv));
map.put(SkyFunctions.ACTION_ENVIRONMENT_VARIABLE, new ActionEnvironmentFunction());
map.put(FileStateKey.FILE_STATE, newFileStateFunction());
map.put(SkyFunctions.DIRECTORY_LISTING_STATE, newDirectoryListingStateFunction());
map.put(FileSymlinkCycleUniquenessFunction.NAME, new FileSymlinkCycleUniquenessFunction());
map.put(
FileSymlinkInfiniteExpansionUniquenessFunction.NAME,
new FileSymlinkInfiniteExpansionUniquenessFunction());
map.put(FileValue.FILE, new FileFunction(pkgLocator, directories));
map.put(SkyFunctions.DIRECTORY_LISTING, new DirectoryListingFunction());
map.put(
SkyFunctions.PACKAGE_LOOKUP,
new PackageLookupFunction(
deletedPackages,
crossRepositoryLabelViolationStrategy,
buildFilesByPriority,
externalPackageHelper));
map.put(SkyFunctions.CONTAINING_PACKAGE_LOOKUP, new ContainingPackageLookupFunction());
map.put(
SkyFunctions.BZL_COMPILE, // TODO rename
new BzlCompileFunction(pkgFactory, getDigestFunction().getHashFunction()));
map.put(SkyFunctions.STARLARK_BUILTINS, new StarlarkBuiltinsFunction(pkgFactory));
map.put(SkyFunctions.BZL_LOAD, newBzlLoadFunction(ruleClassProvider, pkgFactory));
GlobFunction globFunction = newGlobFunction();
map.put(SkyFunctions.GLOB, globFunction);
this.globFunction = globFunction;
map.put(SkyFunctions.TARGET_PATTERN, new TargetPatternFunction());
map.put(SkyFunctions.PREPARE_DEPS_OF_PATTERNS, new PrepareDepsOfPatternsFunction());
map.put(
SkyFunctions.PREPARE_DEPS_OF_PATTERN,
new PrepareDepsOfPatternFunction(pkgLocator, traverseTestSuites()));
map.put(
SkyFunctions.PREPARE_TEST_SUITES_UNDER_DIRECTORY,
new PrepareTestSuitesUnderDirectoryFunction(directories));
map.put(
SkyFunctions.PREPARE_DEPS_OF_TARGETS_UNDER_DIRECTORY,
new PrepareDepsOfTargetsUnderDirectoryFunction(directories));
map.put(SkyFunctions.COLLECT_TARGETS_IN_PACKAGE, new CollectTargetsInPackageFunction());
map.put(SkyFunctions.COLLECT_TEST_SUITES_IN_PACKAGE, new CollectTestSuitesInPackageFunction());
map.put(
SkyFunctions.COLLECT_PACKAGES_UNDER_DIRECTORY,
newCollectPackagesUnderDirectoryFunction(directories));
map.put(SkyFunctions.IGNORED_PACKAGE_PREFIXES, ignoredPackagePrefixesFunction);
map.put(SkyFunctions.TESTS_IN_SUITE, new TestExpansionFunction());
map.put(SkyFunctions.TEST_SUITE_EXPANSION, new TestsForTargetPatternFunction());
map.put(SkyFunctions.TARGET_PATTERN_PHASE, new TargetPatternPhaseFunction());
map.put(
SkyFunctions.PREPARE_ANALYSIS_PHASE, new PrepareAnalysisPhaseFunction(ruleClassProvider));
map.put(SkyFunctions.RECURSIVE_PKG, new RecursivePkgFunction(directories));
map.put(
SkyFunctions.PACKAGE,
new PackageFunction(
pkgFactory,
packageManager,
showLoadingProgress,
numPackagesSuccessfullyLoaded,
bzlLoadFunctionForInliningPackageAndWorkspaceNodes,
packageProgress,
actionOnIOExceptionReadingBuildFile,
getGlobbingStrategy(),
skyKeyStateReceiver::makeThreadStateReceiver));
map.put(SkyFunctions.PACKAGE_ERROR, new PackageErrorFunction());
map.put(SkyFunctions.PACKAGE_ERROR_MESSAGE, new PackageErrorMessageFunction());
map.put(SkyFunctions.TARGET_PATTERN_ERROR, new TargetPatternErrorFunction());
map.put(TransitiveTargetKey.NAME, new TransitiveTargetFunction());
map.put(Label.TRANSITIVE_TRAVERSAL, getTransitiveTraversalFunction());
map.put(
SkyFunctions.CONFIGURED_TARGET,
new ConfiguredTargetFunction(
new BuildViewProvider(),
ruleClassProvider,
oomSensitiveSkyFunctionsSemaphore,
shouldStoreTransitivePackagesInLoadingAndAnalysis(),
shouldUnblockCpuWorkWhenFetchingDeps,
configuredTargetProgress));
map.put(
SkyFunctions.ASPECT,
new AspectFunction(
new BuildViewProvider(),
ruleClassProvider,
shouldStoreTransitivePackagesInLoadingAndAnalysis()));
map.put(SkyFunctions.TOP_LEVEL_ASPECTS, new ToplevelStarlarkAspectFunction());
map.put(
SkyFunctions.BUILD_TOP_LEVEL_ASPECTS_DETAILS, new BuildTopLevelAspectsDetailsFunction());
map.put(SkyFunctions.ACTION_LOOKUP_CONFLICT_FINDING, new ActionLookupConflictFindingFunction());
map.put(
SkyFunctions.TOP_LEVEL_ACTION_LOOKUP_CONFLICT_FINDING,
new TopLevelActionLookupConflictFindingFunction());
map.put(
SkyFunctions.BUILD_CONFIGURATION,
new BuildConfigurationFunction(directories, ruleClassProvider));
map.put(SkyFunctions.WORKSPACE_NAME, new WorkspaceNameFunction());
map.put(
WorkspaceFileValue.WORKSPACE_FILE,
new WorkspaceFileFunction(
ruleClassProvider,
pkgFactory,
directories,
bzlLoadFunctionForInliningPackageAndWorkspaceNodes));
map.put(SkyFunctions.EXTERNAL_PACKAGE, new ExternalPackageFunction(externalPackageHelper));
map.put(
BzlmodRepoRuleValue.BZLMOD_REPO_RULE,
new BzlmodRepoRuleFunction(ruleClassProvider, directories, new BzlmodRepoRuleHelperImpl()));
map.put(
SkyFunctions.TARGET_COMPLETION,
TargetCompletor.targetCompletionFunction(
pathResolverFactory, skyframeActionExecutor, topLevelArtifactsMetric, bugReporter));
map.put(
SkyFunctions.ASPECT_COMPLETION,
AspectCompletor.aspectCompletionFunction(
pathResolverFactory, skyframeActionExecutor, topLevelArtifactsMetric, bugReporter));
map.put(SkyFunctions.TEST_COMPLETION, new TestCompletionFunction());
map.put(
Artifact.ARTIFACT,
new ArtifactFunction(
() -> !skyframeActionExecutor.actionFileSystemType().inMemoryFileSystem(),
sourceArtifactsSeen,
perCommandSyscallCache));
map.put(
SkyFunctions.BUILD_INFO_COLLECTION,
new BuildInfoCollectionFunction(actionKeyContext, artifactFactory));
map.put(SkyFunctions.BUILD_INFO, new WorkspaceStatusFunction(this::makeWorkspaceStatusAction));
map.put(SkyFunctions.COVERAGE_REPORT, new CoverageReportFunction(actionKeyContext));
ActionExecutionFunction actionExecutionFunction =
new ActionExecutionFunction(skyframeActionExecutor, directories, tsgm::get, bugReporter);
map.put(SkyFunctions.ACTION_EXECUTION, actionExecutionFunction);
this.actionExecutionFunction = actionExecutionFunction;
map.put(
SkyFunctions.RECURSIVE_FILESYSTEM_TRAVERSAL,
new RecursiveFilesystemTraversalFunction(perCommandSyscallCache));
map.put(SkyFunctions.FILESET_ENTRY, new FilesetEntryFunction(directories::getExecRoot));
map.put(
SkyFunctions.ACTION_TEMPLATE_EXPANSION,
new ActionTemplateExpansionFunction(actionKeyContext));
map.put(
SkyFunctions.LOCAL_REPOSITORY_LOOKUP,
new LocalRepositoryLookupFunction(externalPackageHelper));
map.put(
SkyFunctions.REGISTERED_EXECUTION_PLATFORMS, new RegisteredExecutionPlatformsFunction());
map.put(SkyFunctions.REGISTERED_TOOLCHAINS, new RegisteredToolchainsFunction());
map.put(SkyFunctions.SINGLE_TOOLCHAIN_RESOLUTION, new SingleToolchainResolutionFunction());
map.put(SkyFunctions.TOOLCHAIN_RESOLUTION, new ToolchainResolutionFunction());
map.put(SkyFunctions.REPOSITORY_MAPPING, new RepositoryMappingFunction());
map.put(SkyFunctions.RESOLVED_HASH_VALUES, new ResolvedHashesFunction());
map.put(SkyFunctions.RESOLVED_FILE, new ResolvedFileFunction());
map.put(
SkyFunctions.PLATFORM_MAPPING,
new PlatformMappingFunction(ruleClassProvider.getFragmentRegistry().getOptionsClasses()));
map.put(
SkyFunctions.ARTIFACT_NESTED_SET,
ArtifactNestedSetFunction.createInstance(valueBasedChangePruningEnabled()));
map.put(
SkyFunctions.BUILD_DRIVER,
new BuildDriverFunction(
new TransitiveActionLookupValuesHelper() {
@Override
public ActionLookupValuesCollectionResult collect(ActionLookupKey key)
throws InterruptedException {
return collectTransitiveActionLookupValues(key);
}
@Override
public void registerConflictFreeKeys(ImmutableSet<ActionLookupKey> keys) {
getConflictFreeActionLookupKeysGlobalSet().addAll(keys);
}
},
this::getIncrementalArtifactConflictFinder,
this::getRuleContextConstraintSemantics));
map.putAll(extraSkyFunctions);
return ImmutableMap.copyOf(map);
}
protected SkyFunction getTransitiveTraversalFunction() {
return new TransitiveTraversalFunction();
}
protected boolean traverseTestSuites() {
return false;
}
protected SkyFunction newFileStateFunction() {
return new FileStateFunction(tsgm::get, perCommandSyscallCache, externalFilesHelper);
}
protected SkyFunction newDirectoryListingStateFunction() {
return new DirectoryListingStateFunction(externalFilesHelper, perCommandSyscallCache);
}
protected GlobFunction newGlobFunction() {
return new GlobFunction(/*alwaysUseDirListing=*/ false);
}
protected SkyFunction newCollectPackagesUnderDirectoryFunction(BlazeDirectories directories) {
return new CollectPackagesUnderDirectoryFunction(directories);
}
protected boolean valueBasedChangePruningEnabled() {
return true;
}
@Nullable
protected BzlLoadFunction getBzlLoadFunctionForInliningPackageAndWorkspaceNodes() {
return null;
}
protected SkyFunction newBzlLoadFunction(
RuleClassProvider ruleClassProvider, PackageFactory pkgFactory) {
return BzlLoadFunction.create(
this.pkgFactory, directories, getDigestFunction().getHashFunction(), bzlCompileCache);
}
@ThreadCompatible
public void setActive(boolean active) {
this.active = active;
}
protected void checkActive() {
Preconditions.checkState(active);
}
public void configureActionExecutor(
MetadataProvider fileCache, ActionInputPrefetcher actionInputPrefetcher) {
skyframeActionExecutor.configure(
fileCache, actionInputPrefetcher, DiscoveredModulesPruner.DEFAULT);
}
@ForOverride
protected abstract void dumpPackages(PrintStream out);
public void setOutputService(OutputService outputService) {
this.outputService = outputService;
}
/** Inform this SkyframeExecutor that a new command is starting. */
public void noteCommandStart() {}
/** Notify listeners about changed files, and release any associated memory afterwards. */
public void drainChangedFiles() {
incrementalBuildMonitor.alertListeners(getEventBus());
incrementalBuildMonitor = null;
}
/**
* Was there an analysis-invalidating change, like a configuration option changing, causing a
* non-incremental analysis phase to be performed. Calling this resets the state to false.
*/
public final boolean wasAnalysisCacheInvalidatedAndResetBit() {
boolean tmp = analysisCacheInvalidated;
analysisCacheInvalidated = false;
return tmp;
}
/** Was the analysis (and loading) cache cleared to save memory before execution. */
public final boolean wasAnalysisCacheCleared() {
return analysisCacheCleared;
}
/**
* This method exists only to allow a module to make a top-level Skyframe call during the
* transition to making it fully Skyframe-compatible. Do not add additional callers!
*/
public final SkyValue evaluateSkyKeyForExecutionSetup(
final ExtendedEventHandler eventHandler, final SkyKey key)
throws EnvironmentalExecException, InterruptedException {
synchronized (valueLookupLock) {
// We evaluate in keepGoing mode because in the case that the graph does not store its
// edges, nokeepGoing builds are not allowed, whereas keepGoing builds are always
// permitted.
EvaluationResult<?> result =
evaluate(
ImmutableList.of(key), true, ResourceUsage.getAvailableProcessors(), eventHandler);
if (!result.hasError()) {
return Preconditions.checkNotNull(result.get(key), "%s %s", result, key);
}
ErrorInfo errorInfo = Preconditions.checkNotNull(result.getError(key), "%s %s", key, result);
Throwables.propagateIfPossible(errorInfo.getException(), EnvironmentalExecException.class);
if (errorInfo.getException() != null) {
throw new IllegalStateException(errorInfo.getException());
}
throw new IllegalStateException(errorInfo.toString());
}
}
final class BuildViewProvider {
/** Returns the current {@link SkyframeBuildView} instance. */
SkyframeBuildView getSkyframeBuildView() {
return skyframeBuildView;
}
}
/**
* Must be called before the {@link SkyframeExecutor} can be used (should only be called in
* factory methods and as an implementation detail of {@link #resetEvaluator}).
*/
protected final void init() {
progressReceiver = newSkyframeProgressReceiver();
memoizingEvaluator =
createEvaluator(
skyFunctions(), progressReceiver, DEFAULT_FILTER_WITH_ACTIONS, emittedEventState);
skyframeExecutorConsumerOnInit.accept(this);
// Initialize the various conflict-finding states. This is unconditionally created but only used
// with Skymeld i.e. --experimental_merged_skyframe_analysis_execution.
incrementalArtifactConflictFinder =
IncrementalArtifactConflictFinder.createWithActionGraph(
new MapBasedActionGraph(actionKeyContext));
conflictFreeActionLookupKeysGlobalSet = Sets.newConcurrentHashSet();
incrementalTransitiveActionLookupKeysCollector =
new IncrementalTransitiveActionLookupKeysCollector(
SkyframeExecutorWrappingWalkableGraph.of(this), conflictFreeActionLookupKeysGlobalSet);
}
@ForOverride
protected abstract MemoizingEvaluator createEvaluator(
ImmutableMap<SkyFunctionName, SkyFunction> skyFunctions,
SkyframeProgressReceiver progressReceiver,
EventFilter eventFilter,
EmittedEventState emittedEventState);
/**
* Use the fact that analysis of a target must occur before execution of that target, and in a
* separate Skyframe evaluation, to avoid propagating events from configured target nodes (and
* more generally action lookup nodes) to action execution nodes. We take advantage of the fact
* that if a node depends on an action lookup node and is not itself an action lookup node, then
* it is an execution-phase node: the action lookup nodes are terminal in the analysis phase.
*/
private static final EventFilter DEFAULT_FILTER_WITH_ACTIONS =
new EventFilter() {
@Override
public boolean storeEventsAndPosts() {
return true;
}
@Override
public boolean test(Event input) {
// Use the filtering defined in the default filter: no info/progress messages.
return InMemoryMemoizingEvaluator.DEFAULT_STORED_EVENT_FILTER.test(input);
}
@Override
public boolean shouldPropagate(SkyKey depKey, SkyKey primaryKey) {
// Do not propagate events from analysis phase nodes to execution phase nodes.
return isAnalysisPhaseKey(primaryKey) || !isAnalysisPhaseKey(depKey);
}
};
private static boolean isAnalysisPhaseKey(SkyKey key) {
return key instanceof ActionLookupKey && !(key instanceof ActionTemplateExpansionKey);
}
protected SkyframeProgressReceiver newSkyframeProgressReceiver() {
return new SkyframeProgressReceiver();
}
/** Reinitializes the Skyframe evaluator, dropping all previously computed values. */
public void resetEvaluator() {
init();
emittedEventState.clear();
skyframeBuildView.reset();
}
/**
* Notifies the executor that the command is complete. May safely be called multiple times for a
* single command, so callers should err on the side of calling it more frequently. Should be
* idempotent, so that calls after the first one in the same evaluation should be quick.
*/
public void notifyCommandComplete(ExtendedEventHandler eventHandler) throws InterruptedException {
memoizingEvaluator.noteEvaluationsAtSameVersionMayBeFinished(eventHandler);
globFunction.complete();
}
/**
* Notifies the executor to post logging stats when the server is crashing, so that logging is
* still available even when the server crashes.
*/
public void postLoggingStatsWhenCrashing(ExtendedEventHandler eventHandler) {
memoizingEvaluator.postLoggingStats(eventHandler);
}
/** Clear any configured target data stored outside Skyframe. */
public void handleAnalysisInvalidatingChange() {
logger.atInfo().log("Dropping configured target data");
analysisCacheInvalidated = true;
skyframeBuildView.clearInvalidatedActionLookupKeys();
skyframeBuildView.clearLegacyData();
ArtifactNestedSetFunction.getInstance().resetArtifactNestedSetFunctionMaps();
}
/** Used with dump --rules. */
public static class RuleStat {
private final String key;
private final String name;
private final boolean isRule;
private long count;
private long actionCount;
public RuleStat(String key, String name, boolean isRule) {
this.key = key;
this.name = name;
this.isRule = isRule;
}
public void addRule(long actionCount) {
this.count++;
this.actionCount += actionCount;
}
/** Returns a key that uniquely identifies this rule or aspect. */
public String getKey() {
return key;
}
/** Returns a name for the rule or aspect. */
public String getName() {
return name;
}
/** Returns whether this is a rule or an aspect. */
public boolean isRule() {
return isRule;
}
/** Returns the instance count of this rule or aspect class. */
public long getCount() {
return count;
}
/** Returns the total action count of all instance of this rule or aspect class. */
public long getActionCount() {
return actionCount;
}
}
/** Computes statistics on heap-resident rules and aspects. */
public abstract List<RuleStat> getRuleStats(ExtendedEventHandler eventHandler)
throws InterruptedException;
/**
* Decides if graph edges should be stored during this evaluation and checks if the state from the
* last evaluation, if any, can be kept.
*
* <p>If not, it will mark this state for deletion. The actual cleaning is put off until {@link
* #sync}, in case no evaluation was actually called for and the existing state can be kept for
* longer.
*/
public void decideKeepIncrementalState(
boolean batch,
boolean keepStateAfterBuild,
boolean trackIncrementalState,
boolean discardAnalysisCache,
EventHandler eventHandler) {
// Assume incrementality.
}
/**
* Whether this executor tracks state for the purpose of improving incremental performance.
*
* <p>A return of {@code false} indicates that nodes have a lifetime of a single command and that
* graph edges are not kept.
*/
public boolean tracksStateForIncrementality() {
return true;
}
@ForOverride
protected GlobbingStrategy getGlobbingStrategy() {
return tracksStateForIncrementality()
? GlobbingStrategy.SKYFRAME_HYBRID
: GlobbingStrategy.NON_SKYFRAME;
}
@ForOverride
protected boolean shouldDeleteActionNodesWhenDroppingAnalysis() {
return true;
}
/**
* If not null, this is the only source root in the build, corresponding to the single element in
* a single-element package path. Such a single-source-root build need not plant the execroot
* symlink forest, and can trivially resolve source artifacts from exec paths. As a consequence,
* builds where this is not null do not need to track a package -> source root map, and so do not
* need to track all loaded packages.
*/
@Nullable
protected Root getForcedSingleSourceRootIfNoExecrootSymlinkCreation() {
return null;
}
private boolean shouldStoreTransitivePackagesInLoadingAndAnalysis() {
return getForcedSingleSourceRootIfNoExecrootSymlinkCreation() == null;
}
@VisibleForTesting
protected abstract Injectable injectable();
/**
* Types that are created during loading, use significant space, and are definitely not needed
* during execution unless explicitly named.
*
* <p>Some keys, like globs, may be re-evaluated during execution, so these types should only be
* discarded if reverse deps are not being tracked!
*/
private static final ImmutableSet<SkyFunctionName> LOADING_TYPES =
ImmutableSet.of(
SkyFunctions.PACKAGE, SkyFunctions.BZL_LOAD, SkyFunctions.BZL_COMPILE, SkyFunctions.GLOB);
/** Data that should be discarded in {@link #discardPreExecutionCache}. */
protected enum DiscardType {
ALL,
ANALYSIS_REFS_ONLY,
LOADING_NODES_ONLY;
boolean discardsAnalysis() {
return this != LOADING_NODES_ONLY;
}
boolean discardsLoading() {
return this != ANALYSIS_REFS_ONLY;
}
}
/**
* Save memory by removing references to configured targets and aspects in Skyframe.
*
* <p>These nodes must be recreated on subsequent builds. We do not clear the top-level target
* nodes, since their configured targets are needed for the target completion middleman values.
*
* <p>The nodes are not deleted during this method call, because they are needed for the execution
* phase. Instead, their analysis-time data is cleared while preserving the generating action info
* needed for execution. The next build will delete the nodes (and recreate them if necessary).
*
* <p>{@code discardType} can be used to specify which data to discard.
*/
protected void discardPreExecutionCache(
Collection<ConfiguredTarget> topLevelTargets,
ImmutableSet<AspectKey> topLevelAspects,
DiscardType discardType) {
if (discardType.discardsAnalysis()) {
topLevelTargets = ImmutableSet.copyOf(topLevelTargets);
topLevelAspects = ImmutableSet.copyOf(topLevelAspects);
}
// This is to prevent throwing away Packages we may need during execution.
ImmutableSet.Builder<PackageIdentifier> packageSetBuilder = ImmutableSet.builder();
if (discardType.discardsLoading()) {
packageSetBuilder.addAll(
Collections2.transform(
topLevelTargets, target -> target.getLabel().getPackageIdentifier()));
packageSetBuilder.addAll(
Collections2.transform(
topLevelAspects, aspect -> aspect.getLabel().getPackageIdentifier()));
}
ImmutableSet<PackageIdentifier> topLevelPackages = packageSetBuilder.build();
try (SilentCloseable p = trackDiscardAnalysisCache()) {
lastAnalysisDiscarded = true;
Iterator<? extends Map.Entry<SkyKey, ? extends NodeEntry>> it =
memoizingEvaluator.getGraphEntries().iterator();
while (it.hasNext()) {
Map.Entry<SkyKey, ? extends NodeEntry> keyAndEntry = it.next();
NodeEntry entry = keyAndEntry.getValue();
if (entry == null || !entry.isDone()) {
continue;
}
SkyKey key = keyAndEntry.getKey();
SkyFunctionName functionName = key.functionName();
if (discardType.discardsLoading()) {
// Keep packages for top-level targets and aspects in memory to get the target from later.
if (functionName.equals(SkyFunctions.PACKAGE)
&& topLevelPackages.contains(key.argument())) {
continue;
}
if (LOADING_TYPES.contains(functionName)) {
it.remove();
continue;
}
}
if (discardType.discardsAnalysis()) {
if (functionName.equals(SkyFunctions.CONFIGURED_TARGET)) {
ConfiguredTargetValue ctValue;
try {
ctValue = (ConfiguredTargetValue) entry.getValue();
} catch (InterruptedException e) {
throw new IllegalStateException(
"No interruption in in-memory retrieval: " + entry, e);
}
// ctValue may be null if target was not successfully analyzed.
if (ctValue != null) {
if (!(ctValue instanceof ActionLookupValue)
&& discardType.discardsLoading()
&& !topLevelTargets.contains(ctValue.getConfiguredTarget())) {
// If loading is already being deleted, deleting these nodes doesn't hurt. Morally
// we should always be able to delete these, since they're not used for execution,
// but it leaves the graph inconsistent, and the --discard_analysis_cache with
// --track_incremental_state case isn't worth optimizing for.
it.remove();
} else {
ctValue.clear(!topLevelTargets.contains(ctValue.getConfiguredTarget()));
}
}
} else if (functionName.equals(SkyFunctions.ASPECT)) {
AspectValue aspectValue;
try {
aspectValue = (AspectValue) entry.getValue();
} catch (InterruptedException e) {
throw new IllegalStateException(
"No interruption in in-memory retrieval: " + entry, e);
}
// value may be null if target was not successfully analyzed.
if (aspectValue != null) {
aspectValue.clear(!topLevelAspects.contains(key));
}
}
}
}
}
}
/** Tracks how long it takes to clear the analysis cache. */
private final SilentCloseable trackDiscardAnalysisCache() {
AutoProfiler profiler = GoogleAutoProfilerUtils.logged("discarding analysis cache");
return () -> {
Duration d = Duration.ofNanos(profiler.completeAndGetElapsedTimeNanos());
getEventBus().post(new AnalysisCacheClearEvent(d));
};
}
/**
* Saves memory by clearing analysis objects from Skyframe. Clears their data without deleting
* them (they will be deleted on the next build). May also delete loading-phase objects from the
* graph.
*/
// VisibleForTesting but open-source annotation doesn't have productionVisibility option.
public final void clearAnalysisCache(
Collection<ConfiguredTarget> topLevelTargets, ImmutableSet<AspectKey> topLevelAspects) {
this.analysisCacheCleared = true;
clearAnalysisCacheImpl(topLevelTargets, topLevelAspects);
}
protected abstract void clearAnalysisCacheImpl(
Collection<ConfiguredTarget> topLevelTargets, ImmutableSet<AspectKey> topLevelAspects);
protected abstract void dropConfiguredTargetsNow(final ExtendedEventHandler eventHandler);
protected final void deleteAnalysisNodes() {
memoizingEvaluator.delete(
shouldDeleteActionNodesWhenDroppingAnalysis()
? SkyframeExecutor::analysisInvalidatingPredicateWithActions
: SkyframeExecutor::analysisInvalidatingPredicate);
}
// We delete any value that can hold an action -- all subclasses of ActionLookupKey.
// Also remove ArtifactNestedSetValues to prevent memory leak (b/143940221).
// Also BuildConfigurationKey to prevent memory leak (b/191875929).
private static boolean analysisInvalidatingPredicate(SkyKey key) {
return key instanceof ArtifactNestedSetKey
|| key instanceof ActionLookupKey
|| key instanceof BuildConfigurationKey;
}
// Also remove ActionLookupData since all such nodes depend on ActionLookupKey nodes and deleting
// en masse is cheaper than deleting via graph traversal (b/192863968).
private static boolean analysisInvalidatingPredicateWithActions(SkyKey key) {
return analysisInvalidatingPredicate(key) || key instanceof ActionLookupData;
}
private WorkspaceStatusAction makeWorkspaceStatusAction(String workspaceName) {
WorkspaceStatusAction.Environment env =
new WorkspaceStatusAction.Environment() {
@Override
public Artifact createStableArtifact(String name) {
ArtifactRoot root = directories.getBuildDataDirectory(workspaceName);
return skyframeBuildView
.getArtifactFactory()
.getDerivedArtifact(
PathFragment.create(name), root, WorkspaceStatusValue.BUILD_INFO_KEY);
}
@Override
public Artifact createVolatileArtifact(String name) {
ArtifactRoot root = directories.getBuildDataDirectory(workspaceName);
return skyframeBuildView
.getArtifactFactory()
.getConstantMetadataArtifact(
PathFragment.create(name), root, WorkspaceStatusValue.BUILD_INFO_KEY);
}
};
return workspaceStatusActionFactory.createWorkspaceStatusAction(env);
}
public void injectCoverageReportData(Actions.GeneratingActions actions) {
CoverageReportFunction.COVERAGE_REPORT_KEY.set(injectable(), actions.getActions());
}
private void setDefaultVisibility(RuleVisibility defaultVisibility) {
PrecomputedValue.DEFAULT_VISIBILITY.set(injectable(), defaultVisibility);
}
private void setConfigSettingVisibilityPolicty(ConfigSettingVisibilityPolicy policy) {
PrecomputedValue.CONFIG_SETTING_VISIBILITY_POLICY.set(injectable(), policy);
}
private void setStarlarkSemantics(StarlarkSemantics starlarkSemantics) {
PrecomputedValue.STARLARK_SEMANTICS.set(injectable(), starlarkSemantics);
}
public void setBaselineConfiguration(BuildOptions buildOptions) {
PrecomputedValue.BASELINE_CONFIGURATION.set(injectable(), buildOptions);
}
public void injectExtraPrecomputedValues(List<PrecomputedValue.Injected> extraPrecomputedValues) {
for (PrecomputedValue.Injected injected : extraPrecomputedValues) {
injected.inject(injectable());
}
}
private void setShowLoadingProgress(boolean showLoadingProgressValue) {
showLoadingProgress.set(showLoadingProgressValue);
}
protected void setCommandId(UUID commandId) {
PrecomputedValue.BUILD_ID.set(injectable(), commandId);
}
/** Returns the build-info.txt and build-changelist.txt artifacts. */
public Collection<Artifact> getWorkspaceStatusArtifacts(ExtendedEventHandler eventHandler)
throws InterruptedException {
// Should already be present, unless the user didn't request any targets for analysis.
EvaluationResult<WorkspaceStatusValue> result =
evaluate(
ImmutableList.of(WorkspaceStatusValue.BUILD_INFO_KEY),
/*keepGoing=*/ true,
/*numThreads=*/ 1,
eventHandler);
WorkspaceStatusValue value =
Preconditions.checkNotNull(result.get(WorkspaceStatusValue.BUILD_INFO_KEY));
return ImmutableList.of(value.getStableArtifact(), value.getVolatileArtifact());
}
@VisibleForTesting
public SkyFunctionEnvironmentForTesting getSkyFunctionEnvironmentForTesting(
ExtendedEventHandler eventHandler) {
return new SkyFunctionEnvironmentForTesting(eventHandler, this);
}
public EventBus getEventBus() {
return eventBus.get();
}
@VisibleForTesting
ImmutableList<Root> getPathEntries() {
return pkgLocator.get().getPathEntries();
}
public AtomicReference<PathPackageLocator> getPackageLocator() {
return pkgLocator;
}
protected abstract void invalidate(Predicate<SkyKey> pred);
protected Differencer.Diff getDiff(
TimestampGranularityMonitor tsgm,
ModifiedFileSet modifiedFileSet,
final Root pathEntry,
int fsvcThreads)
throws InterruptedException, AbruptExitException {
if (modifiedFileSet.modifiedSourceFiles().isEmpty()) {
return new ImmutableDiff(ImmutableList.of(), ImmutableMap.of());
}
// TODO(bazel-team): change ModifiedFileSet to work with RootedPaths instead of PathFragments.
Collection<FileStateKey> dirtyFileStateSkyKeys =
Collections2.transform(
modifiedFileSet.modifiedSourceFiles(),
pathFragment -> {
Preconditions.checkState(
!pathFragment.isAbsolute(), "found absolute PathFragment: %s", pathFragment);
return FileStateValue.key(RootedPath.toRootedPath(pathEntry, pathFragment));
});
Map<SkyKey, SkyValue> valuesMap = memoizingEvaluator.getValues();
return FileSystemValueCheckerInferringAncestors.getDiffWithInferredAncestors(
tsgm,
valuesMap,
memoizingEvaluator.getDoneValues(),
dirtyFileStateSkyKeys,
fsvcThreads,
perCommandSyscallCache);
}
/**
* Deletes all loaded packages and their upwards transitive closure, forcing reevaluation of all
* affected nodes.
*/
public void clearLoadedPackages() {
memoizingEvaluator.delete(k -> SkyFunctions.PACKAGE.equals(k.functionName()));
}
/** Sets the packages that should be treated as deleted and ignored. */
@VisibleForTesting // productionVisibility = Visibility.PRIVATE
public abstract void setDeletedPackages(Iterable<PackageIdentifier> pkgs);
/**
* Prepares the evaluator for loading.
*
* <p>MUST be run before every incremental build.
*/
@VisibleForTesting // productionVisibility = Visibility.PRIVATE
public void preparePackageLoading(
PathPackageLocator pkgLocator,
PackageOptions packageOptions,
BuildLanguageOptions buildLanguageOptions,
UUID commandId,
Map<String, String> clientEnv,
TimestampGranularityMonitor tsgm) {
Preconditions.checkNotNull(pkgLocator);
Preconditions.checkNotNull(tsgm);
setActive(true);
this.tsgm.set(tsgm);
setCommandId(commandId);
this.clientEnv.set(clientEnv);
setShowLoadingProgress(packageOptions.showLoadingProgress);
setDefaultVisibility(packageOptions.defaultVisibility);
if (!packageOptions.enforceConfigSettingVisibility) {
setConfigSettingVisibilityPolicty(ConfigSettingVisibilityPolicy.LEGACY_OFF);
} else {
setConfigSettingVisibilityPolicty(
packageOptions.configSettingPrivateDefaultVisibility
? ConfigSettingVisibilityPolicy.DEFAULT_STANDARD
: ConfigSettingVisibilityPolicy.DEFAULT_PUBLIC);
}
StarlarkSemantics starlarkSemantics = getEffectiveStarlarkSemantics(buildLanguageOptions);
setStarlarkSemantics(starlarkSemantics);
setSiblingDirectoryLayout(
starlarkSemantics.getBool(BuildLanguageOptions.EXPERIMENTAL_SIBLING_REPOSITORY_LAYOUT));
setPackageLocator(pkgLocator);
perCommandSyscallCache.clear();
this.pkgFactory.setGlobbingThreads(packageOptions.globbingThreads);
this.pkgFactory.setMaxDirectoriesToEagerlyVisitInGlobbing(
packageOptions.maxDirectoriesToEagerlyVisitInGlobbing);
emittedEventState.clear();
// Clear internal caches used by SkyFunctions used for package loading. If the SkyFunctions
// never had a chance to restart (e.g. due to user interrupt, or an error in a --nokeep_going
// build), these may have stale entries.
bzlCompileCache.invalidateAll();
numPackagesSuccessfullyLoaded.set(0);
if (packageProgress != null) {
packageProgress.reset();
}
// Reset the stateful SkyframeCycleReporter, which contains cycles from last run.
cyclesReporter = createCyclesReporter();
analysisCacheCleared = false;
}
private void setSiblingDirectoryLayout(boolean experimentalSiblingRepositoryLayout) {
this.artifactFactory.setSiblingRepositoryLayout(experimentalSiblingRepositoryLayout);
}
public StarlarkSemantics getEffectiveStarlarkSemantics(
BuildLanguageOptions buildLanguageOptions) {
return buildLanguageOptions.toStarlarkSemantics();
}
private void setPackageLocator(PathPackageLocator pkgLocator) {
EventBus eventBus = this.eventBus.get();
if (eventBus != null) {
eventBus.post(pkgLocator);
}
PathPackageLocator oldLocator = this.pkgLocator.getAndSet(pkgLocator);
PrecomputedValue.PATH_PACKAGE_LOCATOR.set(injectable(), pkgLocator);
if (!pkgLocator.equals(oldLocator)) {
// The package path is read not only by SkyFunctions but also by some other code paths.
// We need to take additional steps to keep the corresponding data structures in sync.
// (Some of the additional steps are carried out by ConfiguredTargetValueInvalidationListener,
// and some by BuildView#buildHasIncompatiblePackageRoots and #updateSkyframe.)
onPkgLocatorChange(oldLocator, pkgLocator);
}
}
protected abstract void onPkgLocatorChange(
PathPackageLocator oldLocator, PathPackageLocator pkgLocator);
public SkyframeBuildView getSkyframeBuildView() {
return skyframeBuildView;
}
/** Sets the eventBus to use for posting events. */
public void setEventBus(@Nullable EventBus eventBus) {
this.eventBus.set(eventBus);
}
public void setClientEnv(Map<String, String> clientEnv) {
this.skyframeActionExecutor.setClientEnv(clientEnv);
}
/** Sets the path for action log buffers. */
@Deprecated
public void setActionOutputRoot(Path actionOutputRoot) {
setActionOutputRoot(actionOutputRoot, actionOutputRoot);
}
/** Sets the path for action log buffers. */
public void setActionOutputRoot(Path actionOutputRoot, Path persistentActionOutputRoot) {
Preconditions.checkNotNull(actionOutputRoot);
this.actionLogBufferPathGenerator =
new ActionLogBufferPathGenerator(actionOutputRoot, persistentActionOutputRoot);
this.skyframeActionExecutor.setActionLogBufferPathGenerator(actionLogBufferPathGenerator);
}
private void setRemoteExecutionEnabled(boolean enabled) {
PrecomputedValue.REMOTE_EXECUTION_ENABLED.set(injectable(), enabled);
}
/** Called when a top-level configuration is determined. */
protected void setTopLevelConfiguration(BuildConfigurationCollection topLevelConfiguration) {}
/**
* Asks the Skyframe evaluator to build the value for BuildConfigurationCollection and returns the
* result.
*/
// TODO(ulfjack): Remove this legacy method after switching to the Skyframe-based implementation.
public BuildConfigurationCollection createConfigurations(
ExtendedEventHandler eventHandler,
BuildOptions buildOptions,
Set<String> multiCpu,
boolean keepGoing)
throws InvalidConfigurationException {
if (configuredTargetProgress != null) {
configuredTargetProgress.reset();
}
ImmutableList<BuildConfigurationValue> topLevelTargetConfigs =
getConfigurations(
eventHandler,
PrepareAnalysisPhaseFunction.getTopLevelBuildOptions(buildOptions, multiCpu),
buildOptions,
keepGoing);
BuildConfigurationValue firstTargetConfig = topLevelTargetConfigs.get(0);
BuildOptionsView hostTransitionOptionsView =
new BuildOptionsView(
firstTargetConfig.getOptions(), HostTransition.INSTANCE.requiresOptionFragments());
BuildOptions hostOptions =
HostTransition.INSTANCE.patch(hostTransitionOptionsView, eventHandler);
BuildConfigurationValue hostConfig = getConfiguration(eventHandler, hostOptions, keepGoing);
// TODO(gregce): cache invalid option errors in BuildConfigurationFunction, then use a dedicated
// accessor (i.e. not the event handler) to trigger the exception below.
ErrorSensingEventHandler<Void> nosyEventHandler =
ErrorSensingEventHandler.withoutPropertyValueTracking(eventHandler);
topLevelTargetConfigs.forEach(config -> config.reportInvalidOptions(nosyEventHandler));
if (nosyEventHandler.hasErrors()) {
throw new InvalidConfigurationException(
"Build options are invalid", Code.INVALID_BUILD_OPTIONS);
}
return new BuildConfigurationCollection(topLevelTargetConfigs, hostConfig);
}
/**
* Asks the Skyframe evaluator to build the given artifacts and targets, and to test the given
* parallel test targets. Additionally, exclusive tests are built together with all the other
* tests but they are intentionally *not* run since they must be executed separately one-by-one.
*/
public EvaluationResult<?> buildArtifacts(
Reporter reporter,
ResourceManager resourceManager,
Executor executor,
Set<Artifact> artifactsToBuild,
Collection<ConfiguredTarget> targetsToBuild,
ImmutableSet<AspectKey> aspects,
Set<ConfiguredTarget> parallelTests,
Set<ConfiguredTarget> exclusiveTests,
OptionsProvider options,
ActionCacheChecker actionCacheChecker,
@Nullable EvaluationProgressReceiver executionProgressReceiver,
TopLevelArtifactContext topLevelArtifactContext)
throws InterruptedException, AbruptExitException {
checkActive();
Preconditions.checkState(actionLogBufferPathGenerator != null);
deleteActionsIfRemoteOptionsChanged(options);
try (SilentCloseable c =
Profiler.instance().profile("skyframeActionExecutor.prepareForExecution")) {
prepareSkyframeActionExecutorForExecution(reporter, executor, options, actionCacheChecker);
}
resourceManager.resetResourceUsage();
try {
setExecutionProgressReceiver(executionProgressReceiver);
Iterable<TargetCompletionValue.TargetCompletionKey> targetKeys =
TargetCompletionValue.keys(
targetsToBuild, topLevelArtifactContext, Sets.union(parallelTests, exclusiveTests));
Iterable<SkyKey> aspectKeys = AspectCompletionValue.keys(aspects, topLevelArtifactContext);
Iterable<SkyKey> testKeys =
TestCompletionValue.keys(
parallelTests, topLevelArtifactContext, /*exclusiveTesting=*/ false);
EvaluationContext evaluationContext =
newEvaluationContextBuilder()
.setKeepGoing(options.getOptions(KeepGoingOption.class).keepGoing)
.setNumThreads(options.getOptions(BuildRequestOptions.class).jobs)
.setUseForkJoinPool(options.getOptions(BuildRequestOptions.class).useForkJoinPool)
.setEventHandler(reporter)
.setExecutionPhase()
.build();
return memoizingEvaluator.evaluate(
Iterables.concat(Artifact.keys(artifactsToBuild), targetKeys, aspectKeys, testKeys),
evaluationContext);
} finally {
// Also releases thread locks.
resourceManager.resetResourceUsage();
cleanUpAfterSingleEvaluationWithActionExecution(reporter);
}
}
public void setExecutionProgressReceiver(
@Nullable EvaluationProgressReceiver executionProgressReceiver) {
progressReceiver.executionProgressReceiver = executionProgressReceiver;
}
public void prepareSkyframeActionExecutorForExecution(
Reporter reporter,
Executor executor,
OptionsProvider options,
ActionCacheChecker actionCacheChecker) {
skyframeActionExecutor.prepareForExecution(
reporter,
executor,
options,
actionCacheChecker,
outputService,
tracksStateForIncrementality());
}
/** Asks the Skyframe evaluator to run a single exclusive test. */
public EvaluationResult<?> runExclusiveTest(
Reporter reporter,
ResourceManager resourceManager,
Executor executor,
ConfiguredTarget exclusiveTest,
OptionsProvider options,
ActionCacheChecker actionCacheChecker,
TopLevelArtifactContext topLevelArtifactContext)
throws InterruptedException {
checkActive();
Preconditions.checkState(actionLogBufferPathGenerator != null);
try (SilentCloseable c =
Profiler.instance().profile("skyframeActionExecutor.prepareForExecution")) {
prepareSkyframeActionExecutorForExecution(reporter, executor, options, actionCacheChecker);
}
resourceManager.resetResourceUsage();
try {
Iterable<SkyKey> testKeys =
TestCompletionValue.keys(
ImmutableSet.of(exclusiveTest), topLevelArtifactContext, /*exclusiveTesting=*/ true);
return evaluate(
testKeys,
/*keepGoing=*/ options.getOptions(KeepGoingOption.class).keepGoing,
/*numThreads=*/ options.getOptions(BuildRequestOptions.class).jobs,
reporter);
} finally {
// Also releases thread locks.
resourceManager.resetResourceUsage();
cleanUpAfterSingleEvaluationWithActionExecution(reporter);
}
}
@VisibleForTesting
public void prepareBuildingForTestingOnly(
Reporter reporter, Executor executor, OptionsProvider options, ActionCacheChecker checker) {
prepareSkyframeActionExecutorForExecution(reporter, executor, options, checker);
}
private void deleteActionsIfRemoteOptionsChanged(OptionsProvider options)
throws AbruptExitException {
RemoteOptions remoteOptions = options.getOptions(RemoteOptions.class);
Map<String, String> remoteDefaultExecProperties;
try {
remoteDefaultExecProperties =
remoteOptions != null
? remoteOptions.getRemoteDefaultExecProperties()
: ImmutableMap.of();
} catch (UserExecException e) {
throw new AbruptExitException(
DetailedExitCode.of(
FailureDetail.newBuilder()
.setMessage(e.getMessage())
.setRemoteOptions(
FailureDetails.RemoteOptions.newBuilder()
.setCode(
FailureDetails.RemoteOptions.Code
.REMOTE_DEFAULT_EXEC_PROPERTIES_LOGIC_ERROR)
.build())
.build()),
e);
}
boolean needsDeletion =
lastRemoteDefaultExecProperties != null
&& !remoteDefaultExecProperties.equals(lastRemoteDefaultExecProperties);
lastRemoteDefaultExecProperties = remoteDefaultExecProperties;
boolean remoteCacheEnabled = remoteOptions != null && remoteOptions.isRemoteCacheEnabled();
// If we have remote metadata from last build, and the remote cache is not
// enabled in this build, invalidate actions since they can't download those
// remote files.
//
// TODO(chiwang): Re-evaluate this after action rewinding is implemented in
// Bazel since we can treat that case as lost inputs.
if (lastRemoteOutputsMode != RemoteOutputsMode.ALL) {
needsDeletion |=
lastRemoteCacheEnabled != null && lastRemoteCacheEnabled && !remoteCacheEnabled;
}
lastRemoteCacheEnabled = remoteCacheEnabled;
RemoteOutputsMode remoteOutputsMode =
remoteOptions != null ? remoteOptions.remoteOutputsMode : RemoteOutputsMode.ALL;
needsDeletion |= lastRemoteOutputsMode != null && lastRemoteOutputsMode != remoteOutputsMode;
this.lastRemoteOutputsMode = remoteOutputsMode;
if (needsDeletion) {
memoizingEvaluator.delete(k -> SkyFunctions.ACTION_EXECUTION.equals(k.functionName()));
}
}
EvaluationResult<SkyValue> targetPatterns(
Iterable<? extends SkyKey> patternSkyKeys,
int numThreads,
boolean keepGoing,
ExtendedEventHandler eventHandler)
throws InterruptedException {
checkActive();
EvaluationContext evaluationContext =
newEvaluationContextBuilder()
.setKeepGoing(keepGoing)
.setNumThreads(numThreads)
.setEventHandler(eventHandler)
.setUseForkJoinPool(true)
.build();
return memoizingEvaluator.evaluate(patternSkyKeys, evaluationContext);
}
/**
* Returns the {@link ConfiguredTargetAndData}s corresponding to the given keys.
*
* <p>For use for legacy support and tests calling through {@code BuildView} only.
*
* <p>If a requested configured target is in error, the corresponding value is omitted from the
* returned list.
*/
@ThreadSafety.ThreadSafe
public ImmutableList<ConfiguredTargetAndData> getConfiguredTargetsForTesting(
ExtendedEventHandler eventHandler,
BuildConfigurationValue originalConfig,
Iterable<DependencyKey> keys)
throws TransitionException, InvalidConfigurationException, InterruptedException {
return getConfiguredTargetMapForTesting(eventHandler, originalConfig, keys).values().asList();
}
/**
* Returns a map from {@link Dependency} inputs to the {@link ConfiguredTargetAndData}s
* corresponding to those dependencies.
*
* <p>For use for legacy support and tests calling through {@code BuildView} only.
*
* <p>If a requested configured target is in error, the corresponding value is omitted from the
* returned list.
*/
@ThreadSafety.ThreadSafe
public ImmutableMultimap<DependencyKey, ConfiguredTargetAndData> getConfiguredTargetMapForTesting(
ExtendedEventHandler eventHandler,
BuildConfigurationKey originalConfig,
Iterable<DependencyKey> keys)
throws InvalidConfigurationException, InterruptedException {
return getConfiguredTargetMapForTesting(
eventHandler, getConfiguration(eventHandler, originalConfig), keys);
}
/**
* Returns a map from {@link Dependency} inputs to the {@link ConfiguredTargetAndData}s
* corresponding to those dependencies.
*
* <p>For use for legacy support and tests calling through {@code BuildView} only.
*
* <p>If a requested configured target is in error, the corresponding value is omitted from the
* returned list except...
*/
@ThreadSafety.ThreadSafe
private ImmutableMultimap<DependencyKey, ConfiguredTargetAndData>
getConfiguredTargetMapForTesting(
ExtendedEventHandler eventHandler,
BuildConfigurationValue originalConfig,
Iterable<DependencyKey> keys)
throws InvalidConfigurationException, InterruptedException {
checkActive();
Multimap<DependencyKey, BuildConfigurationValue> configs;
if (originalConfig != null) {
configs =
getConfigurations(eventHandler, originalConfig.getOptions(), keys).getConfigurationMap();
} else {
configs = ArrayListMultimap.create();
for (DependencyKey key : keys) {
configs.put(key, null);
}
}
final List<SkyKey> skyKeys = new ArrayList<>();
for (DependencyKey key : keys) {
if (!configs.containsKey(key)) {
// If we couldn't compute a configuration for this target, the target was in error (e.g.
// it couldn't be loaded). Exclude it from the results.
continue;
}
for (BuildConfigurationValue depConfig : configs.get(key)) {
ConfiguredTargetKey configuredTargetKey =
ConfiguredTargetKey.builder()
.setLabel(key.getLabel())
.setConfiguration(depConfig)
.build();
skyKeys.add(configuredTargetKey);
for (AspectDeps aspectDeps : key.getAspects().getUsedAspects()) {
skyKeys.add(
AspectKeyCreator.createAspectKey(aspectDeps.getAspect(), configuredTargetKey));
}
}
skyKeys.add(PackageValue.key(key.getLabel().getPackageIdentifier()));
}
EvaluationResult<SkyValue> result = evaluateSkyKeys(eventHandler, skyKeys);
ImmutableMultimap.Builder<DependencyKey, ConfiguredTargetAndData> cts =
ImmutableMultimap.builder();
// Logic copied from ConfiguredTargetFunction#computeDependencies.
Set<SkyKey> aliasPackagesToFetch = new HashSet<>();
List<DependencyKey> aliasKeysToRedo = new ArrayList<>();
EvaluationResult<SkyValue> aliasPackageValues = null;
Iterable<DependencyKey> keysToProcess = keys;
for (int i = 0; i < 2; i++) {
DependentNodeLoop:
for (DependencyKey key : keysToProcess) {
if (!configs.containsKey(key)) {
// If we couldn't compute a configuration for this target, the target was in error (e.g.
// it couldn't be loaded). Exclude it from the results.
continue;
}
for (BuildConfigurationValue depConfig : configs.get(key)) {
ConfiguredTargetKey configuredTargetKey =
ConfiguredTargetKey.builder()
.setLabel(key.getLabel())
.setConfiguration(depConfig)
.build();
if (result.get(configuredTargetKey) == null) {
continue;
}
ConfiguredTarget configuredTarget =
((ConfiguredTargetValue) result.get(configuredTargetKey)).getConfiguredTarget();
Label label = configuredTarget.getLabel();
SkyKey packageKey = PackageValue.key(label.getPackageIdentifier());
PackageValue packageValue;
if (i == 0) {
packageValue = (PackageValue) result.get(packageKey);
if (packageValue == null) {
aliasPackagesToFetch.add(packageKey);
aliasKeysToRedo.add(key);
continue;
}
} else {
packageValue =
(PackageValue)
Preconditions.checkNotNull(aliasPackageValues.get(packageKey), packageKey);
}
List<ConfiguredAspect> configuredAspects = new ArrayList<>();
for (AspectDeps aspectDeps : key.getAspects().getUsedAspects()) {
SkyKey aspectKey =
AspectKeyCreator.createAspectKey(aspectDeps.getAspect(), configuredTargetKey);
if (result.get(aspectKey) == null) {
continue DependentNodeLoop;
}
configuredAspects.add(((AspectValue) result.get(aspectKey)).getConfiguredAspect());
}
try {
ConfiguredTarget mergedTarget =
MergedConfiguredTarget.of(configuredTarget, configuredAspects);
BuildConfigurationKey configKey = mergedTarget.getConfigurationKey();
BuildConfigurationValue resolvedConfig = depConfig;
if (configKey == null) {
// Unfortunately, it's possible to get a configured target with a null configuration
// when depConfig is non-null, so we need to explicitly override it in that case.
resolvedConfig = null;
} else if (!configKey.equals(depConfig.getKey())) {
resolvedConfig = getConfiguration(eventHandler, mergedTarget.getConfigurationKey());
}
cts.put(
key,
new ConfiguredTargetAndData(
mergedTarget,
packageValue.getPackage().getTarget(configuredTarget.getLabel().getName()),
resolvedConfig,
null));
} catch (DuplicateException | NoSuchTargetException e) {
throw new IllegalStateException(
String.format("Error creating %s", configuredTarget.getLabel()), e);
}
}
}
if (aliasKeysToRedo.isEmpty()) {
break;
}
aliasPackageValues = evaluateSkyKeys(eventHandler, aliasPackagesToFetch);
keysToProcess = aliasKeysToRedo;
}
Supplier<Map<BuildConfigurationKey, BuildConfigurationValue>> configurationLookupSupplier =
() ->
configs.values().stream()
.collect(toMap(BuildConfigurationValue::getKey, Functions.identity()));
// We ignore the return value and exceptions here because tests effectively run with
// --keep_going, and the loading-phase-error bit is only needed if we're constructing a
// SkyframeAnalysisResult.
try {
SkyframeErrorProcessor.processAnalysisErrors(
result,
configurationLookupSupplier,
cyclesReporter,
eventHandler,
/*keepGoing=*/ true,
/*eventBus=*/ null,
bugReporter);
} catch (ViewCreationFailedException ignored) {
// Ignored.
}
return cts.build();
}
/**
* Returns the configuration corresponding to the given set of build options. Should not be used
* in a world with trimmed configurations.
*
* @throws InvalidConfigurationException if the build options produces an invalid configuration
*/
@Deprecated
public BuildConfigurationValue getConfiguration(
ExtendedEventHandler eventHandler, BuildOptions options, boolean keepGoing)
throws InvalidConfigurationException {
return Iterables.getOnlyElement(
getConfigurations(eventHandler, ImmutableList.of(options), options, keepGoing));
}
public BuildConfigurationValue getConfiguration(
ExtendedEventHandler eventHandler, BuildConfigurationKey configurationKey) {
if (configurationKey == null) {
return null;
}
return (BuildConfigurationValue)
evaluateSkyKeys(eventHandler, ImmutableList.of(configurationKey)).get(configurationKey);
}
public Map<BuildConfigurationKey, BuildConfigurationValue> getConfigurations(
ExtendedEventHandler eventHandler, Collection<BuildConfigurationKey> keys) {
EvaluationResult<SkyValue> evaluationResult = evaluateSkyKeys(eventHandler, keys);
return keys.stream()
.collect(
toMap(
Functions.identity(), key -> (BuildConfigurationValue) evaluationResult.get(key)));
}
/**
* Returns the configurations corresponding to the given sets of build options. Output order is
* the same as input order.
*
* @throws InvalidConfigurationException if any build options produces an invalid configuration
*/
// TODO(ulfjack): Remove this legacy method after switching to the Skyframe-based implementation.
private ImmutableList<BuildConfigurationValue> getConfigurations(
ExtendedEventHandler eventHandler,
List<BuildOptions> optionsList,
BuildOptions referenceBuildOptions,
boolean keepGoing)
throws InvalidConfigurationException {
Preconditions.checkArgument(!Iterables.isEmpty(optionsList));
// Prepare the Skyframe inputs.
PlatformMappingValue platformMappingValue =
getPlatformMappingValue(eventHandler, referenceBuildOptions);
ImmutableList.Builder<SkyKey> configSkyKeysBuilder =
ImmutableList.builderWithExpectedSize(optionsList.size());
for (BuildOptions options : optionsList) {
configSkyKeysBuilder.add(toConfigurationKey(platformMappingValue, options));
}
ImmutableList<SkyKey> configSkyKeys = configSkyKeysBuilder.build();
// Skyframe-evaluate the configurations and throw errors if any.
EvaluationResult<SkyValue> evalResult = evaluateSkyKeys(eventHandler, configSkyKeys, keepGoing);
if (evalResult.hasError()) {
Map.Entry<SkyKey, ErrorInfo> firstError = Iterables.get(evalResult.errorMap().entrySet(), 0);
ErrorInfo error = firstError.getValue();
Throwable e = error.getException();
// Wrap loading failed exceptions
if (e instanceof NoSuchThingException) {
e = new InvalidConfigurationException(((NoSuchThingException) e).getDetailedExitCode(), e);
} else if (e == null && !error.getCycleInfo().isEmpty()) {
cyclesReporter.reportCycles(error.getCycleInfo(), firstError.getKey(), eventHandler);
e =
new InvalidConfigurationException(
"cannot load build configuration because of this cycle", Code.CYCLE);
}
if (e != null) {
Throwables.throwIfInstanceOf(e, InvalidConfigurationException.class);
}
throw new IllegalStateException("Unknown error during configuration creation evaluation", e);
}
// Prepare and return the results.
return configSkyKeys.stream()
.map(key -> (BuildConfigurationValue) evalResult.get(key))
.collect(toImmutableList());
}
/**
* Retrieves the configurations needed for the given deps. Unconditionally includes all fragments.
*
* <p>Skips targets with loading phase errors.
*/
// Keep this in sync with {@link PrepareAnalysisPhaseFunction#getConfigurations}.
// TODO(ulfjack): Remove this legacy method after switching to the Skyframe-based implementation.
@Override
public ConfigurationsResult getConfigurations(
ExtendedEventHandler eventHandler, BuildOptions fromOptions, Iterable<DependencyKey> keys)
throws InvalidConfigurationException, InterruptedException {
ConfigurationsResult.Builder builder = ConfigurationsResult.newBuilder();
PlatformMappingValue platformMappingValue = getPlatformMappingValue(eventHandler, fromOptions);
// Now get the configurations.
List<SkyKey> configSkyKeys = new ArrayList<>();
for (DependencyKey key : keys) {
ConfigurationTransition transition = key.getTransition();
if (transition == NullTransition.INSTANCE) {
continue;
}
Collection<BuildOptions> toOptions;
try {
Map<PackageValue.Key, PackageValue> buildSettingPackages =
getBuildSettingPackages(transition, eventHandler);
toOptions =
ConfigurationResolver.applyTransitionWithoutSkyframe(
fromOptions, transition, buildSettingPackages, eventHandler)
.values();
} catch (TransitionException e) {
eventHandler.handle(Event.error(e.getMessage()));
builder.setHasError();
continue;
}
for (BuildOptions toOption : toOptions) {
configSkyKeys.add(toConfigurationKey(platformMappingValue, toOption));
}
}
EvaluationResult<SkyValue> configsResult =
evaluateSkyKeys(eventHandler, configSkyKeys, /*keepGoing=*/ true);
for (DependencyKey key : keys) {
if (key.getTransition() == NullTransition.INSTANCE) {
builder.put(key, null);
continue;
}
Collection<BuildOptions> toOptions;
try {
Map<PackageValue.Key, PackageValue> buildSettingPackages =
getBuildSettingPackages(key.getTransition(), eventHandler);
toOptions =
ConfigurationResolver.applyTransitionWithoutSkyframe(
fromOptions, key.getTransition(), buildSettingPackages, eventHandler)
.values();
} catch (TransitionException e) {
eventHandler.handle(Event.error(e.getMessage()));
builder.setHasError();
continue;
}
for (BuildOptions toOption : toOptions) {
BuildConfigurationKey configKey = toConfigurationKey(platformMappingValue, toOption);
BuildConfigurationValue configValue =
(BuildConfigurationValue) configsResult.get(configKey);
if (configValue != null) {
builder.put(key, configValue);
} else if (configsResult.errorMap().containsKey(configKey)) {
ErrorInfo configError = configsResult.getError(configKey);
if (configError.getException() instanceof InvalidConfigurationException) {
// Wrap underlying exception to make it clearer to developers which line of code
// actually threw exception.
InvalidConfigurationException underlying =
(InvalidConfigurationException) configError.getException();
throw new InvalidConfigurationException(underlying.getDetailedExitCode(), underlying);
}
}
}
}
return builder.build();
}
/** Returns every {@link BuildConfigurationKey} in the graph. */
public Collection<SkyKey> getTransitiveConfigurationKeys() {
return memoizingEvaluator.getDoneValues().keySet().stream()
.filter(key -> SkyFunctions.BUILD_CONFIGURATION.equals(key.functionName()))
.collect(toImmutableList());
}
private PlatformMappingValue getPlatformMappingValue(
ExtendedEventHandler eventHandler, BuildOptions referenceBuildOptions)
throws InvalidConfigurationException {
PathFragment platformMappingPath =
referenceBuildOptions.get(PlatformOptions.class).platformMappings;
PlatformMappingValue.Key platformMappingKey =
PlatformMappingValue.Key.create(platformMappingPath);
EvaluationResult<SkyValue> evaluationResult =
evaluateSkyKeys(eventHandler, ImmutableSet.of(platformMappingKey));
if (evaluationResult.hasError()) {
throw new InvalidConfigurationException(
Code.PLATFORM_MAPPING_EVALUATION_FAILURE, evaluationResult.getError().getException());
}
return (PlatformMappingValue) evaluationResult.get(platformMappingKey);
}
private static BuildConfigurationKey toConfigurationKey(
PlatformMappingValue platformMappingValue, BuildOptions toOption)
throws InvalidConfigurationException {
try {
return BuildConfigurationKey.withPlatformMapping(platformMappingValue, toOption);
} catch (OptionsParsingException e) {
throw new InvalidConfigurationException(Code.INVALID_BUILD_OPTIONS, e);
}
}
/** Keep in sync with {@link StarlarkTransition#getBuildSettingPackages} */
private Map<PackageValue.Key, PackageValue> getBuildSettingPackages(
ConfigurationTransition transition, ExtendedEventHandler eventHandler)
throws TransitionException {
HashMap<PackageValue.Key, PackageValue> buildSettingPackages = new HashMap<>();
// This happens before cycle detection so keep track of all seen build settings to ensure
// we don't get stuck in endless loops (e.g. //alias1->//alias2 && //alias2->alias1)
Set<Label> allSeenBuildSettings = new HashSet<>();
ImmutableSet<Label> unverifiedBuildSettings =
StarlarkTransition.getAllBuildSettings(transition);
while (!unverifiedBuildSettings.isEmpty()) {
for (Label buildSetting : unverifiedBuildSettings) {
if (!allSeenBuildSettings.add(buildSetting)) {
throw new TransitionException(
String.format(
"Error with aliased build settings related to '%s'. Either your aliases form a"
+ " dependency cycle or you're attempting to set both an alias its actual"
+ " target in the same transition.",
buildSetting));
}
}
ImmutableSet<PackageValue.Key> buildSettingPackageKeys =
StarlarkTransition.getPackageKeysFromLabels(unverifiedBuildSettings);
EvaluationResult<SkyValue> newlyLoaded =
evaluateSkyKeys(eventHandler, buildSettingPackageKeys, true);
if (newlyLoaded.hasError()) {
Map.Entry<SkyKey, ErrorInfo> errorEntry =
Preconditions.checkNotNull(
Iterables.getFirst(newlyLoaded.errorMap().entrySet(), null), newlyLoaded);
throw new TransitionException(
new NoSuchPackageException(
((PackageValue.Key) errorEntry.getKey()).argument(),
"Unable to find build setting package",
errorEntry.getValue().getException()));
}
buildSettingPackageKeys.forEach(
k -> buildSettingPackages.put(k, (PackageValue) newlyLoaded.get(k)));
unverifiedBuildSettings =
StarlarkTransition.verifyBuildSettingsAndGetAliases(
buildSettingPackages, unverifiedBuildSettings);
}
return buildSettingPackages;
}
/**
* Evaluates the given sky keys, blocks, and returns their evaluation results. Fails fast on the
* first evaluation error.
*/
private EvaluationResult<SkyValue> evaluateSkyKeys(
final ExtendedEventHandler eventHandler, final Iterable<? extends SkyKey> skyKeys) {
return evaluateSkyKeys(eventHandler, skyKeys, false);
}
/**
* Evaluates the given sky keys, blocks, and returns their evaluation results. Enables/disables
* "keep going" on evaluation errors as specified.
*/
EvaluationResult<SkyValue> evaluateSkyKeys(
final ExtendedEventHandler eventHandler,
final Iterable<? extends SkyKey> skyKeys,
final boolean keepGoing) {
EvaluationResult<SkyValue> result;
try {
result =
callUninterruptibly(
() -> {
synchronized (valueLookupLock) {
try {
skyframeBuildView.enableAnalysis(true);
return evaluate(
skyKeys, keepGoing, /*numThreads=*/ DEFAULT_THREAD_COUNT, eventHandler);
} finally {
skyframeBuildView.enableAnalysis(false);
}
}
});
} catch (Exception e) {
throw new IllegalStateException(e); // Should never happen.
}
return result;
}
/** Returns a dynamic configuration constructed from the given build options. */
@VisibleForTesting
public BuildConfigurationValue getConfigurationForTesting(
ExtendedEventHandler eventHandler, BuildOptions options)
throws InterruptedException, OptionsParsingException, InvalidConfigurationException {
SkyKey key =
BuildConfigurationKey.withPlatformMapping(
getPlatformMappingValue(eventHandler, options), options);
return (BuildConfigurationValue)
evaluate(
ImmutableList.of(key),
/*keepGoing=*/ false,
/*numThreads=*/ DEFAULT_THREAD_COUNT,
eventHandler)
.get(key);
}
/** Returns a particular configured target. */
@VisibleForTesting
@Nullable
public ConfiguredTarget getConfiguredTargetForTesting(
ExtendedEventHandler eventHandler, Label label, BuildConfigurationValue configuration)
throws TransitionException, InvalidConfigurationException, InterruptedException {
return getConfiguredTargetForTesting(eventHandler, label, configuration, NoTransition.INSTANCE);
}
/** Returns a particular configured target after applying the given transition. */
@VisibleForTesting
@Nullable
public ConfiguredTarget getConfiguredTargetForTesting(
ExtendedEventHandler eventHandler,
Label label,
BuildConfigurationValue configuration,
ConfigurationTransition transition)
throws TransitionException, InvalidConfigurationException, InterruptedException {
ConfiguredTargetAndData configuredTargetAndData =
getConfiguredTargetAndDataForTesting(eventHandler, label, configuration, transition);
return configuredTargetAndData == null ? null : configuredTargetAndData.getConfiguredTarget();
}
@VisibleForTesting
@Nullable
public ConfiguredTargetAndData getConfiguredTargetAndDataForTesting(
ExtendedEventHandler eventHandler,
Label label,
BuildConfigurationValue configuration,
ConfigurationTransition transition)
throws TransitionException, InvalidConfigurationException, InterruptedException {
ConfigurationTransition transition1 =
configuration == null ? NullTransition.INSTANCE : transition;
DependencyKey dependencyKey =
DependencyKey.builder().setLabel(label).setTransition(transition1).build();
return Iterables.getFirst(
getConfiguredTargetsForTesting(
eventHandler, configuration, ImmutableList.of(dependencyKey)),
null);
}
@VisibleForTesting
@Nullable
public ConfiguredTargetAndData getConfiguredTargetAndDataForTesting(
ExtendedEventHandler eventHandler, Label label, BuildConfigurationValue configuration)
throws TransitionException, InvalidConfigurationException, InterruptedException {
return getConfiguredTargetAndDataForTesting(
eventHandler, label, configuration, NoTransition.INSTANCE);
}
/**
* Invalidates Skyframe values corresponding to the given set of modified files under the given
* path entry.
*
* <p>May throw an {@link InterruptedException}, which means that no values have been invalidated.
*/
@VisibleForTesting
public final void invalidateFilesUnderPathForTesting(
ExtendedEventHandler eventHandler, ModifiedFileSet modifiedFileSet, Root pathEntry)
throws InterruptedException, AbruptExitException {
if (lastAnalysisDiscarded) {
// Values were cleared last build, but they couldn't be deleted because they were needed for
// the execution phase. We can delete them now.
dropConfiguredTargetsNow(eventHandler);
lastAnalysisDiscarded = false;
}
perCommandSyscallCache.clear();
invalidateFilesUnderPathForTestingImpl(eventHandler, modifiedFileSet, pathEntry);
}
protected abstract void invalidateFilesUnderPathForTestingImpl(
ExtendedEventHandler eventHandler, ModifiedFileSet modifiedFileSet, Root pathEntry)
throws InterruptedException, AbruptExitException;
/** Invalidates SkyFrame values that may have failed for transient reasons. */
public abstract void invalidateTransientErrors();
/** Configures a given set of configured targets. */
EvaluationResult<ActionLookupValue> configureTargets(
ExtendedEventHandler eventHandler,
List<ConfiguredTargetKey> configuredTargetKeys,
ImmutableList<TopLevelAspectsKey> topLevelAspectKeys,
boolean keepGoing,
int numThreads,
int cpuHeavySkyKeysThreadPoolSize)
throws InterruptedException {
checkActive();
eventHandler.post(new ConfigurationPhaseStartedEvent(configuredTargetProgress));
EvaluationContext evaluationContext =
newEvaluationContextBuilder()
.setKeepGoing(keepGoing)
.setNumThreads(numThreads)
.setExecutorServiceSupplier(
() -> NamedForkJoinPool.newNamedPool("skyframe-evaluator", numThreads))
.setCPUHeavySkyKeysThreadPoolSize(cpuHeavySkyKeysThreadPoolSize)
.setEventHandler(eventHandler)
.build();
EvaluationResult<ActionLookupValue> result =
memoizingEvaluator.evaluate(
analysisPhaseKeys(configuredTargetKeys, topLevelAspectKeys), evaluationContext);
perCommandSyscallCache.noteAnalysisPhaseEnded();
return result;
}
/**
* Returns top-level analysis phase keys, {@link ConfiguredTargetKey} and {@link
* TopLevelAspectsKey}.
*/
protected Iterable<? extends SkyKey> analysisPhaseKeys(
Iterable<ConfiguredTargetKey> ctKeys, Iterable<TopLevelAspectsKey> aspectKeys) {
return Iterables.concat(ctKeys, aspectKeys);
}
/**
* Evaluates the given collections of CT/Aspect BuildDriverKeys. This is part of
* https://github.com/bazelbuild/bazel/issues/14057, internal: b/147350683.
*/
EvaluationResult<BuildDriverValue> evaluateBuildDriverKeys(
ExtendedEventHandler eventHandler,
List<BuildDriverKey> buildDriverCTKeys,
List<BuildDriverKey> buildDriverAspectKeys,
boolean keepGoing,
int numThreads,
int cpuHeavySkyKeysThreadPoolSize,
int mergedPhasesExecutionJobsCount)
throws InterruptedException {
checkActive();
try {
eventHandler.post(new ConfigurationPhaseStartedEvent(configuredTargetProgress));
EvaluationContext evaluationContext =
newEvaluationContextBuilder()
.setKeepGoing(keepGoing)
.setNumThreads(numThreads)
.setExecutorServiceSupplier(
() -> NamedForkJoinPool.newNamedPool("skyframe-evaluator", numThreads))
.setCPUHeavySkyKeysThreadPoolSize(cpuHeavySkyKeysThreadPoolSize)
.setExecutionPhaseThreadPoolSize(mergedPhasesExecutionJobsCount)
.setEventHandler(eventHandler)
.build();
return memoizingEvaluator.evaluate(
Iterables.concat(buildDriverCTKeys, buildDriverAspectKeys), evaluationContext);
} finally {
// No more analysis expected after this.
perCommandSyscallCache.noteAnalysisPhaseEnded();
}
}
/** Called after a single Skyframe evaluation that involves action execution. */
private void cleanUpAfterSingleEvaluationWithActionExecution(ExtendedEventHandler eventHandler) {
setExecutionProgressReceiver(null);
skyframeActionExecutor.executionOver();
actionExecutionFunction.complete(eventHandler);
}
/**
* Clears the various states required for execution after ALL action execution in the build is
* done.
*/
public void clearExecutionStates(ExtendedEventHandler eventHandler) {
cleanUpAfterSingleEvaluationWithActionExecution(eventHandler);
setActionExecutionProgressReportingObjects(null, null, null);
}
/**
* Checks the given action lookup values for action conflicts. Values satisfying the returned
* predicate are known to be transitively error-free from action conflicts or other analysis
* failures. {@link #resetActionConflictsStoredInSkyframe} must be called after this to free
* memory coming from this call.
*/
TopLevelActionConflictReport filterActionConflictsForConfiguredTargetsAndAspects(
ExtendedEventHandler eventHandler,
Iterable<ActionLookupKey> keys,
ImmutableMap<ActionAnalysisMetadata, ArtifactConflictFinder.ConflictException>
actionConflicts,
TopLevelArtifactContext topLevelArtifactContext)
throws InterruptedException {
checkActive();
ACTION_CONFLICTS.set(injectable(), actionConflicts);
// This work is CPU-bound, so use the number of available processors.
EvaluationResult<ActionLookupConflictFindingValue> result =
evaluate(
TopLevelActionLookupConflictFindingFunction.keys(keys, topLevelArtifactContext),
/*keepGoing=*/ true,
/*numThreads=*/ ResourceUsage.getAvailableProcessors(),
eventHandler);
// Remove top-level action-conflict detection values for memory efficiency. Non-top-level ones
// are removed below. We are OK with this mini-phase being non-incremental as the failure mode
// of action conflict is rare.
memoizingEvaluator.delete(
SkyFunctionName.functionIs(SkyFunctions.TOP_LEVEL_ACTION_LOOKUP_CONFLICT_FINDING));
return new TopLevelActionConflictReport(result, topLevelArtifactContext);
}
/**
* Encapsulation of the result of #filterActionConflictsForConfiguredTargetsAndAspects() allowing
* callers to determine which top-level keys did not have analysis errors and retrieve the
* ConflictException for those that keys that specifically have conflicts.
*/
static final class TopLevelActionConflictReport {
public final EvaluationResult<ActionLookupConflictFindingValue> result;
private final TopLevelArtifactContext topLevelArtifactContext;
TopLevelActionConflictReport(
EvaluationResult<ActionLookupConflictFindingValue> result,
TopLevelArtifactContext topLevelArtifactContext) {
this.result = result;
this.topLevelArtifactContext = topLevelArtifactContext;
}
boolean isErrorFree(ActionLookupKey k) {
return result.get(
TopLevelActionLookupConflictFindingFunction.Key.create(k, topLevelArtifactContext))
!= null;
}
/**
* Get the ConflictException produced for the given ActionLookupKey. Will throw if the given key
* {@link #isErrorFree is error-free}.
*/
Optional<ConflictException> getConflictException(ActionLookupKey k) {
ErrorInfo errorInfo =
result.getError(
TopLevelActionLookupConflictFindingFunction.Key.create(k, topLevelArtifactContext));
Exception e = errorInfo.getException();
return Optional.ofNullable(e instanceof ConflictException ? (ConflictException) e : null);
}
}
/**
* Clears all action conflicts stored in skyframe that were discovered by a call to {@link
* #filterActionConflictsForConfiguredTargetsAndAspects}.
*
* <p>This function must be called after a call to {@link
* #filterActionConflictsForConfiguredTargetsAndAspects}, either directly (in the case of
* no-keep_going evaluations) or indirectly by {@link #filterActionConflictsForTopLevelArtifacts}
* in keep_going evaluations.
*/
void resetActionConflictsStoredInSkyframe() {
memoizingEvaluator.delete(
SkyFunctionName.functionIs(SkyFunctions.ACTION_LOOKUP_CONFLICT_FINDING));
}
/** Resets the incremental artifact conflict finder to ensure incremental correctness. */
public void resetIncrementalArtifactConflictFindingStates() throws InterruptedException {
incrementalArtifactConflictFinder.shutdown();
incrementalArtifactConflictFinder =
IncrementalArtifactConflictFinder.createWithActionGraph(
new MapBasedActionGraph(actionKeyContext));
incrementalTransitiveActionLookupKeysCollector.shutdown();
conflictFreeActionLookupKeysGlobalSet = Sets.newConcurrentHashSet();
incrementalTransitiveActionLookupKeysCollector =
new IncrementalTransitiveActionLookupKeysCollector(
SkyframeExecutorWrappingWalkableGraph.of(this), conflictFreeActionLookupKeysGlobalSet);
}
private IncrementalArtifactConflictFinder getIncrementalArtifactConflictFinder() {
return incrementalArtifactConflictFinder;
}
private Set<SkyKey> getConflictFreeActionLookupKeysGlobalSet() {
return conflictFreeActionLookupKeysGlobalSet;
}
/**
* Checks the action lookup values owning the given artifacts for action conflicts. Artifacts
* satisfying the returned predicate are known to be transitively free from action conflicts.
* {@link #filterActionConflictsForConfiguredTargetsAndAspects} must be called before this is
* called in order to populate the known action conflicts.
*
* <p>This method is only called in keep-going mode, since otherwise any known action conflicts
* will immediately fail the build.
*/
public Predicate<Artifact> filterActionConflictsForTopLevelArtifacts(
ExtendedEventHandler eventHandler, Collection<Artifact> artifacts)
throws InterruptedException {
checkActive();
// This work is CPU-bound, so use the number of available processors.
EvaluationResult<ActionLookupConflictFindingValue> result =
evaluate(
Iterables.transform(artifacts, ActionLookupConflictFindingValue::key),
/*keepGoing=*/ true,
/*numThreads=*/ ResourceUsage.getAvailableProcessors(),
eventHandler);
// Remove remaining action-conflict detection values immediately for memory efficiency.
resetActionConflictsStoredInSkyframe();
return a -> result.get(ActionLookupConflictFindingValue.key(a)) != null;
}
/**
* For internal use in queries: performs a graph update to make sure the transitive closure of the
* specified {@code universeKey} is present in the graph, and returns the {@link
* EvaluationResult}.
*
* <p>The graph update is unconditionally done in keep-going mode, so that the query is guaranteed
* a complete graph to work on.
*/
@Override
public final EvaluationResult<SkyValue> prepareAndGet(
Set<SkyKey> roots, EvaluationContext evaluationContext) throws InterruptedException {
EvaluationContext evaluationContextToUse =
evaluationContext.builder().setKeepGoing(/*keepGoing=*/ true).build();
return memoizingEvaluator.evaluate(roots, evaluationContextToUse);
}
public Optional<UniverseScope> maybeGetHardcodedUniverseScope() {
return Optional.empty();
}
@ForOverride
protected SkyKey getUniverseKey(Collection<String> patterns, PathFragment offset) {
return PrepareDepsOfPatternsValue.key(ImmutableList.copyOf(patterns), offset);
}
/** Returns the generating action of a given artifact ({@code null} if it's a source artifact). */
private ActionAnalysisMetadata getGeneratingAction(
ExtendedEventHandler eventHandler, Artifact artifact) throws InterruptedException {
if (artifact.isSourceArtifact()) {
return null;
}
ActionLookupData generatingActionKey =
((Artifact.DerivedArtifact) artifact).getGeneratingActionKey();
synchronized (valueLookupLock) {
// Note that this will crash (attempting to run a configured target value builder after
// analysis) after a failed --nokeep_going analysis in which the configured target that
// failed was a (transitive) dependency of the configured target that should generate
// this action. We don't expect callers to query generating actions in such cases.
EvaluationResult<ActionLookupValue> result =
evaluate(
ImmutableList.of(generatingActionKey.getActionLookupKey()),
/*keepGoing=*/ false,
/*numThreads=*/ ResourceUsage.getAvailableProcessors(),
eventHandler);
if (result.hasError()) {
return null;
}
ActionLookupValue actionLookupValue = result.get(generatingActionKey.getActionLookupKey());
return actionLookupValue.getActions().get(generatingActionKey.getActionIndex());
}
}
/**
* Returns an action graph.
*
* <p>For legacy compatibility only.
*/
public ActionGraph getActionGraph(final ExtendedEventHandler eventHandler) {
return artifact -> {
try {
return callUninterruptibly(
() -> SkyframeExecutor.this.getGeneratingAction(eventHandler, artifact));
} catch (Exception e) {
throw new IllegalStateException(
"Error getting generating action: " + artifact.prettyPrint(), e);
}
};
}
public PackageManager getPackageManager() {
return packageManager;
}
public QueryTransitivePackagePreloader getQueryTransitivePackagePreloader() {
return queryTransitivePackagePreloader;
}
@VisibleForTesting
public TargetPatternPreloader newTargetPatternPreloader() {
return new SkyframeTargetPatternEvaluator(this);
}
public ActionKeyContext getActionKeyContext() {
return actionKeyContext;
}
// TODO(janakr): Is there a better place for this?
public final DigestHashFunction getDigestFunction() {
return fileSystem.getDigestFunction();
}
/** Exception thrown when {@link #getDoneSkyValueForIntrospection} fails. */
public static final class FailureToRetrieveIntrospectedValueException extends Exception {
private FailureToRetrieveIntrospectedValueException(String message) {
super(message);
}
private FailureToRetrieveIntrospectedValueException(
String message, InterruptedException cause) {
super(message, cause);
}
}
/**
* Returns the value of a node that the caller knows to be done. May be called intra-evaluation.
* Null values and interrupts are unexpected, and will cause a {@link
* FailureToRetrieveIntrospectedValueException}. Callers should handle gracefully, probably via
* {@link BugReport}.
*/
@ThreadSafety.ThreadSafe
public SkyValue getDoneSkyValueForIntrospection(SkyKey key)
throws FailureToRetrieveIntrospectedValueException {
NodeEntry entry;
try {
entry = memoizingEvaluator.getExistingEntryAtCurrentlyEvaluatingVersion(key);
} catch (InterruptedException e) {
throw new FailureToRetrieveIntrospectedValueException(
"Unexpected interrupt when fetching " + key, e);
}
if (entry == null || !entry.isDone()) {
throw new FailureToRetrieveIntrospectedValueException(
"Entry for " + key + " not found or null: " + entry);
}
SkyValue value;
try {
value = entry.getValue();
} catch (InterruptedException e) {
throw new FailureToRetrieveIntrospectedValueException(
"Entry for " + key + " did not have locally present value: " + entry, e);
}
if (value == null) {
throw new FailureToRetrieveIntrospectedValueException(
"Entry for " + key + " had null value: " + entry);
}
return value;
}
class SkyframePackageLoader {
/**
* Looks up a particular package (mostly used after the loading phase, so packages should
* already be present, but occasionally used pre-loading phase). Use should be discouraged,
* since this cannot be used inside a Skyframe evaluation, and concurrent calls are
* synchronized.
*
* <p>Note that this method needs to be synchronized since InMemoryMemoizingEvaluator.evaluate()
* method does not support concurrent calls.
*/
Package getPackage(ExtendedEventHandler eventHandler, PackageIdentifier pkgName)
throws InterruptedException, NoSuchPackageException {
SkyKey key = PackageValue.key(pkgName);
ImmutableList<SkyKey> keys = ImmutableList.of(key);
EvaluationResult<PackageValue> result;
synchronized (valueLookupLock) {
// Loading a single package shouldn't be too bad to do in keep_going mode even if the build
// overall is in nokeep_going mode: the worst that happens is we parse some unnecessary
// .bzl files.
result =
evaluate(keys, /*keepGoing=*/ true, /*numThreads=*/ DEFAULT_THREAD_COUNT, eventHandler);
}
ErrorInfo error = result.getError(key);
if (error != null) {
if (!error.getCycleInfo().isEmpty()) {
cyclesReporter.reportCycles(result.getError().getCycleInfo(), key, eventHandler);
// This can only happen if a package is freshly loaded outside of the target parsing or
// loading phase
throw new BuildFileContainsErrorsException(
pkgName, "Cycle encountered while loading package " + pkgName);
}
Throwable e = Preconditions.checkNotNull(error.getException(), "%s %s", pkgName, error);
// PackageFunction should be catching, swallowing, and rethrowing all transitive errors as
// NoSuchPackageExceptions or constructing packages with errors, since we're in keep_going
// mode.
Throwables.throwIfInstanceOf(e, NoSuchPackageException.class);
throw new IllegalStateException(
"Unexpected Exception type from PackageValue for '"
+ pkgName
+ "'' with error: "
+ error,
e);
}
return result.get(key).getPackage();
}
/** Returns whether the given package should be consider deleted and thus should be ignored. */
public boolean isPackageDeleted(PackageIdentifier packageName) {
return deletedPackages.get().contains(packageName);
}
PackageLookupValue getPackageLookupValue(PackageIdentifier pkgName) {
try {
return (PackageLookupValue)
memoizingEvaluator.getExistingValue(PackageLookupValue.key(pkgName));
} catch (InterruptedException e) {
throw new IllegalStateException(
String.format(
"Evaluator %s should not be interruptible (%s)", memoizingEvaluator, pkgName),
e);
}
}
void dumpPackages(PrintStream out) {
SkyframeExecutor.this.dumpPackages(out);
}
}
public MemoizingEvaluator getEvaluator() {
return memoizingEvaluator;
}
@VisibleForTesting
public ConfiguredRuleClassProvider getRuleClassProviderForTesting() {
return ruleClassProvider;
}
@VisibleForTesting
public PackageFactory getPackageFactoryForTesting() {
return pkgFactory;
}
@VisibleForTesting
public PackageSettings getPackageSettingsForTesting() {
return pkgFactory.getPackageSettingsForTesting();
}
@VisibleForTesting
public BlazeDirectories getBlazeDirectoriesForTesting() {
return directories;
}
@VisibleForTesting
ActionExecutionStatusReporter getActionExecutionStatusReporterForTesting() {
return statusReporterRef.get();
}
/**
* Initializes and syncs the graph with the given options, readying it for the next evaluation.
*
* <p>At a minimum, {@link PackageOptions} and {@link BuildLanguageOptions} are expected to be
* present in the given {@link OptionsProvider}.
*
* <p>Returns precomputed information about the workspace if it is available at this stage. This
* is an optimization allowing implementations which have such information to make it available
* early in the build.
*/
@Nullable
public WorkspaceInfoFromDiff sync(
ExtendedEventHandler eventHandler,
PathPackageLocator pathPackageLocator,
UUID commandId,
Map<String, String> clientEnv,
Map<String, String> repoEnvOption,
TimestampGranularityMonitor tsgm,
OptionsProvider options)
throws InterruptedException, AbruptExitException {
getActionEnvFromOptions(options.getOptions(CoreOptions.class));
PrecomputedValue.REPO_ENV.set(injectable(), new LinkedHashMap<>(repoEnvOption));
RemoteOptions remoteOptions = options.getOptions(RemoteOptions.class);
setRemoteExecutionEnabled(remoteOptions != null && remoteOptions.isRemoteExecutionEnabled());
updateSkyFunctionsSemaphoreSize(options);
syncPackageLoading(pathPackageLocator, commandId, clientEnv, tsgm, options);
if (lastAnalysisDiscarded) {
dropConfiguredTargetsNow(eventHandler);
lastAnalysisDiscarded = false;
}
return null;
}
/**
* Updates the size of {@link #oomSensitiveSkyFunctionsSemaphore} based on the provided flag
* option. If the provided value is 0, remove the semaphore.
*/
private void updateSkyFunctionsSemaphoreSize(OptionsProvider options) {
AnalysisOptions analysisOptions = options.getOptions(AnalysisOptions.class);
if (analysisOptions == null) {
return;
}
Semaphore newSemaphore =
analysisOptions.oomSensitiveSkyFunctionsSemaphoreSize == 0
? null
: new Semaphore(analysisOptions.oomSensitiveSkyFunctionsSemaphoreSize);
oomSensitiveSkyFunctionsSemaphore.set(newSemaphore);
}
protected void syncPackageLoading(
PathPackageLocator pathPackageLocator,
UUID commandId,
Map<String, String> clientEnv,
TimestampGranularityMonitor tsgm,
OptionsProvider options)
throws AbruptExitException {
PackageOptions packageOptions = options.getOptions(PackageOptions.class);
try (SilentCloseable c = Profiler.instance().profile("preparePackageLoading")) {
preparePackageLoading(
pathPackageLocator,
packageOptions,
options.getOptions(BuildLanguageOptions.class),
commandId,
clientEnv,
tsgm);
}
try (SilentCloseable c = Profiler.instance().profile("setDeletedPackages")) {
setDeletedPackages(packageOptions.getDeletedPackages());
}
incrementalBuildMonitor = new SkyframeIncrementalBuildMonitor();
invalidateTransientErrors();
sourceArtifactsSeen.reset();
outputArtifactsSeen.reset();
outputArtifactsFromActionCache.reset();
topLevelArtifactsMetric.reset();
}
private void getActionEnvFromOptions(CoreOptions opt) {
// ImmutableMap does not support null values, so use a LinkedHashMap instead.
LinkedHashMap<String, String> actionEnvironment = new LinkedHashMap<>();
if (opt != null) {
for (Map.Entry<String, String> v : opt.actionEnvironment) {
actionEnvironment.put(v.getKey(), v.getValue());
}
}
setActionEnv(actionEnvironment);
}
@VisibleForTesting
public void setActionEnv(Map<String, String> actionEnv) {
PrecomputedValue.ACTION_ENV.set(injectable(), actionEnv);
}
public PathPackageLocator createPackageLocator(
ExtendedEventHandler eventHandler, List<String> packagePaths, Path workingDirectory) {
return PathPackageLocator.create(
directories.getOutputBase(),
packagePaths,
eventHandler,
directories.getWorkspace().asFragment(),
workingDirectory,
buildFilesByPriority);
}
private CyclesReporter createCyclesReporter() {
return new CyclesReporter(
new TargetCycleReporter(packageManager),
new ActionArtifactCycleReporter(packageManager),
new TestExpansionCycleReporter(packageManager),
new RegisteredToolchainsCycleReporter(),
// TODO(ulfjack): The StarlarkModuleCycleReporter swallows previously reported cycles
// unconditionally! Is that intentional?
new StarlarkModuleCycleReporter());
}
public CyclesReporter getCyclesReporter() {
return cyclesReporter;
}
public void setActionExecutionProgressReportingObjects(
@Nullable ProgressSupplier supplier,
@Nullable ActionCompletedReceiver completionReceiver,
@Nullable ActionExecutionStatusReporter statusReporter) {
skyframeActionExecutor.setActionExecutionProgressReportingObjects(supplier, completionReceiver);
this.statusReporterRef.set(statusReporter);
}
public abstract void detectModifiedOutputFiles(
ModifiedFileSet modifiedOutputFiles,
@Nullable Range<Long> lastExecutionTimeRange,
boolean trustRemoteArtifacts,
int fsvcThreads)
throws AbruptExitException, InterruptedException;
/**
* Mark dirty values for deletion if they've been dirty for longer than N versions.
*
* <p>Specifying a value N means, if the current version is V and a value was dirtied (and has
* remained so) in version U, and U + N &lt;= V, then the value will be marked for deletion and
* purged in version V+1.
*/
public abstract void deleteOldNodes(long versionWindowForDirtyGc);
@Nullable
public PackageProgressReceiver getPackageProgressReceiver() {
return packageProgress;
}
/**
* Loads the given target patterns without applying any filters (such as removing non-test targets
* if {@code --build_tests_only} is set).
*
* @param eventHandler handler which accepts update events
* @param targetPatterns patterns to be loaded
* @param threadCount number of threads to use for this skyframe evaluation
* @param keepGoing whether to attempt to ignore errors. See also {@link KeepGoingOption}
*/
public TargetPatternPhaseValue loadTargetPatternsWithoutFilters(
ExtendedEventHandler eventHandler,
List<String> targetPatterns,
PathFragment relativeWorkingDirectory,
int threadCount,
boolean keepGoing)
throws TargetParsingException, InterruptedException {
SkyKey key =
TargetPatternPhaseValue.keyWithoutFilters(
ImmutableList.copyOf(targetPatterns), relativeWorkingDirectory);
return getTargetPatternPhaseValue(eventHandler, targetPatterns, threadCount, keepGoing, key);
}
/**
* Loads the given target patterns after applying filters configured through parameters and
* options (such as removing non-test targets if {@code --build_tests_only} is set).
*
* @param eventHandler handler which accepts update events
* @param targetPatterns patterns to be loaded
* @param threadCount number of threads to use for this skyframe evaluation
* @param keepGoing whether to attempt to ignore errors. See also {@link KeepGoingOption}
* @param determineTests whether to ignore any targets that aren't tests or test suites
*/
public TargetPatternPhaseValue loadTargetPatternsWithFilters(
ExtendedEventHandler eventHandler,
List<String> targetPatterns,
PathFragment relativeWorkingDirectory,
LoadingOptions options,
int threadCount,
boolean keepGoing,
boolean determineTests)
throws TargetParsingException, InterruptedException {
SkyKey key =
TargetPatternPhaseValue.key(
ImmutableList.copyOf(targetPatterns),
relativeWorkingDirectory,
options.compileOneDependency,
options.buildTestsOnly,
determineTests,
ImmutableList.copyOf(options.buildTagFilterList),
options.buildManualTests,
options.expandTestSuites,
TestFilter.forOptions(options, eventHandler, pkgFactory.getRuleClassNames()));
return getTargetPatternPhaseValue(eventHandler, targetPatterns, threadCount, keepGoing, key);
}
private TargetPatternPhaseValue getTargetPatternPhaseValue(
ExtendedEventHandler eventHandler,
List<String> targetPatterns,
int threadCount,
boolean keepGoing,
SkyKey key)
throws InterruptedException, TargetParsingException {
Stopwatch timer = Stopwatch.createStarted();
eventHandler.post(new LoadingPhaseStartedEvent(packageProgress));
EvaluationResult<TargetPatternPhaseValue> evalResult =
evaluate(ImmutableList.of(key), keepGoing, threadCount, eventHandler);
tryThrowTargetParsingException(eventHandler, targetPatterns, key, evalResult);
eventHandler.post(new TargetParsingPhaseTimeEvent(timer.stop().elapsed().toMillis()));
return evalResult.get(key);
}
private void tryThrowTargetParsingException(
ExtendedEventHandler eventHandler,
List<String> targetPatterns,
SkyKey key,
EvaluationResult<TargetPatternPhaseValue> evalResult)
throws TargetParsingException {
if (evalResult.hasError()) {
ErrorInfo errorInfo = evalResult.getError(key);
TargetParsingException exc;
if (!errorInfo.getCycleInfo().isEmpty()) {
exc =
new TargetParsingException(
"cycles detected during target parsing", TargetPatterns.Code.CYCLE);
cyclesReporter.reportCycles(errorInfo.getCycleInfo(), key, eventHandler);
// Fallback: we don't know which patterns failed, specifically, so we report the entire
// set as being in error.
eventHandler.post(PatternExpandingError.failed(targetPatterns, exc.getMessage()));
} else {
exc = constructNoCycleTargetParsingException(eventHandler, targetPatterns, errorInfo);
}
throw exc;
}
}
private static TargetParsingException constructNoCycleTargetParsingException(
ExtendedEventHandler eventHandler, List<String> targetPatterns, ErrorInfo errorInfo) {
Exception e = Preconditions.checkNotNull(errorInfo.getException());
DetailedExitCode detailedExitCode = traverseExceptionChain(e);
if (!(e instanceof TargetParsingException)) {
// If it's a TargetParsingException, then the TargetPatternPhaseFunction has already
// reported the error, so we don't need to report it again.
eventHandler.post(PatternExpandingError.failed(targetPatterns, e.getMessage()));
}
// Following SkyframeTargetPatternEvaluator, we create with a new TargetParsingException either
// with an existing DetailedExitCode, or with a FailureDetail Code.
Throwable cause = e instanceof TargetParsingException ? e.getCause() : e;
return detailedExitCode != null
? new TargetParsingException(e.getMessage(), cause, detailedExitCode)
: new TargetParsingException(
e.getMessage(), cause, TargetPatterns.Code.TARGET_PATTERN_PARSE_FAILURE);
}
@Nullable
private static DetailedExitCode traverseExceptionChain(Exception topLevelException) {
Exception traverseException = topLevelException;
DetailedExitCode detailedExitCode = null;
int traverseLevel = 0;
while (traverseLevel < EXCEPTION_TRAVERSAL_LIMIT) {
traverseLevel++;
detailedExitCode = DetailedException.getDetailedExitCode(traverseException);
if (detailedExitCode != null || traverseException.getCause() == null) {
break;
}
traverseException = (Exception) traverseException.getCause();
}
return detailedExitCode;
}
public PrepareAnalysisPhaseValue prepareAnalysisPhase(
ExtendedEventHandler eventHandler,
BuildOptions buildOptions,
Set<String> multiCpu,
Collection<Label> labels)
throws InvalidConfigurationException, InterruptedException {
SkyKey key = PrepareAnalysisPhaseValue.key(buildOptions, multiCpu, labels);
EvaluationResult<PrepareAnalysisPhaseValue> evalResult =
evaluate(
ImmutableList.of(key),
/*keepGoing=*/ true,
/*numThreads=*/ DEFAULT_THREAD_COUNT,
eventHandler);
if (evalResult.hasError()) {
ErrorInfo errorInfo = evalResult.getError(key);
Exception e = errorInfo.getException();
if (e == null && !errorInfo.getCycleInfo().isEmpty()) {
cyclesReporter.reportCycles(errorInfo.getCycleInfo(), key, eventHandler);
e =
new InvalidConfigurationException(
"cannot load build configuration because of this cycle", Code.CYCLE);
} else if (e instanceof DetailedException) {
e = new InvalidConfigurationException(((DetailedException) e).getDetailedExitCode(), e);
}
if (e != null) {
Throwables.throwIfInstanceOf(e, InvalidConfigurationException.class);
}
throw new IllegalStateException("Unknown error during configuration creation evaluation", e);
}
if (configuredTargetProgress != null) {
configuredTargetProgress.reset();
}
return evalResult.get(key);
}
@Nullable
RuleContextConstraintSemantics getRuleContextConstraintSemantics() {
return ruleContextConstraintSemantics;
}
public void setRuleContextConstraintSemantics(
RuleContextConstraintSemantics ruleContextConstraintSemantics) {
this.ruleContextConstraintSemantics = ruleContextConstraintSemantics;
}
/** A progress receiver to track analysis invalidation and update progress messages. */
protected class SkyframeProgressReceiver implements EvaluationProgressReceiver {
/**
* This flag is needed in order to avoid invalidating legacy data when we clear the analysis
* cache because of --discard_analysis_cache flag. For that case we want to keep the legacy data
* but get rid of the Skyframe data.
*/
protected boolean ignoreInvalidations = false;
/** This receiver is only needed for execution, so it is null otherwise. */
@Nullable EvaluationProgressReceiver executionProgressReceiver = null;
@Override
public void invalidated(SkyKey skyKey, InvalidationState state) {
if (ignoreInvalidations) {
return;
}
skyframeBuildView.getProgressReceiver().invalidated(skyKey, state);
}
@Override
public void enqueueing(SkyKey skyKey) {
if (ignoreInvalidations) {
return;
}
skyframeBuildView.getProgressReceiver().enqueueing(skyKey);
if (executionProgressReceiver != null) {
executionProgressReceiver.enqueueing(skyKey);
}
}
@Override
public void stateStarting(SkyKey skyKey, NodeState nodeState) {
if (NodeState.COMPUTE.equals(nodeState)) {
skyKeyStateReceiver.computationStarted(skyKey);
}
}
@Override
public void stateEnding(SkyKey skyKey, NodeState nodeState) {
if (NodeState.COMPUTE.equals(nodeState)) {
skyKeyStateReceiver.computationEnded(skyKey);
}
}
@Override
public void evaluated(
SkyKey skyKey,
@Nullable SkyValue newValue,
@Nullable ErrorInfo newError,
Supplier<EvaluationSuccessState> evaluationSuccessState,
EvaluationState state) {
if (EvaluationState.BUILT.equals(state)) {
skyKeyStateReceiver.evaluated(skyKey);
}
if (ignoreInvalidations) {
return;
}
skyframeBuildView
.getProgressReceiver()
.evaluated(skyKey, newValue, newError, evaluationSuccessState, state);
if (executionProgressReceiver != null) {
executionProgressReceiver.evaluated(
skyKey, newValue, newError, evaluationSuccessState, state);
}
}
}
public final ExecutionFinishedEvent createExecutionFinishedEvent() {
return createExecutionFinishedEventInternal()
.setSourceArtifactsRead(sourceArtifactsSeen.toFilesMetricAndReset())
.setOutputArtifactsSeen(outputArtifactsSeen.toFilesMetricAndReset())
.setOutputArtifactsFromActionCache(outputArtifactsFromActionCache.toFilesMetricAndReset())
.setTopLevelArtifacts(topLevelArtifactsMetric.toFilesMetricAndReset())
.build();
}
@ForOverride
protected ExecutionFinishedEvent.Builder createExecutionFinishedEventInternal() {
return ExecutionFinishedEvent.builderWithDefaults();
}
final AnalysisTraversalResult getActionLookupValuesInBuild(
List<ConfiguredTargetKey> topLevelCtKeys, ImmutableList<AspectKey> aspectKeys)
throws InterruptedException {
try (SilentCloseable c =
Profiler.instance().profile("skyframeExecutor.getActionLookupValuesInBuild")) {
AnalysisTraversalResult result = new AnalysisTraversalResult();
if (!tracksStateForIncrementality()) {
// If we do not have graph edges, we cannot traverse the graph and find only actions in the
// current build. In this case we can simply return all ActionLookupValues in the graph,
// since the graph's lifetime is a single build anyway.
for (Map.Entry<SkyKey, SkyValue> entry : memoizingEvaluator.getDoneValues().entrySet()) {
if ((entry.getKey() instanceof ActionLookupKey) && entry.getValue() != null) {
result.accumulate((ActionLookupKey) entry.getKey(), entry.getValue());
}
}
return result;
}
Map<ActionLookupKey, SkyValue> foundActions =
new TransitiveActionLookupKeysCollector(SkyframeExecutorWrappingWalkableGraph.of(this))
.collect(Iterables.concat(topLevelCtKeys, aspectKeys));
foundActions.forEach(result::accumulate);
return result;
}
}
/**
* Collects the transitive ActionLookupKeys of the provided {@code key}, taking into account the
* set of visited ALKs this build for pruning.
*/
private ActionLookupValuesCollectionResult collectTransitiveActionLookupValues(
ActionLookupKey key) {
try (SilentCloseable c =
Profiler.instance().profile("SkyframeExecutor.collectTransitiveActionLookupValues")) {
AnalysisTraversalResult result = new AnalysisTraversalResult();
Map<ActionLookupKey, SkyValue> foundTransitiveActionLookupEntities =
incrementalTransitiveActionLookupKeysCollector.collect(key);
foundTransitiveActionLookupEntities.forEach(result::accumulate);
return ActionLookupValuesCollectionResult.create(
result.getActionShards(),
ImmutableSet.copyOf(foundTransitiveActionLookupEntities.keySet()));
}
}
static class AnalysisTraversalResult {
// Some metrics indicate this is a rough average # of ALVs in a build.
private final Sharder<ActionLookupValue> actionShards = new Sharder<>(NUM_JOBS, 200_000);
// Metrics.
private int configuredObjectCount = 0;
private int configuredTargetCount = 0;
private int actionCount = 0;
private int actionCountNotIncludingAspects = 0;
private int inputFileConfiguredTargetCount = 0;
private int outputFileConfiguredTargetCount = 0;
private int otherConfiguredTargetCount = 0;
private AnalysisTraversalResult() {}
private void accumulate(ActionLookupKey keyForDebugging, SkyValue value) {
boolean isConfiguredTarget = value instanceof ConfiguredTargetValue;
boolean isActionLookupValue = value instanceof ActionLookupValue;
if (!isConfiguredTarget && !isActionLookupValue) {
BugReport.sendBugReport(
new IllegalStateException(
String.format(
"Should only be called with ConfiguredTargetValue or ActionLookupValue: %s %s"
+ " %s",
value.getClass(), keyForDebugging, value)));
return;
}
configuredObjectCount++;
if (isConfiguredTarget) {
configuredTargetCount++;
}
if (isActionLookupValue) {
ActionLookupValue alv = (ActionLookupValue) value;
int numActions = alv.getNumActions();
actionCount += numActions;
if (isConfiguredTarget) {
actionCountNotIncludingAspects += numActions;
}
actionShards.add(alv);
return;
}
if (!(value instanceof NonRuleConfiguredTargetValue)) {
BugReport.sendBugReport(
new IllegalStateException(
String.format(
"Unexpected value type: %s %s %s", value.getClass(), keyForDebugging, value)));
return;
}
ConfiguredTarget configuredTarget =
((NonRuleConfiguredTargetValue) value).getConfiguredTarget();
if (configuredTarget instanceof InputFileConfiguredTarget) {
inputFileConfiguredTargetCount++;
} else if (configuredTarget instanceof OutputFileConfiguredTarget) {
outputFileConfiguredTargetCount++;
} else {
otherConfiguredTargetCount++;
}
}
Sharder<ActionLookupValue> getActionShards() {
return actionShards;
}
int getActionCount() {
return actionCount;
}
BuildEventStreamProtos.BuildMetrics.BuildGraphMetrics.Builder getMetrics() {
return BuildEventStreamProtos.BuildMetrics.BuildGraphMetrics.newBuilder()
.setActionLookupValueCount(configuredObjectCount)
.setActionLookupValueCountNotIncludingAspects(configuredTargetCount)
.setActionCount(actionCount)
.setActionCountNotIncludingAspects(actionCountNotIncludingAspects)
.setInputFileConfiguredTargetCount(inputFileConfiguredTargetCount)
.setOutputFileConfiguredTargetCount(outputFileConfiguredTargetCount)
.setOtherConfiguredTargetCount(otherConfiguredTargetCount);
}
}
/**
* Given a collection of ActionLookupKeys, collect the ActionLookupKeys in their transitive
* closure.
*
* <p>This class is called once after the analysis phase for action conflict checking. There's
* only 1 instance per build.
*/
private static class TransitiveActionLookupKeysCollector {
final ForkJoinPool executorService =
NamedForkJoinPool.newNamedPool(
"find-action-lookup-values-in-build", Runtime.getRuntime().availableProcessors());
private final WalkableGraph walkableGraph;
TransitiveActionLookupKeysCollector(WalkableGraph walkableGraph) {
this.walkableGraph = walkableGraph;
}
/**
* Traverses the transitive closure of the visitationRoots and returns a mapping of
* ActionLookupKey -> SkyValue for the keys previously UNVISITED by this
* TransitiveActionLookupKeysCollector instance.
*/
Map<ActionLookupKey, SkyValue> collect(Iterable<ActionLookupKey> visitationRoots)
throws InterruptedException {
try {
Map<ActionLookupKey, SkyValue> collected = Maps.newConcurrentMap();
List<Future<?>> futures = Lists.newArrayListWithCapacity(Iterables.size(visitationRoots));
for (ActionLookupKey actionLookupKey : visitationRoots) {
futures.add(executorService.submit(new VisitActionLookupKey(actionLookupKey, collected)));
}
for (Future<?> future : futures) {
future.get();
}
return collected;
} catch (ExecutionException e) {
throw new IllegalStateException("Error collecting transitive ActionLookupValues", e);
} finally {
shutdown();
}
}
boolean seen(ActionLookupKey key, Map<ActionLookupKey, SkyValue> collected) {
return collected.containsKey(key);
}
void shutdown() throws InterruptedException {
if (ExecutorUtil.interruptibleShutdown(executorService)) {
throw new InterruptedException();
}
}
protected final class VisitActionLookupKey extends RecursiveAction {
private final ActionLookupKey key;
private final Map<ActionLookupKey, SkyValue> collected;
private VisitActionLookupKey(ActionLookupKey key, Map<ActionLookupKey, SkyValue> collected) {
this.key = key;
this.collected = collected;
}
@Override
public void compute() {
SkyValue value;
try {
value = walkableGraph.getValue(key);
} catch (InterruptedException e) {
return;
}
if (value == null) {
return; // The value failed to evaluate.
}
collected.put(key, value);
Iterable<SkyKey> directDeps;
try {
directDeps = walkableGraph.getDirectDeps(key);
} catch (InterruptedException e) {
return;
}
List<VisitActionLookupKey> subtasks = new ArrayList<>(Iterables.size(directDeps));
for (SkyKey dep : directDeps) {
if (!(dep instanceof ActionLookupKey) || seen((ActionLookupKey) dep, collected)) {
// The subgraph of dependencies of ActionLookupKeys never has a non-ActionLookupKey
// depending on an ActionLookupKey. So we can skip any non-ActionLookupKeys in the
// traversal as an optimization.
continue;
}
subtasks.add(new VisitActionLookupKey((ActionLookupKey) dep, collected));
}
invokeAll(subtasks);
}
}
}
/**
* This class is the Skymeld-only extension of {@link TransitiveActionLookupKeysCollector}.
*
* <p>Called multiple times per build: after each top-level ActionLookupKey finishes its analysis
* and wants to check for action conflicts. The instance lives throughout the length of the build,
* and is cleared after the build is done. There's only one instance per build.
*/
private static final class IncrementalTransitiveActionLookupKeysCollector
extends TransitiveActionLookupKeysCollector {
private final Set<SkyKey> globalVisitedSet;
private IncrementalTransitiveActionLookupKeysCollector(
WalkableGraph walkableGraph, Set<SkyKey> globalVisitedSet) {
super(walkableGraph);
this.globalVisitedSet = globalVisitedSet;
}
@Override
Map<ActionLookupKey, SkyValue> collect(Iterable<ActionLookupKey> visitationRoots) {
throw new UnsupportedOperationException(
"IncrementalTransitiveActionLookupKeysCollector expects only a single visitation root.");
}
/**
* Collects the ALKs in the transitive closure of the given single visitation root which have
* not been confirmed to be conflict-free.
*
* <p>IMPORTANT: due to pruning, the set of returned ActionLookupKey is a SUBSET of the set of
* elements in the transitive closure of the visitationRoot.
*/
Map<ActionLookupKey, SkyValue> collect(ActionLookupKey visitationRoot) {
Map<ActionLookupKey, SkyValue> collected = Maps.newConcurrentMap();
if (seen(visitationRoot, collected)) {
return collected;
}
executorService.invoke(new VisitActionLookupKey(visitationRoot, collected));
return collected;
}
@Override
boolean seen(ActionLookupKey key, Map<ActionLookupKey, SkyValue> collected) {
return globalVisitedSet.contains(key) || collected.containsKey(key);
}
}
private <T extends SkyValue> EvaluationResult<T> evaluate(
Iterable<? extends SkyKey> roots,
boolean keepGoing,
int numThreads,
ExtendedEventHandler eventHandler)
throws InterruptedException {
EvaluationContext evaluationContext =
newEvaluationContextBuilder()
.setKeepGoing(keepGoing)
.setNumThreads(numThreads)
.setEventHandler(eventHandler)
.build();
return memoizingEvaluator.evaluate(roots, evaluationContext);
}
private static final UnnecessaryTemporaryStateDropper NULL_UNNECESSARY_TEMPORARY_STATE_DROPPER =
() -> {};
private volatile UnnecessaryTemporaryStateDropper dropper =
NULL_UNNECESSARY_TEMPORARY_STATE_DROPPER;
private final UnnecessaryTemporaryStateDropperReceiver unnecessaryTemporaryStateDropperReceiver =
new UnnecessaryTemporaryStateDropperReceiver() {
@Override
public void onEvaluationStarted(UnnecessaryTemporaryStateDropper dropper) {
SkyframeExecutor.this.dropper = dropper;
}
@Override
public void onEvaluationFinished() {
SkyframeExecutor.this.dropper = NULL_UNNECESSARY_TEMPORARY_STATE_DROPPER;
}
};
protected final EvaluationContext.Builder newEvaluationContextBuilder() {
return EvaluationContext.newBuilder()
.setUnnecessaryTemporaryStateDropperReceiver(unnecessaryTemporaryStateDropperReceiver);
}
void dropUnnecessaryTemporarySkyframeState() {
dropper.drop();
}
/** Receiver for successfully evaluated/doing computation {@link SkyKey}s. */
public interface SkyKeyStateReceiver {
SkyKeyStateReceiver NULL_INSTANCE = new SkyKeyStateReceiver() {};
/** Called when {@code key}'s associated {@link SkyFunction#compute} is called. */
default void computationStarted(SkyKey key) {}
/** Called when {@code key}'s associated {@link SkyFunction#compute} has finished. */
default void computationEnded(SkyKey key) {}
/** Called when {@code key} has been evaluated and has a value. */
default void evaluated(SkyKey key) {}
default ThreadStateReceiver makeThreadStateReceiver(SkyKey key) {
return ThreadStateReceiver.NULL_INSTANCE;
}
}
}