io-event 1.2.2 → 1.3.3

data/lib/io/event/interrupt.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 module IO::Event
 	# A thread safe synchronisation primative.

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2023, by Samuel Williams.
 
 require 'io/nonblock'
 

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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2023, by Math Ieu.
 
 require_relative '../interrupt'
 require_relative '../support'
@@ -103,14 +104,26 @@ module IO::Event
 					self.fiber&.alive?
 				end
 				
-				def transfer(events)
+				# Dispatch the given events to the list of waiting fibers. If the fiber was not waiting for the given events, it is reactivated by calling the given block.
+				def dispatch(events, &reactivate)
+					# We capture the tail here, because calling reactivate might modify it:
+					tail = self.tail
+					
 					if fiber = self.fiber
-						self.fiber = nil
-						
-						fiber.transfer(events & self.events) if fiber.alive?
+						if fiber.alive?
+							revents = events & self.events
+							if revents.zero?
+								reactivate.call(self)
+							else
+								self.fiber = nil
+								fiber.transfer(revents)
+							end
+						else
+							self.fiber = nil
+						end
 					end
-				
-					self.tail&.transfer(events)
+					
+					tail&.dispatch(events, &reactivate)
 				end
 				
 				def invalidate
@@ -147,13 +160,72 @@ 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
-							maximum_size = buffer.size - offset
+							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
+					
+					Selector.nonblock(io) do
+						maximum_size = buffer.size - offset
+						while maximum_size > 0
 							result = Fiber.blocking{buffer.read(io, maximum_size, offset)}
 							
 							if again?(result)
@@ -169,6 +241,8 @@ module IO::Event
 								offset += result
 								break if total >= length
 							end
+							
+							maximum_size = buffer.size - offset
 						end
 					end
 					
@@ -179,8 +253,8 @@ module IO::Event
 					total = 0
 					
 					Selector.nonblock(io) do
-						while true
-							maximum_size = buffer.size - offset
+						maximum_size = buffer.size - offset
+						while maximum_size > 0
 							result = Fiber.blocking{buffer.write(io, maximum_size, offset)}
 							
 							if again?(result)
@@ -196,19 +270,23 @@ module IO::Event
 								offset += result
 								break if total >= length
 							end
+							
+							maximum_size = buffer.size - offset
 						end
 					end
 					
 					return total
 				end
 			elsif Support.fiber_scheduler_v1?
+				# Ruby <= 3.1, limited IO::Buffer support.
 				def io_read(fiber, _io, buffer, length, offset = 0)
+					# We need to avoid any internal buffering, so we use a duplicated IO object:
 					io = IO.for_fd(_io.fileno, autoclose: false)
+					
 					total = 0
 					
-					while true
-						maximum_size = buffer.size - offset
-						
+					maximum_size = buffer.size - offset
+					while maximum_size > 0
 						case result = blocking{io.read_nonblock(maximum_size, exception: false)}
 						when :wait_readable
 							if length > 0
@@ -233,6 +311,8 @@ module IO::Event
 							break if size >= length
 							length -= size
 						end
+						
+						maximum_size = buffer.size - offset
 					end
 					
 					return total
@@ -243,12 +323,13 @@ module IO::Event
 				end
 				
 				def io_write(fiber, _io, buffer, length, offset = 0)
+					# We need to avoid any internal buffering, so we use a duplicated IO object:
 					io = IO.for_fd(_io.fileno, autoclose: false)
+					
 					total = 0
 					
-					while true
-						maximum_size = buffer.size - offset
-						
+					maximum_size = buffer.size - offset
+					while maximum_size > 0
 						chunk = buffer.get_string(offset, maximum_size)
 						case result = blocking{io.write_nonblock(chunk, exception: false)}
 						when :wait_readable
@@ -269,6 +350,8 @@ module IO::Event
 							break if result >= length
 							length -= result
 						end
+						
+						maximum_size = buffer.size - offset
 					end
 					
 					return total
@@ -329,12 +412,26 @@ module IO::Event
 					end
 				end
 				
-				@blocked = true
 				duration = 0 unless @ready.empty?
-				readable, writable, priority = ::IO.select(readable, writable, priority, duration)
-				@blocked = false
+				error = nil
 				
-				ready = Hash.new(0)
+				# We need to handle interrupts on blocking IO. Every other implementation uses EINTR, but that doesn't work with `::IO.select` as it will retry the call on EINTR.
+				Thread.handle_interrupt(::Exception => :on_blocking) do
+					@blocked = true
+					readable, writable, priority = ::IO.select(readable, writable, priority, duration)
+				rescue ::Exception => error
+					# Requeue below...
+				ensure
+					@blocked = false
+				end
+				
+				if error
+					# Requeue the error into the pending exception queue:
+					Thread.current.raise(error)
+					return 0
+				end
+				
+				ready = Hash.new(0).compare_by_identity
 				
 				readable&.each do |io|
 					ready[io] |= IO::READABLE
@@ -349,7 +446,11 @@ module IO::Event
 				end
 				
 				ready.each do |io, events|
-					@waiting.delete(io).transfer(events)
+					@waiting.delete(io).dispatch(events) do |waiter|
+						# Re-schedule the waiting IO:
+						waiter.tail = @waiting[io]
+						@waiting[io] = waiter
+					end
 				end
 				
 				return ready.size

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'
@@ -11,11 +11,7 @@ module IO::Event
 	module Selector
 		def self.default(env = ENV)
 			if name = env['IO_EVENT_SELECTOR']&.to_sym
-				if const_defined?(name)
-					return const_get(name)
-				else
-					warn "Could not find IO_EVENT_SELECTOR=#{name}!"
-				end
+				return const_get(name)
 			end
 			
 			if self.const_defined?(:URing)

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 class IO
 	module Event
-		VERSION = "1.2.2"
+		VERSION = "1.3.3"
 	end
 end

data/lib/io/event.rb

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

data/license.md

@@ -1,10 +1,11 @@
 # MIT License
 
-Copyright, 2021-2022, by Samuel Williams.  
+Copyright, 2021-2023, by Samuel Williams.  
 Copyright, 2021, by Delton Ding.  
 Copyright, 2021, by Benoit Daloze.  
 Copyright, 2022, by Alex Matchneer.  
 Copyright, 2022, by Bruno Sutic.  
+Copyright, 2023, by Math Ieu.  
 
 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

@@ -16,8 +16,16 @@ Please see the [project documentation](https://socketry.github.io/io-event/).
 
 We welcome contributions to this project.
 
-1.  Fork it
-2.  Create your feature branch (`git checkout -b my-new-feature`)
-3.  Commit your changes (`git commit -am 'Add some feature'`)
-4.  Push to the branch (`git push origin my-new-feature`)
-5.  Create new Pull Request
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### 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.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: io-event
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Samuel Williams
+- Math Ieu
 - Bruno Sutic
+- Alex Matchneer
 - Benoit Daloze
 - Delton Ding
-- machty
 autorequire:
 bindir: bin
 cert_chain:
@@ -41,64 +42,8 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-05-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
+date: 2023-10-24 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 executables: []
@@ -112,10 +57,12 @@ files:
 - ext/io/event/event.h
 - ext/io/event/interrupt.c
 - ext/io/event/interrupt.h
+- ext/io/event/selector/array.h
 - ext/io/event/selector/epoll.c
 - ext/io/event/selector/epoll.h
 - ext/io/event/selector/kqueue.c
 - ext/io/event/selector/kqueue.h
+- ext/io/event/selector/list.h
 - ext/io/event/selector/pidfd.c
 - ext/io/event/selector/selector.c
 - ext/io/event/selector/selector.h
@@ -150,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: An event loop.