Merge pull request #28 from bernardassan/zig-0.15.1

Author: mookums

.github/workflows/ci.yaml

@@ -15,10 +15,10 @@ jobs:
     name: Build and Unit Tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: goto-bus-stop/setup-zig@v2
+      - uses: actions/checkout@v5
+      - uses: mlugg/setup-zig@v2
         with:
-          version: 0.14.0
+          version: 0.15.1
       - name: Build Examples
         run: zig build -Dexample=all
       - name: Run unit tests
@@ -32,10 +32,10 @@ jobs:
       matrix:
         async: [io_uring, epoll, poll]
     steps:
-      - uses: actions/checkout@v2
-      - uses: goto-bus-stop/setup-zig@v2
+      - uses: actions/checkout@v5
+      - uses: mlugg/setup-zig@v2
         with:
-          version: 0.14.0
+          version: 0.15.1
       - name: Generate random 64-bit integer
         id: random
         shell: bash
@@ -51,10 +51,10 @@ jobs:
       matrix:
         async: [kqueue, poll]
     steps:
-      - uses: actions/checkout@v2
-      - uses: goto-bus-stop/setup-zig@v2
+      - uses: actions/checkout@v5
+      - uses: mlugg/setup-zig@v2
         with:
-          version: 0.14.0
+          version: 0.15.1
       - name: Generate random 64-bit integer
         id: random
         shell: bash
@@ -67,10 +67,10 @@ jobs:
     needs: unit-tests
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: goto-bus-stop/setup-zig@v2
+      - uses: actions/checkout@v5
+      - uses: mlugg/setup-zig@v2
         with:
-          version: 0.14.0
+          version: 0.15.1
       - name: Generate random 64-bit integer
         id: random
         shell: pwsh

build.zig

@@ -1,17 +1,18 @@
 const std = @import("std");
-const builtin = @import("builtin");
 const assert = std.debug.assert;
+const builtin = @import("builtin");
 
-const zig_version = std.SemanticVersion{ .major = 0, .minor = 14, .patch = 1 };
+const AsyncKind = @import("src/aio/lib.zig").AsyncKind;
 
+const zig_version = std.SemanticVersion{ .major = 0, .minor = 15, .patch = 1 };
 comptime {
     // Compare versions while allowing different pre/patch metadata.
     const zig_version_eq = zig_version.major == builtin.zig_version.major and
         zig_version.minor == builtin.zig_version.minor and
         zig_version.patch == builtin.zig_version.patch;
     if (!zig_version_eq) {
         @compileError(std.fmt.comptimePrint(
-            "unsupported zig version: expected {}, found {}",
+            "unsupported zig version: expected {f}, found {f}",
             .{ zig_version, builtin.zig_version },
         ));
     }
@@ -20,7 +21,6 @@ comptime {
 const Example = enum {
     none,
     all,
-
     basic,
     cat,
     channel,
@@ -49,8 +49,6 @@ const Example = enum {
         return ex_string;
     }
 };
-const AsyncKind = @import("src/aio/lib.zig").AsyncKind;
-
 pub fn build(b: *std.Build) void {
 
     // Top-level steps you can invoke on the command line.
@@ -114,7 +112,7 @@ pub fn build(b: *std.Build) void {
     });
 
     // build and run e2e test
-    // usage: zig build test_e2e --Dasync=[async_backend] -- [u64 num]
+    // usage: zig build test_e2e -Dasync=[async_backend] -- [u64 num]
     build_test_e2e(b, .{
         .test_e2e = build_steps.test_e2e,
     }, .{
@@ -253,6 +251,8 @@ fn build_example_exe(
     const example_exe = b.addExecutable(.{
         .name = options.example.toString(),
         .root_module = example_mod,
+        // without llvm leads to error: undefined symbol: tardy_swap_frame
+        .use_llvm = true,
     });
 
     const install_artifact = b.addInstallArtifact(example_exe, .{});
@@ -269,6 +269,11 @@ fn build_example_exe(
     const run_artifact = b.addRunArtifact(example_exe);
     run_artifact.step.dependOn(&install_artifact.step);
 
+    // pass args to examples (.ie cat, rmdir, shove, stat)
+    if (b.args) |args| {
+        run_artifact.addArgs(args);
+    }
+
     steps.run.dependOn(&install_artifact.step);
     steps.run.dependOn(&run_artifact.step);
 }
@@ -317,9 +322,11 @@ fn build_test(
     // usage: zig build test_unit
     const unit_tests = b.addTest(.{
         .name = "general unit tests",
-        .root_source_file = b.path("./src/tests.zig"),
-        .optimize = options.optimize,
-        .target = options.target,
+        .root_module = b.createModule(.{
+            .root_source_file = b.path("./src/tests.zig"),
+            .optimize = options.optimize,
+            .target = options.target,
+        }),
     });
 
     const run_unit_tests = b.addRunArtifact(unit_tests);
@@ -355,6 +362,7 @@ fn build_test_e2e(
         .root_source_file = b.path("test/e2e/main.zig"),
         .target = options.target,
         .optimize = options.optimize,
+        .strip = false,
     });
 
     e2e_mod.addImport("tardy", options.tardy_mod);
@@ -374,7 +382,8 @@ fn build_test_e2e(
     const exe = b.addExecutable(.{
         .name = "e2e",
         .root_module = e2e_mod,
-        .strip = false,
+        // without llvm leads to error: undefined symbol: tardy_swap_frame
+        .use_llvm = true,
     });
 
     // build/install e2e test

examples/basic/main.zig

@@ -1,12 +1,11 @@
 const std = @import("std");
-const log = std.log.scoped(.@"tardy/example/basic");
 
 const Runtime = @import("tardy").Runtime;
 const Task = @import("tardy").Task;
-
 const Timer = @import("tardy").Timer;
 
 const Tardy = @import("tardy").Tardy(.auto);
+const log = std.log.scoped(.@"tardy/example/basic");
 
 fn log_frame(rt: *Runtime) !void {
     var count: usize = 0;
@@ -20,7 +19,7 @@ fn log_frame(rt: *Runtime) !void {
 pub fn main() !void {
     const allocator = std.heap.page_allocator;
 
-    var tardy = try Tardy.init(allocator, .{
+    var tardy: Tardy = try .init(allocator, .{
         .threading = .single,
         .pooling = .static,
         .size_tasks_initial = 2,

examples/cat/main.zig

@@ -1,21 +1,19 @@
 const std = @import("std");
-const log = std.log.scoped(.@"tardy/example/cat");
 
-const Runtime = @import("tardy").Runtime;
-const Frame = @import("tardy").Frame;
-const Task = @import("tardy").Task;
-const Tardy = @import("tardy").Tardy(.auto);
 const Cross = @import("tardy").Cross;
-
 const Dir = @import("tardy").Dir;
 const File = @import("tardy").File;
+const Frame = @import("tardy").Frame;
+const Runtime = @import("tardy").Runtime;
+const Task = @import("tardy").Task;
 
+const log = std.log.scoped(.@"tardy/example/cat");
 pub const std_options: std.Options = .{ .log_level = .err };
 
+const Tardy = @import("tardy").Tardy(.auto);
 const EntryParams = struct { file_name: [:0]const u8 };
 
 fn main_frame(rt: *Runtime, p: *EntryParams) !void {
-    const std_out = File.std_out();
     const file = Dir.cwd().open_file(rt, p.file_name, .{}) catch |e| switch (e) {
         error.NotFound => {
             std.debug.print("{s}: No such file!", .{p.file_name});
@@ -24,25 +22,28 @@ fn main_frame(rt: *Runtime, p: *EntryParams) !void {
         else => return e,
     };
 
-    const reader = file.reader(rt);
-    const writer = std_out.writer(rt);
+    var file_reader = file.reader(rt, &.{});
+    const file_r = &file_reader.interface;
+
+    var std_out = File.std_out().writer(rt, &.{});
+    const stdout_w = &std_out.interface;
+    defer stdout_w.flush() catch unreachable;
 
     var buffer: [1024 * 32]u8 = undefined;
     var done: bool = false;
-
     while (!done) {
-        const length = try reader.readAll(&buffer);
+        const length = file_r.readSliceShort(&buffer) catch unreachable;
         done = length < buffer.len;
-        try writer.writeAll(buffer[0..length]);
+        stdout_w.writeAll(buffer[0..length]) catch unreachable;
     }
 }
 
 pub fn main() !void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{ .thread_safe = true }){};
+    var gpa: std.heap.DebugAllocator(.{ .thread_safe = true }) = .init;
     const allocator = gpa.allocator();
     defer _ = gpa.deinit();
 
-    var tardy = try Tardy.init(allocator, .{
+    var tardy: Tardy = try .init(allocator, .{
         .threading = .single,
         .pooling = .static,
         .size_tasks_initial = 1,
@@ -59,7 +60,7 @@ pub fn main() !void {
             if (i == 1) break :blk arg;
         }
 
-        try std.io.getStdOut().writeAll("file name not passed in: ./cat [file name]");
+        try std.fs.File.stdout().writeAll("file name not passed in: ./cat [file name]");
         return;
     };
 

examples/channel/main.zig

@@ -1,13 +1,13 @@
 const std = @import("std");
-const log = std.log.scoped(.@"tardy/example/channel");
 
 const Runtime = @import("tardy").Runtime;
+const Spsc = @import("tardy").Spsc;
 const Task = @import("tardy").Task;
 const Timer = @import("tardy").Timer;
-const Tardy = @import("tardy").Tardy(.auto);
 
-const Spsc = @import("tardy").Spsc;
+const Tardy = @import("tardy").Tardy(.auto);
 
+const log = std.log.scoped(.@"tardy/example/channel");
 pub const std_options: std.Options = .{ .log_level = .err };
 
 const MAX_COUNT = 100;
@@ -39,17 +39,17 @@ fn consumer_frame(_: *Runtime, consumer: Spsc(usize).Consumer) !void {
 }
 
 pub fn main() !void {
-    const allocator = std.heap.page_allocator;
+    const allocator = std.heap.smp_allocator;
 
-    var tardy = try Tardy.init(allocator, .{
+    var tardy: Tardy = try .init(allocator, .{
         .threading = .{ .multi = 2 },
         .pooling = .static,
         .size_tasks_initial = 1,
         .size_aio_reap_max = 1,
     });
     defer tardy.deinit();
 
-    var channel = try Spsc(usize).init(allocator, 2);
+    var channel: Spsc(usize) = try .init(allocator, 2);
     defer channel.deinit();
 
     try tardy.entry(

examples/echo/main.zig

@@ -1,56 +1,65 @@
 const std = @import("std");
-const log = std.log.scoped(.@"tardy/example/echo");
 
+const AcceptResult = @import("tardy").AcceptResult;
+const Cross = @import("tardy").Cross;
 const Pool = @import("tardy").Pool;
+const RecvResult = @import("tardy").RecvResult;
 const Runtime = @import("tardy").Runtime;
-const Task = @import("tardy").Task;
-const Tardy = @import("tardy").Tardy(.auto);
-const Cross = @import("tardy").Cross;
-
+const SendResult = @import("tardy").SendResult;
 const Socket = @import("tardy").Socket;
+const Task = @import("tardy").Task;
 const Timer = @import("tardy").Timer;
 
-const AcceptResult = @import("tardy").AcceptResult;
-const RecvResult = @import("tardy").RecvResult;
-const SendResult = @import("tardy").SendResult;
+const Tardy = @import("tardy").Tardy(.auto);
+const log = std.log.scoped(.@"tardy/example/echo");
 
 fn echo_frame(rt: *Runtime, server: *const Socket) !void {
     const socket = try server.accept(rt);
     defer socket.close_blocking();
 
-    const reader = socket.reader(rt);
-    const writer = socket.writer(rt);
+    var sock_reader = socket.reader(rt, &.{});
+    const sock_r = &sock_reader.interface;
+
+    var sock_writer = socket.writer(rt, &.{});
+    const sock_w = &sock_writer.interface;
+    defer sock_w.flush() catch unreachable;
 
     log.debug(
-        "{d} - accepted socket [{}]",
+        "{d} - accepted socket [{f}]",
         .{ std.time.milliTimestamp(), socket.addr },
     );
 
     // spawn off a new frame.
     try rt.spawn(.{ rt, server }, echo_frame, 1024 * 16);
 
-    var buffer: [1024]u8 = undefined;
+    //TODO: investigate why using readSliceShort with a buffer bigger
+    // than reader size leads to a connection reset (try to get a repro)
+    var buffer: [501]u8 = undefined;
     while (true) {
-        const recv_length = reader.read(&buffer) catch |e| {
-            log.err("Failed to recv on socket | {}", .{e});
-            return;
+        const recv_length = sock_r.readSliceShort(&buffer) catch |e| {
+            log.err("Failed to recv on socket | {t}", .{e});
+            break;
         };
 
-        writer.writeAll(buffer[0..recv_length]) catch |e| {
-            log.err("Failed to send on socket | {}", .{e});
-            return;
+        if (recv_length == 0) {
+            break;
+        }
+
+        sock_w.writeAll(buffer[0..recv_length]) catch |e| {
+            log.err("Failed to send on socket | {t}", .{e});
+            break;
         };
 
         log.debug("Echoed: {s}", .{buffer[0..recv_length]});
     }
 }
 
 pub fn main() !void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+    var gpa: std.heap.DebugAllocator(.{}) = .init;
     const allocator = gpa.allocator();
     defer _ = gpa.deinit();
 
-    var tardy = try Tardy.init(allocator, .{
+    var tardy: Tardy = try .init(allocator, .{
         .threading = .single,
         .pooling = .static,
         .size_tasks_initial = 256,
@@ -61,7 +70,7 @@ pub fn main() !void {
     const host = "0.0.0.0";
     const port = 9862;
 
-    const server = try Socket.init(.{ .tcp = .{ .host = host, .port = port } });
+    const server: Socket = try .init(.{ .tcp = .{ .host = host, .port = port } });
     try server.bind();
     try server.listen(1024);