io-event 1.1.6 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b1d6d29aedc2b375fa708f5f3518fb39dae6ee0b5c675a4ff571192f3c00ef
-  data.tar.gz: 6e9b9589ef99c97a287d20e4f60f501d87ca163897d21bdd59eb03aa71085ffd
+  metadata.gz: c19fdf43c5e63eb628c4ebb1feedcd048eac2e3ec4b83571f05bcb239eed9d02
+  data.tar.gz: 141749bc238099c65ebcc6db1d0d8b8ce1c3477e6e11a9f62e6c50572b9b6d84
 SHA512:
-  metadata.gz: 6447991710738ba24577100220b4ca322d79179d736ba3101bdd5fd2a2d8a23aa8983d527ebc13cdde5b038601c17d6a860ed21394a2f3d584ddd68772f505b6
-  data.tar.gz: e8a0232a3f36be1bfab1a1ca8a9e0a68e761d89d9f1576449ea23644eddc2643f89c9963186376d1211f25fb96853cadef82c673ca81af7430cdacb45d3f37ea
+  metadata.gz: c3da16be3fd6a0f98106f3e263ff2229e61a03bf5660fee1d3bb1bf6c191f1fd7475aabb85c8b5c29b25f6205816c728b42d68c74e4a123cea6810ac7be44b23
+  data.tar.gz: '026937a0ad18ba0f2783a8e8b8624177e8fbae34ca1a52eb2c5ccd59ae8231d4eea192fc3cc6b54d60e7d5d40d630f97754afa12e115f9ac44bd79caa9e52eee'

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"
@@ -63,6 +63,7 @@ have_func("rb_io_descriptor")
 have_func("&rb_process_status_wait")
 have_func("rb_fiber_current")
 have_func("&rb_fiber_raise")
+have_func("epoll_pwait2")
 
 have_header('ruby/io/buffer.h')
 

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

@@ -569,6 +569,38 @@ VALUE IO_Event_Selector_EPoll_io_write_compatible(int argc, VALUE *argv, VALUE s
 
 #endif
 
+#if defined(HAVE_EPOLL_PWAIT2)
+static
+struct timespec * make_timeout(VALUE duration, struct timespec * storage) {
+	if (duration == Qnil) {
+		return NULL;
+	}
+	
+	if (FIXNUM_P(duration)) {
+		storage->tv_sec = NUM2TIMET(duration);
+		storage->tv_nsec = 0;
+		
+		return storage;
+	}
+	
+	else if (RB_FLOAT_TYPE_P(duration)) {
+		double value = RFLOAT_VALUE(duration);
+		time_t seconds = value;
+		
+		storage->tv_sec = seconds;
+		storage->tv_nsec = (value - seconds) * 1000000000L;
+		
+		return storage;
+	}
+	
+	rb_raise(rb_eRuntimeError, "unable to convert timeout");
+}
+
+static
+int timeout_nonblocking(struct timespec * timespec) {
+	return timespec && timespec->tv_sec == 0 && timespec->tv_nsec == 0;
+}
+#else
 static
 int make_timeout(VALUE duration) {
 	if (duration == Qnil) {
@@ -588,20 +620,35 @@ int make_timeout(VALUE duration) {
 	rb_raise(rb_eRuntimeError, "unable to convert timeout");
 }
 
+static
+int timeout_nonblocking(int timeout) {
+	return timeout == 0;
+}
+#endif
+
 struct select_arguments {
 	struct IO_Event_Selector_EPoll *data;
 	
 	int count;
 	struct epoll_event events[EPOLL_MAX_EVENTS];
-	
+
+#if defined(HAVE_EPOLL_PWAIT2)
+	struct timespec * timeout;
+	struct timespec storage;
+#else
 	int timeout;
+#endif
 };
 
 static
 void * select_internal(void *_arguments) {
 	struct select_arguments * arguments = (struct select_arguments *)_arguments;
 	
+#if defined(HAVE_EPOLL_PWAIT2)
+	arguments->count = epoll_pwait2(arguments->data->descriptor, arguments->events, EPOLL_MAX_EVENTS, arguments->timeout, NULL);
+#else
 	arguments->count = epoll_wait(arguments->data->descriptor, arguments->events, EPOLL_MAX_EVENTS, arguments->timeout);
+#endif
 	
 	return NULL;
 }
@@ -642,9 +689,20 @@ VALUE IO_Event_Selector_EPoll_select(VALUE self, VALUE duration) {
 	
 	struct select_arguments arguments = {
 		.data = data,
+#if defined(HAVE_EPOLL_PWAIT2)
+		.storage = {
+			.tv_sec = 0,
+			.tv_nsec = 0
+		}
+#else
 		.timeout = 0
+#endif
 	};
 	
+#if defined(HAVE_EPOLL_PWAIT2)
+	arguments.timeout = &arguments.storage;
+#endif
+	
 	// Process any currently pending events:
 	select_internal_with_gvl(&arguments);
 	
@@ -654,9 +712,13 @@ VALUE IO_Event_Selector_EPoll_select(VALUE self, VALUE duration) {
 	// 3. There are no items in the ready list,
 	// then we can perform a blocking select.
 	if (!ready && !arguments.count && !data->backend.ready) {
+#if defined(HAVE_EPOLL_PWAIT2)
+		arguments.timeout = make_timeout(duration, &arguments.storage);
+#else
 		arguments.timeout = make_timeout(duration);
+#endif
 		
-		if (arguments.timeout != 0) {
+		if (!timeout_nonblocking(arguments.timeout)) {
 			// Wait for events to occur
 			select_internal_without_gvl(&arguments);
 		}

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

@@ -43,7 +43,7 @@ enum IO_Event {
 	IO_EVENT_HANGUP = 16
 };
 
-void Init_IO_Event_Selector();
+void Init_IO_Event_Selector(VALUE IO_Event_Selector);
 
 static inline int IO_Event_try_again(int error) {
 	return error == EAGAIN || error == EWOULDBLOCK;

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,8 @@ 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) {
@@ -204,6 +210,8 @@ int io_uring_submit_flush(struct IO_Event_Selector_URing *data) {
 // 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);
 		
@@ -220,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) {
@@ -238,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;
@@ -286,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;
@@ -381,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;
@@ -397,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);
+}
 
-	return RB_NUM2INT(result);
+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);
+}
+
+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) {
@@ -460,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;
 }
 
@@ -528,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) {
@@ -550,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) {
@@ -649,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;
 }
@@ -720,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/select.rb

@@ -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.6"
+		VERSION = "1.2.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-event
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -41,7 +41,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-04-30 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.10
 signing_key:
 specification_version: 4
 summary: An event loop.