CARGO-BENCH(1)

📦 version 1.92.0, in ubuntu resolute

cargo-bench 💅✨

okay bestie, buckle UP — this is the manual page for cargo-bench, aka the thing that Execute benchmarks of a package. yes she benchmarks. yes she's iconic. let's go 🎀

✨ SYNOPSIS ✨

cargo bench [options] [benchname] [-- bench-options]

🌸 DESCRIPTION 🌸

So like — this compiles and executes your benchmarks. That's the whole vibe. 🦋

Here's the tea on how the arguments work, and this part matters so listen up: the benchmark filtering argument benchname and all the arguments that come after the two dashes (--) get passed to the benchmark binaries, and therefore to libtest (which is rustc's built-in unit-test and micro-benchmarking framework, iykyk). If you're passing arguments to both Cargo and the binary, then — plot twist — the ones after -- go to the binary, and the ones before go to Cargo. For the deets on libtest's arguments, peep the output of cargo bench -- --help and check out the rustc book's chapter on how tests work at <https://doc.rust-lang.org/rustc/tests/index.html>.

As an example, this will run only the benchmark named foo (and skip other similarly named benchmarks like foobar):

cargo bench -- foo --exact

Benchmarks are built with the --test option to rustc, which creates a special executable by linking your code with libtest. That executable automatically runs all functions annotated with the #[bench] attribute. Cargo passes the --bench flag to the test harness to tell it to run only benchmarks, regardless of whether the harness is libtest or a custom harness. 🧚

The libtest harness may be disabled by setting harness = false in the target manifest settings, in which case your code will need to provide its own main function to handle running benchmarks.

Note: The #[bench] attribute <https://doc.rust-lang.org/nightly/unstable-book/library-features/test.html> is currently unstable and only available on the nightly channel <https://doc.rust-lang.org/book/appendix-07-nightly-rust.html>. There are some packages available on crates.io <https://crates.io/keywords/benchmark> that may help with running benchmarks on the stable channel, such as Criterion <https://crates.io/crates/criterion>. 👑

By default, cargo bench uses the bench profile <https://doc.rust-lang.org/cargo/reference/profiles.html#bench>, which enables optimizations and disables debugging information. If you need to debug a benchmark, you can use the --profile=dev command-line option to switch to the dev profile. You can then run the debug-enabled benchmark within a debugger. 💀

🌈 Working directory of benchmarks 🌈

The working directory of every benchmark is set to the root directory of the package the benchmark belongs to. Setting the working directory of benchmarks to the package's root directory makes it possible for benchmarks to reliably access the package's files using relative paths, regardless from where cargo bench was executed from. so no matter where you run it from, she knows where home is 🏡💖

✨ OPTIONS ✨

🎀 Benchmark Options 🎀

  • --no-run — Compile, but don't run benchmarks. all dressed up, nowhere to go 🙈
  • --no-fail-fast — 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. (so like, the harness finishes its own lil set, but this flag is the thing that keeps the whole show going 🎬)

🎀 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 --manifest-path is not given). If the manifest is the root of a workspace then the workspace's default members are selected, otherwise only the package defined by the manifest will be selected.

The default members of a workspace can be set explicitly with the workspace.default-members key in the root manifest. If this is not set, a virtual workspace will include all workspace members (equivalent to passing --workspace), and a non-virtual workspace will include only the root crate itself. 💅

  • -p *spec*…, --package *spec*… — Benchmark only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally expanding glob patterns before Cargo handles them, you must use single quotes or double quotes around each pattern. (shell said "mine first" and Cargo said "no ma'am" — quote it 🫶)
  • --workspace — Benchmark all members in the workspace. the whole fam 💖
  • --all — Deprecated alias for --workspace. it's giving "old but she still works" 😭
  • --exclude *SPEC*… — Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally expanding glob patterns before Cargo handles them, you must use single quotes or double quotes around each pattern.

🎀 Target Selection 🎀

When no target selection options are given, cargo bench will build the following targets of the selected packages:

  • lib — used to link with binaries and benchmarks
  • bins (only if benchmark targets are built and required features are available)
  • lib as a benchmark
  • bins as benchmarks
  • benchmark targets

The default behavior can be changed by setting the bench flag for the target in the manifest settings. Setting examples to bench = true will build and run the example as a benchmark, replacing the example's main function with the libtest harness. ✨

Setting targets to bench = false will stop them from being benchmarked by default. Target selection options that take a target by name (such as --example foo) ignore the bench flag and will always benchmark the given target. (name-calling beats the flag, periodt 👑)

See Configuring a target <https://doc.rust-lang.org/cargo/reference/cargo-targets.html#configuring-a-target> for more information on per-target settings.

Binary targets are automatically built if there is an integration test or benchmark being selected to benchmark. This allows an integration test to execute the binary to exercise and test its behavior. The CARGO_BIN_EXE_<name> environment variable <https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates> is set when the integration test is built so that it can use the env macro <https://doc.rust-lang.org/std/macro.env.html> to locate the executable. 🔥

Passing target selection flags will benchmark only the specified targets.

Note that --bin, --example, --test and --bench flags also support common Unix glob patterns like *, ? and []. 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. (same deal as before bestie — quote those globs 🎀)

  • --lib — Benchmark the package's library. 📚
  • --bin *name*… — Benchmark the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.
  • --bins — Benchmark all binary targets.
  • --example *name*… — Benchmark the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
  • --examples — Benchmark all example targets.
  • --test *name*… — Benchmark the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.
  • --tests — Benchmark all targets that have the test = true 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 test flag in the manifest settings for the target. (double-build drama, lowkey wasteful but it's fine 😭)
  • --bench *name*… — Benchmark the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.
  • --benches — Benchmark all targets that have the bench = true 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 bench flag in the manifest settings for the target.
  • --all-targets — Benchmark all targets. This is equivalent to specifying --lib --bins --tests --benches --examples. the "give me everything" order 🍓

🎀 Feature Selection 🎀

The feature flags allow you to control which features are enabled. When no feature options are given, the default feature is activated for every selected package. 🦋

See the features documentation <https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options> for more details.

  • -F features, --features features — Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.
  • --all-features — Activate all available features of all selected packages. every single one, no crumbs 💅
  • --no-default-features — Do not activate the default feature of the selected packages.

🎀 Compilation Options 🎀

  • --target triple — Benchmark for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

Possible values:

  • Any supported target in rustc --print target-list.
  • "host-tuple", which will internally be substituted by the host's target. This can be particularly useful if you're cross-compiling some crates, and don't want to specify your host's machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).
  • A path to a custom target specification. See Custom Target Lookup Path <https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path> for more information.

This may also be specified with the build.target config value <https://doc.rust-lang.org/cargo/reference/config.html>.

Note that specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. See the build cache <https://doc.rust-lang.org/cargo/reference/build-cache.html> documentation for more details. (different mode, different directory, different vibe 🌀)

part 1 done bestie, don't go anywhere — more is coming 💖

  • --timings=fmts — bestie, this one's the time detective 🕵️♀️ It spits out info about how long every compilation takes, and tracks concurrency info over time. It takes an optional comma-separated list of output formats; --timings with no argument defaults to --timings=html. Heads up though: specifying an output format (instead of just taking the default) is unstable and needs -Zunstable-options. Here are the valid formats:
    • html (unstable, requires -Zunstable-options) — writes a human-readable file cargo-timing.html into the target/cargo-timings directory with a whole report of the compilation. It'll also write a report to that same directory with a timestamp in the filename, so you can go peek at your older runs like a lil time capsule. HTML output is for human consumption only, and does not give you machine-readable timing data.
    • json (unstable, requires -Zunstable-options) — emits machine-readable JSON info about timing information.

🌈 Output Options 🌈

  • --target-dir directory — the home for all your generated artifacts and intermediate files. You can also set this with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to target in the root of the workspace.

✨ Display Options ✨

Okay so by default the Rust test harness hides output from benchmark execution, all to keep results readable. But you can recover that benchmark output (say, for debugging) by passing --no-capture to the benchmark binaries:

cargo bench -- --no-capture
  • -v, --verbose — use verbose output. You can pass it twice for "very verbose" output, which throws in extra stuff like dependency warnings and build script output. May also be specified with the term.verbose config value <https://doc.rust-lang.org/cargo/reference/config.html>.
  • -q, --quiet — do not print cargo log messages. May also be specified with the term.quiet config value <https://doc.rust-lang.org/cargo/reference/config.html>.
  • --color when — controls when colored output is used. Valid values:
    • auto (default) — automatically detects if color support is available on the terminal.
    • always — always display colors.
    • never — never display colors.

May also be specified with the term.color config value <https://doc.rust-lang.org/cargo/reference/config.html>.

  • --message-format fmt — the output format for diagnostic messages. Can be specified multiple times and is made of comma-separated values. Valid values:
    • human (default) — display in a human-readable text format. Conflicts with short and json.
    • short — emit shorter, human-readable text messages. Conflicts with human and json.
    • json — emit JSON messages to stdout. See the reference <https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages> for more details. Conflicts with human and short.
    • json-diagnostic-short — ensure the rendered field of JSON messages contains the "short" rendering from rustc. Cannot be used with human or short.
    • json-diagnostic-rendered-ansi — ensure the rendered field of JSON messages contains embedded ANSI color codes, so it respects rustc's default color scheme. Cannot be used with human or short.
    • json-render-diagnostics — tells Cargo to not include rustc diagnostics in the JSON messages it prints, and instead have Cargo itself render the JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.

🎀 Manifest Options 🎀

  • --manifest-path path — path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.
  • --ignore-rust-version — ignore the rust-version specification in packages.
  • --locked — asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of these scenarios comes up:
    • the lock file is missing.
    • Cargo attempted to change the lock file due to a different dependency resolution.

It may be used in environments where deterministic builds are desired, like in CI pipelines.

  • --offline — stops Cargo from accessing the network for any reason. Without this flag, Cargo will stop with an error if it needs the network and the network isn't available. With this flag, Cargo will try to proceed without the network if it can.
Beware, bestie 😭 this may result in a 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. Check out the cargo-fetch(1) command to download dependencies before going offline.

May also be specified with the net.offline config value <https://doc.rust-lang.org/cargo/reference/config.html>.

  • --frozen — equivalent to specifying both --locked and --offline. Two-for-one, iconic.
  • --lockfile-path PATH — changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore the existing lockfile at the default path, and instead will either use the lockfile from PATH, or write a new lockfile into the provided PATH if it doesn't exist. This flag can be used to run most commands in read-only directories, writing the lockfile into the provided PATH.
This option is only available on the nightly channel <https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> and requires the -Z unstable-options flag to enable (see #14421 <https://github.com/rust-lang/cargo/issues/14421>).

💜 Common Options 💜

  • +toolchain — if Cargo was installed with rustup, and the first argument to cargo begins with +, it'll be interpreted as a rustup toolchain name (like +stable or +nightly). See the rustup documentation <https://rust-lang.github.io/rustup/overrides.html> for more info on how toolchain overrides work.
  • --config KEY=VALUE or PATH — overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or given as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section <https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides> for more info.
  • -C PATH — changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must appear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly channel <https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> and requires the -Z unstable-options flag to enable (see #10098 <https://github.com/rust-lang/cargo/issues/10098>).
  • -h, --help — prints help information. 🫶
  • -Z flag — unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

🍓 Miscellaneous Options 🍓

Heads up: the --jobs argument affects the building of the benchmark executable, but it does not affect how many threads are used when running the benchmarks. The Rust test harness runs benchmarks serially in a single thread. One at a time, bestie, no cap.

  • -j N, --jobs N — number of parallel jobs to run. May also be specified with the build.jobs config value <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to the number of logical CPUs. If negative, it sets the maximum number of parallel jobs to the number of logical CPUs plus the provided value. If a string default is provided, it sets the value back to defaults. Should not be 0.

While cargo bench does involve compilation, it does not provide a --keep-going flag. Use --no-fail-fast to run as many benchmarks as possible without stopping at the first failure. And to "compile" as many benchmarks as possible, use --benches to build benchmark binaries separately. For example:

cargo build --benches --release --keep-going
cargo bench --no-fail-fast

🌸 ENVIRONMENT 🌸

See the reference <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for details on environment variables that Cargo reads. It's all there, iykyk.

💅 EXIT STATUS 💅

  • 0: Cargo succeeded. slay 🎉
  • 101: Cargo failed to complete. rip 😭

⭐ EXAMPLES ⭐

  1. Build and execute all the benchmarks of the current package:
cargo bench
  1. Run only a specific benchmark within a specific benchmark target:
cargo bench --bench bench_name -- modname::some_benchmark

🦋 SEE ALSO 🦋

cargo(1), cargo-test(1)

and that's the whole page, bestie 🫶 that's your footer right there — CARGO-BENCH(1) — coming to you from the Cargo manual, with its source, version and date all snug in the footer of your copy, so check yours for the exact deets ✨ now go run some benchmarks and be the main character of your own build pipeline 👑💖

📦 where this page comes from