com.facebook.buck.core.build.engine.impl

Class CachingBuildEngine

java.lang.Object

com.facebook.buck.core.build.engine.impl.CachingBuildEngine

All Implemented Interfaces:

BuildEngine, Closeable, AutoCloseable

public class CachingBuildEngine
extends Object
implements BuildEngine, Closeable

A build engine used to build a BuildRule which also caches the results. If the current RuleKey of the build rules matches the one on disk, it does not do any work. It also tries to fetch its output from an ArtifactCache to avoid doing any computation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CachingBuildEngine.DefaultBuildRuleBuilderDelegate

Nested classes/interfaces inherited from interface com.facebook.buck.core.build.engine.BuildEngine

BuildEngine.BuildEngineResult

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceAmounts	CACHE_CHECK_RESOURCE_AMOUNTS
static ResourceAmounts	RULE_KEY_COMPUTATION_RESOURCE_AMOUNTS
static ResourceAmounts	SCHEDULING_MORE_WORK_RESOURCE_AMOUNTS

Constructor Summary

Constructors

Constructor and Description

CachingBuildEngine(CachingBuildEngineDelegate cachingBuildEngineDelegate, Optional<BuildRuleStrategy> customBuildRuleStrategy, WeightedListeningExecutorService service, BuildType buildMode, DepFiles depFiles, long maxDepFileCacheEntries, Optional<Long> artifactCacheSizeLimit, BuildRuleResolver resolver, BuildEngineActionToBuildRuleResolver actionToBuildRuleResolver, TargetConfigurationSerializer targetConfigurationSerializer, BuildInfoStoreManager buildInfoStoreManager, ResourceAwareSchedulingInfo resourceAwareSchedulingInfo, boolean consoleLogBuildFailuresInline, RuleKeyFactories ruleKeyFactories)

Method Summary

Modifier and Type	Method and Description
BuildEngine.BuildEngineResult	build(BuildEngineBuildContext buildContext, ExecutionContext executionContext, BuildRule rule) Build the given build rule and return a future to the build rule success.
void	close()
BuildResult	getBuildRuleResult(BuildTarget buildTarget) Returns the build result of the build rule associated with the given build target.
int	getNumRulesToBuild(Iterable<BuildRule> rules) Calculate the total number of transitive build rules processed from the given roots.
ParallelRuleKeyCalculator<RuleKey>	getRuleKeyCalculator()
boolean	isRuleBuilt(BuildTarget buildTarget) Returns whether the build rule associated with the build target has been successfully built.
void	terminateBuildWithFailure(Throwable failure) Marks build as failed with the given Throwable.
com.google.common.util.concurrent.ListenableFuture<?>	walkRule(BuildRule rule, Set<BuildRule> seen)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CACHE_CHECK_RESOURCE_AMOUNTS

public static final ResourceAmounts CACHE_CHECK_RESOURCE_AMOUNTS

RULE_KEY_COMPUTATION_RESOURCE_AMOUNTS

public static final ResourceAmounts RULE_KEY_COMPUTATION_RESOURCE_AMOUNTS

SCHEDULING_MORE_WORK_RESOURCE_AMOUNTS

public static final ResourceAmounts SCHEDULING_MORE_WORK_RESOURCE_AMOUNTS

Constructor Detail

CachingBuildEngine

public CachingBuildEngine(CachingBuildEngineDelegate cachingBuildEngineDelegate,
                          Optional<BuildRuleStrategy> customBuildRuleStrategy,
                          WeightedListeningExecutorService service,
                          BuildType buildMode,
                          DepFiles depFiles,
                          long maxDepFileCacheEntries,
                          Optional<Long> artifactCacheSizeLimit,
                          BuildRuleResolver resolver,
                          BuildEngineActionToBuildRuleResolver actionToBuildRuleResolver,
                          TargetConfigurationSerializer targetConfigurationSerializer,
                          BuildInfoStoreManager buildInfoStoreManager,
                          ResourceAwareSchedulingInfo resourceAwareSchedulingInfo,
                          boolean consoleLogBuildFailuresInline,
                          RuleKeyFactories ruleKeyFactories)

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getRuleKeyCalculator

public ParallelRuleKeyCalculator<RuleKey> getRuleKeyCalculator()

isRuleBuilt

public boolean isRuleBuilt(BuildTarget buildTarget)
                    throws InterruptedException

Description copied from interface: BuildEngine

Returns whether the build rule associated with the build target has been successfully built.

Specified by:

isRuleBuilt in interface BuildEngine

Throws:

InterruptedException

terminateBuildWithFailure

public void terminateBuildWithFailure(Throwable failure)

Description copied from interface: BuildEngine

Marks build as failed with the given Throwable. If keepGoing == false, any pending steps will be terminated before starting.

Specified by:

terminateBuildWithFailure in interface BuildEngine

walkRule

public com.google.common.util.concurrent.ListenableFuture<?> walkRule(BuildRule rule,
                                                                      Set<BuildRule> seen)

getNumRulesToBuild

public int getNumRulesToBuild(Iterable<BuildRule> rules)

Description copied from interface: BuildEngine

Calculate the total number of transitive build rules processed from the given roots.

Specified by:

getNumRulesToBuild in interface BuildEngine

build

public BuildEngine.BuildEngineResult build(BuildEngineBuildContext buildContext,
                                           ExecutionContext executionContext,
                                           BuildRule rule)

Description copied from interface: BuildEngine

Build the given build rule and return a future to the build rule success.

Specified by:

build in interface BuildEngine

getBuildRuleResult

@Nullable
public BuildResult getBuildRuleResult(BuildTarget buildTarget)
                                         throws ExecutionException,
                                                InterruptedException

Description copied from interface: BuildEngine

Returns the build result of the build rule associated with the given build target. Returns null if the build rule has not yet been built.

Specified by:

getBuildRuleResult in interface BuildEngine

Throws:

ExecutionException

InterruptedException