`tiny.bench.Suite`

Reference tiny.bench Suite

Defined in tiny.bench.

API (16)

Public operations.

Public fields and members.

Static calls · unresolved targets: unknown · external targets: unknown.

Source

Source: lib/bench/src/suite.zig:169

1pub const Suite = struct {2    alloc: Allocator,3    default_config: Config,4    filter: ?[]const u8 = null,5    clock_probe: ?timing.ClockProbe = null,6    benchmarks: std.ArrayListUnmanaged(Definition) = .empty,7    results: std.ArrayListUnmanaged(Result) = .empty,89    pub fn init(alloc: Allocator, config: Config) Suite {10        return .{ .alloc = alloc, .default_config = config };11    }1213    pub fn deinit(self: *Suite) void {14        for (self.results.items) |result| {15            self.alloc.free(result.samples);16            self.alloc.free(result.sample_total_ns);17        }18        self.results.deinit(self.alloc);19        self.benchmarks.deinit(self.alloc);20    }2122    pub fn add(self: *Suite, name: []const u8, func: BenchFn, override: anytype) !void {23        try self.benchmarks.append(self.alloc, .{24            .name = name,25            .func = func,26            .config = applyConfigOverride(self.default_config, override),27        });28    }2930    pub fn setFilter(self: *Suite, filter: ?[]const u8) void {31        self.filter = filter;32    }3334    pub fn run(self: *Suite) !void {35        try self.runWithOptions(.{});36    }3738    pub fn runWithOptions(self: *Suite, options: RunOptions) !void {39        const clock_probe = try timing.probeClock();40        self.clock_probe = clock_probe;41        var coz_env = try CozEnv.read(self.alloc);42        defer coz_env.deinit(self.alloc);43        var tracy_env = try TracyEnv.read(self.alloc);44        defer tracy_env.deinit(self.alloc);45        var control_env = try ControlEnv.read(self.alloc);46        defer control_env.deinit(self.alloc);47        var coz_session: instrumentation.CozSession = .{};48        try startCozSession(self.alloc, &coz_session, coz_env);49        defer coz_session.deinit();50        var tracy_session: instrumentation.ProfilingSession = .{};51        try startTracySession(self.alloc, &tracy_session, tracy_env, self.default_config.suite_name);52        defer tracy_session.deinit();53        var memtrace_session: MemtraceSession = .{};54        try memtrace_session.start(self.alloc);55        defer memtrace_session.deinit(self.alloc);56        var executed: usize = 0;5758        tracy.setThreadName("tiny-bench");59        tracy.appInfo("tiny benchmark harness");60        {61            const suite_phase = phaseAt("bench.suite.run", @src());62            defer suite_phase.end();6364            if (options.write_stdout) try output.writeHeader();6566            for (self.benchmarks.items) |def| {67                if (!matchesFilter(def.name, self.filter)) continue;68                if (!matchesFilter(def.name, control_env.filter)) continue;69                const result = try runOne(70                    self.alloc,71                    memtrace_session.sampleAllocator(),72                    memtrace_session.tracerPtr(),73                    controlledDefinition(def, control_env),74                    clock_probe,75                );76                executed += 1;77                try self.results.append(self.alloc, result);78                if (options.write_stdout) try output.writeResult(result);79            }8081            if (options.write_stdout) try output.writeStdoutDoc(pretty.hardline);82        }83        if (options.write_env_jsonl) try self.writeEnvJsonlFile();84        try finishInstrumentation(85            self.alloc,86            executed,87            &memtrace_session,88            &coz_session,89            coz_env,90            &tracy_session,91            tracy_env,92        );93    }9495    pub fn runSilent(self: *Suite) ![]const Result {96        const clock_probe = try timing.probeClock();97        self.clock_probe = clock_probe;98        var coz_env = try CozEnv.read(self.alloc);99        defer coz_env.deinit(self.alloc);100        var tracy_env = try TracyEnv.read(self.alloc);101        defer tracy_env.deinit(self.alloc);102        var control_env = try ControlEnv.read(self.alloc);103        defer control_env.deinit(self.alloc);104        var coz_session: instrumentation.CozSession = .{};105        try startCozSession(self.alloc, &coz_session, coz_env);106        defer coz_session.deinit();107        var tracy_session: instrumentation.ProfilingSession = .{};108        try startTracySession(self.alloc, &tracy_session, tracy_env, self.default_config.suite_name);109        defer tracy_session.deinit();110        var memtrace_session: MemtraceSession = .{};111        try memtrace_session.start(self.alloc);112        defer memtrace_session.deinit(self.alloc);113        var executed: usize = 0;114115        tracy.setThreadName("tiny-bench");116        tracy.appInfo("tiny benchmark harness");117        {118            const suite_phase = phaseAt("bench.suite.run_silent", @src());119            defer suite_phase.end();120121            for (self.benchmarks.items) |def| {122                if (!matchesFilter(def.name, self.filter)) continue;123                if (!matchesFilter(def.name, control_env.filter)) continue;124                const result = try runOne(125                    self.alloc,126                    memtrace_session.sampleAllocator(),127                    memtrace_session.tracerPtr(),128                    controlledDefinition(def, control_env),129                    clock_probe,130                );131                executed += 1;132                try self.results.append(self.alloc, result);133            }134        }135        try finishInstrumentation(136            self.alloc,137            executed,138            &memtrace_session,139            &coz_session,140            coz_env,141            &tracy_session,142            tracy_env,143        );144        return self.results.items;145    }146147    pub fn writeJsonl(self: *const Suite, writer: *std.Io.Writer, options: JsonlOptions) !void {148        try writeJsonlStart(self, writer, options);149        for (self.results.items) |result| try writeJsonlResult(writer, options, result);150        try event.writeRunEnd(writer, .{151            .benches = @intCast(self.results.items.len),152            .errors = 0,153        });154    }155156    pub fn writeJsonlFile(self: *const Suite, path: []const u8, options: JsonlOptions) !void {157        try ensureParent(path);158        var file = try sys.fs.createFile(path, .{ .truncate = true });159        defer file.close(sys.fs.debugIo());160161        var buffer: [8192]u8 = undefined;162        var writer = file.writer(sys.fs.debugIo(), &buffer);163        try self.writeJsonl(&writer.interface, withOutputPath(options, path));164        try writer.interface.flush();165    }166167    pub fn appendJsonlFile(self: *const Suite, path: []const u8, options: JsonlOptions) !void {168        try ensureParent(path);169        var out = std.Io.Writer.Allocating.init(self.alloc);170        defer out.deinit();171        try self.writeJsonl(&out.writer, withOutputPath(options, path));172        try sys.fs.appendFile(path, &.{out.written()});173    }174175    fn writeEnvJsonlFile(self: *const Suite) !void {176        const path = try sys.env.getOwned(self.alloc, jsonl_output_env);177        defer if (path) |actual| self.alloc.free(actual);178        if (path) |actual| try self.appendJsonlFile(actual, .{ .suite_name = self.default_config.suite_name });179    }180};

Source: lib/bench/src/root.zig:126

1pub const Suite = suite.Suite;

Static calls · unresolved targets: 1 · external targets: 0.

Static calls · unresolved targets: 0 · external targets: 3.

Static calls · unresolved targets: 1 · external targets: 1.

Static calls · unresolved targets: 0 · external targets: 0.

Static calls · unresolved targets: 1 · external targets: 6.

Static calls · unresolved targets: 0 · external targets: 0.

Static calls · unresolved targets: 1 · external targets: 1.

Static calls · unresolved targets: 1 · external targets: 4.

Complete caller list for `Suite.add`

22 direct callers.

Complete caller list for `Suite.deinit`

22 direct callers.

Complete caller list for `Suite.init`

22 direct callers.

Complete caller list for `Suite.runSilent`

20 direct callers.

Complete call list for `Suite.runSilent`

17 direct calls.

Complete call list for `Suite.runWithOptions`

21 direct calls.

Audit

Definitions	11
Public names	11
Members	6
Version	`26.7.0`
Revision	`daab053ee433`

tiny.bench.Suite

API (16)

Actions

Fields and members

Source

Complete caller list for Suite.add

Complete caller list for Suite.deinit

Complete caller list for Suite.init

Complete caller list for Suite.runSilent

Complete call list for Suite.runSilent

Complete call list for Suite.runWithOptions

Audit

`tiny.bench.Suite`

Complete caller list for `Suite.add`

Complete caller list for `Suite.deinit`

Complete caller list for `Suite.init`

Complete caller list for `Suite.runSilent`

Complete call list for `Suite.runSilent`

Complete call list for `Suite.runWithOptions`