Package org.openjdk.jmh.runner.options
Interface Options
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
CommandLineOptions
,OptionsBuilder
-
Method Summary
Modifier and TypeMethodDescriptionBenchmarks modes to execute.Which benchmarks to omit?Fork countWhich benchmarks to execute?getJvm()
JVM executable to use for forksJVM parameters to use with forksJVM parameters to use with forks (these options will be appended after any other JVM option)JVM parameters to use with forks (these options will be prepended before any other JVM option)Number of batch size for measurementNumber of measurement iterationsThe duration for measurement iterationsOperations per invocation.Which file to use for dumping the outputgetParameter
(String name) The overridden value of the parameter.Profilers to use for the run.Which file to use for dumping the resultResult format to useOptional
<int[]> Thread subgroups distribution.Number of threads to runTimeout: how long to wait for an iteration to complete.Timeunit to use in units.Number of batch size for warmupNumber of initial forks to ignore the results forWhich benchmarks to warmup before doing the run.Number of warmup iterationsWarmup mode.The duration for warmup iterationsShould force GC between iterations?Should harness terminate on first error encountered?Should synchronize iterations?How verbose should we be?
-
Method Details
-
getIncludes
Which benchmarks to execute?- Returns:
- list of regexps matching the requested benchmarks
-
getExcludes
Which benchmarks to omit?- Returns:
- list of regexps matching the ignored benchmarks
-
getOutput
Which file to use for dumping the output- Returns:
- file name
-
getResultFormat
Optional<ResultFormatType> getResultFormat()Result format to use- Returns:
- format type
-
getResult
Which file to use for dumping the result- Returns:
- file name
-
shouldDoGC
Should force GC between iterations?- Returns:
- should GC?
-
getProfilers
List<ProfilerConfig> getProfilers()Profilers to use for the run. Profilers will start in the order specified by collection, and will stop in the reverse order.- Returns:
- profilers to use; empty collection if no profilers are required
-
verbosity
Optional<VerboseMode> verbosity()How verbose should we be?- Returns:
- verbosity mode
-
shouldFailOnError
Should harness terminate on first error encountered?- Returns:
- should terminate?
-
getThreads
Number of threads to run- Returns:
- number of threads; 0 to use maximum number of threads
- See Also:
-
getThreadGroups
Optional<int[]> getThreadGroups()Thread subgroups distribution.- Returns:
- array of thread ratios
- See Also:
-
shouldSyncIterations
Should synchronize iterations?- Returns:
- should we?
-
getWarmupIterations
Number of warmup iterations- Returns:
- number of warmup iterations
- See Also:
-
getWarmupTime
The duration for warmup iterations- Returns:
- duration
- See Also:
-
getWarmupBatchSize
Number of batch size for warmup- Returns:
- number of batch size for warmup
- See Also:
-
getWarmupMode
Optional<WarmupMode> getWarmupMode()Warmup mode.- Returns:
- warmup mode
- See Also:
-
getWarmupIncludes
Which benchmarks to warmup before doing the run.- Returns:
- list of regexps matching the relevant benchmarks; empty if no benchmarks are defined
-
getMeasurementIterations
Number of measurement iterations- Returns:
- number of measurement iterations
- See Also:
-
getMeasurementTime
The duration for measurement iterations- Returns:
- duration
- See Also:
-
getMeasurementBatchSize
Number of batch size for measurement- Returns:
- number of batch size for measurement
- See Also:
-
getBenchModes
Collection<Mode> getBenchModes()Benchmarks modes to execute.- Returns:
- modes to execute the benchmarks in; empty to use the default modes
- See Also:
-
getTimeUnit
Timeunit to use in units.- Returns:
- timeunit
- See Also:
-
getOperationsPerInvocation
Operations per invocation.- Returns:
- operations per invocation.
- See Also:
-
getForkCount
Fork count- Returns:
- fork count; 0, to prohibit forking
- See Also:
-
getWarmupForkCount
Number of initial forks to ignore the results for- Returns:
- initial fork count; 0, to disable
- See Also:
-
getJvm
JVM executable to use for forks- Returns:
- path to JVM executable
-
getJvmArgs
Optional<Collection<String>> getJvmArgs()JVM parameters to use with forks- Returns:
- JVM parameters
- See Also:
-
getJvmArgsAppend
Optional<Collection<String>> getJvmArgsAppend()JVM parameters to use with forks (these options will be appended after any other JVM option)- Returns:
- JVM parameters
- See Also:
-
getJvmArgsPrepend
Optional<Collection<String>> getJvmArgsPrepend()JVM parameters to use with forks (these options will be prepended before any other JVM option)- Returns:
- JVM parameters
- See Also:
-
getParameter
The overridden value of the parameter.- Parameters:
name
- parameter name- Returns:
- parameter
- See Also:
-
getTimeout
Timeout: how long to wait for an iteration to complete.- Returns:
- duration
-