mirror of
https://github.com/sharkdp/hyperfine.git
synced 2026-11-20 03:11:28 +00:00
Compare commits
12
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6af23bb885 | ||
|
|
683885a6c8 | ||
|
|
33aafdca07 | ||
|
|
16f53eb8d6 | ||
|
|
df49a04a66 | ||
|
|
4aa36c8051 | ||
|
|
e689520fb5 | ||
|
|
8cf4e010e9 | ||
|
|
30a2b61d4c | ||
|
|
3558138cea | ||
|
|
1eafcf4739 | ||
|
|
44c0cc231b |
No files matched your search
@@ -15,6 +15,7 @@ use super::measurement::{Measurement, Measurements};
|
||||
|
||||
use anyhow::{bail, Context, Result};
|
||||
|
||||
#[derive(Clone, Copy)]
|
||||
pub enum BenchmarkIteration {
|
||||
NonBenchmarkRun,
|
||||
Warmup(u64),
|
||||
|
||||
+38
-18
@@ -57,11 +57,12 @@ impl<'a> Benchmark<'a> {
|
||||
command: &Command<'_>,
|
||||
error_output: &'static str,
|
||||
output_policy: &CommandOutputPolicy,
|
||||
iteration: executor::BenchmarkIteration,
|
||||
) -> Result<Measurement> {
|
||||
self.executor
|
||||
.run_command_and_measure(
|
||||
command,
|
||||
executor::BenchmarkIteration::NonBenchmarkRun,
|
||||
iteration,
|
||||
Some(CmdFailureAction::RaiseError),
|
||||
output_policy,
|
||||
)
|
||||
@@ -84,7 +85,14 @@ impl<'a> Benchmark<'a> {
|
||||
Append ' || true' to the command if you are sure that this can be ignored.";
|
||||
|
||||
Ok(command
|
||||
.map(|cmd| self.run_intermediate_command(&cmd, error_output, output_policy))
|
||||
.map(|cmd| {
|
||||
self.run_intermediate_command(
|
||||
&cmd,
|
||||
error_output,
|
||||
output_policy,
|
||||
BenchmarkIteration::NonBenchmarkRun,
|
||||
)
|
||||
})
|
||||
.transpose()?
|
||||
.unwrap_or_default())
|
||||
}
|
||||
@@ -105,7 +113,14 @@ impl<'a> Benchmark<'a> {
|
||||
Append ' || true' to the command if you are sure that this can be ignored.";
|
||||
|
||||
Ok(command
|
||||
.map(|cmd| self.run_intermediate_command(&cmd, error_output, output_policy))
|
||||
.map(|cmd| {
|
||||
self.run_intermediate_command(
|
||||
&cmd,
|
||||
error_output,
|
||||
output_policy,
|
||||
BenchmarkIteration::NonBenchmarkRun,
|
||||
)
|
||||
})
|
||||
.transpose()?
|
||||
.unwrap_or_default())
|
||||
}
|
||||
@@ -115,11 +130,12 @@ impl<'a> Benchmark<'a> {
|
||||
&self,
|
||||
command: &Command<'_>,
|
||||
output_policy: &CommandOutputPolicy,
|
||||
iteration: executor::BenchmarkIteration,
|
||||
) -> Result<Measurement> {
|
||||
let error_output = "The preparation command terminated with a non-zero exit code. \
|
||||
Append ' || true' to the command if you are sure that this can be ignored.";
|
||||
|
||||
self.run_intermediate_command(command, error_output, output_policy)
|
||||
self.run_intermediate_command(command, error_output, output_policy, iteration)
|
||||
}
|
||||
|
||||
/// Run the command specified by `--conclude`.
|
||||
@@ -127,11 +143,12 @@ impl<'a> Benchmark<'a> {
|
||||
&self,
|
||||
command: &Command<'_>,
|
||||
output_policy: &CommandOutputPolicy,
|
||||
iteration: executor::BenchmarkIteration,
|
||||
) -> Result<Measurement> {
|
||||
let error_output = "The conclusion command terminated with a non-zero exit code. \
|
||||
Append ' || true' to the command if you are sure that this can be ignored.";
|
||||
|
||||
self.run_intermediate_command(command, error_output, output_policy)
|
||||
self.run_intermediate_command(command, error_output, output_policy, iteration)
|
||||
}
|
||||
|
||||
/// Run the benchmark for a single command
|
||||
@@ -164,10 +181,10 @@ impl<'a> Benchmark<'a> {
|
||||
)
|
||||
});
|
||||
|
||||
let run_preparation_command = || {
|
||||
let run_preparation_command = |iteration: executor::BenchmarkIteration| {
|
||||
preparation_command
|
||||
.as_ref()
|
||||
.map(|cmd| self.run_preparation_command(cmd, output_policy))
|
||||
.map(|cmd| self.run_preparation_command(cmd, output_policy, iteration))
|
||||
.transpose()
|
||||
};
|
||||
|
||||
@@ -183,10 +200,10 @@ impl<'a> Benchmark<'a> {
|
||||
self.command.get_parameters().iter().cloned(),
|
||||
)
|
||||
});
|
||||
let run_conclusion_command = || {
|
||||
let run_conclusion_command = |iteration: executor::BenchmarkIteration| {
|
||||
conclusion_command
|
||||
.as_ref()
|
||||
.map(|cmd| self.run_conclusion_command(cmd, output_policy))
|
||||
.map(|cmd| self.run_conclusion_command(cmd, output_policy, iteration))
|
||||
.transpose()
|
||||
};
|
||||
|
||||
@@ -205,14 +222,15 @@ impl<'a> Benchmark<'a> {
|
||||
};
|
||||
|
||||
for i in 0..self.options.warmup_count {
|
||||
let _ = run_preparation_command()?;
|
||||
let warmup_iteration = BenchmarkIteration::Warmup(i);
|
||||
let _ = run_preparation_command(warmup_iteration)?;
|
||||
let _ = self.executor.run_command_and_measure(
|
||||
self.command,
|
||||
BenchmarkIteration::Warmup(i),
|
||||
warmup_iteration,
|
||||
None,
|
||||
output_policy,
|
||||
)?;
|
||||
let _ = run_conclusion_command()?;
|
||||
let _ = run_conclusion_command(warmup_iteration)?;
|
||||
if let Some(bar) = progress_bar.as_ref() {
|
||||
bar.inc(1)
|
||||
}
|
||||
@@ -233,7 +251,8 @@ impl<'a> Benchmark<'a> {
|
||||
None
|
||||
};
|
||||
|
||||
let preparation_result = run_preparation_command()?;
|
||||
let benchmark_iteration = BenchmarkIteration::Benchmark(0);
|
||||
let preparation_result = run_preparation_command(benchmark_iteration)?;
|
||||
let preparation_overhead = preparation_result.map_or(Time::zero(), |res| {
|
||||
res.time_wall_clock + self.executor.time_overhead()
|
||||
});
|
||||
@@ -241,13 +260,13 @@ impl<'a> Benchmark<'a> {
|
||||
// Initial timing run
|
||||
let res = self.executor.run_command_and_measure(
|
||||
self.command,
|
||||
BenchmarkIteration::Benchmark(0),
|
||||
benchmark_iteration,
|
||||
None,
|
||||
output_policy,
|
||||
)?;
|
||||
let success = res.exit_status.success();
|
||||
|
||||
let conclusion_result = run_conclusion_command()?;
|
||||
let conclusion_result = run_conclusion_command(benchmark_iteration)?;
|
||||
let conclusion_overhead = conclusion_result.map_or(Time::zero(), |res| {
|
||||
res.time_wall_clock + self.executor.time_overhead()
|
||||
});
|
||||
@@ -288,7 +307,8 @@ impl<'a> Benchmark<'a> {
|
||||
|
||||
// Gather statistics (perform the actual benchmark)
|
||||
for i in 0..count_remaining {
|
||||
run_preparation_command()?;
|
||||
let benchmark_iteration = BenchmarkIteration::Benchmark(i + 1);
|
||||
run_preparation_command(benchmark_iteration)?;
|
||||
|
||||
let msg = {
|
||||
let t_wall_clock_mean = measurements.time_wall_clock_mean();
|
||||
@@ -306,7 +326,7 @@ impl<'a> Benchmark<'a> {
|
||||
|
||||
let res = self.executor.run_command_and_measure(
|
||||
self.command,
|
||||
BenchmarkIteration::Benchmark(i + 1),
|
||||
benchmark_iteration,
|
||||
None,
|
||||
output_policy,
|
||||
)?;
|
||||
@@ -320,7 +340,7 @@ impl<'a> Benchmark<'a> {
|
||||
bar.inc(1)
|
||||
}
|
||||
|
||||
run_conclusion_command()?;
|
||||
run_conclusion_command(benchmark_iteration)?;
|
||||
}
|
||||
|
||||
if let Some(bar) = progress_bar.as_ref() {
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
use std::cmp::Ordering;
|
||||
|
||||
use super::benchmark_result::BenchmarkResult;
|
||||
use crate::options::SortOrder;
|
||||
use crate::quantity::second;
|
||||
use crate::{
|
||||
options::SortOrder,
|
||||
quantity::{self, Ratio, Time, Zero},
|
||||
};
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct BenchmarkResultWithRelativeSpeed<'a> {
|
||||
@@ -16,8 +18,7 @@ pub struct BenchmarkResultWithRelativeSpeed<'a> {
|
||||
|
||||
pub fn compare_mean_time(l: &BenchmarkResult, r: &BenchmarkResult) -> Ordering {
|
||||
l.mean_wall_clock_time()
|
||||
.get::<second>()
|
||||
.partial_cmp(&r.mean_wall_clock_time().get::<second>())
|
||||
.partial_cmp(&r.mean_wall_clock_time())
|
||||
.unwrap_or(Ordering::Equal)
|
||||
}
|
||||
|
||||
@@ -39,7 +40,7 @@ fn compute_relative_speeds<'a>(
|
||||
let is_reference = result == reference;
|
||||
let relative_ordering = compare_mean_time(result, reference);
|
||||
|
||||
if result.mean_wall_clock_time().get::<second>() == 0.0 {
|
||||
if result.mean_wall_clock_time() == Time::zero() {
|
||||
return BenchmarkResultWithRelativeSpeed {
|
||||
result,
|
||||
relative_speed: if is_reference { 1.0 } else { f64::INFINITY },
|
||||
@@ -50,34 +51,25 @@ fn compute_relative_speeds<'a>(
|
||||
}
|
||||
|
||||
let ratio = match relative_ordering {
|
||||
Ordering::Less => {
|
||||
reference.mean_wall_clock_time().get::<second>()
|
||||
/ result.mean_wall_clock_time().get::<second>()
|
||||
}
|
||||
Ordering::Equal => 1.0,
|
||||
Ordering::Less => reference.mean_wall_clock_time() / result.mean_wall_clock_time(),
|
||||
Ordering::Equal => Ratio::new::<quantity::ratio>(1.0),
|
||||
Ordering::Greater => {
|
||||
result.mean_wall_clock_time().get::<second>()
|
||||
/ reference.mean_wall_clock_time().get::<second>()
|
||||
result.mean_wall_clock_time() / reference.mean_wall_clock_time()
|
||||
}
|
||||
};
|
||||
|
||||
// https://en.wikipedia.org/wiki/Propagation_of_uncertainty#Example_formulas
|
||||
// Covariance assumed to be 0, i.e. variables are assumed to be independent
|
||||
let ratio_stddev = match (
|
||||
result
|
||||
.measurements
|
||||
.stddev()
|
||||
.map(|time| time.get::<second>()),
|
||||
reference
|
||||
.measurements
|
||||
.stddev()
|
||||
.map(|time| time.get::<second>()),
|
||||
result.measurements.stddev(),
|
||||
reference.measurements.stddev(),
|
||||
) {
|
||||
(Some(result_stddev), Some(fastest_stddev)) => Some(
|
||||
ratio
|
||||
* ((result_stddev / result.mean_wall_clock_time().get::<second>()).powi(2)
|
||||
+ (fastest_stddev / reference.mean_wall_clock_time().get::<second>())
|
||||
.powi(2))
|
||||
* ((result_stddev / result.mean_wall_clock_time())
|
||||
.powi(uom::typenum::P2::new())
|
||||
+ (fastest_stddev / reference.mean_wall_clock_time())
|
||||
.powi(uom::typenum::P2::new()))
|
||||
.sqrt(),
|
||||
),
|
||||
_ => None,
|
||||
@@ -85,8 +77,8 @@ fn compute_relative_speeds<'a>(
|
||||
|
||||
BenchmarkResultWithRelativeSpeed {
|
||||
result,
|
||||
relative_speed: ratio,
|
||||
relative_speed_stddev: ratio_stddev,
|
||||
relative_speed: ratio.get::<quantity::ratio>(),
|
||||
relative_speed_stddev: ratio_stddev.map(|r| r.get::<quantity::ratio>()),
|
||||
is_reference,
|
||||
relative_ordering,
|
||||
}
|
||||
@@ -108,8 +100,8 @@ pub fn compute_with_check_from_reference<'a>(
|
||||
reference: &'a BenchmarkResult,
|
||||
sort_order: SortOrder,
|
||||
) -> Option<Vec<BenchmarkResultWithRelativeSpeed<'a>>> {
|
||||
if fastest_of(results).mean_wall_clock_time().get::<second>() == 0.0
|
||||
|| reference.mean_wall_clock_time().get::<second>() == 0.0
|
||||
if fastest_of(results).mean_wall_clock_time() == Time::zero()
|
||||
|| reference.mean_wall_clock_time() == Time::zero()
|
||||
{
|
||||
return None;
|
||||
}
|
||||
@@ -123,7 +115,7 @@ pub fn compute_with_check(
|
||||
) -> Option<Vec<BenchmarkResultWithRelativeSpeed<'_>>> {
|
||||
let fastest = fastest_of(results);
|
||||
|
||||
if fastest.mean_wall_clock_time().get::<second>() == 0.0 {
|
||||
if fastest.mean_wall_clock_time() == Time::zero() {
|
||||
return None;
|
||||
}
|
||||
|
||||
|
||||
+13
-12
@@ -5,7 +5,7 @@ use csv::WriterBuilder;
|
||||
use super::Exporter;
|
||||
use crate::benchmark::benchmark_result::BenchmarkResult;
|
||||
use crate::options::SortOrder;
|
||||
use crate::quantity::{second, TimeUnit};
|
||||
use crate::quantity::{FormatQuantity, TimeUnit};
|
||||
|
||||
use anyhow::Result;
|
||||
|
||||
@@ -19,6 +19,7 @@ impl Exporter for CsvExporter {
|
||||
_unit: Option<TimeUnit>,
|
||||
_sort_order: SortOrder,
|
||||
) -> Result<Vec<u8>> {
|
||||
const CSV_UNIT: TimeUnit = TimeUnit::Second;
|
||||
const CSV_PRECISION: usize = 6;
|
||||
|
||||
let mut writer = WriterBuilder::new().from_writer(vec![]);
|
||||
@@ -42,18 +43,18 @@ impl Exporter for CsvExporter {
|
||||
for res in results {
|
||||
let mut fields = vec![Cow::Borrowed(res.command.as_bytes())];
|
||||
for f in &[
|
||||
res.mean_wall_clock_time().get::<second>(),
|
||||
res.measurements
|
||||
.stddev()
|
||||
.unwrap_or_default()
|
||||
.get::<second>(),
|
||||
res.measurements.median().get::<second>(),
|
||||
res.measurements.time_user_mean().get::<second>(),
|
||||
res.measurements.time_system_mean().get::<second>(),
|
||||
res.measurements.min().get::<second>(),
|
||||
res.measurements.max().get::<second>(),
|
||||
res.mean_wall_clock_time(),
|
||||
res.measurements.stddev().unwrap_or_default(),
|
||||
res.measurements.median(),
|
||||
res.measurements.time_user_mean(),
|
||||
res.measurements.time_system_mean(),
|
||||
res.measurements.min(),
|
||||
res.measurements.max(),
|
||||
] {
|
||||
fields.push(Cow::Owned(format!("{f:.CSV_PRECISION$}").into_bytes()))
|
||||
fields.push(Cow::Owned(
|
||||
f.format_with_precision(CSV_UNIT, CSV_PRECISION)
|
||||
.into_bytes(),
|
||||
))
|
||||
}
|
||||
for v in res.parameters.values() {
|
||||
fields.push(Cow::Borrowed(v.value.as_bytes()))
|
||||
|
||||
+5
-1
@@ -158,7 +158,11 @@ impl ExportManager {
|
||||
|
||||
/// Write the given content to a file with the specified name
|
||||
fn write_to_file(filename: &str, content: &[u8]) -> Result<()> {
|
||||
let mut file = OpenOptions::new().write(true).open(filename)?;
|
||||
let mut file = OpenOptions::new()
|
||||
.write(true)
|
||||
// Avoid leaving trailing bytes when the new export is shorter.
|
||||
.truncate(true)
|
||||
.open(filename)?;
|
||||
file.write_all(content)
|
||||
.with_context(|| format!("Failed to export results to '{filename}'"))
|
||||
}
|
||||
@@ -82,17 +82,9 @@ pub fn execute_and_measure(mut command: Command) -> Result<Measurement> {
|
||||
discard(output);
|
||||
}
|
||||
|
||||
#[cfg(not(windows))]
|
||||
let (time_user, time_system, peak_memory_usage, exit_status) = cpu_timer.stop(child)?;
|
||||
|
||||
#[cfg(windows)]
|
||||
let exit_status = child.wait()?;
|
||||
|
||||
let time_wall_clock = wallclock_timer.stop();
|
||||
|
||||
#[cfg(windows)]
|
||||
let (time_user, time_system, peak_memory_usage) = cpu_timer.stop();
|
||||
|
||||
Ok(Measurement {
|
||||
time_wall_clock,
|
||||
time_user,
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
#![cfg(windows)]
|
||||
#![warn(unsafe_op_in_unsafe_fn)]
|
||||
|
||||
use std::{mem, os::windows::io::AsRawHandle, process, ptr};
|
||||
use std::process::{self, Child, ExitStatus};
|
||||
use std::{mem, os::windows::io::AsRawHandle, ptr};
|
||||
|
||||
use anyhow::Result;
|
||||
|
||||
use windows_sys::Win32::{
|
||||
Foundation::{CloseHandle, HANDLE},
|
||||
@@ -84,7 +87,9 @@ impl CPUTimer {
|
||||
Self { job_object }
|
||||
}
|
||||
|
||||
pub fn stop(&self) -> (Time, Time, Information) {
|
||||
pub fn stop(&self, mut child: Child) -> Result<(Time, Time, Information, ExitStatus)> {
|
||||
let status = child.wait()?;
|
||||
|
||||
let mut job_object_info =
|
||||
mem::MaybeUninit::<JOBOBJECT_BASIC_ACCOUNTING_INFORMATION>::uninit();
|
||||
|
||||
@@ -113,9 +118,10 @@ impl CPUTimer {
|
||||
// processes no longer associated with the job, in 100-nanosecond ticks."
|
||||
let system_time =
|
||||
Time::new::<nanosecond>((job_object_info.TotalKernelTime as f64) * 100.0);
|
||||
(user_time, system_time, Information::zero())
|
||||
|
||||
Ok((user_time, system_time, Information::zero(), status))
|
||||
} else {
|
||||
(Time::zero(), Time::zero(), Information::zero())
|
||||
Ok((Time::zero(), Time::zero(), Information::zero(), status))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1037,3 +1037,45 @@ fn windows_quote_before_quote_args() {
|
||||
.assert()
|
||||
.success();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hyperfine_iteration_env_var_in_prepare_and_conclude_commands() {
|
||||
let tempdir = tempfile::tempdir().unwrap();
|
||||
let output_path = tempdir.path().join("iteration output.txt");
|
||||
let iteration = if cfg!(windows) {
|
||||
"%HYPERFINE_ITERATION%"
|
||||
} else {
|
||||
"$HYPERFINE_ITERATION"
|
||||
};
|
||||
let command = |phase| format!(r#"echo {phase}:{iteration} >> "iteration output.txt""#);
|
||||
|
||||
hyperfine()
|
||||
.current_dir(tempdir.path())
|
||||
.arg("--runs=2")
|
||||
.arg("--warmup=1")
|
||||
.arg("--prepare")
|
||||
.arg(command("prepare"))
|
||||
.arg(command("benchmark"))
|
||||
.arg("--conclude")
|
||||
.arg(command("conclude"))
|
||||
.assert()
|
||||
.success();
|
||||
|
||||
let contents = std::fs::read_to_string(output_path).unwrap();
|
||||
// cmd.exe's echo includes the space before the redirection operator.
|
||||
let lines: Vec<&str> = contents.lines().map(str::trim_end).collect();
|
||||
assert_eq!(
|
||||
lines,
|
||||
[
|
||||
"prepare:warmup-0",
|
||||
"benchmark:warmup-0",
|
||||
"conclude:warmup-0",
|
||||
"prepare:0",
|
||||
"benchmark:0",
|
||||
"conclude:0",
|
||||
"prepare:1",
|
||||
"benchmark:1",
|
||||
"conclude:1",
|
||||
]
|
||||
);
|
||||
}
|
||||
Reference in new issue
Block a user