feat: add timestamp to unwind data

Author: not-matthias

crates/runner-shared/src/unwind_data.rs

@@ -7,21 +7,25 @@ use std::{hash::DefaultHasher, ops::Range};
 
 pub const UNWIND_FILE_EXT: &str = "unwind_data";
 
-pub type UnwindData = UnwindDataV1;
+pub type UnwindData = UnwindDataV2;
 
 impl UnwindData {
     pub fn parse(reader: &[u8]) -> anyhow::Result<Self> {
         let compat: UnwindDataCompat = bincode::deserialize(reader)?;
 
         match compat {
-            UnwindDataCompat::V1(v1) => Ok(v1),
+            UnwindDataCompat::V1(v1) => Ok(v1.into()),
+            UnwindDataCompat::V2(v2) => Ok(v2),
         }
     }
 
     pub fn save_to<P: AsRef<std::path::Path>>(&self, folder: P, pid: i32) -> anyhow::Result<()> {
         let unwind_data_path = folder.as_ref().join(format!(
-            "{}_{:x}_{:x}.{UNWIND_FILE_EXT}",
-            pid, self.avma_range.start, self.avma_range.end
+            "{}_{:x}_{:x}_{}.{UNWIND_FILE_EXT}",
+            pid,
+            self.avma_range.start,
+            self.avma_range.end,
+            self.timestamp.unwrap_or_default()
         ));
         self.to_file(unwind_data_path)?;
 
@@ -38,7 +42,7 @@ impl UnwindData {
         }
 
         let mut writer = std::fs::File::create(path.as_ref())?;
-        let compat = UnwindDataCompat::V1(self.clone());
+        let compat = UnwindDataCompat::V2(self.clone());
         bincode::serialize_into(&mut writer, &compat)?;
         Ok(())
     }
@@ -59,6 +63,7 @@ impl Debug for UnwindData {
 
         f.debug_struct("UnwindData")
             .field("path", &self.path)
+            .field("timestamp", &self.timestamp)
             .field("avma_range", &format_args!("{:x?}", self.avma_range))
             .field("base_avma", &format_args!("{:x}", self.base_avma))
             .field("base_svma", &format_args!("{:x}", self.base_svma))
@@ -77,11 +82,12 @@ impl Debug for UnwindData {
 #[derive(Serialize, Deserialize)]
 enum UnwindDataCompat {
     V1(UnwindDataV1),
+    V2(UnwindDataV2),
 }
 
 #[doc(hidden)]
 #[derive(Serialize, Deserialize, Clone)]
-pub struct UnwindDataV1 {
+struct UnwindDataV1 {
     pub path: String,
 
     pub avma_range: Range<u64>,
@@ -94,3 +100,39 @@ pub struct UnwindDataV1 {
     pub eh_frame: Vec<u8>,
     pub eh_frame_svma: Range<u64>,
 }
+
+#[doc(hidden)]
+#[derive(Serialize, Deserialize, Clone)]
+pub struct UnwindDataV2 {
+    pub path: String,
+
+    /// The monotonic timestamp when the unwind data was captured.
+    /// Is `None` if unwind data is valid for the whole program execution
+    pub timestamp: Option<u64>,
+
+    pub avma_range: Range<u64>,
+    pub base_avma: u64,
+    pub base_svma: 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 From<UnwindDataV1> for UnwindDataV2 {
+    fn from(v1: UnwindDataV1) -> Self {
+        Self {
+            path: v1.path,
+            timestamp: None,
+            avma_range: v1.avma_range,
+            base_avma: v1.base_avma,
+            base_svma: v1.base_svma,
+            eh_frame_hdr: v1.eh_frame_hdr,
+            eh_frame_hdr_svma: v1.eh_frame_hdr_svma,
+            eh_frame: v1.eh_frame,
+            eh_frame_svma: v1.eh_frame_svma,
+        }
+    }
+}

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

@@ -74,6 +74,7 @@ impl JitDump {
 
                     jit_unwind_data.push(UnwindData {
                         path: format!("jit_{name}"),
+                        timestamp: Some(raw_record.timestamp),
                         avma_range: avma_start..avma_end,
                         base_avma: 0,
                         eh_frame_hdr,

src/run/runner/wall_time/perf/snapshots/codspeed__run__runner__wall_time__perf__unwind_data__tests__cpp_unwind_data.snap

@@ -5,6 +5,7 @@ expression: "UnwindData::new(MODULE_PATH.as_bytes(), file_offset, start_addr, en
 Ok(
     UnwindData {
         path: "testdata/perf_map/cpp_my_benchmark.bin",
+        timestamp: None,
         avma_range: 400000..459000,
         base_avma: 400000,
         base_svma: 400000,

src/run/runner/wall_time/perf/snapshots/codspeed__run__runner__wall_time__perf__unwind_data__tests__golang_unwind_data.snap

@@ -5,6 +5,7 @@ expression: "UnwindData::new(MODULE_PATH.as_bytes(), file_offset, start_addr, en
 Ok(
     UnwindData {
         path: "testdata/perf_map/go_fib.bin",
+        timestamp: None,
         avma_range: 402000..50f000,
         base_avma: 400000,
         base_svma: 400000,

src/run/runner/wall_time/perf/snapshots/codspeed__run__runner__wall_time__perf__unwind_data__tests__ruff_unwind_data.snap

@@ -5,6 +5,7 @@ expression: "UnwindData::new(MODULE_PATH.as_bytes(), file_offset, start_addr, en
 Ok(
     UnwindData {
         path: "testdata/perf_map/ty_walltime",
+        timestamp: None,
         avma_range: 555555e6d000..555556813000,
         base_avma: 555555554000,
         base_svma: 0,

src/run/runner/wall_time/perf/snapshots/codspeed__run__runner__wall_time__perf__unwind_data__tests__rust_divan_unwind_data.snap

@@ -5,6 +5,7 @@ expression: "UnwindData::new(MODULE_PATH.as_bytes(), file_offset, start_addr, en
 Ok(
     UnwindData {
         path: "testdata/perf_map/divan_sleep_benches.bin",
+        timestamp: None,
         avma_range: 5555555a2000..555555692000,
         base_avma: 555555554000,
         base_svma: 0,

src/run/runner/wall_time/perf/snapshots/codspeed__run__runner__wall_time__perf__unwind_data__tests__the_algorithms_unwind_data.snap

@@ -1,10 +1,11 @@
 ---
 source: src/run/runner/wall_time/perf/unwind_data.rs
-expression: "UnwindData::new(MODULE_PATH.as_bytes(), 0x52efc, 0x00005555555a7000, 0x00005555556b0000,\nNone)"
+expression: "UnwindData::new(MODULE_PATH.as_bytes(), file_offset, start_addr, end_addr,\nNone)"
 ---
 Ok(
     UnwindData {
         path: "testdata/perf_map/the_algorithms.bin",
+        timestamp: None,
         avma_range: 5555555a7000..5555556b0000,
         base_avma: 555555554000,
         base_svma: 0,

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

@@ -81,6 +81,7 @@ impl UnwindDataExt for UnwindData {
 
         Ok(UnwindData {
             path,
+            timestamp: None,
             avma_range,
             base_avma,
             base_svma,