org.openjdk.jmh.runner.options

Class OptionsBuilder

java.lang.Object

org.openjdk.jmh.runner.options.OptionsBuilder

All Implemented Interfaces:

Serializable, ChainedOptionsBuilder, Options

public class OptionsBuilder
extends Object
implements Options, ChainedOptionsBuilder

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OptionsBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
ChainedOptionsBuilder	addProfiler(Class<? extends Profiler> prof) Add the profiler in the run
ChainedOptionsBuilder	addProfiler(Class<? extends Profiler> prof, String initLine) Add the profiler in the run
ChainedOptionsBuilder	addProfiler(String prof) Add the profiler in the run
ChainedOptionsBuilder	addProfiler(String prof, String initLine) Add the profiler in the run
Options	build() Produce the final Options
ChainedOptionsBuilder	detectJvmArgs() Autodetect forked JVM arguments from the parent VM.
ChainedOptionsBuilder	exclude(String regexp) Exclude benchmarks from the run (Can be used multiple times)
ChainedOptionsBuilder	forks(int value) Number of forks to use in the run
Collection<Mode>	getBenchModes() Benchmarks modes to execute.
List<String>	getExcludes() Which benchmarks to omit?
Optional<Integer>	getForkCount() Fork count
List<String>	getIncludes() Which benchmarks to execute?
Optional<String>	getJvm() JVM executable to use for forks
Optional<Collection<String>>	getJvmArgs() JVM parameters to use with forks
Optional<Collection<String>>	getJvmArgsAppend() JVM parameters to use with forks (these options will be appended after any other JVM option)
Optional<Collection<String>>	getJvmArgsPrepend() JVM parameters to use with forks (these options will be prepended before any other JVM option)
Optional<Integer>	getMeasurementBatchSize() Number of batch size for measurement
Optional<Integer>	getMeasurementIterations() Number of measurement iterations
Optional<TimeValue>	getMeasurementTime() The duration for measurement iterations
Optional<Integer>	getOperationsPerInvocation() Operations per invocation.
Optional<String>	getOutput() Which file to use for dumping the output
Optional<Collection<String>>	getParameter(String name) The overridden value of the parameter.
List<ProfilerConfig>	getProfilers() Profilers to use for the run.
Optional<String>	getResult() Which file to use for dumping the result
Optional<ResultFormatType>	getResultFormat() Result format to use
Optional<int[]>	getThreadGroups() Thread subgroups distribution.
Optional<Integer>	getThreads() Number of threads to run
Optional<TimeValue>	getTimeout() Timeout: how long to wait for an iteration to complete.
Optional<TimeUnit>	getTimeUnit() Timeunit to use in units.
Optional<Integer>	getWarmupBatchSize() Number of batch size for warmup
Optional<Integer>	getWarmupForkCount() Number of initial forks to ignore the results for
List<String>	getWarmupIncludes() Which benchmarks to warmup before doing the run.
Optional<Integer>	getWarmupIterations() Number of warmup iterations
Optional<WarmupMode>	getWarmupMode() Warmup mode.
Optional<TimeValue>	getWarmupTime() The duration for warmup iterations
ChainedOptionsBuilder	include(String regexp) Include benchmark in the run (Can be used multiple times)
ChainedOptionsBuilder	includeWarmup(String regexp) What other benchmarks to warmup along the way
ChainedOptionsBuilder	jvm(String path) Forked JVM to use.
ChainedOptionsBuilder	jvmArgs(String... value) Forked JVM arguments.
ChainedOptionsBuilder	jvmArgsAppend(String... value) Append forked JVM arguments: These options go after other options.
ChainedOptionsBuilder	jvmArgsPrepend(String... value) Prepend forked JVM arguments: These options go before any other options.
ChainedOptionsBuilder	measurementBatchSize(int value) How large measurement batchSize should be?
ChainedOptionsBuilder	measurementIterations(int count) How many measurement measurementIterations to do
ChainedOptionsBuilder	measurementTime(TimeValue value) How long each measurement iteration should take?
ChainedOptionsBuilder	mode(Mode mode) Benchmark mode.
ChainedOptionsBuilder	operationsPerInvocation(int opsPerInv) Operations per invocation.
ChainedOptionsBuilder	output(String filename) Output filename to write the run log to
ChainedOptionsBuilder	param(String name, String... values) Set benchmark parameter values.
ChainedOptionsBuilder	parent(Options other) Override the defaults from the given option.
ChainedOptionsBuilder	result(String filename) Output filename to write the result to
ChainedOptionsBuilder	resultFormat(ResultFormatType type) ResultFormatType to use in the run
Optional<Boolean>	shouldDoGC() Should force GC between iterations?
ChainedOptionsBuilder	shouldDoGC(boolean value) Should do GC between measurementIterations?
Optional<Boolean>	shouldFailOnError() Should harness terminate on first error encountered?
ChainedOptionsBuilder	shouldFailOnError(boolean value) Should fail on first benchmark error?
Optional<Boolean>	shouldSyncIterations() Should synchronize iterations?
ChainedOptionsBuilder	syncIterations(boolean value) Should synchronize measurementIterations?
ChainedOptionsBuilder	threadGroups(int... groups) Subgroups thread distribution.
ChainedOptionsBuilder	threads(int count) Number of threads to run the benchmark in
ChainedOptionsBuilder	timeout(TimeValue value) How long to wait for iteration execution?
ChainedOptionsBuilder	timeUnit(TimeUnit tu) Timeunit to use in results
Optional<VerboseMode>	verbosity() How verbose should we be?
ChainedOptionsBuilder	verbosity(VerboseMode mode) Control verbosity level.
ChainedOptionsBuilder	warmupBatchSize(int value) How large warmup batchSize should be?
ChainedOptionsBuilder	warmupForks(int value) Number of ignored forks
ChainedOptionsBuilder	warmupIterations(int value) How many warmup iterations to do?
ChainedOptionsBuilder	warmupMode(WarmupMode mode) Warmup mode to use
ChainedOptionsBuilder	warmupTime(TimeValue value) How long each warmup iteration should take?

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionsBuilder

public OptionsBuilder()

Method Detail

build

public Options build()

Description copied from interface: ChainedOptionsBuilder

Produce the final Options

Specified by:

build in interface ChainedOptionsBuilder

Returns:

options object.

parent

public ChainedOptionsBuilder parent(Options other)

Description copied from interface: ChainedOptionsBuilder

Override the defaults from the given option. You may use this only once.

Specified by:

parent in interface ChainedOptionsBuilder

Parameters:

other - options to base on

Returns:

builder

include

public ChainedOptionsBuilder include(String regexp)

Description copied from interface: ChainedOptionsBuilder

Include benchmark in the run (Can be used multiple times)

Specified by:

include in interface ChainedOptionsBuilder

Parameters:

regexp - to match benchmarks against

Returns:

builder

getIncludes

public List<String> getIncludes()

Description copied from interface: Options

Which benchmarks to execute?

Specified by:

getIncludes in interface Options

Returns:

list of regexps matching the requested benchmarks

exclude

public ChainedOptionsBuilder exclude(String regexp)

Description copied from interface: ChainedOptionsBuilder

Exclude benchmarks from the run (Can be used multiple times)

Specified by:

exclude in interface ChainedOptionsBuilder

Parameters:

regexp - to match benchmark against

Returns:

builder

getExcludes

public List<String> getExcludes()

Description copied from interface: Options

Which benchmarks to omit?

Specified by:

getExcludes in interface Options

Returns:

list of regexps matching the ignored benchmarks

output

public ChainedOptionsBuilder output(String filename)

Description copied from interface: ChainedOptionsBuilder

Output filename to write the run log to

Specified by:

output in interface ChainedOptionsBuilder

Parameters:

filename - file name

Returns:

builder

getOutput

public Optional<String> getOutput()

Description copied from interface: Options

Which file to use for dumping the output

Specified by:

getOutput in interface Options

Returns:

file name

resultFormat

public ChainedOptionsBuilder resultFormat(ResultFormatType type)

Description copied from interface: ChainedOptionsBuilder

ResultFormatType to use in the run

Specified by:

resultFormat in interface ChainedOptionsBuilder

Parameters:

type - resultformat type

Returns:

builder

getResultFormat

public Optional<ResultFormatType> getResultFormat()

Description copied from interface: Options

Result format to use

Specified by:

getResultFormat in interface Options

Returns:

format type

result

public ChainedOptionsBuilder result(String filename)

Description copied from interface: ChainedOptionsBuilder

Output filename to write the result to

Specified by:

result in interface ChainedOptionsBuilder

Parameters:

filename - file name

Returns:

builder

getResult

public Optional<String> getResult()

Description copied from interface: Options

Which file to use for dumping the result

Specified by:

getResult in interface Options

Returns:

file name

shouldDoGC

public ChainedOptionsBuilder shouldDoGC(boolean value)

Description copied from interface: ChainedOptionsBuilder

Should do GC between measurementIterations?

Specified by:

shouldDoGC in interface ChainedOptionsBuilder

Parameters:

value - flag

Returns:

builder

shouldDoGC

public Optional<Boolean> shouldDoGC()

Description copied from interface: Options

Should force GC between iterations?

Specified by:

shouldDoGC in interface Options

Returns:

should GC?

addProfiler

public ChainedOptionsBuilder addProfiler(Class<? extends Profiler> prof)

Description copied from interface: ChainedOptionsBuilder

Add the profiler in the run

Specified by:

addProfiler in interface ChainedOptionsBuilder

Parameters:

prof - profiler class

Returns:

builder

addProfiler

public ChainedOptionsBuilder addProfiler(Class<? extends Profiler> prof,
                                String initLine)

Description copied from interface: ChainedOptionsBuilder

Add the profiler in the run

Specified by:

addProfiler in interface ChainedOptionsBuilder

Parameters:

prof - profiler class

initLine - profiler options initialization line

Returns:

builder

addProfiler

public ChainedOptionsBuilder addProfiler(String prof)

Description copied from interface: ChainedOptionsBuilder

Add the profiler in the run

Specified by:

addProfiler in interface ChainedOptionsBuilder

Parameters:

prof - profiler class name, or profiler alias

Returns:

builder

addProfiler

public ChainedOptionsBuilder addProfiler(String prof,
                                String initLine)

Description copied from interface: ChainedOptionsBuilder

Add the profiler in the run

Specified by:

addProfiler in interface ChainedOptionsBuilder

Parameters:

prof - profiler class name, or profiler alias

initLine - profiler options initialization line

Returns:

builder

getProfilers

public List<ProfilerConfig> getProfilers()

Description copied from interface: Options

Profilers to use for the run. Profilers will start in the order specified by collection, and will stop in the reverse order.

Specified by:

getProfilers in interface Options

Returns:

profilers to use; empty collection if no profilers are required

verbosity

public ChainedOptionsBuilder verbosity(VerboseMode mode)

Description copied from interface: ChainedOptionsBuilder

Control verbosity level.

Specified by:

verbosity in interface ChainedOptionsBuilder

Parameters:

mode - flag

Returns:

builder

verbosity

public Optional<VerboseMode> verbosity()

Description copied from interface: Options

How verbose should we be?

Specified by:

verbosity in interface Options

Returns:

verbosity mode

shouldFailOnError

public ChainedOptionsBuilder shouldFailOnError(boolean value)

Description copied from interface: ChainedOptionsBuilder

Should fail on first benchmark error?

Specified by:

shouldFailOnError in interface ChainedOptionsBuilder

Parameters:

value - flag

Returns:

builder

shouldFailOnError

public Optional<Boolean> shouldFailOnError()

Description copied from interface: Options

Should harness terminate on first error encountered?

Specified by:

shouldFailOnError in interface Options

Returns:

should terminate?

threads

public ChainedOptionsBuilder threads(int count)

Description copied from interface: ChainedOptionsBuilder

Number of threads to run the benchmark in

Specified by:

threads in interface ChainedOptionsBuilder

Parameters:

count - number of threads

Returns:

builder

See Also:

Threads

getThreads

public Optional<Integer> getThreads()

Description copied from interface: Options

Number of threads to run

Specified by:

getThreads in interface Options

Returns:

number of threads; 0 to use maximum number of threads

See Also:

Threads

threadGroups

public ChainedOptionsBuilder threadGroups(int... groups)

Description copied from interface: ChainedOptionsBuilder

Subgroups thread distribution.

Specified by:

threadGroups in interface ChainedOptionsBuilder

Parameters:

groups - thread distribution

Returns:

builder

See Also:

Group, GroupThreads

getThreadGroups

public Optional<int[]> getThreadGroups()

Description copied from interface: Options

Thread subgroups distribution.

Specified by:

getThreadGroups in interface Options

Returns:

array of thread ratios

See Also:

Group, GroupThreads

syncIterations

public ChainedOptionsBuilder syncIterations(boolean value)

Description copied from interface: ChainedOptionsBuilder

Should synchronize measurementIterations?

Specified by:

syncIterations in interface ChainedOptionsBuilder

Parameters:

value - flag

Returns:

builder

shouldSyncIterations

public Optional<Boolean> shouldSyncIterations()

Description copied from interface: Options

Should synchronize iterations?

Specified by:

shouldSyncIterations in interface Options

Returns:

should we?

warmupIterations

public ChainedOptionsBuilder warmupIterations(int value)

Description copied from interface: ChainedOptionsBuilder

How many warmup iterations to do?

Specified by:

warmupIterations in interface ChainedOptionsBuilder

Parameters:

value - flag

Returns:

builder

See Also:

Warmup

getWarmupIterations

public Optional<Integer> getWarmupIterations()

Description copied from interface: Options

Number of warmup iterations

Specified by:

getWarmupIterations in interface Options

Returns:

number of warmup iterations

See Also:

Warmup

warmupBatchSize

public ChainedOptionsBuilder warmupBatchSize(int value)

Description copied from interface: ChainedOptionsBuilder

How large warmup batchSize should be?

Specified by:

warmupBatchSize in interface ChainedOptionsBuilder

Parameters:

value - batch size

Returns:

builder

See Also:

Warmup

getWarmupBatchSize

public Optional<Integer> getWarmupBatchSize()

Description copied from interface: Options

Number of batch size for warmup

Specified by:

getWarmupBatchSize in interface Options

Returns:

number of batch size for warmup

See Also:

Warmup

warmupTime

public ChainedOptionsBuilder warmupTime(TimeValue value)

Description copied from interface: ChainedOptionsBuilder

How long each warmup iteration should take?

Specified by:

warmupTime in interface ChainedOptionsBuilder

Parameters:

value - time

Returns:

builder

See Also:

Warmup

getWarmupTime

public Optional<TimeValue> getWarmupTime()

Description copied from interface: Options

The duration for warmup iterations

Specified by:

getWarmupTime in interface Options

Returns:

duration

See Also:

Warmup

warmupMode

public ChainedOptionsBuilder warmupMode(WarmupMode mode)

Description copied from interface: ChainedOptionsBuilder

Warmup mode to use

Specified by:

warmupMode in interface ChainedOptionsBuilder

Parameters:

mode - to use

Returns:

builder

getWarmupMode

public Optional<WarmupMode> getWarmupMode()

Description copied from interface: Options

Warmup mode.

Specified by:

getWarmupMode in interface Options

Returns:

warmup mode

See Also:

WarmupMode

includeWarmup

public ChainedOptionsBuilder includeWarmup(String regexp)

Description copied from interface: ChainedOptionsBuilder

What other benchmarks to warmup along the way

Specified by:

includeWarmup in interface ChainedOptionsBuilder

Parameters:

regexp - to match benchmarks against

Returns:

builder

getWarmupIncludes

public List<String> getWarmupIncludes()

Description copied from interface: Options

Which benchmarks to warmup before doing the run.

Specified by:

getWarmupIncludes in interface Options

Returns:

list of regexps matching the relevant benchmarks; empty if no benchmarks are defined

measurementIterations

public ChainedOptionsBuilder measurementIterations(int count)

Description copied from interface: ChainedOptionsBuilder

How many measurement measurementIterations to do

Specified by:

measurementIterations in interface ChainedOptionsBuilder

Parameters:

count - number of iterations

Returns:

builder

See Also:

Measurement

getMeasurementIterations

public Optional<Integer> getMeasurementIterations()

Description copied from interface: Options

Number of measurement iterations

Specified by:

getMeasurementIterations in interface Options

Returns:

number of measurement iterations

See Also:

Measurement

measurementTime

public ChainedOptionsBuilder measurementTime(TimeValue value)

Description copied from interface: ChainedOptionsBuilder

How long each measurement iteration should take?

Specified by:

measurementTime in interface ChainedOptionsBuilder

Parameters:

value - time

Returns:

builder

See Also:

Measurement

getMeasurementTime

public Optional<TimeValue> getMeasurementTime()

Description copied from interface: Options

The duration for measurement iterations

Specified by:

getMeasurementTime in interface Options

Returns:

duration

See Also:

Measurement

measurementBatchSize

public ChainedOptionsBuilder measurementBatchSize(int value)

Description copied from interface: ChainedOptionsBuilder

How large measurement batchSize should be?

Specified by:

measurementBatchSize in interface ChainedOptionsBuilder

Parameters:

value - batch size

Returns:

builder

See Also:

Measurement

getMeasurementBatchSize

public Optional<Integer> getMeasurementBatchSize()

Description copied from interface: Options

Number of batch size for measurement

Specified by:

getMeasurementBatchSize in interface Options

Returns:

number of batch size for measurement

See Also:

Measurement

mode

public ChainedOptionsBuilder mode(Mode mode)

Description copied from interface: ChainedOptionsBuilder

Benchmark mode. (Can be used multiple times)

Specified by:

mode in interface ChainedOptionsBuilder

Parameters:

mode - benchmark mode

Returns:

builder

See Also:

BenchmarkMode

getBenchModes

public Collection<Mode> getBenchModes()

Description copied from interface: Options

Benchmarks modes to execute.

Specified by:

getBenchModes in interface Options

Returns:

modes to execute the benchmarks in; empty to use the default modes

See Also:

BenchmarkMode

timeUnit

public ChainedOptionsBuilder timeUnit(TimeUnit tu)

Description copied from interface: ChainedOptionsBuilder

Timeunit to use in results

Specified by:

timeUnit in interface ChainedOptionsBuilder

Parameters:

tu - time unit

Returns:

builder

See Also:

OutputTimeUnit

getTimeUnit

public Optional<TimeUnit> getTimeUnit()

Description copied from interface: Options

Timeunit to use in units.

Specified by:

getTimeUnit in interface Options

Returns:

timeunit

See Also:

OutputTimeUnit

operationsPerInvocation

public ChainedOptionsBuilder operationsPerInvocation(int opsPerInv)

Description copied from interface: ChainedOptionsBuilder

Operations per invocation.

Specified by:

operationsPerInvocation in interface ChainedOptionsBuilder

Parameters:

opsPerInv - operations per invocation.

Returns:

builder

See Also:

OperationsPerInvocation

getOperationsPerInvocation

public Optional<Integer> getOperationsPerInvocation()

Description copied from interface: Options

Operations per invocation.

Specified by:

getOperationsPerInvocation in interface Options

Returns:

operations per invocation.

See Also:

OperationsPerInvocation

forks

public ChainedOptionsBuilder forks(int value)

Description copied from interface: ChainedOptionsBuilder

Number of forks to use in the run

Specified by:

forks in interface ChainedOptionsBuilder

Parameters:

value - number of forks

Returns:

builder

See Also:

Fork

getForkCount

public Optional<Integer> getForkCount()

Description copied from interface: Options

Fork count

Specified by:

getForkCount in interface Options

Returns:

fork count; 0, to prohibit forking

See Also:

Fork

warmupForks

public ChainedOptionsBuilder warmupForks(int value)

Description copied from interface: ChainedOptionsBuilder

Number of ignored forks

Specified by:

warmupForks in interface ChainedOptionsBuilder

Parameters:

value - number of ignored forks

Returns:

builder

See Also:

Fork

getWarmupForkCount

public Optional<Integer> getWarmupForkCount()

Description copied from interface: Options

Number of initial forks to ignore the results for

Specified by:

getWarmupForkCount in interface Options

Returns:

initial fork count; 0, to disable

See Also:

Fork

jvm

public ChainedOptionsBuilder jvm(String path)

Description copied from interface: ChainedOptionsBuilder

Forked JVM to use.

Specified by:

jvm in interface ChainedOptionsBuilder

Parameters:

path - path to /bin/java

Returns:

builder

getJvm

public Optional<String> getJvm()

Description copied from interface: Options

JVM executable to use for forks

Specified by:

getJvm in interface Options

Returns:

path to JVM executable

jvmArgs

public ChainedOptionsBuilder jvmArgs(String... value)

Description copied from interface: ChainedOptionsBuilder

Forked JVM arguments.

Specified by:

jvmArgs in interface ChainedOptionsBuilder

Parameters:

value - arguments to add to the run

Returns:

builder

See Also:

Fork

getJvmArgs

public Optional<Collection<String>> getJvmArgs()

Description copied from interface: Options

JVM parameters to use with forks

Specified by:

getJvmArgs in interface Options

Returns:

JVM parameters

See Also:

Fork

jvmArgsAppend

public ChainedOptionsBuilder jvmArgsAppend(String... value)

Description copied from interface: ChainedOptionsBuilder

Append forked JVM arguments: These options go after other options.

Specified by:

jvmArgsAppend in interface ChainedOptionsBuilder

Parameters:

value - arguments to add to the run

Returns:

builder

See Also:

Fork

getJvmArgsAppend

public Optional<Collection<String>> getJvmArgsAppend()

Description copied from interface: Options

JVM parameters to use with forks (these options will be appended after any other JVM option)

Specified by:

getJvmArgsAppend in interface Options

Returns:

JVM parameters

See Also:

Fork

jvmArgsPrepend

public ChainedOptionsBuilder jvmArgsPrepend(String... value)

Description copied from interface: ChainedOptionsBuilder

Prepend forked JVM arguments: These options go before any other options.

Specified by:

jvmArgsPrepend in interface ChainedOptionsBuilder

Parameters:

value - arguments to add to the run

Returns:

builder

See Also:

Fork

getJvmArgsPrepend

public Optional<Collection<String>> getJvmArgsPrepend()

Description copied from interface: Options

JVM parameters to use with forks (these options will be prepended before any other JVM option)

Specified by:

getJvmArgsPrepend in interface Options

Returns:

JVM parameters

See Also:

Fork

detectJvmArgs

public ChainedOptionsBuilder detectJvmArgs()

Description copied from interface: ChainedOptionsBuilder

Autodetect forked JVM arguments from the parent VM. Overrides the jvmArgs(...) value.

Specified by:

detectJvmArgs in interface ChainedOptionsBuilder

Returns:

builder

getParameter

public Optional<Collection<String>> getParameter(String name)

Description copied from interface: Options

The overridden value of the parameter.

Specified by:

getParameter in interface Options

Parameters:

name - parameter name

Returns:

parameter

See Also:

Param

param

public ChainedOptionsBuilder param(String name,
                          String... values)

Description copied from interface: ChainedOptionsBuilder

Set benchmark parameter values. The parameter values would be taken in the order given by user.

Specified by:

param in interface ChainedOptionsBuilder

Parameters:

name - parameter

values - sequence of values to set

Returns:

builder

See Also:

Param

timeout

public ChainedOptionsBuilder timeout(TimeValue value)

Description copied from interface: ChainedOptionsBuilder

How long to wait for iteration execution?

Specified by:

timeout in interface ChainedOptionsBuilder

Parameters:

value - time

Returns:

builder

getTimeout

public Optional<TimeValue> getTimeout()

Description copied from interface: Options

Timeout: how long to wait for an iteration to complete.

Specified by:

getTimeout in interface Options

Returns:

duration