polyphony 0.46.0 → 0.46.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 890abc2b84ed305f591c697764ea16255059aeb3cd4ddd23195b81f78f5f6daf
-  data.tar.gz: a02442318f82682ba1fa3a87e2b4e7ad8ae06d365a7d4a4b5c45689b2e55472f
+  metadata.gz: 831c85a16a22fe3877044430a4d1cc4a270d18dc73e9ceca8d4826623ab0ddc8
+  data.tar.gz: f0432473abb769be2805ad354dddf44465789ebe2d5220f194660e4c6521ec87
 SHA512:
-  metadata.gz: 506a2fdbdee9e6c5bb94b976489537792941326080441f3d93924cd9657db5188b29e4ced6e1c8a6f8db06ae211da0522b3ac042e45365be1af2e68f8b157b0e
-  data.tar.gz: cbc0e333731e035c2094abfa72d425e649c210a8c9d3aec467446f615315cfc6e1f6de664321099ccdf93ddd6e1bb0ba484b2b8b53922725b2df8483aedefeab
+  metadata.gz: 9bfecbed04a8052c3a885dfde73975694313801d2a8341260041be84e4910ac459af71766f7df6fa96e5afad66a737b97e36531811bd47cab407ad43b239e073
+  data.tar.gz: 2caa40f7193cf1954b69adc5810844ad4e578a4472382602a6ee4204d548e8327344f913bc0aef076030e7deacb911cab1733b281f7a2e8849ffcbd009a00ebc

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.46.1
+
+* Add `TCPServer#accept_loop`, `OpenSSL::SSL::SSLSocket#accept_loop` method
+* Fix compilation error on MacOS (#43)
+* Fix backtrace for `Timeout.timeout`
+* Add `Backend#timer_loop`
+
 ## 0.46.0
 
 * Implement [io_uring backend](https://github.com/digital-fabric/polyphony/pull/44)

data/Gemfile.lock

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

data/TODO.md

@@ -1,16 +1,24 @@
-- change fiber_trace method to return nil, change trace logic to use provided
-  arguments instead of return values for fiber events
-- allow backend selection at runtime
-- add Backend#timer_loop that does what throttled_loop does, on lower level
-- Adapter for io/console (what does `IO#raw` do?)
-- Adapter for Pry and IRB (Which fixes #5 and #6)
+## Roadmap for Polyphony 1.0
+
+- Check why worker-thread example doesn't work.
+- Add test that mimics the original design for Monocrono:
+  - 256 fibers each waiting for a message
+  - When message received do some blocking work using a `ThreadPool`
+  - Send messages, collect responses, check for correctness
 - Improve `#supervise`. It does not work as advertised, and seems to exhibit an
   inconsistent behaviour (see supervisor example).
-- Fix backtrace for `Timeout.timeout` API (see timeout example).
-- Check why worker-thread example doesn't work.
 
-0.47
+- io_uring
+  - Use playground.c to find out why we when submitting and waiting for
+    completion in single syscall signals seem to be blocked until the syscall
+    returns. Is this a bug in io_uring/liburing?
 
+-----------------------------------------------------
+
+- Add `Backend#splice(in, out, nbytes)` API
+- Adapter for io/console (what does `IO#raw` do?)
+- Adapter for Pry and IRB (Which fixes #5 and #6)
+- allow backend selection at runtime
 - Debugging
   - Eat your own dogfood: need a good tool to check what's going on when some
     test fails
@@ -148,6 +156,11 @@
   - `IO.foreach`
   - `Process.waitpid`
 
+### Quic / HTTP/3
+
+- Python impl: https://github.com/aiortc/aioquic/
+- Go impl: https://github.com/lucas-clemente/quic-go
+
 ### DNS client
 
 ```ruby

data/bin/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+clear && POLYPHONY_USE_LIBEV=1 rake recompile && ruby test/run.rb
+clear && rake recompile && ruby test/run.rb

data/examples/performance/fiber_transfer.rb

@@ -12,6 +12,7 @@ end
 def run(num_fibers)
   count = 0
 
+  GC.start
   GC.disable
 
   first = nil
@@ -36,13 +37,21 @@ def run(num_fibers)
   last.next = first
   
   t0 = Time.now
+  puts "start transfer..."
   first.transfer
   elapsed = Time.now - t0
 
-  puts "fibers: #{num_fibers} count: #{count} rate: #{count / elapsed}"
-  GC.start
+  rss = `ps -o rss= -p #{Process.pid}`.to_i
+
+  puts "fibers: #{num_fibers} rss: #{rss} count: #{count} rate: #{count / elapsed}"
+rescue Exception => e
+  puts "Stopped at #{count} fibers"
+  p e
 end
 
+puts "pid: #{Process.pid}"
 run(100)
-run(1000)
-run(10000)
+# run(1000)
+# run(10000)
+# run(100000)
+# run(400000)

data/examples/performance/thread-vs-fiber/polyphony_server.rb

@@ -4,41 +4,30 @@ require 'bundler/setup'
 require 'polyphony'
 require 'http/parser'
 
-$connection_count = 0
-
 def handle_client(socket)
-  $connection_count += 1
+  pending_requests = []
   parser = Http::Parser.new
-  reqs = []
-  parser.on_message_complete = proc do |env|
-    reqs << Object.new # parser
-  end
+  parser.on_message_complete = proc { pending_requests << parser }
+
   socket.recv_loop do |data|
     parser << data
-    while (req = reqs.shift)
-      handle_request(socket, req)
-      req = nil
-    end
+    write_response(socket) while pending_requests.shift
   end
 rescue IOError, SystemCallError => e
   # do nothing
 ensure
-  $connection_count -= 1
   socket&.close
 end
 
-def handle_request(client, parser)
+def write_response(socket)
   status_code = "200 OK"
   data = "Hello world!\n"
   headers = "Content-Type: text/plain\r\nContent-Length: #{data.bytesize}\r\n"
-  client.write "HTTP/1.1 #{status_code}\r\n#{headers}\r\n#{data}"
+  socket.write "HTTP/1.1 #{status_code}\r\n#{headers}\r\n#{data}"
 end
 
 server = TCPServer.open('0.0.0.0', 1234)
 puts "pid #{Process.pid}"
 puts "listening on port 1234"
 
-loop do
-  client = server.accept
-  spin { handle_client(client) }
-end
+server.accept_loop { |c| handle_client(c) }

data/ext/polyphony/backend_common.h

@@ -1,3 +1,5 @@
+#include <time.h>
+
 #include "ruby.h"
 #include "ruby/io.h"
 
@@ -107,3 +109,12 @@ inline void rectify_io_file_pos(rb_io_t *fptr) {
     fptr->rbuf.len = 0;
   }
 }
+
+inline double current_time() {
+  struct timespec ts;
+  clock_gettime(CLOCK_MONOTONIC, &ts);
+  long long ns = ts.tv_sec;
+  ns = ns * 1000000000 + ts.tv_nsec;
+  double t = ns;
+  return t / 1e9;
+}

data/ext/polyphony/backend_io_uring.c

@@ -7,18 +7,18 @@
 #include <fcntl.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
-
-#include "polyphony.h"
-#include "../liburing/liburing.h"
-#include "ruby/thread.h"
-#include "backend_io_uring_context.h"
-
+#include <stdnoreturn.h>
 #include <poll.h>
 #include <sys/types.h>
 #include <sys/eventfd.h>
 #include <sys/wait.h>
 #include <errno.h>
 
+#include "polyphony.h"
+#include "../liburing/liburing.h"
+#include "ruby/thread.h"
+#include "backend_io_uring_context.h"
+
 #ifndef __NR_pidfd_open
 #define __NR_pidfd_open 434   /* System call # on most architectures */
 #endif
@@ -304,6 +304,7 @@ int io_uring_backend_defer_submit_and_await(
 
   if (value_ptr) (*value_ptr) = switchpoint_result;
   RB_GC_GUARD(switchpoint_result);
+  RB_GC_GUARD(ctx->fiber);
   return ctx->result;
 }
 
@@ -773,29 +774,62 @@ VALUE Backend_wait_io(VALUE self, VALUE io, VALUE write) {
   return self;
 }
 
-VALUE Backend_sleep(VALUE self, VALUE duration) {
-  Backend_t *backend;
-  struct io_uring_sqe *sqe;
+// returns true if completed, 0 otherwise
+int io_uring_backend_submit_timeout_and_await(Backend_t *backend, double duration, VALUE *resume_value) {
   double duration_integral;
-  double duration_fraction = modf(NUM2DBL(duration), &duration_integral);
+  double duration_fraction = modf(duration, &duration_integral);
   struct __kernel_timespec ts;
 
-  GetBackend(self, backend);
-  sqe = io_uring_get_sqe(&backend->ring);
+  struct io_uring_sqe *sqe = io_uring_get_sqe(&backend->ring);
   ts.tv_sec = duration_integral;
 	ts.tv_nsec = floor(duration_fraction * 1000000000);
   
-  VALUE resume_value = Qnil;
   op_context_t *ctx = OP_CONTEXT_ACQUIRE(&backend->store, OP_TIMEOUT);
   io_uring_prep_timeout(sqe, &ts, 0, 0);
 
-  io_uring_backend_defer_submit_and_await(backend, sqe, ctx, &resume_value);
+  io_uring_backend_defer_submit_and_await(backend, sqe, ctx, resume_value);
   OP_CONTEXT_RELEASE(&backend->store, ctx);
+  return ctx->completed;
+}
+
+VALUE Backend_sleep(VALUE self, VALUE duration) {
+  Backend_t *backend;
+  GetBackend(self, backend);
+
+  VALUE resume_value = Qnil;
+  io_uring_backend_submit_timeout_and_await(backend, NUM2DBL(duration), &resume_value);
   RAISE_IF_EXCEPTION(resume_value);
   RB_GC_GUARD(resume_value);
   return resume_value;
 }
 
+VALUE Backend_timer_loop(VALUE self, VALUE interval) {
+  Backend_t *backend;
+  double interval_d = NUM2DBL(interval);
+  GetBackend(self, backend);
+  double next_time = 0.;
+
+  while (1) {
+    double now = current_time();
+    if (next_time == 0.) next_time = current_time() + interval_d;
+    double sleep_duration = next_time - now;
+    if (sleep_duration < 0) sleep_duration = 0;
+    
+    VALUE resume_value = Qnil;
+    int completed = io_uring_backend_submit_timeout_and_await(backend, sleep_duration, &resume_value);
+    RAISE_IF_EXCEPTION(resume_value);
+    if (!completed) return resume_value;
+    RB_GC_GUARD(resume_value);
+
+    rb_yield(Qnil);
+
+    while (1) {
+      next_time += interval_d;
+      if (next_time > now) break;
+    }
+  }
+}
+
 VALUE Backend_waitpid(VALUE self, VALUE pid) {
   Backend_t *backend;
   int pid_int = NUM2INT(pid);
@@ -864,6 +898,7 @@ void Init_Backend() {
   rb_define_method(cBackend, "connect", Backend_connect, 3);
   rb_define_method(cBackend, "wait_io", Backend_wait_io, 2);
   rb_define_method(cBackend, "sleep", Backend_sleep, 1);
+  rb_define_method(cBackend, "timer_loop", Backend_timer_loop, 1);
   rb_define_method(cBackend, "waitpid", Backend_waitpid, 1);
   rb_define_method(cBackend, "wait_event", Backend_wait_event, 1);
 

data/ext/polyphony/backend_libev.c

@@ -7,6 +7,7 @@
 #include <fcntl.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
+#include <stdnoreturn.h>
 
 #include "polyphony.h"
 #include "../libev/ev.h"
@@ -688,6 +689,39 @@ VALUE Backend_sleep(VALUE self, VALUE duration) {
   return switchpoint_result;
 }
 
+noreturn VALUE Backend_timer_loop(VALUE self, VALUE interval) {
+  Backend_t *backend;
+  struct libev_timer watcher;
+  double interval_d = NUM2DBL(interval);
+
+  GetBackend(self, backend);
+  watcher.fiber = rb_fiber_current();
+
+  double next_time = 0.;
+
+  while (1) {
+    double now = current_time();
+    if (next_time == 0.) next_time = current_time() + interval_d;
+    double sleep_duration = next_time - now;
+    if (sleep_duration < 0) sleep_duration = 0;
+    
+    VALUE switchpoint_result = Qnil;    
+    ev_timer_init(&watcher.timer, Backend_timer_callback, sleep_duration, 0.);
+    ev_timer_start(backend->ev_loop, &watcher.timer);
+    switchpoint_result = backend_await(backend);
+    ev_timer_stop(backend->ev_loop, &watcher.timer);
+    RAISE_IF_EXCEPTION(switchpoint_result);
+    RB_GC_GUARD(switchpoint_result);
+
+    rb_yield(Qnil);
+
+    while (1) {
+      next_time += interval_d;
+      if (next_time > now) break;
+    }
+  }
+}
+
 struct libev_child {
   struct ev_child child;
   VALUE fiber;
@@ -777,6 +811,7 @@ void Init_Backend() {
   rb_define_method(cBackend, "send", Backend_write, 2);
   rb_define_method(cBackend, "wait_io", Backend_wait_io, 2);
   rb_define_method(cBackend, "sleep", Backend_sleep, 1);
+  rb_define_method(cBackend, "timer_loop", Backend_timer_loop, 1);
   rb_define_method(cBackend, "waitpid", Backend_waitpid, 1);
   rb_define_method(cBackend, "wait_event", Backend_wait_event, 1);
 

data/ext/polyphony/fiber.c

@@ -21,7 +21,7 @@ VALUE SYM_fiber_terminate;
 
 static VALUE Fiber_safe_transfer(int argc, VALUE *argv, VALUE self) {
   VALUE arg = (argc == 0) ? Qnil : argv[0];
-  VALUE ret = rb_funcall(self, ID_transfer, 1, arg);
+  VALUE ret = FIBER_TRANSFER(self, arg);
 
   RAISE_IF_EXCEPTION(ret);
   RB_GC_GUARD(ret);
@@ -42,10 +42,6 @@ inline VALUE Fiber_auto_watcher(VALUE self) {
 void Fiber_make_runnable(VALUE fiber, VALUE value) {
   VALUE thread = rb_ivar_get(fiber, ID_ivar_thread);
   if (thread == Qnil) {
-    INSPECT("Fiber with no thread", fiber);
-    TRACE_CALLER();
-    TRACE_C_STACK();
-    exit(-1);
     rb_raise(rb_eRuntimeError, "No thread set for fiber");
     // rb_warn("No thread set for fiber");
     return;
@@ -57,7 +53,6 @@ void Fiber_make_runnable(VALUE fiber, VALUE value) {
 void Fiber_make_runnable_with_priority(VALUE fiber, VALUE value) {
   VALUE thread = rb_ivar_get(fiber, ID_ivar_thread);
   if (thread == Qnil) {
-    INSPECT("Fiber with no thread", fiber);
     rb_raise(rb_eRuntimeError, "No thread set for fiber");
     // rb_warn("No thread set for fiber");
     return;

data/ext/polyphony/polyphony.h

@@ -23,12 +23,15 @@
 #define TRACE(...)  rb_funcall(rb_cObject, ID_fiber_trace, __VA_ARGS__)
 #define COND_TRACE(...) if (__tracing_enabled__) { TRACE(__VA_ARGS__); }
 
+// exceptions
 #define TEST_EXCEPTION(ret) (RTEST(rb_obj_is_kind_of(ret, rb_eException)))
-
 #define RAISE_EXCEPTION(e) rb_funcall(e, ID_invoke, 0);
 #define RAISE_IF_EXCEPTION(ret) if (RTEST(rb_obj_is_kind_of(ret, rb_eException))) { RAISE_EXCEPTION(ret); }
 #define RAISE_IF_NOT_NIL(ret) if (ret != Qnil) { RAISE_EXCEPTION(ret); }
 
+// Fiber#transfer
+#define FIBER_TRANSFER(fiber, value) rb_funcall(fiber, ID_transfer, 1, value)
+
 extern backend_interface_t backend_interface;
 #define __BACKEND__ (backend_interface)
 

data/ext/polyphony/thread.c

@@ -4,7 +4,6 @@ ID ID_deactivate_all_watchers_post_fork;
 ID ID_ivar_backend;
 ID ID_ivar_join_wait_queue;
 ID ID_ivar_main_fiber;
-ID ID_ivar_result;
 ID ID_ivar_terminated;
 ID ID_ivar_runqueue;
 ID ID_stop;
@@ -116,7 +115,7 @@ VALUE Thread_switch_fiber(VALUE self) {
   RB_GC_GUARD(next.fiber);
   RB_GC_GUARD(next.value);
   return (next.fiber == current_fiber) ?
-    next.value : rb_funcall(next.fiber, ID_transfer, 1, next.value);
+    next.value : FIBER_TRANSFER(next.fiber, next.value);
 }
 
 VALUE Thread_reset_fiber_scheduling(VALUE self) {
@@ -162,7 +161,6 @@ void Init_Thread() {
   ID_ivar_backend                       = rb_intern("@backend");
   ID_ivar_join_wait_queue               = rb_intern("@join_wait_queue");
   ID_ivar_main_fiber                    = rb_intern("@main_fiber");
-  ID_ivar_result                        = rb_intern("@result");
   ID_ivar_terminated                    = rb_intern("@terminated");
   ID_ivar_runqueue                      = rb_intern("@runqueue");
   ID_stop                               = rb_intern("stop");

data/lib/polyphony/core/exceptions.rb

@@ -14,10 +14,6 @@ module Polyphony
       @caller_backtrace = caller
       @value = value
     end
-
-    def backtrace
-      sanitize(@caller_backtrace)
-    end
   end
 
   # MoveOn is used to interrupt a long-running blocking operation, while

data/lib/polyphony/core/global_api.rb

@@ -20,15 +20,20 @@ module Polyphony
       canceller = spin do
         sleep interval
         exception = cancel_exception(with_exception)
+        # we don't want the cancelling fiber caller location as part of the
+        # exception backtrace
+        exception.__raising_fiber__ = nil
         fiber.schedule exception
       end
       block ? cancel_after_wrap_block(canceller, &block) : canceller
     end
 
     def cancel_exception(exception)
-      return exception.new if exception.is_a?(Class)
-
-      RuntimeError.new(exception)
+      case exception
+      when Class then exception.new
+      when Array then exception[0].new(exception[1])
+      else RuntimeError.new(exception)
+      end
     end
 
     def cancel_after_wrap_block(canceller, &block)

data/lib/polyphony/extensions/core.rb

@@ -12,7 +12,7 @@ class ::Exception
     attr_accessor :__disable_sanitized_backtrace__
   end
 
-  attr_accessor :source_fiber
+  attr_accessor :source_fiber, :__raising_fiber__
 
   alias_method :orig_initialize, :initialize
   def initialize(*args)
@@ -22,8 +22,8 @@ class ::Exception
 
   alias_method :orig_backtrace, :backtrace
   def backtrace
-    unless @first_backtrace_call
-      @first_backtrace_call = true
+    unless @backtrace_called
+      @backtrace_called = true
       return orig_backtrace
     end
 
@@ -31,12 +31,10 @@ class ::Exception
   end
 
   def sanitized_backtrace
-    if @__raising_fiber__
-      backtrace = orig_backtrace || []
-      sanitize(backtrace + @__raising_fiber__.caller)
-    else
-      sanitize(orig_backtrace)
-    end
+    return sanitize(orig_backtrace) unless @__raising_fiber__
+
+    backtrace = orig_backtrace || []
+    sanitize(backtrace + @__raising_fiber__.caller)
   end
 
   POLYPHONY_DIR = File.expand_path(File.join(__dir__, '..'))
@@ -164,11 +162,7 @@ end
 
 # Override Timeout to use cancel scope
 module ::Timeout
-  def self.timeout(sec, klass = nil, message = nil, &block)
-    cancel_after(sec, &block)
-  rescue Polyphony::Cancel => e
-    error = klass ? klass.new(message) : ::Timeout::Error.new
-    error.set_backtrace(e.backtrace)
-    raise error
+  def self.timeout(sec, klass = Timeout::Error, message = 'execution expired', &block)
+    cancel_after(sec, with_exception: [klass, message], &block)
   end
 end

data/lib/polyphony/extensions/openssl.rb

@@ -36,6 +36,12 @@ class ::OpenSSL::SSL::SSLSocket
     end
   end
 
+  def accept_loop
+    loop do
+      yield accept
+    end
+  end
+
   alias_method :orig_sysread, :sysread
   def sysread(maxlen, buf = +'')
     loop do

data/lib/polyphony/extensions/socket.rb

@@ -191,6 +191,10 @@ class ::TCPServer
     @io.accept
   end
 
+  def accept_loop(&block)
+    Thread.current.backend.accept_loop(@io, &block)
+  end
+
   alias_method :orig_close, :close
   def close
     @io.close

data/lib/polyphony/version.rb

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

data/test/helper.rb

@@ -85,4 +85,4 @@ module Minitest::Assertions
   end
 end
 
-puts "Polyphony backend: #{Thread.current.backend.kind}"
+puts "Polyphony backend: #{Thread.current.backend.kind}"

data/test/stress.rb

@@ -2,7 +2,7 @@
 
 count = ARGV[0] ? ARGV[0].to_i : 100
 
-TEST_CMD = 'ruby test/test_backend.rb' #'ruby test/run.rb'
+TEST_CMD = 'ruby test/run.rb'
 
 def run_test(count)
   puts "#{count}: running tests..."

data/test/test_backend.rb

@@ -125,4 +125,15 @@ class BackendTest < MiniTest::Test
     snooze
     server&.close
   end
+
+  def test_timer_loop
+    i = 0
+    f = spin do
+      @backend.timer_loop(0.01) { i += 1 }
+    end
+    @backend.sleep(0.05)
+    f.stop
+    f.await # TODO: check why this test sometimes segfaults if we don't a<wait fiber
+    assert_in_range 4..6, i
+  end
 end

data/test/test_global_api.rb

@@ -202,6 +202,19 @@ class CancelAfterTest < MiniTest::Test
       end
     end
 
+    begin
+      err = nil
+      cancel_after(0.01, with_exception: [CustomException, 'custom message']) do
+        sleep 1
+        :foo
+      end
+    rescue Exception => err
+    ensure
+      assert_kind_of CustomException, err
+      assert_equal 'custom message', err.message
+    end
+
+
     begin
       e = nil
       cancel_after(0.01, with_exception: 'foo') do

data/test/test_queue.rb

@@ -129,4 +129,4 @@ class QueueTest < MiniTest::Test
 
     assert_equal 0, @queue.size
   end
-end
+end

data/test/test_socket.rb

@@ -40,12 +40,12 @@ class HTTPClientTest < MiniTest::Test
   def test_http
     res = HTTParty.get('http://worldtimeapi.org/api/timezone/Europe/Paris')
     response = JSON.load(res.body)
-    assert_equal "CEST", response['abbreviation']
+    assert_equal "CET", response['abbreviation']
   end
 
   def test_https
     res = HTTParty.get('https://worldtimeapi.org/api/timezone/Europe/Paris')
     response = JSON.load(res.body)
-    assert_equal "CEST", response['abbreviation']
+    assert_equal "CET", response['abbreviation']
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: 0.46.0
+  version: 0.46.1
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -290,6 +290,7 @@ files:
 - TODO.md
 - bin/polyphony-debug
 - bin/stress.rb
+- bin/test
 - docs/_config.yml
 - docs/_includes/head.html
 - docs/_includes/title.html