com.facebook.buck.jvm.java

Class CalculateSourceAbi

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.rules.modern.ModernBuildRule<T>

com.facebook.buck.rules.modern.PipelinedModernBuildRule<JavacPipelineState,CalculateSourceAbi.SourceAbiBuildable>

com.facebook.buck.jvm.java.CalculateSourceAbi

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, InitializableFromDisk<Object>, SupportsDependencyFileRuleKey, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, SupportsPipelining<JavacPipelineState>, CalculateAbi, HasJavaAbi, Comparable<BuildRule>

public class CalculateSourceAbi
extends PipelinedModernBuildRule<JavacPipelineState,CalculateSourceAbi.SourceAbiBuildable>
implements CalculateAbi, InitializableFromDisk<Object>, SupportsDependencyFileRuleKey

Source Abi calculation. Derives the abi from the source files (possibly with access to dependencies).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CalculateSourceAbi.SourceAbiBuildable Buildable implementation.

Constructor Summary

Constructors

Constructor and Description
CalculateSourceAbi(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, JarBuildStepsFactory jarBuildStepsFactory, SourcePathRuleFinder ruleFinder)

Method Summary

Modifier and Type	Method and Description
JavaAbiInfo	getAbiInfo()
BuildOutputInitializer<Object>	getBuildOutputInitializer()
java.util.function.Predicate<SourcePath>	getCoveredByDepFilePredicate(SourcePathResolverAdapter pathResolver) Returns a predicate that can tell whether a given path is covered by dep-file or not.
java.util.function.Predicate<SourcePath>	getExistenceOfInterestPredicate(SourcePathResolverAdapter pathResolver) Returns a predicate that can tell whether the existence of a given path may be of interest to compiler.
com.google.common.collect.ImmutableList<SourcePath>	getInputsAfterBuildingLocally(BuildContext context, CellPathResolver cellPathResolver) Returns a list of source paths that were actually used for the rule.
RulePipelineStateFactory<JavacPipelineState>	getPipelineStateFactory()
SupportsPipelining<JavacPipelineState>	getPreviousRuleInPipeline()
SourcePath	getSourcePathToOutput()
String	getType()
Object	initializeFromDisk(SourcePathResolverAdapter pathResolver)
void	invalidateInitializeFromDiskState()
boolean	useDependencyFileRuleKeys()
boolean	useRulePipelining()

Methods inherited from class com.facebook.buck.rules.modern.PipelinedModernBuildRule

getPipelinedBuildSteps

Methods inherited from class com.facebook.buck.rules.modern.ModernBuildRule

compareTo, getBuildable, getBuildCellPathFactory, getBuildDeps, getBuildSteps, getOutputPathResolver, getSetupStepsForBuildable, getSourcePath, getSourcePaths, injectFieldsIfNecessary, inputBasedRuleKeyIsEnabled, recordOutputs, recordOutputs, recordOutputs, stepsForBuildable, stepsForBuildable, updateBuildRuleResolver

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRule

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, hasBuildSteps, hashCode, injectFields, isCacheable, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.jvm.core.CalculateAbi

getAbiJar

Methods inherited from interface com.facebook.buck.jvm.core.HasJavaAbi

getSourceOnlyAbiJar

Methods inherited from interface com.facebook.buck.core.rules.BuildRule

compareTo, getBuildDeps, getBuildSteps, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, hasBuildSteps, isCacheable, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString, updateBuildRuleResolver

Methods inherited from interface com.facebook.buck.core.build.action.BuildEngineAction

getDependencies, getSourcePathOutputs

Methods inherited from interface com.facebook.buck.core.rules.pipeline.SupportsPipelining

isSupported

Methods inherited from interface com.facebook.buck.core.rules.attr.SupportsInputBasedRuleKey

isSupported

Constructor Detail

CalculateSourceAbi

public CalculateSourceAbi(BuildTarget buildTarget,
                          ProjectFilesystem projectFilesystem,
                          JarBuildStepsFactory jarBuildStepsFactory,
                          SourcePathRuleFinder ruleFinder)

Method Detail

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

Overrides:

getSourcePathToOutput in class ModernBuildRule<CalculateSourceAbi.SourceAbiBuildable>

getAbiInfo

public JavaAbiInfo getAbiInfo()

Specified by:

getAbiInfo in interface HasJavaAbi

getType

public String getType()

Specified by:

getType in interface HasNameAndType

Overrides:

getType in class AbstractBuildRule

invalidateInitializeFromDiskState

public void invalidateInitializeFromDiskState()

Specified by:

invalidateInitializeFromDiskState in interface InitializableFromDisk<Object>

initializeFromDisk

public Object initializeFromDisk(SourcePathResolverAdapter pathResolver)
                          throws IOException

Specified by:

initializeFromDisk in interface InitializableFromDisk<Object>

Returns:

an object that has the in-memory data structures that need to be populated as a result of executing this object's steps.

Throws:

IOException

getBuildOutputInitializer

public BuildOutputInitializer<Object> getBuildOutputInitializer()

Specified by:

getBuildOutputInitializer in interface InitializableFromDisk<Object>

useRulePipelining

public boolean useRulePipelining()

Specified by:

useRulePipelining in interface SupportsPipelining<JavacPipelineState>

getPreviousRuleInPipeline

@Nullable
public SupportsPipelining<JavacPipelineState> getPreviousRuleInPipeline()

Specified by:

getPreviousRuleInPipeline in interface SupportsPipelining<JavacPipelineState>

getPipelineStateFactory

public RulePipelineStateFactory<JavacPipelineState> getPipelineStateFactory()

Specified by:

getPipelineStateFactory in interface SupportsPipelining<JavacPipelineState>

useDependencyFileRuleKeys

public boolean useDependencyFileRuleKeys()

Specified by:

useDependencyFileRuleKeys in interface SupportsDependencyFileRuleKey

getCoveredByDepFilePredicate

public java.util.function.Predicate<SourcePath> getCoveredByDepFilePredicate(SourcePathResolverAdapter pathResolver)

Description copied from interface: SupportsDependencyFileRuleKey

Returns a predicate that can tell whether a given path is covered by dep-file or not. Note that being covered by dep-file doesn't necessarily mean being present in the dep-file. A covered path will only be present if actually used and that's the core idea of dep-file keys.

I.e. this predicate should return true only for source paths that *may* be returned from SupportsDependencyFileRuleKey.getInputsAfterBuildingLocally(BuildContext, CellPathResolver). This information is used by the rule key builder to infer that inputs *not* in this list should be included unconditionally in the rule key. Inputs that *are* in this list should be included in the rule key if and only if they are actually being used for the rule. I.e. if they are present in the dep-file listed by SupportsDependencyFileRuleKey.getInputsAfterBuildingLocally(BuildContext, CellPathResolver).

Specified by:

getCoveredByDepFilePredicate in interface SupportsDependencyFileRuleKey

getExistenceOfInterestPredicate

public java.util.function.Predicate<SourcePath> getExistenceOfInterestPredicate(SourcePathResolverAdapter pathResolver)

Description copied from interface: SupportsDependencyFileRuleKey

Returns a predicate that can tell whether the existence of a given path may be of interest to compiler. If this predicate returns true, the path should be included in the rule key. Note that we only care about the existence here. The actual content of the file is not relevant.

The main purpose of this predicate is to support scenarios where compiler decides whether to use a file or not solely based on its path. Of course, if compiler decides to use the file, it should list it in the dep-file in which case both the path and the content will be included in the rule key. However, relying only on presence in the dep-file for such paths is not sufficient. The problem occurs when a new such file just gets added, in which case it won't be present in the dep-file produced in the previous build, and yet if we run a local build now the compiler may decide to use it. For that reason rule key needs to reflect existence of all such files and change when a such a file gets added or removed.

Specified by:

getExistenceOfInterestPredicate in interface SupportsDependencyFileRuleKey

getInputsAfterBuildingLocally

public com.google.common.collect.ImmutableList<SourcePath> getInputsAfterBuildingLocally(BuildContext context,
                                                                                         CellPathResolver cellPathResolver)

Description copied from interface: SupportsDependencyFileRuleKey

Returns a list of source paths that were actually used for the rule. This list comes from the dep-file produced by compiler.

Specified by:

getInputsAfterBuildingLocally in interface SupportsDependencyFileRuleKey