├── .gitignore ├── LICENSE ├── README.md └── bench.zig /.gitignore: -------------------------------------------------------------------------------- 1 | zig-cache/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Goal 2 | 3 | zig-benchmark provides a minimal API to do micro-benchmarking. 4 | 5 | Everything it contains is very barebones compared to mature benchmarking frameworks, but usable nonetheless. 6 | 7 | # Features 8 | 9 | * easy to use 10 | * runs every micro-benchmark in fixed time 11 | * pre-warming, to get the caches ready 12 | * ugly text report 13 | 14 | # Example 15 | 16 | ## Simple 17 | 18 | ```zig 19 | const bench = @import("bench.zig"); 20 | 21 | fn longCompute(ctx: *bench.Context) void { 22 | while (ctx.run()) { 23 | // something you want to time 24 | } 25 | } 26 | 27 | pub fn main() void { 28 | bench.benchmark("longCompute", longCompute); 29 | } 30 | ``` 31 | 32 | ## With arguments 33 | 34 | ```zig 35 | const bench = @import("bench.zig"); 36 | 37 | fn longCompute(ctx: *bench.Context, x: u32) void { 38 | while (ctx.run()) { 39 | // something you want to time 40 | } 41 | } 42 | 43 | pub fn main() void { 44 | bench.benchmarkArgs("longCompute", longCompute, []const u32{ 1, 2, 3, 4 }); 45 | } 46 | ``` 47 | 48 | Works with `type`s as arguments, too. 49 | 50 | ## With explicit timing 51 | 52 | ```zig 53 | const bench = @import("bench.zig"); 54 | 55 | fn longCompute(ctx: *bench.Context) void { 56 | while (ctx.runExplicitTiming()) { 57 | // do some set-up 58 | 59 | ctx.startTimer(); 60 | // something you want to time 61 | ctx.stopTimer(); 62 | } 63 | } 64 | 65 | pub fn main() void { 66 | bench.benchmark("longCompute", longCompute); 67 | } 68 | ``` -------------------------------------------------------------------------------- /bench.zig: -------------------------------------------------------------------------------- 1 | // Copyright 2021 Antoine Vugliano 2 | 3 | const std = @import("std"); 4 | const assert = std.debug.assert; 5 | const time = std.time; 6 | const print = std.debug.print; 7 | 8 | const Timer = time.Timer; 9 | 10 | const BenchFn = fn (*Context) void; 11 | 12 | pub const Context = struct { 13 | timer: Timer, 14 | iter: u32, 15 | count: u32, 16 | state: State, 17 | nanoseconds: u64, 18 | 19 | const HeatingTime = time.ns_per_s / 2; 20 | const RunTime = time.ns_per_s * 2; 21 | 22 | const State = enum { 23 | None, 24 | Heating, 25 | Running, 26 | Finished, 27 | }; 28 | 29 | pub fn init() Context { 30 | return Context{ 31 | .timer = Timer.start() catch unreachable, 32 | .iter = 0, 33 | .count = 0, 34 | .state = .None, 35 | .nanoseconds = 0, 36 | }; 37 | } 38 | 39 | pub fn run(self: *Context) bool { 40 | switch (self.state) { 41 | .None => { 42 | self.state = .Heating; 43 | self.timer.reset(); 44 | return true; 45 | }, 46 | .Heating => { 47 | self.count += 1; 48 | const elapsed = self.timer.read(); 49 | if (elapsed >= HeatingTime) { 50 | // Caches should be hot 51 | self.count = @intCast(RunTime / (HeatingTime / self.count)); 52 | self.state = .Running; 53 | self.timer.reset(); 54 | } 55 | 56 | return true; 57 | }, 58 | .Running => { 59 | if (self.iter < self.count) { 60 | self.iter += 1; 61 | return true; 62 | } else { 63 | self.nanoseconds = self.timer.read(); 64 | self.state = .Finished; 65 | return false; 66 | } 67 | }, 68 | .Finished => unreachable, 69 | } 70 | } 71 | 72 | pub fn startTimer(self: *Context) void { 73 | self.timer.reset(); 74 | } 75 | 76 | pub fn stopTimer(self: *Context) void { 77 | const elapsed = self.timer.read(); 78 | self.nanoseconds += elapsed; 79 | } 80 | 81 | pub fn runExplicitTiming(self: *Context) bool { 82 | switch (self.state) { 83 | .None => { 84 | self.state = .Heating; 85 | return true; 86 | }, 87 | .Heating => { 88 | self.count += 1; 89 | if (self.nanoseconds >= HeatingTime) { 90 | // Caches should be hot 91 | self.count = @intCast(RunTime / (HeatingTime / self.count)); 92 | self.nanoseconds = 0; 93 | self.state = .Running; 94 | } 95 | 96 | return true; 97 | }, 98 | .Running => { 99 | if (self.iter < self.count) { 100 | self.iter += 1; 101 | return true; 102 | } else { 103 | self.state = .Finished; 104 | return false; 105 | } 106 | }, 107 | .Finished => unreachable, 108 | } 109 | } 110 | 111 | pub fn averageTime(self: *Context, unit: u64) f32 { 112 | assert(self.state == .Finished); 113 | return @as(f32, @floatFromInt(self.nanoseconds / unit)) / @as(f32, @floatFromInt(self.iter)); 114 | } 115 | }; 116 | 117 | pub fn benchmark(name: []const u8, comptime f: BenchFn) void { 118 | var ctx = Context.init(); 119 | @call(.never_inline, f, .{&ctx}); 120 | 121 | var unit: u64 = undefined; 122 | var unit_name: []const u8 = undefined; 123 | const avg_time = ctx.averageTime(1); 124 | assert(avg_time >= 0); 125 | 126 | if (avg_time <= time.ns_per_us) { 127 | unit = 1; 128 | unit_name = "ns"; 129 | } else if (avg_time <= time.ns_per_ms) { 130 | unit = time.ns_per_us; 131 | unit_name = "us"; 132 | } else { 133 | unit = time.ns_per_ms; 134 | unit_name = "ms"; 135 | } 136 | 137 | print("{s}: avg {d:.3}{s} ({d} iterations)\n", .{ name, ctx.averageTime(unit), unit_name, ctx.iter }); 138 | } 139 | 140 | fn benchArgFn(comptime argType: type) type { 141 | return fn (*Context, argType) void; 142 | } 143 | 144 | fn argTypeFromFn(comptime f: anytype) type { 145 | const F = @TypeOf(f); 146 | if (@typeInfo(F) != .Fn) { 147 | @compileError("Argument must be a function."); 148 | } 149 | 150 | const fnInfo = @typeInfo(F).Fn; 151 | if (fnInfo.params.len != 2) { 152 | @compileError("Only functions taking 1 argument are accepted."); 153 | } 154 | 155 | return fnInfo.params[1].type.?; 156 | } 157 | 158 | pub fn benchmarkArgs(comptime name: []const u8, comptime f: anytype, comptime args: []const argTypeFromFn(f)) void { 159 | inline for (args) |arg| { 160 | var ctx = Context.init(); 161 | @call(.never_inline, f, .{ &ctx, arg }); 162 | 163 | var unit: u64 = undefined; 164 | var unit_name: []const u8 = undefined; 165 | const avg_time = ctx.averageTime(1); 166 | assert(avg_time >= 0); 167 | 168 | if (avg_time <= time.ns_per_us) { 169 | unit = 1; 170 | unit_name = "ns"; 171 | } else if (avg_time <= time.ns_per_ms) { 172 | unit = time.ns_per_us; 173 | unit_name = "us"; 174 | } else { 175 | unit = time.ns_per_ms; 176 | unit_name = "ms"; 177 | } 178 | 179 | const typeOfArg = @TypeOf(arg); 180 | if (typeOfArg == type) { 181 | print("{s} <{s}>: avg {d:.3}{s} ({d} iterations)\n", .{ 182 | name, 183 | @typeName(arg), 184 | ctx.averageTime(unit), 185 | unit_name, 186 | ctx.iter, 187 | }); 188 | } else { 189 | print("{s} <{any}>: avg {d:.3}{s} ({d} iterations)\n", .{ 190 | name, 191 | arg, 192 | ctx.averageTime(unit), 193 | unit_name, 194 | ctx.iter, 195 | }); 196 | } 197 | } 198 | } 199 | 200 | pub fn doNotOptimize(value: anytype) void { 201 | // LLVM triggers an assert if we pass non-trivial types as inputs for the 202 | // asm volatile expression. 203 | // Workaround until asm support is better on Zig's end. 204 | const T = @TypeOf(value); 205 | switch (T) { 206 | .Bool, .Int, .Float => { 207 | asm volatile ("" 208 | : 209 | : [_] "r,m" (value), 210 | : "memory" 211 | ); 212 | }, 213 | .Optional => { 214 | if (value) |v| doNotOptimize(v); 215 | }, 216 | .Struct => { 217 | inline for (comptime std.meta.fields(T)) |field| { 218 | doNotOptimize(@field(value, field.name)); 219 | } 220 | }, 221 | .Type, 222 | .Void, 223 | .NoReturn, 224 | .ComptimeFloat, 225 | .ComptimeInt, 226 | .Undefined, 227 | .Null, 228 | .Fn, 229 | .BoundFn, 230 | => @compileError("doNotOptimize makes no sense for " ++ @tagName(T)), 231 | else => @compileError("doNotOptimize is not implemented for " ++ @tagName(T)), 232 | } 233 | } 234 | 235 | pub fn clobberMemory() void { 236 | asm volatile ("" ::: "memory"); 237 | } 238 | 239 | const ENABLE_TESTS = true; 240 | 241 | test "benchmark" { 242 | if (!ENABLE_TESTS) return error.SkipZigTest; 243 | 244 | const benchSleep57 = struct { 245 | fn benchSleep57(ctx: *Context) void { 246 | while (ctx.run()) { 247 | time.sleep(57 * time.ns_per_ms); 248 | } 249 | } 250 | }.benchSleep57; 251 | 252 | benchmark("Sleep57", benchSleep57); 253 | } 254 | 255 | test "benchmarkArgs" { 256 | if (!ENABLE_TESTS) return error.SkipZigTest; 257 | 258 | const benchSleep = struct { 259 | fn benchSleep(ctx: *Context, ms: u32) void { 260 | while (ctx.run()) { 261 | time.sleep(ms * time.ns_per_ms); 262 | } 263 | } 264 | }.benchSleep; 265 | 266 | benchmarkArgs("Sleep", benchSleep, &[_]u32{ 20, 30, 57 }); 267 | } 268 | 269 | test "benchmarkArgs types" { 270 | if (!ENABLE_TESTS) return error.SkipZigTest; 271 | 272 | const benchMin = struct { 273 | fn benchMin(ctx: *Context, comptime intType: type) void { 274 | while (ctx.run()) { 275 | const a = @as(intType, 37); 276 | const b = @as(intType, 48); 277 | time.sleep(@min(a, b) * @as(intType, time.ns_per_ms)); 278 | } 279 | } 280 | }.benchMin; 281 | 282 | benchmarkArgs("Min", benchMin, &[_]type{ u32, u64 }); 283 | } 284 | 285 | test "benchmark custom timing" { 286 | if (!ENABLE_TESTS) return error.SkipZigTest; 287 | 288 | const sleep = struct { 289 | fn sleep(ctx: *Context) void { 290 | while (ctx.runExplicitTiming()) { 291 | time.sleep(30 * time.ns_per_ms); 292 | ctx.startTimer(); 293 | defer ctx.stopTimer(); 294 | time.sleep(10 * time.ns_per_ms); 295 | } 296 | } 297 | }.sleep; 298 | 299 | benchmark("sleep", sleep); 300 | } 301 | --------------------------------------------------------------------------------