feat: update to Zig v0.13.0

.gitignore

@@ -1,2 +1,3 @@
 zig-cache/
+.zig-cache/
 zig-out/

build.zig

@@ -15,33 +15,21 @@ pub fn build(b: *std.Build) void {
     // set a preferred release mode, allowing the user to decide how to optimize.
     const optimize = b.standardOptimizeOption(.{});
 
-    const lib = b.addStaticLibrary(.{
+    _ = b.addModule("zba-util", .{ .root_source_file = b.path("src/lib.zig") });
-        .name = "zba-util",
-        // In this case the main source file is merely a path, however, in more
-        // complicated build scripts, this could be a generated file.
-        .root_source_file = .{ .path = "src/lib.zig" },
-        .target = target,
-        .optimize = optimize,
-    });
-
-    // This declares intent for the library to be installed into the standard
-    // location when the user invokes the "install" step (the default step when
-    // running `zig build`).
-    b.installArtifact(lib);
 
     // Creates a step for unit testing. This only builds the test executable
     // but does not run it.
-    const main_tests = b.addTest(.{
+    const lib_unit_tests = b.addTest(.{
-        .root_source_file = .{ .path = "src/lib.zig" },
+        .root_source_file = b.path("src/lib.zig"),
         .target = target,
         .optimize = optimize,
     });
 
-    const run_main_tests = b.addRunArtifact(main_tests);
+    const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests);
 
-    // This creates a build step. It will be visible in the `zig build --help` menu,
+    // Similar to creating the run step earlier, this exposes a `test` step to
-    // and can be selected like this: `zig build test`
+    // the `zig build --help` menu, providing a way for the user to request
-    // This will evaluate the `test` step rather than the default, which is "install".
+    // running the unit tests.
-    const test_step = b.step("test", "Run library tests");
+    const test_step = b.step("test", "Run unit tests");
-    test_step.dependOn(&run_main_tests.step);
+    test_step.dependOn(&run_lib_unit_tests.step);
 }

build.zig.zon

@@ -0,0 +1,72 @@
+.{
+    // This is the default name used by packages depending on this one. For
+    // example, when a user runs `zig fetch --save <url>`, this field is used
+    // as the key in the `dependencies` table. Although the user can choose a
+    // different name, most users will stick with this provided value.
+    //
+    // It is redundant to include "zig" in this name because it is already
+    // within the Zig package namespace.
+    .name = "zba-util",
+
+    // This is a [Semantic Version](https://semver.org/).
+    // In a future version of Zig it will be used for package deduplication.
+    .version = "0.1.0",
+
+    // This field is optional.
+    // This is currently advisory only; Zig does not yet do anything
+    // with this value.
+    //.minimum_zig_version = "0.11.0",
+
+    // This field is optional.
+    // Each dependency must either provide a `url` and `hash`, or a `path`.
+    // `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
+    // Once all dependencies are fetched, `zig build` no longer requires
+    // internet connectivity.
+    .dependencies = .{
+        // See `zig fetch --save <url>` for a command-line interface for adding dependencies.
+        //.example = .{
+        //    // When updating this field to a new URL, be sure to delete the corresponding
+        //    // `hash`, otherwise you are communicating that you expect to find the old hash at
+        //    // the new URL.
+        //    .url = "https://example.com/foo.tar.gz",
+        //
+        //    // This is computed from the file contents of the directory of files that is
+        //    // obtained after fetching `url` and applying the inclusion rules given by
+        //    // `paths`.
+        //    //
+        //    // This field is the source of truth; packages do not come from a `url`; they
+        //    // come from a `hash`. `url` is just one of many possible mirrors for how to
+        //    // obtain a package matching this `hash`.
+        //    //
+        //    // Uses the [multihash](https://multiformats.io/multihash/) format.
+        //    .hash = "...",
+        //
+        //    // When this is provided, the package is found in a directory relative to the
+        //    // build root. In this case the package's hash is irrelevant and therefore not
+        //    // computed. This field and `url` are mutually exclusive.
+        //    .path = "foo",
+
+        //    // When this is set to `true`, a package is declared to be lazily
+        //    // fetched. This makes the dependency only get fetched if it is
+        //    // actually used.
+        //    .lazy = false,
+        //},
+    },
+
+    // Specifies the set of files and directories that are included in this package.
+    // Only files and directories listed here are included in the `hash` that
+    // is computed for this package. Only files listed here will remain on disk
+    // when using the zig package manager. As a rule of thumb, one should list
+    // files required for compilation plus any license(s).
+    // Paths are relative to the build root. Use the empty string (`""`) to refer to
+    // the build root itself.
+    // A directory listed here means that all files within, recursively, are included.
+    .paths = .{
+        "build.zig",
+        "build.zig.zon",
+        "src",
+        // For example...
+        //"LICENSE",
+        //"README.md",
+    },
+}

src/lib.zig

@@ -2,186 +2,6 @@ const std = @import("std");
 const Log2Int = std.math.Log2Int;
 const Allocator = std.mem.Allocator;
 
-// TODO: Rewrite
-// pub const TwoWayChannel = struct {
-//     const Self = @This();
-
-//     emu: Channel(EmuMessage),
-//     gui: Channel(GuiMessage),
-
-//     pub fn init(items: []u8) Self {
-//         comptime std.debug.assert(@sizeOf(EmuMessage) == @sizeOf(GuiMessage));
-//         comptime std.debug.assert(@sizeOf(@typeInfo([]u8).Pointer.child) == @sizeOf(EmuMessage));
-
-//         std.debug.assert(items.len % 2 == 0);
-
-//         const left = @ptrCast([*]EmuMessage, items)[0 .. items.len / 2];
-//         const right = @ptrCast([*]GuiMessage, items)[items.len / 2 .. items.len];
-
-//         return .{ .emu = Channel(EmuMessage).init(left), .gui = Channel(GuiMessage).init(right) };
-//     }
-// };
-
-pub fn Channel(comptime T: type, comptime N: usize) type {
-    return struct {
-        const Index = usize;
-        const capacity_limit = (@as(Index, 1) << @typeInfo(Index).Int.bits - 1) - 1; // half the range of index type
-
-        tx: Sender,
-        rx: Receiver,
-
-        pub const Sender = struct {
-            const Self = @This();
-
-            read: *Index,
-            write: *Index,
-            ptr: *[N]T,
-
-            const Error = error{buffer_full};
-
-            pub fn send(self: Self, value: T) void {
-                const idx_r = @atomicLoad(Index, self.read, .Acquire);
-                const idx_w = @atomicLoad(Index, self.write, .Acquire);
-
-                // Check to see if Queue is full
-                if (idx_w - idx_r == N) @panic("Channel: Buffer is full");
-
-                self.ptr[mask(idx_w)] = value;
-
-                std.atomic.fence(.Release);
-                @atomicStore(Index, self.write, idx_w + 1, .Release);
-            }
-
-            pub fn len(self: Self) Index {
-                const idx_r = @atomicLoad(Index, self.read, .Acquire);
-                const idx_w = @atomicLoad(Index, self.write, .Acquire);
-
-                return idx_w - idx_r;
-            }
-        };
-
-        pub const Receiver = struct {
-            const Self = @This();
-
-            read: *Index,
-            write: *Index,
-            ptr: *[N]T,
-
-            pub fn recv(self: Self) ?T {
-                const idx_r = @atomicLoad(Index, self.read, .Acquire);
-                const idx_w = @atomicLoad(Index, self.write, .Acquire);
-
-                if (idx_r == idx_w) return null;
-
-                std.atomic.fence(.Acquire);
-                const value = self.ptr[mask(idx_r)];
-
-                std.atomic.fence(.Release);
-                @atomicStore(Index, self.read, idx_r + 1, .Release);
-
-                return value;
-            }
-
-            pub fn peek(self: Self) ?T {
-                const idx_r = @atomicLoad(Index, self.read, .Acquire);
-                const idx_w = @atomicLoad(Index, self.write, .Acquire);
-
-                if (idx_r == idx_w) return null;
-
-                std.atomic.fence(.Acquire);
-                return self.ptr[mask(idx_r)];
-            }
-
-            pub fn len(self: Self) Index {
-                const idx_r = @atomicLoad(Index, self.read, .Acquire);
-                const idx_w = @atomicLoad(Index, self.write, .Acquire);
-
-                return idx_w - idx_r;
-            }
-        };
-
-        fn mask(idx: Index) Index {
-            return idx & (@intCast(Index, N) - 1);
-        }
-
-        pub fn init(allocator: Allocator) !Channel(T, N) {
-            const buf = try allocator.alloc(T, N);
-            const indicies = try allocator.alloc(Index, 2);
-
-            return .{
-                .tx = Sender{
-                    .ptr = buf[0..N],
-                    .read = &indicies[0],
-                    .write = &indicies[1],
-                },
-                .rx = Receiver{
-                    .ptr = buf[0..N],
-                    .read = &indicies[0],
-                    .write = &indicies[1],
-                },
-            };
-        }
-
-        pub fn deinit(self: *Channel(T, N), allocator: Allocator) void {
-            const indicies: []Index = @ptrCast([*]Index, self.tx.read)[0..2];
-
-            allocator.free(indicies);
-            allocator.free(self.tx.ptr);
-
-            self.* = undefined;
-        }
-
-        comptime {
-            std.debug.assert(std.math.isPowerOfTwo(N));
-            std.debug.assert(N <= capacity_limit);
-        }
-    };
-}
-
-test "Channel init + deinit" {
-    var ch = try Channel(u8, 64).init(std.testing.allocator);
-    defer ch.deinit(std.testing.allocator);
-}
-
-test "Channel basic queue" {
-    var ch = try Channel(u8, 64).init(std.testing.allocator);
-    defer ch.deinit(std.testing.allocator);
-
-    ch.tx.send(128);
-
-    try std.testing.expectEqual(@as(?u8, 128), ch.rx.recv());
-}
-
-test "Channel basic multithreaded" {
-    const builtin = @import("builtin");
-
-    if (builtin.single_threaded)
-        return error.SkipZigTest;
-
-    const run_tx = struct {
-        fn run(tx: anytype) void {
-            tx.send(128);
-        }
-    }.run;
-
-    const run_rx = struct {
-        fn run(rx: anytype) !void {
-            while (rx.recv()) |value| {
-                try std.testing.expectEqual(@as(?u8, 128), value);
-            }
-        }
-    }.run;
-
-    var ch = try Channel(u8, 64).init(std.testing.allocator);
-    defer ch.deinit(std.testing.allocator);
-
-    const tx_handle = try std.Thread.spawn(.{}, run_tx, .{&ch.tx});
-    defer tx_handle.join();
-
-    const rx_handle = try std.Thread.spawn(.{}, run_rx, .{&ch.rx});
-    defer rx_handle.join();
-}
-
 pub fn RingBuffer(comptime T: type) type {
     return struct {
         const Self = @This();
@@ -200,8 +20,6 @@ pub fn RingBuffer(comptime T: type) type {
             std.debug.assert(std.math.isPowerOfTwo(buf.len)); // capacity must be a power of two
             std.debug.assert(buf.len <= max_capacity);
 
-            @memset(buf, 0);
-
             return .{ .read = 0, .write = 0, .buf = buf };
         }
 
@@ -221,7 +39,7 @@ pub fn RingBuffer(comptime T: type) type {
 
         /// Returns the number of entries read
         pub fn copy(self: *const Self, cpy: []T) Index {
-            const count = std.math.min(self.len(), cpy.len);
+            const count = @min(self.len(), cpy.len);
             var start: Index = self.read;
 
             for (cpy, 0..) |*v, i| {
@@ -259,9 +77,9 @@ pub fn sext(comptime T: type, comptime U: type, value: T) T {
 
     const iT = std.meta.Int(.signed, @typeInfo(T).Int.bits);
     const ExtU = if (@typeInfo(U).Int.signedness == .unsigned) T else iT;
-    const shift_amt = @intCast(Log2Int(T), @typeInfo(T).Int.bits - @typeInfo(U).Int.bits);
+    const shift_amt: Log2Int(T) = @intCast(@typeInfo(T).Int.bits - @typeInfo(U).Int.bits);
 
-    return @bitCast(T, @bitCast(iT, @as(ExtU, @truncate(U, value)) << shift_amt) >> shift_amt);
+    return @bitCast(@as(iT, @bitCast(@as(ExtU, @as(U, @truncate(value))) << shift_amt)) >> shift_amt);
 }
 
 /// See https://godbolt.org/z/W3en9Eche
@@ -269,6 +87,10 @@ pub inline fn rotr(comptime T: type, x: T, r: anytype) T {
     if (@typeInfo(T).Int.signedness == .signed)
         @compileError("cannot rotate signed integer");
 
-    const ar = @intCast(Log2Int(T), @mod(r, @typeInfo(T).Int.bits));
+    const ar: Log2Int(T) = @intCast(@mod(r, @typeInfo(T).Int.bits));
     return x >> ar | x << (1 +% ~ar);
 }
+
+pub inline fn alignAddr(comptime T: type, address: u32) u32 {
+    return address & ~@as(u32, @sizeOf(T) - 1);
+}