chore: update to Zig 0.15.1

Author: tensorush

.github/workflows/cd.yaml

@@ -5,28 +5,28 @@ on:
     workflows: [CI]
     types: [completed]
 
-  workflow_dispatch:
+concurrency:
+  group: cd
+  cancel-in-progress: true
 
 jobs:
   emit:
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    if: ${{ github.event.workflow_run.event == 'push' && github.event.workflow_run.conclusion == 'success' }}
 
     runs-on: ubuntu-latest
 
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Zig
-        uses: mlugg/setup-zig@v1
-        with:
-          version: master
+        uses: mlugg/setup-zig@v2
 
-      - name: Run doc step
+      - name: Run `doc` step
         run: zig build doc
 
       - name: Upload artifact for GitHub Pages
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@v4
         with:
           path: zig-out/docs/
 

.github/workflows/ci.yaml

@@ -7,35 +7,33 @@ on:
   pull_request:
     branches: [main]
 
-  workflow_dispatch:
+concurrency:
+  group: ci
+  cancel-in-progress: true
 
 jobs:
   test:
     runs-on: ubuntu-latest
 
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Zig
-        uses: mlugg/setup-zig@v1
-        with:
-          version: master
+        uses: mlugg/setup-zig@v2
 
-      - name: Run test step
+      - name: Run `test` step
         run: zig build test --summary all
 
   fmt:
     runs-on: ubuntu-latest
 
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Zig
-        uses: mlugg/setup-zig@v1
-        with:
-          version: master
+        uses: mlugg/setup-zig@v2
 
-      - name: Run fmt step
+      - name: Run `fmt` step
         run: zig build fmt

README.md

@@ -4,13 +4,13 @@
 
 ### Usage
 
-- Add `sieve` dependency to `build.zig.zon`.
+1. Add `sieve` dependency to `build.zig.zon`:
 
 ```sh
-zig fetch --save git+https://github.com/tensorush/zig-sieve
+zig fetch --save git+https://github.com/tensorush/zig-sieve.git
 ```
 
-- Use `sieve` dependency in `build.zig`.
+2. Use `sieve` dependency in `build.zig`:
 
 ```zig
 const sieve_dep = b.dependency("sieve", .{
@@ -23,23 +23,23 @@ const sieve_mod = sieve_dep.module("sieve");
 
 ### Benchmarks (MacBook M1 Pro)
 
-- Sequence: the time to cache and retrieve integer values.
+- Sequence - the time to cache and retrieve integer values:
 
-    ```sh
-    $ zig build bench -- -s
-    Sequence: 23.042us
-    ```
+```sh
+$ zig build bench -- s
+Sequence: 22.958us
+```
 
-- Composite: the time to cache and retrieve composite values.
+- Composite - the time to cache and retrieve composite values:
 
-    ```sh
-    $ zig build bench -- -c
-    Composite: 33.417us
-    ```
+```sh
+$ zig build bench -- c
+Composite: 37.668us
+```
 
-- Composite (normal): the time to cache and retrieve normally-distributed composite values.
+- Composite (normal) - the time to cache and retrieve normally-distributed composite values:
 
-    ```sh
-    $ zig build bench -- -n
-    Composite Normal: 99.708us
-    ```
+```sh
+$ zig build bench -- n
+Composite Normal: 108.001us
+```

build.zig

@@ -1,41 +1,39 @@
 const std = @import("std");
 
-pub fn build(b: *std.Build) void {
+const manifest = @import("build.zig.zon");
+
+pub fn build(b: *std.Build) !void {
     const install_step = b.getInstallStep();
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});
     const root_source_file = b.path("src/root.zig");
-    const version = std.SemanticVersion{ .major = 0, .minor = 1, .patch = 1 };
+    const version: std.SemanticVersion = try .parse(manifest.version);
 
-    // Module
-    const mod = b.addModule("sieve", .{
+    // Public root module
+    const root_mod = b.addModule("sieve", .{
         .target = target,
         .optimize = optimize,
         .root_source_file = root_source_file,
+        .strip = b.option(bool, "strip", "Strip the binary"),
     });
 
     // Library
-    const lib_step = b.step("lib", "Install library");
-
     const lib = b.addLibrary(.{
         .name = "sieve",
         .version = version,
-        .root_module = mod,
+        .root_module = root_mod,
     });
-
-    const lib_install = b.addInstallArtifact(lib, .{});
-    lib_step.dependOn(&lib_install.step);
-    install_step.dependOn(lib_step);
+    b.installArtifact(lib);
 
     // Documentation
     const docs_step = b.step("doc", "Emit documentation");
+
     const docs_install = b.addInstallDirectory(.{
         .install_dir = .prefix,
         .install_subdir = "docs",
         .source_dir = lib.getEmittedDocs(),
     });
     docs_step.dependOn(&docs_install.step);
-    install_step.dependOn(docs_step);
 
     // Benchmarks
     const benchs_step = b.step("bench", "Run benchmarks");
@@ -60,11 +58,7 @@ pub fn build(b: *std.Build) void {
     const tests_step = b.step("test", "Run test suite");
 
     const tests = b.addTest(.{
-        .version = version,
-        .root_module = b.createModule(.{
-            .target = target,
-            .root_source_file = root_source_file,
-        }),
+        .root_module = root_mod,
     });
 
     const tests_run = b.addRunArtifact(tests);
@@ -84,4 +78,14 @@ pub fn build(b: *std.Build) void {
     });
     fmt_step.dependOn(&fmt.step);
     install_step.dependOn(fmt_step);
+
+    // Compilation check for ZLS Build-On-Save
+    // See: https://zigtools.org/zls/guides/build-on-save/
+    const check_step = b.step("check", "Check compilation");
+    const check_exe = b.addExecutable(.{
+        .name = "sieve",
+        .version = version,
+        .root_module = root_mod,
+    });
+    check_step.dependOn(&check_exe.step);
 }

build.zig.zon

@@ -1,8 +1,8 @@
 .{
     .name = .sieve,
-    .fingerprint = 0x34df97e7ea21fbe6,
-    .version = "0.1.1",
-    .minimum_zig_version = "0.14.0",
+    .version = "0.2.0",
+    .fingerprint = 0x34df97e7ea21fbe6, // Changing this has security and trust implications.
+    .minimum_zig_version = "0.15.1",
     .paths = .{
         "src/",
         "build.zig",

src/bench.zig

@@ -1,47 +1,47 @@
 const std = @import("std");
+
 const sieve = @import("sieve.zig");
 
-const MEAN: f64 = 50.0;
-const ARRAY_SIZE: u64 = 12;
-const NUM_ITERS: u64 = 1000;
-const CACHE_CAPACITY: u64 = 68;
-const STD_DEV: f64 = MEAN / 3.0;
+const MEAN = 50.0;
+const ARRAY_SIZE = 12;
+const NUM_ITERS = 1000;
+const CACHE_CAPACITY = 68;
+const STD_DEV = MEAN / 3.0;
+const MAX_BUF_SIZE = 1 << 12;
 
 pub fn main() !void {
-    var gpa_state = std.heap.DebugAllocator(.{}){};
+    var gpa_state: std.heap.DebugAllocator(.{}) = .init;
     const gpa = gpa_state.allocator();
-    defer if (gpa_state.deinit() == .leak) {
-        @panic("Memory leak has occurred!");
-    };
+    defer if (gpa_state.deinit() == .leak) @panic("Memory leaked!");
 
-    const std_out = std.io.getStdOut();
-    var buf_writer = std.io.bufferedWriter(std_out.writer());
-    const writer = buf_writer.writer();
+    var stdout_buf: [MAX_BUF_SIZE]u8 = undefined;
+    var stdout_writer = std.fs.File.stdout().writer(&stdout_buf);
+    const writer = &stdout_writer.interface;
 
-    var prng = std.Random.DefaultPrng.init(blk: {
+    var prng: std.Random.DefaultPrng = .init(blk: {
         var seed: u64 = undefined;
         try std.posix.getrandom(std.mem.asBytes(&seed));
         break :blk seed;
     });
     const random = prng.random();
 
-    var buf: [512]u8 = undefined;
-    var fixed_buf = std.heap.FixedBufferAllocator.init(buf[0..]);
+    var buf: [MAX_BUF_SIZE]u8 = undefined;
+    var fixed_buf: std.heap.FixedBufferAllocator = .init(&buf);
     const args = try std.process.argsAlloc(fixed_buf.allocator());
 
-    switch (args[1][1]) {
+    switch (args[1][0]) {
         's' => try benchmarkSequence(gpa, writer),
         'c' => try benchmarkComposite(gpa, random, writer),
         'n' => try benchmarkCompositeNormal(gpa, random, writer),
         else => @panic("Unknown benchmark!"),
     }
 
-    try buf_writer.flush();
+    try writer.flush();
 }
 
 fn benchmarkSequence(gpa: std.mem.Allocator, writer: anytype) !void {
     const Cache = sieve.Cache(u64, u64);
-    var cache = try Cache.init(gpa, CACHE_CAPACITY);
+    var cache: Cache = try .init(gpa, CACHE_CAPACITY);
     defer cache.deinit(gpa);
 
     var timer = try std.time.Timer.start();
@@ -62,12 +62,12 @@ fn benchmarkSequence(gpa: std.mem.Allocator, writer: anytype) !void {
         _ = cache.get(num);
     }
 
-    try writer.print("Sequence: {}\n", .{std.fmt.fmtDuration(timer.read() - start)});
+    try writer.print("Sequence: {D}\n", .{timer.read() - start});
 }
 
 fn benchmarkComposite(gpa: std.mem.Allocator, random: std.Random, writer: anytype) !void {
     const Cache = sieve.Cache(u64, struct { [ARRAY_SIZE]u8, u64 });
-    var cache = try Cache.init(gpa, CACHE_CAPACITY);
+    var cache: Cache = try .init(gpa, CACHE_CAPACITY);
     defer cache.deinit(gpa);
 
     var timer = try std.time.Timer.start();
@@ -79,7 +79,7 @@ fn benchmarkComposite(gpa: std.mem.Allocator, random: std.Random, writer: anytyp
     while (i < NUM_ITERS) : (i += 1) {
         num = random.uintLessThan(u64, 100);
         node = try gpa.create(Cache.Node);
-        node.* = .{ .key = num, .value = .{ [1]u8{0} ** ARRAY_SIZE, num } };
+        node.* = .{ .key = num, .value = .{ @splat(0), num } };
         _ = try cache.put(node);
     }
 
@@ -88,12 +88,12 @@ fn benchmarkComposite(gpa: std.mem.Allocator, random: std.Random, writer: anytyp
         _ = cache.get(num);
     }
 
-    try writer.print("Composite: {}\n", .{std.fmt.fmtDuration(timer.read() - start)});
+    try writer.print("Composite: {D}\n", .{timer.read() - start});
 }
 
 fn benchmarkCompositeNormal(gpa: std.mem.Allocator, random: std.Random, writer: anytype) !void {
     const Cache = sieve.Cache(u64, struct { [ARRAY_SIZE]u8, u64 });
-    var cache = try Cache.init(gpa, @intFromFloat(STD_DEV));
+    var cache: Cache = try .init(gpa, @intFromFloat(STD_DEV));
     defer cache.deinit(gpa);
 
     var timer = try std.time.Timer.start();
@@ -106,7 +106,7 @@ fn benchmarkCompositeNormal(gpa: std.mem.Allocator, random: std.Random, writer:
         num = @intFromFloat(random.floatNorm(f64) * STD_DEV + MEAN);
         num %= 100;
         node = try gpa.create(Cache.Node);
-        node.* = .{ .key = num, .value = .{ [1]u8{0} ** ARRAY_SIZE, num } };
+        node.* = .{ .key = num, .value = .{ @splat(0), num } };
         _ = try cache.put(node);
     }
 
@@ -116,5 +116,5 @@ fn benchmarkCompositeNormal(gpa: std.mem.Allocator, random: std.Random, writer:
         _ = cache.get(num);
     }
 
-    try writer.print("Composite Normal: {}\n", .{std.fmt.fmtDuration(timer.read() - start)});
+    try writer.print("Composite Normal: {D}\n", .{timer.read() - start});
 }