feat: add instrument-hooks library

Author: not-matthias

.github/workflows/ci.yml

@@ -20,6 +20,8 @@ jobs:
     steps: 
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          submodules: "recursive"
 
       - name: Cache build
         uses: actions/cache@v3
@@ -62,6 +64,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          submodules: "recursive"
 
       - name: Cache build
         uses: actions/cache@v3
@@ -81,6 +85,8 @@ jobs:
       - name: Run the benchmarks
         uses: CodSpeedHQ/action@main
         if: matrix.codspeed-mode != 'off'
+        env:
+          CODSPEED_PERF_ENABLED: true
         with:
           run: examples/google_benchmark_cmake/build/benchmark_example
           token: ${{ secrets.CODSPEED_TOKEN }}
@@ -98,6 +104,8 @@ jobs:
     runs-on: ${{ matrix.runner }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
 
       - name: Set up Bazel
         uses: bazel-contrib/setup-bazel@0.14.0
@@ -116,6 +124,8 @@ jobs:
       - name: Run the benchmarks
         uses: CodSpeedHQ/action@main
         if: matrix.codspeed-mode != 'off'
+        env:
+          CODSPEED_PERF_ENABLED: true
         with:
           run: bazel run //examples/google_benchmark_bazel:my_benchmark --//core:codspeed_mode=${{ matrix.codspeed-mode }}
           token: ${{ secrets.CODSPEED_TOKEN }}
@@ -128,6 +138,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          submodules: "recursive"
 
       - name: Cache build
         uses: actions/cache@v3
@@ -156,6 +168,8 @@ jobs:
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
 
       - name: Set up Bazel
         uses: bazel-contrib/setup-bazel@0.14.0

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "core/instrument-hooks"]
+	path = core/instrument-hooks
+	url = https://github.com/CodSpeedHQ/instrument-hooks

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
-exclude: '^(google_benchmark/.*|core/instrument-hooks/.*|.*/build/.*|build/.*|core/include/valgrind\.h|core/include/callgrind\.h)'
+exclude: '^(google_benchmark/.*|.*/build/.*|build/.*|core/include/valgrind\.h|core/include/callgrind\.h)'
 files: ^(core|examples)/.*$
 
 repos:

MODULE.bazel

@@ -1 +1,8 @@
 bazel_dep(name = "rules_cc", version = "0.0.17")
+bazel_dep(name = "instrument_hooks", version = "1.0.0")
+
+git_override(
+    module_name = "instrument_hooks",
+    commit = "42ed74076c697c2f06c5ac81a84ccee983d7f140",
+    remote = "https://github.com/CodSpeedHQ/instrument-hooks",
+)

core/BUILD

@@ -8,6 +8,33 @@ config_setting(
     constraint_values = ["@platforms//os:windows"],
 )
 
+# Instrument-hooks library with warning suppressions
+cc_library(
+    name = "instrument_hooks",
+    srcs = ["instrument-hooks/dist/core.c"],
+    hdrs = glob(["instrument-hooks/includes/*.h"]),
+    includes = ["instrument-hooks/includes"],
+    copts = select({
+        ":windows": [
+            "/wd4101",  # unreferenced local variable (equivalent to -Wno-unused-variable)
+            "/wd4189",  # local variable is initialized but not referenced (equivalent to -Wno-unused-but-set-variable)
+            "/wd4100",  # unreferenced formal parameter (equivalent to -Wno-unused-parameter)
+            "/wd4245",  # signed/unsigned mismatch
+            "/wd4132",  # const object should be initialized
+            "/wd4146",  # unary minus operator applied to unsigned type
+        ],
+        "//conditions:default": [
+            "-Wno-maybe-uninitialized",
+            "-Wno-unused-variable",
+            "-Wno-unused-parameter",
+            "-Wno-unused-but-set-variable",
+            "-Wno-type-limits",
+        ],
+    }),
+    visibility = ["//visibility:public"],
+)
+
+
 # Define the codspeed library
 cc_library(
     name = "codspeed",
@@ -25,6 +52,7 @@ cc_library(
         ":walltime_mode": ["CODSPEED_ENABLED", "CODSPEED_WALLTIME"],
         "//conditions:default": [],
     }),
+    deps = [":instrument_hooks"],
     visibility = ["//visibility:public"],
 )
 

core/CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.10)
 
 set(CODSPEED_VERSION 1.2.0)
 
-project(codspeed VERSION ${CODSPEED_VERSION} LANGUAGES CXX)
+project(codspeed VERSION ${CODSPEED_VERSION} LANGUAGES CXX C)
 
 # Specify the C++ standard
 set(CMAKE_CXX_STANDARD 17)
@@ -11,7 +11,46 @@ set(CMAKE_CXX_STANDARD_REQUIRED True)
 # Add the include directory
 include_directories(include)
 
-# Add the library
+# Add the instrument_hooks library
+add_library(
+    instrument_hooks
+    STATIC
+    instrument-hooks/dist/core.c
+)
+
+target_include_directories(
+    instrument_hooks
+    PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/instrument-hooks/includes>
+    $<INSTALL_INTERFACE:includes>
+)
+
+# Suppress warnings for the instrument_hooks library
+if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+    target_compile_options(
+        instrument_hooks
+        PRIVATE
+        -Wno-maybe-uninitialized
+        -Wno-unused-variable
+        -Wno-unused-parameter
+        -Wno-unused-but-set-variable
+        -Wno-type-limits
+    )
+elseif(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
+    target_compile_options(
+        instrument_hooks
+        PRIVATE
+        /wd4101  # unreferenced local variable (equivalent to -Wno-unused-variable)
+        /wd4189  # local variable is initialized but not referenced (equivalent to -Wno-unused-but-set-variable)
+        /wd4100  # unreferenced formal parameter (equivalent to -Wno-unused-parameter)
+        /wd4245  # signed/unsigned mismatch
+        /wd4132  # const object should be initialized
+        /wd4146  # unary minus operator applied to unsigned type
+    )
+endif()
+
+
+# Add the main library
 add_library(
     codspeed
     src/codspeed.cpp
@@ -20,13 +59,17 @@ add_library(
     src/workspace.cpp
 )
 
+# Link instrument_hooks to codspeed
+target_link_libraries(codspeed PRIVATE instrument_hooks)
+
 # Version
 add_compile_definitions(CODSPEED_VERSION="${CODSPEED_VERSION}")
 
 # Specify the include directories for users of the library
 target_include_directories(
     codspeed
     PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+           $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/instrument-hooks/includes>
 )
 
 # Disable valgrind compilation errors
@@ -116,7 +159,7 @@ install(
 )
 
 install(
-    TARGETS codspeed
+    TARGETS codspeed instrument_hooks
     EXPORT codspeed-targets
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
     ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}

core/include/measurement.hpp

@@ -2,11 +2,28 @@
 #define MEASUREMENT_H
 
 #include <string>
+#ifdef _WIN32
+#include <process.h>
+#else
+#include <unistd.h>
+#endif
 
 #ifdef CODSPEED_INSTRUMENTATION
 #include "callgrind.h"
 #endif
 
+extern "C" {
+#include "core.h"
+}
+
+static InstrumentHooks* g_hooks = nullptr;
+
+inline void measurement_init() {
+  if (!g_hooks) {
+    g_hooks = instrument_hooks_init();
+  }
+}
+
 inline std::string get_version() {
 #ifdef CODSPEED_VERSION
   return {CODSPEED_VERSION};
@@ -16,29 +33,41 @@ inline std::string get_version() {
 }
 
 #ifdef CODSPEED_INSTRUMENTATION
-inline bool measurement_is_instrumented() { return RUNNING_ON_VALGRIND; }
+inline bool measurement_is_instrumented() {
+  return instrument_hooks_is_instrumented(g_hooks);
+}
 
 inline void measurement_set_metadata() {
-  std::string metadata = "Metadata: codspeed-cpp " + get_version();
-  CALLGRIND_DUMP_STATS_AT(metadata.c_str());
+  std::string version = get_version();
+  instrument_hooks_set_integration(g_hooks, "codspeed-cpp", version.c_str());
 }
 
 __attribute__((always_inline)) inline void measurement_start() {
-  CALLGRIND_ZERO_STATS;
-  CALLGRIND_START_INSTRUMENTATION;
+  instrument_hooks_start_benchmark_inline(g_hooks);
+}
+
+__attribute__((always_inline)) inline void measurement_stop() {
+  instrument_hooks_stop_benchmark_inline(g_hooks);
 }
 
-__attribute__((always_inline)) inline void measurement_stop(
-    const std::string &name) {
-  CALLGRIND_STOP_INSTRUMENTATION;
-  CALLGRIND_DUMP_STATS_AT(name.c_str());
-};
+__attribute__((always_inline)) inline void measurement_executed_benchmark(
+    const std::string& name) {
+#ifdef _WIN32
+  auto current_pid = _getpid();
+#else
+  auto current_pid = getpid();
+#endif
+  instrument_hooks_executed_benchmark(g_hooks, current_pid, name.c_str());
+}
 #else
 // Stub implementations for non-instrumentation builds
 inline bool measurement_is_instrumented() { return false; }
 inline void measurement_set_metadata() {}
 inline void measurement_start() {}
-inline void measurement_stop(const std::string &name) { (void)name; }
+inline void measurement_stop() {}
+inline void measurement_executed_benchmark(const std::string& name) {
+  (void)name;
+}
 #endif
 
 #endif  // MEASUREMENT_H

core/instrument-hooks

@@ -55,6 +55,7 @@ CodSpeed::CodSpeed() : is_instrumented(measurement_is_instrumented()) {
            "be made since it's running in an unknown environment."
         << std::endl;
   }
+  measurement_init();
   measurement_set_metadata();
 }
 
@@ -85,7 +86,8 @@ void CodSpeed::start_benchmark(const std::string &name) {
 }
 
 void CodSpeed::end_benchmark() {
-  measurement_stop(current_benchmark);
+  measurement_executed_benchmark(current_benchmark);
+
   benchmarked.push_back(current_benchmark);
   std::string action_str = is_instrumented ? "Measured" : "Checked";
   std::string group_str =

core/src/codspeed.cpp

@@ -1065,6 +1065,8 @@ struct State::StateIterator {
   bool operator!=(StateIterator const&) const {
     if (BENCHMARK_BUILTIN_EXPECT(cached_ != 0, true)) return true;
 #ifdef CODSPEED_INSTRUMENTATION
+    measurement_stop();
+
     if (parent_->codspeed_ != NULL) {
       parent_->codspeed_->end_benchmark();
     }
@@ -1086,8 +1088,9 @@ inline BENCHMARK_ALWAYS_INLINE State::StateIterator State::end() {
 #ifdef CODSPEED_INSTRUMENTATION
   if (this->codspeed_ != NULL) {
     this->codspeed_->start_benchmark(name_);
-    measurement_start();
   }
+
+  measurement_start();
 #endif
   return StateIterator();
 }