io-event 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d99060107bec74ecdf3c86668fc61deea4d28bdcd9978511b5697ed33cf138d
-  data.tar.gz: 5bf171bc3b6ffe9d0884b722b1b6d63d74ef8612b4d7e0a71257fc7fd7956f80
+  metadata.gz: 529ab26d211811182c1ac8b7b292431533c830eddcfd8781185c9ea4ff623c93
+  data.tar.gz: cef3ea8d930d3f3f92e0c814c0f89405a78e3da1d4ebd6c0d1e73bd32f6839a6
 SHA512:
-  metadata.gz: 724ed197eeba22fd9ac7cb044ce287d34ba8a3a5a920dd84e990dd8627260c8d4266fae9f36f168859d9f6497efdefbb178f6d216cce16eabdf08f3d9e12d2e2
-  data.tar.gz: a28bad4426fdb19d261565fe1363a3ce3a5cb6d29f7d70419bda678dbf414f483455b669cdca0f49c0400ba6ec01ece4f2b536fd1a90af01e7eb519277532756
+  metadata.gz: 77cd0725f41f507e391f54dae4071c9b2721a1fc4ce1c4dbcbf7b4dac8a7453c0e4867679b9f9c615d82ce06af2b3f77745b0d1526f0c6bb02cf06a60c84f763
+  data.tar.gz: 6d9a389303af3b13540ff2761d8e35762e3af975c7e1defddf8765088129f43dc4584029947bafd2a6eb35c60f8206b0dc184d425c52163d1652392e62bb9333

data/design.md

@@ -0,0 +1,63 @@
+## Dual `_select` without GVL:
+
+Always release GVL:
+
+```
+Warming up --------------------------------------
+              KQueue    55.896k i/100ms
+              Select    17.023k i/100ms
+Calculating -------------------------------------
+              KQueue    532.515k (± 8.0%) i/s -      2.683M in   5.071193s
+              Select    177.956k (± 3.4%) i/s -    902.219k in   5.075817s
+
+Comparison:
+              KQueue:   532515.3 i/s
+              Select:   177956.1 i/s - 2.99x  (± 0.00) slower
+```
+
+Only release GVL with non-zero timeout, with selector.elect(1) (so always hitting slow path):
+
+```
+Warming up --------------------------------------
+              KQueue    39.628k i/100ms
+              Select    18.330k i/100ms
+Calculating -------------------------------------
+              KQueue    381.868k (± 6.5%) i/s -      1.902M in   5.004267s
+              Select    171.623k (± 3.0%) i/s -    861.510k in   5.024308s
+
+Comparison:
+              KQueue:   381867.8 i/s
+              Select:   171622.5 i/s - 2.23x  (± 0.00) slower
+```
+
+Only release GVL with non-zero timeout, with selector.select(0) so always hitting fast path:
+
+```
+Warming up --------------------------------------
+              KQueue    56.240k i/100ms
+              Select    17.888k i/100ms
+Calculating -------------------------------------
+              KQueue    543.042k (± 7.8%) i/s -      2.700M in   5.003790s
+              Select    171.866k (± 4.3%) i/s -    858.624k in   5.005785s
+
+Comparison:
+              KQueue:   543041.5 i/s
+              Select:   171866.2 i/s - 3.16x  (± 0.00) slower
+```
+
+Only release GVL when no events are ready and non-zero timeout, with selector.select(1):
+
+```
+Warming up --------------------------------------
+              KQueue    53.401k i/100ms
+              Select    16.691k i/100ms
+Calculating -------------------------------------
+              KQueue    524.564k (± 6.1%) i/s -      2.617M in   5.006996s
+              Select    179.329k (± 2.4%) i/s -    901.314k in   5.029136s
+
+Comparison:
+              KQueue:   524564.0 i/s
+              Select:   179329.1 i/s - 2.93x  (± 0.00) slower
+```
+
+So this approach seems to be a net win of about 1.5x throughput.

data/ext/extconf.rb

@@ -1,4 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021, by Samuel Williams.
 
 # Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 

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

@@ -241,7 +241,7 @@ VALUE IO_Event_Selector_EPoll_process_wait(VALUE self, VALUE fiber, VALUE pid, V
 	rb_update_max_fd(process_wait_arguments.descriptor);
 	
 	struct epoll_event event = {
-		.events = EPOLLIN|EPOLLRDHUP|EPOLLONESHOT,
+		.events = EPOLLIN|EPOLLERR|EPOLLHUP|EPOLLONESHOT,
 		.data = {.ptr = (void*)fiber},
 	};
 	
@@ -385,7 +385,7 @@ VALUE IO_Event_Selector_EPoll_io_wait(VALUE self, VALUE fiber, VALUE io, VALUE e
 	return rb_ensure(io_wait_transfer, (VALUE)&io_wait_arguments, io_wait_ensure, (VALUE)&io_wait_arguments);
 }
 
-#ifdef HAVE_RUBY_IO_BUFFER_H
+#ifdef RUBY_FIBER_SCHEDULER_VERSION
 
 struct io_read_arguments {
 	VALUE self;
@@ -398,6 +398,7 @@ struct io_read_arguments {
 	
 	VALUE buffer;
 	size_t length;
+	size_t offset;
 };
 
 static
@@ -408,8 +409,8 @@ VALUE io_read_loop(VALUE _arguments) {
 	size_t size;
 	rb_io_buffer_get_bytes_for_writing(arguments->buffer, &base, &size);
 	
-	size_t offset = 0;
 	size_t length = arguments->length;
+	size_t offset = arguments->offset;
 	
 	while (true) {
 		size_t maximum_size = size - offset;
@@ -440,9 +441,10 @@ VALUE io_read_ensure(VALUE _arguments) {
 	return Qnil;
 }
 
-VALUE IO_Event_Selector_EPoll_io_read(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length) {
+VALUE IO_Event_Selector_EPoll_io_read(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length, VALUE _offset) {
 	int descriptor = IO_Event_Selector_io_descriptor(io);
 	
+	size_t offset = NUM2SIZET(_offset);
 	size_t length = NUM2SIZET(_length);
 	
 	struct io_read_arguments io_read_arguments = {
@@ -454,11 +456,25 @@ VALUE IO_Event_Selector_EPoll_io_read(VALUE self, VALUE fiber, VALUE io, VALUE b
 		.descriptor = descriptor,
 		.buffer = buffer,
 		.length = length,
+		.offset = offset,
 	};
 	
 	return rb_ensure(io_read_loop, (VALUE)&io_read_arguments, io_read_ensure, (VALUE)&io_read_arguments);
 }
 
+VALUE IO_Event_Selector_EPoll_io_read_compatible(int argc, VALUE *argv, VALUE self)
+{
+	rb_check_arity(argc, 4, 5);
+	
+	VALUE _offset = SIZET2NUM(0);
+	
+	if (argc == 5) {
+		_offset = argv[4];
+	}
+	
+	return IO_Event_Selector_EPoll_io_read(self, argv[0], argv[1], argv[2], argv[3], _offset);
+}
+
 struct io_write_arguments {
 	VALUE self;
 	VALUE fiber;
@@ -470,6 +486,7 @@ struct io_write_arguments {
 	
 	VALUE buffer;
 	size_t length;
+	size_t offset;
 };
 
 static
@@ -480,8 +497,8 @@ VALUE io_write_loop(VALUE _arguments) {
 	size_t size;
 	rb_io_buffer_get_bytes_for_reading(arguments->buffer, &base, &size);
 	
-	size_t offset = 0;
 	size_t length = arguments->length;
+	size_t offset = arguments->offset;
 	
 	if (length > size) {
 		rb_raise(rb_eRuntimeError, "Length exceeds size of buffer!");
@@ -516,10 +533,11 @@ VALUE io_write_ensure(VALUE _arguments) {
 	return Qnil;
 };
 
-VALUE IO_Event_Selector_EPoll_io_write(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length) {
+VALUE IO_Event_Selector_EPoll_io_write(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length, VALUE _offset) {
 	int descriptor = IO_Event_Selector_io_descriptor(io);
 	
 	size_t length = NUM2SIZET(_length);
+	size_t offset = NUM2SIZET(_offset);
 	
 	struct io_write_arguments io_write_arguments = {
 		.self = self,
@@ -530,11 +548,25 @@ VALUE IO_Event_Selector_EPoll_io_write(VALUE self, VALUE fiber, VALUE io, VALUE
 		.descriptor = descriptor,
 		.buffer = buffer,
 		.length = length,
+		.offset = offset,
 	};
 	
 	return rb_ensure(io_write_loop, (VALUE)&io_write_arguments, io_write_ensure, (VALUE)&io_write_arguments);
 }
 
+VALUE IO_Event_Selector_EPoll_io_write_compatible(int argc, VALUE *argv, VALUE self)
+{
+	rb_check_arity(argc, 4, 5);
+	
+	VALUE _offset = SIZET2NUM(0);
+	
+	if (argc == 5) {
+		_offset = argv[4];
+	}
+	
+	return IO_Event_Selector_EPoll_io_write(self, argv[0], argv[1], argv[2], argv[3], _offset);
+}
+
 #endif
 
 static
@@ -683,11 +715,13 @@ void Init_IO_Event_Selector_EPoll(VALUE IO_Event_Selector) {
 	rb_define_method(IO_Event_Selector_EPoll, "close", IO_Event_Selector_EPoll_close, 0);
 	
 	rb_define_method(IO_Event_Selector_EPoll, "io_wait", IO_Event_Selector_EPoll_io_wait, 3);
+
+	rb_define_method(IO_Event_Selector_EPoll, "io_read", IO_Event_Selector_EPoll_io_read_compatible, -1);
+	rb_define_method(IO_Event_Selector_EPoll, "io_write", IO_Event_Selector_EPoll_io_write_compatible, -1);
 	
-#ifdef HAVE_RUBY_IO_BUFFER_H
-	rb_define_method(IO_Event_Selector_EPoll, "io_read", IO_Event_Selector_EPoll_io_read, 4);
-	rb_define_method(IO_Event_Selector_EPoll, "io_write", IO_Event_Selector_EPoll_io_write, 4);
-#endif
+	// Once compatibility isn't a concern, we can do this:
+	// rb_define_method(IO_Event_Selector_EPoll, "io_read", IO_Event_Selector_EPoll_io_read, 5);
+	// rb_define_method(IO_Event_Selector_EPoll, "io_write", IO_Event_Selector_EPoll_io_write, 5);
 	
 	rb_define_method(IO_Event_Selector_EPoll, "process_wait", IO_Event_Selector_EPoll_process_wait, 3);
 }

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

@@ -380,7 +380,7 @@ VALUE IO_Event_Selector_KQueue_io_wait(VALUE self, VALUE fiber, VALUE io, VALUE
 	return rb_rescue(io_wait_transfer, (VALUE)&io_wait_arguments, io_wait_rescue, (VALUE)&io_wait_arguments);
 }
 
-#ifdef HAVE_RUBY_IO_BUFFER_H
+#ifdef RUBY_FIBER_SCHEDULER_VERSION
 
 struct io_read_arguments {
 	VALUE self;
@@ -393,6 +393,7 @@ struct io_read_arguments {
 	
 	VALUE buffer;
 	size_t length;
+	size_t offset;
 };
 
 static
@@ -403,8 +404,8 @@ VALUE io_read_loop(VALUE _arguments) {
 	size_t size;
 	rb_io_buffer_get_bytes_for_writing(arguments->buffer, &base, &size);
 	
-	size_t offset = 0;
 	size_t length = arguments->length;
+	size_t offset = arguments->offset;
 	
 	if (DEBUG_IO_READ) fprintf(stderr, "io_read_loop(fd=%d, length=%zu)\n", arguments->descriptor, length);
 	
@@ -442,13 +443,14 @@ VALUE io_read_ensure(VALUE _arguments) {
 	return Qnil;
 }
 
-VALUE IO_Event_Selector_KQueue_io_read(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length) {
+VALUE IO_Event_Selector_KQueue_io_read(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length, VALUE _offset) {
 	struct IO_Event_Selector_KQueue *data = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_KQueue, &IO_Event_Selector_KQueue_Type, data);
 	
 	int descriptor = IO_Event_Selector_io_descriptor(io);
 	
 	size_t length = NUM2SIZET(_length);
+	size_t offset = NUM2SIZET(_offset);
 	
 	struct io_read_arguments io_read_arguments = {
 		.self = self,
@@ -459,11 +461,25 @@ VALUE IO_Event_Selector_KQueue_io_read(VALUE self, VALUE fiber, VALUE io, VALUE
 		.descriptor = descriptor,
 		.buffer = buffer,
 		.length = length,
+		.offset = offset,
 	};
 	
 	return rb_ensure(io_read_loop, (VALUE)&io_read_arguments, io_read_ensure, (VALUE)&io_read_arguments);
 }
 
+static VALUE IO_Event_Selector_KQueue_io_read_compatible(int argc, VALUE *argv, VALUE self)
+{
+	rb_check_arity(argc, 4, 5);
+	
+	VALUE _offset = SIZET2NUM(0);
+	
+	if (argc == 5) {
+		_offset = argv[4];
+	}
+	
+	return IO_Event_Selector_KQueue_io_read(self, argv[0], argv[1], argv[2], argv[3], _offset);
+}
+
 struct io_write_arguments {
 	VALUE self;
 	VALUE fiber;
@@ -475,6 +491,7 @@ struct io_write_arguments {
 	
 	VALUE buffer;
 	size_t length;
+	size_t offset;
 };
 
 static
@@ -485,8 +502,8 @@ VALUE io_write_loop(VALUE _arguments) {
 	size_t size;
 	rb_io_buffer_get_bytes_for_reading(arguments->buffer, &base, &size);
 	
-	size_t offset = 0;
 	size_t length = arguments->length;
+	size_t offset = arguments->offset;
 	
 	if (length > size) {
 		rb_raise(rb_eRuntimeError, "Length exceeds size of buffer!");
@@ -528,13 +545,14 @@ VALUE io_write_ensure(VALUE _arguments) {
 	return Qnil;
 };
 
-VALUE IO_Event_Selector_KQueue_io_write(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length) {
+VALUE IO_Event_Selector_KQueue_io_write(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length, VALUE _offset) {
 	struct IO_Event_Selector_KQueue *data = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_KQueue, &IO_Event_Selector_KQueue_Type, data);
 	
 	int descriptor = IO_Event_Selector_io_descriptor(io);
 	
 	size_t length = NUM2SIZET(_length);
+	size_t offset = NUM2SIZET(_offset);
 	
 	struct io_write_arguments io_write_arguments = {
 		.self = self,
@@ -545,11 +563,25 @@ VALUE IO_Event_Selector_KQueue_io_write(VALUE self, VALUE fiber, VALUE io, VALUE
 		.descriptor = descriptor,
 		.buffer = buffer,
 		.length = length,
+		.offset = offset,
 	};
 	
 	return rb_ensure(io_write_loop, (VALUE)&io_write_arguments, io_write_ensure, (VALUE)&io_write_arguments);
 }
 
+static VALUE IO_Event_Selector_KQueue_io_write_compatible(int argc, VALUE *argv, VALUE self)
+{
+	rb_check_arity(argc, 4, 5);
+	
+	VALUE _offset = SIZET2NUM(0);
+	
+	if (argc == 5) {
+		_offset = argv[4];
+	}
+	
+	return IO_Event_Selector_KQueue_io_write(self, argv[0], argv[1], argv[2], argv[3], _offset);
+}
+
 #endif
 
 static
@@ -732,11 +764,9 @@ void Init_IO_Event_Selector_KQueue(VALUE IO_Event_Selector) {
 	rb_define_method(IO_Event_Selector_KQueue, "close", IO_Event_Selector_KQueue_close, 0);
 	
 	rb_define_method(IO_Event_Selector_KQueue, "io_wait", IO_Event_Selector_KQueue_io_wait, 3);
-	
-#ifdef HAVE_RUBY_IO_BUFFER_H
-	rb_define_method(IO_Event_Selector_KQueue, "io_read", IO_Event_Selector_KQueue_io_read, 4);
-	rb_define_method(IO_Event_Selector_KQueue, "io_write", IO_Event_Selector_KQueue_io_write, 4);
-#endif
+
+	rb_define_method(IO_Event_Selector_KQueue, "io_read", IO_Event_Selector_KQueue_io_read_compatible, -1);
+	rb_define_method(IO_Event_Selector_KQueue, "io_write", IO_Event_Selector_KQueue_io_write_compatible, -1);
 	
 	rb_define_method(IO_Event_Selector_KQueue, "process_wait", IO_Event_Selector_KQueue_process_wait, 3);
 }

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

@@ -29,6 +29,10 @@
 #include <ruby/fiber/scheduler.h>
 #endif
 
+#ifndef RUBY_FIBER_SCHEDULER_VERSION
+#define RUBY_FIBER_SCHEDULER_VERSION 1
+#endif
+
 #include <time.h>
 
 enum IO_Event {

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

@@ -23,6 +23,7 @@
 
 #include <liburing.h>
 #include <poll.h>
+#include <stdint.h>
 #include <time.h>
 
 #include "pidfd.c"
@@ -324,7 +325,7 @@ VALUE io_wait_rescue(VALUE _arguments, VALUE exception) {
 	
 	if (DEBUG) fprintf(stderr, "io_wait_rescue:io_uring_prep_poll_remove(%p)\n", (void*)arguments->fiber);
 	
-	io_uring_prep_poll_remove(sqe, (void*)arguments->fiber);
+	io_uring_prep_poll_remove(sqe, (uintptr_t)arguments->fiber);
 	io_uring_submit_now(data);
 
 	rb_exc_raise(exception);
@@ -375,7 +376,7 @@ VALUE IO_Event_Selector_URing_io_wait(VALUE self, VALUE fiber, VALUE io, VALUE e
 	return rb_rescue(io_wait_transfer, (VALUE)&io_wait_arguments, io_wait_rescue, (VALUE)&io_wait_arguments);
 }
 
-#ifdef HAVE_RUBY_IO_BUFFER_H
+#ifdef RUBY_FIBER_SCHEDULER_VERSION
 
 #if LINUX_VERSION_CODE >= KERNEL_VERSION(5,16,0)
 static inline off_t io_seekable(int descriptor) {
@@ -408,7 +409,7 @@ static int io_read(struct IO_Event_Selector_URing *data, VALUE fiber, int descri
 	return RB_NUM2INT(result);
 }
 
-VALUE IO_Event_Selector_URing_io_read(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length) {
+VALUE IO_Event_Selector_URing_io_read(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length, VALUE _offset) {
 	struct IO_Event_Selector_URing *data = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_URing, &IO_Event_Selector_URing_Type, data);
 	
@@ -418,8 +419,8 @@ VALUE IO_Event_Selector_URing_io_read(VALUE self, VALUE fiber, VALUE io, VALUE b
 	size_t size;
 	rb_io_buffer_get_bytes_for_writing(buffer, &base, &size);
 	
-	size_t offset = 0;
 	size_t length = NUM2SIZET(_length);
+	size_t offset = NUM2SIZET(_offset);
 	
 	while (true) {
 		size_t maximum_size = size - offset;
@@ -443,6 +444,19 @@ VALUE IO_Event_Selector_URing_io_read(VALUE self, VALUE fiber, VALUE io, VALUE b
 	return rb_fiber_scheduler_io_result(offset, 0);
 }
 
+static VALUE IO_Event_Selector_URing_io_read_compatible(int argc, VALUE *argv, VALUE self)
+{
+	rb_check_arity(argc, 4, 5);
+	
+	VALUE _offset = SIZET2NUM(0);
+	
+	if (argc == 5) {
+		_offset = argv[4];
+	}
+	
+	return IO_Event_Selector_URing_io_read(self, argv[0], argv[1], argv[2], argv[3], _offset);
+}
+
 static
 int io_write(struct IO_Event_Selector_URing *data, VALUE fiber, int descriptor, char *buffer, size_t length) {
 	struct io_uring_sqe *sqe = io_get_sqe(data);
@@ -459,7 +473,7 @@ int io_write(struct IO_Event_Selector_URing *data, VALUE fiber, int descriptor,
 	return result;
 }
 
-VALUE IO_Event_Selector_URing_io_write(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length) {
+VALUE IO_Event_Selector_URing_io_write(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length, VALUE _offset) {
 	struct IO_Event_Selector_URing *data = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_URing, &IO_Event_Selector_URing_Type, data);
 	
@@ -469,8 +483,8 @@ VALUE IO_Event_Selector_URing_io_write(VALUE self, VALUE fiber, VALUE io, VALUE
 	size_t size;
 	rb_io_buffer_get_bytes_for_reading(buffer, &base, &size);
 	
-	size_t offset = 0;
 	size_t length = NUM2SIZET(_length);
+	size_t offset = NUM2SIZET(_offset);
 	
 	if (length > size) {
 		rb_raise(rb_eRuntimeError, "Length exceeds size of buffer!");
@@ -496,6 +510,19 @@ VALUE IO_Event_Selector_URing_io_write(VALUE self, VALUE fiber, VALUE io, VALUE
 	return rb_fiber_scheduler_io_result(offset, 0);
 }
 
+static VALUE IO_Event_Selector_URing_io_write_compatible(int argc, VALUE *argv, VALUE self)
+{
+	rb_check_arity(argc, 4, 5);
+	
+	VALUE _offset = SIZET2NUM(0);
+	
+	if (argc == 5) {
+		_offset = argv[4];
+	}
+	
+	return IO_Event_Selector_URing_io_write(self, argv[0], argv[1], argv[2], argv[3], _offset);
+}
+
 #endif
 
 static const int ASYNC_CLOSE = 1;
@@ -710,11 +737,9 @@ void Init_IO_Event_Selector_URing(VALUE IO_Event_Selector) {
 	rb_define_method(IO_Event_Selector_URing, "close", IO_Event_Selector_URing_close, 0);
 	
 	rb_define_method(IO_Event_Selector_URing, "io_wait", IO_Event_Selector_URing_io_wait, 3);
-	
-#ifdef HAVE_RUBY_IO_BUFFER_H
-	rb_define_method(IO_Event_Selector_URing, "io_read", IO_Event_Selector_URing_io_read, 4);
-	rb_define_method(IO_Event_Selector_URing, "io_write", IO_Event_Selector_URing_io_write, 4);
-#endif
+
+	rb_define_method(IO_Event_Selector_URing, "io_read", IO_Event_Selector_URing_io_read_compatible, -1);
+	rb_define_method(IO_Event_Selector_URing, "io_write", IO_Event_Selector_URing_io_write_compatible, -1);
 	
 	rb_define_method(IO_Event_Selector_URing, "io_close", IO_Event_Selector_URing_io_close, 1);
 	

data/lib/io/event/debug/selector.rb

@@ -1,22 +1,9 @@
-# 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2022, by Samuel Williams.
+
+require_relative '../support'
 
 module IO::Event
 	module Debug
@@ -80,14 +67,16 @@ module IO::Event
 				@selector.io_wait(fiber, io, events)
 			end
 			
-			if IO.const_defined?(:Buffer)
-				def io_read(fiber, io, buffer, length)
-					@selector.io_read(fiber, io, buffer, length)
-				end
-				
-				def io_write(fiber, io, buffer, length)
-					@selector.io_write(fiber, io, buffer, length)
-				end
+			def io_read(...)
+				@selector.io_read(...)
+			end
+			
+			def io_write(...)
+				@selector.io_write(...)
+			end
+			
+			def respond_to?(name, include_private = false)
+				@selector.respond_to?(name, include_private)
 			end
 			
 			def select(duration = nil)

data/lib/io/event/interrupt.rb

@@ -1,22 +1,7 @@
-# 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021, by Samuel Williams.
 
 module IO::Event
 	# A thread safe synchronisation primative.

data/lib/io/event/selector/select.rb

@@ -1,24 +1,12 @@
-# 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2022, by Samuel Williams.
 
 require_relative '../interrupt'
+require_relative '../support'
+
+require 'io/nonblock'
 
 module IO::Event
 	module Selector
@@ -36,7 +24,7 @@ module IO::Event
 			
 			attr :loop
 			
-			# If the event loop is currently blocked, 
+			# If the event loop is currently sleeping, wake it up.
 			def wakeup
 				if @blocked
 					@interrupt.signal
@@ -148,11 +136,65 @@ module IO::Event
 				waiter&.invalidate
 			end
 			
-			if IO.const_defined?(:Buffer)
+			if Support.fiber_scheduler_v2?
 				EAGAIN = Errno::EAGAIN::Errno
 				
-				def io_read(fiber, io, buffer, length)
-					offset = 0
+				def io_read(fiber, io, buffer, length, offset = 0)
+					total = 0
+					io.nonblock = true
+					
+					while true
+						maximum_size = buffer.size - offset
+						result = Fiber.blocking{buffer.read(io, maximum_size, offset)}
+						
+						if result == -EAGAIN
+							if length > 0
+								self.io_wait(fiber, io, IO::READABLE)
+							else
+								return result
+							end
+						elsif result < 0
+							return result
+						else
+							total += result
+							offset += result
+							break if total >= length
+						end
+					end
+					
+					return total
+				end
+				
+				def io_write(fiber, io, buffer, length, offset = 0)
+					total = 0
+					io.nonblock = true
+					
+					while true
+						maximum_size = buffer.size - offset
+						result = Fiber.blocking{buffer.write(io, maximum_size, offset)}
+						
+						if result == -EAGAIN
+							if length > 0
+								self.io_wait(fiber, io, IO::READABLE)
+							else
+								return result
+							end
+						elsif result < 0
+							return result
+						else
+							total += result
+							offset += result
+							break if total >= length
+						end
+					end
+					
+					return offset
+				end
+			elsif Support.fiber_scheduler_v1?
+				EAGAIN = Errno::EAGAIN::Errno
+				
+				def io_read(fiber, _io, buffer, length, offset = 0)
+					io = IO.for_fd(_io.fileno, autoclose: false)
 					
 					while true
 						maximum_size = buffer.size - offset
@@ -185,8 +227,8 @@ module IO::Event
 					return offset
 				end
 				
-				def io_write(fiber, io, buffer, length)
-					offset = 0
+				def io_write(fiber, _io, buffer, length, offset = 0)
+					io = IO.for_fd(_io.fileno, autoclose: false)
 					
 					while true
 						maximum_size = buffer.size - offset
@@ -214,24 +256,17 @@ module IO::Event
 					
 					return offset
 				end
+				
+				def blocking(&block)
+					fiber = Fiber.new(blocking: true, &block)
+					return fiber.resume(fiber)
+				end
 			end
 			
 			def process_wait(fiber, pid, flags)
-				r, w = IO.pipe
-				
-				thread = Thread.new do
+				Thread.new do
 					Process::Status.wait(pid, flags)
-				ensure
-					w.close
-				end
-				
-				self.io_wait(fiber, r, IO::READABLE)
-				
-				return thread.value
-			ensure
-				r.close
-				w.close
-				thread&.kill
+				end.value
 			end
 			
 			private def pop_ready
@@ -255,6 +290,7 @@ module IO::Event
 				
 				readable = Array.new
 				writable = Array.new
+				priority = Array.new
 				
 				@waiting.each do |io, waiter|
 					waiter.each do |fiber, events|
@@ -265,12 +301,16 @@ module IO::Event
 						if (events & IO::WRITABLE) > 0
 							writable << io
 						end
+						
+						if (events & IO::PRIORITY) > 0
+							priority << io
+						end
 					end
 				end
 				
 				@blocked = true
 				duration = 0 unless @ready.empty?
-				readable, writable, _ = ::IO.select(readable, writable, nil, duration)
+				readable, writable, priority = ::IO.select(readable, writable, priority, duration)
 				@blocked = false
 				
 				ready = Hash.new(0)
@@ -283,16 +323,16 @@ module IO::Event
 					ready[io] |= IO::WRITABLE
 				end
 				
+				priority&.each do |io|
+					ready[io] |= IO::PRIORITY
+				end
+				
 				ready.each do |io, events|
 					@waiting.delete(io).transfer(events)
 				end
 				
 				return ready.size
 			end
-			
-			private def blocking(&block)
-				Fiber.new(blocking: true, &block).resume
-			end
 		end
 	end
 end

data/lib/io/event/selector.rb

@@ -1,25 +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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2022, by Samuel Williams.
 
 require_relative 'selector/select'
 require_relative 'debug/selector'
+require_relative 'support'
 
 module IO::Event
 	module Selector
@@ -32,12 +18,14 @@ module IO::Event
 				end
 			end
 			
-			if self.const_defined?(:EPoll)
-				return EPoll
+			if self.const_defined?(:URing)
+				URing
+			elsif self.const_defined?(:EPoll)
+				EPoll
 			elsif self.const_defined?(:KQueue)
-				return KQueue
+				KQueue
 			else
-				return Select
+				Select
 			end
 		end
 		

data/lib/io/event/support.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
+
+class IO
+	module Event
+		module Support
+			def self.buffer?
+				IO.const_defined?(:Buffer)
+			end
+			
+			def self.fiber_scheduler_v1?
+				IO.const_defined?(:Buffer) and !Fiber.respond_to?(:blocking)
+			end
+			
+			def self.fiber_scheduler_v2?
+				IO.const_defined?(:Buffer) and Fiber.respond_to?(:blocking) and IO::Buffer.instance_method(:read).arity == -1
+			end
+		end
+	end
+end

data/lib/io/event/version.rb

@@ -1,23 +1,10 @@
-# 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.
+# frozen_string_literal: true
 
-module IO::Event
-	VERSION = "1.0.7"
+# Released under the MIT License.
+# Copyright, 2021-2022, by Samuel Williams.
+
+class IO
+	module Event
+		VERSION = "1.1.0"
+	end
 end

data/lib/io/event.rb

@@ -1,22 +1,7 @@
-# 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021, by Samuel Williams.
 
 require_relative 'event/version'
 require_relative 'event/selector'

data/license.md

@@ -0,0 +1,25 @@
+# MIT License
+
+Copyright, 2021-2022, by Samuel Williams.  
+Copyright, 2021, by Delton Ding.  
+Copyright, 2021, by Benoit Daloze.  
+Copyright, 2022, by Alex Matchneer.  
+Copyright, 2022, by Bruno Sutic.  
+
+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.

data/readme.md

@@ -0,0 +1,23 @@
+# ![Event](logo.svg)
+
+Provides low level cross-platform primitives for constructing event loops, with support for `select`, `kqueue`, `epoll` and `io_uring`.
+
+[![Development Status](https://github.com/socketry/io-event/workflows/Test/badge.svg)](https://github.com/socketry/io-event/actions?workflow=Test)
+
+## Motivation
+
+The initial proof-of-concept [Async](https://github.com/socketry/async) was built on [NIO4r](https://github.com/socketry/nio4r). It was perfectly acceptable and well tested in production, however being built on `libev` was a little bit limiting. I wanted to directly built my fiber scheduler into the fabric of the event loop, which is what this gem exposes - it is specifically implemented to support building event loops beneath the fiber scheduler interface, providing an efficient C implementation of all the core operations.
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/io-event/).
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it
+2.  Create your feature branch (`git checkout -b my-new-feature`)
+3.  Commit your changes (`git commit -am 'Add some feature'`)
+4.  Push to the branch (`git push origin my-new-feature`)
+5.  Create new Pull Request

metadata

@@ -1,17 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: io-event
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - Samuel Williams
-- machty
+- Bruno Sutic
 - Benoit Daloze
 - Delton Ding
+- machty
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2022-05-02 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -76,6 +106,7 @@ extensions:
 - ext/extconf.rb
 extra_rdoc_files: []
 files:
+- design.md
 - ext/extconf.rb
 - ext/io/event/event.c
 - ext/io/event/event.h
@@ -95,7 +126,10 @@ files:
 - lib/io/event/interrupt.rb
 - lib/io/event/selector.rb
 - lib/io/event/selector/select.rb
+- lib/io/event/support.rb
 - lib/io/event/version.rb
+- license.md
+- readme.md
 homepage: https://github.com/socketry/io-event
 licenses:
 - MIT
@@ -115,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: An event loop.