polyphony 1.3 → 1.5

data/lib/polyphony/extensions/socket.rb

@@ -59,7 +59,7 @@ class ::Socket < ::BasicSocket
 
   # Reads from the socket. If `maxlen` is given, reads up to `maxlen` bytes from
   # the socket, otherwise reads to `EOF`. If `buf` is given, it is used as the
-  # buffer to read into, otherwise a new string is allocated. If `buf_pos` is
+  # buffer to read into, otherwise a new string is allocated. If `buffer_pos` is
   # given, reads into the given offset (in bytes) in the given buffer. If the
   # given buffer offset is negative, it is calculated from the current end of
   # the buffer (`-1` means the read data will be appended to the end of the
@@ -70,9 +70,9 @@ class ::Socket < ::BasicSocket
   #
   # @param len [Integer, nil] maximum bytes to read from socket
   # @param buf [String, nil] buffer to read into
-  # @param buf_pos [Number] buffer position to read into
+  # @param buffer_pos [Number] buffer position to read into
   # @return [String] buffer used for reading
-  def read(len = nil, buf = nil, buffer_pos: 0)
+  def read(len = nil, buf = nil, buffer_pos = 0)
     return '' if len == 0
     return Polyphony.backend_read(self, buf, len, true, buffer_pos) if buf
 
@@ -148,7 +148,7 @@ class ::Socket < ::BasicSocket
   end
 
   # Reads up to `maxlen` from the socket. If `buf` is given, it is used as the
-  # buffer to read into, otherwise a new string is allocated. If `buf_pos` is
+  # buffer to read into, otherwise a new string is allocated. If `buffer_pos` is
   # given, reads into the given offset (in bytes) in the given buffer. If the
   # given buffer offset is negative, it is calculated from the current end of
   # the buffer (`-1` means the read data will be appended to the end of the
@@ -160,10 +160,10 @@ class ::Socket < ::BasicSocket
   #
   # @param maxlen [Integer, nil] maximum bytes to read from socket
   # @param buf [String, nil] buffer to read into
-  # @param buf_pos [Number] buffer position to read into
+  # @param buffer_pos [Number] buffer position to read into
   # @param raise_on_eof [bool] whether to raise an exception on `EOF`
   # @return [String, nil] buffer used for reading or nil on `EOF`
-  def readpartial(maxlen, buf = +'', buffer_pos: 0, raise_on_eof: true)
+  def readpartial(maxlen, buf = +'', buffer_pos = 0, raise_on_eof = true)
     result = Polyphony.backend_recv(self, buf, maxlen, buffer_pos)
     raise EOFError if !result && raise_on_eof
 
@@ -320,7 +320,7 @@ class ::TCPSocket < ::IPSocket
 
   # Reads from the socket. If `maxlen` is given, reads up to `maxlen` bytes from
   # the socket, otherwise reads to `EOF`. If `buf` is given, it is used as the
-  # buffer to read into, otherwise a new string is allocated. If `buf_pos` is
+  # buffer to read into, otherwise a new string is allocated. If `buffer_pos` is
   # given, reads into the given offset (in bytes) in the given buffer. If the
   # given buffer offset is negative, it is calculated from the current end of
   # the buffer (`-1` means the read data will be appended to the end of the
@@ -331,9 +331,9 @@ class ::TCPSocket < ::IPSocket
   #
   # @param len [Integer, nil] maximum bytes to read from socket
   # @param buf [String, nil] buffer to read into
-  # @param buf_pos [Number] buffer position to read into
+  # @param buffer_pos [Number] buffer position to read into
   # @return [String] buffer used for reading
-  def read(len = nil, buf = nil, buffer_pos: 0)
+  def read(len = nil, buf = nil, buffer_pos = 0)
     return '' if len == 0
     return Polyphony.backend_read(self, buf, len, true, buffer_pos) if buf
 
@@ -391,7 +391,7 @@ class ::TCPSocket < ::IPSocket
   end
 
   # Reads up to `maxlen` from the socket. If `buf` is given, it is used as the
-  # buffer to read into, otherwise a new string is allocated. If `buf_pos` is
+  # buffer to read into, otherwise a new string is allocated. If `buffer_pos` is
   # given, reads into the given offset (in bytes) in the given buffer. If the
   # given buffer offset is negative, it is calculated from the current end of
   # the buffer (`-1` means the read data will be appended to the end of the
@@ -403,10 +403,10 @@ class ::TCPSocket < ::IPSocket
   #
   # @param maxlen [Integer, nil] maximum bytes to read from socket
   # @param buf [String, nil] buffer to read into
-  # @param buf_pos [Number] buffer position to read into
+  # @param buffer_pos [Number] buffer position to read into
   # @param raise_on_eof [bool] whether to raise an exception on `EOF`
   # @return [String, nil] buffer used for reading or nil on `EOF`
-  def readpartial(maxlen, buf = +'', buffer_pos: 0, raise_on_eof: true)
+  def readpartial(maxlen, buf = +'', buffer_pos = 0, raise_on_eof = true)
     result = Polyphony.backend_recv(self, buf, maxlen, buffer_pos)
     raise EOFError if !result && raise_on_eof
 
@@ -464,20 +464,6 @@ class ::TCPServer < ::TCPSocket
     Polyphony.backend_accept(@io, TCPSocket)
   end
 
-  if Polyphony.instance_methods(false).include?(:backend_multishot_accept)
-    # Starts a multishot accept operation (only available with io_uring
-    # backend). Example usage:
-    #
-    #   server.multishot_accept do
-    #     server.accept_loop { |c| handle_connection(c) }
-    #   end
-    #
-    # @return [any] return value of code block
-    def multishot_accept(&block)
-      Polyphony.backend_multishot_accept(@io, &block)
-    end
-  end
-
   # Accepts incoming connections in an infinite loop.
   #
   # @yield [TCPSocket] accepted socket
@@ -526,7 +512,7 @@ class ::UNIXSocket < ::BasicSocket
 
   # Reads from the socket. If `maxlen` is given, reads up to `maxlen` bytes from
   # the socket, otherwise reads to `EOF`. If `buf` is given, it is used as the
-  # buffer to read into, otherwise a new string is allocated. If `buf_pos` is
+  # buffer to read into, otherwise a new string is allocated. If `buffer_pos` is
   # given, reads into the given offset (in bytes) in the given buffer. If the
   # given buffer offset is negative, it is calculated from the current end of
   # the buffer (`-1` means the read data will be appended to the end of the
@@ -537,9 +523,9 @@ class ::UNIXSocket < ::BasicSocket
   #
   # @param len [Integer, nil] maximum bytes to read from socket
   # @param buf [String, nil] buffer to read into
-  # @param buf_pos [Number] buffer position to read into
+  # @param buffer_pos [Number] buffer position to read into
   # @return [String] buffer used for reading
-  def read(len = nil, buf = nil, buffer_pos: 0)
+  def read(len = nil, buf = nil, buffer_pos = 0)
     return '' if len == 0
     return Polyphony.backend_read(self, buf, len, true, buffer_pos) if buf
 
@@ -623,7 +609,7 @@ class ::UNIXSocket < ::BasicSocket
   end
 
   # Reads up to `maxlen` from the socket. If `buf` is given, it is used as the
-  # buffer to read into, otherwise a new string is allocated. If `buf_pos` is
+  # buffer to read into, otherwise a new string is allocated. If `buffer_pos` is
   # given, reads into the given offset (in bytes) in the given buffer. If the
   # given buffer offset is negative, it is calculated from the current end of
   # the buffer (`-1` means the read data will be appended to the end of the
@@ -635,10 +621,10 @@ class ::UNIXSocket < ::BasicSocket
   #
   # @param maxlen [Integer, nil] maximum bytes to read from socket
   # @param buf [String, nil] buffer to read into
-  # @param buf_pos [Number] buffer position to read into
+  # @param buffer_pos [Number] buffer position to read into
   # @param raise_on_eof [bool] whether to raise an exception on `EOF`
   # @return [String, nil] buffer used for reading or nil on `EOF`
-  def readpartial(maxlen, buf = +'', buffer_pos: 0, raise_on_eof: true)
+  def readpartial(maxlen, buf = +'', buffer_pos = 0, raise_on_eof = true)
     result = Polyphony.backend_recv(self, buf, maxlen, buffer_pos)
     raise EOFError if !result && raise_on_eof
 

data/lib/polyphony/extensions/timeout.rb

@@ -14,6 +14,10 @@ module ::Timeout
   # @param message [String] exception message
   # @return [any] block's return value
   def self.timeout(sec, klass = Timeout::Error, message = 'execution expired', &block)
-    cancel_after(sec, with_exception: [klass, message], &block)
+    if sec.nil? || sec == 0
+      block.call
+    else
+      cancel_after(sec, with_exception: [klass, message], &block)
+    end
   end
 end

data/lib/polyphony/version.rb

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

data/test/stress.rb

@@ -3,11 +3,16 @@
 count = ARGV[0] ? ARGV[0].to_i : 100
 test_name = ARGV[1]
 
-$test_cmd = +'ruby test/test_scenarios.rb'
+$test_cmd = +'ruby test/run.rb'
 if test_name
   $test_cmd << " --name #{test_name}"
 end
 
+puts '*' * 40
+puts
+puts $test_cmd
+puts
+
 def run_test(count)
   puts "#{count}: running tests..."
   # sleep 1

data/test/test_backend.rb

@@ -317,6 +317,8 @@ class BackendTest < MiniTest::Test
   end
 
   def test_splice_chunks
+    skip if !Thread.current.backend.respond_to?(:splice_chunks)
+
     body = 'abcd' * 4
     chunk_size = 12
 
@@ -346,8 +348,8 @@ class BackendTest < MiniTest::Test
     expected = "Content-Type: foo\r\n\r\n#{12.to_s(16)}\r\n#{body[0..11]}\r\n#{4.to_s(16)}\r\n#{body[12..15]}\r\n0\r\n\r\n"
     assert_equal expected, buf
   ensure
-    o.close
-    w.close
+    o&.close
+    w&.close
   end
 
   def test_idle_gc
@@ -544,4 +546,11 @@ class BackendChainTest < MiniTest::Test
     # released properly before raising the error (for the time being this has
     # been verified manually).
   end
+
+  def test_backend_close
+    r, w = IO.pipe
+    w << 'abc'
+    Thread.backend.close(w)
+    assert w.closed?
+  end
 end

data/test/test_ext.rb

@@ -242,6 +242,20 @@ class TimeoutTest < MiniTest::Test
     assert_equal [0, 1, 2], buffer
   end
 
+  def test_timeout_with_nil_or_zero
+    v = Timeout.timeout(nil) do
+      sleep 0.01
+      :foo
+    end
+    assert_equal :foo, v
+
+    v = Timeout.timeout(0) do
+      sleep 0.01
+      :bar
+    end
+    assert_equal :bar, v
+  end
+
   class MyTimeout < Exception
   end
 

data/test/test_global_api.rb

@@ -128,16 +128,16 @@ class MoveOnAfterTest < MiniTest::Test
 
   def test_move_on_after_with_reset
     t0 = monotonic_clock
-    v = move_on_after(0.01, with_value: :moved_on) do |timeout|
-      sleep 0.006
+    v = move_on_after(0.1, with_value: :moved_on) do |timeout|
+      sleep 0.06
       timeout.reset
-      sleep 0.006
+      sleep 0.06
       nil
     end
     t1 = monotonic_clock
 
     assert_nil v
-    assert_in_range 0.012..0.025, t1 - t0 if IS_LINUX
+    assert_in_range 0.12..0.30, t1 - t0 if IS_LINUX
   end
 
   def test_nested_move_on_after
@@ -161,7 +161,7 @@ class MoveOnAfterTest < MiniTest::Test
     end
     t1 = monotonic_clock
     assert_equal 2, o
-    assert_in_range 0.008..0.025, t1 - t0 if IS_LINUX
+    assert_in_range 0.008..0.035, t1 - t0 if IS_LINUX
   end
 end
 

data/test/test_io.rb

@@ -89,7 +89,7 @@ class IOTest < MiniTest::Test
 
     buf = +'def'
     o << 'foobar'
-    assert_equal 'deffoobar', i.read(6, buf, buffer_pos: -1)
+    assert_equal 'deffoobar', i.read(6, buf, -1)
     assert_equal 'deffoobar', buf
   end
 

data/test/test_signal.rb

@@ -4,6 +4,10 @@ require_relative 'helper'
 
 class SignalTrapTest < Minitest::Test
   def test_signal_handler_trace
+    if Thread.current.backend.kind != :io_uring
+      skip "Skipping signal handler trace because Backend_close on libev behaves differently"
+    end
+
     i1, o1 = IO.pipe
     i2, o2 = IO.pipe
     pid = Process.pid
@@ -39,16 +43,21 @@ class SignalTrapTest < Minitest::Test
     end
 
     expected = [
-      [:block, :main],
+      [:block,      :main],
+      [:enter_poll, :main],
+      [:schedule,   :main],
+      [:leave_poll, :main],
+      [:unblock,    :main],
+      [:block,      :main],
       [:enter_poll, :main],
       [:leave_poll, :main],
-      [:unblock, :oob],
-      [:terminate, :oob],
-      [:block, :oob],
+      [:unblock,    :oob],
+      [:terminate,  :oob],
+      [:block,      :oob],
       [:enter_poll, :oob],
-      [:schedule, :main],
+      [:schedule,   :main],
       [:leave_poll, :oob],
-      [:unblock, :main]
+      [:unblock,    :main]
     ]
     if Thread.backend.kind == :libev
       expected += [

data/test/test_socket.rb

@@ -73,12 +73,8 @@ class TCPSocketTest < MiniTest::Test
   def test_read
     port, server = start_tcp_server_on_random_port
     server_fiber = spin do
-      while (socket = server.accept)
-        spin do
-          while (data = socket.readpartial(8192))
-            socket << data
-          end
-        end
+      server.accept_loop do |socket|
+        spin { socket.recv_loop { |data| socket << data } }
       end
     end
 
@@ -98,7 +94,7 @@ class TCPSocketTest < MiniTest::Test
 
     buf = +'def'
     client << 'foobar'
-    assert_equal 'deffoobar', client.read(6, buf, buffer_pos: -1)
+    assert_equal 'deffoobar', client.read(6, buf, -1)
     assert_equal 'deffoobar', buf
 
     client.close
@@ -394,98 +390,3 @@ class SSLSocketTest < MiniTest::Test
     assert_kind_of OpenSSL::SSL::SSLError, errors.first
   end
 end
-
-class MultishotAcceptTest < MiniTest::Test
-  def setup
-    skip if !TCPServer.instance_methods(false).include?(:multishot_accept)
-  end
-
-  def start_tcp_server_on_random_port(host = '127.0.0.1')
-    port = rand(1100..60000)
-    server = TCPServer.new(host, port)
-    [port, server]
-  rescue Errno::EADDRINUSE
-    retry
-  end
-
-  def test_multishot_accept_while_loop
-    port, server = start_tcp_server_on_random_port
-    server_fiber = spin do
-      server.multishot_accept do
-        while (socket = server.accept)
-          spin do
-            while (data = socket.gets(8192))
-              socket << data
-            end
-          end
-        end
-      end
-    end
-
-    snooze
-    client = TCPSocket.new('127.0.0.1', port)
-    client.write("1234\n")
-    assert_equal "1234\n", client.recv(8192)
-    client.close
-
-    client = TCPSocket.new('127.0.0.1', port)
-    client.write("5678\n")
-    assert_equal "5678\n", client.recv(8192)
-    client.close
-
-  ensure
-    server_fiber&.stop
-    server_fiber&.await
-    server&.close
-  end
-
-  def spin_client(socket)
-    spin do
-      while (data = socket.gets(8192))
-        socket << data
-      end
-    end
-  end
-
-  def test_multishot_accept_loop
-    port, server = start_tcp_server_on_random_port
-    server_fiber = spin do
-      server.multishot_accept do
-        server.accept_loop { |s| spin_client(s) }
-      end
-    end
-
-    snooze
-    client = TCPSocket.new('127.0.0.1', port)
-    client.write("1234\n")
-    assert_equal "1234\n", client.recv(8192)
-    client.close
-
-    client = TCPSocket.new('127.0.0.1', port)
-    client.write("5678\n")
-    assert_equal "5678\n", client.recv(8192)
-    client.close
-
-  ensure
-    server_fiber&.stop
-    server_fiber&.await
-    server&.close
-  end
-
-  def test_multishot_accept_error
-    port, server = start_tcp_server_on_random_port
-    error = nil
-    server_fiber = spin do
-      server.multishot_accept do
-        server.accept_loop { |s| spin_client(s) }
-      rescue SystemCallError => e
-        error = e
-      end
-    end
-    snooze
-    server.close
-    snooze
-    server_fiber.await
-    assert_kind_of Errno::EBADF, error
-  end
-end

data/test/test_timer.rb

@@ -73,7 +73,7 @@ class TimerCancelAfterTest < MiniTest::Test
       end
     end
     t1 = Time.now
-    assert_in_range 0.01..0.03, t1 - t0 if IS_LINUX
+    assert_in_range 0.01..0.04, t1 - t0 if IS_LINUX
   end
 
   def test_timer_cancel_after_with_reset

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.5'
 platform: ruby
 authors:
 - Sharon Rosner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2023-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -150,7 +150,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.10.0
-description: 
+description:
 email: sharon@noteflakes.com
 executables: []
 extensions:
@@ -191,6 +191,7 @@ files:
 - docs/extending.md
 - docs/faq.md
 - docs/fiber-scheduling.md
+- docs/installation.md
 - docs/overview.md
 - docs/readme.md
 - docs/tutorial.md
@@ -234,6 +235,7 @@ files:
 - examples/core/shutdown_all_children.rb
 - examples/core/spin.rb
 - examples/core/spin_error_backtrace.rb
+- examples/core/stages.rb
 - examples/core/stream_mockup.rb
 - examples/core/supervise-process.rb
 - examples/core/supervisor.rb
@@ -310,6 +312,7 @@ files:
 - examples/pipes/gzip.rb
 - examples/pipes/gzip_http_server.rb
 - examples/pipes/http_server.rb
+- examples/pipes/http_server2.rb
 - examples/pipes/tcp_proxy.rb
 - examples/pipes/tee.rb
 - ext/libev/Changes
@@ -354,6 +357,7 @@ files:
 - ext/polyphony/runqueue_ring_buffer.h
 - ext/polyphony/socket_extensions.c
 - ext/polyphony/thread.c
+- ext/polyphony/win_uio.h
 - ext/polyphony/zlib_conf.rb
 - ext/test_eintr.c
 - lib/polyphony.rb
@@ -656,7 +660,7 @@ metadata:
   source_code_uri: https://github.com/digital-fabric/polyphony
   documentation_uri: https://www.rubydoc.info/gems/polyphony
   changelog_uri: https://github.com/digital-fabric/polyphony/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - polyphony
@@ -676,7 +680,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.1
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Fine grained concurrency for Ruby
 test_files: []