event 0.4.4 → 0.8.0

data/ext/event/{backend → selector}/uring.h

@@ -22,7 +22,7 @@
 
 #include <ruby.h>
 
-#define EVENT_BACKEND_URING
+#define EVENT_SELECTOR_URING
 
-void Init_Event_Backend_URing(VALUE Event_Backend);
-VALUE Event_Backend_URing_select(VALUE self, VALUE duration);
+void Init_Event_Selector_URing(VALUE Event_Selector);
+VALUE Event_Selector_URing_select(VALUE self, VALUE duration);

data/lib/event.rb

@@ -19,7 +19,8 @@
 # THE SOFTWARE.
 
 require_relative 'event/version'
-require_relative 'event/backend'
+require_relative 'event/selector'
+require_relative 'event/selector'
 
 module Event
 	# These constants are the same as those defined in IO.

data/lib/event/debug.rb

@@ -0,0 +1,126 @@
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require "event/version"
+
+module Event
+	class Debug
+		def initialize(selector)
+			@selector = selector
+			
+			@readable = {}
+			@writable = {}
+			@priority = {}
+		end
+		
+		def close
+			if @selector.nil?
+				raise "Selector already closed!"
+			end
+			
+			@selector.close
+			@selector = nil
+		end
+		
+		def transfer(fiber, *arguments)
+			@selector.transfer(fiber, *arguments)
+		end
+		
+		def yield
+			@selector.yield
+		end
+		
+		def push(fiber)
+			@selector.push(fiber)
+		end
+		
+		def raise(fiber, *arguments)
+			@selector.raise(fiber, *arguments)
+		end
+		
+		def ready?
+			@selector.ready?
+		end
+		
+		def io_wait(fiber, io, events)
+			register_readable(fiber, io, events)
+		end
+		
+		def select(duration = nil)
+			@selector.select(duration)
+		end
+		
+		private
+		
+		def register_readable(fiber, io, events)
+			if (events & READABLE) > 0
+				if @readable.key?(io)
+					raise "Cannot wait for #{io} to become readable from multiple fibers."
+				end
+				
+				begin
+					@readable[io] = fiber
+					
+					register_writable(fiber, io, events)
+				ensure
+					@readable.delete(io)
+				end
+			else
+				register_writable(fiber, io, events)
+			end
+		end
+		
+		def register_writable(fiber, io, events)
+			if (events & WRITABLE) > 0
+				if @writable.key?(io)
+					raise "Cannot wait for #{io} to become writable from multiple fibers."
+				end
+				
+				begin
+					@writable[io] = fiber
+					
+					register_priority(fiber, io, events)
+				ensure
+					@writable.delete(io)
+				end
+			else
+				register_priority(fiber, io, events)
+			end
+		end
+		
+		def register_priority(fiber, io, events)
+			if (events & PRIORITY) > 0
+				if @priority.key?(io)
+					raise "Cannot wait for #{io} to become priority from multiple fibers."
+				end
+				
+				begin
+					@priority[io] = fiber
+					
+					@selector.io_wait(fiber, io, events)
+				ensure
+					@priority.delete(io)
+				end
+			else
+				@selector.io_wait(fiber, io, events)
+			end
+		end
+	end
+end

data/lib/event/selector.rb

@@ -18,9 +18,32 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require "event/version"
+require_relative 'selector/select'
 
 module Event
-	class Selector
+	module Selector
+		def self.default(env = ENV)
+			if name = env['EVENT_SELECTOR']&.to_sym
+				if Event::Selector.const_defined?(name)
+					return Event::Selector.const_get(name)
+				else
+					warn "Could not find EVENT_SELECTOR=#{name}!"
+				end
+			end
+			
+			if self.const_defined?(:URing)
+				return Event::Selector::URing
+			elsif self.const_defined?(:KQueue)
+				return Event::Selector::KQueue
+			elsif self.const_defined?(:EPoll)
+				return Event::Selector::EPoll
+			else
+				return Event::Selector::Select
+			end
+		end
+		
+		def self.new(...)
+			default.new(...)
+		end
 	end
 end

data/lib/event/{backend → selector}/select.rb

@@ -19,13 +19,15 @@
 # THE SOFTWARE.
 
 module Event
-	module Backend
+	module Selector
 		class Select
 			def initialize(loop)
 				@loop = loop
 				
 				@readable = {}
 				@writable = {}
+				
+				@ready = []
 			end
 			
 			def close
@@ -34,6 +36,36 @@ module Event
 				@writable = nil
 			end
 			
+			def transfer(fiber, *arguments)
+				@ready.push(Fiber.current)
+				fiber.transfer(*arguments)
+			ensure
+				@ready.delete(fiber)
+			end
+			
+			def yield
+				fiber = Fiber.current
+				@ready.push(fiber)
+				@loop.transfer
+			ensure
+				@ready.delete(fiber)
+			end
+			
+			def push(fiber)
+				@ready.push(fiber)
+			end
+			
+			def raise(fiber, *arguments)
+				@ready.push(Fiber.current)
+				@fiber.raise(*arguments)
+			ensure
+				@ready.delete(fiber)
+			end
+			
+			def ready?
+				@ready.any?
+			end
+			
 			def io_wait(fiber, io, events)
 				remove_readable = remove_writable = false
 				
@@ -53,7 +85,81 @@ module Event
 				@writable.delete(io) if remove_writable
 			end
 			
+			if IO.const_defined?(:Buffer)
+				def io_read(fiber, io, buffer, length)
+					offset = 0
+					
+					while length > 0
+						# The maximum size we can read:
+						maximum_size = buffer.size - offset
+						
+						case result = io.read_nonblock(maximum_size, exception: false)
+						when :wait_readable
+							self.io_wait(fiber, io, READABLE)
+						when :wait_writable
+							self.io_wait(fiber, io, WRITABLE)
+						else
+							break if result.empty?
+							
+							buffer.copy(result, offset)
+							
+							offset += result.bytesize
+							length -= result.bytesize
+						end
+					end
+					
+					return offset
+				end
+				
+				def io_write(fiber, io, buffer, length)
+					offset = 0
+					
+					while length > 0
+						# From offset until the end:
+						chunk = buffer.to_str(offset, length)
+						case result = io.write_nonblock(chunk, exception: false)
+						when :wait_readable
+							self.io_wait(fiber, io, READABLE)
+						when :wait_writable
+							self.io_wait(fiber, io, WRITABLE)
+						else
+							offset += result
+							length -= result
+						end
+					end
+					
+					return offset
+				end
+			end
+			
+			def process_wait(fiber, pid, flags)
+				r, w = IO.pipe
+				
+				thread = Thread.new do
+					Process::Status.wait(pid, flags)
+				ensure
+					w.close
+				end
+				
+				self.io_wait(fiber, r, READABLE)
+				
+				return thread.value
+			ensure
+				r.close
+				w.close
+				thread&.kill
+			end
+			
 			def select(duration = nil)
+				if @ready.any?
+					ready = @ready
+					@ready = Array.new
+					
+					ready.each do |fiber|
+						fiber.transfer if fiber.alive?
+					end
+				end
+				
 				readable, writable, _ = ::IO.select(@readable.keys, @writable.keys, nil, duration)
 				
 				ready = Hash.new(0)

data/lib/event/version.rb

@@ -1,3 +1,3 @@
 module Event
-	VERSION = "0.4.4"
+	VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -74,29 +74,28 @@ extensions:
 extra_rdoc_files: []
 files:
 - ext/event/Makefile
-- ext/event/backend.o
-- ext/event/backend/backend.c
-- ext/event/backend/backend.h
-- ext/event/backend/epoll.c
-- ext/event/backend/epoll.h
-- ext/event/backend/kqueue.c
-- ext/event/backend/kqueue.h
-- ext/event/backend/uring.c
-- ext/event/backend/uring.h
-- ext/event/epoll.o
+- ext/event/event.bundle
 - ext/event/event.c
 - ext/event/event.h
 - ext/event/event.o
-- ext/event/event.so
 - ext/event/extconf.h
 - ext/event/extconf.rb
+- ext/event/kqueue.o
 - ext/event/mkmf.log
-- ext/event/uring.o
+- ext/event/selector.o
+- ext/event/selector/epoll.c
+- ext/event/selector/epoll.h
+- ext/event/selector/kqueue.c
+- ext/event/selector/kqueue.h
+- ext/event/selector/pidfd.c
+- ext/event/selector/selector.c
+- ext/event/selector/selector.h
+- ext/event/selector/uring.c
+- ext/event/selector/uring.h
 - lib/event.rb
-- lib/event/backend.rb
-- lib/event/backend/select.rb
-- lib/event/debug/selector.rb
+- lib/event/debug.rb
 - lib/event/selector.rb
+- lib/event/selector/select.rb
 - lib/event/version.rb
 homepage: https://github.com/socketry/event
 licenses:
@@ -117,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: An event loop.

data/ext/event/backend/backend.c

@@ -1,39 +0,0 @@
-// Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
-// 
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-// 
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-// 
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-
-#include "backend.h"
-
-static ID id_transfer, id_alive_p;
-
-void Init_Event_Backend(VALUE Event_Backend) {
-	id_transfer = rb_intern("transfer");
-	id_alive_p = rb_intern("alive?");
-}
-
-VALUE
-Event_Backend_resume_safe(VALUE fiber, VALUE result) {
-	VALUE alive = rb_funcall(fiber, id_alive_p, 0);
-	
-	if (RTEST(alive)) {
-		return rb_funcall(fiber, id_transfer, 1, result);
-	} else {
-		return Qnil;
-	}
-}

data/ext/event/backend/epoll.c

@@ -1,309 +0,0 @@
-// Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
-// 
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-// 
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-// 
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-
-#include "kqueue.h"
-#include "backend.h"
-
-#include <sys/epoll.h>
-#include <time.h>
-#include <errno.h>
-
-static VALUE Event_Backend_EPoll = Qnil;
-static ID id_fileno, id_transfer;
-
-enum {EPOLL_MAX_EVENTS = 64};
-
-struct Event_Backend_EPoll {
-	VALUE loop;
-	int descriptor;
-};
-
-void Event_Backend_EPoll_Type_mark(void *_data)
-{
-	struct Event_Backend_EPoll *data = _data;
-	rb_gc_mark(data->loop);
-}
-
-static
-void close_internal(struct Event_Backend_EPoll *data) {
-	if (data->descriptor >= 0) {
-		close(data->descriptor);
-		data->descriptor = -1;
-	}
-}
-
-void Event_Backend_EPoll_Type_free(void *_data)
-{
-	struct Event_Backend_EPoll *data = _data;
-	
-	close_internal(data);
-	
-	free(data);
-}
-
-size_t Event_Backend_EPoll_Type_size(const void *data)
-{
-	return sizeof(struct Event_Backend_EPoll);
-}
-
-static const rb_data_type_t Event_Backend_EPoll_Type = {
-	.wrap_struct_name = "Event::Backend::EPoll",
-	.function = {
-		.dmark = Event_Backend_EPoll_Type_mark,
-		.dfree = Event_Backend_EPoll_Type_free,
-		.dsize = Event_Backend_EPoll_Type_size,
-	},
-	.data = NULL,
-	.flags = RUBY_TYPED_FREE_IMMEDIATELY,
-};
-
-VALUE Event_Backend_EPoll_allocate(VALUE self) {
-	struct Event_Backend_EPoll *data = NULL;
-	VALUE instance = TypedData_Make_Struct(self, struct Event_Backend_EPoll, &Event_Backend_EPoll_Type, data);
-	
-	data->loop = Qnil;
-	data->descriptor = -1;
-	
-	return instance;
-}
-
-VALUE Event_Backend_EPoll_initialize(VALUE self, VALUE loop) {
-	struct Event_Backend_EPoll *data = NULL;
-	TypedData_Get_Struct(self, struct Event_Backend_EPoll, &Event_Backend_EPoll_Type, data);
-	
-	data->loop = loop;
-	int result = epoll_create1(EPOLL_CLOEXEC);
-	
-	if (result == -1) {
-		rb_sys_fail("epoll_create");
-	} else {
-		data->descriptor = result;
-		
-		rb_update_max_fd(data->descriptor);
-	}
-	
-	return self;
-}
-
-VALUE Event_Backend_EPoll_close(VALUE self) {
-	struct Event_Backend_EPoll *data = NULL;
-	TypedData_Get_Struct(self, struct Event_Backend_EPoll, &Event_Backend_EPoll_Type, data);
-	
-	close_internal(data);
-	
-	return Qnil;
-}
-
-static inline
-uint32_t epoll_flags_from_events(int events) {
-	uint32_t flags = 0;
-	
-	if (events & READABLE) flags |= EPOLLIN;
-	if (events & PRIORITY) flags |= EPOLLPRI;
-	if (events & WRITABLE) flags |= EPOLLOUT;
-	
-	flags |= EPOLLRDHUP;
-	flags |= EPOLLONESHOT;
-	
-	return flags;
-}
-
-static inline
-int events_from_epoll_flags(uint32_t flags) {
-	int events = 0;
-	
-	if (flags & EPOLLIN) events |= READABLE;
-	if (flags & EPOLLPRI) events |= PRIORITY;
-	if (flags & EPOLLOUT) events |= WRITABLE;
-	
-	return events;
-}
-
-struct io_wait_arguments {
-	struct Event_Backend_EPoll *data;
-	int descriptor;
-	int duplicate;
-};
-
-static
-VALUE io_wait_ensure(VALUE _arguments) {
-	struct io_wait_arguments *arguments = (struct io_wait_arguments *)_arguments;
-	
-	if (arguments->duplicate >= 0) {
-		epoll_ctl(arguments->data->descriptor, EPOLL_CTL_DEL, arguments->duplicate, NULL);
-		
-		close(arguments->duplicate);
-	} else {
-		epoll_ctl(arguments->data->descriptor, EPOLL_CTL_DEL, arguments->descriptor, NULL);
-	}
-	
-	return Qnil;
-};
-
-static
-VALUE io_wait_transfer(VALUE _arguments) {
-	struct io_wait_arguments *arguments = (struct io_wait_arguments *)_arguments;
-	
-	VALUE result = rb_funcall(arguments->data->loop, id_transfer, 0);
-	
-	return INT2NUM(events_from_epoll_flags(NUM2INT(result)));
-};
-
-VALUE Event_Backend_EPoll_io_wait(VALUE self, VALUE fiber, VALUE io, VALUE events) {
-	struct Event_Backend_EPoll *data = NULL;
-	TypedData_Get_Struct(self, struct Event_Backend_EPoll, &Event_Backend_EPoll_Type, data);
-	
-	struct epoll_event event = {0};
-	
-	int descriptor = NUM2INT(rb_funcall(io, id_fileno, 0));
-	int duplicate = -1;
-	
-	event.events = epoll_flags_from_events(NUM2INT(events));
-	event.data.ptr = (void*)fiber;
-	
-	// fprintf(stderr, "<- fiber=%p descriptor=%d\n", (void*)fiber, descriptor);
-	
-	// A better approach is to batch all changes:
-	int result = epoll_ctl(data->descriptor, EPOLL_CTL_ADD, descriptor, &event);
-	
-	if (result == -1 && errno == EEXIST) {
-		// The file descriptor was already inserted into epoll.
-		duplicate = descriptor = dup(descriptor);
-		
-		rb_update_max_fd(duplicate);
-		
-		if (descriptor == -1)
-			rb_sys_fail("dup");
-		
-		result = epoll_ctl(data->descriptor, EPOLL_CTL_ADD, descriptor, &event);
-	}
-	
-	if (result == -1) {
-		rb_sys_fail("epoll_ctl");
-	}
-	
-	struct io_wait_arguments io_wait_arguments = {
-		.data = data,
-		.descriptor = descriptor,
-		.duplicate = duplicate
-	};
-	
-	return rb_ensure(io_wait_transfer, (VALUE)&io_wait_arguments, io_wait_ensure, (VALUE)&io_wait_arguments);
-}
-
-static
-int make_timeout(VALUE duration) {
-	if (duration == Qnil) {
-		return -1;
-	}
-	
-	if (FIXNUM_P(duration)) {
-		return NUM2LONG(duration) * 1000L;
-	}
-	
-	else if (RB_FLOAT_TYPE_P(duration)) {
-		double value = RFLOAT_VALUE(duration);
-		
-		return value * 1000;
-	}
-	
-	rb_raise(rb_eRuntimeError, "unable to convert timeout");
-}
-
-struct select_arguments {
-	struct Event_Backend_EPoll *data;
-	
-	int count;
-	struct epoll_event events[EPOLL_MAX_EVENTS];
-	
-	int timeout;
-};
-
-static
-void * select_internal(void *_arguments) {
-	struct select_arguments * arguments = (struct select_arguments *)_arguments;
-	
-	arguments->count = epoll_wait(arguments->data->descriptor, arguments->events, EPOLL_MAX_EVENTS, arguments->timeout);
-	
-	return NULL;
-}
-
-static
-void select_internal_without_gvl(struct select_arguments *arguments) {
-	rb_thread_call_without_gvl(select_internal, (void *)arguments, RUBY_UBF_IO, 0);
-	
-	if (arguments->count == -1) {
-		rb_sys_fail("select_internal_without_gvl:epoll_wait");
-	}
-}
-
-static
-void select_internal_with_gvl(struct select_arguments *arguments) {
-	select_internal((void *)arguments);
-	
-	if (arguments->count == -1) {
-		rb_sys_fail("select_internal_with_gvl:epoll_wait");
-	}
-}
-
-VALUE Event_Backend_EPoll_select(VALUE self, VALUE duration) {
-	struct Event_Backend_EPoll *data = NULL;
-	TypedData_Get_Struct(self, struct Event_Backend_EPoll, &Event_Backend_EPoll_Type, data);
-	
-	struct select_arguments arguments = {
-		.data = data,
-		.timeout = 0
-	};
-	
-	select_internal_with_gvl(&arguments);
-	
-	if (arguments.count == 0) {
-		arguments.timeout = make_timeout(duration);
-		
-		if (arguments.timeout != 0) {
-			select_internal_without_gvl(&arguments);
-		}
-	}
-	
-	for (int i = 0; i < arguments.count; i += 1) {
-		VALUE fiber = (VALUE)arguments.events[i].data.ptr;
-		VALUE result = INT2NUM(arguments.events[i].events);
-		
-		// fprintf(stderr, "-> fiber=%p descriptor=%d\n", (void*)fiber, events[i].data.fd);
-		
-		Event_Backend_resume_safe(fiber, result);
-	}
-	
-	return INT2NUM(arguments.count);
-}
-
-void Init_Event_Backend_EPoll(VALUE Event_Backend) {
-	id_fileno = rb_intern("fileno");
-	id_transfer = rb_intern("transfer");
-	
-	Event_Backend_EPoll = rb_define_class_under(Event_Backend, "EPoll", rb_cObject);
-	
-	rb_define_alloc_func(Event_Backend_EPoll, Event_Backend_EPoll_allocate);
-	rb_define_method(Event_Backend_EPoll, "initialize", Event_Backend_EPoll_initialize, 1);
-	rb_define_method(Event_Backend_EPoll, "close", Event_Backend_EPoll_close, 0);
-	
-	rb_define_method(Event_Backend_EPoll, "io_wait", Event_Backend_EPoll_io_wait, 3);
-	rb_define_method(Event_Backend_EPoll, "select", Event_Backend_EPoll_select, 1);
-}