polyphony 0.47.3 → 0.47.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89890bc8a81fd4f0a80f6d84c7f5138cfda12bc99848e74ef8140abf681640e2
-  data.tar.gz: d18e210b24f3d0eb2f83c1dcb188e7c1c691f949231ef0b3d07bd926c988f4d6
+  metadata.gz: f32962c9f1004bc9c63afcaddaad91dc8878da5e8290b8e9d42d591433311c0b
+  data.tar.gz: 3b43ad185ccb0778d88d9c8ac1043bbff291ac0a55d5bee80da8b6e08a1f6493
 SHA512:
-  metadata.gz: c95bef00de396f601f91937c780202a26d0e9c5a3eb48f564d1dcb70d89b30c12ebbbc89c9ddb10b81b013f9a89398468b8b3b4c1d3158d00110e3e6ea5355a6
-  data.tar.gz: 3c31dac6a239e73b6dbf028edfeced82ac6b2d17ba2f5f2960a41aa9d74e57336082bbe038a8ed6701a2ceefaf68cacb74764f9f71c81ce1e36d5868702e5346
+  metadata.gz: b4ba80ea441862f22398e624996144e9ed7f8297b56e2f14035c537671282f4338b3843ff192959a7031134e761d273c5050043b08b5051c1653ecc3f986cddb
+  data.tar.gz: '04850a036f5278d221b6610259e70fbb7e44e8afd04237d9a6906fa826a836c786734123894a0b7197c5c98502a9b5304896b09a1e7b6d16433e363dbd1803e6'

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.47.4
+
+* Add support for Unix sockets
+
 ## 0.47.3
 
 * Enable I/O in signal handlers (#45)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polyphony (0.47.3)
+    polyphony (0.47.4)
 
 GEM
   remote: https://rubygems.org/

data/TODO.md

@@ -1,37 +1,42 @@
-Graceful shutdown again:
-
-- Add `Polyphony::GracefulShutdown` exception
-- Two exceptions for stopping fibers:
-  - `Polyphony::GracefulShutdown` - graceful shutdown
-  - `Polyphony::Terminate` - ungraceful shutdown
-- Fiber API:
-  - `Fiber#shutdown_children` - graceful shutdown of all children
-  - `Fiber#terminate_children` - ungraceful shutdown of all children
-
-- Add `Fiber#graceful_shutdown?` method
-  - Returns false unless a `Polyphony::GracefulShutdown` was raised
-- Override `Polyphony::Terminate#invoke` to reset the `@graceful_shutdown` fiber
-  flag
-
-And then we have:
-
-```ruby
-spin do
-  loop { do_some_stuff }
-ensure
-  return unless Fiber.current.graceful_shutdown?
-
-shutdown_gracefully
-end
-```
+- Graceful shutdown again:
+
+  - Add `Polyphony::GracefulShutdown` exception
+  - Two exceptions for stopping fibers:
+    - `Polyphony::GracefulShutdown` - graceful shutdown
+    - `Polyphony::Terminate` - ungraceful shutdown
+  - Fiber API:
+    - `Fiber#shutdown_children` - graceful shutdown of all children
+    - `Fiber#terminate_children` - ungraceful shutdown of all children
+
+  - Add `Fiber#graceful_shutdown?` method
+    - Returns false unless a `Polyphony::GracefulShutdown` was raised
+  - Override `Polyphony::Terminate#invoke` to reset the `@graceful_shutdown` fiber
+    flag
+
+  And then we have:
+
+  ```ruby
+  spin do
+    loop { do_some_stuff }
+  ensure
+    return unless Fiber.current.graceful_shutdown?
+
+  shutdown_gracefully
+  end
+  ```
 
-- When a fiber is stopped it should use `Polyphony::Terminate` to stop child
-  fibers, *unless* it was stopped with a `Polyphony::GracefulShutdown` (which it
-  can check with `@graceful_shutdown`).
+  - When a fiber is stopped it should use `Polyphony::Terminate` to stop child
+    fibers, *unless* it was stopped with a `Polyphony::GracefulShutdown` (which it
+    can check with `@graceful_shutdown`).
 
+- More tight loops
+  - IO#gets_loop, Socket#gets_loop, OpenSSL::Socket#gets_loop (medium effort)
+  - Fiber#receive_loop (very little effort, should be implemented in C)
 
 ## Roadmap for Polyphony 1.0
 
+- check integration with rb-inotify
+
 - Check why worker-thread example doesn't work.
 - Add test that mimics the original design for Monocrono:
   - 256 fibers each waiting for a message

data/examples/io/unix_socket.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+require 'fileutils'
+
+unix_path = '/tmp/polyphony-unix-socket'
+
+FileUtils.rm unix_path rescue nil
+server = UNIXServer.new(unix_path)
+spin do
+  server.accept_loop do |socket|
+    p [:accept, socket]
+    spin do
+      while (line = socket.gets)
+        socket.puts line
+      end
+    end
+  end
+end
+
+snooze
+client = UNIXSocket.new('/tmp/polyphony-unix-socket')
+p [:connected, client]
+client.puts 'hello!'
+p client.gets

data/ext/polyphony/backend_common.h

@@ -3,6 +3,26 @@
 #include "ruby.h"
 #include "ruby/io.h"
 
+VALUE cTCPSocket;
+VALUE cTCPServer;
+VALUE cUNIXSocket;
+VALUE cUNIXServer;
+
+void Init_SocketClasses() {
+  rb_require("socket");
+  cTCPSocket = rb_const_get(rb_cObject, rb_intern("TCPSocket"));
+  cTCPServer = rb_const_get(rb_cObject, rb_intern("TCPServer"));
+  cUNIXSocket = rb_const_get(rb_cObject, rb_intern("UNIXSocket"));
+  cUNIXServer = rb_const_get(rb_cObject, rb_intern("UNIXServer"));
+}
+
+VALUE ConnectionSocketClass(VALUE server) {
+  if (RTEST(rb_obj_is_kind_of(server, cTCPServer))) return cTCPSocket;
+  if (RTEST(rb_obj_is_kind_of(server, cUNIXServer))) return cUNIXSocket;
+
+  rb_raise(rb_eRuntimeError, "Invalid server class");
+}
+
 //////////////////////////////////////////////////////////////////////
 //////////////////////////////////////////////////////////////////////
 // the following is copied verbatim from the Ruby source code (io.c)

data/ext/polyphony/backend_io_uring.c

@@ -27,7 +27,6 @@ static int pidfd_open(pid_t pid, unsigned int flags) {
   return syscall(__NR_pidfd_open, pid, flags);
 }
 
-VALUE cTCPSocket;
 VALUE SYM_io_uring;
 
 typedef struct Backend_t {
@@ -669,15 +668,16 @@ VALUE Backend_send(VALUE self, VALUE io, VALUE str) {
   return INT2NUM(len);
 }
 
-VALUE io_uring_backend_accept(Backend_t *backend, VALUE sock, int loop) {
+VALUE io_uring_backend_accept(Backend_t *backend, VALUE server_socket, int loop) {
   rb_io_t *fptr;
   struct sockaddr addr;
   socklen_t len = (socklen_t)sizeof addr;
-  VALUE underlying_sock = rb_ivar_get(sock, ID_ivar_io);
   VALUE socket = Qnil;
-  if (underlying_sock != Qnil) sock = underlying_sock;
+  VALUE socket_class = ConnectionSocketClass(server_socket);
+  VALUE underlying_sock = rb_ivar_get(server_socket, ID_ivar_io);
+  if (underlying_sock != Qnil) server_socket = underlying_sock;
 
-  GetOpenFile(sock, fptr);
+  GetOpenFile(server_socket, fptr);
   while (1) {
     VALUE resume_value = Qnil;
     op_context_t *ctx = OP_CONTEXT_ACQUIRE(&backend->store, OP_ACCEPT);
@@ -695,7 +695,7 @@ VALUE io_uring_backend_accept(Backend_t *backend, VALUE sock, int loop) {
     else {
       rb_io_t *fp;
 
-      socket = rb_obj_alloc(cTCPSocket);
+      socket = rb_obj_alloc(socket_class);
       MakeOpenFile(socket, fp);
       rb_update_max_fd(fd);
       fp->fd = fd;
@@ -945,8 +945,7 @@ VALUE Backend_kind(VALUE self) {
 }
 
 void Init_Backend() {
-  rb_require("socket");
-  cTCPSocket = rb_const_get(rb_cObject, rb_intern("TCPSocket"));
+  Init_SocketClasses();
 
   VALUE cBackend = rb_define_class_under(mPolyphony, "Backend", rb_cData);
   rb_define_alloc_func(cBackend, Backend_allocate);

data/ext/polyphony/backend_libev.c

@@ -13,7 +13,6 @@
 #include "../libev/ev.h"
 #include "ruby/io.h"
 
-VALUE cTCPSocket;
 VALUE SYM_libev;
 
 ID ID_ivar_is_nonblocking;
@@ -494,7 +493,7 @@ VALUE Backend_write_m(int argc, VALUE *argv, VALUE self) {
     Backend_writev(self, argv[0], argc - 1, argv + 1);
 }
 
-VALUE Backend_accept(VALUE self, VALUE sock) {
+VALUE Backend_accept(VALUE self, VALUE server_socket) {
   Backend_t *backend;
   struct libev_io watcher;
   rb_io_t *fptr;
@@ -502,12 +501,13 @@ VALUE Backend_accept(VALUE self, VALUE sock) {
   struct sockaddr addr;
   socklen_t len = (socklen_t)sizeof addr;
   VALUE switchpoint_result = Qnil;
-  VALUE underlying_sock = rb_ivar_get(sock, ID_ivar_io);
-  if (underlying_sock != Qnil) sock = underlying_sock;
+  VALUE socket_class = ConnectionSocketClass(server_socket);
+  VALUE underlying_sock = rb_ivar_get(server_socket, ID_ivar_io);
+  if (underlying_sock != Qnil) server_socket = underlying_sock;
 
   GetBackend(self, backend);
-  GetOpenFile(sock, fptr);
-  io_set_nonblock(fptr, sock);
+  GetOpenFile(server_socket, fptr);
+  io_set_nonblock(fptr, server_socket);
   watcher.fiber = Qnil;
   while (1) {
     fd = accept(fptr->fd, &addr, &len);
@@ -529,7 +529,7 @@ VALUE Backend_accept(VALUE self, VALUE sock) {
         goto error;
       }
 
-      socket = rb_obj_alloc(cTCPSocket);
+      socket = rb_obj_alloc(socket_class);
       MakeOpenFile(socket, fp);
       rb_update_max_fd(fd);
       fp->fd = fd;
@@ -550,7 +550,7 @@ error:
   return RAISE_EXCEPTION(switchpoint_result);
 }
 
-VALUE Backend_accept_loop(VALUE self, VALUE sock) {
+VALUE Backend_accept_loop(VALUE self, VALUE server_socket) {
   Backend_t *backend;
   struct libev_io watcher;
   rb_io_t *fptr;
@@ -559,12 +559,13 @@ VALUE Backend_accept_loop(VALUE self, VALUE sock) {
   socklen_t len = (socklen_t)sizeof addr;
   VALUE switchpoint_result = Qnil;
   VALUE socket = Qnil;
-  VALUE underlying_sock = rb_ivar_get(sock, ID_ivar_io);
-  if (underlying_sock != Qnil) sock = underlying_sock;
+  VALUE socket_class = ConnectionSocketClass(server_socket);
+  VALUE underlying_sock = rb_ivar_get(server_socket, ID_ivar_io);
+  if (underlying_sock != Qnil) server_socket = underlying_sock;
 
   GetBackend(self, backend);
-  GetOpenFile(sock, fptr);
-  io_set_nonblock(fptr, sock);
+  GetOpenFile(server_socket, fptr);
+  io_set_nonblock(fptr, server_socket);
   watcher.fiber = Qnil;
 
   while (1) {
@@ -586,7 +587,7 @@ VALUE Backend_accept_loop(VALUE self, VALUE sock) {
         goto error;
       }
 
-      socket = rb_obj_alloc(cTCPSocket);
+      socket = rb_obj_alloc(socket_class);
       MakeOpenFile(socket, fp);
       rb_update_max_fd(fd);
       fp->fd = fd;
@@ -849,8 +850,7 @@ VALUE Backend_kind(VALUE self) {
 void Init_Backend() {
   ev_set_allocator(xrealloc);
 
-  rb_require("socket");
-  cTCPSocket = rb_const_get(rb_cObject, rb_intern("TCPSocket"));
+  Init_SocketClasses();
 
   VALUE cBackend = rb_define_class_under(mPolyphony, "Backend", rb_cData);
   rb_define_alloc_func(cBackend, Backend_allocate);

data/lib/polyphony/extensions/socket.rb

@@ -19,17 +19,7 @@ class ::Socket
   end
 
   def recv(maxlen, flags = 0, outbuf = nil)
-    Thread.current.backend.recv(self, buf || +'', maxlen)
-    # outbuf ||= +''
-    # loop do
-    #   result = recv_nonblock(maxlen, flags, outbuf, **NO_EXCEPTION)
-    #   case result
-    #   when nil then raise IOError
-    #   when :wait_readable then Thread.current.backend.wait_io(self, false)
-    #   else
-    #     return result
-    #   end
-    # end
+    Thread.current.backend.recv(self, outbuf || +'', maxlen)
   end
 
   def recv_loop(&block)
@@ -210,3 +200,62 @@ class ::TCPServer
     @io.close
   end
 end
+
+class ::UNIXServer
+  alias_method :orig_accept, :accept
+ def accept
+    Thread.current.backend.accept(self)
+  end
+
+  def accept_loop(&block)
+    Thread.current.backend.accept_loop(self, &block)
+  end
+
+
+end
+
+class ::UNIXSocket
+  def recv(maxlen, flags = 0, outbuf = nil)
+    Thread.current.backend.recv(self, buf || +'', maxlen)
+  end
+
+  def recv_loop(&block)
+    Thread.current.backend.recv_loop(self, &block)
+  end
+  alias_method :read_loop, :recv_loop
+
+  def send(mesg, flags = 0)
+    Thread.current.backend.send(self, mesg)
+  end
+
+  def write(str, *args)
+    if args.empty?
+      Thread.current.backend.send(self, str)
+    else
+      Thread.current.backend.send(self, str + args.join)
+    end
+  end
+  alias_method :<<, :write
+
+  def readpartial(maxlen, str = nil)
+    @read_buffer ||= +''
+    result = Thread.current.backend.recv(self, @read_buffer, maxlen)
+    raise EOFError unless result
+
+    if str
+      str << @read_buffer
+    else
+      str = @read_buffer
+    end
+    @read_buffer = +''
+    str
+  end
+
+  def read_nonblock(len, str = nil, exception: true)
+    @io.read_nonblock(len, str, exception: exception)
+  end
+
+  def write_nonblock(buf, exception: true)
+    @io.write_nonblock(buf, exception: exception)
+  end
+end

data/lib/polyphony/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: 0.47.3
+  version: 0.47.4
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -386,6 +386,7 @@ files:
 - examples/io/tcpserver.rb
 - examples/io/tcpsocket.rb
 - examples/io/tunnel.rb
+- examples/io/unix_socket.rb
 - examples/io/zip.rb
 - examples/performance/fiber_resume.rb
 - examples/performance/fiber_transfer.rb