io-event 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0743271de82b1b4324953fadd2f5da09cb79609c1153ae8637e4f23f31f0615c
-  data.tar.gz: e90309751d3bc2716362d596b07a477a0f9b1c6ef27443f06469547bce10cb40
+  metadata.gz: 9e419e583855ca1efed750b1ae61bc6fb7b4524cf30cec819a7461eecdb78d45
+  data.tar.gz: 7c64477599375b9612004acb9e725e7af260a51d404b071e209e866d734a083a
 SHA512:
-  metadata.gz: f1fe9c27d9ed25969eaca758565f99346dea63f397e32e8bec027312b0936b61b6677a520cbacb4f0c3e976979ff3ee4cfac93ea766d92cd8b88fa19cab1ad7c
-  data.tar.gz: 4c476754268f03564134fc461bdeee26c0989fc6673cd27235ccc6d1a6df4d03b680f677469db531e8b1613622bd356ffa762d35b2b39ab455d522c6d624d45e
+  metadata.gz: c9b63cafbb56b9eac0f01edd180a70a38de6465ff4624b07360df135d0eeeab984c5348b0981d9c41ce943248af2a554528914e0cb9ae4606737d4ece2b96a8b
+  data.tar.gz: 1fecec388e9a5c517c83dc233a107cd86121a7e88f3cf5275e0ac00dd7a43aa826ae616b815b556c73ec13e5fc108f9c7cbe1bca1215fb0eb8bfed9daadb048b

data/ext/extconf.rb

@@ -3,26 +3,7 @@
 
 # Released under the MIT License.
 # Copyright, 2021-2023, by Samuel Williams.
-
-# 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.
+# Copyright, 2023, by Math Ieu.
 
 return if RUBY_DESCRIPTION =~ /jruby/
 

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

@@ -34,6 +34,7 @@
 
 enum {
 	DEBUG = 0,
+	DEBUG_COMPLETION = 0,
 };
 
 static VALUE IO_Event_Selector_URing = Qnil;
@@ -165,6 +166,8 @@ struct IO_Event_Selector_URing_Completion * IO_Event_Selector_URing_Completion_a
 		IO_Event_List_clear(&completion->list);
 	}
 	
+	if (DEBUG_COMPLETION) fprintf(stderr, "IO_Event_Selector_URing_Completion_acquire(%p, limit=%ld)\n", (void*)completion, selector->completions.limit);
+	
 	waiting->completion = completion;
 	completion->waiting = waiting;
 	
@@ -174,6 +177,8 @@ struct IO_Event_Selector_URing_Completion * IO_Event_Selector_URing_Completion_a
 inline static
 void IO_Event_Selector_URing_Completion_cancel(struct IO_Event_Selector_URing_Completion *completion)
 {
+	if (DEBUG_COMPLETION) fprintf(stderr, "IO_Event_Selector_URing_Completion_cancel(%p)\n", (void*)completion);
+	
 	if (completion->waiting) {
 		completion->waiting->completion = NULL;
 		completion->waiting = NULL;
@@ -183,13 +188,17 @@ void IO_Event_Selector_URing_Completion_cancel(struct IO_Event_Selector_URing_Co
 inline static
 void IO_Event_Selector_URing_Completion_release(struct IO_Event_Selector_URing *selector, struct IO_Event_Selector_URing_Completion *completion)
 {
+	if (DEBUG_COMPLETION) fprintf(stderr, "IO_Event_Selector_URing_Completion_release(%p)\n", (void*)completion);
+	
 	IO_Event_Selector_URing_Completion_cancel(completion);
 	IO_Event_List_prepend(&selector->free_list, &completion->list);
 }
 
 inline static
-void IO_Event_Selector_URing_Waiting_cancel(struct IO_Event_Selector_URing *selector, struct IO_Event_Selector_URing_Waiting *waiting)
+void IO_Event_Selector_URing_Waiting_cancel(struct IO_Event_Selector_URing_Waiting *waiting)
 {
+	if (DEBUG_COMPLETION) fprintf(stderr, "IO_Event_Selector_URing_Waiting_cancel(%p, %p)\n", (void*)waiting, (void*)waiting->completion);
+	
 	if (waiting->completion) {
 		waiting->completion->waiting = NULL;
 		waiting->completion = NULL;
@@ -198,10 +207,13 @@ void IO_Event_Selector_URing_Waiting_cancel(struct IO_Event_Selector_URing *sele
 	waiting->fiber = 0;
 }
 
+struct IO_Event_List_Type IO_Event_Selector_URing_Completion_Type = {};
+
 void IO_Event_Selector_URing_Completion_initialize(void *element)
 {
 	struct IO_Event_Selector_URing_Completion *completion = element;
 	IO_Event_List_initialize(&completion->list);
+	completion->list.type = &IO_Event_Selector_URing_Completion_Type;
 }
 
 void IO_Event_Selector_URing_Completion_free(void *element)
@@ -314,6 +326,32 @@ VALUE IO_Event_Selector_URing_ready_p(VALUE self) {
 
 #pragma mark - Submission Queue
 
+static
+void IO_Event_Selector_URing_dump_completion_queue(struct IO_Event_Selector_URing *selector)
+{
+	struct io_uring *ring = &selector->ring;
+	unsigned head;
+	struct io_uring_cqe *cqe;
+	
+	if (DEBUG) {
+		int first = 1;
+		io_uring_for_each_cqe(ring, head, cqe) {
+			if (!first) {
+				fprintf(stderr, ", ");
+			}
+			else {
+				fprintf(stderr, "CQ: [");
+				first = 0;
+			}
+			
+			fprintf(stderr, "%d:%p", (int)cqe->res, (void*)cqe->user_data);
+		}
+		if (!first) {
+			fprintf(stderr, "]\n");
+		}
+	}
+}
+
 // Flush the submission queue if pending operations are present.
 static
 int io_uring_submit_flush(struct IO_Event_Selector_URing *selector) {
@@ -333,19 +371,24 @@ int io_uring_submit_flush(struct IO_Event_Selector_URing *selector) {
 		return result;
 	}
 	
+	if (DEBUG) {
+		IO_Event_Selector_URing_dump_completion_queue(selector);
+	}
+	
 	return 0;
 }
 
 // Immediately flush the submission queue, yielding to the event loop if it was not successful.
 static
 int io_uring_submit_now(struct IO_Event_Selector_URing *selector) {
-	if (DEBUG && selector->pending) fprintf(stderr, "io_uring_submit_now(pending=%ld)\n", selector->pending);
-
+	if (DEBUG) fprintf(stderr, "io_uring_submit_now(pending=%ld)\n", selector->pending);
+	
 	while (true) {
 		int result = io_uring_submit(&selector->ring);
 		
 		if (result >= 0) {
 			selector->pending = 0;
+			if (DEBUG) IO_Event_Selector_URing_dump_completion_queue(selector);
 			return result;
 		}
 		
@@ -407,7 +450,7 @@ VALUE process_wait_ensure(VALUE _arguments) {
 	
 	close(arguments->descriptor);
 	
-	IO_Event_Selector_URing_Waiting_cancel(arguments->selector, arguments->waiting);
+	IO_Event_Selector_URing_Waiting_cancel(arguments->waiting);
 	
 	return Qnil;
 }
@@ -437,9 +480,8 @@ VALUE IO_Event_Selector_URing_process_wait(VALUE self, VALUE fiber, VALUE _pid,
 		.descriptor = descriptor,
 	};
 	
-	struct io_uring_sqe *sqe = io_get_sqe(selector);
-	
 	if (DEBUG) fprintf(stderr, "IO_Event_Selector_URing_process_wait:io_uring_prep_poll_add(%p)\n", (void*)fiber);
+	struct io_uring_sqe *sqe = io_get_sqe(selector);
 	io_uring_prep_poll_add(sqe, descriptor, POLLIN|POLLHUP|POLLERR);
 	io_uring_sqe_set_data(sqe, completion);
 	io_uring_submit_pending(selector);
@@ -485,12 +527,16 @@ static
 VALUE io_wait_ensure(VALUE _arguments) {
 	struct io_wait_arguments *arguments = (struct io_wait_arguments *)_arguments;
 	
-	// We may want to consider cancellation. Be aware that the order of operations is important here:
-	// io_uring_prep_cancel(sqe, (void*)arguments->waiting, 0);
-	// io_uring_sqe_set_data(sqe, NULL);
-	// io_uring_submit_now(selector);
+	// If the operation is still in progress, cancel it:
+	if (arguments->waiting->completion) {
+		if (DEBUG) fprintf(stderr, "io_wait_ensure:io_uring_prep_cancel(waiting=%p, completion=%p)\n", (void*)arguments->waiting, (void*)arguments->waiting->completion);
+		struct io_uring_sqe *sqe = io_get_sqe(arguments->selector);
+		io_uring_prep_cancel(sqe, (void*)arguments->waiting->completion, 0);
+		io_uring_sqe_set_data(sqe, NULL);
+		io_uring_submit_now(arguments->selector);
+	}
 	
-	IO_Event_Selector_URing_Waiting_cancel(arguments->selector, arguments->waiting);
+	IO_Event_Selector_URing_Waiting_cancel(arguments->waiting);
 	
 	return Qnil;
 };
@@ -502,6 +548,8 @@ VALUE io_wait_transfer(VALUE _arguments) {
 	
 	IO_Event_Selector_fiber_transfer(selector->backend.loop, 0, NULL);
 	
+	if (DEBUG) fprintf(stderr, "io_wait_transfer:waiting=%p, result=%d\n", (void*)arguments->waiting, arguments->waiting->result);
+	
 	if (arguments->waiting->result) {
 		// We explicitly filter the resulting events based on the requested events.
 		// In some cases, poll will report events we didn't ask for.
@@ -516,22 +564,20 @@ VALUE IO_Event_Selector_URing_io_wait(VALUE self, VALUE fiber, VALUE io, VALUE e
 	TypedData_Get_Struct(self, struct IO_Event_Selector_URing, &IO_Event_Selector_URing_Type, selector);
 	
 	int descriptor = IO_Event_Selector_io_descriptor(io);
-	struct io_uring_sqe *sqe = io_get_sqe(selector);
 	
 	short flags = poll_flags_from_events(NUM2INT(events));
 	
 	if (DEBUG) fprintf(stderr, "IO_Event_Selector_URing_io_wait:io_uring_prep_poll_add(descriptor=%d, flags=%d, fiber=%p)\n", descriptor, flags, (void*)fiber);
 	
-	io_uring_prep_poll_add(sqe, descriptor, flags);
-	
 	struct IO_Event_Selector_URing_Waiting waiting = {
 		.fiber = fiber,
 	};
 	
 	struct IO_Event_Selector_URing_Completion *completion = IO_Event_Selector_URing_Completion_acquire(selector, &waiting);
 	
+	struct io_uring_sqe *sqe = io_get_sqe(selector);
+	io_uring_prep_poll_add(sqe, descriptor, flags);
 	io_uring_sqe_set_data(sqe, completion);
-	
 	// If we are going to wait, we assume that we are waiting for a while:
 	io_uring_submit_pending(selector);
 	
@@ -579,10 +625,10 @@ io_read_submit(VALUE _arguments)
 {
 	struct io_read_arguments *arguments = (struct io_read_arguments *)_arguments;
 	struct IO_Event_Selector_URing *selector = arguments->selector;
-	struct io_uring_sqe *sqe = io_get_sqe(selector);
 	
-	if (DEBUG) fprintf(stderr, "io_read_submit:io_uring_prep_read(fiber=%p, descriptor=%d, buffer=%p, length=%ld)\n", (void*)arguments->waiting, arguments->descriptor, arguments->buffer, arguments->length);
+	if (DEBUG) fprintf(stderr, "io_read_submit:io_uring_prep_read(waiting=%p, completion=%p, descriptor=%d, buffer=%p, length=%ld)\n", (void*)arguments->waiting, (void*)arguments->waiting->completion, arguments->descriptor, arguments->buffer, arguments->length);
 	
+	struct io_uring_sqe *sqe = io_get_sqe(selector);
 	io_uring_prep_read(sqe, arguments->descriptor, arguments->buffer, arguments->length, io_seekable(arguments->descriptor));
 	io_uring_sqe_set_data(sqe, arguments->waiting->completion);
 	io_uring_submit_now(selector);
@@ -598,18 +644,16 @@ io_read_ensure(VALUE _arguments)
 	struct io_read_arguments *arguments = (struct io_read_arguments *)_arguments;
 	struct IO_Event_Selector_URing *selector = arguments->selector;
 	
-	struct io_uring_sqe *sqe = io_get_sqe(selector);
-	
-	if (DEBUG) fprintf(stderr, "io_read_cancel:io_uring_prep_cancel(fiber=%p)\n", (void*)arguments->waiting);
-	
-	// If the operation has already completed, we don't need to cancel it:
-	if (!arguments->waiting->result) {
-		io_uring_prep_cancel(sqe, (void*)arguments->waiting, 0);
+	// If the operation is still in progress, cancel it:
+	if (arguments->waiting->completion) {
+		if (DEBUG) fprintf(stderr, "io_read_ensure:io_uring_prep_cancel(waiting=%p, completion=%p)\n", (void*)arguments->waiting, (void*)arguments->waiting->completion);
+		struct io_uring_sqe *sqe = io_get_sqe(selector);
+		io_uring_prep_cancel(sqe, (void*)arguments->waiting->completion, 0);
 		io_uring_sqe_set_data(sqe, NULL);
 		io_uring_submit_now(selector);
 	}
 	
-	IO_Event_Selector_URing_Waiting_cancel(arguments->selector, arguments->waiting);
+	IO_Event_Selector_URing_Waiting_cancel(arguments->waiting);
 	
 	return Qnil;
 }
@@ -702,10 +746,9 @@ io_write_submit(VALUE _argument)
 	struct io_write_arguments *arguments = (struct io_write_arguments*)_argument;
 	struct IO_Event_Selector_URing *selector = arguments->selector;
 	
-	struct io_uring_sqe *sqe = io_get_sqe(selector);
-	
-	if (DEBUG) fprintf(stderr, "io_write_submit:io_uring_prep_write(fiber=%p, descriptor=%d, buffer=%p, length=%ld)\n", (void*)arguments->waiting, arguments->descriptor, arguments->buffer, arguments->length);
+	if (DEBUG) fprintf(stderr, "io_write_submit:io_uring_prep_write(waiting=%p, completion=%p, descriptor=%d, buffer=%p, length=%ld)\n", (void*)arguments->waiting, (void*)arguments->waiting->completion, arguments->descriptor, arguments->buffer, arguments->length);
 	
+	struct io_uring_sqe *sqe = io_get_sqe(selector);
 	io_uring_prep_write(sqe, arguments->descriptor, arguments->buffer, arguments->length, io_seekable(arguments->descriptor));
 	io_uring_sqe_set_data(sqe, arguments->waiting->completion);
 	io_uring_submit_pending(selector);
@@ -721,17 +764,16 @@ io_write_ensure(VALUE _argument)
 	struct io_write_arguments *arguments = (struct io_write_arguments*)_argument;
 	struct IO_Event_Selector_URing *selector = arguments->selector;
 	
-	struct io_uring_sqe *sqe = io_get_sqe(selector);
-	
-	if (DEBUG) fprintf(stderr, "io_wait_rescue:io_uring_prep_cancel(%p)\n", (void*)arguments->waiting);
-	
-	if (!arguments->waiting->result) {
-		io_uring_prep_cancel(sqe, (void*)arguments->waiting, 0);
+	// If the operation is still in progress, cancel it:
+	if (arguments->waiting->completion) {
+		if (DEBUG) fprintf(stderr, "io_write_ensure:io_uring_prep_cancel(waiting=%p, completion=%p)\n", (void*)arguments->waiting, (void*)arguments->waiting->completion);
+		struct io_uring_sqe *sqe = io_get_sqe(selector);
+		io_uring_prep_cancel(sqe, (void*)arguments->waiting->completion, 0);
 		io_uring_sqe_set_data(sqe, NULL);
 		io_uring_submit_now(selector);
 	}
 	
-	IO_Event_Selector_URing_Waiting_cancel(arguments->selector, arguments->waiting);
+	IO_Event_Selector_URing_Waiting_cancel(arguments->waiting);
 	
 	return Qnil;
 }
@@ -826,7 +868,6 @@ VALUE IO_Event_Selector_URing_io_close(VALUE self, VALUE io) {
 
 	if (ASYNC_CLOSE) {
 		struct io_uring_sqe *sqe = io_get_sqe(selector);
-		
 		io_uring_prep_close(sqe, descriptor);
 		io_uring_sqe_set_data(sqe, NULL);
 		io_uring_submit_now(selector);
@@ -919,32 +960,41 @@ unsigned select_process_completions(struct IO_Event_Selector_URing *selector) {
 	unsigned head;
 	struct io_uring_cqe *cqe;
 	
+	if (DEBUG) {
+		fprintf(stderr, "select_process_completions: selector=%p\n", (void*)selector);
+		IO_Event_Selector_URing_dump_completion_queue(selector);
+	}
+	
 	io_uring_for_each_cqe(ring, head, cqe) {
+		if (DEBUG) fprintf(stderr, "select_process_completions: cqe res=%d user_data=%p\n", cqe->res, (void*)cqe->user_data);
+		
 		++completed;
 		
-		// If the operation was cancelled, or the operation has no user data (fiber):
+		// If the operation was cancelled, or the operation has no user data:
 		if (cqe->user_data == 0 || cqe->user_data == LIBURING_UDATA_TIMEOUT) {
 			io_uring_cq_advance(ring, 1);
 			continue;
 		}
 		
-		if (DEBUG) fprintf(stderr, "cqe res=%d user_data=%p\n", cqe->res, (void*)cqe->user_data);
-		
 		struct IO_Event_Selector_URing_Completion *completion = (void*)cqe->user_data;
 		struct IO_Event_Selector_URing_Waiting *waiting = completion->waiting;
 		
+		if (DEBUG) fprintf(stderr, "select_process_completions: completion=%p waiting=%p\n", (void*)completion, (void*)waiting);
+		
 		if (waiting) {
 			waiting->result = cqe->res;
 			waiting->flags = cqe->flags;
 		}
 		
 		io_uring_cq_advance(ring, 1);
+		// This marks the waiting operation as "complete":
+		IO_Event_Selector_URing_Completion_release(selector, completion);
 		
 		if (waiting && waiting->fiber) {
+			assert(waiting->result != -ECANCELED);
+			
 			IO_Event_Selector_fiber_transfer(waiting->fiber, 0, NULL);
 		}
-		
-		IO_Event_Selector_URing_Completion_release(selector, completion);
 	}
 	
 	if (DEBUG && completed > 0) fprintf(stderr, "select_process_completions(completed=%d)\n", completed);

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

@@ -160,7 +160,66 @@ module IO::Event
 				errno == EAGAIN or errno == EWOULDBLOCK
 			end
 			
-			if Support.fiber_scheduler_v2?
+			if Support.fiber_scheduler_v3?
+				# Ruby 3.3+, full IO::Buffer support.
+				
+				# @parameter length [Integer] The minimum number of bytes to read.
+				# @parameter offset [Integer] The offset into the buffer to read to.
+				def io_read(fiber, io, buffer, length, offset = 0)
+					total = 0
+					
+					Selector.nonblock(io) do
+						while true
+							result = Fiber.blocking{buffer.read(io, 0, offset)}
+							
+							if result < 0
+								if again?(result)
+									self.io_wait(fiber, io, IO::READABLE)
+								else
+									return result
+								end
+							elsif result == 0
+								break
+							else
+								total += result
+								break if total >= length
+								offset += result
+							end
+						end
+					end
+					
+					return total
+				end
+				
+				# @parameter length [Integer] The minimum number of bytes to write.
+				# @parameter offset [Integer] The offset into the buffer to write from.
+				def io_write(fiber, io, buffer, length, offset = 0)
+					total = 0
+					
+					Selector.nonblock(io) do
+						while true
+							result = Fiber.blocking{buffer.write(io, 0, offset)}
+							
+							if result < 0
+								if again?(result)
+									self.io_wait(fiber, io, IO::READABLE)
+								else
+									return result
+								end
+							elsif result == 0
+								break result
+							else
+								total += result
+								break if total >= length
+								offset += result
+							end
+						end
+					end
+					
+					return total
+				end
+			elsif Support.fiber_scheduler_v2?
+				# Ruby 3.2, most IO::Buffer support, but slightly clunky read/write methods.
 				def io_read(fiber, io, buffer, length, offset = 0)
 					total = 0
 					
@@ -219,6 +278,7 @@ module IO::Event
 					return total
 				end
 			elsif Support.fiber_scheduler_v1?
+				# Ruby <= 3.1, limited IO::Buffer support.
 				def io_read(fiber, _io, buffer, length, offset = 0)
 					io = IO.for_fd(_io.fileno, autoclose: false)
 					total = 0

data/lib/io/event/selector.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative 'selector/select'
 require_relative 'debug/selector'

data/lib/io/event/support.rb

@@ -17,6 +17,17 @@ class IO
 			def self.fiber_scheduler_v2?
 				IO.const_defined?(:Buffer) and Fiber.respond_to?(:blocking) and IO::Buffer.instance_method(:read).arity == -1
 			end
+			
+			def self.fiber_scheduler_v3?
+				if fiber_scheduler_v2?
+					begin
+						IO::Buffer.new.slice(0, 0).write(STDOUT)
+						return true
+					rescue
+						return false
+					end
+				end
+			end
 		end
 	end
 end

data/lib/io/event/version.rb

@@ -5,6 +5,6 @@
 
 class IO
 	module Event
-		VERSION = "1.3.0"
+		VERSION = "1.3.2"
 	end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: io-event
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Samuel Williams
-- Bruno Sutic
 - Math Ieu
+- Bruno Sutic
 - Alex Matchneer
 - Benoit Daloze
 - Delton Ding
@@ -42,7 +42,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: An event loop.