polyphony 0.98 → 0.99

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf93e3d5dfd0a5e3a4a70ee66d62caddc1ea22e63cf1ce44a212a75f18c2ac76
-  data.tar.gz: 121f84bb920ccc6822cb43b772a68dd92b2f2d81ebf9e1a510c081481dd1e3b1
+  metadata.gz: 4696bb7b13f68b379c29d5c38257e57c13aefd299f88727107e2f0f0a3c7d360
+  data.tar.gz: 94a3eeb8575d0d5fe6f143ab41351024b50c4c4cf919edec6c8155d9ead2831e
 SHA512:
-  metadata.gz: 286d3cb30ecd19b8f046fe43761f6d2f243f3e3a8134d01ebe14fdfdf11d6d879000f51ba66c705b0ad425e3c6a51dff02781b47e8cf75e52bc4f0439dfffc0e
-  data.tar.gz: 7caf9e3b7294ece38c964dc0366011b07d8977f95ec8c92a22763b9ecccc33080de40b5ab19bb66223eb4bb27be0847c92879a173dceee1b3fda9e1b03b0cdcd
+  metadata.gz: 9e1798e18b0e7a35104009d6f480191f5ed5efd7dee69189d443cb57ab8ca2f8fd75105234cd60f52ecea2348a8c3d85f152aa869374ea8dfbab8895a2015b04
+  data.tar.gz: 835b2be245f60b04d5b750bcce6e679b11c671e31c3d0269aeafaa961c52c501193f67cf00f4f7cc5570cab499105d025863189767db8ae79f961a62d903b173

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.99 2023-03-09
+
+- Add missing Mutex API methods (#76)
+- Fix `IO.foreach` and `IO#each_line` (#74)
+- Fix `SSLServer#accept_loop` (#59)
+- Update liburing
+
 ## 0.98 2023-03-08
 
 - Add basic support for UDP sockets

data/examples/io/https_server_sni_2.rb

@@ -27,15 +27,21 @@ server = Polyphony::Net.tcp_listen('localhost', 1234, opts)
 
 puts 'Serving HTTPS on port 1234'
 
-# server.accept_loop do |socket|
-server.accept_loop do |socket|
-# while (socket = (server.accept)
-  spin do
-    while (data = socket.gets("\n", 8192))
-      if data.chomp.empty?
-        socket << "HTTP/1.1 200 OK\nConnection: close\nContent-Length: 4\n\nfoo\n"
-        break
+begin
+  server.accept_loop(false) do |socket|
+    spin do
+      while (data = socket.gets("\n", 8192))
+        if data.chomp.empty?
+          socket << "HTTP/1.1 200 OK\nConnection: close\nContent-Length: 4\n\nfoo\n"
+          break
+        end
       end
+    rescue OpenSSL::SSL::SSLError
+      # ignore
     end
   end
+rescue => e
+  puts '*' * 40
+  p e
+  puts e.backtrace.join("\n")
 end

data/ext/polyphony/extconf.rb

@@ -55,16 +55,17 @@ if config[:io_uring]
 else
   $defs << "-DPOLYPHONY_BACKEND_LIBEV"
   $defs << "-DPOLYPHONY_LINUX" if config[:linux]
-  $defs << '-DEV_USE_LINUXAIO'     if have_header('linux/aio_abi.h')
-  $defs << '-DEV_USE_SELECT'       if have_header('sys/select.h')
-  $defs << '-DEV_USE_POLL'         if have_type('port_event_t', 'poll.h')
+
+  $defs << "-DEV_STANDALONE" # prevent libev from assuming "config.h" exists
   $defs << '-DEV_USE_EPOLL'        if have_header('sys/epoll.h')
   $defs << '-DEV_USE_KQUEUE'       if have_header('sys/event.h') && have_header('sys/queue.h')
+  $defs << '-DEV_USE_LINUXAIO'     if have_header('linux/aio_abi.h')
+  $defs << '-DEV_USE_POLL'         if have_type('port_event_t', 'poll.h')
   $defs << '-DEV_USE_PORT'         if have_type('port_event_t', 'port.h')
+  $defs << '-DEV_USE_SELECT'       if have_header('sys/select.h')
+  
   $defs << '-DHAVE_SYS_RESOURCE_H' if have_header('sys/resource.h')
 
-  $defs << "-DEV_STANDALONE" # prevent libev from assuming "config.h" exists
-
   $CFLAGS << " -Wno-comment"
   $CFLAGS << " -Wno-unused-result"
   $CFLAGS << " -Wno-dangling-else"

data/ext/polyphony/libev.h

@@ -1,5 +1,3 @@
-#define EV_STANDALONE
-
 #ifdef POLYPHONY_BACKEND_LIBEV
 
 /* keeps ev from requiring config.h */

data/lib/polyphony/core/sync.rb

@@ -58,6 +58,58 @@ module Polyphony
       @holding_fiber
     end
 
+    # Obtains a lock. Raises `ThreadError` if mutex is locked by the current
+    # thread.
+    #
+    # @return [Mutex] self
+    def lock
+      raise ThreadError if owned?
+      
+      @token = @store.shift
+      @holding_fiber = Fiber.current
+      self
+    end
+
+    # Releases the lock. Raises `ThreadError` if mutex is not locked by the
+    # current thread.
+    #
+    # @return [Mutex] self
+    def unlock
+      raise ThreadError if !owned?
+
+      @holding_fiber = nil
+      @store << @token if @token
+      @token = nil
+    end
+
+    # Attempts to obtain the lock and returns immediately. Returns `true` if the
+    # lock was granted.
+    #
+    # @return [true, false]
+    def try_lock
+      return false if @holding_fiber
+
+      @token = @store.shift
+      @holding_fiber = Fiber.current
+      true
+    end
+
+    # Releases the lock and sleeps timeout seconds if it is given and non-nil or
+    # forever. Raises `ThreadError` if mutex wasn’t locked by the current
+    # thread.
+    #
+    # @param timeout [nil, Number] sleep timeout
+    # @return [Number] slept time in seconds
+    def sleep(timeout = nil)
+      unlock
+      t0 = Time.now
+      Kernel.sleep(timeout)
+      t1 = Time.now
+      lock
+
+      return t1 - t0
+    end
+
     private
 
     # Helper method for performing a `#synchronize` when not currently holding
@@ -72,6 +124,7 @@ module Polyphony
       ensure
         @holding_fiber = nil
         @store << @token if @token
+        @token = nil
       end
     end
   end

data/lib/polyphony/extensions/io.rb

@@ -25,20 +25,19 @@ class ::IO
 
     EMPTY_HASH = {}.freeze
 
-    # alias_method :orig_foreach, :foreach
-    # def foreach(_name, _sep = $/, _limit = nil, _getline_args = EMPTY_HASH,
-    #             &_block)
-    #   # IO.orig_read(name).each_line(&block)
-    #   raise NotImplementedError
-
-    #   # if sep.is_a?(Integer)
-    #   #   sep = $/
-    #   #   limit = sep
-    #   # end
-    #   # File.open(name, 'r') do |f|
-    #   #   f.each_line(sep, limit, getline_args, &block)
-    #   # end
-    # end
+    alias_method :orig_foreach, :foreach
+    def foreach(name, sep = $/, limit = nil, getline_args = EMPTY_HASH, &block)
+      # IO.orig_read(name).each_line(&block)
+      # raise NotImplementedError
+
+      if sep.is_a?(Integer)
+        sep = $/
+        limit = sep
+      end
+      File.open(name, 'r') do |f|
+        f.each_line(sep, limit, chomp: getline_args[:chomp], &block)
+      end
+    end
 
     alias_method :orig_read, :read
     def read(name, length = nil, offset = nil, opt = EMPTY_HASH)
@@ -198,6 +197,30 @@ class ::IO
     return nil
   end
 
+  def each_line(sep = $/, limit = nil, chomp: false)
+    if sep.is_a?(Integer)
+      limit = sep
+      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
 

data/lib/polyphony/extensions/openssl.rb

@@ -200,7 +200,7 @@ class ::OpenSSL::SSL::SSLServer
   def accept_loop(ignore_errors = true)
     loop do
       yield accept
-    rescue SystemCallError, StandardError => e
+    rescue OpenSSL::SSL::SSLError, SystemCallError => e
       raise e unless ignore_errors
     end
   end

data/lib/polyphony/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Polyphony
-  VERSION = '0.98'
+  VERSION = '0.99'
 end

data/test/test_io.rb

@@ -523,13 +523,12 @@ class IOClassMethodsTest < MiniTest::Test
     assert_equal BIN_DATA, s
   end
   
-  # def test_foreach
-  #   skip 'IO.foreach is not yet implemented'
-  #   lines = []
-  #   IO.foreach(__FILE__) { |l| lines << l }
-  #   assert_equal "# frozen_string_literal: true\n", lines[0]
-  #   assert_equal "end\n", lines[-1]
-  # end
+  def test_foreach
+    lines = []
+    IO.foreach(__FILE__) { |l| lines << l }
+    assert_equal "# frozen_string_literal: true\n", lines[0]
+    assert_equal "end\n", lines[-1]
+  end
   
   def test_read_class_method
     s = IO.read(__FILE__)

data/test/test_socket.rb

@@ -3,6 +3,7 @@
 require_relative 'helper'
 require 'fileutils'
 require 'msgpack'
+require 'localhost/authority'
 
 class TCPSocketTest < MiniTest::Test
   def start_tcp_server_on_random_port(host = '127.0.0.1')
@@ -322,3 +323,63 @@ if IS_LINUX
     end
   end
 end
+
+class SSLSocketTest < MiniTest::Test
+  def handle_http_request(socket)
+    while (data = socket.gets("\n", 8192))
+      if data.chomp.empty?
+        socket << "HTTP/1.1 200 OK\nConnection: close\nContent-Length: 3\n\nfoo"
+        break
+      end
+    end
+  end
+
+  def test_ssl_accept_loop
+    authority = Localhost::Authority.fetch
+    server_ctx = authority.server_context
+    
+    opts = {
+      reuse_addr:     true,
+      dont_linger:    true,
+      secure_context: server_ctx
+    }
+    
+    port = rand(10001..39999)
+    server = Polyphony::Net.tcp_listen('127.0.0.1', port, opts)
+    f = spin do
+      server.accept_loop { |s| handle_http_request(s) }
+    end
+
+    # make bad request
+    `curl -s http://localhost:#{port}/`
+
+    msg = `curl -sk https://localhost:#{port}/`
+    assert_equal 'foo', msg
+
+    f.stop
+    f.await
+
+    port = rand(10001..39999)
+    server = Polyphony::Net.tcp_listen('127.0.0.1', port, opts)
+    errors = []
+    f = spin do
+      ## without ignoring errors
+      f2 = spin do
+        server.accept_loop(false) { |s| handle_http_request(s) }
+      end
+      f2.await
+    rescue => e
+      errors << e
+    end
+
+    msg = `curl -sk https://localhost:#{port}/`
+    assert_equal 'foo', msg
+
+    # make bad request
+    `curl -s http://localhost:#{port}/`
+
+    f.await
+    assert_equal 1, errors.size
+    assert_kind_of OpenSSL::SSL::SSLError, errors.first
+  end
+end

data/test/test_sync.rb

@@ -113,4 +113,45 @@ class MutexTest < MiniTest::Test
     receive
     assert !lock.locked?
   end
-end
+
+  def test_lock_unlock
+    m = Polyphony::Mutex.new
+    assert_nil m.locked?
+    assert_equal false, m.owned?
+    assert_raises(ThreadError) { m.unlock }
+
+    m.lock
+    assert_equal Fiber.current, m.locked?
+    assert_equal true, m.owned?
+
+    assert_raises(ThreadError) { m.lock }
+
+    m.unlock
+    assert_nil m.locked?
+    assert_equal false, m.owned?
+  end
+
+  def test_try_lock
+    m = Polyphony::Mutex.new
+
+    r = m.try_lock
+    assert_equal true, r
+
+    r = m.try_lock
+    assert_equal false, r
+
+    this = Fiber.current
+    m.unlock
+    f = spin do
+      m.synchronize { this << 'ok'; sleep 0.2 }
+    end
+
+    assert_equal 'ok', receive
+    r = m.try_lock
+    assert_equal false, r
+
+    f.await
+    r = m.try_lock
+    assert_equal true, r
+  end
+end

data/vendor/liburing/.github/workflows/build.yml

@@ -26,7 +26,8 @@ jobs:
             cxx_pkg: clang
             cc: clang
             cxx: clang++
-            extra_flags: -Wshorten-64-to-32
+            liburing_extra_flags: -Wshorten-64-to-32
+            extra_flags: -Wmissing-prototypes -Wstrict-prototypes -Wunreachable-code-loop-increment -Wunreachable-code -Wmissing-variable-declarations -Wextra-semi-stmt
 
           # x86 (32-bit) gcc
           - arch: i686
@@ -85,10 +86,10 @@ jobs:
             cxx: mips-linux-gnu-g++
 
     env:
-      FLAGS: -g -O3 -Wall -Wextra -Werror
+      FLAGS: -g -O3 -Wall -Wextra -Werror -Wno-sign-compare ${{matrix.extra_flags}}
 
       # Flags for building sources in src/ dir only.
-      LIBURING_CFLAGS: ${{matrix.extra_flags}}
+      LIBURING_CFLAGS: ${{matrix.liburing_extra_flags}}
 
     steps:
     - name: Checkout source
@@ -98,9 +99,9 @@ jobs:
       run: |
         if [[ "${{matrix.cc_pkg}}" == "clang" ]]; then \
             wget https://apt.llvm.org/llvm.sh -O /tmp/llvm.sh; \
-            sudo bash /tmp/llvm.sh 16; \
-            sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-16 400; \
-            sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-16 400; \
+            sudo bash /tmp/llvm.sh 17; \
+            sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-17 400; \
+            sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-17 400; \
         else \
             sudo apt-get update -y; \
             sudo apt-get install -y ${{matrix.cc_pkg}} ${{matrix.cxx_pkg}}; \
@@ -116,16 +117,6 @@ jobs:
         ./configure --cc=${{matrix.cc}} --cxx=${{matrix.cxx}};
         make -j$(nproc) V=1 CPPFLAGS="-Werror" CFLAGS="$FLAGS" CXXFLAGS="$FLAGS";
 
-    - name: Build nolibc
-      run: |
-        if [[ "${{matrix.arch}}" == "x86_64" || "${{matrix.arch}}" == "i686" || "${{matrix.arch}}" == "aarch64" ]]; then \
-            make clean; \
-            ./configure --cc=${{matrix.cc}} --cxx=${{matrix.cxx}} --nolibc; \
-            make -j$(nproc) V=1 CPPFLAGS="-Werror" CFLAGS="$FLAGS" CXXFLAGS="$FLAGS"; \
-        else \
-            echo "Skipping nolibc build, this arch doesn't support building liburing without libc"; \
-        fi;
-
     - name: Test install command
       run: |
         sudo make install;

data/vendor/liburing/.gitignore

@@ -9,8 +9,12 @@
 
 /src/liburing.a
 /src/liburing.so*
+/src/liburing-ffi.a
+/src/liburing-ffi.so*
 /src/include/liburing/compat.h
+/src/include/liburing/io_uring_version.h
 
+/examples/io_uring-close-test
 /examples/io_uring-cp
 /examples/io_uring-test
 /examples/io_uring-udp
@@ -28,5 +32,6 @@ config-host.mak
 config.log
 
 liburing.pc
+liburing-ffi.pc
 
 cscope.out

data/vendor/liburing/CHANGELOG

@@ -1,8 +1,30 @@
+liburing-2.4 release
+
+- Add io_uring_{major,minor,check}_version() functions.
+- Add IO_URING_{MAJOR,MINOR,CHECK}_VERSION() macros.
+- FFI support (for non-C/C++ languages integration).
+- Add io_uring_prep_msg_ring_cqe_flags() function.
+- Deprecate --nolibc configure option.
+- CONFIG_NOLIBC is always enabled on x86-64, x86, and aarch64.
+- Add support for IORING_REGISTER_USE_REGISTERED_RING and use if available.
+- Add io_uring_close_ring_fd() function.
+
 liburing-2.3 release
 
 - Support non-libc build for aarch64.
 - Add io_uring_{enter,enter2,register,setup} syscall functions.
-
+- Add sync cancel interface, io_uring_register_sync_cancel().
+- Fix return value of io_uring_submit_and_wait_timeout() to match the
+  man page.
+- Improvements to the regression tests
+- Add support and test case for passthrough IO
+- Add recv and recvmsg multishot helpers and support
+- Add documentation and support for IORING_SETUP_DEFER_TASKRUN
+- Fix potential missing kernel entry with IORING_SETUP_IOPOLL
+- Add support and documentation for zero-copy network transmit
+- Various optimizations
+- Many cleanups
+- Many man page additions and updates
 
 liburing-2.2 release
 

data/vendor/liburing/Makefile

@@ -25,7 +25,7 @@ runtests-parallel: all
 	@$(MAKE) -C test runtests-parallel
 
 config-host.mak: configure
-	@if [ ! -e "$@" ]; then					\
+	+@if [ ! -e "$@" ]; then				\
 	  echo "Running configure ...";				\
 	  ./configure;						\
 	else							\
@@ -45,13 +45,14 @@ endif
 	    -e "s%@VERSION@%$(VERSION)%g" \
 	    $< >$@
 
-install: $(NAME).pc
+install: $(NAME).pc $(NAME)-ffi.pc
 	@$(MAKE) -C src install prefix=$(DESTDIR)$(prefix) \
 		includedir=$(DESTDIR)$(includedir) \
 		libdir=$(DESTDIR)$(libdir) \
 		libdevdir=$(DESTDIR)$(libdevdir) \
 		relativelibdir=$(relativelibdir)
 	$(INSTALL) -D -m 644 $(NAME).pc $(DESTDIR)$(libdevdir)/pkgconfig/$(NAME).pc
+	$(INSTALL) -D -m 644 $(NAME)-ffi.pc $(DESTDIR)$(libdevdir)/pkgconfig/$(NAME)-ffi.pc
 	$(INSTALL) -m 755 -d $(DESTDIR)$(mandir)/man2
 	$(INSTALL) -m 644 man/*.2 $(DESTDIR)$(mandir)/man2
 	$(INSTALL) -m 755 -d $(DESTDIR)$(mandir)/man3
@@ -63,7 +64,7 @@ install-tests:
 	@$(MAKE) -C test install prefix=$(DESTDIR)$(prefix) datadir=$(DESTDIR)$(datadir)
 
 clean:
-	@rm -f config-host.mak config-host.h cscope.out $(NAME).pc test/*.dmesg
+	@rm -f config-host.mak config-host.h cscope.out $(NAME).pc $(NAME)-ffi.pc test/*.dmesg
 	@$(MAKE) -C src clean
 	@$(MAKE) -C test clean
 	@$(MAKE) -C examples clean

data/vendor/liburing/Makefile.common

@@ -3,4 +3,5 @@ NAME=liburing
 SPECFILE=$(TOP)/$(NAME).spec
 VERSION=$(shell awk '/Version:/ { print $$2 }' $(SPECFILE))
 VERSION_MAJOR=$(shell echo $(VERSION) | cut -d. -f1)
+VERSION_MINOR=$(shell echo $(VERSION) | cut -d. -f2)
 TAG = $(NAME)-$(VERSION)

data/vendor/liburing/README

@@ -47,6 +47,54 @@ the kernel io_uring support. Please note that this suite isn't expected to
 pass on older kernels, and may even crash or hang older kernels!
 
 
+Building liburing
+-----------------
+
+    #
+    # Prepare build config (optional).
+    #
+    #  --cc  specifies the C   compiler.
+    #  --cxx speficies the C++ compiler.
+    #
+    ./configure --cc=gcc --cxx=g++;
+
+    #
+    # Build liburing.
+    #
+    make -j$(nproc);
+
+    #
+    # Install liburing (headers, shared/static libs, and manpage).
+    #
+    sudo make install;
+
+See './configure --help' for more information about build config options.
+
+
+FFI support
+-----------
+
+By default, the build results in 4 lib files:
+
+    2 shared libs:
+
+        liburing.so
+        liburing-ffi.so
+
+    2 static libs:
+
+        liburing.a
+        liburing-ffi.a
+
+Languages and applications that can't use 'static inline' functions in
+liburing.h should use the FFI variants.
+
+liburing's main public interface lives in liburing.h as 'static inline'
+functions. Users wishing to consume liburing purely as a binary dependency
+should link against liburing-ffi. It contains definitions for every 'static
+inline' function.
+
+
 License
 -------