polyphony 1.0.2 → 1.1.1

data/ext/polyphony/backend_libev.c

@@ -277,10 +277,10 @@ static inline int fd_from_io(VALUE io, rb_io_t **fptr, int write_mode, int recti
     if (underlying_io != Qnil) io = underlying_io;
 
     GetOpenFile(io, *fptr);
-    io_verify_blocking_mode(*fptr, io, Qfalse);
+    int fd = rb_io_descriptor(io);
+    io_verify_blocking_mode(io, fd, Qfalse);
     if (rectify_file_pos) rectify_io_file_pos(*fptr);
-
-    return (*fptr)->fd;
+    return fd;
   }
 }
 
@@ -681,7 +681,7 @@ VALUE Backend_accept(VALUE self, VALUE server_socket, VALUE socket_class) {
       fp->fd = fd;
       fp->mode = FMODE_READWRITE | FMODE_DUPLEX;
       rb_io_ascii8bit_binmode(socket);
-      io_verify_blocking_mode(fp, socket, Qfalse);
+      io_verify_blocking_mode(socket, fd, Qfalse);
       rb_io_synchronized(fp);
 
       // if (rsock_do_not_reverse_lookup) {
@@ -736,7 +736,7 @@ VALUE Backend_accept_loop(VALUE self, VALUE server_socket, VALUE socket_class) {
       fp->fd = fd;
       fp->mode = FMODE_READWRITE | FMODE_DUPLEX;
       rb_io_ascii8bit_binmode(socket);
-      io_verify_blocking_mode(fp, socket, Qfalse);
+      io_verify_blocking_mode(socket, fd, Qfalse);
       rb_io_synchronized(fp);
 
       rb_yield(socket);

data/ext/polyphony/extconf.rb

@@ -98,4 +98,10 @@ end
 
 have_header('ruby/io/buffer.h')
 
+have_func('rb_io_path')
+have_func('rb_io_descriptor')
+have_func('rb_io_get_write_io')
+have_func('rb_io_closed_p')
+have_func('rb_io_open_descriptor')
+
 create_makefile 'polyphony_ext'

data/ext/polyphony/fiber.c

@@ -1,3 +1,4 @@
+#include <stdnoreturn.h>
 #include "polyphony.h"
 
 ID ID_ivar_auto_watcher;
@@ -129,7 +130,7 @@ VALUE Fiber_send(VALUE self, VALUE msg) {
   return self;
 }
 
-/* Receive's a message from the fiber's mailbox. If no message is available,
+/* Receives a message from the fiber's mailbox. If no message is available,
  * waits for a message to be sent to it.
  *
  * @return [any] received message
@@ -144,6 +145,24 @@ VALUE Fiber_receive(VALUE self) {
   return Queue_shift(0, 0, mailbox);
 }
 
+/* Receives messages from the fiber's mailbox in an infinite loop.
+ *
+ */
+
+noreturn VALUE Fiber_receive_loop(VALUE self) {
+  VALUE mailbox = rb_ivar_get(self, ID_ivar_mailbox);
+  if (mailbox == Qnil) {
+    mailbox = rb_funcall(cQueue, ID_new, 0);
+    rb_ivar_set(self, ID_ivar_mailbox, mailbox);
+  }
+
+  while (1) {
+    VALUE msg = Queue_shift(0, 0,mailbox);
+    rb_yield(msg);
+    RB_GC_GUARD(msg);
+  }
+}
+
 /* Returns the fiber's mailbox.
  *
  * @return [Queue]
@@ -201,6 +220,7 @@ void Init_Fiber(void) {
   rb_define_method(cFiber, "<<", Fiber_send, 1);
   rb_define_method(cFiber, "send", Fiber_send, 1);
   rb_define_method(cFiber, "receive", Fiber_receive, 0);
+  rb_define_method(cFiber, "receive_loop", Fiber_receive_loop, 0);
   rb_define_method(cFiber, "receive_all_pending", Fiber_receive_all_pending, 0);
   rb_define_method(cFiber, "mailbox", Fiber_mailbox, 0);
 

data/lib/polyphony/extensions/io.rb

@@ -7,7 +7,7 @@ class ::IO
   class << self
     # @!visibility private
     alias_method :orig_binread, :binread
-    
+
     # @!visibility private
     def binread(name, length = nil, offset = nil)
       File.open(name, 'rb:ASCII-8BIT') do |f|
@@ -15,10 +15,10 @@ class ::IO
         length ? f.read(length) : f.read
       end
     end
-    
+
     # @!visibility private
     alias_method :orig_binwrite, :binwrite
-    
+
     # @!visibility private
     def binwrite(name, string, offset = nil)
       File.open(name, 'wb:ASCII-8BIT') do |f|
@@ -26,13 +26,13 @@ class ::IO
         f.write(string)
       end
     end
-    
+
     # @!visibility private
     EMPTY_HASH = {}.freeze
-    
+
     # @!visibility private
     alias_method :orig_foreach, :foreach
-    
+
     # @!visibility private
     def foreach(name, sep = $/, limit = nil, getline_args = EMPTY_HASH, &block)
       if sep.is_a?(Integer)
@@ -43,10 +43,10 @@ class ::IO
         f.each_line(sep, limit, chomp: getline_args[:chomp], &block)
       end
     end
-    
+
     # @!visibility private
     alias_method :orig_read, :read
-    
+
     # @!visibility private
     def read(name, length = nil, offset = nil, opt = EMPTY_HASH)
       if length.is_a?(Hash)
@@ -58,17 +58,17 @@ class ::IO
         length ? f.read(length) : f.read
       end
     end
-    
+
     # alias_method :orig_readlines, :readlines
     # def readlines(name, sep = $/, limit = nil, getline_args = EMPTY_HASH)
     #   File.open(name, 'r') do |f|
     #     f.readlines(sep, limit, getline_args)
     #   end
     # end
-    
+
     # @!visibility private
     alias_method :orig_write, :write
-    
+
     # @!visibility private
     def write(name, string, offset = nil, opt = EMPTY_HASH)
       File.open(name, opt[:mode] || 'w') do |f|
@@ -76,18 +76,18 @@ class ::IO
         f.write(string)
       end
     end
-    
+
     # @!visibility private
     alias_method :orig_popen, :popen
-    
-    
+
+
     # @!visibility private
     def popen(cmd, mode = 'r')
       return orig_popen(cmd, mode) unless block_given?
-      
+
       Open3.popen2(cmd) { |_i, o, _t| yield o }
     end
-    
+
     # Splices from one IO to another IO. At least one of the IOs must be a pipe.
     # If maxlen is negative, splices repeatedly using absolute value of maxlen
     # until EOF is encountered.
@@ -99,9 +99,9 @@ class ::IO
     def splice(src, dest, maxlen)
       Polyphony.backend_splice(src, dest, maxlen)
     end
-    
-    # Creates a pipe and splices data between the two given IOs using the
-    # pipe, splicing until EOF.
+
+    # Creates a pipe and splices data between the two given IOs, using the pipe,
+    # splicing until EOF.
     #
     # @param src [IO, Polyphony::Pipe] source to splice from
     # @param dest [IO, Polyphony::Pipe] destination to splice to
@@ -109,7 +109,7 @@ class ::IO
     def double_splice(src, dest)
       Polyphony.backend_double_splice(src, dest)
     end
-    
+
     # Tees data from the source to the desination.
     #
     # @param src [IO, Polyphony::Pipe] source to tee from
@@ -125,7 +125,7 @@ class ::IO
       def double_splice(src, dest)
         raise NotImplementedError
       end
-      
+
       # @!visibility private
       def tee(src, dest, maxlen)
         raise NotImplementedError
@@ -140,51 +140,51 @@ class ::IO
   def __read_method__
     :backend_read
   end
-  
+
   # @!visibility private
   def __write_method__
     :backend_write
   end
-  
+
   # def each(sep = $/, limit = nil, chomp: nil)
   #   sep, limit = $/, sep if sep.is_a?(Integer)
   # end
   # alias_method :each_line, :each
-  
+
   # def each_byte
   # end
-  
+
   # def each_char
   # end
-  
+
   # def each_codepoint
   # end
-  
+
   # @!visibility private
   alias_method :orig_getbyte, :getbyte
-  
-  
+
+
   # @!visibility private
   def getbyte
     char = getc
-    char ? char.getbyte(0) : nil
+    char&.getbyte(0)
   end
-  
+
   # @!visibility private
   alias_method :orig_getc, :getc
-  
-  
+
+
   # @!visibility private
   def getc
     return @read_buffer.slice!(0) if @read_buffer && !@read_buffer.empty?
-    
+
     @read_buffer ||= +''
     Polyphony.backend_read(self, @read_buffer, 8192, false, -1)
     return @read_buffer.slice!(0) if !@read_buffer.empty?
-    
+
     nil
   end
-  
+
   # @!visibility private
   def ungetc(c)
     c = c.chr if c.is_a?(Integer)
@@ -195,59 +195,59 @@ class ::IO
     end
   end
   alias_method :ungetbyte, :ungetc
-  
+
   # @!visibility private
   alias_method :orig_read, :read
-  
-  
+
+
   # @!visibility private
   def read(len = nil, buf = nil, buf_pos = 0)
     return '' if len == 0
-    
+
     if buf
       return Polyphony.backend_read(self, buf, len, true, buf_pos)
     end
-    
+
     @read_buffer ||= +''
     result = Polyphony.backend_read(self, @read_buffer, len, true, -1)
     return nil unless result
-    
+
     already_read = @read_buffer
     @read_buffer = +''
     already_read
   end
-  
+
   # @!visibility private
   alias_method :orig_readpartial, :read
-  
+
   # @!visibility private
   def readpartial(len, str = +'', buffer_pos = 0, raise_on_eof = true)
     result = Polyphony.backend_read(self, str, len, false, buffer_pos)
     raise EOFError if !result && raise_on_eof
-    
+
     result
   end
-  
+
   # @!visibility private
   alias_method :orig_write, :write
-  
+
   # @!visibility private
   def write(str, *args)
     Polyphony.backend_write(self, str, *args)
   end
-  
+
   # @!visibility private
   alias_method :orig_write_chevron, :<<
-  
+
   # @!visibility private
   def <<(str)
     Polyphony.backend_write(self, str)
     self
   end
-  
+
   # @!visibility private
   alias_method :orig_gets, :gets
-  
+
   # @!visibility private
   def gets(sep = $/, _limit = nil, _chomp: nil)
     if sep.is_a?(Integer)
@@ -255,20 +255,20 @@ class ::IO
       _limit = sep
     end
     sep_size = sep.bytesize
-    
+
     @read_buffer ||= +''
-    
+
     while true
       idx = @read_buffer.index(sep)
       return @read_buffer.slice!(0, idx + sep_size) if idx
-      
+
       result = readpartial(8192, @read_buffer, -1)
       return nil unless result
     end
   rescue EOFError
     return nil
   end
-  
+
   # @!visibility private
   def each_line(sep = $/, limit = nil, chomp: false)
     if sep.is_a?(Integer)
@@ -276,48 +276,48 @@ class ::IO
       sep = $/
     end
     sep_size = sep.bytesize
-    
-    
+
+
     @read_buffer ||= +''
-    
+
     while true
       while (idx = @read_buffer.index(sep))
         line = @read_buffer.slice!(0, idx + sep_size)
         line = line.chomp if chomp
         yield line
       end
-      
+
       result = readpartial(8192, @read_buffer, -1)
       return self if !result
     end
   rescue EOFError
     return self
   end
-  
+
   # def print(*args)
   # end
-  
+
   # def printf(format, *args)
   # end
-  
+
   # def putc(obj)
   # end
-  
+
   # @!visibility private
   LINEFEED = "\n"
   # @!visibility private
   LINEFEED_RE = /\n$/.freeze
-  
+
   # @!visibility private
   alias_method :orig_puts, :puts
-  
+
   # @!visibility private
   def puts(*args)
     if args.empty?
       write LINEFEED
       return
     end
-    
+
     idx = 0
     while idx < args.size
       arg = args[idx]
@@ -329,26 +329,26 @@ class ::IO
         idx += 2
       end
     end
-    
+
     write(*args)
     nil
   end
-  
+
   # def readbyte
   # end
-  
+
   # def readchar
   # end
-  
+
   # def readline(sep = $/, limit = nil, chomp: nil)
   # end
-  
+
   # def readlines(sep = $/, limit = nil, chomp: nil)
   # end
-  
+
   # @!visibility private
   alias_method :orig_write_nonblock, :write_nonblock
-  
+
   # @!visibility private
   def write_nonblock(string, _options = {})
   write(string)
@@ -396,7 +396,7 @@ end
 # @return [IO] self
 def wait_readable(timeout = nil)
   return self if @read_buffer && @read_buffer.size > 0
-  
+
   if timeout
     move_on_after(timeout) do
       Polyphony.backend_wait_io(self, false)

data/lib/polyphony/extensions/object.rb

@@ -171,6 +171,12 @@ class ::Object
     Fiber.current.receive
   end
 
+  # Receives messages in an infinite loop from the current fiber's mailbox,
+  # passing them to the given block.
+  def receive_loop(&block)
+    Fiber.current.receive_loop(&block)
+  end
+
   # Returns all messages currently pending on the current fiber's mailbox.
   #
   # @return [Array] array of received messages

data/lib/polyphony/extensions/socket.rb

@@ -75,15 +75,15 @@ class ::Socket < ::BasicSocket
   # @return [String] buffer used for reading
   def read(len = nil, buf = nil, buf_pos = 0)
     return '' if len == 0
-    
+
     if buf
       return Polyphony.backend_read(self, buf, len, true, buf_pos)
     end
-    
+
     @read_buffer ||= +''
     result = Polyphony.backend_read(self, @read_buffer, len, true, -1)
     return nil unless result
-    
+
     already_read = @read_buffer
     @read_buffer = +''
     already_read
@@ -339,15 +339,15 @@ class ::TCPSocket < ::IPSocket
   # @return [String] buffer used for reading
   def read(len = nil, buf = nil, buf_pos = 0)
     return '' if len == 0
-    
+
     if buf
       return Polyphony.backend_read(self, buf, len, true, buf_pos)
     end
-    
+
     @read_buffer ||= +''
     result = Polyphony.backend_read(self, @read_buffer, len, true, -1)
     return nil unless result
-    
+
     already_read = @read_buffer
     @read_buffer = +''
     already_read
@@ -548,15 +548,15 @@ class ::UNIXSocket < ::BasicSocket
   # @return [String] buffer used for reading
   def read(len = nil, buf = nil, buf_pos = 0)
     return '' if len == 0
-    
+
     if buf
       return Polyphony.backend_read(self, buf, len, true, buf_pos)
     end
-    
+
     @read_buffer ||= +''
     result = Polyphony.backend_read(self, @read_buffer, len, true, -1)
     return nil unless result
-    
+
     already_read = @read_buffer
     @read_buffer = +''
     already_read

data/lib/polyphony/version.rb

@@ -2,5 +2,5 @@
 
 module Polyphony
   # @!visibility private
-  VERSION = '1.0.2'
+  VERSION = '1.1.1'
 end

data/polyphony.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.author      = 'Sharon Rosner'
   s.email       = 'sharon@noteflakes.com'
   s.files       = `git ls-files --recurse-submodules`.split.reject { |fn| fn =~ /liburing\/man/ }
-  s.homepage    = 'https://digital-fabric.github.io/polyphony'
+  s.homepage    = 'https://github.com/digital-fabric/polyphony'
   s.metadata    = {
     "source_code_uri" => "https://github.com/digital-fabric/polyphony",
     "documentation_uri" => "https://www.rubydoc.info/gems/polyphony",

data/test/stress.rb

@@ -3,7 +3,7 @@
 count = ARGV[0] ? ARGV[0].to_i : 100
 test_name = ARGV[1]
 
-$test_cmd = +'ruby test/run.rb'
+$test_cmd = +'ruby test/test_scenarios.rb'
 if test_name
   $test_cmd << " --name #{test_name}"
 end

data/test/test_fiber.rb

@@ -975,6 +975,50 @@ class MailboxTest < MiniTest::Test
     assert_equal ['foo'] * 100, messages
   end
 
+  def test_receive_loop
+    buffer = []
+    f = spin do
+      receive_loop { |msg| buffer << msg }
+    ensure
+      buffer << :done
+    end
+
+    snooze
+    f << :foo
+    snooze
+    assert_equal [:foo], buffer
+    
+    f << :bar
+    snooze
+    assert_equal [:foo, :bar], buffer
+
+    f.kill
+    f.join
+    assert_equal [:foo, :bar, :done], buffer
+  end
+
+  def test_receive_loop_break
+    buffer = []
+    f = spin do
+      receive_loop do |msg|
+        buffer << msg
+        break if msg == :bar
+      end
+      buffer << :done
+    end
+
+    snooze
+    f << :foo
+    snooze
+    assert_equal [:foo], buffer
+    
+    f << :bar
+    snooze
+    assert_equal [:foo, :bar, :done], buffer
+
+    assert_equal :dead, f.state
+  end
+
   def test_receive_exception
     e = RuntimeError.new 'foo'
     spin { Fiber.current.parent << e }
@@ -1287,4 +1331,4 @@ class DebugTest < MiniTest::Test
     10.times { snooze }
     assert_equal [0, 1, 2], buf
   end
-end
+end

data/test/test_io.rb

@@ -321,11 +321,36 @@ class IOTest < MiniTest::Test
     assert_equal 6, len
   end
 
+  def test_splice_class_method_with_eof_detection
+    i1, o1 = IO.pipe
+    i2, o2 = IO.pipe
+    splice_lens = []
+
+    spin {
+      loop {
+        len = IO.splice(i1, o2, 1000)
+        splice_lens << len
+        break if len == 0
+      }
+      
+      o2.close
+    }
+
+    o1.write('foobar')
+    snooze
+    o1.close
+
+    result = i2.read
+    assert_equal 'foobar', result
+    assert_equal [6, 0], splice_lens
+  end
+
   def test_splice_from_to_eof
     i1, o1 = IO.pipe
     i2, o2 = IO.pipe
     len = nil
 
+
     f = spin {
       len = o2.splice_from(i1, -1000)
       o2.close
@@ -672,6 +697,27 @@ class IOClassMethodsTest < MiniTest::Test
     assert_equal [:ready, 'foo', 'bar', :done], buf
   end
 
+  def test_read_loop_break
+    i, o = IO.pipe
+
+    buf = []
+    f = spin do
+      buf << :ready
+      i.read_loop do |d|
+        buf << d
+        break if d == 'bar'
+      end
+      buf << :done
+    end
+
+    # writing always causes snoozing
+    o << 'foo'
+    3.times { snooze }
+    o << 'bar'
+    f.await
+    assert_equal [:ready, 'foo', 'bar', :done], buf
+  end
+
   def test_read_loop_with_max_len
     r, w = IO.pipe