io-event 1.6.5 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53b1f32affa83ac713eaaf8fba4b9a1c9d2f25421908759dde9b5adec11c498f
-  data.tar.gz: 6504222eab182d55f2b56ef91c4de9f301f509a69fff17f286c03f0ef0315786
+  metadata.gz: 7265f0fb5702ae05b5d928a8efb9e5a5e877f62afc5c93d23fec26f8a3dd1437
+  data.tar.gz: 8ba9b4b0d4e95be1401b8952cccac1a9bcc93c7a0a40e843aea60f0015c791ad
 SHA512:
-  metadata.gz: ac5f863272fb2a532d1adbe16e2960f78dd6f4ce52891e391f301d40bb28ad74e2775348d55610f1f308f7a69b0b362e93f794b44fe94b4ec6e91331a2e851d5
-  data.tar.gz: 042a1a3ba4ec1a3e438d823b9d9348eeebc86be2464030744a9a01ff50654aeeb229fb79729083d3f1bdb2feb968dcee8ec320d33de7083196eb1afd887c5ef6
+  metadata.gz: b4346972aa2dbe00b560e2a1e2cce32a50e9acafaa0c9253f12791c183f35bea8e3cffba93eb93147b4d975ef05edeffef84e0ed8bf29934fb39c70ea1320c6f
+  data.tar.gz: 41b6b53ca30bd0934c702c1ff0899e0e8a6bd3bc97a95f455b0d6cf0be28ff690b69575c44d92a784226edea27958cd43c486e9d907989859e298d602536078b

data/ext/extconf.rb

@@ -2,46 +2,51 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2025, by Samuel Williams.
 # Copyright, 2023, by Math Ieu.
 
 return if RUBY_DESCRIPTION =~ /jruby/
 
-require 'mkmf'
+require "mkmf"
 
 gem_name = File.basename(__dir__)
-extension_name = 'IO_Event'
+extension_name = "IO_Event"
 
 # dir_config(extension_name)
 
 $CFLAGS << " -Wall -Wno-unknown-pragmas -std=c99"
 
-if ENV.key?('RUBY_DEBUG')
+if ENV.key?("RUBY_DEBUG")
+	$stderr.puts "Enabling debug mode..."
+	
 	$CFLAGS << " -DRUBY_DEBUG -O0"
 end
 
-$srcs = ["io/event/event.c", "io/event/selector/selector.c"]
+$srcs = ["io/event/event.c", "io/event/time.c", "io/event/fiber.c", "io/event/profiler.c", "io/event/selector/selector.c"]
 $VPATH << "$(srcdir)/io/event"
 $VPATH << "$(srcdir)/io/event/selector"
 
-have_func('rb_ext_ractor_safe')
-have_func('&rb_fiber_transfer')
+have_func("rb_ext_ractor_safe")
+have_func("&rb_fiber_transfer")
 
-if have_library('uring') and have_header('liburing.h')
+if have_library("uring") and have_header("liburing.h")
+	# We might want to consider using this in the future:
+	# have_func("io_uring_submit_and_wait_timeout", "liburing.h")
+	
 	$srcs << "io/event/selector/uring.c"
 end
 
-if have_header('sys/epoll.h')
+if have_header("sys/epoll.h")
 	$srcs << "io/event/selector/epoll.c"
 end
 
-if have_header('sys/event.h')
+if have_header("sys/event.h")
 	$srcs << "io/event/selector/kqueue.c"
 end
 
-have_header('sys/wait.h')
+have_header("sys/wait.h")
 
-have_header('sys/eventfd.h')
+have_header("sys/eventfd.h")
 $srcs << "io/event/interrupt.c"
 
 have_func("rb_io_descriptor")
@@ -50,7 +55,15 @@ have_func("rb_fiber_current")
 have_func("&rb_fiber_raise")
 have_func("epoll_pwait2")
 
-have_header('ruby/io/buffer.h')
+have_header("ruby/io/buffer.h")
+
+if ENV.key?("RUBY_SANITIZE")
+	$stderr.puts "Enabling sanitizers..."
+	
+	# Add address and undefined behaviour sanitizers:
+	$CFLAGS << " -fsanitize=address -fsanitize=undefined -fno-omit-frame-pointer"
+	$LDFLAGS << " -fsanitize=address -fsanitize=undefined"
+end
 
 create_header
 

data/ext/io/event/{selector/array.h → array.h}

@@ -8,6 +8,9 @@
 #include <errno.h>
 #include <assert.h>
 
+static const size_t IO_EVENT_ARRAY_MAXIMUM_COUNT = SIZE_MAX / sizeof(void*);
+static const size_t IO_EVENT_ARRAY_DEFAULT_COUNT = 128;
+
 struct IO_Event_Array {
 	// The array of pointers to elements:
 	void **base;
@@ -25,18 +28,27 @@ struct IO_Event_Array {
 	void (*element_free)(void*);
 };
 
-inline static void IO_Event_Array_allocate(struct IO_Event_Array *array, size_t count, size_t element_size)
+inline static int IO_Event_Array_initialize(struct IO_Event_Array *array, size_t count, size_t element_size)
 {
+	array->limit = 0;
+	array->element_size = element_size;
+	
 	if (count) {
 		array->base = (void**)calloc(count, sizeof(void*));
+		
+		if (array->base == NULL) {
+			return -1;
+		}
+		
 		array->count = count;
+		
+		return 1;
 	} else {
 		array->base = NULL;
 		array->count = 0;
+		
+		return 0;
 	}
-	
-	array->limit = 0;
-	array->element_size = element_size;
 }
 
 inline static size_t IO_Event_Array_memory_size(const struct IO_Event_Array *array)
@@ -47,31 +59,51 @@ inline static size_t IO_Event_Array_memory_size(const struct IO_Event_Array *arr
 
 inline static void IO_Event_Array_free(struct IO_Event_Array *array)
 {
-	for (size_t i = 0; i < array->limit; i += 1) {
-		void *element = array->base[i];
-		if (element) {
-			array->element_free(element);
-			free(element);
+	if (array->base) {
+		void **base = array->base;
+		size_t limit = array->limit;
+		
+		array->base = NULL;
+		array->count = 0;
+		array->limit = 0;
+		
+		for (size_t i = 0; i < limit; i += 1) {
+			void *element = base[i];
+			if (element) {
+				array->element_free(element);
+				
+				free(element);
+			}
 		}
+		
+		free(base);
 	}
-	
-	if (array->base)
-		free(array->base);
-	
-	array->base = NULL;
-	array->count = 0;
-	array->limit = 0;
 }
 
 inline static int IO_Event_Array_resize(struct IO_Event_Array *array, size_t count)
 {
 	if (count <= array->count) {
+		// Already big enough:
 		return 0;
 	}
 	
-	// Compute the next multiple (ideally a power of 2):
+	if (count > IO_EVENT_ARRAY_MAXIMUM_COUNT) {
+		errno = ENOMEM;
+		return -1;
+	}
+	
 	size_t new_count = array->count;
-	while (new_count < count) {
+	
+	// If the array is empty, we need to set the initial size:
+	if (new_count == 0) new_count = IO_EVENT_ARRAY_DEFAULT_COUNT;
+	else while (new_count < count) {
+		// Ensure we don't overflow:
+		if (new_count > (IO_EVENT_ARRAY_MAXIMUM_COUNT / 2)) {
+			new_count = IO_EVENT_ARRAY_MAXIMUM_COUNT;
+			break;
+		}
+		
+		// Compute the next multiple (ideally a power of 2):
 		new_count *= 2;
 	}
 	
@@ -87,6 +119,7 @@ inline static int IO_Event_Array_resize(struct IO_Event_Array *array, size_t cou
 	array->base = (void**)new_base;
 	array->count = new_count;
 	
+	// Resizing sucessful:
 	return 1;
 }
 
@@ -107,6 +140,7 @@ inline static void* IO_Event_Array_lookup(struct IO_Event_Array *array, size_t i
 	// Allocate the element if it doesn't exist:
 	if (*element == NULL) {
 		*element = malloc(array->element_size);
+		assert(*element);
 		
 		if (array->element_initialize) {
 			array->element_initialize(*element);
@@ -119,6 +153,28 @@ inline static void* IO_Event_Array_lookup(struct IO_Event_Array *array, size_t i
 	return *element;
 }
 
+inline static void* IO_Event_Array_last(struct IO_Event_Array *array)
+{
+	if (array->limit == 0) return NULL;
+	else return array->base[array->limit - 1];
+}
+
+inline static void IO_Event_Array_truncate(struct IO_Event_Array *array, size_t limit)
+{
+	if (limit < array->limit) {
+		for (size_t i = limit; i < array->limit; i += 1) {
+			void **element = array->base + i;
+			if (*element) {
+				array->element_free(*element);
+				free(*element);
+				*element = NULL;
+			}
+		}
+		
+		array->limit = limit;
+	}
+}
+
 // Push a new element onto the end of the array.
 inline static void* IO_Event_Array_push(struct IO_Event_Array *array)
 {

data/ext/io/event/event.c

@@ -1,28 +1,11 @@
-// 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 "event.h"
+#include "fiber.h"
+#include "profiler.h"
 #include "selector/selector.h"
-
-VALUE IO_Event = Qnil;
-VALUE IO_Event_Selector = Qnil;
+#include <complex.h>
 
 void Init_IO_Event(void)
 {
@@ -30,12 +13,12 @@ void Init_IO_Event(void)
 	rb_ext_ractor_safe(true);
 #endif
 	
-	IO_Event = rb_define_module_under(rb_cIO, "Event");
-	rb_gc_register_mark_object(IO_Event);
+	VALUE IO_Event = rb_define_module_under(rb_cIO, "Event");
 	
-	IO_Event_Selector = rb_define_module_under(IO_Event, "Selector");
-	rb_gc_register_mark_object(IO_Event_Selector);
+	Init_IO_Event_Fiber(IO_Event);
+	Init_IO_Event_Profiler(IO_Event);
 	
+	VALUE IO_Event_Selector = rb_define_module_under(IO_Event, "Selector");
 	Init_IO_Event_Selector(IO_Event_Selector);
 	
 	#ifdef IO_EVENT_SELECTOR_URING

data/ext/io/event/event.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
 

data/ext/io/event/fiber.c

@@ -0,0 +1,63 @@
+// Released under the MIT License.
+// Copyright, 2025, by Samuel Williams.
+
+#include "fiber.h"
+
+static ID id_transfer, id_alive_p;
+
+VALUE IO_Event_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);
+		}
+		
+		// If it's a fiber, but dead, we are done.
+		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_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 IO_Event_Fiber_current(void) {
+	return rb_funcall(rb_cFiber, id_current, 0);
+}
+#endif
+
+// There is no public interface for this... yet.
+static ID id_blocking_p;
+
+int IO_Event_Fiber_blocking(VALUE fiber) {
+	return RTEST(rb_funcall(fiber, id_blocking_p, 0));
+}
+
+void Init_IO_Event_Fiber(VALUE IO_Event) {
+	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
+	
+	id_blocking_p = rb_intern("blocking?");
+}

data/ext/io/event/fiber.h

@@ -0,0 +1,23 @@
+// Released under the MIT License.
+// Copyright, 2025, by Samuel Williams.
+
+#pragma once
+
+#include <ruby.h>
+
+VALUE IO_Event_Fiber_transfer(VALUE fiber, int argc, VALUE *argv);
+
+#ifdef HAVE__RB_FIBER_RAISE
+#define IO_Event_Fiber_raise(fiber, argc, argv) rb_fiber_raise(fiber, argc, argv)
+#else
+VALUE IO_Event_Fiber_raise(VALUE fiber, int argc, VALUE *argv);
+#endif
+
+#ifdef HAVE_RB_FIBER_CURRENT
+#define IO_Event_Fiber_current() rb_fiber_current()
+#else
+VALUE IO_Event_Fiber_current(void);
+#endif
+
+int IO_Event_Fiber_blocking(VALUE fiber);
+void Init_IO_Event_Fiber(VALUE IO_Event);

data/ext/io/event/interrupt.c

@@ -1,30 +1,18 @@
-// 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.
-
-// static const int DEBUG = 0;
+// Released under the MIT License.
+// Copyright, 2021-2025, by Samuel Williams.
 
 #include "interrupt.h"
 #include <unistd.h>
 
 #include "selector/selector.h"
 
+#ifdef HAVE_RUBY_WIN32_H
+#include <ruby/win32.h>
+#if !defined(HAVE_PIPE) && !defined(pipe)
+#define pipe(p)	rb_w32_pipe(p)
+#endif
+#endif
+
 #ifdef HAVE_SYS_EVENTFD_H
 #include <sys/eventfd.h>
 
@@ -88,9 +76,11 @@ void IO_Event_Interrupt_signal(struct IO_Event_Interrupt *interrupt)
 	ssize_t result = write(interrupt->descriptor[1], ".", 1);
 	
 	if (result == -1) {
-		if (errno == EAGAIN || errno == EWOULDBLOCK) return;
-		
-		rb_sys_fail("IO_Event_Interrupt_signal:write");
+		if (errno == EAGAIN || errno == EWOULDBLOCK) {
+			// If we can't write to the pipe, it means the other end is full. In that case, we can be sure that the other end has already been woken up or is about to be woken up.
+		} else {
+			rb_sys_fail("IO_Event_Interrupt_signal:write");
+		}
 	}
 }
 
@@ -100,9 +90,11 @@ void IO_Event_Interrupt_clear(struct IO_Event_Interrupt *interrupt)
 	ssize_t result = read(interrupt->descriptor[0], buffer, sizeof(buffer));
 	
 	if (result == -1) {
-		if (errno == EAGAIN || errno == EWOULDBLOCK) return;
-		
-		rb_sys_fail("IO_Event_Interrupt_clear:read");
+		if (errno == EAGAIN || errno == EWOULDBLOCK) {
+			// If we can't read from the pipe, it means the other end is empty. In that case, we can be sure that the other end is already clear.
+		} else {
+			rb_sys_fail("IO_Event_Interrupt_clear:read");
+		}
 	}
 }
 #endif

data/ext/io/event/interrupt.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
 

data/ext/io/event/{selector/list.h → list.h}

@@ -1,5 +1,5 @@
 // Released under the MIT License.
-// Copyright, 2023, by Samuel Williams.
+// Copyright, 2023-2025, by Samuel Williams.
 
 #include <ruby.h>
 #include <stdio.h>
@@ -38,6 +38,7 @@ inline static void IO_Event_List_append(struct IO_Event_List *list, struct IO_Ev
 	head->tail = node;
 }
 
+// Prepend an item to the beginning of the list.
 inline static void IO_Event_List_prepend(struct IO_Event_List *list, struct IO_Event_List *node)
 {
 	assert(node->head == NULL);
@@ -64,6 +65,7 @@ inline static void IO_Event_List_pop(struct IO_Event_List *node)
 	node->head = node->tail = NULL;
 }
 
+// Remove an item from the list, if it is in a list.
 inline static void IO_Event_List_free(struct IO_Event_List *node)
 {
 	if (node->head && node->tail) {
@@ -71,11 +73,27 @@ inline static void IO_Event_List_free(struct IO_Event_List *node)
 	}
 }
 
-inline static int IO_Event_List_empty(struct IO_Event_List *list)
+// Calculate the memory size of the list nodes.
+inline static size_t IO_Event_List_memory_size(const struct IO_Event_List *list)
+{
+	size_t memsize = 0;
+
+	const struct IO_Event_List *node = list->tail;
+	while (node != list) {
+		memsize += sizeof(struct IO_Event_List);
+		node = node->tail;
+	}
+
+	return memsize;
+}
+
+// Return true if the list is empty.
+inline static int IO_Event_List_empty(const struct IO_Event_List *list)
 {
 	return list->head == list->tail;
 }
 
+// Enumerate all items in the list, assuming the list will not be modified during iteration.
 inline static void IO_Event_List_immutable_each(struct IO_Event_List *list, void (*callback)(struct IO_Event_List *node))
 {
 	struct IO_Event_List *node = list->tail;