fix(codspeed): replace bindgen with manual bindings

Author: not-matthias

.github/workflows/ci.yml

@@ -21,6 +21,19 @@ jobs:
         with:
           extra_args: --all-files
 
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: bindgen-cli@0.72.1
+      - name: Check if bindings are up-to-date
+        working-directory: crates/codspeed/src/instrument_hooks
+        run: |
+          ./update-bindings.sh
+
+          if ! git diff --exit-code bindings.rs; then
+            echo "Error: FFI bindings are out of date!"
+            exit 1
+          fi
+
   test-codspeed:
     strategy:
       matrix:

Cargo.lock

@@ -36,5 +36,4 @@ harness = false
 tempfile = { workspace = true }
 
 [build-dependencies]
-bindgen = "0.72.1"
 cc = "1.0"

crates/codspeed/Cargo.toml

@@ -1,5 +1,3 @@
-use std::{env, path::PathBuf};
-
 fn main() {
     println!("cargo:rerun-if-changed=instrument-hooks/dist/core.c");
     println!("cargo:rerun-if-changed=instrument-hooks/includes/core.h");
@@ -29,18 +27,4 @@ fn main() {
 
         std::process::exit(1);
     }
-
-    let bindings = bindgen::Builder::default()
-        .header("instrument-hooks/includes/core.h")
-        // Tell cargo to invalidate the built crate whenever any of the
-        // included header files changed.
-        .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
-        .generate()
-        .expect("Unable to generate bindings");
-
-    // Write the bindings to the $OUT_DIR/bindings.rs file.
-    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
-    bindings
-        .write_to_file(out_path.join("bindings.rs"))
-        .expect("Couldn't write bindings!");
 }

crates/codspeed/build.rs

@@ -0,0 +1,60 @@
+/* automatically generated by rust-bindgen 0.72.1 */
+
+pub const MARKER_TYPE_SAMPLE_START: u32 = 0;
+pub const MARKER_TYPE_SAMPLE_END: u32 = 1;
+pub const MARKER_TYPE_BENCHMARK_START: u32 = 2;
+pub const MARKER_TYPE_BENCHMARK_END: u32 = 3;
+pub type InstrumentHooks = *mut u64;
+extern "C" {
+    pub fn instrument_hooks_init() -> *mut InstrumentHooks;
+}
+extern "C" {
+    pub fn instrument_hooks_deinit(arg1: *mut InstrumentHooks);
+}
+extern "C" {
+    pub fn instrument_hooks_is_instrumented(arg1: *mut InstrumentHooks) -> bool;
+}
+extern "C" {
+    pub fn instrument_hooks_start_benchmark(arg1: *mut InstrumentHooks) -> u8;
+}
+extern "C" {
+    pub fn instrument_hooks_stop_benchmark(arg1: *mut InstrumentHooks) -> u8;
+}
+extern "C" {
+    pub fn instrument_hooks_set_executed_benchmark(
+        arg1: *mut InstrumentHooks,
+        pid: i32,
+        uri: *const ::std::os::raw::c_char,
+    ) -> u8;
+}
+extern "C" {
+    pub fn instrument_hooks_executed_benchmark(
+        arg1: *mut InstrumentHooks,
+        pid: i32,
+        uri: *const ::std::os::raw::c_char,
+    ) -> u8;
+}
+extern "C" {
+    pub fn instrument_hooks_set_integration(
+        arg1: *mut InstrumentHooks,
+        name: *const ::std::os::raw::c_char,
+        version: *const ::std::os::raw::c_char,
+    ) -> u8;
+}
+extern "C" {
+    pub fn instrument_hooks_add_marker(
+        arg1: *mut InstrumentHooks,
+        pid: u32,
+        marker_type: u8,
+        timestamp: u64,
+    ) -> u8;
+}
+extern "C" {
+    pub fn instrument_hooks_current_timestamp() -> u64;
+}
+pub const instrument_hooks_feature_t_FEATURE_DISABLE_CALLGRIND_MARKERS: instrument_hooks_feature_t =
+    0;
+pub type instrument_hooks_feature_t = ::std::os::raw::c_uint;
+extern "C" {
+    pub fn instrument_hooks_set_feature(feature: instrument_hooks_feature_t, enabled: bool);
+}

crates/codspeed/src/instrument_hooks/bindings.rs

@@ -3,4 +3,11 @@
 #![allow(non_snake_case)]
 #![allow(unused)]
 
-include!(concat!(env!("OUT_DIR"), "/bindings.rs"));
+// Use pre-generated bindings instead of generating at build time so that downstream
+// users don't need to install `libclang`.
+//
+// To regenerate bindings, run:
+// ```
+// ./update-bindings.sh
+// ```
+include!("bindings.rs");

crates/codspeed/src/instrument_hooks/ffi.rs

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+bindgen ../../instrument-hooks/includes/core.h \
+  -o bindings.rs \
+  --rust-target 1.74 \
+  --allowlist-function "instrument_hooks_.*" \
+  --allowlist-var "MARKER_TYPE_.*"