feat: release heaptrack with cargo-dist

Author: not-matthias

Cargo.lock

@@ -57,7 +57,7 @@ memmap2 = "0.9.5"
 nix = { version = "0.29.0", features = ["fs", "time", "user"] }
 futures = "0.3.31"
 runner-shared = { path = "crates/runner-shared" }
-heaptrack = { path = "crates/heaptrack" }
+heaptrack = { path = "crates/heaptrack", default-features = false }
 ipc-channel = "0.18"
 shellexpand = { version = "3.1.1", features = ["tilde"] }
 addr2line = "0.25"
@@ -92,6 +92,9 @@ inherits = "release"
 lto = "thin"
 strip = true
 
+[package.metadata.dist]
+targets = ["aarch64-unknown-linux-musl", "x86_64-unknown-linux-musl"]
+
 # Config for 'dist'
 [workspace.metadata.dist]
 # Whether to consider the binaries in a package for distribution (defaults true)
@@ -102,8 +105,6 @@ cargo-dist-version = "0.28.4"
 ci = "github"
 # The installers to generate for each app
 installers = ["shell"]
-# Target platforms to build apps for (Rust target-triple syntax)
-targets = ["aarch64-unknown-linux-musl", "x86_64-unknown-linux-musl"]
 # The archive format to use for non-windows builds (defaults .tar.xz)
 unix-archive = ".tar.gz"
 # Which actions to run on pull requests
@@ -114,6 +115,7 @@ post-announce-jobs = ["./bump-action"]
 install-path = "CARGO_HOME"
 # Whether to install an updater program
 install-updater = false
+precise-builds = true
 
 [workspace.metadata.dist.github-custom-runners]
 aarch64-unknown-linux-musl = "buildjet-2vcpu-ubuntu-2204-arm"

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "heaptrack"
-version = "0.1.0"
+version = "4.4.1"
 edition = "2024"
 repository = "https://github.com/CodSpeedHQ/runner"
 
@@ -11,12 +11,20 @@ path = "src/lib.rs"
 [[bin]]
 name = "codspeed-heaptrack"
 path = "src/main.rs"
+required-features = ["ebpf"]
+
+[features]
+default = ["ebpf"]
+ebpf = [
+    "dep:libbpf-rs",
+    "dep:libbpf-cargo",
+    "dep:vmlinux",
+]
 
 [dependencies]
 anyhow = "1.0"
 clap = { version = "4.5", features = ["derive"] }
 libc = "0.2"
-libbpf-rs = "0.25.0"
 log = "0.4.28"
 env_logger = "0.11.8"
 serde_json = "1.0"
@@ -25,11 +33,12 @@ runner-shared = { path = "../runner-shared" }
 ipc-channel = "0.18"
 static_assertions = "1.1"
 itertools = "0.14.0"
+libbpf-rs = { version = "0.25.0", features = ["vendored"], optional = true }
 
 [build-dependencies]
-libbpf-cargo = "0.25.0"
+libbpf-cargo = { version = "0.25.0", optional = true }
+vmlinux = { git = "https://github.com/libbpf/vmlinux.h.git", optional = true }
 bindgen = "0.71"
-vmlinux = { git = "https://github.com/libbpf/vmlinux.h.git" }
 
 [dev-dependencies]
 tempfile = "3.8"
@@ -39,6 +48,11 @@ test-log = "0.2"
 [package.metadata.dist]
 dist = true
 installers = ["shell"]
+targets = ["aarch64-unknown-linux-gnu", "x86_64-unknown-linux-gnu"]
+features = ["libbpf-rs/static"]
 
 [package.metadata.dist.dependencies.apt]
-libelf-dev = "*"
+build-essential = "*"
+pkgconf = "*"
+zlib1g-dev = "*"
+libbpf-dev = "*"

crates/heaptrack/Cargo.toml

@@ -1,16 +1,16 @@
+#[cfg(feature = "ebpf")]
 use std::{env, path::PathBuf};
 
-use libbpf_cargo::SkeletonBuilder;
+#[cfg(feature = "ebpf")]
+fn build_ebpf() {
+    use libbpf_cargo::SkeletonBuilder;
 
-fn main() {
     println!("cargo:rerun-if-changed=src/bpf");
 
     // Build the BPF program
     let arch = env::var("CARGO_CFG_TARGET_ARCH")
         .expect("CARGO_CFG_TARGET_ARCH must be set in build script");
-    let out_dir =
-        PathBuf::from(env::var_os("OUT_DIR").expect("OUT_DIR must be set in build script"));
-    let heaptrack_out = out_dir.join("heaptrack.skel.rs");
+    let heaptrack_out = PathBuf::from(env::var("OUT_DIR").unwrap()).join("heaptrack.skel.rs");
     SkeletonBuilder::new()
         .source("src/bpf/heaptrack.bpf.c")
         .clang_args([
@@ -26,7 +26,11 @@ fn main() {
         .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
         .generate()
         .expect("Unable to generate bindings");
-
-    let out_file = out_dir.join("event.rs");
+    let out_file = PathBuf::from(env::var("OUT_DIR").unwrap()).join("event.rs");
     std::fs::write(&out_file, bindings.to_string()).expect("Couldn't write bindings!");
 }
+
+fn main() {
+    #[cfg(feature = "ebpf")]
+    build_ebpf();
+}

crates/heaptrack/build.rs

@@ -1,13 +1,14 @@
 use anyhow::{Context, Result};
 use ipc_channel::ipc::{self, IpcOneShotServer, IpcSender};
-use log::debug;
 use serde::{Deserialize, Serialize};
+
+#[cfg(feature = "ebpf")]
+use crate::Tracker;
+#[cfg(feature = "ebpf")]
 use std::sync::{Arc, Mutex};
 
 pub type HeaptrackIpcServer = IpcOneShotServer<IpcSender<IpcMessage>>;
 
-use crate::Tracker;
-
 /// Commands sent from the runner to control heaptrack
 #[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
 pub enum IpcCommand {
@@ -85,7 +86,10 @@ impl HeaptrackIpcClient {
 }
 
 /// Handle incoming IPC messages in heaptrack
+#[cfg(feature = "ebpf")]
 pub fn handle_ipc_message(msg: IpcMessage, tracker: &Arc<Mutex<Tracker>>) {
+    use log::debug;
+
     let response = match msg.command {
         IpcCommand::Enable => match tracker.lock() {
             Ok(mut t) => match t.enable() {

crates/heaptrack/src/ipc.rs

@@ -1,14 +1,24 @@
+#[cfg(feature = "ebpf")]
 mod bpf;
+#[cfg(feature = "ebpf")]
 mod events;
 mod ipc;
+#[cfg(feature = "ebpf")]
 mod libc;
+#[cfg(feature = "ebpf")]
 mod poller;
+#[cfg(feature = "ebpf")]
 mod tracker;
 
+#[cfg(feature = "ebpf")]
 pub use events::{Event, EventType};
+#[cfg(feature = "ebpf")]
+pub use ipc::handle_ipc_message;
 pub use ipc::{
     HeaptrackIpcClient, HeaptrackIpcServer, IpcCommand as HeaptrackIpcCommand,
-    IpcMessage as HeaptrackIpcMessage, IpcResponse as HeaptrackIpcResponse, handle_ipc_message,
+    IpcMessage as HeaptrackIpcMessage, IpcResponse as HeaptrackIpcResponse,
 };
+#[cfg(feature = "ebpf")]
 pub use poller::{EventHandler, RingBufferPoller};
+#[cfg(feature = "ebpf")]
 pub use tracker::Tracker;