| // Copyright 2016 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.runtime; |
| |
| import com.google.common.base.Preconditions; |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.eventbus.SubscriberExceptionHandler; |
| import com.google.devtools.build.lib.analysis.BlazeDirectories; |
| import com.google.devtools.build.lib.analysis.WorkspaceStatusAction; |
| import com.google.devtools.build.lib.bugreport.BugReport; |
| import com.google.devtools.build.lib.exec.BinTools; |
| import com.google.devtools.build.lib.packages.PackageFactory; |
| import com.google.devtools.build.lib.profiler.memory.AllocationTracker; |
| import com.google.devtools.build.lib.skyframe.DiffAwareness; |
| import com.google.devtools.build.lib.skyframe.PerBuildSyscallCache; |
| import com.google.devtools.build.lib.skyframe.SequencedSkyframeExecutorFactory; |
| import com.google.devtools.build.lib.skyframe.SkyframeExecutor; |
| import com.google.devtools.build.lib.skyframe.SkyframeExecutorFactory; |
| import com.google.devtools.build.lib.skyframe.SkyframeExecutorRepositoryHelpersHolder; |
| import com.google.devtools.build.lib.util.AbruptExitException; |
| import com.google.devtools.build.lib.vfs.SyscallCache; |
| import com.google.devtools.build.skyframe.SkyFunction; |
| import com.google.devtools.build.skyframe.SkyFunctionName; |
| import com.google.errorprone.annotations.CanIgnoreReturnValue; |
| import java.util.Map; |
| import javax.annotation.Nullable; |
| |
| /** |
| * Builder class to create a {@link BlazeWorkspace} instance. This class is part of the module API, |
| * which allows modules to affect how the workspace is initialized. |
| */ |
| public final class WorkspaceBuilder { |
| private final BlazeDirectories directories; |
| private final BinTools binTools; |
| |
| private SkyframeExecutorFactory skyframeExecutorFactory; |
| private WorkspaceStatusAction.Factory workspaceStatusActionFactory; |
| private final ImmutableList.Builder<DiffAwareness.Factory> diffAwarenessFactories = |
| ImmutableList.builder(); |
| // We use an immutable map builder for the nice side effect that it throws if a duplicate key |
| // is inserted. |
| private final ImmutableMap.Builder<SkyFunctionName, SkyFunction> skyFunctions = |
| ImmutableMap.builder(); |
| private AllocationTracker allocationTracker; |
| |
| @Nullable |
| private SkyframeExecutorRepositoryHelpersHolder skyframeExecutorRepositoryHelpersHolder = null; |
| |
| @Nullable private SkyframeExecutor.SkyKeyStateReceiver skyKeyStateReceiver = null; |
| private SyscallCache perCommandSyscallCache; |
| |
| WorkspaceBuilder(BlazeDirectories directories, BinTools binTools) { |
| this.directories = directories; |
| this.binTools = binTools; |
| } |
| |
| public static int getSyscallCacheInitialCapacity() { |
| // The initial capacity here translates into the size of an array in ConcurrentHashMap, so |
| // oversizing by N results in memory usage of 8N bytes. So the maximum wasted memory here is |
| // 1/2^20 of heap, or 10K on a 10G heap (which would start with 1280-capacity caches). |
| long scaledMemory = Runtime.getRuntime().maxMemory() >> 23; |
| if (scaledMemory > Integer.MAX_VALUE) { |
| // Something went very wrong. |
| BugReport.sendBugReport( |
| new IllegalStateException( |
| "Scaled memory was still too big: " |
| + scaledMemory |
| + ", " |
| + Runtime.getRuntime().maxMemory())); |
| scaledMemory = 1024; |
| } else if (scaledMemory <= 0) { |
| // If Bazel is running in <8M of memory, very impressive. |
| scaledMemory = 32; |
| } |
| return (int) scaledMemory; |
| } |
| |
| public static PerBuildSyscallCache createPerBuildSyscallCache() { |
| return PerBuildSyscallCache.newBuilder() |
| .setInitialCapacity(getSyscallCacheInitialCapacity()) |
| .build(); |
| } |
| |
| BlazeWorkspace build( |
| BlazeRuntime runtime, |
| PackageFactory packageFactory, |
| SubscriberExceptionHandler eventBusExceptionHandler) throws AbruptExitException { |
| // Set default values if none are set. |
| if (skyframeExecutorFactory == null) { |
| skyframeExecutorFactory = new SequencedSkyframeExecutorFactory(); |
| } |
| if (perCommandSyscallCache == null) { |
| perCommandSyscallCache = createPerBuildSyscallCache(); |
| } |
| |
| SkyframeExecutor skyframeExecutor = |
| skyframeExecutorFactory.create( |
| packageFactory, |
| runtime.getFileSystem(), |
| directories, |
| runtime.getActionKeyContext(), |
| workspaceStatusActionFactory, |
| diffAwarenessFactories.build(), |
| skyFunctions.buildOrThrow(), |
| perCommandSyscallCache, |
| skyframeExecutorRepositoryHelpersHolder, |
| skyKeyStateReceiver == null |
| ? SkyframeExecutor.SkyKeyStateReceiver.NULL_INSTANCE |
| : skyKeyStateReceiver, |
| runtime.getBugReporter()); |
| return new BlazeWorkspace( |
| runtime, |
| directories, |
| skyframeExecutor, |
| eventBusExceptionHandler, |
| workspaceStatusActionFactory, |
| binTools, |
| allocationTracker, |
| perCommandSyscallCache); |
| } |
| |
| /** |
| * Sets a factory for creating {@link SkyframeExecutor} objects. Note that only one factory per |
| * workspace is allowed. |
| */ |
| @CanIgnoreReturnValue |
| public WorkspaceBuilder setSkyframeExecutorFactory( |
| SkyframeExecutorFactory skyframeExecutorFactory) { |
| Preconditions.checkState(this.skyframeExecutorFactory == null, |
| "At most one Skyframe factory supported. But found two: %s and %s", |
| this.skyframeExecutorFactory, skyframeExecutorFactory); |
| this.skyframeExecutorFactory = Preconditions.checkNotNull(skyframeExecutorFactory); |
| return this; |
| } |
| |
| /** |
| * Sets the workspace status action factory contributed by this module. Only one factory per |
| * workspace is allowed. |
| */ |
| @CanIgnoreReturnValue |
| public WorkspaceBuilder setWorkspaceStatusActionFactory( |
| WorkspaceStatusAction.Factory workspaceStatusActionFactory) { |
| Preconditions.checkState(this.workspaceStatusActionFactory == null, |
| "At most one workspace status action factory supported. But found two: %s and %s", |
| this.workspaceStatusActionFactory, workspaceStatusActionFactory); |
| this.workspaceStatusActionFactory = Preconditions.checkNotNull(workspaceStatusActionFactory); |
| return this; |
| } |
| |
| @CanIgnoreReturnValue |
| public WorkspaceBuilder setAllocationTracker(AllocationTracker allocationTracker) { |
| Preconditions.checkState( |
| this.allocationTracker == null, "At most one allocation tracker can be set."); |
| this.allocationTracker = Preconditions.checkNotNull(allocationTracker); |
| return this; |
| } |
| |
| @CanIgnoreReturnValue |
| public WorkspaceBuilder setPerCommandSyscallCache(SyscallCache perCommandSyscallCache) { |
| Preconditions.checkState( |
| this.perCommandSyscallCache == null, |
| "Set twice: %s %s", |
| this.perCommandSyscallCache, |
| perCommandSyscallCache); |
| this.perCommandSyscallCache = Preconditions.checkNotNull(perCommandSyscallCache); |
| return this; |
| } |
| |
| /** |
| * Add a {@link DiffAwareness} factory. These will be used to determine which files, if any, |
| * changed between Blaze commands. Note that these factories are attempted in the order in which |
| * they are added to this class, so order matters - in order to guarantee a specific order, only a |
| * single module should add such factories. |
| */ |
| @CanIgnoreReturnValue |
| public WorkspaceBuilder addDiffAwarenessFactory(DiffAwareness.Factory factory) { |
| this.diffAwarenessFactories.add(Preconditions.checkNotNull(factory)); |
| return this; |
| } |
| |
| /** Add an "extra" SkyFunction for SkyValues. */ |
| @CanIgnoreReturnValue |
| public WorkspaceBuilder addSkyFunction(SkyFunctionName name, SkyFunction skyFunction) { |
| Preconditions.checkNotNull(name); |
| Preconditions.checkNotNull(skyFunction); |
| this.skyFunctions.put(name, skyFunction); |
| return this; |
| } |
| |
| /** Add "extra" SkyFunctions for SkyValues. */ |
| @CanIgnoreReturnValue |
| public WorkspaceBuilder addSkyFunctions(Map<SkyFunctionName, SkyFunction> skyFunctions) { |
| this.skyFunctions.putAll(Preconditions.checkNotNull(skyFunctions)); |
| return this; |
| } |
| |
| @CanIgnoreReturnValue |
| public WorkspaceBuilder setSkyframeExecutorRepositoryHelpersHolder( |
| SkyframeExecutorRepositoryHelpersHolder skyframeExecutorRepositoryHelpersHolder) { |
| this.skyframeExecutorRepositoryHelpersHolder = skyframeExecutorRepositoryHelpersHolder; |
| return this; |
| } |
| |
| @CanIgnoreReturnValue |
| public WorkspaceBuilder setSkyKeyStateReceiver( |
| SkyframeExecutor.SkyKeyStateReceiver skyKeyStateReceiver) { |
| Preconditions.checkState( |
| this.skyKeyStateReceiver == null, |
| "Multiple evaluatedSkyKeyReceiver: %s %s", |
| this.skyKeyStateReceiver, |
| skyKeyStateReceiver); |
| this.skyKeyStateReceiver = skyKeyStateReceiver; |
| return this; |
| } |
| } |