基准测试

一个用于对代码片段进行基准测试的库，类似于单元测试。示例：

#include <benchmark/benchmark.h>

static void BM_SomeFunction(benchmark::State& state) {
  // 在此处执行设置
  for (auto _ : state) {
    // 这段代码将被计时
    SomeFunction();
  }
}
// 将函数注册为基准测试
BENCHMARK(BM_SomeFunction);
// 运行基准测试
BENCHMARK_MAIN();

入门

要开始使用，请查看要求和安装。有关完整示例，请参阅用法，更全面的功能概述请参阅用户指南。

阅读Google Test文档可能也会有所帮助，因为API的一些结构方面是相似的。

资源

讨论组

IRC频道：

libera #benchmark

附加工具文档

汇编测试文档

构建和安装Python绑定

要求

该库可以与C++03一起使用。但是，它需要C++14才能构建，包括编译器和标准库支持。

有关支持的编译器和标准的更多详细信息，请参阅dependencies.md。

如果您需要支持特定的编译器，我们非常欢迎补丁。

请参阅特定平台构建说明。

安装

这里描述的是使用cmake的安装过程。作为前提条件，您需要安装git和cmake。

有关支持的构建工具版本的更多详细信息，请参阅dependencies.md。

# 检出库
$ git clone https://github.com/google/benchmark.git
# 进入库的根目录
$ cd benchmark
# 创建一个构建目录来存放构建输出
$ cmake -E make_directory "build"
# 使用cmake生成构建系统文件，并下载任何依赖项
$ cmake -E chdir "build" cmake -DBENCHMARK_DOWNLOAD_DEPENDENCIES=on -DCMAKE_BUILD_TYPE=Release ../
# 或者，从CMake 3.13开始，使用更简单的形式：
# cmake -DCMAKE_BUILD_TYPE=Release -S . -B "build"
# 构建库
$ cmake --build "build" --config Release

这将构建benchmark和benchmark_main库以及测试。在Unix系统上，构建目录现在应该看起来像这样：

/benchmark
  /build
    /src
      /libbenchmark.a
      /libbenchmark_main.a
    /test
      ...

接下来，您可以运行测试来检查构建。

$ cmake -E chdir "build" ctest --build-config Release

如果您想全局安装库，还需运行：

sudo cmake --build "build" --config Release --target install

请注意，Google Benchmark需要Google Test来构建和运行测试。这个依赖可以通过两种方式提供：

将Google Test源代码检出到benchmark/googletest。
否则，如果在配置过程中指定了-DBENCHMARK_DOWNLOAD_DEPENDENCIES=ON（如上所示），库将自动下载并构建任何所需的依赖项。

如果您不想构建和运行测试，请在CMAKE_ARGS中添加-DBENCHMARK_ENABLE_GTEST_TESTS=OFF。

调试与发布

默认情况下，benchmark构建为调试库。当出现这种情况时，您会在输出中看到警告。要将其构建为发布库，请在生成构建系统文件时添加-DCMAKE_BUILD_TYPE=Release，如上所示。在构建命令中使用--config Release是为了正确支持多配置工具（例如Visual Studio），对于其他构建系统（如Makefile）可以跳过。

要启用链接时优化，在生成构建系统文件时还需添加-DBENCHMARK_ENABLE_LTO=true。

如果您使用的是gcc，如果自动检测失败，您可能需要设置GCC_AR和GCC_RANLIB cmake缓存变量。

如果您使用的是clang，您可能需要设置LLVMAR_EXECUTABLE、LLVMNM_EXECUTABLE和LLVMRANLIB_EXECUTABLE cmake缓存变量。

要启用sanitizer检查（例如，asan和tsan），请添加：

 -DCMAKE_C_FLAGS="-g -O2 -fno-omit-frame-pointer -fsanitize=address -fsanitize=thread -fno-sanitize-recover=all"
 -DCMAKE_CXX_FLAGS="-g -O2 -fno-omit-frame-pointer -fsanitize=address -fsanitize=thread -fno-sanitize-recover=all "

稳定和实验性库版本

主分支包含基准测试库的最新稳定版本；其API可以被认为是基本稳定的，只有在发布新的主要版本时才会进行源代码破坏性更改。

更新的、实验性的功能在v2分支上实现和测试。我们鼓励希望使用、测试新功能并提供反馈的用户尝试这个分支。但是，这个分支不提供稳定性保证，并保留随时更改和破坏API的权利。

用法

基本用法

定义一个执行要测量代码的函数，使用BENCHMARK宏将其注册为基准测试函数，并确保有一个适当的main函数可用：

#include <benchmark/benchmark.h>

static void BM_StringCreation(benchmark::State& state) {
  for (auto _ : state)
    std::string empty_string;
}
// 将函数注册为基准测试
BENCHMARK(BM_StringCreation);

// 定义另一个基准测试
static void BM_StringCopy(benchmark::State& state) {
  std::string x = "hello";
  for (auto _ : state)
    std::string copy(x);
}
BENCHMARK(BM_StringCopy);

BENCHMARK_MAIN();

要运行基准测试，请编译并链接到benchmark库（libbenchmark.a/.so）。如果您按照上面的构建步骤进行操作，这个库将位于您创建的构建目录下。

# Linux上的示例，在运行上述构建步骤后。假设`benchmark`和`build`目录位于当前目录下。
$ g++ mybenchmark.cc -std=c++11 -isystem benchmark/include \
  -Lbenchmark/build/src -lbenchmark -lpthread -o mybenchmark

或者，链接到benchmark_main库并删除上面的BENCHMARK_MAIN();以获得相同的行为。

编译后的可执行文件默认会运行所有基准测试。传递--help标志以获取选项信息，或查看用户指南。

与CMake一起使用

如果使用CMake，建议使用target_link_libraries链接到项目提供的benchmark::benchmark和benchmark::benchmark_main目标。可以使用find_package导入已安装版本的库。

find_package(benchmark REQUIRED)

或者，add_subdirectory将直接将库合并到CMake项目中。

add_subdirectory(benchmark)

无论哪种方式，都按如下方式链接到库。

target_link_libraries(MyTarget benchmark::benchmark)