diff options
Diffstat (limited to 'ext/io/wait')
-rw-r--r-- | ext/io/wait/depend | 5 | ||||
-rw-r--r-- | ext/io/wait/extconf.rb | 33 | ||||
-rw-r--r-- | ext/io/wait/io-wait.gemspec | 23 | ||||
-rw-r--r-- | ext/io/wait/wait.c | 223 |
4 files changed, 175 insertions, 109 deletions
diff --git a/ext/io/wait/depend b/ext/io/wait/depend index 0426a6a1ed..70317b1497 100644 --- a/ext/io/wait/depend +++ b/ext/io/wait/depend @@ -16,6 +16,7 @@ wait.o: $(hdrdir)/ruby/backward/2/stdarg.h wait.o: $(hdrdir)/ruby/defines.h wait.o: $(hdrdir)/ruby/encoding.h wait.o: $(hdrdir)/ruby/intern.h +wait.o: $(hdrdir)/ruby/internal/abi.h wait.o: $(hdrdir)/ruby/internal/anyargs.h wait.o: $(hdrdir)/ruby/internal/arithmetic.h wait.o: $(hdrdir)/ruby/internal/arithmetic/char.h @@ -53,6 +54,7 @@ wait.o: $(hdrdir)/ruby/internal/attr/noexcept.h wait.o: $(hdrdir)/ruby/internal/attr/noinline.h wait.o: $(hdrdir)/ruby/internal/attr/nonnull.h wait.o: $(hdrdir)/ruby/internal/attr/noreturn.h +wait.o: $(hdrdir)/ruby/internal/attr/packed_struct.h wait.o: $(hdrdir)/ruby/internal/attr/pure.h wait.o: $(hdrdir)/ruby/internal/attr/restrict.h wait.o: $(hdrdir)/ruby/internal/attr/returns_nonnull.h @@ -121,7 +123,6 @@ wait.o: $(hdrdir)/ruby/internal/intern/enumerator.h wait.o: $(hdrdir)/ruby/internal/intern/error.h wait.o: $(hdrdir)/ruby/internal/intern/eval.h wait.o: $(hdrdir)/ruby/internal/intern/file.h -wait.o: $(hdrdir)/ruby/internal/intern/gc.h wait.o: $(hdrdir)/ruby/internal/intern/hash.h wait.o: $(hdrdir)/ruby/internal/intern/io.h wait.o: $(hdrdir)/ruby/internal/intern/load.h @@ -152,12 +153,12 @@ wait.o: $(hdrdir)/ruby/internal/memory.h wait.o: $(hdrdir)/ruby/internal/method.h wait.o: $(hdrdir)/ruby/internal/module.h wait.o: $(hdrdir)/ruby/internal/newobj.h -wait.o: $(hdrdir)/ruby/internal/rgengc.h wait.o: $(hdrdir)/ruby/internal/scan_args.h wait.o: $(hdrdir)/ruby/internal/special_consts.h wait.o: $(hdrdir)/ruby/internal/static_assert.h wait.o: $(hdrdir)/ruby/internal/stdalign.h wait.o: $(hdrdir)/ruby/internal/stdbool.h +wait.o: $(hdrdir)/ruby/internal/stdckdint.h wait.o: $(hdrdir)/ruby/internal/symbol.h wait.o: $(hdrdir)/ruby/internal/value.h wait.o: $(hdrdir)/ruby/internal/value_type.h diff --git a/ext/io/wait/extconf.rb b/ext/io/wait/extconf.rb index d20ff4553f..e63c046187 100644 --- a/ext/io/wait/extconf.rb +++ b/ext/io/wait/extconf.rb @@ -1,20 +1,25 @@ # frozen_string_literal: false require 'mkmf' -target = "io/wait" -have_func("rb_io_wait") -unless macro_defined?("DOSISH", "#include <ruby.h>") - have_header(ioctl_h = "sys/ioctl.h") or ioctl_h = nil - fionread = %w[sys/ioctl.h sys/filio.h sys/socket.h].find do |h| - have_macro("FIONREAD", [h, ioctl_h].compact) - end - if fionread - $defs << "-DFIONREAD_HEADER=\"<#{fionread}>\"" - create_makefile(target) - end +if RUBY_VERSION < "2.6" + File.write("Makefile", dummy_makefile($srcdir).join("")) else - if have_func("rb_w32_ioctlsocket", "ruby.h") - have_func("rb_w32_is_socket", "ruby.h") - create_makefile(target) + target = "io/wait" + have_func("rb_io_wait") + have_func("rb_io_descriptor") + unless macro_defined?("DOSISH", "#include <ruby.h>") + have_header(ioctl_h = "sys/ioctl.h") or ioctl_h = nil + fionread = %w[sys/ioctl.h sys/filio.h sys/socket.h].find do |h| + have_macro("FIONREAD", [h, ioctl_h].compact) + end + if fionread + $defs << "-DFIONREAD_HEADER=\"<#{fionread}>\"" + create_makefile(target) + end + else + if have_func("rb_w32_ioctlsocket", "ruby.h") + have_func("rb_w32_is_socket", "ruby.h") + create_makefile(target) + end end end diff --git a/ext/io/wait/io-wait.gemspec b/ext/io/wait/io-wait.gemspec index 5150f14848..e850e10bf9 100644 --- a/ext/io/wait/io-wait.gemspec +++ b/ext/io/wait/io-wait.gemspec @@ -1,27 +1,38 @@ -_VERSION = "0.2.0" +_VERSION = "0.3.1" Gem::Specification.new do |spec| spec.name = "io-wait" spec.version = _VERSION - spec.authors = ["Nobu Nakada"] - spec.email = ["nobu@ruby-lang.org"] + spec.authors = ["Nobu Nakada", "Charles Oliver Nutter"] + spec.email = ["nobu@ruby-lang.org", "headius@headius.com"] spec.summary = %q{Waits until IO is readable or writable without blocking.} spec.description = %q{Waits until IO is readable or writable without blocking.} spec.homepage = "https://github.com/ruby/io-wait" spec.licenses = ["Ruby", "BSD-2-Clause"] - spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0") spec.metadata["homepage_uri"] = spec.homepage spec.metadata["source_code_uri"] = spec.homepage spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do `git ls-files -z`.split("\x0").reject do |f| - f.match(%r{\A(?:test|spec|features)/|\A\.(?:git|travis)}) + File.identical?(f, __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|rakelib)/|\.(?:git|travis|circleci)|appveyor|Rakefile)}) end end - spec.extensions = %w[ext/io/wait/extconf.rb] spec.bindir = "exe" spec.executables = [] spec.require_paths = ["lib"] + + jruby = true if Gem::Platform.new('java') =~ spec.platform or RUBY_ENGINE == 'jruby' + spec.files.delete_if do |f| + f.end_with?(".java") or + f.start_with?("ext/") && (jruby ^ f.start_with?("ext/java/")) + end + if jruby + spec.platform = 'java' + spec.files << "lib/io/wait.jar" + spec.require_paths += ["ext/java/lib"] + else + spec.extensions = %w[ext/io/wait/extconf.rb] + end end diff --git a/ext/io/wait/wait.c b/ext/io/wait/wait.c index 8f0d16e168..8835670e59 100644 --- a/ext/io/wait/wait.c +++ b/ext/io/wait/wait.c @@ -41,22 +41,17 @@ #endif #ifndef HAVE_RB_IO_WAIT -static VALUE io_ready_p _((VALUE io)); -static VALUE io_wait_readable _((int argc, VALUE *argv, VALUE io)); -static VALUE io_wait_writable _((int argc, VALUE *argv, VALUE io)); -void Init_wait _((void)); - static struct timeval * get_timeout(int argc, VALUE *argv, struct timeval *timerec) { VALUE timeout = Qnil; rb_check_arity(argc, 0, 1); if (!argc || NIL_P(timeout = argv[0])) { - return NULL; + return NULL; } else { - *timerec = rb_time_interval(timeout); - return timerec; + *timerec = rb_time_interval(timeout); + return timerec; } } @@ -65,7 +60,7 @@ wait_for_single_fd(rb_io_t *fptr, int events, struct timeval *tv) { int i = rb_wait_for_single_fd(fptr->fd, events, tv); if (i < 0) - rb_sys_fail(0); + rb_sys_fail(0); rb_io_check_closed(fptr); return (i & events); } @@ -77,6 +72,8 @@ wait_for_single_fd(rb_io_t *fptr, int events, struct timeval *tv) * * Returns number of bytes that can be read without blocking. * Returns zero if no information available. + * + * You must require 'io/wait' to use this method. */ static VALUE @@ -90,38 +87,51 @@ io_nread(VALUE io) rb_io_check_readable(fptr); len = rb_io_read_pending(fptr); if (len > 0) return INT2FIX(len); - if (!FIONREAD_POSSIBLE_P(fptr->fd)) return INT2FIX(0); - if (ioctl(fptr->fd, FIONREAD, &n)) return INT2FIX(0); + +#ifdef HAVE_RB_IO_DESCRIPTOR + int fd = rb_io_descriptor(io); +#else + int fd = fptr->fd; +#endif + + if (!FIONREAD_POSSIBLE_P(fd)) return INT2FIX(0); + if (ioctl(fd, FIONREAD, &n)) return INT2FIX(0); if (n > 0) return ioctl_arg2num(n); return INT2FIX(0); } #ifdef HAVE_RB_IO_WAIT static VALUE -io_wait_event(VALUE io, int event, VALUE timeout) +io_wait_event(VALUE io, int event, VALUE timeout, int return_io) { VALUE result = rb_io_wait(io, RB_INT2NUM(event), timeout); if (!RB_TEST(result)) { - return Qnil; + return Qnil; } int mask = RB_NUM2INT(result); if (mask & event) { - return io; + if (return_io) + return io; + else + return result; } else { - return Qfalse; + return Qfalse; } } #endif /* * call-seq: - * io.ready? -> true or false + * io.ready? -> truthy or falsy * - * Returns +true+ if input available without blocking, or +false+. + * Returns a truthy value if input available without blocking, or a + * falsy value. + * + * You must require 'io/wait' to use this method. */ static VALUE @@ -137,23 +147,25 @@ io_ready_p(VALUE io) if (rb_io_read_pending(fptr)) return Qtrue; #ifndef HAVE_RB_IO_WAIT - if (wait_for_single_fd(fptr, RB_WAITFD_IN, &tv)) - return Qtrue; + return wait_for_single_fd(fptr, RB_WAITFD_IN, &tv) ? Qtrue : Qfalse; #else - if (RTEST(io_wait_event(io, RUBY_IO_READABLE, RB_INT2NUM(0)))) - return Qtrue; + return io_wait_event(io, RUBY_IO_READABLE, RB_INT2NUM(0), 1); #endif - return Qfalse; } +/* Ruby 3.2+ can define these methods. This macro indicates that case. */ +#ifndef RUBY_IO_WAIT_METHODS + /* * call-seq: - * io.wait_readable -> true or false - * io.wait_readable(timeout) -> true or false + * io.wait_readable -> truthy or falsy + * io.wait_readable(timeout) -> truthy or falsy + * + * Waits until IO is readable and returns a truthy value, or a falsy + * value when times out. Returns a truthy value immediately when + * buffered data is available. * - * Waits until IO is readable and returns +true+, or - * +false+ when times out. - * Returns +true+ immediately when buffered data is available. + * You must require 'io/wait' to use this method. */ static VALUE @@ -175,24 +187,26 @@ io_wait_readable(int argc, VALUE *argv, VALUE io) #ifndef HAVE_RB_IO_WAIT if (wait_for_single_fd(fptr, RB_WAITFD_IN, tv)) { - return io; + return io; } return Qnil; #else rb_check_arity(argc, 0, 1); VALUE timeout = (argc == 1 ? argv[0] : Qnil); - return io_wait_event(io, RUBY_IO_READABLE, timeout); + return io_wait_event(io, RUBY_IO_READABLE, timeout, 1); #endif } /* * call-seq: - * io.wait_writable -> true or false - * io.wait_writable(timeout) -> true or false + * io.wait_writable -> truthy or falsy + * io.wait_writable(timeout) -> truthy or falsy * - * Waits until IO is writable and returns +true+ or - * +false+ when times out. + * Waits until IO is writable and returns a truthy value or a falsy + * value when times out. + * + * You must require 'io/wait' to use this method. */ static VALUE io_wait_writable(int argc, VALUE *argv, VALUE io) @@ -209,25 +223,28 @@ io_wait_writable(int argc, VALUE *argv, VALUE io) #ifndef HAVE_RB_IO_WAIT tv = get_timeout(argc, argv, &timerec); if (wait_for_single_fd(fptr, RB_WAITFD_OUT, tv)) { - return io; + return io; } return Qnil; #else rb_check_arity(argc, 0, 1); VALUE timeout = (argc == 1 ? argv[0] : Qnil); - return io_wait_event(io, RUBY_IO_WRITABLE, timeout); + return io_wait_event(io, RUBY_IO_WRITABLE, timeout, 1); #endif } #ifdef HAVE_RB_IO_WAIT /* * call-seq: - * io.wait_priority -> true or false - * io.wait_priority(timeout) -> true or false + * io.wait_priority -> truthy or falsy + * io.wait_priority(timeout) -> truthy or falsy + * + * Waits until IO is priority and returns a truthy value or a falsy + * value when times out. Priority data is sent and received using + * the Socket::MSG_OOB flag and is typically limited to streams. * - * Waits until IO is priority and returns +true+ or - * +false+ when times out. + * You must require 'io/wait' to use this method. */ static VALUE io_wait_priority(int argc, VALUE *argv, VALUE io) @@ -242,7 +259,7 @@ io_wait_priority(int argc, VALUE *argv, VALUE io) rb_check_arity(argc, 0, 1); VALUE timeout = argc == 1 ? argv[0] : Qnil; - return io_wait_event(io, RUBY_IO_PRIORITY, timeout); + return io_wait_event(io, RUBY_IO_PRIORITY, timeout, 1); } #endif @@ -250,51 +267,65 @@ static int wait_mode_sym(VALUE mode) { if (mode == ID2SYM(rb_intern("r"))) { - return RB_WAITFD_IN; + return RB_WAITFD_IN; } if (mode == ID2SYM(rb_intern("read"))) { - return RB_WAITFD_IN; + return RB_WAITFD_IN; } if (mode == ID2SYM(rb_intern("readable"))) { - return RB_WAITFD_IN; + return RB_WAITFD_IN; } if (mode == ID2SYM(rb_intern("w"))) { - return RB_WAITFD_OUT; + return RB_WAITFD_OUT; } if (mode == ID2SYM(rb_intern("write"))) { - return RB_WAITFD_OUT; + return RB_WAITFD_OUT; } if (mode == ID2SYM(rb_intern("writable"))) { - return RB_WAITFD_OUT; + return RB_WAITFD_OUT; } if (mode == ID2SYM(rb_intern("rw"))) { - return RB_WAITFD_IN|RB_WAITFD_OUT; + return RB_WAITFD_IN|RB_WAITFD_OUT; } if (mode == ID2SYM(rb_intern("read_write"))) { - return RB_WAITFD_IN|RB_WAITFD_OUT; + return RB_WAITFD_IN|RB_WAITFD_OUT; } if (mode == ID2SYM(rb_intern("readable_writable"))) { - return RB_WAITFD_IN|RB_WAITFD_OUT; + return RB_WAITFD_IN|RB_WAITFD_OUT; } rb_raise(rb_eArgError, "unsupported mode: %"PRIsVALUE, mode); return 0; } +#ifdef HAVE_RB_IO_WAIT +static inline rb_io_event_t +io_event_from_value(VALUE value) +{ + int events = RB_NUM2INT(value); + + if (events <= 0) rb_raise(rb_eArgError, "Events must be positive integer!"); + + return events; +} +#endif + /* * call-seq: - * io.wait(events, timeout) -> event mask or false. - * io.wait(timeout = nil, mode = :read) -> event mask or false. + * io.wait(events, timeout) -> event mask, false or nil + * io.wait(timeout = nil, mode = :read) -> self, true, or false * * Waits until the IO becomes ready for the specified events and returns the - * subset of events that become ready, or +false+ when times out. + * subset of events that become ready, or a falsy value when times out. * * The events can be a bit mask of +IO::READABLE+, +IO::WRITABLE+ or * +IO::PRIORITY+. * - * Returns +true+ immediately when buffered data is available. + * Returns a truthy value immediately when buffered data is available. * * Optional parameter +mode+ is one of +:read+, +:write+, or * +:read_write+. + * + * You must require 'io/wait' to use this method. */ static VALUE @@ -309,61 +340,77 @@ io_wait(int argc, VALUE *argv, VALUE io) GetOpenFile(io, fptr); for (i = 0; i < argc; ++i) { - if (SYMBOL_P(argv[i])) { - event |= wait_mode_sym(argv[i]); - } - else { - *(tv = &timerec) = rb_time_interval(argv[i]); - } + if (SYMBOL_P(argv[i])) { + event |= wait_mode_sym(argv[i]); + } + else { + *(tv = &timerec) = rb_time_interval(argv[i]); + } } /* rb_time_interval() and might_mode() might convert the argument */ rb_io_check_closed(fptr); if (!event) event = RB_WAITFD_IN; if ((event & RB_WAITFD_IN) && rb_io_read_pending(fptr)) - return Qtrue; + return Qtrue; if (wait_for_single_fd(fptr, event, tv)) - return io; + return io; return Qnil; #else VALUE timeout = Qundef; rb_io_event_t events = 0; + int i, return_io = 0; + /* The documented signature for this method is actually incorrect. + * A single timeout is allowed in any position, and multiple symbols can be given. + * Whether this is intentional or not, I don't know, and as such I consider this to + * be a legacy/slow path. */ if (argc != 2 || (RB_SYMBOL_P(argv[0]) || RB_SYMBOL_P(argv[1]))) { - for (int i = 0; i < argc; i += 1) { - if (RB_SYMBOL_P(argv[i])) { - events |= wait_mode_sym(argv[i]); - } - else if (timeout == Qundef) { - rb_time_interval(timeout = argv[i]); - } - else { - rb_raise(rb_eArgError, "timeout given more than once"); - } - } - if (timeout == Qundef) timeout = Qnil; - } - else /* argc == 2 */ { - events = RB_NUM2UINT(argv[0]); - timeout = argv[1]; + /* We'd prefer to return the actual mask, but this form would return the io itself: */ + return_io = 1; + + /* Slow/messy path: */ + for (i = 0; i < argc; i += 1) { + if (RB_SYMBOL_P(argv[i])) { + events |= wait_mode_sym(argv[i]); + } + else if (timeout == Qundef) { + rb_time_interval(timeout = argv[i]); + } + else { + rb_raise(rb_eArgError, "timeout given more than once"); + } + } + + if (timeout == Qundef) timeout = Qnil; + + if (events == 0) { + events = RUBY_IO_READABLE; + } } - - if (events == 0) { - events = RUBY_IO_READABLE; + else /* argc == 2 and neither are symbols */ { + /* This is the fast path: */ + events = io_event_from_value(argv[0]); + timeout = argv[1]; } if (events & RUBY_IO_READABLE) { - rb_io_t *fptr = NULL; - RB_IO_POINTER(io, fptr); - - if (rb_io_read_pending(fptr)) { - return Qtrue; - } + rb_io_t *fptr = NULL; + RB_IO_POINTER(io, fptr); + + if (rb_io_read_pending(fptr)) { + /* This was the original behaviour: */ + if (return_io) return Qtrue; + /* New behaviour always returns an event mask: */ + else return RB_INT2NUM(RUBY_IO_READABLE); + } } - return io_wait_event(io, events, timeout); + return io_wait_event(io, events, timeout, return_io); #endif } +#endif /* RUBY_IO_WAIT_METHODS */ + /* * IO wait methods */ @@ -378,6 +425,7 @@ Init_wait(void) rb_define_method(rb_cIO, "nread", io_nread, 0); rb_define_method(rb_cIO, "ready?", io_ready_p, 0); +#ifndef RUBY_IO_WAIT_METHODS rb_define_method(rb_cIO, "wait", io_wait, -1); rb_define_method(rb_cIO, "wait_readable", io_wait_readable, -1); @@ -385,4 +433,5 @@ Init_wait(void) #ifdef HAVE_RB_IO_WAIT rb_define_method(rb_cIO, "wait_priority", io_wait_priority, -1); #endif +#endif } |