polyphony 0.49.2 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18278f9c013191fd5a96520a07e3b6e5c4bc088665a1b1a769b02552bd0e5448
-  data.tar.gz: 4e1e42fa5e2a6ddc6dcff7982415dd16246a0d75212aa2eb9ae7a97e030a2bdb
+  metadata.gz: '0682736e3fdca0ada986f4210f1bb25d682c75a7b9d297451c186b90c8025e13'
+  data.tar.gz: 5ff46620651c056983a6f73c879ca1c49acea22c0c7abcefb1a119cbe248cb77
 SHA512:
-  metadata.gz: 483158709045a9dc59fa75c912067c4fafbb02885e15f3fa57f482b97903a0c919abbb5ad19bea85837222a44d5ec2778f1e1421839c2e6a595a64e84f2d707d
-  data.tar.gz: c1162de70de5aa2d92804e7c4ccb3a372c5839d5600a7f68ae6f84363677a52f23923dbe8e407a84607ac4f0145736c7a5b9ada8b4956fd9c742cec182ed3a70
+  metadata.gz: cfbb8141b21cc9e56cdcd9a34fd55cd3b48573dcc3011f127ece5049b13ca2c7fa8a17c8525ba5996ab97afcbfc8e46064a3d68c79d71d44d40c274ff9051d2d
+  data.tar.gz: f31d711c88fe354b8ffd63e37f30887b1bfb5c3709d3760412ee4ec4ea06d14c0a17e668ddd750958295dc12307b96cf64874b1be4ed46b8564d04236114ee67

data/.github/workflows/test.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby: [2.6, 2.7]
+        ruby: [2.6, 2.7, 3.0]
 
     name: >-
       ${{matrix.os}}, ${{matrix.ruby}}

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+## 0.53.0
+
+- Implement `Backend#splice`, `Backend#splice_to_eof`, along with `IO#splice`, `IO#splice_to_eof`
+
+## 0.52.0
+
+- Polyphony is now compatible with Ruby 3.0
+- Add `Backend#sendv` method for sending multiple strings
+- Accept flags argument in `Backend#send` (#48)
+- Fix io_uring backend on Ruby 3.0 (#47)
+- Implement C-based public backend API: `Polyphony.backend_XXXX` methods
+- libev backend: Use` pidfd_open` for Linux 5.3+, otherwise use a libev child watcher
+- Use `:call` as default method in `#feed_loop`
+
+## 0.51.0
+
+- Implement `IO#feed_loop`, `Socket#feed_loop`
+- Fix error handling in `Process.kill_and_await`
+
+## 0.50.1
+
+- Set `IOSQE_ASYNC` flag in io_uring backend
+- Fix error handling in `Backend#waitpid`
+- Reimplement libev backend's `#waitpid` by using pidfd_open (in similar manner
+  to the io_uring backend)
+
+## 0.50.0
+
+- Use `Process::CLOCK_MONOTONIC` in Timer
+- Add `Timer#sleep`, `Timer#after`, `Timer#every`
+- Prevent fiber from being resumed after terminating
+- Add `Thread#fiber_index_of` method
+- Use `Backend#wait_event` in `Fiber#await`
+
 ## 0.49.2
 
 - Fix hang with 100s or more child fibers when terminating

data/Gemfile.lock

@@ -1,101 +1,50 @@
 PATH
   remote: .
   specs:
-    polyphony (0.49.2)
+    polyphony (0.53.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
     ast (2.4.0)
     builder (3.2.4)
     coderay (1.1.3)
-    colorator (1.1.0)
-    concurrent-ruby (1.1.6)
     docile (1.3.2)
-    em-websocket (0.5.1)
-      eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
-    eventmachine (1.2.7)
-    ffi (1.12.1)
-    forwardable-extended (2.6.0)
     hiredis (0.6.3)
     http_parser.rb (0.6.0)
     httparty (0.17.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    jekyll (3.8.6)
-      addressable (~> 2.4)
-      colorator (~> 1.0)
-      em-websocket (~> 0.5)
-      i18n (~> 0.7)
-      jekyll-sass-converter (~> 1.0)
-      jekyll-watch (~> 2.0)
-      kramdown (~> 1.14)
-      liquid (~> 4.0)
-      mercenary (~> 0.3.3)
-      pathutil (~> 0.9)
-      rouge (>= 1.7, < 4)
-      safe_yaml (~> 1.0)
-    jekyll-remote-theme (0.4.1)
-      addressable (~> 2.0)
-      jekyll (>= 3.5, < 5.0)
-      rubyzip (>= 1.3.0)
-    jekyll-sass-converter (1.5.2)
-      sass (~> 3.4)
-    jekyll-seo-tag (2.6.1)
-      jekyll (>= 3.3, < 5.0)
-    jekyll-watch (2.2.1)
-      listen (~> 3.0)
     json (2.3.0)
-    just-the-docs (0.3.0)
-      jekyll (>= 3.8.5)
-      jekyll-seo-tag (~> 2.0)
-      rake (>= 12.3.1, < 13.1.0)
-    kramdown (1.17.0)
-    liquid (4.0.3)
-    listen (3.2.1)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    mercenary (0.3.6)
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
-    minitest (5.13.0)
+    minitest (5.14.4)
     minitest-reporters (1.4.2)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
+    msgpack (1.4.2)
     multi_xml (0.6.0)
     mysql2 (0.5.3)
     parallel (1.19.1)
     parser (2.7.0.2)
       ast (~> 2.4.0)
-    pathutil (0.16.2)
-      forwardable-extended (~> 2.6)
     pg (1.1.4)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.3)
     rack (2.2.3)
     rainbow (3.0.0)
-    rake (12.3.3)
+    rake (13.0.3)
     rake-compiler (1.1.1)
       rake
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
     redis (4.1.0)
     regexp_parser (1.7.1)
     rexml (3.2.4)
-    rouge (3.15.0)
     rubocop (0.85.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
@@ -108,13 +57,6 @@ GEM
     rubocop-ast (0.0.3)
       parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
-    rubyzip (2.0.0)
-    safe_yaml (1.0.5)
-    sass (3.7.4)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
     sequel (5.34.0)
     simplecov (0.17.1)
       docile (~> 1.1)
@@ -130,12 +72,9 @@ DEPENDENCIES
   hiredis (= 0.6.3)
   http_parser.rb (~> 0.6.0)
   httparty (= 0.17.1)
-  jekyll (~> 3.8.6)
-  jekyll-remote-theme (~> 0.4.1)
-  jekyll-seo-tag (~> 2.6.1)
-  just-the-docs (~> 0.3.0)
-  minitest (= 5.13.0)
+  minitest (= 5.14.4)
   minitest-reporters (= 1.4.2)
+  msgpack (= 1.4.2)
   mysql2 (= 0.5.3)
   pg (= 1.1.4)
   polyphony!
@@ -148,4 +87,4 @@ DEPENDENCIES
   simplecov (= 0.17.1)
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/TODO.md

@@ -1,3 +1,8 @@
+- Add support for IPv6:
+  https://www.reddit.com/r/ruby/comments/lyen23/understanding_ipv6_and_why_its_important_to_you/
+
+- Add support for UDP sockets
+
 - Check segfault when resetting a `cancel_after` timeout lots of times at very high rate
 - Check why `throttled_loop` inside of `move_on_after` fails to stop
 
@@ -13,17 +18,46 @@
   - `Fiber#receive_loop` (very little effort, should be implemented in C)
 
 
-- Add `Backend#splice`, `Backend#splice_loop` for implementing stuff like proxying:
+- Add `Backend#splice`, `Backend#splice_to_eof` for implementing stuff like proxying:
 
   ```ruby
   def two_way_proxy(socket1, socket2)
     backend = Thread.current.backend
-    f1 = spin { backend.splice_loop(socket1, socket2) }
-    f2 = spin { backend.splice_loop(socket2, socket1) }
+    f1 = spin { backend.splice_to_eof(socket1, socket2) }
+    f2 = spin { backend.splice_to_eof(socket2, socket1) }
     Fiber.await(f1, f2)
   end
   ```
 
+- Add support for `close` to io_uring backend
+
+- Add support for submission of multiple requests to io_uring backend:
+
+  ```ruby
+  Thread.current.backend.submit(
+    [sock, :<<, chunk_header(len)],
+    [sock, :splice, file, len]
+  )
+  ```
+
+  Full example (for writing chunks from a file to an HTTP response):
+
+  ```ruby
+  def serve_io(io)
+    i, o = IO.pipe
+    backend = Thread.current.backend
+    while true
+      len = o.splice(io, 8192)
+      break if len == 0
+      
+      backend.submit(
+        [sock, :<<, chunk_header(len)],
+        [sock, :splice, file, len]
+      )
+    end
+  end
+  ```
+
 - Graceful shutdown again:
   - What happens to children when doing a graceful shutdown?
   - What are the implications of passing graceful shutdown flag to children?

data/examples/core/forking.rb

@@ -5,7 +5,7 @@ require 'polyphony'
 
 puts "parent pid: #{Process.pid}"
 
-pid = Polyphony.fork do
+pid = fork do
   puts "child pid: #{Process.pid}"
 
   spin do
@@ -20,5 +20,5 @@ end
 puts "got child pid #{pid}"
 
 puts 'parent waiting for child'
-Thread.current.backend.waitpid(pid)
+Polyphony.backend_waitpid(pid)
 puts 'parent done waiting'

data/examples/core/nested.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+
+def process
+  p :b_start
+  sleep 1
+  p :b_stop
+end
+
+spin do
+  p :a_start
+  spin { process }
+  sleep 60
+  p :a_stop
+end
+
+p :main_start
+sleep 120
+p :main_stop

data/examples/core/suspend.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+
+main = Fiber.current
+spin do
+  sleep 0.1
+  main.schedule(:foo)
+end
+
+v = suspend
+puts "v => #{v.inspect}"

data/examples/core/terminate_main_fiber.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+
+main = Fiber.current
+spin do
+  sleep 0.1
+  main.terminate
+end
+
+sleep

data/examples/io/echo_server.rb

@@ -9,6 +9,7 @@ puts 'Echoing on port 1234...'
 while (client = server.accept)
   spin do
     while (data = client.gets)
+      # client.send("you said: #{data.chomp}!\n", 0)
       client.write('you said: ', data.chomp, "!\n")
     end
   rescue Errno::ECONNRESET

data/examples/io/tcp_proxy.rb

@@ -15,7 +15,7 @@ f1 = spin {
   client1 = server1.accept
   loop do
     if client2
-      Thread.current.backend.splice_loop(client1, client2)
+      Thread.current.backend.splice_to_eof(client1, client2)
     end
   end
 }
@@ -24,7 +24,7 @@ f2 = spin {
   client2 = server2.accept
   loop do
     if client1
-      Thread.current.backend.splice_loop(client2, client1)
+      Thread.current.backend.splice_to_eof(client2, client1)
     end
   end
 }

data/ext/polyphony/backend_common.h

@@ -3,6 +3,17 @@
 #include "ruby.h"
 #include "ruby/io.h"
 
+
+#ifdef POLYPHONY_USE_PIDFD_OPEN
+#ifndef __NR_pidfd_open
+#define __NR_pidfd_open 434   /* System call # on most architectures */
+#endif
+
+static int pidfd_open(pid_t pid, unsigned int flags) {
+  return syscall(__NR_pidfd_open, pid, flags);
+}
+#endif
+
 //////////////////////////////////////////////////////////////////////
 //////////////////////////////////////////////////////////////////////
 // the following is copied verbatim from the Ruby source code (io.c)
@@ -15,11 +26,11 @@ struct io_internal_read_struct {
 
 #define StringValue(v) rb_string_value(&(v))
 
-inline int io_setstrbuf(VALUE *str, long len) {
+int io_setstrbuf(VALUE *str, long len) {
   #ifdef _WIN32
     len = (len + 1) & ~1L;	/* round up for wide char */
   #endif
-  if (NIL_P(*str)) {
+  if (*str == Qnil) {
     *str = rb_str_new(0, len);
     return 1;
   }
@@ -44,7 +55,7 @@ inline void io_shrink_read_string(VALUE str, long n) {
   }
 }
 
-inline void io_set_read_length(VALUE str, long n, int shrinkable) {
+void io_set_read_length(VALUE str, long n, int shrinkable) {
   if (RSTRING_LEN(str) != n) {
     rb_str_modify(str);
     rb_str_set_len(str, n);
@@ -59,7 +70,7 @@ inline rb_encoding* io_read_encoding(rb_io_t *fptr) {
     return rb_default_external_encoding();
 }
 
-inline VALUE io_enc_str(VALUE str, rb_io_t *fptr) {
+VALUE io_enc_str(VALUE str, rb_io_t *fptr) {
     OBJ_TAINT(str);
     rb_enc_associate(str, io_read_encoding(fptr));
     return str;
@@ -99,6 +110,13 @@ inline VALUE backend_snooze() {
   READ_LOOP_PREPARE_STR(); \
 }
 
+#define READ_LOOP_PASS_STR_TO_RECEIVER(receiver, method_id) { \
+  io_set_read_length(str, total, shrinkable); \
+  io_enc_str(str, fptr); \
+  rb_funcall_passing_block(receiver, method_id, 1, &str); \
+  READ_LOOP_PREPARE_STR(); \
+}
+
 inline void rectify_io_file_pos(rb_io_t *fptr) {
   // Apparently after reopening a closed file, the file position is not reset,
   // which causes the read to fail. Fortunately we can use fptr->rbuf.len to
@@ -114,16 +132,48 @@ inline double current_time() {
   struct timespec ts;
   clock_gettime(CLOCK_MONOTONIC, &ts);
   long long ns = ts.tv_sec;
-  ns = ns * 1000000000 + ts.tv_nsec;
+  ns = ns * 1e9 + ts.tv_nsec;
   double t = ns;
   return t / 1e9;
 }
 
 inline VALUE backend_timeout_exception(VALUE exception) {
-  if (RTEST(rb_obj_is_kind_of(exception, rb_cArray)))
+  if (rb_obj_is_kind_of(exception, rb_cArray) == Qtrue)
     return rb_funcall(rb_ary_entry(exception, 0), ID_new, 1, rb_ary_entry(exception, 1));
-  else if (RTEST(rb_obj_is_kind_of(exception, rb_cClass)))
+  else if (rb_obj_is_kind_of(exception, rb_cClass) == Qtrue)
     return rb_funcall(exception, ID_new, 0);
   else
     return rb_funcall(rb_eRuntimeError, ID_new, 1, exception);
-}
+}
+
+VALUE Backend_timeout_safe(VALUE arg) {
+  return rb_yield(arg);
+}
+
+VALUE Backend_timeout_rescue(VALUE arg, VALUE exception) {
+  return exception;
+}
+
+VALUE Backend_timeout_ensure_safe(VALUE arg) {
+  return rb_rescue2(Backend_timeout_safe, Qnil, Backend_timeout_rescue, Qnil, rb_eException, (VALUE)0);
+}
+
+static VALUE empty_string = Qnil;
+
+VALUE Backend_sendv(VALUE self, VALUE io, VALUE ary, VALUE flags) {
+  switch (RARRAY_LEN(ary)) {
+  case 0:
+    return Qnil;
+  case 1:
+    return Backend_send(self, io, RARRAY_AREF(ary, 0), flags);
+  default:
+    if (empty_string == Qnil) {
+      empty_string = rb_str_new_literal("");
+      rb_global_variable(&empty_string);
+    }
+    VALUE joined = rb_ary_join(ary, empty_string);
+    VALUE result = Backend_send(self, io, joined, flags);
+    RB_GC_GUARD(joined);
+    return result;
+  }
+}