io-event 1.10.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec418d3289f8648ac13d7808bbe8d56b50a3b4cf518f61da116c56c3c345daa9
-  data.tar.gz: 8de6423981f2bfb2da54e0cd99e493787253a2c2c83bc644f72fffdcf52a295c
+  metadata.gz: 15970f96a2af0de9aa23889ee6ff50217b53216334de39ad5b4692ebf945942b
+  data.tar.gz: 5f44f0dbcdf09106e342e3fda71f56f8a0208dc5a435e82f8c80b1fdb8826fae
 SHA512:
-  metadata.gz: 9fd70cf075b1703fd8e4659fa2adaf7381f7d5523e47e8700eeda233a01679c671ebb8197fd06f525da17b7a30332e996dd087874503f8ff7a594b8f88268554
-  data.tar.gz: c42e23c74e1069fb199fd1044b7fc487b8f1587294703a19362242bbbfa23c21fbba36a6a114fafb978ddc4cfcd2a21d2a6c7b7c3d3dc1c4a08094ca9b51bd2a
+  metadata.gz: 0b72815ede642358071d66b9720935603493b6a09a34fcf2eec6930c8648a7d2b6498358f630554f40c6537f2bd0fb3cb6b58334ad58dfbaacc5d6c1f0e407cf
+  data.tar.gz: a5eb4e8396cd510aa71e8ee45f8ebf60829ca707a96bded1104ce0c3f74c47e9343225d826c58e4ec7bcfed6aed81051d7c14a10f304c42fa61fe930e1099fef

data/agent.md

@@ -0,0 +1,47 @@
+# Agent
+
+## Context
+
+This section provides links to documentation from installed packages. It is automatically generated and may be updated by running `bake agent:context:install`.
+
+**Important:** Before performing any code, documentation, or analysis tasks, always read and apply the full content of any relevant documentation referenced in the following sections. These context files contain authoritative standards and best practices for documentation, code style, and project-specific workflows. **Do not proceed with any actions until you have read and incorporated the guidance from relevant context files.**
+
+### agent-context
+
+Install and manage context files from Ruby gems.
+
+#### [Usage Guide](.context/agent-context/usage.md)
+
+`agent-context` is a tool that helps you discover and install contextual information from Ruby gems for AI agents. Gems can provide additional documentation, examples, and guidance in a `context/` ...
+
+### decode
+
+Code analysis for documentation generation.
+
+#### [Getting Started with Decode](.context/decode/getting-started.md)
+
+The Decode gem provides programmatic access to Ruby code structure and metadata. It can parse Ruby files and extract definitions, comments, and documentation pragmas, enabling code analysis, docume...
+
+#### [Documentation Coverage](.context/decode/coverage.md)
+
+This guide explains how to test and monitor documentation coverage in your Ruby projects using the Decode gem's built-in bake tasks.
+
+#### [Ruby Documentation](.context/decode/ruby-documentation.md)
+
+This guide covers documentation practices and pragmas supported by the Decode gem for documenting Ruby code. These pragmas provide structured documentation that can be parsed and used to generate A...
+
+### sus
+
+A fast and scalable test runner.
+
+#### [Using Sus Testing Framework](.context/sus/usage.md)
+
+Sus is a modern Ruby testing framework that provides a clean, BDD-style syntax for writing tests. It's designed to be fast, simple, and expressive.
+
+#### [Mocking](.context/sus/mocking.md)
+
+There are two types of mocking in sus: `receive` and `mock`. The `receive` matcher is a subset of full mocking and is used to set expectations on method calls, while `mock` can be used to replace m...
+
+#### [Shared Test Behaviors and Fixtures](.context/sus/shared.md)
+
+Sus provides shared test contexts which can be used to define common behaviours or tests that can be reused across one or more test files.

data/ext/extconf.rb

@@ -4,6 +4,7 @@
 # Released under the MIT License.
 # Copyright, 2021-2025, by Samuel Williams.
 # Copyright, 2023, by Math Ieu.
+# Copyright, 2025, by Stanislav (Stas) Katkov.
 
 return if RUBY_DESCRIPTION =~ /jruby/
 
@@ -14,12 +15,12 @@ extension_name = "IO_Event"
 
 # dir_config(extension_name)
 
-$CFLAGS << " -Wall -Wno-unknown-pragmas -std=c99"
+append_cflags(["-Wall", "-Wno-unknown-pragmas", "-std=c99"])
 
 if ENV.key?("RUBY_DEBUG")
 	$stderr.puts "Enabling debug mode..."
-	
-	$CFLAGS << " -DRUBY_DEBUG -O0"
+
+	append_cflags(["-DRUBY_DEBUG", "-O0"])
 end
 
 $srcs = ["io/event/event.c", "io/event/time.c", "io/event/fiber.c", "io/event/selector/selector.c"]
@@ -32,7 +33,7 @@ have_func("&rb_fiber_transfer")
 if have_library("uring") and have_header("liburing.h")
 	# We might want to consider using this in the future:
 	# have_func("io_uring_submit_and_wait_timeout", "liburing.h")
-	
+
 	$srcs << "io/event/selector/uring.c"
 end
 
@@ -57,11 +58,21 @@ have_func("epoll_pwait2")
 
 have_header("ruby/io/buffer.h")
 
+# Feature detection for blocking operation support
+if have_func("rb_fiber_scheduler_blocking_operation_extract")
+	# Feature detection for pthread support (needed for WorkerPool)
+	if have_header("pthread.h")
+		append_cflags(["-DHAVE_IO_EVENT_WORKER_POOL"])
+		$srcs << "io/event/worker_pool.c"
+		$srcs << "io/event/worker_pool_test.c"
+	end
+end
+
 if ENV.key?("RUBY_SANITIZE")
 	$stderr.puts "Enabling sanitizers..."
-	
+
 	# Add address and undefined behaviour sanitizers:
-	$CFLAGS << " -fsanitize=address -fsanitize=undefined -fno-omit-frame-pointer"
+	append_cflags(["-fsanitize=address", "-fsanitize=undefined", "-fno-omit-frame-pointer"])
 	$LDFLAGS << " -fsanitize=address -fsanitize=undefined"
 end
 

data/ext/io/event/event.c

@@ -14,7 +14,11 @@ void Init_IO_Event(void)
 	VALUE IO_Event = rb_define_module_under(rb_cIO, "Event");
 	
 	Init_IO_Event_Fiber(IO_Event);
-	
+
+	#ifdef HAVE_IO_EVENT_WORKER_POOL
+	Init_IO_Event_WorkerPool(IO_Event);
+	#endif
+
 	VALUE IO_Event_Selector = rb_define_module_under(IO_Event, "Selector");
 	Init_IO_Event_Selector(IO_Event_Selector);
 	

data/ext/io/event/event.h

@@ -18,3 +18,7 @@ void Init_IO_Event(void);
 #ifdef HAVE_SYS_EVENT_H
 #include "selector/kqueue.h"
 #endif
+
+#ifdef HAVE_IO_EVENT_WORKER_POOL
+#include "worker_pool.h"
+#endif

data/ext/io/event/fiber.c

@@ -35,7 +35,7 @@ VALUE IO_Event_Fiber_raise(VALUE fiber, int argc, VALUE *argv) {
 #ifndef HAVE_RB_FIBER_CURRENT
 static ID id_current;
 
-static VALUE IO_Event_Fiber_current(void) {
+VALUE IO_Event_Fiber_current(void) {
 	return rb_funcall(rb_cFiber, id_current, 0);
 }
 #endif

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

@@ -38,6 +38,10 @@ struct IO_Event_Selector_EPoll
 {
 	struct IO_Event_Selector backend;
 	int descriptor;
+	
+	// Flag indicating whether the selector is currently blocked in a system call.
+	// Set to 1 when blocked in epoll_wait() without GVL, 0 otherwise.
+	// Used by wakeup() to determine if an interrupt signal is needed.
 	int blocked;
 	
 	struct timespec idle_duration;

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

@@ -47,6 +47,10 @@ struct IO_Event_Selector_KQueue
 {
 	struct IO_Event_Selector backend;
 	int descriptor;
+	
+	// Flag indicating whether the selector is currently blocked in a system call.
+	// Set to 1 when blocked in kevent() without GVL, 0 otherwise.
+	// Used by wakeup() to determine if an interrupt signal is needed.
 	int blocked;
 	
 	struct timespec idle_duration;

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

@@ -29,10 +29,7 @@ VALUE IO_Event_Selector_process_status_wait(rb_pid_t pid, int flags)
 int IO_Event_Selector_nonblock_set(int file_descriptor)
 {
 #ifdef _WIN32
-	u_long nonblock = 1;
-	ioctlsocket(file_descriptor, FIONBIO, &nonblock);
-	// Windows does not provide any way to know this, so we always restore it back to unset:
-	return 0;
+	rb_w32_set_nonblock(file_descriptor);
 #else
 	// Get the current mode:
 	int flags = fcntl(file_descriptor, F_GETFL, 0);
@@ -50,8 +47,6 @@ void IO_Event_Selector_nonblock_restore(int file_descriptor, int flags)
 {
 #ifdef _WIN32
 	// Yolo...
-	u_long nonblock = flags;
-	ioctlsocket(file_descriptor, FIONBIO, &nonblock);
 #else
 	// The flags didn't have O_NONBLOCK set, so it would have been set, so we need to restore it:
 	if (!(flags & O_NONBLOCK)) {

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

@@ -18,7 +18,7 @@
 enum {
 	DEBUG = 0,
 	DEBUG_COMPLETION = 0,
-	DEBUG_IO_READ = 1,
+	DEBUG_CQE = 0,
 };
 
 enum {URING_ENTRIES = 64};
@@ -30,6 +30,10 @@ struct IO_Event_Selector_URing
 	struct IO_Event_Selector backend;
 	struct io_uring ring;
 	size_t pending;
+	
+	// Flag indicating whether the selector is currently blocked in a system call.
+	// Set to 1 when blocked in io_uring_wait_cqe_timeout() without GVL, 0 otherwise.
+	// Used by wakeup() to determine if an interrupt signal is needed.
 	int blocked;
 	
 	struct timespec idle_duration;
@@ -552,7 +556,10 @@ VALUE io_wait_transfer(VALUE _arguments) {
 	
 	if (DEBUG) fprintf(stderr, "io_wait_transfer:waiting=%p, result=%d\n", (void*)arguments->waiting, arguments->waiting->result);
 	
-	if (arguments->waiting->result) {
+	int32_t result = arguments->waiting->result;
+	if (result < 0) {
+		rb_syserr_fail(-result, "io_wait_transfer:io_uring_poll_add");
+	} else if (result > 0) {
 		// We explicitly filter the resulting events based on the requested events.
 		// In some cases, poll will report events we didn't ask for.
 		return RB_INT2NUM(events_from_poll_flags(arguments->waiting->result & arguments->flags));
@@ -704,6 +711,20 @@ VALUE IO_Event_Selector_URing_io_read(VALUE self, VALUE fiber, VALUE io, VALUE b
 	off_t from = io_seekable(descriptor);
 	
 	size_t maximum_size = size - offset;
+	
+	// Are we performing a non-blocking read?
+	if (!length) {
+		// If the (maximum) length is zero, that indicates we just want to read whatever is available without blocking.
+		// If we schedule this read into the URing, it will block until data is available, rather than returning immediately.
+		int state = IO_Event_Selector_nonblock_set(descriptor);
+		
+		int result = read(descriptor, (char*)base+offset, maximum_size);
+		int error = errno;
+		
+		IO_Event_Selector_nonblock_restore(descriptor, state);
+		return rb_fiber_scheduler_io_result(result, error);
+	}
+	
 	while (maximum_size) {
 		int result = io_read(selector, fiber, descriptor, (char*)base+offset, maximum_size, from);
 		
@@ -1059,7 +1080,7 @@ unsigned select_process_completions(struct IO_Event_Selector_URing *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);
+		if (DEBUG_CQE) fprintf(stderr, "select_process_completions: cqe res=%d user_data=%p\n", cqe->res, (void*)cqe->user_data);
 		
 		++completed;
 		
@@ -1090,7 +1111,7 @@ unsigned select_process_completions(struct IO_Event_Selector_URing *selector) {
 		}
 	}
 	
-	if (DEBUG && completed > 0) fprintf(stderr, "select_process_completions(completed=%d)\n", completed);
+	if (DEBUG && completed > 0) fprintf(stderr, "select_process_completions: completed=%d\n", completed);
 	
 	return completed;
 }