|
| 1 | +//! Shared microbenchmark harness for zolt-arith. |
| 2 | +//! Zero external dependencies — only std. |
| 3 | +//! |
| 4 | +//! Usage: |
| 5 | +//! const harness = @import("bench_harness.zig"); |
| 6 | +//! _ = harness.run("field_Fp", "mul", harness.Config.field, Fp, struct { |
| 7 | +//! fn call(i: usize) Fp { return a[i % N].mul(b[i % N]); } |
| 8 | +//! }.call); |
| 9 | + |
| 10 | +const std = @import("std"); |
| 11 | + |
| 12 | +const MAX_SAMPLES: usize = 101; |
| 13 | + |
| 14 | +pub const Config = struct { |
| 15 | + warmup_iters: usize = 5_000, |
| 16 | + sample_count: usize = 21, |
| 17 | + iters_per_sample: usize = 100_000, |
| 18 | + |
| 19 | + pub const field: Config = .{ |
| 20 | + .warmup_iters = 20_000, |
| 21 | + .sample_count = 21, |
| 22 | + .iters_per_sample = 100_000, |
| 23 | + }; |
| 24 | + |
| 25 | + pub const pairing: Config = .{ |
| 26 | + .warmup_iters = 10, |
| 27 | + .sample_count = 21, |
| 28 | + .iters_per_sample = 100, |
| 29 | + }; |
| 30 | +}; |
| 31 | + |
| 32 | +pub const Stats = struct { |
| 33 | + min_ns: f64, |
| 34 | + median_ns: f64, |
| 35 | + mean_ns: f64, |
| 36 | + p99_ns: f64, |
| 37 | + stddev_ns: f64, |
| 38 | + sample_count: usize, |
| 39 | + iters_per_sample: usize, |
| 40 | +}; |
| 41 | + |
| 42 | +pub fn run( |
| 43 | + comptime group: []const u8, |
| 44 | + comptime op_name: []const u8, |
| 45 | + config: Config, |
| 46 | + comptime T: type, |
| 47 | + comptime body: fn (usize) T, |
| 48 | +) Stats { |
| 49 | + const n = @min(config.sample_count, MAX_SAMPLES); |
| 50 | + const iters = config.iters_per_sample; |
| 51 | + |
| 52 | + // --- Warmup --- |
| 53 | + var sink: T = undefined; |
| 54 | + for (0..config.warmup_iters) |i| { |
| 55 | + sink = body(i); |
| 56 | + } |
| 57 | + std.mem.doNotOptimizeAway(&sink); |
| 58 | + |
| 59 | + // --- Collect samples --- |
| 60 | + var samples: [MAX_SAMPLES]f64 = undefined; |
| 61 | + for (0..n) |s| { |
| 62 | + var timer = std.time.Timer.start() catch unreachable; |
| 63 | + for (0..iters) |i| { |
| 64 | + sink = body(i); |
| 65 | + } |
| 66 | + std.mem.doNotOptimizeAway(&sink); |
| 67 | + const elapsed_ns: u64 = timer.read(); |
| 68 | + samples[s] = @as(f64, @floatFromInt(elapsed_ns)) / |
| 69 | + @as(f64, @floatFromInt(iters)); |
| 70 | + } |
| 71 | + |
| 72 | + // --- Compute stats --- |
| 73 | + const slice = samples[0..n]; |
| 74 | + std.sort.pdq(f64, slice, {}, lessThanF64); |
| 75 | + |
| 76 | + var sum: f64 = 0; |
| 77 | + for (slice) |v| sum += v; |
| 78 | + const mean = sum / @as(f64, @floatFromInt(n)); |
| 79 | + |
| 80 | + var var_sum: f64 = 0; |
| 81 | + for (slice) |v| { |
| 82 | + const d = v - mean; |
| 83 | + var_sum += d * d; |
| 84 | + } |
| 85 | + const stddev = @sqrt(var_sum / @as(f64, @floatFromInt(n))); |
| 86 | + |
| 87 | + const median = if (n % 2 == 1) |
| 88 | + slice[n / 2] |
| 89 | + else |
| 90 | + (slice[n / 2 - 1] + slice[n / 2]) / 2.0; |
| 91 | + |
| 92 | + const p99_idx = @as(usize, @intFromFloat(@ceil(0.99 * @as(f64, @floatFromInt(n))))) - 1; |
| 93 | + |
| 94 | + const stats = Stats{ |
| 95 | + .min_ns = slice[0], |
| 96 | + .median_ns = median, |
| 97 | + .mean_ns = mean, |
| 98 | + .p99_ns = slice[p99_idx], |
| 99 | + .stddev_ns = stddev, |
| 100 | + .sample_count = n, |
| 101 | + .iters_per_sample = iters, |
| 102 | + }; |
| 103 | + |
| 104 | + printResult(group, op_name, stats); |
| 105 | + return stats; |
| 106 | +} |
| 107 | + |
| 108 | +fn lessThanF64(_: void, a: f64, b: f64) bool { |
| 109 | + return a < b; |
| 110 | +} |
| 111 | + |
| 112 | +const FmtTime = struct { val: f64, unit: []const u8 }; |
| 113 | + |
| 114 | +fn formatTime(ns: f64) FmtTime { |
| 115 | + if (ns >= 1_000_000.0) return .{ .val = ns / 1_000_000.0, .unit = "ms" }; |
| 116 | + if (ns >= 1_000.0) return .{ .val = ns / 1_000.0, .unit = "us" }; |
| 117 | + return .{ .val = ns, .unit = "ns" }; |
| 118 | +} |
| 119 | + |
| 120 | +fn printResult(comptime group: []const u8, comptime op_name: []const u8, s: Stats) void { |
| 121 | + const min_f = formatTime(s.min_ns); |
| 122 | + const med_f = formatTime(s.median_ns); |
| 123 | + const mean_f = formatTime(s.mean_ns); |
| 124 | + const p99_f = formatTime(s.p99_ns); |
| 125 | + const sd_f = formatTime(s.stddev_ns); |
| 126 | + |
| 127 | + std.debug.print( |
| 128 | + "[BENCH] group={s} op={s} min={d:.1}{s} median={d:.1}{s} mean={d:.1}{s} p99={d:.1}{s} stddev={d:.1}{s} samples={d}x{d}\n", |
| 129 | + .{ |
| 130 | + group, op_name, |
| 131 | + min_f.val, min_f.unit, |
| 132 | + med_f.val, med_f.unit, |
| 133 | + mean_f.val, mean_f.unit, |
| 134 | + p99_f.val, p99_f.unit, |
| 135 | + sd_f.val, sd_f.unit, |
| 136 | + s.sample_count, s.iters_per_sample, |
| 137 | + }, |
| 138 | + ); |
| 139 | +} |
0 commit comments