bench: integrate Spark component benchmarks into bench_firo

Author: navidR

.github/workflows/ci-master.yml

@@ -240,6 +240,7 @@ jobs:
         env PKG_CONFIG_PATH="$(realpath depends/$HOST_TRIPLET/lib/pkgconfig):$PKG_CONFIG_PATH" \
         cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=$(realpath depends/$HOST_TRIPLET/toolchain.cmake) \
         -DBUILD_CLI=ON -DBUILD_TESTS=ON -DENABLE_CRASH_HOOKS=ON -DBUILD_GUI=ON \
+        -DBUILD_BENCH=ON -DBUILD_BENCH_SPARK=ON \
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
         $CMAKE_EXTRA_FLAGS \
         -S$(realpath .) -B$(realpath build)
@@ -260,6 +261,7 @@ jobs:
         env PKG_CONFIG_PATH="$(realpath depends/$HOST_TRIPLET/lib/pkgconfig):$PKG_CONFIG_PATH" \
         cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=$(realpath depends/$HOST_TRIPLET/toolchain.cmake) \
         -DBUILD_CLI=ON -DBUILD_TESTS=OFF -DENABLE_CRASH_HOOKS=ON \
+        -DBUILD_BENCH=ON -DBUILD_BENCH_SPARK=ON \
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
         $CMAKE_EXTRA_FLAGS \
         -DBUILD_GUI=ON -S$(realpath .) -B$(realpath build)
@@ -280,6 +282,7 @@ jobs:
         env PKG_CONFIG_PATH="$(pwd)/depends/$HOST_TRIPLET/lib/pkgconfig:$PKG_CONFIG_PATH" \
         cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=$(pwd)/depends/$HOST_TRIPLET/toolchain.cmake \
         -DBUILD_CLI=ON -DBUILD_TESTS=OFF -DENABLE_CRASH_HOOKS=ON -DBUILD_GUI=ON \
+        -DBUILD_BENCH=ON -DBUILD_BENCH_SPARK=ON \
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
         $CMAKE_EXTRA_FLAGS \
         -S$(pwd) -B$(pwd)/build
@@ -297,6 +300,11 @@ jobs:
         set -exo pipefail
         cp -rf build/bin/* build/src/
         qa/pull-tester/rpc-tests.py -extended
+    - name: Run Benchmarks
+      if: matrix.is_linux
+      run: |
+        set -exo pipefail
+        build/bin/bench_firo
     - name: Prepare Files for Artifact
       run: |
         set -exo pipefail

CMakeLists.txt

@@ -283,6 +283,7 @@ if(BUILD_GUI)
 endif()
 
 option(BUILD_BENCH "Build bench_firo executable." OFF)
+option(BUILD_BENCH_SPARK "Build Spark benchmarks into bench_firo." OFF)
 option(BUILD_FUZZ_BINARY "Build fuzz binary." OFF)
 option(BUILD_FOR_FUZZING "Build for fuzzing. Enabling this will disable all other targets and override BUILD_FUZZ_BINARY." OFF)
 
@@ -339,6 +340,7 @@ if(BUILD_FOR_FUZZING)
   set(BUILD_TESTS OFF)
   set(BUILD_GUI_TESTS OFF)
   set(BUILD_BENCH OFF)
+  set(BUILD_BENCH_SPARK OFF)
   set(BUILD_FUZZ_BINARY ON)
 
   target_compile_definitions(core_interface INTERFACE
@@ -853,7 +855,7 @@ if(DEFINED ENV{LDFLAGS})
   deduplicate_flags(CMAKE_EXE_LINKER_FLAGS)
 endif()
 
-if(BUILD_TESTS)
+if(BUILD_TESTS OR BUILD_BENCH)
   enable_testing()
 endif()
 
@@ -956,6 +958,7 @@ message("Tests:")
 message("  test_firo ........................ ${BUILD_TESTS}")
 message("  test_firo-qt ..................... ${BUILD_GUI_TESTS}")
 message("  bench_firo ....................... ${BUILD_BENCH}")
+message("  Spark benchmarks ................. ${BUILD_BENCH_SPARK}")
 message("  fuzz binary ......................... ${BUILD_FUZZ_BINARY}")
 message("")
 if(CMAKE_CROSSCOMPILING)
@@ -1006,4 +1009,4 @@ if(WIN32 AND MINGW AND STATIC_BUILD)
         # Ensure we link against static versions of system libraries
         set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,-Bstatic")
     endif()
-endif()
+endif()

cmake/script/GenerateHeaderFromRaw.cmake

@@ -11,6 +11,9 @@ string(REGEX REPLACE "[^\n][^\n]" "std::byte{0x\\0}, " formatted_bytes "${format
 string(LENGTH "${hex_content}" content_length)
 math(EXPR array_size "${content_length} / 2")
 
+cmake_path(GET HEADER_PATH PARENT_PATH header_dir)
+file(MAKE_DIRECTORY "${header_dir}")
+
 set(header_content
 "#include <array>
 #include <cstddef>

cmake/utilities.cmake

@@ -4,12 +4,17 @@
 
 function(apply_wrapped_exception_flags target_name)
   if(ENABLE_CRASH_HOOKS AND CRASH_HOOKS_WRAPPED_CXX_ABI)
-    # We need to wrap exceptions to catch them in the crash handler
-    # We need to pass both compile flags and link flags to ensure that the wrapped exceptions are used in all cases
-    target_compile_options(${target_name} PRIVATE ${LDFLAGS_WRAP_EXCEPTIONS})
-    # Apple linker does not support -Wl,--wrap=
+    get_target_property(target_type ${target_name} TYPE)
+    if(target_type STREQUAL "STATIC_LIBRARY")
+      set(wrap_scope INTERFACE)
+    else()
+      set(wrap_scope PRIVATE)
+    endif()
+
+    # The wrappers are resolved by the final executable link step. Static
+    # libraries therefore propagate the requirement to their consumers.
     if(NOT APPLE)
-      target_link_options(${target_name} PRIVATE ${LDFLAGS_WRAP_EXCEPTIONS})
+      target_link_options(${target_name} ${wrap_scope} ${LDFLAGS_WRAP_EXCEPTIONS})
     endif()
   endif()
 endfunction()

src/CMakeLists.txt

@@ -71,6 +71,7 @@ target_link_libraries(bitcoin_util
     bitcoin_crypto
     Boost::thread
     Boost::chrono
+    Boost::program_options
     univalue
     secp256k1
     leveldb

src/bench/CMakeLists.txt

@@ -47,87 +47,12 @@ install(TARGETS bench_firo
   RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
 )
 
-# Spark/Lelantus benchmarking framework
-option(BUILD_BENCH_SPARK "Build Spark/Lelantus benchmarks" OFF)
-
 if(BUILD_BENCH_SPARK)
-  message(STATUS "Building Spark benchmarks")
-  
-  # Generic benchmarking framework library
-  add_library(firo_benchmark STATIC
-    ${CMAKE_CURRENT_SOURCE_DIR}/benchmark.cpp
-  )
-  
-  target_include_directories(firo_benchmark PUBLIC
-    ${CMAKE_CURRENT_SOURCE_DIR}
-  )
-  
-  # Optional: Enable Linux perf counters (requires explicit opt-in)
-  option(ENABLE_BENCH_PERF_COUNTERS "Enable Linux perf counters in benchmarks (Linux only)" OFF)
-  
-  if(ENABLE_BENCH_PERF_COUNTERS)
-    if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
-      target_compile_definitions(firo_benchmark PUBLIC BENCH_PERF_COUNTERS)
-      message(STATUS "  Linux perf counters: ENABLED")
-    else()
-      message(WARNING "  ENABLE_BENCH_PERF_COUNTERS is only supported on Linux, ignoring")
-    endif()
-  else()
-    message(STATUS "  Linux perf counters: DISABLED (use -DENABLE_BENCH_PERF_COUNTERS=ON to enable)")
-  endif()
-  
-  # Grootle proof benchmarks
-  add_executable(bench_spark_grootle
-    ${CMAKE_CURRENT_SOURCE_DIR}/spark_grootle.cpp
-  )
-  
-  target_link_libraries(bench_spark_grootle
-    firo_benchmark
-    firo_node
-    Boost::filesystem
-    secp256k1pp
-  )
-  
-  # BPPlus (Bulletproofs+) benchmarks
-  add_executable(bench_spark_bpplus
-    ${CMAKE_CURRENT_SOURCE_DIR}/spark_bpplus.cpp
-  )
-  
-  target_link_libraries(bench_spark_bpplus
-    firo_benchmark
-    firo_node
-    Boost::filesystem
-    secp256k1pp
-  )
-  
-  # Chaum proof benchmarks
-  add_executable(bench_spark_chaum
-    ${CMAKE_CURRENT_SOURCE_DIR}/spark_chaum.cpp
-  )
-  
-  target_link_libraries(bench_spark_chaum
-    firo_benchmark
-    firo_node
-    Boost::filesystem
-    secp256k1pp
-  )
-  
-  # Schnorr signature benchmarks
-  add_executable(bench_spark_schnorr
-    ${CMAKE_CURRENT_SOURCE_DIR}/spark_schnorr.cpp
-  )
-  
-  target_link_libraries(bench_spark_schnorr
-    firo_benchmark
-    firo_node
-    Boost::filesystem
-    secp256k1pp
-  )
-  
-  # Install benchmark executables
-  install(TARGETS bench_spark_grootle bench_spark_bpplus bench_spark_chaum bench_spark_schnorr
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+  target_sources(bench_firo
+    PRIVATE
+      ${CMAKE_CURRENT_SOURCE_DIR}/spark_bpplus.cpp
+      ${CMAKE_CURRENT_SOURCE_DIR}/spark_chaum.cpp
+      ${CMAKE_CURRENT_SOURCE_DIR}/spark_grootle.cpp
+      ${CMAKE_CURRENT_SOURCE_DIR}/spark_schnorr.cpp
   )
-  
-  message(STATUS "  Benchmarks: bench_spark_grootle, bench_spark_bpplus, bench_spark_chaum, bench_spark_schnorr")
 endif()

src/bench/bench_bitcoin.cpp

@@ -4,11 +4,15 @@
 
 #include "bench.h"
 
+#include "chainparams.h"
 #include "key.h"
+#include "pubkey.h"
 #include "stacktraces.h"
 #include "validation.h"
 #include "util.h"
 
+#include <string>
+
 int
 main(int argc, char** argv)
 {
@@ -17,10 +21,22 @@ main(int argc, char** argv)
     RegisterPrettyTerminateHander();
 #endif
     ECC_Start();
-    SetupEnvironment();
-    fPrintToDebugLog = false; // don't want to write to debug.log file
+    {
+        ECCVerifyHandle globalVerifyHandle;
+
+        SetupEnvironment();
+        SelectParams(CBaseChainParams::MAIN);
+        fPrintToDebugLog = false; // don't want to write to debug.log file
+
+        double elapsed_time_for_one = 1.0;
+        for (int i = 1; i < argc; ++i) {
+            if (std::string(argv[i]) == "-sanity-check") {
+                elapsed_time_for_one = 0.001;
+            }
+        }
 
-    benchmark::BenchRunner::RunAll();
+        benchmark::BenchRunner::RunAll(elapsed_time_for_one);
+    }
 
     ECC_Stop();
 }