com.facebook.buck.cxx

Class CxxPreprocessAndCompile

java.lang.Object

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

com.facebook.buck.rules.modern.ModernBuildRule<com.facebook.buck.cxx.CxxPreprocessAndCompile.Impl>

com.facebook.buck.cxx.CxxPreprocessAndCompile

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, SupportsDependencyFileRuleKey, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, CxxIntermediateBuildProduct, Comparable<BuildRule>

public class CxxPreprocessAndCompile
extends ModernBuildRule<com.facebook.buck.cxx.CxxPreprocessAndCompile.Impl>
implements SupportsDependencyFileRuleKey, CxxIntermediateBuildProduct

A build rule which preprocesses and/or compiles a C/C++ source in a single step.

Method Summary

Modifier and Type	Method and Description
static CxxPreprocessAndCompile	compile(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, SourcePathRuleFinder ruleFinder, com.facebook.buck.cxx.CompilerDelegate compilerDelegate, String outputName, SourcePath input, CxxSource.Type inputType, DebugPathSanitizer sanitizer)
com.google.common.collect.ImmutableList<String>	getCommand(BuildContext context) Returns the compilation command (used for compdb).
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.
SourcePath	getInput()
com.google.common.collect.ImmutableList<SourcePath>	getInputsAfterBuildingLocally(BuildContext context, CellPathResolver cellPathResolver) Returns a list of source paths that were actually used for the rule.
String	getSourceInputPath(SourcePathResolverAdapter resolver) Returns the original path of the source file relative to its own project root
SourcePath	getSourcePathToOutput()
String	getType()
com.facebook.buck.cxx.CxxPreprocessAndCompileStep	makeMainStep(BuildContext context, boolean useArgFile)
static CxxPreprocessAndCompile	preprocessAndCompile(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, SourcePathRuleFinder ruleFinder, com.facebook.buck.cxx.PreprocessorDelegate preprocessorDelegate, com.facebook.buck.cxx.CompilerDelegate compilerDelegate, String outputName, SourcePath input, CxxSource.Type inputType, Optional<com.facebook.buck.cxx.CxxPrecompiledHeader> precompiledHeaderRule, DebugPathSanitizer sanitizer)
boolean	shouldRespectInputSizeLimitForRemoteExecution()
boolean	useDependencyFileRuleKeys()

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.core.rules.BuildRule

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

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

getDependencies, getSourcePathOutputs

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

isSupported

Method Detail

getType

public String getType()

Specified by:

getType in interface HasNameAndType

Overrides:

getType in class AbstractBuildRule

compile

public static CxxPreprocessAndCompile compile(BuildTarget buildTarget,
                                              ProjectFilesystem projectFilesystem,
                                              SourcePathRuleFinder ruleFinder,
                                              com.facebook.buck.cxx.CompilerDelegate compilerDelegate,
                                              String outputName,
                                              SourcePath input,
                                              CxxSource.Type inputType,
                                              DebugPathSanitizer sanitizer)

Returns:

a CxxPreprocessAndCompile step that compiles the given preprocessed source.

preprocessAndCompile

public static CxxPreprocessAndCompile preprocessAndCompile(BuildTarget buildTarget,
                                                           ProjectFilesystem projectFilesystem,
                                                           SourcePathRuleFinder ruleFinder,
                                                           com.facebook.buck.cxx.PreprocessorDelegate preprocessorDelegate,
                                                           com.facebook.buck.cxx.CompilerDelegate compilerDelegate,
                                                           String outputName,
                                                           SourcePath input,
                                                           CxxSource.Type inputType,
                                                           Optional<com.facebook.buck.cxx.CxxPrecompiledHeader> precompiledHeaderRule,
                                                           DebugPathSanitizer sanitizer)

Returns:

a CxxPreprocessAndCompile step that preprocesses and compiles the given source.

getSourceInputPath

public String getSourceInputPath(SourcePathResolverAdapter resolver)

Returns the original path of the source file relative to its own project root

getCommand

public com.google.common.collect.ImmutableList<String> getCommand(BuildContext context)

Returns the compilation command (used for compdb).

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

Overrides:

getSourcePathToOutput in class ModernBuildRule<com.facebook.buck.cxx.CxxPreprocessAndCompile.Impl>

getInput

public SourcePath getInput()

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)
                                                                                  throws IOException

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

Throws:

IOException

shouldRespectInputSizeLimitForRemoteExecution

public final boolean shouldRespectInputSizeLimitForRemoteExecution()

Specified by:

shouldRespectInputSizeLimitForRemoteExecution in interface BuildEngineAction

Specified by:

shouldRespectInputSizeLimitForRemoteExecution in interface BuildRule

Returns:

true if this rule should only be allowed to be executed via Remote Execution if it satisfies input size limits.

makeMainStep

public com.facebook.buck.cxx.CxxPreprocessAndCompileStep makeMainStep(BuildContext context,
                                                                      boolean useArgFile)