feat: add perf v2 support

Author: not-matthias

crates/runner-shared/src/fifo.rs

@@ -0,0 +1,33 @@
+//! WARNING: Has to be in sync with `codspeed-rust/codspeed`.
+
+pub const RUNNER_CTL_FIFO: &str = "/tmp/runner.ctl.fifo";
+pub const RUNNER_ACK_FIFO: &str = "/tmp/runner.ack.fifo";
+
+pub const CURRENT_PROTOCOL_VERSION: u64 = 1;
+
+/// The different markers that can be set in the perf.data.
+///
+/// `SampleStart/End`: Marks the start and end of a sampling period. This is used to differentiate between benchmarks.
+/// `BenchmarkStart/End`: Marks the start and end of a benchmark. This is used to measure the duration of a benchmark, without the benchmark harness code.
+#[derive(
+    serde::Serialize, serde::Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Copy, Clone,
+)]
+pub enum MarkerType {
+    SampleStart(u64),
+    SampleEnd(u64),
+    BenchmarkStart(u64),
+    BenchmarkEnd(u64),
+}
+
+#[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq)]
+pub enum Command {
+    CurrentBenchmark { pid: u32, uri: String },
+    StartBenchmark,
+    StopBenchmark,
+    Ack,
+    PingPerf,
+    SetIntegration { name: String, version: String },
+    Err,
+    AddMarker { pid: u32, marker: MarkerType },
+    SetVersion(u64),
+}

crates/runner-shared/src/metadata.rs

@@ -1,26 +1,36 @@
-// !!!!!!!!!!!!!!!!!!!!!!!!
-// !! DO NOT TOUCH BELOW !!
-// !!!!!!!!!!!!!!!!!!!!!!!!
-// Has to be in sync with `perf-parser`.
-//
-
-use std::{collections::HashMap, path::Path};
-
+use anyhow::Context;
 use serde::{Deserialize, Serialize};
+use std::path::Path;
+
+use crate::fifo::MarkerType;
 
 #[derive(Serialize, Deserialize)]
 pub struct PerfMetadata {
+    /// The version of this metadata format.
+    /// Only available in version 1+
+    #[serde(default)]
+    pub version: u64,
+
     /// Name and version of the integration
     pub integration: (String, String),
 
-    /// The URIs of the benchmarks in the order they were executed.
-    pub bench_order_by_pid: HashMap<u32, Vec<String>>,
+    /// The URIs of the benchmarks with the timestamps they were executed at.
+    pub uri_by_ts: Vec<(u64, String)>,
 
     /// Modules that should be ignored and removed from the folded trace and callgraph (e.g. python interpreter)
     pub ignored_modules: Vec<(String, u64, u64)>,
+
+    /// Marker for certain regions in the profiling data
+    /// Only available in version 1+
+    #[serde(default)]
+    pub markers: Vec<MarkerType>,
 }
 
 impl PerfMetadata {
+    pub fn from_reader<R: std::io::Read>(reader: R) -> anyhow::Result<Self> {
+        serde_json::from_reader(reader).context("Could not parse perf metadata from JSON")
+    }
+
     pub fn save_to<P: AsRef<Path>>(&self, path: P) -> anyhow::Result<()> {
         let file = std::fs::File::create(path.as_ref().join("perf.metadata"))?;
         serde_json::to_writer(file, self)?;