com.facebook.buck.cli

Class AbstractPerfCommand<CommandContext>

java.lang.Object

com.facebook.buck.cli.CommandWithPluginManager

com.facebook.buck.cli.AbstractCommand

com.facebook.buck.cli.AbstractPerfCommand<CommandContext>

All Implemented Interfaces:

Command

Direct Known Subclasses:

PerfActionGraphCommand, PerfManifestCommand, PerfMbrPrepareRemoteExecutionCommand, PerfMbrSerializationCommand, PerfRuleKeyCommand

public abstract class AbstractPerfCommand<CommandContext>
extends AbstractCommand

This is the core of our perf commands, it handles the outer prepare + loop and statistics gathering.

Field Summary

Fields inherited from class com.facebook.buck.cli.AbstractCommand

commandArgsFile

Constructor Summary

Constructors

Constructor and Description
AbstractPerfCommand()

Method Summary

Modifier and Type	Method and Description
protected StackedFileHashCache	createStackedFileHashCache(CommandRunnerParams params) Creates a StackedFileHashCache similar to a real command but that uses our hash-faking delegate.
protected abstract String	getComputationName()
protected static com.google.common.collect.ImmutableList<BuildRule>	getRulesInGraph(ActionGraphBuilder graphBuilder, Iterable<BuildTarget> targets) Gets a list of the rules in the graph reachable from the provided targets.
protected TargetGraphCreationResult	getTargetGraph(CommandRunnerParams params, com.google.common.collect.ImmutableSet<BuildTarget> targets) Most of our perf tests require a target graph, this helps them get it concisely.
protected static void	initializeRulesFromDisk(ActionGraphBuilder graphBuilder, com.google.common.collect.ImmutableList<BuildRule> rulesInGraph) Calls initializeFromDisk() on all the initializable rules in the graph.
boolean	isReadOnly()
ExitCode	runWithoutHelp(CommandRunnerParams params)

Methods inherited from class com.facebook.buck.cli.AbstractCommand

addCommandSpecificConfigOverrides, convertArgumentsToBuildTargets, createParsingContext, getCommandArgsFile, getCommandLineBuildTargetNormalizer, getConcurrencyLimit, getConfigOverrides, getEnableParserProfiling, getEventListeners, getEventsOutputPath, getExcludeIncompatibleTargets, getExecutionContext, getExecutionContextBuilder, getHostPlatform, getLogConfig, getTargetPlatforms, handleException, handleException, isNoCache, isReuseCurrentConfig, isSourceControlStatsGatheringEnabled, matchBuildTargetsWithLabelsFromSpecs, performsBuild, prepareExecutionContext, printUsage, printWarning, printWarning, run, runHelp

Methods inherited from class com.facebook.buck.cli.CommandWithPluginManager

getPluginManager, setPluginManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.cli.Command

getShortDescription

Constructor Detail

AbstractPerfCommand

public AbstractPerfCommand()

Method Detail

getComputationName

protected abstract String getComputationName()

runWithoutHelp

public final ExitCode runWithoutHelp(CommandRunnerParams params)
                              throws Exception

Specified by:

runWithoutHelp in class AbstractCommand

Throws:

Exception

getTargetGraph

protected TargetGraphCreationResult getTargetGraph(CommandRunnerParams params,
                                                   com.google.common.collect.ImmutableSet<BuildTarget> targets)
                                            throws InterruptedException,
                                                   IOException,
                                                   VersionException

Most of our perf tests require a target graph, this helps them get it concisely.

Throws:

InterruptedException

IOException

VersionException

initializeRulesFromDisk

protected static void initializeRulesFromDisk(ActionGraphBuilder graphBuilder,
                                              com.google.common.collect.ImmutableList<BuildRule> rulesInGraph)
                                       throws IOException

Calls initializeFromDisk() on all the initializable rules in the graph. This is unsafe.

Throws:

IOException

getRulesInGraph

protected static com.google.common.collect.ImmutableList<BuildRule> getRulesInGraph(ActionGraphBuilder graphBuilder,
                                                                                    Iterable<BuildTarget> targets)
                                                                             throws CycleException

Gets a list of the rules in the graph reachable from the provided targets.

Throws:

CycleException

createStackedFileHashCache

protected StackedFileHashCache createStackedFileHashCache(CommandRunnerParams params)
                                                   throws InterruptedException

Creates a StackedFileHashCache similar to a real command but that uses our hash-faking delegate.

Throws:

InterruptedException

isReadOnly

public final boolean isReadOnly()

Returns:

whether the command doesn't modify the state of the filesystem