Radix/third_party/modules/libxev/20241208.0-db6a52b/patches/128.patch

442 lines
15 KiB
Diff
Raw Normal View History

From 12fb50bdd4b62c8e111f12eecb171257b6af6038 Mon Sep 17 00:00:00 2001
From: Mitchell Hashimoto <m@mitchellh.com>
Date: Mon, 4 Nov 2024 13:30:10 -0800
Subject: [PATCH 1/8] Revert "Fix potential ThreadPool UAF (#113)"
This reverts commit dbe22910a43e9e8ec9948d3cbd73d8488a074967, reversing
changes made to 43c7e4b3308f359e5b758db2d824d7c447f4ed3f.
---
src/ThreadPool.zig | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/src/ThreadPool.zig b/src/ThreadPool.zig
index 9e0ff02..1d0123b 100644
--- a/src/ThreadPool.zig
+++ b/src/ThreadPool.zig
@@ -335,8 +335,12 @@ fn unregister(noalias self: *ThreadPool, noalias maybe_thread: ?*Thread) void {
fn join(self: *ThreadPool) void {
// Wait for the thread pool to be shutdown() then for all threads to enter a joinable state
- self.join_event.wait();
- const sync: Sync = @bitCast(self.sync.load(.monotonic));
+ var sync: Sync = @bitCast(self.sync.load(.monotonic));
+ if (!(sync.state == .shutdown and sync.spawned == 0)) {
+ self.join_event.wait();
+ sync = @bitCast(self.sync.load(.monotonic));
+ }
+
assert(sync.state == .shutdown);
assert(sync.spawned == 0);
From f6dea8bb85593cca6d4a54d92d4b05fe15b1eb41 Mon Sep 17 00:00:00 2001
From: Corentin Godeau <corentin.godeau@zml.ai>
Date: Tue, 10 Sep 2024 11:23:28 +0200
Subject: [PATCH 2/8] fix: avoid overflow in kqueue backend
When there is more than 256 events, the `events` slice could overflow
when processing completions.
---
src/backend/kqueue.zig | 3 +++
1 file changed, 3 insertions(+)
diff --git a/src/backend/kqueue.zig b/src/backend/kqueue.zig
index 834f916..456f64f 100644
--- a/src/backend/kqueue.zig
+++ b/src/backend/kqueue.zig
@@ -437,6 +437,9 @@ pub const Loop = struct {
// Only resubmit if we aren't already active (in the queue)
.rearm => if (!c_active) self.submissions.push(c),
}
+
+ // If we filled the events slice, we break to avoid overflow.
+ if (changes == events.len) break;
}
// Determine our next timeout based on the timers
From 890e2711ff9eb82bbceda2e6229b9c9a8d0b60da Mon Sep 17 00:00:00 2001
From: David Rubin <daviru007@icloud.com>
Date: Fri, 6 Dec 2024 20:43:52 -0800
Subject: [PATCH 3/8] remove race from threadpool
---
src/ThreadPool.zig | 8 +++-----
1 file changed, 3 insertions(+), 5 deletions(-)
diff --git a/src/ThreadPool.zig b/src/ThreadPool.zig
index 1d0123b..aec09d7 100644
--- a/src/ThreadPool.zig
+++ b/src/ThreadPool.zig
@@ -291,6 +291,7 @@ pub noinline fn shutdown(self: *ThreadPool) void {
// Wake up any threads sleeping on the idle_event.
// TODO: I/O polling notification here.
if (sync.idle > 0) self.idle_event.shutdown();
+ if (sync.spawned == 0) self.join_event.notify();
return;
});
}
@@ -335,11 +336,8 @@ fn unregister(noalias self: *ThreadPool, noalias maybe_thread: ?*Thread) void {
fn join(self: *ThreadPool) void {
// Wait for the thread pool to be shutdown() then for all threads to enter a joinable state
- var sync: Sync = @bitCast(self.sync.load(.monotonic));
- if (!(sync.state == .shutdown and sync.spawned == 0)) {
- self.join_event.wait();
- sync = @bitCast(self.sync.load(.monotonic));
- }
+ self.join_event.wait();
+ const sync: Sync = @bitCast(self.sync.load(.monotonic));
assert(sync.state == .shutdown);
assert(sync.spawned == 0);
From d82ee736a1548e6564a296315f33902ae09aa298 Mon Sep 17 00:00:00 2001
From: Steeve Morin <steeve@zml.ai>
Date: Tue, 19 Nov 2024 16:14:14 +0100
Subject: [PATCH 4/8] backend/epoll: implement eventfd wakeup notification
Tries to mimic what happens in backend/kqueue.
Closes #4
---
src/backend/epoll.zig | 42 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 42 insertions(+)
diff --git a/src/backend/epoll.zig b/src/backend/epoll.zig
index ae4ec7d..f44d326 100644
--- a/src/backend/epoll.zig
+++ b/src/backend/epoll.zig
@@ -21,6 +21,12 @@ pub const Loop = struct {
fd: posix.fd_t,
+ /// The eventfd that this epoll queue always has a filter for. Writing
+ /// an empty message to this eventfd can be used to wake up the loop
+ /// at any time. Waking up the loop via this eventfd won't trigger any
+ /// particular completion, it just forces tick to cycle.
+ eventfd: xev.Async,
+
/// The number of active completions. This DOES NOT include completions that
/// are queued in the submissions queue.
active: usize = 0,
@@ -56,8 +62,12 @@ pub const Loop = struct {
} = .{},
pub fn init(options: xev.Options) !Loop {
+ var eventfd = try xev.Async.init();
+ errdefer eventfd.deinit();
+
var res: Loop = .{
.fd = try posix.epoll_create1(std.os.linux.EPOLL.CLOEXEC),
+ .eventfd = eventfd,
.thread_pool = options.thread_pool,
.thread_pool_completions = undefined,
.cached_now = undefined,
@@ -68,6 +78,7 @@ pub const Loop = struct {
pub fn deinit(self: *Loop) void {
posix.close(self.fd);
+ self.eventfd.deinit();
}
/// Run the event loop. See RunMode documentation for details on modes.
@@ -262,9 +273,26 @@ pub const Loop = struct {
// Initialize
if (!self.flags.init) {
self.flags.init = true;
+
if (self.thread_pool != null) {
self.thread_pool_completions.init();
}
+
+ var ev: linux.epoll_event = .{
+ .events = linux.EPOLL.IN | linux.EPOLL.RDHUP,
+ .data = .{ .ptr = 0 },
+ };
+ posix.epoll_ctl(
+ self.fd,
+ linux.EPOLL.CTL_ADD,
+ self.eventfd.fd,
+ &ev,
+ ) catch |err| {
+ // We reset initialization because we can't do anything
+ // safely unless we get this mach port registered!
+ self.flags.init = false;
+ return err;
+ };
}
// Submit all the submissions. We copy the submission queue so that
@@ -369,6 +397,10 @@ pub const Loop = struct {
// Process all our events and invoke their completion handlers
for (events[0..n]) |ev| {
+ // Zero data values are internal events that we do nothing
+ // on such as the eventfd wakeup.
+ if (ev.data.ptr == 0) continue;
+
const c: *Completion = @ptrFromInt(@as(usize, @intCast(ev.data.ptr)));
// We get the fd and mark this as in progress we can properly
@@ -415,6 +447,7 @@ pub const Loop = struct {
const pool = self.thread_pool orelse return error.ThreadPoolRequired;
// Setup our completion state so that thread_perform can do stuff
+ c.task_loop = self;
c.task_completions = &self.thread_pool_completions;
c.task = .{ .callback = Loop.thread_perform };
@@ -436,6 +469,14 @@ pub const Loop = struct {
// Add to our completion queue
c.task_completions.push(c);
+
+ // Wake up our main loop
+ c.task_loop.wakeup() catch {};
+ }
+
+ /// Sends an empty message to this loop's eventfd so that it wakes up.
+ fn wakeup(self: *Loop) !void {
+ try self.eventfd.notify();
}
fn start(self: *Loop, completion: *Completion) void {
@@ -800,6 +841,7 @@ pub const Completion = struct {
/// reliable way to get access to the loop and shouldn't be used
/// except internally.
task: ThreadPool.Task = undefined,
+ task_loop: *Loop = undefined,
task_completions: *Loop.TaskCompletionQueue = undefined,
task_result: Result = undefined,
From 320f1ae9ccc95ce814e246b35ca0f9fd2361f43e Mon Sep 17 00:00:00 2001
From: Corentin Godeau <corentin@zml.ai>
Date: Tue, 14 Jan 2025 14:43:54 +0000
Subject: [PATCH 5/8] backend/epoll: read the wakeup eventfd to avoid being
awaken again
---
src/backend/epoll.zig | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/src/backend/epoll.zig b/src/backend/epoll.zig
index f44d326..f84c687 100644
--- a/src/backend/epoll.zig
+++ b/src/backend/epoll.zig
@@ -280,7 +280,7 @@ pub const Loop = struct {
var ev: linux.epoll_event = .{
.events = linux.EPOLL.IN | linux.EPOLL.RDHUP,
- .data = .{ .ptr = 0 },
+ .data = .{ .fd = self.eventfd.fd },
};
posix.epoll_ctl(
self.fd,
@@ -397,9 +397,12 @@ pub const Loop = struct {
// Process all our events and invoke their completion handlers
for (events[0..n]) |ev| {
- // Zero data values are internal events that we do nothing
- // on such as the eventfd wakeup.
- if (ev.data.ptr == 0) continue;
+ // Handle wakeup eventfd
+ if (ev.data.fd == self.eventfd.fd) {
+ var buffer: u64 = undefined;
+ _ = posix.read(self.eventfd.fd, std.mem.asBytes(&buffer)) catch {};
+ continue;
+ }
const c: *Completion = @ptrFromInt(@as(usize, @intCast(ev.data.ptr)));
From 258a64180c901b5e1f9a2c75f1ac77a758411450 Mon Sep 17 00:00:00 2001
From: Steeve Morin <steeve@zml.ai>
Date: Fri, 17 Jan 2025 20:47:42 +0000
Subject: [PATCH 6/8] epoll: use infinite timeout for epoll_wait
Since eventfd is now implemented.
---
src/backend/epoll.zig | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/src/backend/epoll.zig b/src/backend/epoll.zig
index f84c687..e3eee20 100644
--- a/src/backend/epoll.zig
+++ b/src/backend/epoll.zig
@@ -375,9 +375,7 @@ pub const Loop = struct {
const timeout: i32 = if (wait_rem == 0) 0 else timeout: {
// If we have a timer, we want to set the timeout to our next
// timer value. If we have no timer, we wait forever.
- // TODO: do not wait 100ms here, use an eventfd for our
- // thread pool to wake us up.
- const t = self.timers.peek() orelse break :timeout 100;
+ const t = self.timers.peek() orelse break :timeout -1;
// Determine the time in milliseconds.
const ms_now = @as(u64, @intCast(self.cached_now.tv_sec)) * std.time.ms_per_s +
From 9ff535f9b6fac454d454f2799b93863dc9aba7d4 Mon Sep 17 00:00:00 2001
From: Steeve Morin <steeve@zml.ai>
Date: Fri, 17 Jan 2025 20:48:27 +0000
Subject: [PATCH 7/8] epoll,kqueue: dispatch close in threadpool
Close might block, so dispatch it inside a threadpool.
---
src/backend/epoll.zig | 15 +++++++++++++--
src/backend/kqueue.zig | 6 +++++-
src/watcher/stream.zig | 16 ++++++++++++++++
3 files changed, 34 insertions(+), 3 deletions(-)
diff --git a/src/backend/epoll.zig b/src/backend/epoll.zig
index e3eee20..0f4a2ac 100644
--- a/src/backend/epoll.zig
+++ b/src/backend/epoll.zig
@@ -700,6 +700,13 @@ pub const Loop = struct {
},
.close => |v| res: {
+ if (completion.flags.threadpool) {
+ if (self.thread_schedule(completion)) |_|
+ return
+ else |err|
+ break :res .{ .close = err };
+ }
+
posix.close(v.fd);
break :res .{ .close = {} };
},
@@ -909,7 +916,6 @@ pub const Completion = struct {
// This should never happen because we always do these synchronously
// or in another location.
.cancel,
- .close,
.noop,
.shutdown,
.timer,
@@ -1015,6 +1021,11 @@ pub const Completion = struct {
err,
};
},
+
+ .close => |*op| res: {
+ posix.close(op.fd);
+ break :res .{ .close = {} };
+ },
};
}
@@ -1277,7 +1288,7 @@ pub const AcceptError = posix.EpollCtlError || error{
Unknown,
};
-pub const CloseError = posix.EpollCtlError || error{
+pub const CloseError = posix.EpollCtlError || ThreadPoolError || error{
Unknown,
};
diff --git a/src/backend/kqueue.zig b/src/backend/kqueue.zig
index 456f64f..9914309 100644
--- a/src/backend/kqueue.zig
+++ b/src/backend/kqueue.zig
@@ -1102,7 +1102,6 @@ pub const Completion = struct {
fn perform(self: *Completion, ev_: ?*const Kevent) Result {
return switch (self.op) {
.cancel,
- .close,
.noop,
.timer,
.shutdown,
@@ -1232,6 +1231,11 @@ pub const Completion = struct {
break :res .{ .proc = 0 };
},
+
+ .close => |*op| res: {
+ posix.close(op.fd);
+ break :res .{ .close = {} };
+ },
};
}
diff --git a/src/watcher/stream.zig b/src/watcher/stream.zig
index 7f5df6f..bc95282 100644
--- a/src/watcher/stream.zig
+++ b/src/watcher/stream.zig
@@ -80,6 +80,22 @@ pub fn Closeable(comptime xev: type, comptime T: type, comptime options: Options
}).callback,
};
+ // If we're dup-ing, then we ask the backend to manage the fd.
+ switch (xev.backend) {
+ .io_uring,
+ .wasi_poll,
+ .iocp,
+ => {},
+
+ .epoll => {
+ c.flags.threadpool = true;
+ },
+
+ .kqueue => {
+ c.flags.threadpool = true;
+ },
+ }
+
loop.add(c);
}
};
From 003416b0b410e70daab0d55ddc48e8e443f4fd09 Mon Sep 17 00:00:00 2001
From: Steeve Morin <steeve@zml.ai>
Date: Fri, 17 Jan 2025 20:59:18 +0000
Subject: [PATCH 8/8] epoll: don't count immediate actions
If an immediate action is dispatched, the loop might block
on epoll_wait even though only one action was requested.
---
src/backend/epoll.zig | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/src/backend/epoll.zig b/src/backend/epoll.zig
index 0f4a2ac..fb7e59e 100644
--- a/src/backend/epoll.zig
+++ b/src/backend/epoll.zig
@@ -297,6 +297,7 @@ pub const Loop = struct {
// Submit all the submissions. We copy the submission queue so that
// any resubmits don't cause an infinite loop.
+ var wait_rem: usize = @intCast(wait);
var queued = self.submissions;
self.submissions = .{};
while (queued.pop()) |c| {
@@ -304,6 +305,19 @@ pub const Loop = struct {
// This usually means that we switched them to be deleted or
// something.
if (c.flags.state != .adding) continue;
+
+ // These operations happen synchronously. Ensure they are
+ // decremented from wait_rem.
+ switch (c.op) {
+ .cancel,
+ // should noop be counted?
+ // .noop,
+ .shutdown,
+ .timer,
+ => wait_rem -|= 1,
+ else => {},
+ }
+
self.start(c);
}
@@ -322,7 +336,6 @@ pub const Loop = struct {
// Wait and process events. We only do this if we have any active.
var events: [1024]linux.epoll_event = undefined;
- var wait_rem: usize = @intCast(wait);
while (self.active > 0 and (wait == 0 or wait_rem > 0)) {
self.update_now();
const now_timer: Operation.Timer = .{ .next = self.cached_now };