io-event 1.6.6 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 853f198e7ea15ab8efd9f3c864a224af60e1c45342a226ce2768eb554b1a21bb
-  data.tar.gz: 8fd1da4d954a4c78072f78499b322d87fd354e22786b3858f909c91346e5f92e
+  metadata.gz: 542a0e0f15dd7d59246ac8b03a3579ff9fe8e85618009277572b04a1d1fdbfc9
+  data.tar.gz: e440cf4f7f2a33a7e7c0b995f4b7829d4d66a44acb3f3d3ca00683b838062fcb
 SHA512:
-  metadata.gz: 25ea52c93eabc794db7abb8a91eb8b7311dd81eaf0bc725d67a3a553e8591df108b71a49ca3947aa3ed4a69d5e7f0247e1ffd24e0a93c54fbd2f90fc09688c13
-  data.tar.gz: 69937d7849c3c3ea9fd1b657dc5184f1921a44d7f51d8184ded13112ab57a5511bebbf2e40c5acd9b06e393c8e43041a3f0feedb2c4eb70230f330a280ffe125
+  metadata.gz: cd577bac5f3b70b70af3ca48f012179ec8d1b1774fc89cd46982fed601fe3a163a9ae9742b58ded385764c5233abc90cbf63f3b2563a114d232233085ba1c5ef
+  data.tar.gz: ff23dd077067823bd748d89482d39bb1b49cee26e87b6733561d2c3c09ffa3711015d0e8da514ac4851eccd81b84b0e7b66c2d5d7815ade30c551052e0dda536

data/ext/extconf.rb

@@ -17,11 +17,9 @@ extension_name = "IO_Event"
 $CFLAGS << " -Wall -Wno-unknown-pragmas -std=c99"
 
 if ENV.key?("RUBY_DEBUG")
-	$CFLAGS << " -DRUBY_DEBUG -O0"
+	$stderr.puts "Enabling debug mode..."
 	
-	# Add address and undefined behaviour sanitizers:
-	$CFLAGS << " -fsanitize=undefined -fno-omit-frame-pointer"
-	$LDFLAGS << " -fsanitize=undefined"
+	$CFLAGS << " -DRUBY_DEBUG -O0"
 end
 
 $srcs = ["io/event/event.c", "io/event/selector/selector.c"]
@@ -56,6 +54,14 @@ have_func("epoll_pwait2")
 
 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
 
 # Generate the makefile to compile the native binary into `lib`:

data/ext/io/event/event.c

@@ -21,20 +21,14 @@
 #include "event.h"
 #include "selector/selector.h"
 
-VALUE IO_Event = Qnil;
-VALUE IO_Event_Selector = Qnil;
-
 void Init_IO_Event(void)
 {
 #ifdef HAVE_RB_EXT_RACTOR_SAFE
 	rb_ext_ractor_safe(true);
 #endif
 	
-	IO_Event = rb_define_module_under(rb_cIO, "Event");
-	rb_gc_register_mark_object(IO_Event);
-	
-	IO_Event_Selector = rb_define_module_under(IO_Event, "Selector");
-	rb_gc_register_mark_object(IO_Event_Selector);
+	VALUE IO_Event = rb_define_module_under(rb_cIO, "Event");
+	VALUE IO_Event_Selector = rb_define_module_under(IO_Event, "Selector");
 	
 	Init_IO_Event_Selector(IO_Event_Selector);
 	

data/ext/io/event/interrupt.c

@@ -25,6 +25,13 @@
 
 #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>
 

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

@@ -29,6 +29,8 @@ inline static void IO_Event_Array_allocate(struct IO_Event_Array *array, size_t
 {
 	if (count) {
 		array->base = (void**)calloc(count, sizeof(void*));
+		assert(array->base);
+		
 		array->count = count;
 	} else {
 		array->base = NULL;
@@ -51,6 +53,7 @@ inline static void IO_Event_Array_free(struct IO_Event_Array *array)
 		void *element = array->base[i];
 		if (element) {
 			array->element_free(element);
+			
 			free(element);
 		}
 	}
@@ -107,6 +110,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);

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

@@ -34,8 +34,6 @@ enum {
 	DEBUG = 0,
 };
 
-static VALUE IO_Event_Selector_EPoll = Qnil;
-
 enum {EPOLL_MAX_EVENTS = 64};
 
 // This represents an actual fiber waiting for a specific event.
@@ -184,7 +182,7 @@ static const rb_data_type_t IO_Event_Selector_EPoll_Type = {
 		.dsize = IO_Event_Selector_EPoll_Type_size,
 	},
 	.data = NULL,
-	.flags = RUBY_TYPED_FREE_IMMEDIATELY,
+	.flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
 };
 
 inline static
@@ -333,7 +331,7 @@ VALUE IO_Event_Selector_EPoll_allocate(VALUE self) {
 	struct IO_Event_Selector_EPoll *selector = NULL;
 	VALUE instance = TypedData_Make_Struct(self, struct IO_Event_Selector_EPoll, &IO_Event_Selector_EPoll_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, Qnil);
+	IO_Event_Selector_initialize(&selector->backend, self, Qnil);
 	selector->descriptor = -1;
 	selector->blocked = 0;
 	
@@ -363,7 +361,7 @@ VALUE IO_Event_Selector_EPoll_initialize(VALUE self, VALUE loop) {
 	struct IO_Event_Selector_EPoll *selector = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_EPoll, &IO_Event_Selector_EPoll_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, loop);
+	IO_Event_Selector_initialize(&selector->backend, self, loop);
 	int result = epoll_create1(EPOLL_CLOEXEC);
 	
 	if (result == -1) {
@@ -1037,8 +1035,7 @@ VALUE IO_Event_Selector_EPoll_wakeup(VALUE self) {
 }
 
 void Init_IO_Event_Selector_EPoll(VALUE IO_Event_Selector) {
-	IO_Event_Selector_EPoll = rb_define_class_under(IO_Event_Selector, "EPoll", rb_cObject);
-	rb_gc_register_mark_object(IO_Event_Selector_EPoll);
+	VALUE IO_Event_Selector_EPoll = rb_define_class_under(IO_Event_Selector, "EPoll", rb_cObject);
 	
 	rb_define_alloc_func(IO_Event_Selector_EPoll, IO_Event_Selector_EPoll_allocate);
 	rb_define_method(IO_Event_Selector_EPoll, "initialize", IO_Event_Selector_EPoll_initialize, 1);

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

@@ -43,8 +43,6 @@ enum {
 #define IO_EVENT_SELECTOR_KQUEUE_USE_INTERRUPT
 #endif
 
-static VALUE IO_Event_Selector_KQueue = Qnil;
-
 enum {KQUEUE_MAX_EVENTS = 64};
 
 // This represents an actual fiber waiting for a specific event.
@@ -183,7 +181,7 @@ static const rb_data_type_t IO_Event_Selector_KQueue_Type = {
 		.dsize = IO_Event_Selector_KQueue_Type_size,
 	},
 	.data = NULL,
-	.flags = RUBY_TYPED_FREE_IMMEDIATELY,
+	.flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
 };
 
 inline static
@@ -307,7 +305,7 @@ VALUE IO_Event_Selector_KQueue_allocate(VALUE self) {
 	struct IO_Event_Selector_KQueue *selector = NULL;
 	VALUE instance = TypedData_Make_Struct(self, struct IO_Event_Selector_KQueue, &IO_Event_Selector_KQueue_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, Qnil);
+	IO_Event_Selector_initialize(&selector->backend, self, Qnil);
 	selector->descriptor = -1;
 	selector->blocked = 0;
 	
@@ -340,7 +338,7 @@ VALUE IO_Event_Selector_KQueue_initialize(VALUE self, VALUE loop) {
 	struct IO_Event_Selector_KQueue *selector = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_KQueue, &IO_Event_Selector_KQueue_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, loop);
+	IO_Event_Selector_initialize(&selector->backend, self, loop);
 	int result = kqueue();
 	
 	if (result == -1) {
@@ -1052,8 +1050,7 @@ VALUE IO_Event_Selector_KQueue_wakeup(VALUE self) {
 }
 
 void Init_IO_Event_Selector_KQueue(VALUE IO_Event_Selector) {
-	IO_Event_Selector_KQueue = rb_define_class_under(IO_Event_Selector, "KQueue", rb_cObject);
-	rb_gc_register_mark_object(IO_Event_Selector_KQueue);
+	VALUE IO_Event_Selector_KQueue = rb_define_class_under(IO_Event_Selector, "KQueue", rb_cObject);
 	
 	rb_define_alloc_func(IO_Event_Selector_KQueue, IO_Event_Selector_KQueue_allocate);
 	rb_define_method(IO_Event_Selector_KQueue, "initialize", IO_Event_Selector_KQueue_initialize, 1);

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

@@ -172,12 +172,14 @@ 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;
 	}
 	
@@ -190,12 +192,15 @@ static void queue_push(struct IO_Event_Selector *backend, struct IO_Event_Select
 	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;
 }
 
@@ -276,11 +281,14 @@ VALUE IO_Event_Selector_raise(struct IO_Event_Selector *backend, int argc, VALUE
 void IO_Event_Selector_queue_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_WRITTEN(backend->self, Qundef, fiber);
 	
 	queue_push(backend, waiting);
 }
@@ -292,7 +300,7 @@ void IO_Event_Selector_queue_pop(struct IO_Event_Selector *backend, struct IO_Ev
 	
 	if (ready->flags & IO_EVENT_SELECTOR_QUEUE_FIBER) {
 		IO_Event_Selector_fiber_transfer(ready->fiber, 0, NULL);
-	} else {
+	} else if (ready->flags & IO_EVENT_SELECTOR_QUEUE_INTERNAL) {
 		VALUE fiber = ready->fiber;
 		queue_pop(backend, ready);
 		free(ready);
@@ -300,6 +308,8 @@ void IO_Event_Selector_queue_pop(struct IO_Event_Selector *backend, struct IO_Ev
 		if (RTEST(rb_funcall(fiber, id_alive_p, 0))) {
 			rb_funcall(fiber, id_transfer, 0);
 		}
+	} else {
+		rb_raise(rb_eRuntimeError, "Unknown queue type!");
 	}
 }
 
@@ -307,6 +317,8 @@ int IO_Event_Selector_queue_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);

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

@@ -95,27 +95,29 @@ struct IO_Event_Selector_Queue {
 };
 
 struct IO_Event_Selector {
+	VALUE self;
 	VALUE loop;
 	
-	struct IO_Event_Selector_Queue *free;
-	
-	// Append to waiting.
+	// 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;
+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;
 }
 
 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 +127,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;

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

@@ -37,8 +37,6 @@ enum {
 	DEBUG_COMPLETION = 0,
 };
 
-static VALUE IO_Event_Selector_URing = Qnil;
-
 enum {URING_ENTRIES = 64};
 
 #pragma mark - Data Type
@@ -152,7 +150,7 @@ static const rb_data_type_t IO_Event_Selector_URing_Type = {
 		.dsize = IO_Event_Selector_URing_Type_size,
 	},
 	.data = NULL,
-	.flags = RUBY_TYPED_FREE_IMMEDIATELY,
+	.flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
 };
 
 inline static
@@ -228,7 +226,7 @@ VALUE IO_Event_Selector_URing_allocate(VALUE self) {
 	struct IO_Event_Selector_URing *selector = NULL;
 	VALUE instance = TypedData_Make_Struct(self, struct IO_Event_Selector_URing, &IO_Event_Selector_URing_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, Qnil);
+	IO_Event_Selector_initialize(&selector->backend, self, Qnil);
 	selector->ring.ring_fd = -1;
 	
 	selector->pending = 0;
@@ -249,7 +247,7 @@ VALUE IO_Event_Selector_URing_initialize(VALUE self, VALUE loop) {
 	struct IO_Event_Selector_URing *selector = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_URing, &IO_Event_Selector_URing_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, loop);
+	IO_Event_Selector_initialize(&selector->backend, self, loop);
 	int result = io_uring_queue_init(URING_ENTRIES, &selector->ring, 0);
 	
 	if (result < 0) {
@@ -1094,8 +1092,7 @@ VALUE IO_Event_Selector_URing_wakeup(VALUE self) {
 #pragma mark - Native Methods
 
 void Init_IO_Event_Selector_URing(VALUE IO_Event_Selector) {
-	IO_Event_Selector_URing = rb_define_class_under(IO_Event_Selector, "URing", rb_cObject);
-	rb_gc_register_mark_object(IO_Event_Selector_URing);
+	VALUE IO_Event_Selector_URing = rb_define_class_under(IO_Event_Selector, "URing", rb_cObject);
 	
 	rb_define_alloc_func(IO_Event_Selector_URing, IO_Event_Selector_URing_allocate);
 	rb_define_method(IO_Event_Selector_URing, "initialize", IO_Event_Selector_URing_initialize, 1);

data/lib/io/event/version.rb

@@ -5,6 +5,6 @@
 
 class IO
 	module Event
-		VERSION = "1.6.6"
+		VERSION = "1.7.0"
 	end
 end

data/license.md

@@ -9,6 +9,8 @@ Copyright, 2022, by Bruno Sutic.
 Copyright, 2023, by Math Ieu.  
 Copyright, 2024, by Pavel Rosický.  
 Copyright, 2024, by Anthony Ross.  
+Copyright, 2024, by Shizuo Fujita.  
+Copyright, 2024, by Jean Boussier.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-event
 version: !ruby/object:Gem::Version
-  version: 1.6.6
+  version: 1.7.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -45,7 +45,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-10-03 00:00:00.000000000 Z
+date: 2024-10-04 00:00:00.000000000 Z
 dependencies: []
 description:
 email: