io-event 1.6.5 → 1.9.0

data/ext/io/event/selector/selector.c

@@ -1,65 +1,13 @@
-// Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
-// 
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-// 
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-// 
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
+// Released under the MIT License.
+// Copyright, 2021-2025, by Samuel Williams.
 
 #include "selector.h"
+
 #include <fcntl.h>
+#include <stdlib.h>
 
 static const int DEBUG = 0;
 
-static ID id_transfer, id_alive_p;
-
-VALUE IO_Event_Selector_fiber_transfer(VALUE fiber, int argc, VALUE *argv) {
-	// TODO Consider introducing something like `rb_fiber_scheduler_transfer(...)`.
-#ifdef HAVE__RB_FIBER_TRANSFER
-	if (RTEST(rb_obj_is_fiber(fiber))) {
-		if (RTEST(rb_fiber_alive_p(fiber))) {
-			return rb_fiber_transfer(fiber, argc, argv);
-		}
-		
-		return Qnil;
-	}
-#endif
-	if (RTEST(rb_funcall(fiber, id_alive_p, 0))) {
-		return rb_funcallv(fiber, id_transfer, argc, argv);
-	}
-	
-	return Qnil;
-}
-
-#ifndef HAVE__RB_FIBER_RAISE
-static ID id_raise;
-
-VALUE IO_Event_Selector_fiber_raise(VALUE fiber, int argc, VALUE *argv) {
-	return rb_funcallv(fiber, id_raise, argc, argv);
-}
-#endif
-
-#ifndef HAVE_RB_FIBER_CURRENT
-static ID id_current;
-
-static VALUE rb_fiber_current() {
-	return rb_funcall(rb_cFiber, id_current, 0);
-}
-#endif
-
-
 #ifndef HAVE_RB_IO_DESCRIPTOR
 static ID id_fileno;
 
@@ -136,17 +84,6 @@ static VALUE IO_Event_Selector_nonblock(VALUE class, VALUE io)
 }
 
 void Init_IO_Event_Selector(VALUE IO_Event_Selector) {
-	id_transfer = rb_intern("transfer");
-	id_alive_p = rb_intern("alive?");
-	
-#ifndef HAVE__RB_FIBER_RAISE
-	id_raise = rb_intern("raise");
-#endif
-	
-#ifndef HAVE_RB_FIBER_CURRENT
-	id_current = rb_intern("current");
-#endif
-	
 #ifndef HAVE_RB_IO_DESCRIPTOR
 	id_fileno = rb_intern("fileno");
 #endif
@@ -156,10 +93,29 @@ void Init_IO_Event_Selector(VALUE IO_Event_Selector) {
 	rb_Process_Status = rb_const_get_at(rb_mProcess, rb_intern("Status"));
 	rb_gc_register_mark_object(rb_Process_Status);
 #endif
-
+	
 	rb_define_singleton_method(IO_Event_Selector, "nonblock", IO_Event_Selector_nonblock, 1);
 }
 
+void IO_Event_Selector_initialize(struct IO_Event_Selector *backend, VALUE self, VALUE loop) {
+	RB_OBJ_WRITE(self, &backend->self, self);
+	RB_OBJ_WRITE(self, &backend->loop, loop);
+	
+	backend->waiting = NULL;
+	backend->ready = NULL;
+}
+
+VALUE IO_Event_Selector_loop_resume(struct IO_Event_Selector *backend, VALUE fiber, int argc, VALUE *argv) {
+	return IO_Event_Fiber_transfer(fiber, argc, argv);
+}
+
+VALUE IO_Event_Selector_loop_yield(struct IO_Event_Selector *backend)
+{
+	// TODO Why is this assertion failing in async?
+	// RUBY_ASSERT(backend->loop != IO_Event_Fiber_current());
+	return IO_Event_Fiber_transfer(backend->loop, 0, NULL);
+}
+
 struct wait_and_transfer_arguments {
 	int argc;
 	VALUE *argv;
@@ -172,24 +128,35 @@ static void queue_pop(struct IO_Event_Selector *backend, struct IO_Event_Selecto
 	if (waiting->head) {
 		waiting->head->tail = waiting->tail;
 	} else {
+		// We must have been at the head of the queue:
 		backend->waiting = waiting->tail;
 	}
 	
 	if (waiting->tail) {
 		waiting->tail->head = waiting->head;
 	} else {
+		// We must have been at the tail of the queue:
 		backend->ready = waiting->head;
 	}
+	
+	waiting->head = NULL;
+	waiting->tail = NULL;
 }
 
 static void queue_push(struct IO_Event_Selector *backend, struct IO_Event_Selector_Queue *waiting) {
+	assert(waiting->head == NULL);
+	assert(waiting->tail == NULL);
+	
 	if (backend->waiting) {
+		// If there was an item in the queue already, we shift it along:
 		backend->waiting->head = waiting;
 		waiting->tail = backend->waiting;
 	} else {
+		// If the queue was empty, we update the tail too:
 		backend->ready = waiting;
 	}
 	
+	// We always push to the front/head:
 	backend->waiting = waiting;
 }
 
@@ -200,7 +167,7 @@ static VALUE wait_and_transfer(VALUE _arguments) {
 	int argc = arguments->argc - 1;
 	VALUE *argv = arguments->argv + 1;
 	
-	return IO_Event_Selector_fiber_transfer(fiber, argc, argv);
+	return IO_Event_Selector_loop_resume(arguments->backend, fiber, argc, argv);
 }
 
 static VALUE wait_and_transfer_ensure(VALUE _arguments) {
@@ -219,9 +186,11 @@ VALUE IO_Event_Selector_resume(struct IO_Event_Selector *backend, int argc, VALU
 		.head = NULL,
 		.tail = NULL,
 		.flags = IO_EVENT_SELECTOR_QUEUE_FIBER,
-		.fiber = rb_fiber_current()
+		.fiber = IO_Event_Fiber_current()
 	};
 	
+	RB_OBJ_WRITTEN(backend->self, Qundef, waiting.fiber);
+	
 	queue_push(backend, &waiting);
 	
 	struct wait_and_transfer_arguments arguments = {
@@ -241,7 +210,7 @@ static VALUE wait_and_raise(VALUE _arguments) {
 	int argc = arguments->argc - 1;
 	VALUE *argv = arguments->argv + 1;
 	
-	return IO_Event_Selector_fiber_raise(fiber, argc, argv);
+	return IO_Event_Fiber_raise(fiber, argc, argv);
 }
 
 VALUE IO_Event_Selector_raise(struct IO_Event_Selector *backend, int argc, VALUE *argv)
@@ -252,9 +221,11 @@ VALUE IO_Event_Selector_raise(struct IO_Event_Selector *backend, int argc, VALUE
 		.head = NULL,
 		.tail = NULL,
 		.flags = IO_EVENT_SELECTOR_QUEUE_FIBER,
-		.fiber = rb_fiber_current()
+		.fiber = IO_Event_Fiber_current()
 	};
 	
+	RB_OBJ_WRITTEN(backend->self, Qundef, waiting.fiber);
+	
 	queue_push(backend, &waiting);
 	
 	struct wait_and_transfer_arguments arguments = {
@@ -267,42 +238,49 @@ VALUE IO_Event_Selector_raise(struct IO_Event_Selector *backend, int argc, VALUE
 	return rb_ensure(wait_and_raise, (VALUE)&arguments, wait_and_transfer_ensure, (VALUE)&arguments);
 }
 
-void IO_Event_Selector_queue_push(struct IO_Event_Selector *backend, VALUE fiber)
+void IO_Event_Selector_ready_push(struct IO_Event_Selector *backend, VALUE fiber)
 {
 	struct IO_Event_Selector_Queue *waiting = malloc(sizeof(struct IO_Event_Selector_Queue));
+	assert(waiting);
 	
 	waiting->head = NULL;
 	waiting->tail = NULL;
 	waiting->flags = IO_EVENT_SELECTOR_QUEUE_INTERNAL;
-	waiting->fiber = fiber;
+	
+	RB_OBJ_WRITE(backend->self, &waiting->fiber, fiber);
 	
 	queue_push(backend, waiting);
 }
 
 static inline
-void IO_Event_Selector_queue_pop(struct IO_Event_Selector *backend, struct IO_Event_Selector_Queue *ready)
+void IO_Event_Selector_ready_pop(struct IO_Event_Selector *backend, struct IO_Event_Selector_Queue *ready)
 {
-	if (DEBUG) fprintf(stderr, "IO_Event_Selector_queue_pop -> %p\n", (void*)ready->fiber);
-	if (ready->flags & IO_EVENT_SELECTOR_QUEUE_FIBER) {
-		IO_Event_Selector_fiber_transfer(ready->fiber, 0, NULL);
-	} else {
-		VALUE fiber = ready->fiber;
+	if (DEBUG) fprintf(stderr, "IO_Event_Selector_ready_pop -> %p\n", (void*)ready->fiber);
+	
+	VALUE fiber = ready->fiber;
+	
+	if (ready->flags & IO_EVENT_SELECTOR_QUEUE_INTERNAL) {
+		// This means that the fiber was added to the ready queue by the selector itself, and we need to transfer control to it, but before we do that, we need to remove it from the queue, as there is no expectation that returning from `transfer` will remove it.
 		queue_pop(backend, ready);
 		free(ready);
-		
-		if (RTEST(rb_funcall(fiber, id_alive_p, 0))) {
-			rb_funcall(fiber, id_transfer, 0);
-		}
+	} else if (ready->flags & IO_EVENT_SELECTOR_QUEUE_FIBER) {
+		// This means the fiber added itself to the ready queue, and we need to transfer control back to it. Transferring control back to the fiber will call `queue_pop` and remove it from the queue.
+	} else {
+		rb_raise(rb_eRuntimeError, "Unknown queue type!");
 	}
+	
+	IO_Event_Selector_loop_resume(backend, fiber, 0, NULL);
 }
 
-int IO_Event_Selector_queue_flush(struct IO_Event_Selector *backend)
+int IO_Event_Selector_ready_flush(struct IO_Event_Selector *backend)
 {
 	int count = 0;
 	
+	// During iteration of the queue, the same item may be re-queued. If we don't handle this correctly, we may end up in an infinite loop. So, to avoid this situation, we keep note of the current head of the queue and break the loop if we reach the same item again.
+	
 	// Get the current tail and head of the queue:
 	struct IO_Event_Selector_Queue *waiting = backend->waiting;
-	if (DEBUG) fprintf(stderr, "IO_Event_Selector_queue_flush waiting = %p\n", waiting);
+	if (DEBUG) fprintf(stderr, "IO_Event_Selector_ready_flush waiting = %p\n", waiting);
 	
 	// Process from head to tail in order:
 	// During this, more items may be appended to tail.
@@ -311,25 +289,10 @@ int IO_Event_Selector_queue_flush(struct IO_Event_Selector *backend)
 		struct IO_Event_Selector_Queue *ready = backend->ready;
 		
 		count += 1;
-		IO_Event_Selector_queue_pop(backend, ready);
+		IO_Event_Selector_ready_pop(backend, ready);
 		
 		if (ready == waiting) break;
 	}
 	
 	return count;
 }
-
-void IO_Event_Selector_elapsed_time(struct timespec* start, struct timespec* stop, struct timespec *duration)
-{
-	if ((stop->tv_nsec - start->tv_nsec) < 0) {
-		duration->tv_sec = stop->tv_sec - start->tv_sec - 1;
-		duration->tv_nsec = stop->tv_nsec - start->tv_nsec + 1000000000;
-	} else {
-		duration->tv_sec = stop->tv_sec - start->tv_sec;
-		duration->tv_nsec = stop->tv_nsec - start->tv_nsec;
-	}
-}
-
-void IO_Event_Selector_current_time(struct timespec *time) {
-	clock_gettime(CLOCK_MONOTONIC, time);
-}

data/ext/io/event/selector/selector.h

@@ -1,22 +1,5 @@
-// Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
-// 
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-// 
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-// 
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
+// Released under the MIT License.
+// Copyright, 2021-2025, by Samuel Williams.
 
 #pragma once
 
@@ -24,6 +7,9 @@
 #include <ruby/thread.h>
 #include <ruby/io.h>
 
+#include "../time.h"
+#include "../fiber.h"
+
 #ifdef HAVE_RUBY_IO_BUFFER_H
 #include <ruby/io/buffer.h>
 #include <ruby/fiber/scheduler.h>
@@ -33,8 +19,6 @@
 #define RUBY_FIBER_SCHEDULER_VERSION 1
 #endif
 
-#include <time.h>
-
 #ifdef HAVE_SYS_WAIT_H
 #include <sys/wait.h>
 #endif
@@ -56,14 +40,6 @@ static inline int IO_Event_try_again(int error) {
 	return error == EAGAIN || error == EWOULDBLOCK;
 }
 
-VALUE IO_Event_Selector_fiber_transfer(VALUE fiber, int argc, VALUE *argv);
-
-#ifdef HAVE__RB_FIBER_RAISE
-#define IO_Event_Selector_fiber_raise(fiber, argc, argv) rb_fiber_raise(fiber, argc, argv)
-#else
-VALUE IO_Event_Selector_fiber_raise(VALUE fiber, int argc, VALUE *argv);
-#endif
-
 #ifdef HAVE_RB_IO_DESCRIPTOR
 #define IO_Event_Selector_io_descriptor(io) rb_io_descriptor(io)
 #else
@@ -94,28 +70,27 @@ struct IO_Event_Selector_Queue {
 	VALUE fiber;
 };
 
+// The internal state of the event selector.
+// The event selector is responsible for managing the scheduling of fibers, as well as selecting for events.
 struct IO_Event_Selector {
+	VALUE self;
 	VALUE loop;
 	
-	struct IO_Event_Selector_Queue *free;
-	
-	// Append to waiting.
+	// The ready queue is a list of fibers that are ready to be resumed from the event loop fiber.
+	// Append to waiting (front/head of queue).
 	struct IO_Event_Selector_Queue *waiting;
-	// Process from ready.
+	// Process from ready (back/tail of queue).
 	struct IO_Event_Selector_Queue *ready;
 };
 
-static inline
-void IO_Event_Selector_initialize(struct IO_Event_Selector *backend, VALUE loop) {
-	backend->loop = loop;
-	backend->waiting = NULL;
-	backend->ready = NULL;
-}
+void IO_Event_Selector_initialize(struct IO_Event_Selector *backend, VALUE self, VALUE loop);
 
 static inline
 void IO_Event_Selector_mark(struct IO_Event_Selector *backend) {
+	rb_gc_mark_movable(backend->self);
 	rb_gc_mark_movable(backend->loop);
 	
+	// Walk backwards through the ready queue:
 	struct IO_Event_Selector_Queue *ready = backend->ready;
 	while (ready) {
 		rb_gc_mark_movable(ready->fiber);
@@ -125,6 +100,7 @@ void IO_Event_Selector_mark(struct IO_Event_Selector *backend) {
 
 static inline
 void IO_Event_Selector_compact(struct IO_Event_Selector *backend) {
+	backend->self = rb_gc_location(backend->self);
 	backend->loop = rb_gc_location(backend->loop);
 	
 	struct IO_Event_Selector_Queue *ready = backend->ready;
@@ -134,20 +110,49 @@ void IO_Event_Selector_compact(struct IO_Event_Selector *backend) {
 	}
 }
 
+// Transfer control from the event loop to a user fiber.
+// This is used to transfer control to a user fiber when it may proceed.
+// Strictly speaking, it's not a scheduling operation (does not schedule the current fiber).
+VALUE IO_Event_Selector_loop_resume(struct IO_Event_Selector *backend, VALUE fiber, int argc, VALUE *argv);
+
+// Transfer from a user fiber back to the event loop.
+// This is used to transfer control back to the event loop in order to wait for events.
+// Strictly speaking, it's not a scheduling operation (does not schedule the current fiber).
+VALUE IO_Event_Selector_loop_yield(struct IO_Event_Selector *backend);
+
+// Resume a specific fiber. This is a scheduling operation.
+// The first argument is the fiber, the rest are the arguments to the resume.
+//
+// The implementation has two possible strategies:
+// 1. Add the current fiber to the ready queue and transfer control to the target fiber.
+// 2. Schedule the target fiber to be resumed by the event loop later on.
+//
+// We currently only implement the first strategy.
 VALUE IO_Event_Selector_resume(struct IO_Event_Selector *backend, int argc, VALUE *argv);
+
+// Raise an exception on a specific fiber.
+// The first argument is the fiber, the rest are the arguments to the exception.
+//
+// The implementation has two possible strategies:
+// 1. Add the current fiber to the ready queue and transfer control to the target fiber.
+// 2. Schedule the target fiber to be resumed by the event loop with an exception later on.
+//
+// We currently only implement the first strategy.
 VALUE IO_Event_Selector_raise(struct IO_Event_Selector *backend, int argc, VALUE *argv);
 
+// Yield control to the event loop. This is a scheduling operation.
+//
+// The implementation adds the current fiber to the ready queue and transfers control to the event loop.
 static inline
 VALUE IO_Event_Selector_yield(struct IO_Event_Selector *backend)
 {
 	return IO_Event_Selector_resume(backend, 1, &backend->loop);
 }
 
-void IO_Event_Selector_queue_push(struct IO_Event_Selector *backend, VALUE fiber);
-int IO_Event_Selector_queue_flush(struct IO_Event_Selector *backend);
-
-void IO_Event_Selector_elapsed_time(struct timespec* start, struct timespec* stop, struct timespec *duration);
-void IO_Event_Selector_current_time(struct timespec *time);
+// Append a specific fiber to the ready queue.
+// The fiber can be an actual fiber or an object that responds to `alive?` and `transfer`.
+// The implementation will transfer control to the fiber later on.
+void IO_Event_Selector_ready_push(struct IO_Event_Selector *backend, VALUE fiber);
 
-#define PRINTF_TIMESPEC "%lld.%.9ld"
-#define PRINTF_TIMESPEC_ARGS(ts) (long long)((ts).tv_sec), (ts).tv_nsec
+// Flush the ready queue by transferring control one at a time.
+int IO_Event_Selector_ready_flush(struct IO_Event_Selector *backend);