cargo-bench(1)

名称

cargo-bench — 执行包的基准测试

概要

cargo bench [选项] [基准测试名称] [-- 基准测试选项]

描述

编译并执行基准测试。

基准测试过滤参数 基准测试名称 以及紧跟在双破折号 (--) 之后的所有参数都会传递给基准测试二进制文件，进而传递给 libtest（rustc 内置的单元测试和微基准测试框架）。如果你同时向 Cargo 和二进制文件传递参数，-- 后面的参数传递给二进制文件，前面的传递给 Cargo。有关 libtest 参数的详细信息，请参阅 cargo bench -- --help 的输出，并查看 rustc 手册关于测试工作方式的章节：https://doc.rust-lang.net.cn/rustc/tests/index.html。

例如，这将只运行名为 foo 的基准测试（并跳过其他类似名称的基准测试，如 foobar）

cargo bench -- foo --exact

基准测试使用 rustc 的 --test 选项构建，该选项通过将你的代码与 libtest 链接来创建特殊的可执行文件。该可执行文件会自动运行所有带有 #[bench] 属性的函数。Cargo 会将 --bench 标志传递给测试框架，告诉它只运行基准测试，无论该框架是 libtest 还是自定义框架。

可以通过在目标清单设置中将 harness = false 来禁用 libtest 框架，在这种情况下，你的代码需要提供自己的 main 函数来处理基准测试的运行。

注意：#[bench] 属性目前是不稳定的，仅在每夜版本 (nightly channel)上可用。在 crates.io 上有一些包可以帮助在稳定版本 (stable channel) 上运行基准测试，例如 Criterion。

默认情况下，cargo bench 使用bench profile，该 profile 启用优化并禁用调试信息。如果需要调试基准测试，可以使用 --profile=dev 命令行选项切换到 dev profile。然后可以在调试器中运行启用调试功能的基准测试。

基准测试的工作目录

每个基准测试的工作目录都设置为基准测试所属包的根目录。将基准测试的工作目录设置为包的根目录，使得基准测试可以使用相对路径可靠地访问包的文件，无论 cargo bench 是从哪里执行的。

选项

基准测试选项

--no-run
只编译，不运行基准测试。
--no-fail-fast
无论是否失败，都运行所有基准测试。没有此标志时，Cargo 会在第一个可执行文件失败后退出。Rust 测试框架将运行可执行文件中的所有基准测试直到完成，此标志仅应用于整个可执行文件。

包选择

默认情况下，如果未指定包选择选项，则选择的包取决于选定的清单文件（如果未给定 --manifest-path，则基于当前工作目录）。如果清单是工作空间的根，则选择工作空间的默认成员；否则，只选择清单定义的包。

工作空间的默认成员可以通过根清单中的 workspace.default-members 键显式设置。如果未设置，虚拟工作空间将包含所有工作空间成员（相当于传递 --workspace），非虚拟工作空间将只包含根 crate 本身。

-p spec…
--package spec…
只对指定的包进行基准测试。有关 SPEC 格式，请参阅cargo-pkgid(1)。此标志可以多次指定，支持常见的 Unix glob 模式，如 *、? 和 []。但是，为避免你的 shell 在 Cargo 处理 glob 模式之前意外展开它们，你必须在每个模式周围使用单引号或双引号。
--workspace
对工作空间中的所有成员进行基准测试。
--all
--workspace 的已弃用别名。
--exclude SPEC…
排除指定的包。必须与 --workspace 标志一起使用。此标志可以多次指定，支持常见的 Unix glob 模式，如 *、? 和 []。但是，为避免你的 shell 在 Cargo 处理 glob 模式之前意外展开它们，你必须在每个模式周围使用单引号或双引号。

目标选择

未给定目标选择选项时，cargo bench 将构建所选包的以下目标：

  • lib — 用于与二进制文件和基准测试链接
  • bins（仅在基准测试目标构建且必需特性可用时）
  • lib 作为基准测试
  • bins 作为基准测试
  • 基准测试目标

可以通过在清单设置中为目标设置 bench 标志来更改默认行为。将 examples 的 bench 设置为 true 将把示例作为基准测试构建和运行，将示例的 main 函数替换为 libtest 框架。

将目标的 bench 设置为 false 将停止默认对它们进行基准测试。按名称选择目标的选项（例如 --example foo）会忽略 bench 标志，并始终对给定目标进行基准测试。

有关每个目标设置的更多信息，请参阅配置目标。

如果选择构建集成测试或基准测试，则会自动构建二进制目标。这允许集成测试执行二进制文件来演练和测试其行为。构建集成测试时会设置 CARGO_BIN_EXE_<name> 环境变量，以便它可以使用 env macro 来定位可执行文件。

传递目标选择标志将仅对指定的目标进行基准测试。

请注意，--bin、--example、--test 和 --bench 标志也支持常见的 Unix glob 模式，如 *、? 和 []。但是，为避免你的 shell 在 Cargo 处理 glob 模式之前意外展开它们，你必须在每个 glob 模式周围使用单引号或双引号。

--lib
对包的库进行基准测试。
--bin 名称…
对指定的二进制文件进行基准测试。此标志可以多次指定，并支持常见的 Unix glob 模式。
--bins
对所有二进制目标进行基准测试。
--example 名称…
对指定的示例进行基准测试。此标志可以多次指定，并支持常见的 Unix glob 模式。
--examples
对所有示例目标进行基准测试。
--test 名称…
对指定的集成测试进行基准测试。此标志可以多次指定，并支持常见的 Unix glob 模式。
--tests
对所有设置了清单标志 test = true 的目标进行基准测试。默认情况下，这包括构建为单元测试的库和二进制文件，以及集成测试。请注意，这也会构建任何必需的依赖项，因此 lib 目标可能会构建两次（一次作为单元测试，一次作为二进制文件、集成测试等的依赖项）。可以通过在目标的清单设置中设置 test 标志来启用或禁用目标。
--bench 名称…
对指定的基准测试进行基准测试。此标志可以多次指定，并支持常见的 Unix glob 模式。
--benches
对所有设置了清单标志 bench = true 的目标进行基准测试。默认情况下，这包括构建为基准测试的库和二进制文件，以及基准测试目标。请注意，这也会构建任何必需的依赖项，因此 lib 目标可能会构建两次（一次作为基准测试，一次作为二进制文件、基准测试等的依赖项）。可以通过在目标的清单设置中设置 bench 标志来启用或禁用目标。
--all-targets
对所有目标进行基准测试。这等同于指定 --lib --bins --tests --benches --examples。

特性选择

特性标志允许你控制启用哪些特性。未给定特性选项时，会为每个选定的包激活 default 特性。

有关更多详细信息，请参阅特性文档。

-F 特性
--features 特性
要激活的特性列表，以空格或逗号分隔。工作空间成员的特性可以使用 package-name/feature-name 语法启用。此标志可以多次指定，这将启用所有指定的特性。
--all-features
激活所有选定包的所有可用特性。
--no-default-features
不激活选定包的 default 特性。

编译选项

--target triple
为给定的体系结构进行基准测试。默认是主机体系结构。triple 的一般格式是 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 查看支持的目标列表。此标志可以多次指定。

也可以通过 build.target 配置值指定此项。

请注意，指定此标志会使 Cargo 在不同的模式下运行，目标工件会放置在单独的目录中。有关更多详细信息，请参阅构建缓存文档。

--profile 名称
使用给定的 profile 进行基准测试。有关 profile 的更多详细信息，请参阅参考资料。
--timings=格式
输出每个编译花费的时间信息，并随时间跟踪并发信息。接受可选的逗号分隔的输出格式列表；不带参数的 --timings 将默认为 --timings=html。指定输出格式（而不是默认格式）是不稳定的，需要 -Zunstable-options。有效的输出格式：

  • html (不稳定，需要 -Zunstable-options)：将人类可读的文件 cargo-timing.html 写入 target/cargo-timings 目录，其中包含编译报告。如果你想查看旧的运行结果，也会在同一目录中写入一个文件名包含时间戳的报告。HTML 输出仅适合人类阅读，不提供机器可读的时序数据。
  • json (不稳定，需要 -Zunstable-options)：输出关于时序信息的机器可读 JSON 数据。

输出选项

--target-dir 目录
所有生成的工件和中间文件的目录。也可以通过 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值指定。默认为工作空间根目录中的 target。

显示选项

默认情况下，Rust 测试框架会隐藏基准测试执行的输出，以保持结果的可读性。可以通过向基准测试二进制文件传递 --nocapture 来恢复基准测试输出（例如，用于调试）。

cargo bench -- --nocapture
-v
--verbose
使用详细输出。可以指定两次以获得“非常详细”的输出，其中包括依赖警告和构建脚本输出等额外信息。也可以通过 term.verbose 配置值指定此项。
-q
--quiet
不打印 cargo 日志消息。也可以通过 term.quiet 配置值指定此项。
--color 何时
控制何时使用彩色输出。有效值：

  • auto (默认)：自动检测终端是否支持彩色输出。
  • always：始终显示彩色输出。
  • never：从不显示彩色输出。

也可以通过 term.color 配置值指定此项。

--message-format 格式
诊断消息的输出格式。可以多次指定，由逗号分隔的值组成。有效值：

  • human (默认)：以人类可读的文本格式显示。与 short 和 json 冲突。
  • short：输出更短的、人类可读的文本消息。与 human 和 json 冲突。
  • json：向 stdout 输出 JSON 消息。有关更多详细信息，请参阅参考资料。与 human 和 short 冲突。
  • json-diagnostic-short：确保 JSON 消息的 rendered 字段包含 rustc 的“短”渲染输出。不能与 human 或 short 一起使用。
  • json-diagnostic-rendered-ansi：确保 JSON 消息的 rendered 字段包含嵌入式 ANSI 颜色代码，以遵循 rustc 的默认配色方案。不能与 human 或 short 一起使用。
  • json-render-diagnostics：指示 Cargo 不将 rustc 诊断信息包含在打印的 JSON 消息中，而是由 Cargo 本身渲染来自 rustc 的 JSON 诊断信息。Cargo 自己的 JSON 诊断信息以及其他来自 rustc 的诊断信息仍然会输出。不能与 human 或 short 一起使用。

清单选项

--manifest-path 路径
Cargo.toml 文件的路径。默认情况下，Cargo 在当前目录或任何父目录中搜索 Cargo.toml 文件。
--ignore-rust-version
忽略包中的 rust-version 规范。
--locked
断言使用的依赖项和版本与现有 Cargo.lock 文件最初生成时完全相同。当出现以下任一情况时，Cargo 将会退出并报错：

  • lock 文件缺失。
  • 由于依赖解析不同，Cargo 尝试更改 lock 文件。

可在需要确定性构建的环境中使用，例如 CI 流水线。

--offline
阻止 Cargo 出于任何原因访问网络。没有此标志时，如果 Cargo 需要访问网络但网络不可用，它将报错停止。有了此标志，如果可能，Cargo 将尝试在没有网络的情况下继续进行。

请注意，这可能会导致与在线模式不同的依赖解析结果。Cargo 会将自身限制在本地下载的 crate 中，即使本地索引副本中可能显示有更新的版本。请参阅 cargo-fetch(1) 命令，以便在离线前下载依赖项。

也可以通过 net.offline 配置值指定此项。

--frozen
等同于同时指定 --locked 和 --offline。
--lockfile-path 路径
将 lock 文件路径从默认路径 (<workspace_root>/Cargo.lock) 更改为 路径。路径必须以 Cargo.lock 结尾（例如 --lockfile-path /tmp/temporary-lockfile/Cargo.lock）。请注意，提供 --lockfile-path 将忽略默认路径下现有的 lock 文件，而是使用 路径 中的 lock 文件，如果不存在则将新的 lock 文件写入提供的 路径。此标志可用于在只读目录中运行大多数命令，将 lock 文件写入提供的 路径。

此选项仅在每夜版本 (nightly channel)上可用，并且需要 -Z unstable-options 标志才能启用（详见 #14421）。

通用选项

+工具链
如果 Cargo 是通过 rustup 安装的，并且 cargo 的第一个参数以 + 开头，则会被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅rustup 文档。
--config KEY=VALUE 或 路径
覆盖 Cargo 配置值。参数应为 TOML 语法 KEY=VALUE，或提供一个额外配置文件的路径。此标志可以多次指定。有关更多信息，请参阅命令行覆盖部分。
-C 路径
在执行任何指定操作之前更改当前工作目录。这会影响 Cargo 默认查找项目清单 (Cargo.toml) 的位置，以及搜索发现 .cargo/config.toml 的目录等。此选项必须出现在命令名称之前，例如 cargo -C path/to/my-project build。

此选项仅在每夜版本 (nightly channel)上可用，并且需要 -Z unstable-options 标志才能启用（详见 #10098）。

-h
--help
打印帮助信息。
-Z 标志
Cargo 的不稳定标志（仅在每夜版本上可用）。运行 cargo -Z help 查看详细信息。

杂项选项

--jobs 参数会影响基准测试可执行文件的构建，但不影响运行基准测试时使用的线程数。Rust 测试框架在单个线程中串行运行基准测试。

-j N
--jobs N
要运行的并行任务数。也可以通过 build.jobs 配置值指定。默认为逻辑 CPU 的数量。如果为负，则将并行任务的最大数量设置为逻辑 CPU 数量加上提供的值。如果提供字符串 default，则将其值设置回默认值。不应为 0。

虽然 cargo bench 涉及编译，但它不提供 --keep-going 标志。使用 --no-fail-fast 可以在不因第一次失败而停止的情况下运行尽可能多的基准测试。要“编译”尽可能多的基准测试，使用 --benches 分别构建基准测试二进制文件。例如：

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

环境变量

有关 Cargo 读取的环境变量的详细信息，请参阅参考资料。

退出状态

  • 0：Cargo 成功执行。
  • 101：Cargo 未能完成。

示例

  1. 构建并执行当前包的所有基准测试

    cargo bench

  2. 在特定基准测试目标中只运行特定的基准测试

    cargo bench --bench bench_name -- modname::some_benchmark

另请参阅

cargo(1), cargo-test(1)