You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
462 lines
15 KiB
462 lines
15 KiB
'\" t
|
|
.TH "CARGO\-BENCH" "1"
|
|
.nh
|
|
.ad l
|
|
.ss \n[.ss] 0
|
|
.SH "NAME"
|
|
cargo\-bench \- Execute benchmarks of a package
|
|
.SH "SYNOPSIS"
|
|
\fBcargo bench\fR [\fIoptions\fR] [\fIbenchname\fR] [\fB\-\-\fR \fIbench\-options\fR]
|
|
.SH "DESCRIPTION"
|
|
Compile and execute benchmarks.
|
|
.sp
|
|
The benchmark filtering argument \fIbenchname\fR and all the arguments following
|
|
the two dashes (\fB\-\-\fR) are passed to the benchmark binaries and thus to
|
|
\fIlibtest\fR (rustc's built in unit\-test and micro\-benchmarking framework). If
|
|
you are passing arguments to both Cargo and the binary, the ones after \fB\-\-\fR go
|
|
to the binary, the ones before go to Cargo. For details about libtest's
|
|
arguments see the output of \fBcargo bench \-\- \-\-help\fR\&. As an example, this will
|
|
run only the benchmark named \fBfoo\fR (and skip other similarly named benchmarks
|
|
like \fBfoobar\fR):
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo bench \-\- foo \-\-exact
|
|
.fi
|
|
.RE
|
|
.sp
|
|
Benchmarks are built with the \fB\-\-test\fR option to \fBrustc\fR which creates an
|
|
executable with a \fBmain\fR function that automatically runs all functions
|
|
annotated with the \fB#[bench]\fR attribute. Cargo passes the \fB\-\-bench\fR flag to
|
|
the test harness to tell it to run only benchmarks.
|
|
.sp
|
|
The libtest harness may be disabled by setting \fBharness = false\fR in the target
|
|
manifest settings, in which case your code will need to provide its own \fBmain\fR
|
|
function to handle running benchmarks.
|
|
.RS 3
|
|
.ll -5
|
|
.sp
|
|
\fBNote\fR: The
|
|
\fI\f(BI#[bench]\fI attribute\fR <https://doc.rust\-lang.org/nightly/unstable\-book/library\-features/test.html>
|
|
is currently unstable and only available on the
|
|
\fInightly channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html>\&.
|
|
There are some packages available on
|
|
\fIcrates.io\fR <https://crates.io/keywords/benchmark> that may help with
|
|
running benchmarks on the stable channel, such as
|
|
\fICriterion\fR <https://crates.io/crates/criterion>\&.
|
|
.br
|
|
.RE
|
|
.ll
|
|
.SH "OPTIONS"
|
|
.SS "Benchmark Options"
|
|
.sp
|
|
\fB\-\-no\-run\fR
|
|
.RS 4
|
|
Compile, but don't run benchmarks.
|
|
.RE
|
|
.sp
|
|
\fB\-\-no\-fail\-fast\fR
|
|
.RS 4
|
|
Run all benchmarks regardless of failure. Without this flag, Cargo will exit
|
|
after the first executable fails. The Rust test harness will run all benchmarks
|
|
within the executable to completion, this flag only applies to the executable
|
|
as a whole.
|
|
.RE
|
|
.SS "Package Selection"
|
|
By default, when no package selection options are given, the packages selected
|
|
depend on the selected manifest file (based on the current working directory if
|
|
\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then
|
|
the workspaces default members are selected, otherwise only the package defined
|
|
by the manifest will be selected.
|
|
.sp
|
|
The default members of a workspace can be set explicitly with the
|
|
\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a
|
|
virtual workspace will include all workspace members (equivalent to passing
|
|
\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself.
|
|
.sp
|
|
\fB\-p\fR \fIspec\fR\&...,
|
|
\fB\-\-package\fR \fIspec\fR\&...
|
|
.RS 4
|
|
Benchmark only the specified packages. See \fBcargo\-pkgid\fR(1) for the
|
|
SPEC format. This flag may be specified multiple times and supports common Unix
|
|
glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally
|
|
expanding glob patterns before Cargo handles them, you must use single quotes or
|
|
double quotes around each pattern.
|
|
.RE
|
|
.sp
|
|
\fB\-\-workspace\fR
|
|
.RS 4
|
|
Benchmark all members in the workspace.
|
|
.RE
|
|
.sp
|
|
\fB\-\-all\fR
|
|
.RS 4
|
|
Deprecated alias for \fB\-\-workspace\fR\&.
|
|
.RE
|
|
.sp
|
|
\fB\-\-exclude\fR \fISPEC\fR\&...
|
|
.RS 4
|
|
Exclude the specified packages. Must be used in conjunction with the
|
|
\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports
|
|
common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell
|
|
accidentally expanding glob patterns before Cargo handles them, you must use
|
|
single quotes or double quotes around each pattern.
|
|
.RE
|
|
.SS "Target Selection"
|
|
When no target selection options are given, \fBcargo bench\fR will build the
|
|
following targets of the selected packages:
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'lib \[em] used to link with binaries and benchmarks
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'bins (only if benchmark targets are built and required features are
|
|
available)
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'lib as a benchmark
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'bins as benchmarks
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'benchmark targets
|
|
.RE
|
|
.sp
|
|
The default behavior can be changed by setting the \fBbench\fR flag for the target
|
|
in the manifest settings. Setting examples to \fBbench = true\fR will build and
|
|
run the example as a benchmark. Setting targets to \fBbench = false\fR will stop
|
|
them from being benchmarked by default. Target selection options that take a
|
|
target by name ignore the \fBbench\fR flag and will always benchmark the given
|
|
target.
|
|
.sp
|
|
Passing target selection flags will benchmark only the specified
|
|
targets.
|
|
.sp
|
|
Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also
|
|
support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your
|
|
shell accidentally expanding glob patterns before Cargo handles them, you must
|
|
use single quotes or double quotes around each glob pattern.
|
|
.sp
|
|
\fB\-\-lib\fR
|
|
.RS 4
|
|
Benchmark the package's library.
|
|
.RE
|
|
.sp
|
|
\fB\-\-bin\fR \fIname\fR\&...
|
|
.RS 4
|
|
Benchmark the specified binary. This flag may be specified multiple times
|
|
and supports common Unix glob patterns.
|
|
.RE
|
|
.sp
|
|
\fB\-\-bins\fR
|
|
.RS 4
|
|
Benchmark all binary targets.
|
|
.RE
|
|
.sp
|
|
\fB\-\-example\fR \fIname\fR\&...
|
|
.RS 4
|
|
Benchmark the specified example. This flag may be specified multiple times
|
|
and supports common Unix glob patterns.
|
|
.RE
|
|
.sp
|
|
\fB\-\-examples\fR
|
|
.RS 4
|
|
Benchmark all example targets.
|
|
.RE
|
|
.sp
|
|
\fB\-\-test\fR \fIname\fR\&...
|
|
.RS 4
|
|
Benchmark the specified integration test. This flag may be specified
|
|
multiple times and supports common Unix glob patterns.
|
|
.RE
|
|
.sp
|
|
\fB\-\-tests\fR
|
|
.RS 4
|
|
Benchmark all targets in test mode that have the \fBtest = true\fR manifest
|
|
flag set. By default this includes the library and binaries built as
|
|
unittests, and integration tests. Be aware that this will also build any
|
|
required dependencies, so the lib target may be built twice (once as a
|
|
unittest, and once as a dependency for binaries, integration tests, etc.).
|
|
Targets may be enabled or disabled by setting the \fBtest\fR flag in the
|
|
manifest settings for the target.
|
|
.RE
|
|
.sp
|
|
\fB\-\-bench\fR \fIname\fR\&...
|
|
.RS 4
|
|
Benchmark the specified benchmark. This flag may be specified multiple
|
|
times and supports common Unix glob patterns.
|
|
.RE
|
|
.sp
|
|
\fB\-\-benches\fR
|
|
.RS 4
|
|
Benchmark all targets in benchmark mode that have the \fBbench = true\fR
|
|
manifest flag set. By default this includes the library and binaries built
|
|
as benchmarks, and bench targets. Be aware that this will also build any
|
|
required dependencies, so the lib target may be built twice (once as a
|
|
benchmark, and once as a dependency for binaries, benchmarks, etc.).
|
|
Targets may be enabled or disabled by setting the \fBbench\fR flag in the
|
|
manifest settings for the target.
|
|
.RE
|
|
.sp
|
|
\fB\-\-all\-targets\fR
|
|
.RS 4
|
|
Benchmark all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&.
|
|
.RE
|
|
.SS "Feature Selection"
|
|
The feature flags allow you to control which features are enabled. When no
|
|
feature options are given, the \fBdefault\fR feature is activated for every
|
|
selected package.
|
|
.sp
|
|
See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
|
|
for more details.
|
|
.sp
|
|
\fB\-\-features\fR \fIfeatures\fR
|
|
.RS 4
|
|
Space or comma separated list of features to activate. Features of workspace
|
|
members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
|
|
be specified multiple times, which enables all specified features.
|
|
.RE
|
|
.sp
|
|
\fB\-\-all\-features\fR
|
|
.RS 4
|
|
Activate all available features of all selected packages.
|
|
.RE
|
|
.sp
|
|
\fB\-\-no\-default\-features\fR
|
|
.RS 4
|
|
Do not activate the \fBdefault\fR feature of the selected packages.
|
|
.RE
|
|
.SS "Compilation Options"
|
|
.sp
|
|
\fB\-\-target\fR \fItriple\fR
|
|
.RS 4
|
|
Benchmark for the given architecture. The default is the host
|
|
architecture. The general format of the triple is
|
|
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
|
|
list of supported targets.
|
|
.sp
|
|
This may also be specified with the \fBbuild.target\fR
|
|
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.sp
|
|
Note that specifying this flag makes Cargo run in a different mode where the
|
|
target artifacts are placed in a separate directory. See the
|
|
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/guide/build\-cache.html> documentation for more details.
|
|
.RE
|
|
.SS "Output Options"
|
|
.sp
|
|
\fB\-\-target\-dir\fR \fIdirectory\fR
|
|
.RS 4
|
|
Directory for all generated artifacts and intermediate files. May also be
|
|
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
|
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults
|
|
to \fBtarget\fR in the root of the workspace.
|
|
.RE
|
|
.SS "Display Options"
|
|
By default the Rust test harness hides output from benchmark execution to keep
|
|
results readable. Benchmark output can be recovered (e.g., for debugging) by
|
|
passing \fB\-\-nocapture\fR to the benchmark binaries:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo bench \-\- \-\-nocapture
|
|
.fi
|
|
.RE
|
|
.sp
|
|
\fB\-v\fR,
|
|
\fB\-\-verbose\fR
|
|
.RS 4
|
|
Use verbose output. May be specified twice for "very verbose" output which
|
|
includes extra output such as dependency warnings and build script output.
|
|
May also be specified with the \fBterm.verbose\fR
|
|
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.RE
|
|
.sp
|
|
\fB\-q\fR,
|
|
\fB\-\-quiet\fR
|
|
.RS 4
|
|
No output printed to stdout.
|
|
.RE
|
|
.sp
|
|
\fB\-\-color\fR \fIwhen\fR
|
|
.RS 4
|
|
Control when colored output is used. Valid values:
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBauto\fR (default): Automatically detect if color support is available on the
|
|
terminal.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBalways\fR: Always display colors.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBnever\fR: Never display colors.
|
|
.RE
|
|
.sp
|
|
May also be specified with the \fBterm.color\fR
|
|
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.RE
|
|
.sp
|
|
\fB\-\-message\-format\fR \fIfmt\fR
|
|
.RS 4
|
|
The output format for diagnostic messages. Can be specified multiple times
|
|
and consists of comma\-separated values. Valid values:
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBhuman\fR (default): Display in a human\-readable text format.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBshort\fR: Emit shorter, human\-readable text messages.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBjson\fR: Emit JSON messages to stdout. See
|
|
\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
|
|
for more details.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
|
|
the "short" rendering from rustc.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
|
|
contains embedded ANSI color codes for respecting rustc's default color
|
|
scheme.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in
|
|
in JSON messages printed, but instead Cargo itself should render the
|
|
JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
|
|
coming from rustc are still emitted.
|
|
.RE
|
|
.RE
|
|
.SS "Manifest Options"
|
|
.sp
|
|
\fB\-\-manifest\-path\fR \fIpath\fR
|
|
.RS 4
|
|
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
|
\fBCargo.toml\fR file in the current directory or any parent directory.
|
|
.RE
|
|
.sp
|
|
\fB\-\-frozen\fR,
|
|
\fB\-\-locked\fR
|
|
.RS 4
|
|
Either of these flags requires that the \fBCargo.lock\fR file is
|
|
up\-to\-date. If the lock file is missing, or it needs to be updated, Cargo will
|
|
exit with an error. The \fB\-\-frozen\fR flag also prevents Cargo from
|
|
attempting to access the network to determine if it is out\-of\-date.
|
|
.sp
|
|
These may be used in environments where you want to assert that the
|
|
\fBCargo.lock\fR file is up\-to\-date (such as a CI build) or want to avoid network
|
|
access.
|
|
.RE
|
|
.sp
|
|
\fB\-\-offline\fR
|
|
.RS 4
|
|
Prevents Cargo from accessing the network for any reason. Without this
|
|
flag, Cargo will stop with an error if it needs to access the network and
|
|
the network is not available. With this flag, Cargo will attempt to
|
|
proceed without the network if possible.
|
|
.sp
|
|
Beware that this may result in different dependency resolution than online
|
|
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
|
if there might be a newer version as indicated in the local copy of the index.
|
|
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
|
offline.
|
|
.sp
|
|
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.RE
|
|
.SS "Common Options"
|
|
.sp
|
|
\fB+\fR\fItoolchain\fR
|
|
.RS 4
|
|
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
|
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
|
as \fB+stable\fR or \fB+nightly\fR).
|
|
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
|
for more information about how toolchain overrides work.
|
|
.RE
|
|
.sp
|
|
\fB\-h\fR,
|
|
\fB\-\-help\fR
|
|
.RS 4
|
|
Prints help information.
|
|
.RE
|
|
.sp
|
|
\fB\-Z\fR \fIflag\fR
|
|
.RS 4
|
|
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
|
.RE
|
|
.SS "Miscellaneous Options"
|
|
The \fB\-\-jobs\fR argument affects the building of the benchmark executable but
|
|
does not affect how many threads are used when running the benchmarks. The
|
|
Rust test harness runs benchmarks serially in a single thread.
|
|
.sp
|
|
\fB\-j\fR \fIN\fR,
|
|
\fB\-\-jobs\fR \fIN\fR
|
|
.RS 4
|
|
Number of parallel jobs to run. May also be specified with the
|
|
\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
|
|
the number of CPUs.
|
|
.RE
|
|
.SH "PROFILES"
|
|
Profiles may be used to configure compiler options such as optimization levels
|
|
and debug settings. See
|
|
\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html>
|
|
for more details.
|
|
.sp
|
|
Benchmarks are always built with the \fBbench\fR profile. Binary and lib targets
|
|
are built separately as benchmarks with the \fBbench\fR profile. Library targets
|
|
are built with the \fBrelease\fR profiles when linked to binaries and benchmarks.
|
|
Dependencies use the \fBrelease\fR profile.
|
|
.sp
|
|
If you need a debug build of a benchmark, try building it with
|
|
\fBcargo\-build\fR(1) which will use the \fBtest\fR profile which is by default
|
|
unoptimized and includes debug information. You can then run the debug\-enabled
|
|
benchmark manually.
|
|
.SH "ENVIRONMENT"
|
|
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
|
details on environment variables that Cargo reads.
|
|
.SH "EXIT STATUS"
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fB0\fR: Cargo succeeded.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fB101\fR: Cargo failed to complete.
|
|
.RE
|
|
.SH "EXAMPLES"
|
|
.sp
|
|
.RS 4
|
|
\h'-04' 1.\h'+01'Build and execute all the benchmarks of the current package:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo bench
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04' 2.\h'+01'Run only a specific benchmark within a specific benchmark target:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo bench \-\-bench bench_name \-\- modname::some_benchmark
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
\fBcargo\fR(1), \fBcargo\-test\fR(1)
|