ruby-changes:73994
From: Samuel <ko1@a...>
Date: Sat, 15 Oct 2022 15:59:22 +0900 (JST)
Subject: [ruby-changes:73994] 8a420670a2 (master): Introduce `Fiber::Scheduler#io_select` hook for non-blocking `IO.select`. (#6559)
https://git.ruby-lang.org/ruby.git/commit/?id=8a420670a2 From 8a420670a29a7c78c7201f678eb26528621bf39f Mon Sep 17 00:00:00 2001 From: Samuel Williams <samuel.williams@o...> Date: Sat, 15 Oct 2022 19:59:04 +1300 Subject: Introduce `Fiber::Scheduler#io_select` hook for non-blocking `IO.select`. (#6559) --- NEWS.md | 4 ++++ include/ruby/fiber/scheduler.h | 22 +++++++++++++++++++++- io.c | 9 +++++++++ scheduler.c | 21 +++++++++++++++++++++ test/fiber/scheduler.rb | 7 +++++++ test/fiber/test_io.rb | 22 ++++++++++++++++++++++ 6 files changed, 84 insertions(+), 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index a355d91d7d..730462d85d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -102,6 +102,9 @@ Note that each entry is kept to a minimum, see links for details. https://github.com/ruby/ruby/blob/trunk/NEWS.md#L102 Note: We're only listing outstanding class updates. +* Fiber::Scheduler + * Introduce `Fiber::Scheduler#io_select` for non-blocking `IO.select`. [[Feature #19060]] + * IO * Introduce `IO#timeout=` and `IO#timeout` which can cause `IO::TimeoutError` to be raised if a blocking operation exceeds the @@ -354,3 +357,4 @@ The following deprecated APIs are removed. https://github.com/ruby/ruby/blob/trunk/NEWS.md#L357 [Feature #16122]: https://bugs.ruby-lang.org/issues/16122 [Feature #18630]: https://bugs.ruby-lang.org/issues/18630 [Feature #18589]: https://bugs.ruby-lang.org/issues/18589 +[Feature #19060]: https://bugs.ruby-lang.org/issues/19060 diff --git a/include/ruby/fiber/scheduler.h b/include/ruby/fiber/scheduler.h index 37985e1285..d6a033d322 100644 --- a/include/ruby/fiber/scheduler.h +++ b/include/ruby/fiber/scheduler.h @@ -244,7 +244,27 @@ VALUE rb_fiber_scheduler_io_wait_readable(VALUE scheduler, VALUE io); https://github.com/ruby/ruby/blob/trunk/include/ruby/fiber/scheduler.h#L244 VALUE rb_fiber_scheduler_io_wait_writable(VALUE scheduler, VALUE io); /** - * Nonblocking read from the passed IO. + * Non-blocking version of `IO.select`. + * + * It's possible that this will be emulated using a thread, so you should not + * rely on it for high performance. + * + * @param[in] scheduler Target scheduler. + * @param[in] readables An array of readable objects. + * @param[in] writables An array of writable objects. + * @param[in] exceptables An array of objects that might encounter exceptional conditions. + * @param[in] timeout Numeric timeout or nil. + * @return What `scheduler.io_select` returns, normally a 3-tuple of arrays of ready objects. + */ +VALUE rb_fiber_scheduler_io_select(VALUE scheduler, VALUE readables, VALUE writables, VALUE exceptables, VALUE timeout); + +/** + * Non-blocking version of `IO.select`, `argv` variant. + */ +VALUE rb_fiber_scheduler_io_selectv(VALUE scheduler, int argc, VALUE *argv); + +/** + * Non-blocking read from the passed IO. * * @param[in] scheduler Target scheduler. * @param[out] io An io object to read from. diff --git a/io.c b/io.c index 2fe092b84e..a1b3f27611 100644 --- a/io.c +++ b/io.c @@ -10851,6 +10851,15 @@ rb_io_advise(int argc, VALUE *argv, VALUE io) https://github.com/ruby/ruby/blob/trunk/io.c#L10851 static VALUE rb_f_select(int argc, VALUE *argv, VALUE obj) { + VALUE scheduler = rb_fiber_scheduler_current(); + if (scheduler != Qnil) { + // It's optionally supported. + VALUE result = rb_fiber_scheduler_io_selectv(scheduler, argc, argv); + if (result != Qundef) { + return result; + } + } + VALUE timeout; struct select_args args; struct timeval timerec; diff --git a/scheduler.c b/scheduler.c index 785ad06f19..09fc921c88 100644 --- a/scheduler.c +++ b/scheduler.c @@ -28,6 +28,7 @@ static ID id_process_wait; https://github.com/ruby/ruby/blob/trunk/scheduler.c#L28 static ID id_io_read, id_io_pread; static ID id_io_write, id_io_pwrite; static ID id_io_wait; +static ID id_io_select; static ID id_io_close; static ID id_address_resolve; @@ -51,6 +52,7 @@ Init_Fiber_Scheduler(void) https://github.com/ruby/ruby/blob/trunk/scheduler.c#L52 id_io_pwrite = rb_intern_const("io_pwrite"); id_io_wait = rb_intern_const("io_wait"); + id_io_select = rb_intern_const("io_select"); id_io_close = rb_intern_const("io_close"); id_address_resolve = rb_intern_const("address_resolve"); @@ -231,6 +233,25 @@ rb_fiber_scheduler_io_wait_writable(VALUE scheduler, VALUE io) https://github.com/ruby/ruby/blob/trunk/scheduler.c#L233 return rb_fiber_scheduler_io_wait(scheduler, io, RB_UINT2NUM(RUBY_IO_WRITABLE), rb_io_timeout(io)); } +VALUE rb_fiber_scheduler_io_select(VALUE scheduler, VALUE readables, VALUE writables, VALUE exceptables, VALUE timeout) +{ + VALUE arguments[] = { + readables, writables, exceptables, timeout + }; + + return rb_fiber_scheduler_io_selectv(scheduler, 4, arguments); +} + +VALUE rb_fiber_scheduler_io_selectv(VALUE scheduler, int argc, VALUE *argv) +{ + // I wondered about extracting argv, and checking if there is only a single + // IO instance, and instead calling `io_wait`. However, it would require a + // decent amount of work and it would be hard to preserve the exact + // semantics of IO.select. + + return rb_check_funcall(scheduler, id_io_select, argc, argv); +} + VALUE rb_fiber_scheduler_io_read(VALUE scheduler, VALUE io, VALUE buffer, size_t length, size_t offset) { diff --git a/test/fiber/scheduler.rb b/test/fiber/scheduler.rb index 322564fe6d..3fd41ef6f1 100644 --- a/test/fiber/scheduler.rb +++ b/test/fiber/scheduler.rb @@ -197,6 +197,13 @@ class Scheduler https://github.com/ruby/ruby/blob/trunk/test/fiber/scheduler.rb#L197 @writable.delete(io) end + def io_select(...) + # Emulate the operation using a non-blocking thread: + Thread.new do + IO.select(...) + end.value + end + # Used for Kernel#sleep and Thread::Mutex#sleep def kernel_sleep(duration = nil) # $stderr.puts [__method__, duration, Fiber.current].inspect diff --git a/test/fiber/test_io.rb b/test/fiber/test_io.rb index 4252641cde..821a169e44 100644 --- a/test/fiber/test_io.rb +++ b/test/fiber/test_io.rb @@ -172,4 +172,26 @@ class TestFiberIO < Test::Unit::TestCase https://github.com/ruby/ruby/blob/trunk/test/fiber/test_io.rb#L172 assert_predicate(i, :closed?) assert_predicate(o, :closed?) end + + def test_io_select + omit "UNIXSocket is not defined!" unless defined?(UNIXSocket) + + UNIXSocket.pair do |r, w| + result = nil + + thread = Thread.new do + scheduler = Scheduler.new + Fiber.set_scheduler scheduler + + Fiber.schedule do + w.write("Hello World") + result = IO.select([r], [w]) + end + end + + thread.join + + assert_equal [[r], [w], []], result + end + end end -- cgit v1.2.1 -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/