zig/lib/std/Io/EventLoop.zig

925 lines
34 KiB
Zig

const std = @import("../std.zig");
const builtin = @import("builtin");
const assert = std.debug.assert;
const Allocator = std.mem.Allocator;
const Io = std.Io;
const EventLoop = @This();
const Alignment = std.mem.Alignment;
const IoUring = std.os.linux.IoUring;
/// Must be a thread-safe allocator.
gpa: Allocator,
mutex: std.Thread.Mutex,
main_fiber: Fiber,
threads: Thread.List,
/// Empirically saw >128KB being used by the self-hosted backend to panic.
const idle_stack_size = 256 * 1024;
const max_idle_search = 4;
const max_steal_ready_search = 4;
const io_uring_entries = 64;
const Thread = struct {
thread: std.Thread,
idle_context: Context,
current_context: *Context,
ready_queue: ?*Fiber,
free_queue: ?*Fiber,
io_uring: IoUring,
idle_search_index: u32,
steal_ready_search_index: u32,
threadlocal var index: u32 = undefined;
fn current(el: *EventLoop) *Thread {
return &el.threads.allocated[index];
}
fn currentFiber(thread: *Thread) *Fiber {
return @fieldParentPtr("context", thread.current_context);
}
const List = struct {
allocated: []Thread,
reserved: u32,
active: u32,
};
};
const Fiber = struct {
context: Context,
awaiter: ?*Fiber,
queue_next: ?*Fiber,
can_cancel: bool,
canceled: bool,
const finished: ?*Fiber = @ptrFromInt(std.mem.alignBackward(usize, std.math.maxInt(usize), @alignOf(Fiber)));
const max_result_align: Alignment = .@"16";
const max_result_size = max_result_align.forward(64);
/// This includes any stack realignments that need to happen, and also the
/// initial frame return address slot and argument frame, depending on target.
const min_stack_size = 4 * 1024 * 1024;
const max_context_align: Alignment = .@"16";
const max_context_size = max_context_align.forward(1024);
const allocation_size = std.mem.alignForward(
usize,
std.mem.alignForward(
usize,
max_result_align.forward(@sizeOf(Fiber)) + max_result_size + min_stack_size,
@max(@alignOf(AsyncClosure), max_context_align.toByteUnits()),
) + @sizeOf(AsyncClosure) + max_context_size,
std.heap.page_size_max,
);
fn allocate(el: *EventLoop) error{OutOfMemory}!*Fiber {
const thread: *Thread = .current(el);
if (thread.free_queue) |free_fiber| {
thread.free_queue = free_fiber.queue_next;
free_fiber.queue_next = null;
return free_fiber;
}
return @ptrCast(try el.gpa.alignedAlloc(u8, @alignOf(Fiber), allocation_size));
}
fn allocatedSlice(f: *Fiber) []align(@alignOf(Fiber)) u8 {
return @as([*]align(@alignOf(Fiber)) u8, @ptrCast(f))[0..allocation_size];
}
fn allocatedEnd(f: *Fiber) [*]u8 {
const allocated_slice = f.allocatedSlice();
return allocated_slice[allocated_slice.len..].ptr;
}
fn resultPointer(f: *Fiber, comptime Result: type) *Result {
return @alignCast(@ptrCast(f.resultBytes(.of(Result))));
}
fn resultBytes(f: *Fiber, alignment: Alignment) [*]u8 {
return @ptrFromInt(alignment.forward(@intFromPtr(f) + @sizeOf(Fiber)));
}
const Queue = struct { head: *Fiber, tail: *Fiber };
};
pub fn io(el: *EventLoop) Io {
return .{
.userdata = el,
.vtable = &.{
.@"async" = @"async",
.@"await" = @"await",
.cancel = cancel,
.cancelRequested = cancelRequested,
.createFile = createFile,
.openFile = openFile,
.closeFile = closeFile,
.read = read,
.write = write,
},
};
}
pub fn init(el: *EventLoop, gpa: Allocator) !void {
const threads_size = @max(std.Thread.getCpuCount() catch 1, 1) * @sizeOf(Thread);
const idle_stack_end_offset = std.mem.alignForward(usize, threads_size + idle_stack_size, std.heap.page_size_max);
const allocated_slice = try gpa.alignedAlloc(u8, @alignOf(Thread), idle_stack_end_offset);
errdefer gpa.free(allocated_slice);
el.* = .{
.gpa = gpa,
.mutex = .{},
.main_fiber = .{
.context = undefined,
.awaiter = null,
.queue_next = null,
.can_cancel = false,
.canceled = false,
},
.threads = .{
.allocated = @ptrCast(allocated_slice[0..threads_size]),
.reserved = 1,
.active = 1,
},
};
Thread.index = 0;
const main_thread = &el.threads.allocated[0];
const idle_stack_end: [*]usize = @alignCast(@ptrCast(allocated_slice[idle_stack_end_offset..].ptr));
(idle_stack_end - 1)[0..1].* = .{@intFromPtr(el)};
main_thread.* = .{
.thread = undefined,
.idle_context = .{
.rsp = @intFromPtr(idle_stack_end - 1),
.rbp = 0,
.rip = @intFromPtr(&mainIdleEntry),
},
.current_context = &el.main_fiber.context,
.ready_queue = null,
.free_queue = null,
.io_uring = try IoUring.init(io_uring_entries, 0),
.idle_search_index = 1,
.steal_ready_search_index = 1,
};
errdefer main_thread.io_uring.deinit();
std.log.debug("created main idle {*}", .{&main_thread.idle_context});
std.log.debug("created main {*}", .{&el.main_fiber});
}
pub fn deinit(el: *EventLoop) void {
const active_threads = @atomicLoad(u32, &el.threads.active, .acquire);
for (el.threads.allocated[0..active_threads]) |*thread|
assert(@atomicLoad(?*Fiber, &thread.ready_queue, .unordered) == null); // pending async
el.yield(null, .exit);
const allocated_ptr: [*]align(@alignOf(Thread)) u8 = @alignCast(@ptrCast(el.threads.allocated.ptr));
const idle_stack_end_offset = std.mem.alignForward(usize, el.threads.allocated.len * @sizeOf(Thread) + idle_stack_size, std.heap.page_size_max);
for (el.threads.allocated[1..active_threads]) |*thread| {
thread.thread.join();
while (thread.free_queue) |free_fiber| {
thread.free_queue = free_fiber.queue_next;
free_fiber.queue_next = null;
el.gpa.free(free_fiber.allocatedSlice());
}
}
el.gpa.free(allocated_ptr[0..idle_stack_end_offset]);
el.* = undefined;
}
fn yield(el: *EventLoop, maybe_ready_fiber: ?*Fiber, pending_task: SwitchMessage.PendingTask) void {
const thread: *Thread = .current(el);
const ready_context: *Context = if (maybe_ready_fiber) |ready_fiber|
&ready_fiber.context
else if (thread.ready_queue) |ready_fiber| ready_context: {
thread.ready_queue = ready_fiber.queue_next;
ready_fiber.queue_next = null;
break :ready_context &ready_fiber.context;
} else ready_context: {
const ready_threads = @atomicLoad(u32, &el.threads.active, .acquire);
break :ready_context for (0..max_steal_ready_search) |_| {
defer thread.steal_ready_search_index += 1;
if (thread.steal_ready_search_index == ready_threads) thread.steal_ready_search_index = 0;
const steal_ready_search_thread = &el.threads.allocated[thread.steal_ready_search_index];
const ready_fiber = @atomicLoad(?*Fiber, &steal_ready_search_thread.ready_queue, .acquire) orelse continue;
if (@cmpxchgWeak(
?*Fiber,
&steal_ready_search_thread.ready_queue,
ready_fiber,
@atomicLoad(?*Fiber, &ready_fiber.queue_next, .acquire),
.acq_rel,
.monotonic,
)) |_| continue;
break &ready_fiber.context;
} else &thread.idle_context;
};
const message: SwitchMessage = .{
.contexts = .{
.prev = thread.current_context,
.ready = ready_context,
},
.pending_task = pending_task,
};
std.log.debug("switching from {*} to {*}", .{ message.contexts.prev, message.contexts.ready });
contextSwitch(&message).handle(el);
}
fn schedule(el: *EventLoop, thread: *Thread, ready_queue: Fiber.Queue) void {
{
var fiber = ready_queue.head;
while (true) {
std.log.debug("scheduling {*}", .{fiber});
fiber = fiber.queue_next orelse break;
}
assert(fiber == ready_queue.tail);
}
// shared fields of previous `Thread` must be initialized before later ones are marked as active
const new_thread_index = @atomicLoad(u32, &el.threads.active, .acquire);
for (0..max_idle_search) |_| {
defer thread.idle_search_index += 1;
if (thread.idle_search_index == new_thread_index) thread.idle_search_index = 0;
const idle_search_thread = &el.threads.allocated[thread.idle_search_index];
if (@cmpxchgWeak(
?*Fiber,
&idle_search_thread.ready_queue,
null,
ready_queue.head,
.acq_rel,
.monotonic,
)) |_| continue;
getSqe(&thread.io_uring).* = .{
.opcode = .MSG_RING,
.flags = std.os.linux.IOSQE_CQE_SKIP_SUCCESS,
.ioprio = 0,
.fd = idle_search_thread.io_uring.fd,
.off = @intFromEnum(Completion.Key.wakeup),
.addr = 0,
.len = 0,
.rw_flags = 0,
.user_data = @intFromEnum(Completion.Key.wakeup),
.buf_index = 0,
.personality = 0,
.splice_fd_in = 0,
.addr3 = 0,
.resv = 0,
};
return;
}
spawn_thread: {
// previous failed reservations must have completed before retrying
if (new_thread_index == el.threads.allocated.len or @cmpxchgWeak(
u32,
&el.threads.reserved,
new_thread_index,
new_thread_index + 1,
.acquire,
.monotonic,
) != null) break :spawn_thread;
const new_thread = &el.threads.allocated[new_thread_index];
const next_thread_index = new_thread_index + 1;
new_thread.* = .{
.thread = undefined,
.idle_context = undefined,
.current_context = &new_thread.idle_context,
.ready_queue = ready_queue.head,
.free_queue = null,
.io_uring = IoUring.init(io_uring_entries, 0) catch |err| {
@atomicStore(u32, &el.threads.reserved, new_thread_index, .release);
// no more access to `thread` after giving up reservation
std.log.warn("unable to create worker thread due to io_uring init failure: {s}", .{@errorName(err)});
break :spawn_thread;
},
.idle_search_index = next_thread_index,
.steal_ready_search_index = next_thread_index,
};
new_thread.thread = std.Thread.spawn(.{
.stack_size = idle_stack_size,
.allocator = el.gpa,
}, threadEntry, .{ el, new_thread_index }) catch |err| {
new_thread.io_uring.deinit();
@atomicStore(u32, &el.threads.reserved, new_thread_index, .release);
// no more access to `thread` after giving up reservation
std.log.warn("unable to create worker thread due spawn failure: {s}", .{@errorName(err)});
break :spawn_thread;
};
// shared fields of `Thread` must be initialized before being marked active
@atomicStore(u32, &el.threads.active, next_thread_index, .release);
return;
}
// nobody wanted it, so just queue it on ourselves
while (@cmpxchgWeak(
?*Fiber,
&thread.ready_queue,
ready_queue.tail.queue_next,
ready_queue.head,
.acq_rel,
.acquire,
)) |old_head| ready_queue.tail.queue_next = old_head;
}
fn recycle(el: *EventLoop, fiber: *Fiber) void {
const thread: *Thread = .current(el);
std.log.debug("recyling {*}", .{fiber});
assert(fiber.queue_next == null);
@memset(fiber.allocatedSlice(), undefined);
fiber.queue_next = thread.free_queue;
thread.free_queue = fiber;
}
fn mainIdle(el: *EventLoop, message: *const SwitchMessage) callconv(.withStackAlign(.c, @max(@alignOf(Thread), @alignOf(Context)))) noreturn {
message.handle(el);
const thread: *Thread = &el.threads.allocated[0];
el.idle(thread);
el.yield(&el.main_fiber, .nothing);
unreachable; // switched to dead fiber
}
fn threadEntry(el: *EventLoop, index: u32) void {
Thread.index = index;
const thread: *Thread = &el.threads.allocated[index];
std.log.debug("created thread idle {*}", .{&thread.idle_context});
el.idle(thread);
}
const Completion = struct {
const Key = enum(usize) {
unused,
wakeup,
cancel,
cleanup,
exit,
/// *Fiber
_,
};
result: i32,
flags: u32,
};
fn idle(el: *EventLoop, thread: *Thread) void {
var maybe_ready_fiber: ?*Fiber = null;
while (true) {
el.yield(maybe_ready_fiber, .nothing);
maybe_ready_fiber = null;
_ = thread.io_uring.submit_and_wait(1) catch |err| switch (err) {
error.SignalInterrupt => std.log.warn("submit_and_wait failed with SignalInterrupt", .{}),
else => |e| @panic(@errorName(e)),
};
var cqes_buffer: [io_uring_entries]std.os.linux.io_uring_cqe = undefined;
var maybe_ready_queue: ?Fiber.Queue = null;
for (cqes_buffer[0 .. thread.io_uring.copy_cqes(&cqes_buffer, 0) catch |err| switch (err) {
error.SignalInterrupt => cqes_len: {
std.log.warn("copy_cqes failed with SignalInterrupt", .{});
break :cqes_len 0;
},
else => |e| @panic(@errorName(e)),
}]) |cqe| switch (@as(Completion.Key, @enumFromInt(cqe.user_data))) {
.unused => unreachable, // bad submission queued?
.wakeup => {},
.cancel => {},
.cleanup => @panic("failed to notify other threads that we are exiting"),
.exit => {
assert(maybe_ready_fiber == null and maybe_ready_queue == null); // pending async
return;
},
_ => {
const fiber: *Fiber = @ptrFromInt(cqe.user_data);
assert(fiber.queue_next == null);
fiber.resultPointer(Completion).* = .{
.result = cqe.res,
.flags = cqe.flags,
};
if (maybe_ready_fiber == null) maybe_ready_fiber = fiber else if (maybe_ready_queue) |*ready_queue| {
ready_queue.tail.queue_next = fiber;
ready_queue.tail = fiber;
} else maybe_ready_queue = .{ .head = fiber, .tail = fiber };
},
};
if (maybe_ready_queue) |ready_queue| el.schedule(thread, ready_queue);
}
}
const SwitchMessage = struct {
contexts: extern struct {
prev: *Context,
ready: *Context,
},
pending_task: PendingTask,
const PendingTask = union(enum) {
nothing,
register_awaiter: *?*Fiber,
exit,
};
fn handle(message: *const SwitchMessage, el: *EventLoop) void {
const thread: *Thread = .current(el);
thread.current_context = message.contexts.ready;
switch (message.pending_task) {
.nothing => {},
.register_awaiter => |awaiter| {
const prev_fiber: *Fiber = @alignCast(@fieldParentPtr("context", message.contexts.prev));
if (@atomicRmw(
?*Fiber,
awaiter,
.Xchg,
prev_fiber,
.acq_rel,
) == Fiber.finished) el.schedule(thread, .{ .head = prev_fiber, .tail = prev_fiber });
},
.exit => for (el.threads.allocated[0..@atomicLoad(u32, &el.threads.active, .acquire)]) |*each_thread| {
getSqe(&thread.io_uring).* = .{
.opcode = .MSG_RING,
.flags = std.os.linux.IOSQE_CQE_SKIP_SUCCESS,
.ioprio = 0,
.fd = each_thread.io_uring.fd,
.off = @intFromEnum(Completion.Key.exit),
.addr = 0,
.len = 0,
.rw_flags = 0,
.user_data = @intFromEnum(Completion.Key.cleanup),
.buf_index = 0,
.personality = 0,
.splice_fd_in = 0,
.addr3 = 0,
.resv = 0,
};
},
}
}
};
const Context = switch (builtin.cpu.arch) {
.x86_64 => extern struct {
rsp: u64,
rbp: u64,
rip: u64,
},
else => |arch| @compileError("unimplemented architecture: " ++ @tagName(arch)),
};
inline fn contextSwitch(message: *const SwitchMessage) *const SwitchMessage {
return @fieldParentPtr("contexts", switch (builtin.cpu.arch) {
.x86_64 => asm volatile (
\\ movq 0(%%rsi), %%rax
\\ movq 8(%%rsi), %%rcx
\\ leaq 0f(%%rip), %%rdx
\\ movq %%rsp, 0(%%rax)
\\ movq %%rbp, 8(%%rax)
\\ movq %%rdx, 16(%%rax)
\\ movq 0(%%rcx), %%rsp
\\ movq 8(%%rcx), %%rbp
\\ jmpq *16(%%rcx)
\\0:
: [received_message] "={rsi}" (-> *const @FieldType(SwitchMessage, "contexts")),
: [message_to_send] "{rsi}" (&message.contexts),
: "rax", "rcx", "rdx", "rbx", "rdi", //
"r8", "r9", "r10", "r11", "r12", "r13", "r14", "r15", //
"mm0", "mm1", "mm2", "mm3", "mm4", "mm5", "mm6", "mm7", //
"zmm0", "zmm1", "zmm2", "zmm3", "zmm4", "zmm5", "zmm6", "zmm7", //
"zmm8", "zmm9", "zmm10", "zmm11", "zmm12", "zmm13", "zmm14", "zmm15", //
"zmm16", "zmm17", "zmm18", "zmm19", "zmm20", "zmm21", "zmm22", "zmm23", //
"zmm24", "zmm25", "zmm26", "zmm27", "zmm28", "zmm29", "zmm30", "zmm31", //
"fpsr", "fpcr", "mxcsr", "rflags", "dirflag", "memory"
),
else => |arch| @compileError("unimplemented architecture: " ++ @tagName(arch)),
});
}
fn mainIdleEntry() callconv(.naked) void {
switch (builtin.cpu.arch) {
.x86_64 => asm volatile (
\\ movq (%%rsp), %%rdi
\\ jmp %[mainIdle:P]
:
: [mainIdle] "X" (&mainIdle),
),
else => |arch| @compileError("unimplemented architecture: " ++ @tagName(arch)),
}
}
fn fiberEntry() callconv(.naked) void {
switch (builtin.cpu.arch) {
.x86_64 => asm volatile (
\\ leaq 8(%%rsp), %%rdi
\\ jmp %[AsyncClosure_call:P]
:
: [AsyncClosure_call] "X" (&AsyncClosure.call),
),
else => |arch| @compileError("unimplemented architecture: " ++ @tagName(arch)),
}
}
const AsyncClosure = struct {
event_loop: *EventLoop,
fiber: *Fiber,
start: *const fn (context: *const anyopaque, result: *anyopaque) void,
result_align: Alignment,
fn contextPointer(closure: *AsyncClosure) [*]align(Fiber.max_context_align.toByteUnits()) u8 {
return @alignCast(@as([*]u8, @ptrCast(closure)) + @sizeOf(AsyncClosure));
}
fn call(closure: *AsyncClosure, message: *const SwitchMessage) callconv(.withStackAlign(.c, @alignOf(AsyncClosure))) noreturn {
message.handle(closure.event_loop);
std.log.debug("{*} performing async", .{closure.fiber});
closure.start(closure.contextPointer(), closure.fiber.resultBytes(closure.result_align));
const awaiter = @atomicRmw(?*Fiber, &closure.fiber.awaiter, .Xchg, Fiber.finished, .acq_rel);
closure.event_loop.yield(awaiter, .nothing);
unreachable; // switched to dead fiber
}
};
fn @"async"(
userdata: ?*anyopaque,
result: []u8,
result_alignment: Alignment,
context: []const u8,
context_alignment: Alignment,
start: *const fn (context: *const anyopaque, result: *anyopaque) void,
) ?*std.Io.AnyFuture {
assert(result_alignment.compare(.lte, Fiber.max_result_align)); // TODO
assert(context_alignment.compare(.lte, Fiber.max_context_align)); // TODO
assert(result.len <= Fiber.max_result_size); // TODO
assert(context.len <= Fiber.max_context_size); // TODO
const event_loop: *EventLoop = @alignCast(@ptrCast(userdata));
const fiber = Fiber.allocate(event_loop) catch {
start(context.ptr, result.ptr);
return null;
};
std.log.debug("allocated {*}", .{fiber});
const closure: *AsyncClosure = @ptrFromInt(Fiber.max_context_align.max(.of(AsyncClosure)).backward(
@intFromPtr(fiber.allocatedEnd()) - Fiber.max_context_size,
) - @sizeOf(AsyncClosure));
fiber.* = .{
.context = switch (builtin.cpu.arch) {
.x86_64 => .{
.rsp = @intFromPtr(closure) - @sizeOf(usize),
.rbp = 0,
.rip = @intFromPtr(&fiberEntry),
},
else => |arch| @compileError("unimplemented architecture: " ++ @tagName(arch)),
},
.awaiter = null,
.queue_next = null,
.can_cancel = false,
.canceled = false,
};
closure.* = .{
.event_loop = event_loop,
.fiber = fiber,
.start = start,
.result_align = result_alignment,
};
@memcpy(closure.contextPointer(), context);
event_loop.schedule(.current(event_loop), .{ .head = fiber, .tail = fiber });
return @ptrCast(fiber);
}
fn @"await"(
userdata: ?*anyopaque,
any_future: *std.Io.AnyFuture,
result: []u8,
result_alignment: Alignment,
) void {
const event_loop: *EventLoop = @alignCast(@ptrCast(userdata));
const future_fiber: *Fiber = @alignCast(@ptrCast(any_future));
if (@atomicLoad(?*Fiber, &future_fiber.awaiter, .acquire) != Fiber.finished) event_loop.yield(null, .{ .register_awaiter = &future_fiber.awaiter });
@memcpy(result, future_fiber.resultBytes(result_alignment));
event_loop.recycle(future_fiber);
}
fn cancel(
userdata: ?*anyopaque,
any_future: *std.Io.AnyFuture,
result: []u8,
result_alignment: Alignment,
) void {
const event_loop: *EventLoop = @alignCast(@ptrCast(userdata));
const future_fiber: *Fiber = @alignCast(@ptrCast(any_future));
@atomicStore(bool, &future_fiber.canceled, true, .release);
if (@atomicLoad(bool, &future_fiber.can_cancel, .acquire)) {
const thread: *Thread = .current(event_loop);
getSqe(&thread.io_uring).* = .{
.opcode = .ASYNC_CANCEL,
.flags = std.os.linux.IOSQE_CQE_SKIP_SUCCESS,
.ioprio = 0,
.fd = 0,
.off = 0,
.addr = @intFromPtr(future_fiber),
.len = 0,
.rw_flags = 0,
.user_data = @intFromEnum(Completion.Key.cancel),
.buf_index = 0,
.personality = 0,
.splice_fd_in = 0,
.addr3 = 0,
.resv = 0,
};
}
@"await"(userdata, any_future, result, result_alignment);
}
fn cancelRequested(userdata: ?*anyopaque) bool {
const event_loop: *EventLoop = @alignCast(@ptrCast(userdata));
const thread: *Thread = .current(event_loop);
return thread.currentFiber().canceled;
}
pub fn createFile(
userdata: ?*anyopaque,
dir: std.fs.Dir,
sub_path: []const u8,
flags: Io.CreateFlags,
) Io.FileOpenError!std.fs.File {
const el: *EventLoop = @alignCast(@ptrCast(userdata));
const posix = std.posix;
const sub_path_c = try posix.toPosixPath(sub_path);
var os_flags: posix.O = .{
.ACCMODE = if (flags.read) .RDWR else .WRONLY,
.CREAT = true,
.TRUNC = flags.truncate,
.EXCL = flags.exclusive,
};
if (@hasField(posix.O, "LARGEFILE")) os_flags.LARGEFILE = true;
if (@hasField(posix.O, "CLOEXEC")) os_flags.CLOEXEC = true;
// Use the O locking flags if the os supports them to acquire the lock
// atomically. Note that the NONBLOCK flag is removed after the openat()
// call is successful.
const has_flock_open_flags = @hasField(posix.O, "EXLOCK");
if (has_flock_open_flags) switch (flags.lock) {
.none => {},
.shared => {
os_flags.SHLOCK = true;
os_flags.NONBLOCK = flags.lock_nonblocking;
},
.exclusive => {
os_flags.EXLOCK = true;
os_flags.NONBLOCK = flags.lock_nonblocking;
},
};
const have_flock = @TypeOf(posix.system.flock) != void;
if (have_flock and !has_flock_open_flags and flags.lock != .none) {
@panic("TODO");
}
if (has_flock_open_flags and flags.lock_nonblocking) {
@panic("TODO");
}
const thread: *Thread = .current(el);
const iou = &thread.io_uring;
const fiber = thread.currentFiber();
if (@atomicLoad(bool, &fiber.canceled, .acquire)) return error.AsyncCancel;
const sqe = getSqe(iou);
sqe.prep_openat(dir.fd, &sub_path_c, os_flags, flags.mode);
sqe.user_data = @intFromPtr(fiber);
@atomicStore(bool, &fiber.can_cancel, true, .release);
el.yield(null, .nothing);
@atomicStore(bool, &fiber.can_cancel, false, .release);
const completion = fiber.resultPointer(Completion);
switch (errno(completion.result)) {
.SUCCESS => return .{ .handle = completion.result },
.INTR => @panic("TODO is this reachable?"),
.CANCELED => return error.AsyncCancel,
.FAULT => unreachable,
.INVAL => return error.BadPathName,
.BADF => unreachable,
.ACCES => return error.AccessDenied,
.FBIG => return error.FileTooBig,
.OVERFLOW => return error.FileTooBig,
.ISDIR => return error.IsDir,
.LOOP => return error.SymLinkLoop,
.MFILE => return error.ProcessFdQuotaExceeded,
.NAMETOOLONG => return error.NameTooLong,
.NFILE => return error.SystemFdQuotaExceeded,
.NODEV => return error.NoDevice,
.NOENT => return error.FileNotFound,
.NOMEM => return error.SystemResources,
.NOSPC => return error.NoSpaceLeft,
.NOTDIR => return error.NotDir,
.PERM => return error.PermissionDenied,
.EXIST => return error.PathAlreadyExists,
.BUSY => return error.DeviceBusy,
.OPNOTSUPP => return error.FileLocksNotSupported,
.AGAIN => return error.WouldBlock,
.TXTBSY => return error.FileBusy,
.NXIO => return error.NoDevice,
else => |err| return posix.unexpectedErrno(err),
}
}
pub fn openFile(
userdata: ?*anyopaque,
dir: std.fs.Dir,
sub_path: []const u8,
flags: Io.OpenFlags,
) Io.FileOpenError!std.fs.File {
const el: *EventLoop = @alignCast(@ptrCast(userdata));
const thread: *Thread = .current(el);
const iou = &thread.io_uring;
const fiber = thread.currentFiber();
if (@atomicLoad(bool, &fiber.canceled, .acquire)) return error.AsyncCancel;
const posix = std.posix;
const sub_path_c = try posix.toPosixPath(sub_path);
var os_flags: posix.O = .{
.ACCMODE = switch (flags.mode) {
.read_only => .RDONLY,
.write_only => .WRONLY,
.read_write => .RDWR,
},
};
if (@hasField(posix.O, "CLOEXEC")) os_flags.CLOEXEC = true;
if (@hasField(posix.O, "LARGEFILE")) os_flags.LARGEFILE = true;
if (@hasField(posix.O, "NOCTTY")) os_flags.NOCTTY = !flags.allow_ctty;
// Use the O locking flags if the os supports them to acquire the lock
// atomically.
const has_flock_open_flags = @hasField(posix.O, "EXLOCK");
if (has_flock_open_flags) {
// Note that the NONBLOCK flag is removed after the openat() call
// is successful.
switch (flags.lock) {
.none => {},
.shared => {
os_flags.SHLOCK = true;
os_flags.NONBLOCK = flags.lock_nonblocking;
},
.exclusive => {
os_flags.EXLOCK = true;
os_flags.NONBLOCK = flags.lock_nonblocking;
},
}
}
const have_flock = @TypeOf(posix.system.flock) != void;
if (have_flock and !has_flock_open_flags and flags.lock != .none) {
@panic("TODO");
}
if (has_flock_open_flags and flags.lock_nonblocking) {
@panic("TODO");
}
const sqe = getSqe(iou);
sqe.prep_openat(dir.fd, &sub_path_c, os_flags, 0);
sqe.user_data = @intFromPtr(fiber);
@atomicStore(bool, &fiber.can_cancel, true, .release);
el.yield(null, .nothing);
@atomicStore(bool, &fiber.can_cancel, false, .release);
const completion = fiber.resultPointer(Completion);
switch (errno(completion.result)) {
.SUCCESS => return .{ .handle = completion.result },
.INTR => @panic("TODO is this reachable?"),
.CANCELED => return error.AsyncCancel,
.FAULT => unreachable,
.INVAL => return error.BadPathName,
.BADF => unreachable,
.ACCES => return error.AccessDenied,
.FBIG => return error.FileTooBig,
.OVERFLOW => return error.FileTooBig,
.ISDIR => return error.IsDir,
.LOOP => return error.SymLinkLoop,
.MFILE => return error.ProcessFdQuotaExceeded,
.NAMETOOLONG => return error.NameTooLong,
.NFILE => return error.SystemFdQuotaExceeded,
.NODEV => return error.NoDevice,
.NOENT => return error.FileNotFound,
.NOMEM => return error.SystemResources,
.NOSPC => return error.NoSpaceLeft,
.NOTDIR => return error.NotDir,
.PERM => return error.PermissionDenied,
.EXIST => return error.PathAlreadyExists,
.BUSY => return error.DeviceBusy,
.OPNOTSUPP => return error.FileLocksNotSupported,
.AGAIN => return error.WouldBlock,
.TXTBSY => return error.FileBusy,
.NXIO => return error.NoDevice,
else => |err| return posix.unexpectedErrno(err),
}
}
pub fn closeFile(userdata: ?*anyopaque, file: std.fs.File) void {
const el: *EventLoop = @alignCast(@ptrCast(userdata));
const thread: *Thread = .current(el);
const iou = &thread.io_uring;
const fiber = thread.currentFiber();
const sqe = getSqe(iou);
sqe.prep_close(file.handle);
sqe.user_data = @intFromPtr(fiber);
el.yield(null, .nothing);
const completion = fiber.resultPointer(Completion);
switch (errno(completion.result)) {
.SUCCESS => return,
.INTR => @panic("TODO is this reachable?"),
.CANCELED => return,
.BADF => unreachable, // Always a race condition.
else => return,
}
}
pub fn read(userdata: ?*anyopaque, file: std.fs.File, buffer: []u8) Io.FileReadError!usize {
const el: *EventLoop = @alignCast(@ptrCast(userdata));
const thread: *Thread = .current(el);
const iou = &thread.io_uring;
const fiber = thread.currentFiber();
if (@atomicLoad(bool, &fiber.canceled, .acquire)) return error.AsyncCancel;
const sqe = getSqe(iou);
sqe.prep_read(file.handle, buffer, std.math.maxInt(u64));
sqe.user_data = @intFromPtr(fiber);
@atomicStore(bool, &fiber.can_cancel, true, .release);
el.yield(null, .nothing);
@atomicStore(bool, &fiber.can_cancel, false, .release);
const completion = fiber.resultPointer(Completion);
switch (errno(completion.result)) {
.SUCCESS => return @as(u32, @bitCast(completion.result)),
.INTR => @panic("TODO is this reachable?"),
.CANCELED => return error.AsyncCancel,
.INVAL => unreachable,
.FAULT => unreachable,
.NOENT => return error.ProcessNotFound,
.AGAIN => return error.WouldBlock,
.BADF => return error.NotOpenForReading, // Can be a race condition.
.IO => return error.InputOutput,
.ISDIR => return error.IsDir,
.NOBUFS => return error.SystemResources,
.NOMEM => return error.SystemResources,
.NOTCONN => return error.SocketNotConnected,
.CONNRESET => return error.ConnectionResetByPeer,
.TIMEDOUT => return error.ConnectionTimedOut,
else => |err| return std.posix.unexpectedErrno(err),
}
}
pub fn write(userdata: ?*anyopaque, file: std.fs.File, buffer: []const u8) Io.FileWriteError!usize {
const el: *EventLoop = @alignCast(@ptrCast(userdata));
const thread: *Thread = .current(el);
const iou = &thread.io_uring;
const fiber = thread.currentFiber();
if (@atomicLoad(bool, &fiber.canceled, .acquire)) return error.AsyncCancel;
const sqe = getSqe(iou);
sqe.prep_write(file.handle, buffer, std.math.maxInt(u64));
sqe.user_data = @intFromPtr(fiber);
@atomicStore(bool, &fiber.can_cancel, true, .release);
el.yield(null, .nothing);
@atomicStore(bool, &fiber.can_cancel, false, .release);
const completion = fiber.resultPointer(Completion);
switch (errno(completion.result)) {
.SUCCESS => return @as(u32, @bitCast(completion.result)),
.INTR => @panic("TODO is this reachable?"),
.CANCELED => return error.AsyncCancel,
.INVAL => return error.InvalidArgument,
.FAULT => unreachable,
.NOENT => return error.ProcessNotFound,
.AGAIN => return error.WouldBlock,
.BADF => return error.NotOpenForWriting, // can be a race condition.
.DESTADDRREQ => unreachable, // `connect` was never called.
.DQUOT => return error.DiskQuota,
.FBIG => return error.FileTooBig,
.IO => return error.InputOutput,
.NOSPC => return error.NoSpaceLeft,
.ACCES => return error.AccessDenied,
.PERM => return error.PermissionDenied,
.PIPE => return error.BrokenPipe,
.CONNRESET => return error.ConnectionResetByPeer,
.BUSY => return error.DeviceBusy,
.NXIO => return error.NoDevice,
.MSGSIZE => return error.MessageTooBig,
else => |err| return std.posix.unexpectedErrno(err),
}
}
fn errno(signed: i32) std.posix.E {
const int = if (signed > -4096 and signed < 0) -signed else 0;
return @enumFromInt(int);
}
fn getSqe(iou: *IoUring) *std.os.linux.io_uring_sqe {
return iou.get_sqe() catch @panic("TODO: handle submission queue full");
}