build: add benchmark build scaffolding by timothyw553 · Pull Request #825 · apache/iceberg-cpp

timothyw553 · 2026-07-08T22:10:19Z

Summary

Adds an opt-in benchmark build path so future C++ microbenchmarks can live in-tree without affecting normal builds. Benchmarks stay disabled by default, and this PR keeps the executable intentionally small so reviewers can focus on CMake/Meson wiring and Google Benchmark integration.

Adds ICEBERG_BUILD_BENCHMARKS for CMake and a disabled-by-default benchmarks Meson feature.
Wires src/iceberg/benchmark into both build systems.
Adds Google Benchmark dependency setup for CMake and Meson.
Adds a tiny smoke benchmark so the new target is buildable in isolation.

Part of #690.

Stack

This is PR 1 of 2.

PR 2 adds the actual metrics evaluator benchmark cases on top of this scaffolding: timothyw553#1.

Test Plan

Configured benchmark-enabled CMake build with -DICEBERG_BUILD_BENCHMARKS=ON.
Built metrics_evaluator_benchmark on this branch.
Ran the smoke benchmark with --benchmark_min_time=0.01s.
Re-ran the default build and test suite on the top of the stack: 18/18 tests passed.
Meson wiring is syntax-reviewed but not locally executed because meson is not installed in this shell.

Verification Commands

cmake -S . -B build-bench-stack -G Ninja \
  -DFETCHCONTENT_TRY_FIND_PACKAGE_MODE=NEVER \
  -DCMAKE_IGNORE_PREFIX_PATH=/opt/homebrew/anaconda3 \
  -DCMAKE_PREFIX_PATH='/opt/homebrew/opt/snappy;/opt/homebrew/opt/zstd' \
  -DICEBERG_BUILD_BENCHMARKS=ON
cmake --build build-bench-stack --target metrics_evaluator_benchmark
build-bench-stack/src/iceberg/benchmark/metrics_evaluator_benchmark --benchmark_min_time=0.01s
cmake --build build
ctest --test-dir build --output-on-failure

zhjwpku · 2026-07-09T14:28:44Z

+
+fetchcontent_declare(google_benchmark
+                     GIT_REPOSITORY https://github.com/google/benchmark.git
+                     GIT_TAG v1.8.4


nit: should we use the commit SHA like gtest?

done. I pinned Google Benchmark to the v1.8.4 release commit SHA (a4cf155615c63e019ae549e31703bf367df5b471) and kept the version as an inline comment, matching the gtest style.

wgtmac

Thanks for adding this! I just left some comments.

wgtmac · 2026-07-11T06:56:28Z

+namespace iceberg {
+namespace {
+
+void BM_BenchmarkSmoke(benchmark::State& state) {


nit: the file name looks odd since it's unrelated to metrics evaluator.

renamed the smoke benchmark so it isn't tied to metrics evaluator yet.

wgtmac · 2026-07-11T07:03:57Z

+    OFF
+    CACHE BOOL "" FORCE)
+
+fetchcontent_declare(google_benchmark


Should we move this to IcebergThirdpartyToolchain.cmake? I think we should move GTest to there, too.

I think this PR follows the gtest way ;) Maybe we can change that together, I have the same feeling at the first look.

opened #829 to track moving both GTest and Google Benchmark into IcebergThirdpartyToolchain.cmake. I’ll keep this PR scoped and follow the current GTest pattern here.

wgtmac · 2026-07-11T07:11:13Z

            -DCMAKE_C_COMPILER_LAUNCHER=sccache \
            -DCMAKE_CXX_COMPILER_LAUNCHER=sccache \
            -DICEBERG_BUILD_SQL_CATALOG=ON \
+            -DICEBERG_BUILD_BENCHMARKS=ON \


Why do we need this but do not change other workflows?

this is just so the benchmarks get linted. I previously did not have this and cpp-linter failed because the benchmark source wasn’t in compile_commands.json.

Fair enough. Let's keep it for now.

wgtmac · 2026-07-11T07:12:32Z

+                     CONFIG)
+fetchcontent_makeavailable(google_benchmark)
+
+add_executable(metrics_evaluator_benchmark metrics_evaluator_benchmark.cc)


Should we add EXCLUDE_FROM_ALL so it does not build by default?

ah I don’t think we need it. I set benchmarks to be off by default (see my CMakeLists.txt change), and when users set ICEBERG_BUILD_BENCHMARKS=ON, the benchmark target should build normally.

hmm... if we did add EXCLUDE_FROM_ALL then users would have to do

cmake --build build --target benchmark_a benchmark_b benchmark_c benchmark_d

to me a better pattern seems to be:

cmake -S . -B build -DICEBERG_BUILD_BENCHMARKS=ON cmake --build build

and if user did want to just build specific targets then they can still do:

cmake --build build --target metrics_evaluator_benchmark

what do you think?

Sounds good!

wgtmac · 2026-07-12T01:38:00Z

            -DCMAKE_C_COMPILER_LAUNCHER=sccache \
            -DCMAKE_CXX_COMPILER_LAUNCHER=sccache \
            -DICEBERG_BUILD_SQL_CATALOG=ON \
+            -DICEBERG_BUILD_BENCHMARKS=ON \


Fair enough. Let's keep it for now.

timothyw553 mentioned this pull request Jul 8, 2026

benchmark: add metrics evaluator benchmark timothyw553/iceberg-cpp#1

Closed

4 tasks

timothyw553 force-pushed the tw/benchmark-infra branch 2 times, most recently from e922f8f to 0717dac Compare July 8, 2026 22:34

zhjwpku approved these changes Jul 9, 2026

View reviewed changes

timothyw553 force-pushed the tw/benchmark-infra branch from 0717dac to b45e7ea Compare July 10, 2026 21:19

wgtmac reviewed Jul 11, 2026

View reviewed changes

build: add benchmark build scaffolding

22aa193

timothyw553 force-pushed the tw/benchmark-infra branch from b45e7ea to 22aa193 Compare July 12, 2026 00:08

timothyw553 mentioned this pull request Jul 12, 2026

Move GTest and Google Benchmark setup into IcebergThirdpartyToolchain #829

Open

timothyw553 requested a review from wgtmac July 12, 2026 00:55

wgtmac approved these changes Jul 12, 2026

View reviewed changes

wgtmac merged commit 263795e into apache:main Jul 12, 2026
22 checks passed

Uh oh!

Conversation

timothyw553 commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Stack

Test Plan

Verification Commands

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timothyw553 Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wgtmac left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timothyw553 Jul 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timothyw553 Jul 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timothyw553 Jul 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

timothyw553 commented Jul 8, 2026 •

edited

Loading

timothyw553 Jul 10, 2026 •

edited

Loading

timothyw553 Jul 12, 2026 •

edited

Loading

timothyw553 Jul 12, 2026 •

edited

Loading

timothyw553 Jul 12, 2026 •

edited

Loading