feat: add runner-shared crate

Author: not-matthias

Cargo.lock

@@ -53,8 +53,9 @@ object = "0.36.7"
 linux-perf-data = "0.11.0"
 debugid = "0.8.0"
 memmap2 = "0.9.5"
-nix = { version = "0.29.0", features = ["fs", "user"] }
+nix = { version = "0.29.0", features = ["fs", "time", "user"] }
 futures = "0.3.31"
+runner-shared = { path = "crates/runner-shared" }
 
 [target.'cfg(target_os = "linux")'.dependencies]
 procfs = "0.17.0"
@@ -67,6 +68,9 @@ rstest = { version = "0.25.0", default-features = false }
 rstest_reuse = "0.7.0"
 shell-quote = "0.7.2"
 
+[workspace]
+members = ["crates/runner-shared"]
+
 [workspace.metadata.release]
 sign-tag = true
 sign-commit = true

Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "runner-shared"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+anyhow = "1.0.100"
+serde = { version = "1.0.225", features = ["derive"] }
+serde_json = "1.0.145"

crates/runner-shared/Cargo.toml

@@ -0,0 +1,5 @@
+// This will be accessed from the `parse_callgraph` lambda.
+
+pub mod fifo;
+pub mod metadata;
+pub mod unwind_data;

crates/runner-shared/src/lib.rs

@@ -0,0 +1,49 @@
+use core::{
+    fmt::Debug,
+    hash::{Hash, Hasher},
+};
+use serde::{Deserialize, Serialize};
+use std::{hash::DefaultHasher, ops::Range};
+
+/// Unwind data for a single module.
+#[derive(Serialize, Deserialize)]
+pub struct UnwindData {
+    pub path: String,
+
+    pub avma_range: Range<u64>,
+    pub base_avma: u64,
+
+    pub eh_frame_hdr: Vec<u8>,
+    pub eh_frame_hdr_svma: Range<u64>,
+
+    pub eh_frame: Vec<u8>,
+    pub eh_frame_svma: Range<u64>,
+}
+
+impl Debug for UnwindData {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let eh_frame_hdr_hash = {
+            let mut hasher = DefaultHasher::new();
+            self.eh_frame_hdr.hash(&mut hasher);
+            hasher.finish()
+        };
+        let eh_frame_hash = {
+            let mut hasher = DefaultHasher::new();
+            self.eh_frame.hash(&mut hasher);
+            hasher.finish()
+        };
+
+        f.debug_struct("UnwindData")
+            .field("path", &self.path)
+            .field("avma_range", &format_args!("{:x?}", self.avma_range))
+            .field("base_avma", &format_args!("{:x}", self.base_avma))
+            .field(
+                "eh_frame_hdr_svma",
+                &format_args!("{:x?}", self.eh_frame_hdr_svma),
+            )
+            .field("eh_frame_hdr_hash", &format_args!("{eh_frame_hdr_hash:x}"))
+            .field("eh_frame_hash", &format_args!("{eh_frame_hash:x}"))
+            .field("eh_frame_svma", &format_args!("{:x?}", self.eh_frame_svma))
+            .finish()
+    }
+}

src/run/runner/wall_time/perf/metadata.rs crates/runner-shared/src/metadata.rssrc/run/runner/wall_time/perf/metadata.rs renamed to crates/runner-shared/src/metadata.rs

@@ -1,4 +1,5 @@
-use super::{FifoCommand, RUNNER_ACK_FIFO, RUNNER_CTL_FIFO};
+use super::FifoCommand;
+use runner_shared::fifo::{RUNNER_ACK_FIFO, RUNNER_CTL_FIFO};
 use std::path::PathBuf;
 use tokio::io::{AsyncReadExt, AsyncWriteExt};
 use tokio::net::unix::pipe::OpenOptions as TokioPipeOpenOptions;

crates/runner-shared/src/unwind_data.rs

@@ -2,10 +2,11 @@ use crate::{
     prelude::*,
     run::runner::wall_time::perf::{
         perf_map::{ModuleSymbols, Symbol},
-        unwind_data::UnwindData,
+        unwind_data::UnwindDataExt,
     },
 };
 use linux_perf_data::jitdump::{JitDumpReader, JitDumpRecord};
+use runner_shared::unwind_data::UnwindData;
 use std::{
     collections::HashSet,
     path::{Path, PathBuf},

src/run/runner/wall_time/perf/fifo.rs

@@ -2,61 +2,29 @@
 
 use crate::run::runner::wall_time::perf::elf_helper;
 use anyhow::{Context, bail};
-use core::{
-    fmt::Debug,
-    hash::{Hash, Hasher},
-};
 use debugid::CodeId;
 use object::{Object, ObjectSection};
-use serde::{Deserialize, Serialize};
-use std::{hash::DefaultHasher, ops::Range};
+use runner_shared::unwind_data::UnwindData;
+use std::ops::Range;
 
-/// Unwind data for a single module.
-#[derive(Serialize, Deserialize)]
-pub struct UnwindData {
-    pub path: String,
-
-    pub avma_range: Range<u64>,
-    pub base_avma: u64,
-
-    pub eh_frame_hdr: Vec<u8>,
-    pub eh_frame_hdr_svma: Range<u64>,
-
-    pub eh_frame: Vec<u8>,
-    pub eh_frame_svma: Range<u64>,
-}
-
-impl Debug for UnwindData {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        let eh_frame_hdr_hash = {
-            let mut hasher = DefaultHasher::new();
-            self.eh_frame_hdr.hash(&mut hasher);
-            hasher.finish()
-        };
-        let eh_frame_hash = {
-            let mut hasher = DefaultHasher::new();
-            self.eh_frame.hash(&mut hasher);
-            hasher.finish()
-        };
+pub trait UnwindDataExt {
+    fn new(
+        path_slice: &[u8],
+        mapping_start_file_offset: u64,
+        mapping_start_avma: u64,
+        mapping_size: u64,
+        build_id: Option<&[u8]>,
+    ) -> anyhow::Result<Self>
+    where
+        Self: Sized;
 
-        f.debug_struct("UnwindData")
-            .field("path", &self.path)
-            .field("avma_range", &format_args!("{:x?}", self.avma_range))
-            .field("base_avma", &format_args!("{:x}", self.base_avma))
-            .field(
-                "eh_frame_hdr_svma",
-                &format_args!("{:x?}", self.eh_frame_hdr_svma),
-            )
-            .field("eh_frame_hdr_hash", &format_args!("{eh_frame_hdr_hash:x}"))
-            .field("eh_frame_hash", &format_args!("{eh_frame_hash:x}"))
-            .field("eh_frame_svma", &format_args!("{:x?}", self.eh_frame_svma))
-            .finish()
-    }
+    fn save_to<P: AsRef<std::path::Path>>(&self, folder: P, pid: u32) -> anyhow::Result<()>;
+    fn to_file<P: AsRef<std::path::Path>>(&self, path: P) -> anyhow::Result<()>;
 }
 
-impl UnwindData {
+impl UnwindDataExt for UnwindData {
     // Based on this: https://github.com/mstange/linux-perf-stuff/blob/22ca6531b90c10dd2a4519351c843b8d7958a451/src/main.rs#L747-L893
-    pub fn new(
+    fn new(
         path_slice: &[u8],
         runtime_file_offset: u64,
         runtime_start_addr: u64,
@@ -80,18 +48,12 @@ impl UnwindData {
                     let file_build_id = CodeId::from_binary(file_build_id);
                     let expected_build_id = CodeId::from_binary(build_id);
                     bail!(
-                        "File {:?} has non-matching build ID {} (expected {})",
-                        path,
-                        file_build_id,
-                        expected_build_id
+                        "File {path:?} has non-matching build ID {file_build_id} (expected {expected_build_id})"
                     );
                 }
             }
             (Some(_), Err(_)) | (Some(_), Ok(None)) => {
-                bail!(
-                    "File {:?} does not contain a build ID, but we expected it to have one",
-                    path
-                );
+                bail!("File {path:?} does not contain a build ID, but we expected it to have one");
             }
             _ => {
                 // No build id to check
@@ -135,7 +97,7 @@ impl UnwindData {
         })
     }
 
-    pub fn save_to<P: AsRef<std::path::Path>>(&self, folder: P, pid: u32) -> anyhow::Result<()> {
+    fn save_to<P: AsRef<std::path::Path>>(&self, folder: P, pid: u32) -> anyhow::Result<()> {
         let unwind_data_path = folder.as_ref().join(format!(
             "{}_{:x}_{:x}.unwind",
             pid, self.avma_range.start, self.avma_range.end