io-event 1.6.5 → 1.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53b1f32affa83ac713eaaf8fba4b9a1c9d2f25421908759dde9b5adec11c498f
-  data.tar.gz: 6504222eab182d55f2b56ef91c4de9f301f509a69fff17f286c03f0ef0315786
+  metadata.gz: 53bb3bfd2bffe7db8d43a4dd2d136a2ec9b62df30b78f90894b816a33a855765
+  data.tar.gz: 151b806b36724b5f210e28a59949ca4c4550a79a15e29174b6c7bdf9e5e4ba7d
 SHA512:
-  metadata.gz: ac5f863272fb2a532d1adbe16e2960f78dd6f4ce52891e391f301d40bb28ad74e2775348d55610f1f308f7a69b0b362e93f794b44fe94b4ec6e91331a2e851d5
-  data.tar.gz: 042a1a3ba4ec1a3e438d823b9d9348eeebc86be2464030744a9a01ff50654aeeb229fb79729083d3f1bdb2feb968dcee8ec320d33de7083196eb1afd887c5ef6
+  metadata.gz: ef219c25c4acc91a0fb56bfb3a36275b131d71e594682c0f6d383e0d66657ecd286b711bf90323e661d83be0961fa0baaf4368c0e3c2309b0e3376f9c006fefc
+  data.tar.gz: 56112593370c044238ee9198ef1ee608e0be69507a37dd380c9a54d03948074b1ec89e692308f4b6e58096730398be1fd2a3efee4c9e055977e543058716aaec

data/ext/extconf.rb

@@ -2,21 +2,23 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 # Copyright, 2023, by Math Ieu.
 
 return if RUBY_DESCRIPTION =~ /jruby/
 
-require 'mkmf'
+require "mkmf"
 
 gem_name = File.basename(__dir__)
-extension_name = 'IO_Event'
+extension_name = "IO_Event"
 
 # dir_config(extension_name)
 
 $CFLAGS << " -Wall -Wno-unknown-pragmas -std=c99"
 
-if ENV.key?('RUBY_DEBUG')
+if ENV.key?("RUBY_DEBUG")
+	$stderr.puts "Enabling debug mode..."
+	
 	$CFLAGS << " -DRUBY_DEBUG -O0"
 end
 
@@ -24,24 +26,24 @@ $srcs = ["io/event/event.c", "io/event/selector/selector.c"]
 $VPATH << "$(srcdir)/io/event"
 $VPATH << "$(srcdir)/io/event/selector"
 
-have_func('rb_ext_ractor_safe')
-have_func('&rb_fiber_transfer')
+have_func("rb_ext_ractor_safe")
+have_func("&rb_fiber_transfer")
 
-if have_library('uring') and have_header('liburing.h')
+if have_library("uring") and have_header("liburing.h")
 	$srcs << "io/event/selector/uring.c"
 end
 
-if have_header('sys/epoll.h')
+if have_header("sys/epoll.h")
 	$srcs << "io/event/selector/epoll.c"
 end
 
-if have_header('sys/event.h')
+if have_header("sys/event.h")
 	$srcs << "io/event/selector/kqueue.c"
 end
 
-have_header('sys/wait.h')
+have_header("sys/wait.h")
 
-have_header('sys/eventfd.h')
+have_header("sys/eventfd.h")
 $srcs << "io/event/interrupt.c"
 
 have_func("rb_io_descriptor")
@@ -50,7 +52,15 @@ have_func("rb_fiber_current")
 have_func("&rb_fiber_raise")
 have_func("epoll_pwait2")
 
-have_header('ruby/io/buffer.h')
+have_header("ruby/io/buffer.h")
+
+if ENV.key?("RUBY_SANITIZE")
+	$stderr.puts "Enabling sanitizers..."
+	
+	# Add address and undefined behaviour sanitizers:
+	$CFLAGS << " -fsanitize=address -fsanitize=undefined -fno-omit-frame-pointer"
+	$LDFLAGS << " -fsanitize=address -fsanitize=undefined"
+end
 
 create_header
 

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

@@ -29,6 +29,8 @@ inline static void IO_Event_Array_allocate(struct IO_Event_Array *array, size_t
 {
 	if (count) {
 		array->base = (void**)calloc(count, sizeof(void*));
+		assert(array->base);
+		
 		array->count = count;
 	} else {
 		array->base = NULL;
@@ -51,6 +53,7 @@ inline static void IO_Event_Array_free(struct IO_Event_Array *array)
 		void *element = array->base[i];
 		if (element) {
 			array->element_free(element);
+			
 			free(element);
 		}
 	}
@@ -107,6 +110,7 @@ inline static void* IO_Event_Array_lookup(struct IO_Event_Array *array, size_t i
 	// Allocate the element if it doesn't exist:
 	if (*element == NULL) {
 		*element = malloc(array->element_size);
+		assert(*element);
 		
 		if (array->element_initialize) {
 			array->element_initialize(*element);

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

@@ -184,7 +184,7 @@ static const rb_data_type_t IO_Event_Selector_EPoll_Type = {
 		.dsize = IO_Event_Selector_EPoll_Type_size,
 	},
 	.data = NULL,
-	.flags = RUBY_TYPED_FREE_IMMEDIATELY,
+	.flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
 };
 
 inline static
@@ -333,7 +333,7 @@ VALUE IO_Event_Selector_EPoll_allocate(VALUE self) {
 	struct IO_Event_Selector_EPoll *selector = NULL;
 	VALUE instance = TypedData_Make_Struct(self, struct IO_Event_Selector_EPoll, &IO_Event_Selector_EPoll_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, Qnil);
+	IO_Event_Selector_initialize(&selector->backend, self, Qnil);
 	selector->descriptor = -1;
 	selector->blocked = 0;
 	
@@ -363,7 +363,7 @@ VALUE IO_Event_Selector_EPoll_initialize(VALUE self, VALUE loop) {
 	struct IO_Event_Selector_EPoll *selector = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_EPoll, &IO_Event_Selector_EPoll_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, loop);
+	IO_Event_Selector_initialize(&selector->backend, self, loop);
 	int result = epoll_create1(EPOLL_CLOEXEC);
 	
 	if (result == -1) {

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

@@ -183,7 +183,7 @@ static const rb_data_type_t IO_Event_Selector_KQueue_Type = {
 		.dsize = IO_Event_Selector_KQueue_Type_size,
 	},
 	.data = NULL,
-	.flags = RUBY_TYPED_FREE_IMMEDIATELY,
+	.flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
 };
 
 inline static
@@ -307,7 +307,7 @@ VALUE IO_Event_Selector_KQueue_allocate(VALUE self) {
 	struct IO_Event_Selector_KQueue *selector = NULL;
 	VALUE instance = TypedData_Make_Struct(self, struct IO_Event_Selector_KQueue, &IO_Event_Selector_KQueue_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, Qnil);
+	IO_Event_Selector_initialize(&selector->backend, self, Qnil);
 	selector->descriptor = -1;
 	selector->blocked = 0;
 	
@@ -340,7 +340,7 @@ VALUE IO_Event_Selector_KQueue_initialize(VALUE self, VALUE loop) {
 	struct IO_Event_Selector_KQueue *selector = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_KQueue, &IO_Event_Selector_KQueue_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, loop);
+	IO_Event_Selector_initialize(&selector->backend, self, loop);
 	int result = kqueue();
 	
 	if (result == -1) {

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

@@ -172,24 +172,35 @@ static void queue_pop(struct IO_Event_Selector *backend, struct IO_Event_Selecto
 	if (waiting->head) {
 		waiting->head->tail = waiting->tail;
 	} else {
+		// We must have been at the head of the queue:
 		backend->waiting = waiting->tail;
 	}
 	
 	if (waiting->tail) {
 		waiting->tail->head = waiting->head;
 	} else {
+		// We must have been at the tail of the queue:
 		backend->ready = waiting->head;
 	}
+	
+	waiting->head = NULL;
+	waiting->tail = NULL;
 }
 
 static void queue_push(struct IO_Event_Selector *backend, struct IO_Event_Selector_Queue *waiting) {
+	assert(waiting->head == NULL);
+	assert(waiting->tail == NULL);
+	
 	if (backend->waiting) {
+		// If there was an item in the queue already, we shift it along:
 		backend->waiting->head = waiting;
 		waiting->tail = backend->waiting;
 	} else {
+		// If the queue was empty, we update the tail too:
 		backend->ready = waiting;
 	}
 	
+	// We always push to the front/head:
 	backend->waiting = waiting;
 }
 
@@ -270,11 +281,14 @@ VALUE IO_Event_Selector_raise(struct IO_Event_Selector *backend, int argc, VALUE
 void IO_Event_Selector_queue_push(struct IO_Event_Selector *backend, VALUE fiber)
 {
 	struct IO_Event_Selector_Queue *waiting = malloc(sizeof(struct IO_Event_Selector_Queue));
+	assert(waiting);
 	
 	waiting->head = NULL;
 	waiting->tail = NULL;
 	waiting->flags = IO_EVENT_SELECTOR_QUEUE_INTERNAL;
+	
 	waiting->fiber = fiber;
+	RB_OBJ_WRITTEN(backend->self, Qundef, fiber);
 	
 	queue_push(backend, waiting);
 }
@@ -283,9 +297,10 @@ static inline
 void IO_Event_Selector_queue_pop(struct IO_Event_Selector *backend, struct IO_Event_Selector_Queue *ready)
 {
 	if (DEBUG) fprintf(stderr, "IO_Event_Selector_queue_pop -> %p\n", (void*)ready->fiber);
+	
 	if (ready->flags & IO_EVENT_SELECTOR_QUEUE_FIBER) {
 		IO_Event_Selector_fiber_transfer(ready->fiber, 0, NULL);
-	} else {
+	} else if (ready->flags & IO_EVENT_SELECTOR_QUEUE_INTERNAL) {
 		VALUE fiber = ready->fiber;
 		queue_pop(backend, ready);
 		free(ready);
@@ -293,6 +308,8 @@ void IO_Event_Selector_queue_pop(struct IO_Event_Selector *backend, struct IO_Ev
 		if (RTEST(rb_funcall(fiber, id_alive_p, 0))) {
 			rb_funcall(fiber, id_transfer, 0);
 		}
+	} else {
+		rb_raise(rb_eRuntimeError, "Unknown queue type!");
 	}
 }
 
@@ -300,6 +317,8 @@ int IO_Event_Selector_queue_flush(struct IO_Event_Selector *backend)
 {
 	int count = 0;
 	
+	// During iteration of the queue, the same item may be re-queued. If we don't handle this correctly, we may end up in an infinite loop. So, to avoid this situation, we keep note of the current head of the queue and break the loop if we reach the same item again.
+	
 	// Get the current tail and head of the queue:
 	struct IO_Event_Selector_Queue *waiting = backend->waiting;
 	if (DEBUG) fprintf(stderr, "IO_Event_Selector_queue_flush waiting = %p\n", waiting);

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

@@ -95,27 +95,31 @@ struct IO_Event_Selector_Queue {
 };
 
 struct IO_Event_Selector {
+	VALUE self;
 	VALUE loop;
 	
 	struct IO_Event_Selector_Queue *free;
 	
-	// Append to waiting.
+	// Append to waiting (front/head of queue).
 	struct IO_Event_Selector_Queue *waiting;
-	// Process from ready.
+	// Process from ready (back/tail of queue).
 	struct IO_Event_Selector_Queue *ready;
 };
 
 static inline
-void IO_Event_Selector_initialize(struct IO_Event_Selector *backend, VALUE loop) {
-	backend->loop = loop;
+void IO_Event_Selector_initialize(struct IO_Event_Selector *backend, VALUE self, VALUE loop) {
+	RB_OBJ_WRITE(self, &backend->self, self);
+	RB_OBJ_WRITE(self, &backend->loop, loop);
 	backend->waiting = NULL;
 	backend->ready = NULL;
 }
 
 static inline
 void IO_Event_Selector_mark(struct IO_Event_Selector *backend) {
+	rb_gc_mark_movable(backend->self);
 	rb_gc_mark_movable(backend->loop);
 	
+	// Walk backwards through the ready queue:
 	struct IO_Event_Selector_Queue *ready = backend->ready;
 	while (ready) {
 		rb_gc_mark_movable(ready->fiber);
@@ -125,6 +129,7 @@ void IO_Event_Selector_mark(struct IO_Event_Selector *backend) {
 
 static inline
 void IO_Event_Selector_compact(struct IO_Event_Selector *backend) {
+	backend->self = rb_gc_location(backend->self);
 	backend->loop = rb_gc_location(backend->loop);
 	
 	struct IO_Event_Selector_Queue *ready = backend->ready;

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

@@ -152,7 +152,7 @@ static const rb_data_type_t IO_Event_Selector_URing_Type = {
 		.dsize = IO_Event_Selector_URing_Type_size,
 	},
 	.data = NULL,
-	.flags = RUBY_TYPED_FREE_IMMEDIATELY,
+	.flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
 };
 
 inline static
@@ -228,7 +228,7 @@ VALUE IO_Event_Selector_URing_allocate(VALUE self) {
 	struct IO_Event_Selector_URing *selector = NULL;
 	VALUE instance = TypedData_Make_Struct(self, struct IO_Event_Selector_URing, &IO_Event_Selector_URing_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, Qnil);
+	IO_Event_Selector_initialize(&selector->backend, self, Qnil);
 	selector->ring.ring_fd = -1;
 	
 	selector->pending = 0;
@@ -249,7 +249,7 @@ VALUE IO_Event_Selector_URing_initialize(VALUE self, VALUE loop) {
 	struct IO_Event_Selector_URing *selector = NULL;
 	TypedData_Get_Struct(self, struct IO_Event_Selector_URing, &IO_Event_Selector_URing_Type, selector);
 	
-	IO_Event_Selector_initialize(&selector->backend, loop);
+	IO_Event_Selector_initialize(&selector->backend, self, loop);
 	int result = io_uring_queue_init(URING_ENTRIES, &selector->ring, 0);
 	
 	if (result < 0) {

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

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative '../support'
+require_relative "../support"
 
 module IO::Event
 	module Debug
@@ -12,8 +12,8 @@ module IO::Event
 			def self.wrap(selector, env = ENV)
 				log = nil
 				
-				if log_path = env['IO_EVENT_DEBUG_SELECTOR_LOG']
-					log = File.open(log_path, 'w')
+				if log_path = env["IO_EVENT_DEBUG_SELECTOR_LOG"]
+					log = File.open(log_path, "w")
 				end
 				
 				return self.new(selector, log: log)

data/lib/io/event/interrupt.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 module IO::Event
 	# A thread safe synchronisation primative.
@@ -27,7 +27,7 @@ module IO::Event
 		
 		# Send a sigle byte interrupt.
 		def signal
-			@output.write('.')
+			@output.write(".")
 			@output.flush
 		rescue IOError
 			# Ignore.

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require 'io/nonblock'
+require "io/nonblock"
 
 module IO::Event
 	module Selector

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

@@ -4,8 +4,8 @@
 # Copyright, 2021-2024, by Samuel Williams.
 # Copyright, 2023, by Math Ieu.
 
-require_relative '../interrupt'
-require_relative '../support'
+require_relative "../interrupt"
+require_relative "../support"
 
 module IO::Event
 	module Selector
@@ -168,6 +168,8 @@ module IO::Event
 			if Support.fiber_scheduler_v3?
 				# Ruby 3.3+, full IO::Buffer support.
 				
+				# Read from the given IO to the buffer.
+				#
 				# @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)
@@ -196,6 +198,8 @@ module IO::Event
 					return total
 				end
 				
+				# Write to the given IO from the buffer.
+				#
 				# @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)

data/lib/io/event/selector.rb

@@ -3,14 +3,14 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'selector/select'
-require_relative 'debug/selector'
-require_relative 'support'
+require_relative "selector/select"
+require_relative "debug/selector"
+require_relative "support"
 
 module IO::Event
 	module Selector
 		def self.default(env = ENV)
-			if name = env['IO_EVENT_SELECTOR']&.to_sym
+			if name = env["IO_EVENT_SELECTOR"]&.to_sym
 				return const_get(name)
 			end
 			
@@ -28,7 +28,7 @@ module IO::Event
 		def self.new(loop, env = ENV)
 			selector = default(env).new(loop)
 			
-			if debug = env['IO_EVENT_DEBUG_SELECTOR']
+			if debug = env["IO_EVENT_DEBUG_SELECTOR"]
 				selector = Debug::Selector.wrap(selector, env)
 			end
 			

data/lib/io/event/support.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 class IO
 	module Event
@@ -10,14 +10,23 @@ class IO
 				IO.const_defined?(:Buffer)
 			end
 			
+			# To be removed on 31 Mar 2025.
 			def self.fiber_scheduler_v1?
-				IO.const_defined?(:Buffer) and !Fiber.respond_to?(:blocking)
+				IO.const_defined?(:Buffer)
 			end
 			
+			# To be removed on 31 Mar 2026.
 			def self.fiber_scheduler_v2?
+				# Some interface changes were back-ported incorrectly:
+				# https://github.com/ruby/ruby/pull/10778
+				# Specifically "Improvements to IO::Buffer read/write/pread/pwrite."
+				# Missing correct size calculation.
+				return false if RUBY_VERSION >= "3.2.5"
+				
 				IO.const_defined?(:Buffer) and Fiber.respond_to?(:blocking) and IO::Buffer.instance_method(:read).arity == -1
 			end
 			
+			# To become the default 31 Mar 2026.
 			def self.fiber_scheduler_v3?
 				if fiber_scheduler_v2?
 					return true if RUBY_VERSION >= "3.3"

data/lib/io/event/timers.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require_relative 'priority_heap'
+require_relative "priority_heap"
 
 class IO
 	module Event

data/lib/io/event/version.rb

@@ -5,6 +5,6 @@
 
 class IO
 	module Event
-		VERSION = "1.6.5"
+		VERSION = "1.6.7"
 	end
 end

data/lib/io/event.rb

@@ -3,13 +3,13 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'event/version'
-require_relative 'event/selector'
-require_relative 'event/timers'
+require_relative "event/version"
+require_relative "event/selector"
+require_relative "event/timers"
 
 begin
-	require 'IO_Event'
+	require "IO_Event"
 rescue LoadError => error
 	warn "Could not load native event selector: #{error}"
-	require_relative 'event/selector/nonblock'
+	require_relative "event/selector/nonblock"
 end

data/license.md

@@ -8,6 +8,7 @@ Copyright, 2022, by Alex Matchneer.
 Copyright, 2022, by Bruno Sutic.  
 Copyright, 2023, by Math Ieu.  
 Copyright, 2024, by Pavel Rosický.  
+Copyright, 2024, by Anthony Ross.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -24,8 +24,8 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-event
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.6.7
 platform: ruby
 authors:
 - Samuel Williams
@@ -10,6 +10,7 @@ authors:
 - Benoit Daloze
 - Bruno Sutic
 - Alex Matchneer
+- Anthony Ross
 - Delton Ding
 - Pavel Rosický
 autorequire:
@@ -44,7 +45,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-06-23 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -85,7 +86,9 @@ files:
 homepage: https://github.com/socketry/io-event
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/io-event/
+  source_code_uri: https://github.com/socketry/io-event.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -101,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: An event loop.