Description
The microbench project is used to test the performance of SM2/SM3/SM3withSM2/SM4 algorithms.
How to build
A benchmarks.jar will be generated in the target directory through the following command:
mvn install
How to run
Run benchmarks.jar using the java -jar command.
java -jar target/benchmarks.jar
If you only want to test the performance of SM3, you can specify the class (SM3Benchmark) to test SM3 in the parameters.
java -jar target/benchmarks.jar SM3Benchmark
If you want to test algorithms implemented by other Providers, you can specify the Provider through the system property benchmark.provider.name.
java -jar target/benchmarks.jar -jvmArgsPrepend "-Dbenchmark.provider.name=org.openeuler.security.openssl.KAEProvider"
If you want to test algorithms implemented by SDFProvider, you can specify the Provider through the system property benchmark.provider.name.
java -Dbenchmark.provider.name=org.openeuler.sdf.provider.SDFProvider -Dsdf.sdkConfig=/tmp/sdk.config -Dsdf.defaultKEKId="xxxxxxxxx" -Dsdf.defaultRegionId="TestRegion" -Dsdf.defaultCdpId="cdp_xxxxxx" -jar target/benchmarks.jar SM3Benchmark
More JMH parameter introduction
Using the -h parameter will print out JMH parameter usage instructions.
java -jar target/benchmarks.jar -h
The usage of JMH parameters is as follows:
Usage: java -jar ... [regexp*] [options]
[opt] means optional argument.
<opt> means required argument.
"+" means comma-separated list of values.
"time" arguments accept time suffixes, like "100ms".
Command line options usually take precedence over annotations.
[arguments] Benchmarks to run (regexp+). (default: .*)
-i <int> Number of measurement iterations to do. Measurement
iterations are counted towards the benchmark score.
(default: 1 for SingleShotTime, and 5 for all other
modes)
-bs <int> Batch size: number of benchmark method calls per
operation. Some benchmark modes may ignore this
setting, please check this separately. (default:
1)
-r <time> Minimum time to spend at each measurement iteration.
Benchmarks may generally run longer than iteration
duration. (default: 10 s)
-wi <int> Number of warmup iterations to do. Warmup iterations
are not counted towards the benchmark score. (default:
0 for SingleShotTime, and 5 for all other modes)
-wbs <int> Warmup batch size: number of benchmark method calls
per operation. Some benchmark modes may ignore this
setting. (default: 1)
-w <time> Minimum time to spend at each warmup iteration. Benchmarks
may generally run longer than iteration duration.
(default: 10 s)
-to <time> Timeout for benchmark iteration. After reaching
this timeout, JMH will try to interrupt the running
tasks. Non-cooperating benchmarks may ignore this
timeout. (default: 10 min)
-t <int> Number of worker threads to run with. 'max' means
the maximum number of hardware threads available
on the machine, figured out by JMH itself. (default:
1)
-bm <mode> Benchmark mode. Available modes are: [Throughput/thrpt,
AverageTime/avgt, SampleTime/sample, SingleShotTime/ss,
All/all]. (default: Throughput)
-si <bool> Should JMH synchronize iterations? This would significantly
lower the noise in multithreaded tests, by making
sure the measured part happens only when all workers
are running. (default: true)
-gc <bool> Should JMH force GC between iterations? Forcing
the GC may help to lower the noise in GC-heavy benchmarks,
at the expense of jeopardizing GC ergonomics decisions.
Use with care. (default: false)
-foe <bool> Should JMH fail immediately if any benchmark had
experienced an unrecoverable error? This helps
to make quick sanity tests for benchmark suites,
as well as make the automated runs with checking error
codes. (default: false)
-v <mode> Verbosity mode. Available modes are: [SILENT, NORMAL,
EXTRA]. (default: NORMAL)
-f <int> How many times to fork a single benchmark. Use 0 to
disable forking altogether. Warning: disabling
forking may have detrimental impact on benchmark
and infrastructure reliability, you might want
to use different warmup mode instead. (default:
5)
-wf <int> How many warmup forks to make for a single benchmark.
All iterations within the warmup fork are not counted
towards the benchmark score. Use 0 to disable warmup
forks. (default: 0)
-o <filename> Redirect human-readable output to a given file.
-rff <filename> Write machine-readable results to a given file.
The file format is controlled by -rf option. Please
see the list of result formats for available formats.
(default: jmh-result.<result-format>)
-prof <profiler> Use profilers to collect additional benchmark data.
Some profilers are not available on all JVMs and/or
all OSes. Please see the list of available profilers
with -lprof.
-tg <int+> Override thread group distribution for asymmetric
benchmarks. This option expects a comma-separated
list of thread counts within the group. See @Group/@GroupThreads
Javadoc for more information.
-jvm <string> Use given JVM for runs. This option only affects forked
runs.
-jvmArgs <string> Use given JVM arguments. Most options are inherited
from the host VM options, but in some cases you want
to pass the options only to a forked VM. Either single
space-separated option line, or multiple options
are accepted. This option only affects forked runs.
-jvmArgsAppend <string> Same as jvmArgs, but append these options after the
already given JVM args.
-jvmArgsPrepend <string> Same as jvmArgs, but prepend these options before
the already given JVM arg.
-tu <TU> Override time unit in benchmark results. Available
time units are: [m, s, ms, us, ns]. (default: SECONDS)
-opi <int> Override operations per invocation, see @OperationsPerInvocation
Javadoc for details. (default: 1)
-rf <type> Format type for machine-readable results. These
results are written to a separate file (see -rff).
See the list of available result formats with -lrf.
(default: CSV)
-wm <mode> Warmup mode for warming up selected benchmarks.
Warmup modes are: INDI = Warmup each benchmark individually,
then measure it. BULK = Warmup all benchmarks first,
then do all the measurements. BULK_INDI = Warmup
all benchmarks first, then re-warmup each benchmark
individually, then measure it. (default: INDI)
-e <regexp+> Benchmarks to exclude from the run.
-p <param={v,}*> Benchmark parameters. This option is expected to
be used once per parameter. Parameter name and parameter
values should be separated with equals sign. Parameter
values should be separated with commas.
-wmb <regexp+> Warmup benchmarks to include in the run in addition
to already selected by the primary filters. Harness
will not measure these benchmarks, but only use them
for the warmup.
-l List the benchmarks that match a filter, and exit.
-lp List the benchmarks that match a filter, along with
parameters, and exit.
-lrf List machine-readable result formats, and exit.
-lprof List profilers, and exit.
-h Display help, and exit.