Advanced performance metrics

Cargo.toml

@@ -28,6 +28,11 @@ rand = "0.8"
 shell-words = "1.0"
 thiserror = "2.0"
 anyhow = "1.0"
+uom = { version = "0.36.0", default-features = false, features = [
+    "std",
+    "si",
+    "f64",
+] }
 
 [target.'cfg(not(windows))'.dependencies]
 libc = "0.2"

src/benchmark/benchmark_result.rs

@@ -2,54 +2,54 @@ use std::collections::BTreeMap;
 
 use serde::Serialize;
 
-use crate::util::units::Second;
+use crate::benchmark::measurement::Measurements;
+use crate::quantity::Time;
 
-/// Set of values that will be exported.
-// NOTE: `serde` is used for JSON serialization, but not for CSV serialization due to the
-// `parameters` map. Update `src/hyperfine/export/csv.rs` with new fields, as appropriate.
+/// Parameter value and whether it was used in the command line template
+#[derive(Debug, Default, Clone, Serialize, PartialEq)]
+pub struct Parameter {
+    pub value: String,
+    pub is_unused: bool,
+}
+
+/// Meta data and performance metrics for a single benchmark
 #[derive(Debug, Default, Clone, Serialize, PartialEq)]
 pub struct BenchmarkResult {
     /// The full command line of the program that is being benchmarked
     pub command: String,
 
-    /// The full command line of the program that is being benchmarked, possibly including a list of
-    /// parameters that were not used in the command line template.
-    #[serde(skip_serializing)]
-    pub command_with_unused_parameters: String,
-
-    /// The average run time
-    pub mean: Second,
-
-    /// The standard deviation of all run times. Not available if only one run has been performed
-    pub stddev: Option<Second>,
-
-    /// The median run time
-    pub median: Second,
-
-    /// Time spent in user mode
-    pub user: Second,
-
-    /// Time spent in kernel mode
-    pub system: Second,
-
-    /// Minimum of all measured times
-    pub min: Second,
-
-    /// Maximum of all measured times
-    pub max: Second,
-
-    /// All run time measurements
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub times: Option<Vec<Second>>,
-
-    /// Maximum memory usage of the process, in bytes
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub memory_usage_byte: Option<Vec<u64>>,
-
-    /// Exit codes of all command invocations
-    pub exit_codes: Vec<Option<i32>>,
+    /// Performance metric measurements and exit codes for each run
+    #[serde(flatten)]
+    pub measurements: Measurements,
 
     /// Parameter values for this benchmark
     #[serde(skip_serializing_if = "BTreeMap::is_empty")]
-    pub parameters: BTreeMap<String, String>,
+    pub parameters: BTreeMap<String, Parameter>,
+}
+
+impl BenchmarkResult {
+    /// The average wall clock time
+    pub fn mean_wall_clock_time(&self) -> Time {
+        self.measurements.time_wall_clock_mean()
+    }
+
+    /// The full command line of the program that is being benchmarked, possibly including a list of
+    /// parameters that were not used in the command line template.
+    pub fn command_with_unused_parameters(&self) -> String {
+        let parameters = self
+            .parameters
+            .iter()
+            .filter(|(_, parameter)| parameter.is_unused)
+            .fold(String::new(), |output, (name, parameter)| {
+                output + &format!("{name} = {value}, ", value = parameter.value)
+            });
+        let parameters = parameters.trim_end_matches(", ");
+        let parameters = if parameters.is_empty() {
+            "".into()
+        } else {
+            format!(" ({parameters})")
+        };
+
+        format!("{}{}", self.command, parameters)
+    }
 }