polyphony 0.47.5.1 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4b0d95763e1c95248c83f2b649bdafa609e5a3877ea381afa1ce7253b340904
-  data.tar.gz: c25589fd2a4433d21778281a631b364b5505ce27c9fe3f349d2a357a3dd30f97
+  metadata.gz: 2aac80a08ca16498c3ee0044b0ba6de039b179425051cbcee67af4c9b948c349
+  data.tar.gz: bbe016d6b2ad3c5c89129089f9ebb8457a37159e03be2ff84f2572454880b0c2
 SHA512:
-  metadata.gz: 2637f2f6aa6531e6b8bc62035a028caffd027d65668b1a1f6b957c9f89045d148b790003856ece2213ccf882e1eab12068578cce8ba0c8882213f3e8f9a125f3
-  data.tar.gz: '0009c9eae3b3fc52239d26bc836d7a1b4d2bd24d922c02f9a986fbed5d26f76b618777422efe9909aaff27164cc53de9d7083f9b784bc5534b387e6735dc7be6'
+  metadata.gz: 2f91d0b40bceb4600e4bbd22f39cdbd6bfd4ac5b5fc038f77deb7d26a464ce3cad177884f9aadde60c78bc48df170ab6909c44d133283af3abf77a090ac58332
+  data.tar.gz: 37dfa412a25f41dd704a203a865817bf273a23db0ccbe1bbec1a3f6017b9cd953301d67077e3b58601485f4dd96db94bef77da3d46cabd57fb563d3652173175

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## 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
+- Fix double pending_count increment in io_uring backend
+
+## 0.49.1
+
+- Use `TCPSocket` instead of `Socket` in `Net.tcp_connect`
+- Catch `Errno::ERSCH` in `Process.kill_and_await`
+- Set io_uring queue size to 2048
+
+## 0.49.0
+
+- Implement `Polyphony::Timer` for performant timeouts
+
+## 0.48.0
+
+- Implement graceful shutdown
+- Add support for `break` / `StopIteration` in `spin_loop`
+- Fix `IO#gets`, `IO#readpartial`
+
 ## 0.47.5.1
 
 - Add missing `Socket#accept_loop` method

data/Gemfile.lock

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

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Sharon Rosner
+Copyright (c) 2021 Sharon Rosner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/TODO.md

@@ -1,29 +1,49 @@
-- Graceful shutdown again:
+- 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
+
+- Commented out `io_uring_sqe_set_flags(sqe, IOSQE_ASYNC);` in `io_uring_backend_defer_submit_and_await`:
+  - This flag should be set for I/O ops, not for other stuff
+
+- Override stock `::SizedQueue` impl with Queue with capacity
 
-  - Fiber API:
-    - `Fiber#terminate(graceul)` - with a graceful flag
-    - `Fiber#terminate_all_children(graceful)` - with a graceful flag
-    - `Fiber#shutdown_all_children(graceful)` - with a graceful flag
+- Add support for `break` and `StopIteration` in all loops (with tests)
 
-  - Set graceful termination in `@graceful_shutdown`
-  - Add `Fiber#graceful_shutdown?` method
-    - Returns `@graceful_shutdown`
+- Change `IO#gets` to use `String#split` to cut into lines, much faster (see
+  examples/performance/line_splitting.rb)
+
+- 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)
 
-  And then we have:
+
+- Add `Backend#splice`, `Backend#splice_loop` for implementing stuff like proxying:
 
   ```ruby
-  spin do
-    loop { do_some_stuff }
-  ensure
-    shutdown_gracefully if Fiber.current.graceful_shutdown?
+  def two_way_proxy(socket1, socket2)
+    backend = Thread.current.backend
+    f1 = spin { backend.splice_loop(socket1, socket2) }
+    f2 = spin { backend.splice_loop(socket2, socket1) }
+    Fiber.await(f1, f2)
   end
   ```
 
+- Graceful shutdown again:
+  - What happens to children when doing a graceful shutdown?
+  - What are the implications of passing graceful shutdown flag to children?
+  - What about errors while doing a graceful shutdown?
+  - What about graceful restarts?
+  - Some interesting discussions:
+    - https://trio.discourse.group/search?q=graceful%20shutdown
+    - https://github.com/python-trio/trio/issues/147
+    - https://github.com/python-trio/trio/issues/143
+    - https://trio.discourse.group/t/graceful-shutdown/93/2
+    - https://250bpm.com/blog:146/
+    - https://www.rodrigoaraujo.me/posts/golang-pattern-graceful-shutdown-of-concurrent-events/
+    - https://github.com/tj/go-gracefully
   - `Fiber#finalize_children` should pass graceful shutdown flag to children
-
-- 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)
+  - A good use case is an HTTP server that on graceful shutdown:
+    - stops listening
+    - waits for all ongoing requests to finish, optionally with a timeout
 
 ## Roadmap for Polyphony 1.0
 

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/tcp_proxy.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+
+server1 = TCPServer.open('127.0.0.1', 1234)
+server2 = TCPServer.open('127.0.0.1', 1235)
+
+puts "Pid: #{Process.pid}"
+puts 'Proxying port 1234 => port 1235'
+
+client1 = client2 = nil
+
+f1 = spin {
+  client1 = server1.accept
+  loop do
+    if client2
+      Thread.current.backend.splice_loop(client1, client2)
+    end
+  end
+}
+
+f2 = spin {
+  client2 = server2.accept
+  loop do
+    if client1
+      Thread.current.backend.splice_loop(client2, client1)
+    end
+  end
+}
+
+Fiber.await(f1, f2)

data/examples/performance/line_splitting.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "benchmark/ips"
+
+def slice
+  str = ('*' * 40) + "\n" + ('*' * 40) + "\n" + ('*' * 40) + "\n" + ('*' * 40) + "\n" + ('*' * 40)
+  lines = []
+  while true
+    idx = str.index("\n")
+    break unless idx
+    
+    lines << str.slice!(0, idx + 1)
+  end
+  raise unless lines.size == 4
+  raise unless str == ('*' * 40)
+end
+
+def split
+  str = ('*' * 40) + "\n" + ('*' * 40) + "\n" + ('*' * 40) + "\n" + ('*' * 40) + "\n" + ('*' * 40)
+  lines = str.split("\n")
+  if str[-1] == "\n"
+    str = ''
+  else
+    str = lines.pop
+  end
+  raise unless lines.size == 4
+  raise unless str == ('*' * 40)
+end
+
+Benchmark.ips do |x|
+  x.report("slice") { slice }
+  x.report("split") { split }
+  x.compare!
+end

data/examples/performance/loop.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+
+LIMIT = 1_000_0
+
+def do_while
+  i = 0
+  while true
+    i += 1
+    break if i == LIMIT
+  end
+end
+
+def do_loop
+  i = 0
+  loop do
+    i += 1
+    break if i == LIMIT
+  end
+end
+
+GC.disable
+Benchmark.bm do |x|
+  x.report('while') do
+    LIMIT.times { do_while }
+  end
+  x.report('loop') do
+    LIMIT.times { do_loop }
+  end
+end
+

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

@@ -26,8 +26,12 @@ def write_response(socket)
   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} Polyphony (#{Thread.current.backend.kind}) listening on port 1234"
+server = TCPServer.open('0.0.0.0', 4411)
+puts "pid #{Process.pid} Polyphony (#{Thread.current.backend.kind}) listening on port 4411"
+
+spin_loop(interval: 10) do
+  p Thread.current.fiber_scheduling_stats
+end
 
 server.accept_loop do |c|
   spin { handle_client(c) }

data/ext/polyphony/backend_common.h

@@ -70,9 +70,9 @@ inline VALUE io_enc_str(VALUE str, rb_io_t *fptr) {
 
 inline VALUE backend_await(Backend_t *backend) {
   VALUE ret;
-  backend->ref_count++;
+  backend->pending_count++;
   ret = Thread_switch_fiber(rb_thread_current());
-  backend->ref_count--;
+  backend->pending_count--;
   RB_GC_GUARD(ret);
   return ret;
 }
@@ -114,7 +114,7 @@ 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;
 }

data/ext/polyphony/backend_io_uring.c

@@ -30,11 +30,14 @@ static int pidfd_open(pid_t pid, unsigned int flags) {
 VALUE SYM_io_uring;
 
 typedef struct Backend_t {
+  // common fields
+  unsigned int        currently_polling;
+  unsigned int        pending_count;
+  unsigned int        poll_no_wait_count;
+
+  // implementation-specific fields
   struct io_uring     ring;
   op_context_store_t  store;
-  int                 waiting_for_cqe;
-  unsigned int        ref_count;
-  unsigned int        run_no_wait_count;
   unsigned int        pending_sqes;
   unsigned int        prepared_limit;
   int                 event_fd;
@@ -65,11 +68,11 @@ static VALUE Backend_initialize(VALUE self) {
   Backend_t *backend;
   GetBackend(self, backend);
 
-  backend->waiting_for_cqe = 0;
-  backend->ref_count = 0;
-  backend->run_no_wait_count = 0;
+  backend->currently_polling = 0;
+  backend->pending_count = 0;
+  backend->poll_no_wait_count = 0;
   backend->pending_sqes = 0;
-  backend->prepared_limit = 1024;
+  backend->prepared_limit = 2048;
 
   context_store_initialize(&backend->store);
   io_uring_queue_init(backend->prepared_limit, &backend->ring, 0);
@@ -95,46 +98,19 @@ VALUE Backend_post_fork(VALUE self) {
   io_uring_queue_exit(&backend->ring);
   io_uring_queue_init(backend->prepared_limit, &backend->ring, 0);
   context_store_free(&backend->store);
-  backend->waiting_for_cqe = 0;
-  backend->ref_count = 0;
-  backend->run_no_wait_count = 0;
+  backend->currently_polling = 0;
+  backend->pending_count = 0;
+  backend->poll_no_wait_count = 0;
   backend->pending_sqes = 0;
 
   return self;
 }
 
-VALUE Backend_ref(VALUE self) {
-  Backend_t *backend;
-  GetBackend(self, backend);
-
-  backend->ref_count++;
-  return self;
-}
-
-VALUE Backend_unref(VALUE self) {
+unsigned int Backend_pending_count(VALUE self) {
   Backend_t *backend;
   GetBackend(self, backend);
 
-  backend->ref_count--;
-  return self;
-}
-
-int Backend_ref_count(VALUE self) {
-  Backend_t *backend;
-  GetBackend(self, backend);
-
-  return backend->ref_count;
-}
-
-void Backend_reset_ref_count(VALUE self) {
-  Backend_t *backend;
-  GetBackend(self, backend);
-
-  backend->ref_count = 0;
-}
-
-VALUE Backend_pending_count(VALUE self) {
-  return INT2NUM(0);
+  return backend->pending_count;
 }
 
 typedef struct poll_context {
@@ -158,7 +134,7 @@ static inline bool cq_ring_needs_flush(struct io_uring *ring) {
 
 void io_uring_backend_handle_completion(struct io_uring_cqe *cqe, Backend_t *backend) {
   op_context_t *ctx = io_uring_cqe_get_data(cqe);
-  if (ctx == 0) return;
+  if (!ctx) return;
 
   ctx->result = cqe->res;
 
@@ -211,9 +187,9 @@ void io_uring_backend_poll(Backend_t *backend) {
     io_uring_submit(&backend->ring);
   }
 
-  backend->waiting_for_cqe = 1;
+  backend->currently_polling = 1;
   rb_thread_call_without_gvl(io_uring_backend_poll_without_gvl, (void *)&poll_ctx, RUBY_UBF_IO, 0);
-  backend->waiting_for_cqe = 0;
+  backend->currently_polling = 0;
   if (poll_ctx.result < 0) return;
 
   io_uring_backend_handle_completion(poll_ctx.cqe, backend);
@@ -226,14 +202,14 @@ VALUE Backend_poll(VALUE self, VALUE nowait, VALUE current_fiber, VALUE runqueue
   GetBackend(self, backend);
 
   if (is_nowait) {
-    backend->run_no_wait_count++;
-    if (backend->run_no_wait_count < 10) return self;
+    backend->poll_no_wait_count++;
+    if (backend->poll_no_wait_count < 10) return self;
 
     long runnable_count = Runqueue_len(runqueue);
-    if (backend->run_no_wait_count < runnable_count) return self;
+    if (backend->poll_no_wait_count < runnable_count) return self;
   }
 
-  backend->run_no_wait_count = 0;
+  backend->poll_no_wait_count = 0;
 
   if (is_nowait && backend->pending_sqes) {
     backend->pending_sqes = 0;
@@ -252,7 +228,7 @@ VALUE Backend_wakeup(VALUE self) {
   Backend_t *backend;
   GetBackend(self, backend);
 
-  if (backend->waiting_for_cqe) {
+  if (backend->currently_polling) {
     // Since we're currently blocking while waiting for a completion, we add a
     // NOP which would cause the io_uring_enter syscall to return
     struct io_uring_sqe *sqe = io_uring_get_sqe(&backend->ring);
@@ -284,12 +260,10 @@ int io_uring_backend_defer_submit_and_await(
   VALUE switchpoint_result = Qnil;
 
   io_uring_sqe_set_data(sqe, ctx);
-  io_uring_sqe_set_flags(sqe, IOSQE_ASYNC);
+  // io_uring_sqe_set_flags(sqe, IOSQE_ASYNC);
   io_uring_backend_defer_submit(backend);
 
-  backend->ref_count++;
   switchpoint_result = backend_await(backend);
-  backend->ref_count--;
 
   if (!ctx->completed) {
     ctx->result = -ECANCELED;
@@ -351,7 +325,7 @@ VALUE Backend_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eof)
 
     if (result < 0)
       rb_syserr_fail(-result, strerror(-result));
-    else if (result == 0)
+    else if (!result)
       break; // EOF
     else {
       total += result;
@@ -373,7 +347,7 @@ VALUE Backend_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eof)
   io_set_read_length(str, total, shrinkable);
   io_enc_str(str, fptr);
 
-  if (total == 0) return Qnil;
+  if (!total) return Qnil;
 
   return str;
 }
@@ -410,7 +384,7 @@ VALUE Backend_read_loop(VALUE self, VALUE io) {
 
     if (result < 0)
       rb_syserr_fail(-result, strerror(-result));
-    else if (result == 0)
+    else if (!result)
       break; // EOF
     else {
       total = result;
@@ -581,7 +555,7 @@ VALUE Backend_recv(VALUE self, VALUE io, VALUE str, VALUE length) {
   io_set_read_length(str, total, shrinkable);
   io_enc_str(str, fptr);
 
-  if (total == 0) return Qnil;
+  if (!total) return Qnil;
 
   return str;
 }
@@ -618,7 +592,7 @@ VALUE Backend_recv_loop(VALUE self, VALUE io) {
 
     if (result < 0)
       rb_syserr_fail(-result, strerror(-result));
-    else if (result == 0)
+    else if (!result)
       break; // EOF
     else {
       total = result;
@@ -950,10 +924,6 @@ void Init_Backend() {
   rb_define_method(cBackend, "initialize", Backend_initialize, 0);
   rb_define_method(cBackend, "finalize", Backend_finalize, 0);
   rb_define_method(cBackend, "post_fork", Backend_post_fork, 0);
-  rb_define_method(cBackend, "pending_count", Backend_pending_count, 0);
-
-  rb_define_method(cBackend, "ref", Backend_ref, 0);
-  rb_define_method(cBackend, "unref", Backend_unref, 0);
 
   rb_define_method(cBackend, "poll", Backend_poll, 3);
   rb_define_method(cBackend, "break", Backend_wakeup, 0);
@@ -977,15 +947,6 @@ void Init_Backend() {
   rb_define_method(cBackend, "kind", Backend_kind, 0);
 
   SYM_io_uring = ID2SYM(rb_intern("io_uring"));
-
-  __BACKEND__.pending_count   = Backend_pending_count;
-  __BACKEND__.poll            = Backend_poll;
-  __BACKEND__.ref             = Backend_ref;
-  __BACKEND__.ref_count       = Backend_ref_count;
-  __BACKEND__.reset_ref_count = Backend_reset_ref_count;
-  __BACKEND__.unref           = Backend_unref;
-  __BACKEND__.wait_event      = Backend_wait_event;
-  __BACKEND__.wakeup          = Backend_wakeup;
 }
 
 #endif // POLYPHONY_BACKEND_LIBURING