io-event 1.1.5 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26fea80dce46f28ba71af255facb8ef1daca055ba8da63c6bc585eef3baad7b7
-  data.tar.gz: 5b0eeb129fc7203e0ffb9dedd5c0638ba2c05c025c47496b79491e13fc160095
+  metadata.gz: 0202b38104b1b6254a15fc12f687f9102509ba75592b1584d3dd5d0e44c497fb
+  data.tar.gz: 925de8b198ea2a9fca99b7c02c5262dd691a9864601c7db109a79c332804b944
 SHA512:
-  metadata.gz: f78ca39439f5c89185f96432907f980944d778c2ceffc1f51355e810caac1b844fbb8e8e83b14a3df25d9e8205a40b5b1673052ba9eb2924a9f00639cdfbee54
-  data.tar.gz: 1418caaf2eb40020e1b7a984d9d77b5c63a795ede985eab0854d24ad35004304ed0fc6ea5eebf5f77ec37d13c5edff490ad6111b98d8899b2ded50cdca043cc3
+  metadata.gz: d0bb87512e17c8be8ca0b04390466b0c3de198c6ee4a4a0a074b31d8e2f3bb0f482ece3378d0d9653b9219d36f06d41882f4c78631b27f6c0fb02e4143688d33
+  data.tar.gz: 4403550628403eccfb92d60e44ccf096ecb2dee1f2e78917fbef65b8c49cc71b15db96b3074e5b16f0ce005f826db928e4a95fd1214973cf33509659195a2e9a

data/ext/extconf.rb

@@ -33,7 +33,7 @@ extension_name = 'IO_Event'
 
 # dir_config(extension_name)
 
-$CFLAGS << " -Wall -std=c99"
+$CFLAGS << " -Wall -Wno-unknown-pragmas -std=c99"
 
 $srcs = ["io/event/event.c", "io/event/selector/selector.c"]
 $VPATH << "$(srcdir)/io/event"

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

@@ -39,6 +39,8 @@ static VALUE IO_Event_Selector_URing = Qnil;
 
 enum {URING_ENTRIES = 64};
 
+#pragma mark - Data Type
+
 struct IO_Event_Selector_URing {
 	struct IO_Event_Selector backend;
 	struct io_uring ring;
@@ -98,6 +100,8 @@ VALUE IO_Event_Selector_URing_allocate(VALUE self) {
 	return instance;
 }
 
+#pragma mark - Methods
+
 VALUE IO_Event_Selector_URing_initialize(VALUE self, VALUE loop) {
 	struct IO_Event_Selector_URing *data = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_URing, &IO_Event_Selector_URing_Type, data);
@@ -179,6 +183,9 @@ VALUE IO_Event_Selector_URing_ready_p(VALUE self) {
 	return data->backend.ready ? Qtrue : Qfalse;
 }
 
+#pragma mark - Submission Queue
+
+// Flush the submission queue if pending operations are present.
 static
 int io_uring_submit_flush(struct IO_Event_Selector_URing *data) {
 	if (data->pending) {
@@ -200,8 +207,11 @@ int io_uring_submit_flush(struct IO_Event_Selector_URing *data) {
 	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 *data) {
+	if (DEBUG && data->pending) fprintf(stderr, "io_uring_submit_now(pending=%ld)\n", data->pending);
+
 	while (true) {
 		int result = io_uring_submit(&data->ring);
 		
@@ -218,9 +228,12 @@ int io_uring_submit_now(struct IO_Event_Selector_URing *data) {
 	}
 }
 
+// Submit a pending operation. This does not submit the operation immediately, but instead defers it to the next call to `io_uring_submit_flush` or `io_uring_submit_now`. This is useful for operations that are not urgent, but should be used with care as it can lead to a deadlock if the submission queue is not flushed.
 static
 void io_uring_submit_pending(struct IO_Event_Selector_URing *data) {
 	data->pending += 1;
+	
+	if (DEBUG) fprintf(stderr, "io_uring_submit_pending(ring=%p, pending=%ld)\n", &data->ring, data->pending);
 }
 
 struct io_uring_sqe * io_get_sqe(struct IO_Event_Selector_URing *data) {
@@ -236,6 +249,8 @@ struct io_uring_sqe * io_get_sqe(struct IO_Event_Selector_URing *data) {
 	return sqe;
 }
 
+#pragma mark - Process.wait
+
 struct process_wait_arguments {
 	struct IO_Event_Selector_URing *data;
 	pid_t pid;
@@ -284,6 +299,8 @@ VALUE IO_Event_Selector_URing_process_wait(VALUE self, VALUE fiber, VALUE pid, V
 	return rb_ensure(process_wait_transfer, (VALUE)&process_wait_arguments, process_wait_ensure, (VALUE)&process_wait_arguments);
 }
 
+#pragma mark - IO#wait
+
 static inline
 short poll_flags_from_events(int events) {
 	short flags = 0;
@@ -379,6 +396,8 @@ VALUE IO_Event_Selector_URing_io_wait(VALUE self, VALUE fiber, VALUE io, VALUE e
 
 #ifdef HAVE_RUBY_IO_BUFFER_H
 
+#pragma mark - IO#read
+
 #if LINUX_VERSION_CODE >= KERNEL_VERSION(5,16,0)
 static inline off_t io_seekable(int descriptor) {
 	return -1;
@@ -395,19 +414,67 @@ static inline off_t io_seekable(int descriptor)
 }
 #endif
 
-static int io_read(struct IO_Event_Selector_URing *data, VALUE fiber, int descriptor, char *buffer, size_t length) {
-	struct io_uring_sqe *sqe = io_get_sqe(data);
+#pragma mark - IO#read
 
-	if (DEBUG) fprintf(stderr, "io_read:io_uring_prep_read(fiber=%p)\n", (void*)fiber);
+struct io_read_arguments {
+	struct IO_Event_Selector_URing *data;
+	VALUE fiber;
+	int descriptor;
+	char *buffer;
+	size_t length;
+};
 
-	io_uring_prep_read(sqe, descriptor, buffer, length, io_seekable(descriptor));
-	io_uring_sqe_set_data(sqe, (void*)fiber);
+static VALUE
+io_read_submit(VALUE _arguments)
+{
+	struct io_read_arguments *arguments = (struct io_read_arguments *)_arguments;
+	struct IO_Event_Selector_URing *data = arguments->data;
+	struct io_uring_sqe *sqe = io_get_sqe(data);
+	
+	if (DEBUG) fprintf(stderr, "io_read_submit:io_uring_prep_read(fiber=%p, descriptor=%d, buffer=%p, length=%ld)\n", (void*)arguments->fiber, arguments->descriptor, arguments->buffer, arguments->length);
+	
+	io_uring_prep_read(sqe, arguments->descriptor, arguments->buffer, arguments->length, io_seekable(arguments->descriptor));
+	io_uring_sqe_set_data(sqe, (void*)arguments->fiber);
 	io_uring_submit_now(data);
 	
-	VALUE result = IO_Event_Selector_fiber_transfer(data->backend.loop, 0, NULL);
-	if (DEBUG) fprintf(stderr, "io_read:IO_Event_Selector_fiber_transfer -> %d\n", RB_NUM2INT(result));
+	return IO_Event_Selector_fiber_transfer(data->backend.loop, 0, NULL);
+}
+
+static VALUE
+io_read_cancel(VALUE _arguments, VALUE exception)
+{
+	struct io_read_arguments *arguments = (struct io_read_arguments *)_arguments;
+	struct IO_Event_Selector_URing *data = arguments->data;
+	
+	struct io_uring_sqe *sqe = io_get_sqe(data);
+	
+	if (DEBUG) fprintf(stderr, "io_read_cancel:io_uring_prep_cancel(fiber=%p)\n", (void*)arguments->fiber);
+	
+	io_uring_prep_cancel(sqe, (void*)arguments->fiber, 0);
+	io_uring_sqe_set_data(sqe, NULL);
+	io_uring_submit_now(data);
+	
+	rb_exc_raise(exception);
+}
 
-	return RB_NUM2INT(result);
+static int
+io_read(struct IO_Event_Selector_URing *data, VALUE fiber, int descriptor, char *buffer, size_t length)
+{
+	struct io_read_arguments io_read_arguments = {
+		.data = data,
+		.fiber = fiber,
+		.descriptor = descriptor,
+		.buffer = buffer,
+		.length = length
+	};
+	
+	int result = RB_NUM2INT(
+		rb_rescue(io_read_submit, (VALUE)&io_read_arguments, io_read_cancel, (VALUE)&io_read_arguments)
+	);
+	
+	if (DEBUG) fprintf(stderr, "io_read:IO_Event_Selector_fiber_transfer -> %d\n", result);
+	
+	return result;
 }
 
 VALUE IO_Event_Selector_URing_io_read(VALUE self, VALUE fiber, VALUE io, VALUE buffer, VALUE _length, VALUE _offset) {
@@ -458,19 +525,67 @@ static VALUE IO_Event_Selector_URing_io_read_compatible(int argc, VALUE *argv, V
 	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) {
+#pragma mark - IO#write
+
+struct io_write_arguments {
+	struct IO_Event_Selector_URing *data;
+	VALUE fiber;
+	int descriptor;
+	char *buffer;
+	size_t length;
+};
+
+static VALUE
+io_write_submit(VALUE _argument)
+{
+	struct io_write_arguments *arguments = (struct io_write_arguments*)_argument;
+	struct IO_Event_Selector_URing *data = arguments->data;
+	
 	struct io_uring_sqe *sqe = io_get_sqe(data);
 	
-	if (DEBUG) fprintf(stderr, "io_write:io_uring_prep_write(fiber=%p)\n", (void*)fiber);
-
-	io_uring_prep_write(sqe, descriptor, buffer, length, io_seekable(descriptor));
-	io_uring_sqe_set_data(sqe, (void*)fiber);
+	if (DEBUG) fprintf(stderr, "io_write_submit:io_uring_prep_write(fiber=%p, descriptor=%d, buffer=%p, length=%ld)\n", (void*)arguments->fiber, arguments->descriptor, arguments->buffer, arguments->length);
+	
+	io_uring_prep_write(sqe, arguments->descriptor, arguments->buffer, arguments->length, io_seekable(arguments->descriptor));
+	io_uring_sqe_set_data(sqe, (void*)arguments->fiber);
 	io_uring_submit_pending(data);
 	
-	int result = RB_NUM2INT(IO_Event_Selector_fiber_transfer(data->backend.loop, 0, NULL));
-	if (DEBUG) fprintf(stderr, "io_write:IO_Event_Selector_fiber_transfer -> %d\n", result);
+	return IO_Event_Selector_fiber_transfer(data->backend.loop, 0, NULL);
+}
 
+static VALUE
+io_write_cancel(VALUE _argument, VALUE exception)
+{
+	struct io_write_arguments *arguments = (struct io_write_arguments*)_argument;
+	struct IO_Event_Selector_URing *data = arguments->data;
+	
+	struct io_uring_sqe *sqe = io_get_sqe(data);
+	
+	if (DEBUG) fprintf(stderr, "io_wait_rescue:io_uring_prep_cancel(%p)\n", (void*)arguments->fiber);
+	
+	io_uring_prep_cancel(sqe, (void*)arguments->fiber, 0);
+	io_uring_sqe_set_data(sqe, NULL);
+	io_uring_submit_now(data);
+	
+	rb_exc_raise(exception);
+}
+
+static int
+io_write(struct IO_Event_Selector_URing *data, VALUE fiber, int descriptor, char *buffer, size_t length)
+{
+	struct io_write_arguments arguments = {
+		.data = data,
+		.fiber = fiber,
+		.descriptor = descriptor,
+		.buffer = buffer,
+		.length = length,
+	};
+	
+	int result = RB_NUM2INT(
+		rb_rescue(io_write_submit, (VALUE)&arguments, io_write_cancel, (VALUE)&arguments)
+	);
+	
+	if (DEBUG) fprintf(stderr, "io_write:IO_Event_Selector_fiber_transfer -> %d\n", result);
+	
 	return result;
 }
 
@@ -526,6 +641,8 @@ static VALUE IO_Event_Selector_URing_io_write_compatible(int argc, VALUE *argv,
 
 #endif
 
+#pragma mark - IO#close
+
 static const int ASYNC_CLOSE = 1;
 
 VALUE IO_Event_Selector_URing_io_close(VALUE self, VALUE io) {
@@ -548,6 +665,8 @@ VALUE IO_Event_Selector_URing_io_close(VALUE self, VALUE io) {
 	return Qtrue;
 }
 
+#pragma mark - Event Loop
+
 static
 struct __kernel_timespec * make_timeout(VALUE duration, struct __kernel_timespec *storage) {
 	if (duration == Qnil) {
@@ -647,7 +766,7 @@ unsigned select_process_completions(struct io_uring *ring) {
 	
 	// io_uring_cq_advance(ring, completed);
 	
-	if (DEBUG) fprintf(stderr, "select_process_completions(completed=%d)\n", completed);
+	if (DEBUG && completed > 0) fprintf(stderr, "select_process_completions(completed=%d)\n", completed);
 	
 	return completed;
 }
@@ -680,9 +799,6 @@ VALUE IO_Event_Selector_URing_select(VALUE self, VALUE duration) {
 		if (!data->backend.ready && !timeout_nonblocking(arguments.timeout)) {
 			// This is a blocking operation, we wait for events:
 			result = select_internal_without_gvl(&arguments);
-		} else {
-			// The timeout specified required "nonblocking" behaviour so we just flush the SQ if required:
-			io_uring_submit_flush(data);
 		}
 		
 		// After waiting/flushing the SQ, check if there are any completions:
@@ -721,6 +837,8 @@ VALUE IO_Event_Selector_URing_wakeup(VALUE self) {
 	return Qfalse;
 }
 
+#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);

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

@@ -9,6 +9,9 @@ module IO::Event
 	module Selector
 		def self.nonblock(io, &block)
 			io.nonblock(&block)
+		rescue Errno::EBADF
+			# Windows.
+			yield
 		end
 	end
 end

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

@@ -140,14 +140,14 @@ module IO::Event
 				end.value
 			end
 			
+			EAGAIN = -Errno::EAGAIN::Errno
+			EWOULDBLOCK = -Errno::EWOULDBLOCK::Errno
+			
+			def again?(errno)
+				errno == EAGAIN or errno == EWOULDBLOCK
+			end
+			
 			if Support.fiber_scheduler_v2?
-				EAGAIN = -Errno::EAGAIN::Errno
-				EWOULDBLOCK = -Errno::EWOULDBLOCK::Errno
-				
-				def again?(errno)
-					errno == EAGAIN or errno == EWOULDBLOCK
-				end
-				
 				def io_read(fiber, io, buffer, length, offset = 0)
 					total = 0
 					
@@ -236,6 +236,10 @@ module IO::Event
 					end
 					
 					return total
+				rescue IOError => error
+					return -Errno::EBADF::Errno
+				rescue SystemCallError => error
+					return -error.errno
 				end
 				
 				def io_write(fiber, _io, buffer, length, offset = 0)
@@ -268,6 +272,10 @@ module IO::Event
 					end
 					
 					return total
+				rescue IOError => error
+					return -Errno::EBADF::Errno
+				rescue SystemCallError => error
+					return -error.errno
 				end
 				
 				def blocking(&block)

data/lib/io/event/version.rb

@@ -5,6 +5,6 @@
 
 class IO
 	module Event
-		VERSION = "1.1.5"
+		VERSION = "1.1.7"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-event
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.7
 platform: ruby
 authors:
 - Samuel Williams
@@ -41,7 +41,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: An event loop.