tiny.profiling.driver.progress

1const std = @import("std");2const pretty_usage = @import("pretty_usage");3const host = @import("../root.zig").host;4const order = @import("../root.zig").order;5const perturbation = @import("../root.zig").perturbation;67pub fn writeCaptureControlProgress(8    allocator: std.mem.Allocator,9    workload_name: []const u8,10    pair: perturbation.Pair,11    pair_count: usize,12) !void {13    const order_label = switch (pair.order) {14        .control_first => "control->capture",15        .capture_first => "capture->control",16    };17    try pretty_usage.Terminal.stderr(allocator, .{}).writeTextFmt(18        "profile: {s} capture control pair {d}/{d}, order {s}\n",19        .{ workload_name, pair.index, pair_count, order_label },20    );21}2223pub fn writeMeasureProgress(24    allocator: std.mem.Allocator,25    workload_name: []const u8,26    repeat_index: usize,27    repeat: u32,28) !void {29    if (repeat <= 1) return;30    try pretty_usage.Terminal.stderr(allocator, .{}).writeTextFmt(31        "profile: {s} measurement repetition {d}/{d}\n",32        .{ workload_name, repeat_index + 1, repeat },33    );34}3536pub fn writeInterleaveProgress(37    allocator: std.mem.Allocator,38    workload_name: []const u8,39    entry: order.Entry,40    acquisition_count: usize,41    repeat_count: u32,42) !void {43    std.debug.assert(entry.position > 0);44    std.debug.assert(entry.position <= acquisition_count);45    try pretty_usage.Terminal.stderr(allocator, .{}).writeTextFmt(46        "profile: acquisition {d}/{d}, {s} repetition {d}/{d}\n",47        .{48            entry.position,49            acquisition_count,50            workload_name,51            entry.repetition_index + 1,52            repeat_count,53        },54    );55}5657pub fn writeWarmupProgress(58    allocator: std.mem.Allocator,59    workload_name: []const u8,60    index: usize,61    repeat: u32,62) !void {63    std.debug.assert(repeat > 0);64    try pretty_usage.Terminal.stderr(allocator, .{}).writeTextFmt(65        "profile: {s} unmeasured warmup {d}/{d}\n",66        .{ workload_name, index + 1, repeat },67    );68}6970pub fn writeCounterProgress(71    allocator: std.mem.Allocator,72    workload_name: []const u8,73    lane: host.counters.Lane,74    options: host.counters.Options,75    run: host.counters.Run,76    run_index: usize,77) !void {78    const terminal = pretty_usage.Terminal.stderr(allocator, .{});79    if (lane.event_groups.len > 1 and options.repeat > 1) {80        try terminal.writeTextFmt(81            "profile: {s} counter execution {d}/{d}, group {d}/{d}, repetition {d}/{d}\n",82            .{83                workload_name,84                run_index + 1,85                lane.runs.len,86                run.group_index,87                lane.event_groups.len,88                run.repetition_index,89                options.repeat,90            },91        );92    } else if (lane.event_groups.len > 1) {93        try terminal.writeTextFmt(94            "profile: {s} counter group {d}/{d}\n",95            .{ workload_name, run.group_index, lane.event_groups.len },96        );97    } else if (options.repeat > 1) {98        try terminal.writeTextFmt(99            "profile: {s} counter repetition {d}/{d}\n",100            .{ workload_name, run.repetition_index, options.repeat },101        );102    }103}104105pub fn writeCaptureCaveats(106    allocator: std.mem.Allocator,107    workload_name: []const u8,108    captures: []const host.Capture,109) !void {110    const terminal = pretty_usage.Terminal.stderr(allocator, .{});111    for (captures) |row| {112        if (!captureNeedsNotice(row)) continue;113        try terminal.writeTextFmt(114            "profile: {s} {s} {s}",115            .{ workload_name, row.kind, row.state },116        );117        if (row.caveat_kind) |caveat| {118            try terminal.writeTextFmt(": {s}", .{caveat});119        }120        if (row.caveat_message) |message| {121            try terminal.writeTextFmt(": {s}", .{message});122        }123        try terminal.writeText("\n");124    }125}126127fn captureNeedsNotice(row: host.Capture) bool {128    return !std.mem.eql(u8, row.state, "summary_written") or row.caveat_kind != null;129}130131test "profiling driver notices unsupported captures" {132    try std.testing.expect(!captureNeedsNotice(.{133        .kind = "perf_record",134        .tool = "perf",135        .capture_path = "perf.data",136        .summary_path = "perf.summary.json",137        .state = "summary_written",138    }));139    try std.testing.expect(captureNeedsNotice(.{140        .kind = "perf_record",141        .tool = "perf",142        .capture_path = "perf.data",143        .summary_path = "perf.summary.json",144        .state = "insufficient_samples",145    }));146}

1pub const progress = @import("progress.zig");