| // Copyright 2017 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.packages; |
| |
| import static com.google.common.base.Preconditions.checkState; |
| |
| import com.google.common.base.Preconditions; |
| import com.google.common.cache.Cache; |
| import com.google.common.cache.CacheBuilder; |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.collect.ImmutableSet; |
| import com.google.common.collect.Iterables; |
| import com.google.common.eventbus.EventBus; |
| import com.google.devtools.build.lib.analysis.BlazeDirectories; |
| import com.google.devtools.build.lib.analysis.ServerDirectories; |
| import com.google.devtools.build.lib.clock.BlazeClock; |
| import com.google.devtools.build.lib.cmdline.PackageIdentifier; |
| import com.google.devtools.build.lib.events.Reporter; |
| import com.google.devtools.build.lib.packages.AstParseResult; |
| import com.google.devtools.build.lib.packages.AttributeContainer; |
| import com.google.devtools.build.lib.packages.BuildFileContainsErrorsException; |
| import com.google.devtools.build.lib.packages.BuildFileName; |
| import com.google.devtools.build.lib.packages.CachingPackageLocator; |
| import com.google.devtools.build.lib.packages.ConstantRuleVisibility; |
| import com.google.devtools.build.lib.packages.NoSuchPackageException; |
| import com.google.devtools.build.lib.packages.Package; |
| import com.google.devtools.build.lib.packages.PackageFactory; |
| import com.google.devtools.build.lib.packages.PackageFactory.EnvironmentExtension; |
| import com.google.devtools.build.lib.packages.RuleClassProvider; |
| import com.google.devtools.build.lib.pkgcache.PathPackageLocator; |
| import com.google.devtools.build.lib.skyframe.ASTFileLookupFunction; |
| import com.google.devtools.build.lib.skyframe.BazelSkyframeExecutorConstants; |
| import com.google.devtools.build.lib.skyframe.BlacklistedPackagePrefixesFunction; |
| import com.google.devtools.build.lib.skyframe.ContainingPackageLookupFunction; |
| import com.google.devtools.build.lib.skyframe.ExternalFilesHelper; |
| import com.google.devtools.build.lib.skyframe.ExternalFilesHelper.ExternalFileAction; |
| import com.google.devtools.build.lib.skyframe.ExternalPackageFunction; |
| import com.google.devtools.build.lib.skyframe.FileFunction; |
| import com.google.devtools.build.lib.skyframe.FileStateFunction; |
| import com.google.devtools.build.lib.skyframe.FileSymlinkCycleUniquenessFunction; |
| import com.google.devtools.build.lib.skyframe.FileSymlinkInfiniteExpansionUniquenessFunction; |
| import com.google.devtools.build.lib.skyframe.PackageFunction; |
| import com.google.devtools.build.lib.skyframe.PackageFunction.ActionOnIOExceptionReadingBuildFile; |
| import com.google.devtools.build.lib.skyframe.PackageFunction.IncrementalityIntent; |
| import com.google.devtools.build.lib.skyframe.PackageFunction.LoadedPackageCacheEntry; |
| import com.google.devtools.build.lib.skyframe.PackageLookupFunction; |
| import com.google.devtools.build.lib.skyframe.PackageLookupFunction.CrossRepositoryLabelViolationStrategy; |
| import com.google.devtools.build.lib.skyframe.PackageValue; |
| import com.google.devtools.build.lib.skyframe.PerBuildSyscallCache; |
| import com.google.devtools.build.lib.skyframe.PrecomputedFunction; |
| import com.google.devtools.build.lib.skyframe.PrecomputedValue; |
| import com.google.devtools.build.lib.skyframe.SkyFunctions; |
| import com.google.devtools.build.lib.skyframe.SkylarkImportLookupFunction; |
| import com.google.devtools.build.lib.skyframe.WorkspaceASTFunction; |
| import com.google.devtools.build.lib.skyframe.WorkspaceFileFunction; |
| import com.google.devtools.build.lib.skyframe.WorkspaceNameFunction; |
| import com.google.devtools.build.lib.syntax.SkylarkSemantics; |
| import com.google.devtools.build.lib.util.io.TimestampGranularityMonitor; |
| 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.skyframe.BuildDriver; |
| import com.google.devtools.build.skyframe.Differencer; |
| import com.google.devtools.build.skyframe.ErrorInfo; |
| import com.google.devtools.build.skyframe.EvaluationProgressReceiver; |
| import com.google.devtools.build.skyframe.EvaluationResult; |
| import com.google.devtools.build.skyframe.GraphInconsistencyReceiver; |
| 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.SequentialBuildDriver; |
| 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.Version; |
| import com.google.devtools.build.skyframe.WalkableGraph; |
| import java.util.ArrayList; |
| import java.util.Arrays; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.concurrent.atomic.AtomicBoolean; |
| import java.util.concurrent.atomic.AtomicInteger; |
| import java.util.concurrent.atomic.AtomicReference; |
| import javax.annotation.Nullable; |
| |
| /** |
| * Abstract base class of a {@link PackageLoader} implementation that has no incrementality or |
| * caching. |
| */ |
| public abstract class AbstractPackageLoader implements PackageLoader { |
| |
| // See {@link PackageFactory.setMaxDirectoriesToEagerlyVisitInGlobbing}. |
| private static final int MAX_DIRECTORIES_TO_EAGERLY_VISIT_IN_GLOBBING = 3000; |
| |
| private final ImmutableDiff preinjectedDiff; |
| private final Differencer preinjectedDifferencer = |
| new Differencer() { |
| @Override |
| public Diff getDiff(WalkableGraph fromGraph, Version fromVersion, Version toVersion) |
| throws InterruptedException { |
| return preinjectedDiff; |
| } |
| }; |
| private final Reporter reporter; |
| protected final RuleClassProvider ruleClassProvider; |
| protected SkylarkSemantics skylarkSemantics; |
| protected final ImmutableMap<SkyFunctionName, SkyFunction> extraSkyFunctions; |
| private final AtomicReference<PathPackageLocator> pkgLocatorRef; |
| protected final ExternalFilesHelper externalFilesHelper; |
| protected final BlazeDirectories directories; |
| private final int legacyGlobbingThreads; |
| private final int skyframeThreads; |
| |
| /** Abstract base class of a builder for {@link PackageLoader} instances. */ |
| public abstract static class Builder { |
| protected final Path workspaceDir; |
| protected final BlazeDirectories directories; |
| protected final PathPackageLocator pkgLocator; |
| final AtomicReference<PathPackageLocator> pkgLocatorRef; |
| protected final ExternalFilesHelper externalFilesHelper; |
| protected RuleClassProvider ruleClassProvider = getDefaultRuleClassProvider(); |
| protected SkylarkSemantics skylarkSemantics; |
| protected Reporter reporter = new Reporter(new EventBus()); |
| protected Map<SkyFunctionName, SkyFunction> extraSkyFunctions = new HashMap<>(); |
| List<PrecomputedValue.Injected> extraPrecomputedValues = new ArrayList<>(); |
| String defaultsPackageContents = getDefaultDefaultPackageContents(); |
| int legacyGlobbingThreads = 1; |
| int skyframeThreads = 1; |
| |
| protected Builder(Path workspaceDir, Path installBase, Path outputBase) { |
| this.workspaceDir = workspaceDir; |
| Path devNull = workspaceDir.getFileSystem().getPath("/dev/null"); |
| directories = |
| new BlazeDirectories( |
| new ServerDirectories(installBase, outputBase, devNull), |
| workspaceDir, |
| /* defaultSystemJavabase= */ null, |
| "blaze"); |
| |
| this.pkgLocator = |
| new PathPackageLocator( |
| directories.getOutputBase(), |
| ImmutableList.of(Root.fromPath(workspaceDir)), |
| BazelSkyframeExecutorConstants.BUILD_FILES_BY_PRIORITY); |
| this.pkgLocatorRef = new AtomicReference<>(pkgLocator); |
| this.externalFilesHelper = |
| ExternalFilesHelper.create( |
| pkgLocatorRef, |
| ExternalFileAction.DEPEND_ON_EXTERNAL_PKG_FOR_EXTERNAL_REPO_PATHS, |
| directories); |
| } |
| |
| public Builder setRuleClassProvider(RuleClassProvider ruleClassProvider) { |
| this.ruleClassProvider = ruleClassProvider; |
| return this; |
| } |
| |
| public Builder setSkylarkSemantics(SkylarkSemantics semantics) { |
| this.skylarkSemantics = semantics; |
| return this; |
| } |
| |
| public Builder useDefaultSkylarkSemantics() { |
| this.skylarkSemantics = SkylarkSemantics.DEFAULT_SEMANTICS; |
| return this; |
| } |
| |
| public Builder setReporter(Reporter reporter) { |
| this.reporter = reporter; |
| return this; |
| } |
| |
| public Builder addExtraSkyFunctions( |
| ImmutableMap<SkyFunctionName, SkyFunction> extraSkyFunctions) { |
| this.extraSkyFunctions.putAll(extraSkyFunctions); |
| return this; |
| } |
| |
| public Builder addExtraPrecomputedValues(PrecomputedValue.Injected... extraPrecomputedValues) { |
| return this.addExtraPrecomputedValues(Arrays.asList(extraPrecomputedValues)); |
| } |
| |
| public Builder addExtraPrecomputedValues( |
| List<PrecomputedValue.Injected> extraPrecomputedValues) { |
| this.extraPrecomputedValues.addAll(extraPrecomputedValues); |
| return this; |
| } |
| |
| public Builder setLegacyGlobbingThreads(int numThreads) { |
| this.legacyGlobbingThreads = numThreads; |
| return this; |
| } |
| |
| public Builder setSkyframeThreads(int skyframeThreads) { |
| this.skyframeThreads = skyframeThreads; |
| return this; |
| } |
| |
| /** Throws {@link IllegalArgumentException} if builder args are incomplete/inconsistent. */ |
| protected void validate() { |
| if (skylarkSemantics == null) { |
| throw new IllegalArgumentException( |
| "must call either setSkylarkSemantics or useDefaultSkylarkSemantics"); |
| } |
| } |
| |
| public final PackageLoader build() { |
| validate(); |
| return buildImpl(); |
| } |
| |
| protected abstract PackageLoader buildImpl(); |
| |
| protected abstract RuleClassProvider getDefaultRuleClassProvider(); |
| |
| protected abstract String getDefaultDefaultPackageContents(); |
| } |
| |
| AbstractPackageLoader(Builder builder) { |
| this.ruleClassProvider = builder.ruleClassProvider; |
| this.skylarkSemantics = builder.skylarkSemantics; |
| this.reporter = builder.reporter; |
| this.extraSkyFunctions = ImmutableMap.copyOf(builder.extraSkyFunctions); |
| this.pkgLocatorRef = builder.pkgLocatorRef; |
| this.legacyGlobbingThreads = builder.legacyGlobbingThreads; |
| this.skyframeThreads = builder.skyframeThreads; |
| this.directories = builder.directories; |
| |
| this.externalFilesHelper = builder.externalFilesHelper; |
| |
| this.preinjectedDiff = |
| makePreinjectedDiff( |
| skylarkSemantics, |
| builder.pkgLocator, |
| builder.defaultsPackageContents, |
| ImmutableList.copyOf(builder.extraPrecomputedValues)); |
| } |
| |
| private static ImmutableDiff makePreinjectedDiff( |
| SkylarkSemantics skylarkSemantics, |
| PathPackageLocator pkgLocator, |
| String defaultsPackageContents, |
| ImmutableList<PrecomputedValue.Injected> extraPrecomputedValues) { |
| final Map<SkyKey, SkyValue> valuesToInject = new HashMap<>(); |
| Injectable injectable = |
| new Injectable() { |
| @Override |
| public void inject(Map<SkyKey, ? extends SkyValue> values) { |
| valuesToInject.putAll(values); |
| } |
| |
| @Override |
| public void inject(SkyKey key, SkyValue value) { |
| valuesToInject.put(key, value); |
| } |
| }; |
| for (PrecomputedValue.Injected injected : extraPrecomputedValues) { |
| injected.inject(injectable); |
| } |
| PrecomputedValue.PATH_PACKAGE_LOCATOR.set(injectable, pkgLocator); |
| PrecomputedValue.DEFAULT_VISIBILITY.set(injectable, ConstantRuleVisibility.PRIVATE); |
| PrecomputedValue.SKYLARK_SEMANTICS.set(injectable, skylarkSemantics); |
| PrecomputedValue.DEFAULTS_PACKAGE_CONTENTS.set(injectable, defaultsPackageContents); |
| return new ImmutableDiff(ImmutableList.of(), valuesToInject); |
| } |
| |
| @Override |
| public Package loadPackage(PackageIdentifier pkgId) |
| throws NoSuchPackageException, InterruptedException { |
| return loadPackages(ImmutableList.of(pkgId)).get(pkgId).get(); |
| } |
| |
| @Override |
| public ImmutableMap<PackageIdentifier, PackageLoader.PackageOrException> loadPackages( |
| Iterable<? extends PackageIdentifier> pkgIds) throws InterruptedException { |
| ArrayList<SkyKey> keys = new ArrayList<>(); |
| for (PackageIdentifier pkgId : ImmutableSet.copyOf(pkgIds)) { |
| keys.add(PackageValue.key(pkgId)); |
| } |
| |
| EvaluationResult<PackageValue> evalResult = |
| makeFreshDriver().evaluate(keys, /*keepGoing=*/ true, skyframeThreads, reporter); |
| |
| ImmutableMap.Builder<PackageIdentifier, PackageLoader.PackageOrException> result = |
| ImmutableMap.builder(); |
| for (SkyKey key : keys) { |
| ErrorInfo error = evalResult.getError(key); |
| PackageValue packageValue = evalResult.get(key); |
| checkState((error == null) != (packageValue == null)); |
| PackageIdentifier pkgId = (PackageIdentifier) key.argument(); |
| result.put( |
| pkgId, |
| error != null |
| ? new PackageOrException(null, exceptionFromErrorInfo(error, pkgId)) |
| : new PackageOrException(packageValue.getPackage(), null)); |
| } |
| |
| return result.build(); |
| } |
| |
| private static NoSuchPackageException exceptionFromErrorInfo( |
| ErrorInfo error, PackageIdentifier pkgId) { |
| if (!Iterables.isEmpty(error.getCycleInfo())) { |
| return new BuildFileContainsErrorsException( |
| pkgId, "Cycle encountered while loading package " + pkgId); |
| } |
| Throwable e = Preconditions.checkNotNull(error.getException()); |
| if (e instanceof NoSuchPackageException) { |
| return (NoSuchPackageException) e; |
| } |
| throw new IllegalStateException( |
| "Unexpected Exception type from PackageValue for '" |
| + pkgId |
| + "'' with root causes: " |
| + Iterables.toString(error.getRootCauses()), |
| e); |
| } |
| |
| private BuildDriver makeFreshDriver() { |
| return new SequentialBuildDriver( |
| InMemoryMemoizingEvaluator.SUPPLIER.create( |
| makeFreshSkyFunctions(), |
| preinjectedDifferencer, |
| new EvaluationProgressReceiver.NullEvaluationProgressReceiver(), |
| GraphInconsistencyReceiver.THROWING, |
| new MemoizingEvaluator.EmittedEventState(), |
| /*keepEdges=*/ false)); |
| } |
| |
| /** |
| * Version is the string BazelPackageLoader reports in native.bazel_version to be used by Skylark. |
| */ |
| protected abstract String getVersion(); |
| |
| protected abstract ImmutableList<EnvironmentExtension> getEnvironmentExtensions(); |
| |
| protected abstract CrossRepositoryLabelViolationStrategy |
| getCrossRepositoryLabelViolationStrategy(); |
| |
| protected abstract ImmutableList<BuildFileName> getBuildFilesByPriority(); |
| |
| protected abstract ActionOnIOExceptionReadingBuildFile getActionOnIOExceptionReadingBuildFile(); |
| |
| private ImmutableMap<SkyFunctionName, SkyFunction> makeFreshSkyFunctions() { |
| AtomicReference<TimestampGranularityMonitor> tsgm = |
| new AtomicReference<>(new TimestampGranularityMonitor(BlazeClock.instance())); |
| Cache<PackageIdentifier, LoadedPackageCacheEntry> packageFunctionCache = |
| CacheBuilder.newBuilder().build(); |
| Cache<PackageIdentifier, AstParseResult> astCache = CacheBuilder.newBuilder().build(); |
| AtomicReference<PerBuildSyscallCache> syscallCacheRef = |
| new AtomicReference<>( |
| PerBuildSyscallCache.newBuilder().setConcurrencyLevel(legacyGlobbingThreads).build()); |
| PackageFactory pkgFactory = |
| new PackageFactory( |
| ruleClassProvider, |
| AttributeContainer::new, |
| getEnvironmentExtensions(), |
| getVersion(), |
| Package.Builder.DefaultHelper.INSTANCE); |
| pkgFactory.setGlobbingThreads(legacyGlobbingThreads); |
| pkgFactory.setSyscalls(syscallCacheRef); |
| pkgFactory.setMaxDirectoriesToEagerlyVisitInGlobbing( |
| MAX_DIRECTORIES_TO_EAGERLY_VISIT_IN_GLOBBING); |
| CachingPackageLocator cachingPackageLocator = |
| new CachingPackageLocator() { |
| @Override |
| @Nullable |
| public Path getBuildFileForPackage(PackageIdentifier packageName) { |
| return pkgLocatorRef.get().getPackageBuildFileNullable(packageName, syscallCacheRef); |
| } |
| }; |
| ImmutableMap.Builder<SkyFunctionName, SkyFunction> builder = ImmutableMap.builder(); |
| builder |
| .put(SkyFunctions.PRECOMPUTED, new PrecomputedFunction()) |
| .put(SkyFunctions.FILE_STATE, new FileStateFunction(tsgm, externalFilesHelper)) |
| .put(SkyFunctions.FILE_SYMLINK_CYCLE_UNIQUENESS, new FileSymlinkCycleUniquenessFunction()) |
| .put( |
| SkyFunctions.FILE_SYMLINK_INFINITE_EXPANSION_UNIQUENESS, |
| new FileSymlinkInfiniteExpansionUniquenessFunction()) |
| .put(SkyFunctions.FILE, new FileFunction(pkgLocatorRef)) |
| .put( |
| SkyFunctions.PACKAGE_LOOKUP, |
| new PackageLookupFunction( |
| /* deletedPackages= */ new AtomicReference<>(ImmutableSet.of()), |
| getCrossRepositoryLabelViolationStrategy(), |
| getBuildFilesByPriority())) |
| .put( |
| SkyFunctions.BLACKLISTED_PACKAGE_PREFIXES, |
| new BlacklistedPackagePrefixesFunction( |
| /*hardcodedBlacklistedPackagePrefixes=*/ ImmutableSet.of(), |
| /*additionalBlacklistedPackagePrefixesFile=*/ PathFragment.EMPTY_FRAGMENT)) |
| .put(SkyFunctions.CONTAINING_PACKAGE_LOOKUP, new ContainingPackageLookupFunction()) |
| .put(SkyFunctions.AST_FILE_LOOKUP, new ASTFileLookupFunction(ruleClassProvider)) |
| .put( |
| SkyFunctions.SKYLARK_IMPORTS_LOOKUP, |
| new SkylarkImportLookupFunction(ruleClassProvider, pkgFactory)) |
| .put(SkyFunctions.WORKSPACE_NAME, new WorkspaceNameFunction()) |
| .put(SkyFunctions.WORKSPACE_AST, new WorkspaceASTFunction(ruleClassProvider)) |
| .put( |
| SkyFunctions.WORKSPACE_FILE, |
| new WorkspaceFileFunction(ruleClassProvider, pkgFactory, directories)) |
| .put(SkyFunctions.EXTERNAL_PACKAGE, new ExternalPackageFunction()) |
| .put( |
| SkyFunctions.PACKAGE, |
| new PackageFunction( |
| pkgFactory, |
| cachingPackageLocator, |
| /*showLoadingProgress=*/ new AtomicBoolean(false), |
| packageFunctionCache, |
| astCache, |
| /*numPackagesLoaded=*/ new AtomicInteger(0), |
| /*skylarkImportLookupFunctionForInlining=*/ null, |
| /*packageProgress=*/ null, |
| getActionOnIOExceptionReadingBuildFile(), |
| // Tell PackageFunction to optimize for our use-case of no incrementality. |
| IncrementalityIntent.NON_INCREMENTAL)) |
| .putAll(extraSkyFunctions); |
| return builder.build(); |
| } |
| } |