Class Runner

java.lang.Object

org.openjdk.jmh.runner.BaseRunner

org.openjdk.jmh.runner.Runner

public class Runner
extends BaseRunner

Runner executes JMH benchmarks.

This is the entry point for JMH Java API.

Runner is not usually reusable. After you execute any method on the Runner, you should digest the results, give up on current Runner, and instantiate another one. This class may be turned into static class in future releases.

Field Summary

Fields

Modifier and Type	Field	Description
private int	cpuCount
private static final String	JMH_LOCK_FILE
private static final Boolean	JMH_LOCK_IGNORE
private final BenchmarkList	list
private static final int	TAIL_LINES_ON_ERROR

Fields inherited from class BaseRunner

options, out

Constructor Summary

Constructors

Constructor	Description
Runner(Options options)	Create Runner with the given options.
Runner(Options options, OutputFormat format)	Create runner with the custom OutputFormat.

Method Summary

Modifier and Type	Method	Description
private void	addClasspath(List<String> command)
private static OutputFormat	createOutputFormat(Options options)
private List<IterationResult>	doFork(BinaryLinkServer reader, List<String> commandString, File stdOut, File stdErr, boolean printOut, boolean printErr)
private List<WorkloadParams>	explodeAllParams(BenchmarkListEntry br)
private List<ActionPlan>	getActionPlans(Set<BenchmarkListEntry> benchmarks)
(package private) List<String>	getForkedMainCommand(BenchmarkParams benchmark, List<ExternalProfiler> profilers, String host, int port)
private List<String>	getPrintPropertiesCommand(String jvm)
private Collection<RunResult>	internalRun()
void	list()	Print matching benchmarks into output.
void	listWithParams(CommandLineOptions options)	Print matching benchmarks with parameters into output.
private SortedSet<RunResult>	mergeRunResults(Multimap<BenchmarkParams, BenchmarkResult> results)
private Action	newAction(BenchmarkListEntry br, ActionMode mode)
private BenchmarkParams	newBenchmarkParams(BenchmarkListEntry benchmark, ActionMode mode)
Collection<RunResult>	run()	Run benchmarks.
private Collection<RunResult>	runBenchmarks(SortedSet<BenchmarkListEntry> benchmarks)
private Multimap<BenchmarkParams, BenchmarkResult>	runSeparate(ActionPlan actionPlan)
RunResult	runSingle()	Shortcut method for the single benchmark execution.

Methods inherited from class BaseRunner

etaAfterBenchmark, etaAfterBenchmarks, etaBeforeBenchmark, etaBeforeBenchmarks, runBenchmark, runBenchmark, runBenchmarksEmbedded, runBenchmarksForked, runSystemGC

Methods inherited from class Object

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

Field Details

TAIL_LINES_ON_ERROR

private static final int TAIL_LINES_ON_ERROR

JMH_LOCK_FILE

private static final String JMH_LOCK_FILE

JMH_LOCK_IGNORE

private static final Boolean JMH_LOCK_IGNORE

list

private final BenchmarkList list

cpuCount

private int cpuCount

Constructor Details

Runner

public Runner(Options options,
 OutputFormat format)

Create runner with the custom OutputFormat.

Parameters:

options - options to use

format - OutputFormat to use

Runner

public Runner(Options options)

Create Runner with the given options. This method sets up the OutputFormat as mandated by options.

Parameters:

options - options to use.

Method Details

createOutputFormat

private static OutputFormat createOutputFormat(Options options)

list

public void list()

Print matching benchmarks into output.

listWithParams

public void listWithParams(CommandLineOptions options)

Print matching benchmarks with parameters into output.

Parameters:

options - options to use.

runSingle

public RunResult runSingle()
                    throws RunnerException

Shortcut method for the single benchmark execution. This method is handy when Options describe only the single benchmark to run.

Returns:

benchmark result

Throws:

RunnerException - if more than one benchmark is found, or no results are returned

run

public Collection<RunResult> run()
                          throws RunnerException

Run benchmarks.

Returns:

map of benchmark results

Throws:

RunnerException - if something goes wrong

internalRun

private Collection<RunResult> internalRun()
                                   throws RunnerException

Throws:

RunnerException

getActionPlans

private List<ActionPlan> getActionPlans(Set<BenchmarkListEntry> benchmarks)

newAction

private Action newAction(BenchmarkListEntry br,
 ActionMode mode)

newBenchmarkParams

private BenchmarkParams newBenchmarkParams(BenchmarkListEntry benchmark,
 ActionMode mode)

explodeAllParams

private List<WorkloadParams> explodeAllParams(BenchmarkListEntry br)
                                       throws RunnerException

Throws:

RunnerException

runBenchmarks

private Collection<RunResult> runBenchmarks(SortedSet<BenchmarkListEntry> benchmarks)
                                     throws RunnerException

Throws:

RunnerException

mergeRunResults

private SortedSet<RunResult> mergeRunResults(Multimap<BenchmarkParams, BenchmarkResult> results)

runSeparate

private Multimap<BenchmarkParams, BenchmarkResult> runSeparate(ActionPlan actionPlan)

doFork

private List<IterationResult> doFork(BinaryLinkServer reader,
 List<String> commandString,
 File stdOut,
 File stdErr,
 boolean printOut,
 boolean printErr)

getForkedMainCommand

List<String> getForkedMainCommand(BenchmarkParams benchmark,
 List<ExternalProfiler> profilers,
 String host,
 int port)

Parameters:

host - host VM host

port - host VM port

Returns:

getPrintPropertiesCommand

private List<String> getPrintPropertiesCommand(String jvm)

addClasspath

private void addClasspath(List<String> command)