Compare commits

...

8 Commits

4 changed files with 91 additions and 117 deletions

1
.gitignore vendored
View File

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

View File

@@ -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(.{
.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);
_ = b.addModule("zba-util", .{ .root_source_file = b.path("src/lib.zig") });
// Creates a step for unit testing. This only builds the test executable
// but does not run it.
const main_tests = b.addTest(.{
.root_source_file = .{ .path = "src/lib.zig" },
const lib_unit_tests = b.addTest(.{
.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,
// and can be selected like this: `zig build test`
// This will evaluate the `test` step rather than the default, which is "install".
const test_step = b.step("test", "Run library tests");
test_step.dependOn(&run_main_tests.step);
// Similar to creating the run step earlier, this exposes a `test` step to
// the `zig build --help` menu, providing a way for the user to request
// running the unit tests.
const test_step = b.step("test", "Run unit tests");
test_step.dependOn(&run_lib_unit_tests.step);
}

72
build.zig.zon Normal file
View File

@@ -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",
},
}

View File

@@ -1,95 +1,6 @@
const std = @import("std");
const Log2Int = std.math.Log2Int;
const EmuMessage = enum { Pause, Resume, Quit };
const GuiMessage = enum { Paused, Quit };
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) };
}
};
fn Channel(comptime T: type) type {
return struct {
const Self = @This();
const Index = usize;
const Atomic = std.atomic.Atomic;
const max_capacity = (@as(Index, 1) << @typeInfo(Index).Int.bits - 1) - 1; // half the range of index type
const log = std.log.scoped(.Channel);
read: Atomic(Index),
write: Atomic(Index),
buf: []T,
const Error = error{buffer_full};
pub fn init(buf: []T) Self {
std.debug.assert(std.math.isPowerOfTwo(buf.len)); // capacity must be a power of two
std.debug.assert(buf.len <= max_capacity);
return .{
.read = Atomic(Index).init(0),
.write = Atomic(Index).init(0),
.buf = buf,
};
}
pub fn push(self: *Self, value: T) void {
const read_idx = self.read.load(.Acquire);
const write_idx = self.write.load(.Acquire);
// Check to see if Queue is full
if (write_idx - read_idx == self.buf.len) @panic("Channel: Buffer is full");
self.buf[self.mask(write_idx)] = value;
std.atomic.fence(.Release);
self.write.store(write_idx + 1, .Release);
}
pub fn pop(self: *Self) ?T {
const read_idx = self.read.load(.Acquire);
const write_idx = self.write.load(.Acquire);
if (read_idx == write_idx) return null;
std.atomic.fence(.Acquire);
const value = self.buf[self.mask(read_idx)];
std.atomic.fence(.Release);
self.read.store(read_idx + 1, .Release);
return value;
}
pub fn len(self: *const Self) Index {
const read_idx = self.read.load(.Acquire);
const write_idx = self.write.load(.Acquire);
return write_idx - read_idx;
}
fn mask(self: *const Self, idx: Index) Index {
return idx & (self.buf.len - 1);
}
};
}
const Allocator = std.mem.Allocator;
pub fn RingBuffer(comptime T: type) type {
return struct {
@@ -109,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 };
}
@@ -130,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| {
@@ -168,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
@@ -178,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);
}