CARGO-BENCH(1)

📦 version 1.78.0, in ubuntu jammy, ubuntu noble

cargo-bench 💅

the manual page, bestie edition ✨ — <cyan>General Commands Manual</cyan> 🎀

NAME 🌸

cargo-bench — Execute benchmarks of a package 🔥

SYNOPSIS 🦋

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

DESCRIPTION 💖

okay so. Compile and execute benchmarks. That's the whole vibe. 👑

The benchmark filtering argument benchname and all the arguments following the two dashes (--) get passed to the benchmark binaries, which means they go straight to libtest (rustc's built-in unit-test and micro-benchmarking framework, iykyk). If you're passing arguments to both Cargo and the binary: the ones after -- go to the binary, the ones before go to Cargo. That's the whole split, no cap. 🫶

For the deets on libtest's arguments, check the output of cargo bench -- --help and go read the rustc book's chapter on how tests work at https://doc.rust-lang.org/rustc/tests/index.html.

Example time ✨ — this runs only the benchmark named foo (and skips other similarly named benchmarks like foobar, because --exact said so):

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 can be disabled by setting harness = false in the target manifest settings — in which case your code needs to provide its own main function to handle running benchmarks. You're on your own for that one bestie. 😭

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. Then you can run the debug-enabled benchmark inside 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 of where cargo bench was executed from. Slay. 💖

OPTIONS ⭐

Benchmark Options 🎀

  • --no-run — Compile, but don't run benchmarks. Build only, no main character energy. 🙈
  • --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. 🔥

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. no cap, quote ur globs. 💅
  • --workspace — Benchmark all members in the workspace. 👯
  • --all — Deprecated alias for --workspace. it's giving legacy, use the new one bestie. 💀
  • --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. ✨

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. 💅

  • --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 in test mode 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. 😭
  • --bench *name*… — Benchmark the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.
  • --benches — Benchmark all targets in benchmark mode 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. all of them, periodt. 👑

Feature Selection 🧚

The feature flags let you 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. go big or go home. 🔥
  • --no-default-features — Do not activate the default feature of the selected packages. 🚫

Compilation Options 🛠️

  • --target triple — Benchmark for the given architecture. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for a list of supported targets. This flag may be specified multiple times.

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/guide/build-cache.html) documentation for more details. 📂

  • --profile name — Benchmark with the given profile. See the reference (https://doc.rust-lang.org/cargo/reference/profiles.html) for more details on profiles. ✨
  • --ignore-rust-version — Benchmark the target even if the selected Rust compiler is older than the required Rust version as configured in the project's rust-version field. living dangerously, respect. 💅
  • --timings=fmts — Output information on how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. Specifying an output format (rather than the default) is unstable and requires -Zunstable-options. Valid output formats:
  • html (unstable, needs -Zunstable-options) — writes a whole human-readable file called cargo-timing.html into the target/cargo-timings directory, with a report of the compilation 💖 and if you want to peek at older runs, it also drops a report in that same directory with a timestamp in the filename. HTML output is for human consumption only — it does not give you machine-readable timing data, bestie.
  • json (unstable, needs -Zunstable-options) — emits machine-readable JSON info about the timing info. 🤖

🗂️ Output Options 🗂️

  • --target-dir directory — the directory for all the generated artifacts and intermediate files. You can also set it with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. Defaults to target in the root of the workspace. ✨

👀 Display Options 👀

So by default the Rust test harness hides output from benchmark execution, because otherwise the results would be a whole mess and nobody could read them. If you wanna recover that benchmark output (say, for debugging 👩‍💻), just pass --nocapture to the benchmark binaries:

cargo bench -- --nocapture
  • -v, --verbose — verbose output, bestie. You can specify it twice for "very verbose" output, which includes extra stuff like dependency warnings and build script output. May also be specified with the term.verbose config value.
  • -q, --quiet — do not print cargo log messages. Periodt. May also be specified with the term.quiet config value.
  • --color when — controls when colored output is used 🌈. Valid values:
    • auto (default): automatically detect 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.

  • --message-format fmt — the output format for diagnostic messages 💬. Can be specified multiple times and consists 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 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 not to 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 the 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. 🦋
  • --frozen, --locked — either of these flags requires that the Cargo.lock file is up-to-date. If the lock file is missing, or it needs to be updated, Cargo will exit with an error 😭. The --frozen flag also stops Cargo from even attempting to access the network to determine if it's out-of-date.

These are for environments where you wanna assert that the Cargo.lock file is up-to-date (like a CI build, iykyk) or where you want to avoid network access entirely.

  • --offline — prevents Cargo from accessing the network for any reason. Without this flag, Cargo just stops with an error if it needs the network and the network isn't there. With this flag, Cargo will try to proceed without the network if it possibly can.
⚠️ Beware, bestie: this may result in different dependency resolution than online mode. Cargo restricts 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 cargo-fetch(1) command to download dependencies before going offline.

May also be specified with the net.offline config value.

🧰 Common Options 🧰

  • +toolchain — if Cargo has been installed with rustup, and the first argument to cargo begins with +, it gets interpreted as a rustup toolchain name (like +stable or +nightly) 🛠️. See the rustup documentation for more info about 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 for more info.
  • -C PATH — changes the current working directory before executing any specified operations. This affects stuff like where cargo looks by default for the project manifest (Cargo.toml), and also the directories searched for discovering .cargo/config.toml, for example. This option must appear before the command name, like cargo -C path/to/my-project build.
🌙 This option is only available on the nightly channel and requires the -Z unstable-options flag to enable (see #10098).
  • -h, --help — prints help information. Classic. 💅
  • -Z flag — unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

🎀 Miscellaneous Options 🎀

Heads up, this part matters: 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. Single. Thread. 🧵

  • -j N, --jobs N — number of parallel jobs to run. May also be specified with the build.jobs config value. 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 involves 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. Like so:

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

🌍 ENVIRONMENT 🌍

See the reference for details on environment variables that Cargo reads. (Yes, there's a whole list over there, go look, it's giving ✨documentation✨.)

🚦 EXIT STATUS 🚦

  • 0: Cargo succeeded. 🎉
  • 101: Cargo failed to complete. 💀

🌟 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 vibe, bestie — this was CARGO-BENCH(1), straight from the Cargo manual (you know the one, it's got its own date stamped down at the bottom of the page 🫶). Go forth and benchmark. Slay. 💅✨

📦 where this page comes from