feat: add instrument-hooks native module

Author: not-matthias

.github/workflows/ci.yml

@@ -15,6 +15,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - name: Set up Python 3.11
         uses: actions/setup-python@v5
         with:
@@ -44,6 +46,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - uses: astral-sh/setup-uv@v4
         with:
           version: "0.5.20"

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "tests/benchmarks/TheAlgorithms"]
 	path = tests/benchmarks/TheAlgorithms
 	url = git@github.com:TheAlgorithms/Python.git
+[submodule "src/pytest_codspeed/instruments/hooks/instrument-hooks"]
+	path = src/pytest_codspeed/instruments/hooks/instrument-hooks
+	url = https://github.com/CodSpeedHQ/instrument-hooks

setup.py

@@ -5,9 +5,7 @@
 
 from setuptools import setup
 
-build_path = (
-    Path(__file__).parent / "src/pytest_codspeed/instruments/valgrind/_wrapper/build.py"
-)
+build_path = Path(__file__).parent / "src/pytest_codspeed/instruments/hooks/build.py"
 
 spec = importlib.util.spec_from_file_location("build", build_path)
 assert spec is not None, "The spec should be initialized"
@@ -52,8 +50,8 @@
 setup(
     package_data={
         "pytest_codspeed": [
-            "instruments/valgrind/_wrapper/*.h",
-            "instruments/valgrind/_wrapper/*.c",
+            "instruments/hooks/instrument-hooks/includes/*.h",
+            "instruments/hooks/instrument-hooks/dist/*.c",
         ]
     },
     ext_modules=(

src/pytest_codspeed/instruments/hooks/__init__.py

@@ -0,0 +1,83 @@
+from __future__ import annotations
+
+import os
+import sys
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .dist_instrument_hooks import lib as LibType
+
+SUPPORTS_PERF_TRAMPOLINE = sys.version_info >= (3, 12)
+
+
+class InstrumentHooks:
+    """Zig library wrapper class providing benchmark measurement functionality."""
+
+    lib: LibType
+    instance: int
+
+    def __init__(self) -> None:
+        if os.environ.get("CODSPEED_ENV") is None:
+            raise RuntimeError(
+                "Can't run benchmarks outside of CodSpeed environment."
+                "Please set the CODSPEED_ENV environment variable."
+            )
+
+        try:
+            from .dist_instrument_hooks import lib  # type: ignore
+        except ImportError as e:
+            raise RuntimeError(f"Failed to load instrument hooks library: {e}") from e
+
+        instance = lib.instrument_hooks_init()
+        if instance == 0:
+            raise RuntimeError("Failed to initialize CodSpeed instrumentation library.")
+
+        if SUPPORTS_PERF_TRAMPOLINE:
+            sys.activate_stack_trampoline("perf")  # type: ignore
+
+        self.lib = lib
+        self.instance = instance
+
+    def __del__(self):
+        if hasattr(self, "lib") and hasattr(self, "instance"):
+            self.lib.instrument_hooks_deinit(self.instance)
+
+    def start_benchmark(self) -> None:
+        """Start a new benchmark measurement."""
+        ret = self.lib.instrument_hooks_start_benchmark(self.instance)
+        if ret != 0:
+            raise RuntimeError("Failed to start benchmark measurement")
+
+    def stop_benchmark(self) -> None:
+        """Stop the current benchmark measurement."""
+        ret = self.lib.instrument_hooks_stop_benchmark(self.instance)
+        if ret != 0:
+            raise RuntimeError("Failed to stop benchmark measurement")
+
+    def set_executed_benchmark(self, uri: str, pid: int | None = None) -> None:
+        """Set the executed benchmark URI and process ID.
+
+        Args:
+            uri: The benchmark URI string identifier
+            pid: Optional process ID (defaults to current process)
+        """
+        if pid is None:
+            pid = os.getpid()
+
+        ret = self.lib.instrument_hooks_executed_benchmark(
+            self.instance, pid, uri.encode("ascii")
+        )
+        if ret != 0:
+            raise RuntimeError("Failed to set executed benchmark")
+
+    def set_integration(self, name: str, version: str) -> None:
+        """Set the integration name and version."""
+        ret = self.lib.instrument_hooks_set_integration(
+            self.instance, name.encode("ascii"), version.encode("ascii")
+        )
+        if ret != 0:
+            raise RuntimeError("Failed to set integration name and version")
+
+    def is_instrumented(self) -> bool:
+        """Check if instrumentation is active."""
+        return self.lib.instrument_hooks_is_instrumented(self.instance)

src/pytest_codspeed/instruments/hooks/build.py

@@ -0,0 +1,26 @@
+from pathlib import Path
+
+from cffi import FFI  # type: ignore
+
+ffibuilder = FFI()
+
+includes_dir = Path(__file__).parent.joinpath("instrument-hooks/includes")
+header_text = (includes_dir / "core.h").read_text()
+filtered_header = "\n".join(
+    line for line in header_text.splitlines() if not line.strip().startswith("#")
+)
+ffibuilder.cdef(filtered_header)
+
+ffibuilder.set_source(
+    "pytest_codspeed.instruments.hooks.dist_instrument_hooks",
+    """
+    #include "core.h"
+    """,
+    sources=[
+        "src/pytest_codspeed/instruments/hooks/instrument-hooks/dist/core.c",
+    ],
+    include_dirs=[str(includes_dir)],
+)
+
+if __name__ == "__main__":
+    ffibuilder.compile(verbose=True)