polyphony 0.55.0 → 0.59.1

data/lib/polyphony/core/timer.rb

@@ -3,8 +3,8 @@
 module Polyphony
   # Implements a common timer for running multiple timeouts
   class Timer
-    def initialize(resolution:)
-      @fiber = spin_loop(interval: resolution) { update }
+    def initialize(tag = nil, resolution:)
+      @fiber = spin_loop(tag, interval: resolution) { update }
       @timeouts = {}
     end
 

data/lib/polyphony/extensions/fiber.rb

@@ -262,7 +262,7 @@ module Polyphony
       @parent = parent
       @caller = caller
       @block = block
-      __fiber_trace__(:fiber_create, self)
+      Thread.backend.trace(:fiber_create, self)
       schedule
     end
 
@@ -311,7 +311,7 @@ module Polyphony
 
     def finalize(result, uncaught_exception = false)
       result, uncaught_exception = finalize_children(result, uncaught_exception)
-      __fiber_trace__(:fiber_terminate, self, result)
+      Thread.backend.trace(:fiber_terminate, self, result)
       @result = result
       @running = false
       inform_dependants(result, uncaught_exception)

data/lib/polyphony/extensions/thread.rb

@@ -105,4 +105,12 @@ class ::Thread
     main_fiber << value
   end
   alias_method :send, :<<
+
+  def idle_gc_period=(period)
+    backend.idle_gc_period = period
+  end
+
+  def on_idle(&block)
+    backend.idle_proc = block
+  end
 end

data/lib/polyphony/version.rb

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

data/test/test_backend.rb

@@ -281,6 +281,97 @@ class BackendTest < MiniTest::Test
       f.await
     end
   end
+
+
+  def test_splice_chunks
+    body = 'abcd' * 250
+    chunk_size = 750
+
+    buf = +''
+    r, w = IO.pipe
+    reader = spin do
+      r.read_loop { |data| buf << data }
+    end
+
+    i, o = IO.pipe
+    writer = spin do
+      o << body
+      o.close
+    end
+    Thread.current.backend.splice_chunks(
+      i,
+      w,
+      "Content-Type: foo\r\n\r\n",
+      "0\r\n\r\n",
+      ->(len) { "#{len.to_s(16)}\r\n" },
+      "\r\n",
+      chunk_size
+    )
+    w.close
+    reader.await
+
+    expected = "Content-Type: foo\r\n\r\n#{750.to_s(16)}\r\n#{body[0..749]}\r\n#{250.to_s(16)}\r\n#{body[750..999]}\r\n0\r\n\r\n"
+    assert_equal expected, buf
+  ensure
+    o.close
+    w.close
+  end
+
+  def test_idle_gc
+    GC.disable
+
+    count = GC.count
+    snooze
+    assert_equal count, GC.count
+    sleep 0.01
+    assert_equal count, GC.count
+
+    @backend.idle_gc_period = 0.1
+    snooze
+    assert_equal count, GC.count
+    sleep 0.05
+    assert_equal count, GC.count
+    # The idle tasks are ran at most once per fiber switch, before the backend
+    # is polled. Therefore, the second sleep will not have triggered a GC, since
+    # only 0.05s have passed since the gc period was set.
+    sleep 0.07
+    assert_equal count, GC.count
+    # Upon the third sleep the GC should be triggered, at 0.12s post setting the
+    # GC period.
+    sleep 0.05
+    assert_equal count + 1, GC.count
+
+    @backend.idle_gc_period = 0
+    count = GC.count
+    sleep 0.001
+    sleep 0.002
+    sleep 0.003
+    assert_equal count, GC.count
+  ensure
+    GC.enable
+  end
+
+  def test_idle_proc
+    counter = 0
+
+    @backend.idle_proc = proc { counter += 1 }
+    
+    3.times { snooze }
+    assert_equal 0, counter
+
+    sleep 0.01
+    assert_equal 1, counter
+    sleep 0.01
+    assert_equal 2, counter
+
+    assert_equal 2, counter
+    3.times { snooze }
+    assert_equal 2, counter
+
+    @backend.idle_proc = nil
+    sleep 0.01
+    assert_equal 2, counter
+  end
 end
 
 class BackendChainTest < MiniTest::Test

data/test/test_thread.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'helper'
-require 'polyphony/adapters/trace'
 
 class ThreadTest < MiniTest::Test
   def test_thread_spin
@@ -130,18 +129,13 @@ class ThreadTest < MiniTest::Test
 
   def test_that_suspend_returns_immediately_if_no_watchers
     records = []
-    t = Polyphony::Trace.new(:fiber_all) do |r|
-      records << r if r[:event] =~ /^fiber_/
-    end
-    t.enable
-    Polyphony.trace(true)
-
+    Thread.backend.trace_proc = proc {|*r| records << r }
     suspend
-    t.disable
-    assert_equal [:fiber_switchpoint], records.map { |r| r[:event] }
+    assert_equal [
+      [:fiber_switchpoint, Fiber.current]
+    ], records
   ensure
-    t&.disable
-    Polyphony.trace(false)
+    Thread.backend.trace_proc = nil
   end
 
   def test_thread_child_fiber_termination
@@ -171,4 +165,56 @@ class ThreadTest < MiniTest::Test
     t&.kill
     t&.join
   end
+
+  def test_idle_gc
+    GC.disable
+
+    count = GC.count
+    snooze
+    assert_equal count, GC.count
+    sleep 0.01
+    assert_equal count, GC.count
+
+    Thread.current.idle_gc_period = 0.1
+    snooze
+    assert_equal count, GC.count
+    sleep 0.05
+    assert_equal count, GC.count
+    # The idle tasks are ran at most once per fiber switch, before the backend
+    # is polled. Therefore, the second sleep will not have triggered a GC, since
+    # only 0.05s have passed since the gc period was set.
+    sleep 0.07
+    assert_equal count, GC.count
+    # Upon the third sleep the GC should be triggered, at 0.12s post setting the
+    # GC period.
+    sleep 0.05
+    assert_equal count + 1, GC.count
+
+    Thread.current.idle_gc_period = 0
+    count = GC.count
+    sleep 0.001
+    sleep 0.002
+    sleep 0.003
+    assert_equal count, GC.count
+  ensure
+    GC.enable
+  end
+
+  def test_on_idle
+    counter = 0
+
+    Thread.current.on_idle { counter += 1 }
+    
+    3.times { snooze }
+    assert_equal 0, counter
+
+    sleep 0.01
+    assert_equal 1, counter
+    sleep 0.01
+    assert_equal 2, counter
+
+    assert_equal 2, counter
+    3.times { snooze }
+    assert_equal 2, counter
+  end
 end

data/test/test_timer.rb

@@ -48,7 +48,7 @@ class TimerMoveOnAfterTest < MiniTest::Test
     t1 = Time.now
 
     assert_nil v
-    assert_in_range 0.015..0.03, t1 - t0
+    assert_in_range 0.015..0.04, t1 - t0
   end
 end
 
@@ -76,17 +76,17 @@ class TimerCancelAfterTest < MiniTest::Test
 
   def test_timer_cancel_after_with_reset
     buf = []
-    @timer.cancel_after(0.01) do
-      sleep 0.005
+    @timer.cancel_after(0.13) do
+      sleep 0.05
       buf << 1
       @timer.reset
-      sleep 0.005
+      sleep 0.05
       buf << 2
       @timer.reset
-      sleep 0.005
+      sleep 0.05
       buf << 3
       @timer.reset
-      sleep 0.005
+      sleep 0.05
       buf << 4
     end
     assert_equal [1, 2, 3, 4], buf
@@ -158,6 +158,6 @@ class TimerMiscTest < MiniTest::Test
     end
     sleep 0.05
     f.stop
-    assert_in_range 4..6, buffer.size
+    assert_in_range 3..7, buffer.size
   end
 end

data/test/test_trace.rb

@@ -1,70 +1,48 @@
 # frozen_string_literal: true
 
 require_relative 'helper'
-require 'polyphony/adapters/trace'
 
 class TraceTest < MiniTest::Test
-  def test_tracing_disabled
-    records = []
-    t = Polyphony::Trace.new { |r| records << r if r[:event] =~ /^fiber_/ }
-    t.enable
-    snooze
-    assert_equal 0, records.size
-  ensure
-    t&.disable
-    Polyphony.trace(nil)
-  end
-
   def test_tracing_enabled
-    records = []
-    t = Polyphony::Trace.new(:fiber_all) { |r| records << r if r[:event] =~ /^fiber_/ }
-    Polyphony.trace(true)
-    t.enable
+    events = []
+    Thread.backend.trace_proc = proc { |*e| events << e }
     snooze
-    t.disable
     
-    assert_equal 3, records.size
-    events = records.map { |r| r[:event] }
-    assert_equal [:fiber_schedule, :fiber_switchpoint, :fiber_run], events
-    assert_equal [Fiber.current], records.map { |r| r[:fiber] }.uniq
+    assert_equal [
+      [:fiber_schedule, Fiber.current, nil],
+      [:fiber_switchpoint, Fiber.current],
+      [:fiber_run, Fiber.current, nil]
+    ], events
   ensure
-    t&.disable
-    Polyphony.trace(nil)
+    Thread.backend.trace_proc = nil
   end
 
   def test_2_fiber_trace
-    records = []
-    thread = Thread.current
-    t = Polyphony::Trace.new(:fiber_all) do |r|
-      records << r if Thread.current == thread && r[:event] =~ /^fiber_/
-    end
-    t.enable
-    Polyphony.trace(true)
+    events = []
+    Thread.backend.trace_proc = proc { |*e| events << e }
 
-    f = spin { sleep 0 }
+    f = spin { sleep 0; :byebye }
     suspend
     sleep 0
 
-    events = records.map { |r| [r[:fiber] == f ? :f : :current, r[:event]] }
     assert_equal [
-      [:f, :fiber_create],
-      [:f, :fiber_schedule],
-      [:current, :fiber_switchpoint],
-      [:f, :fiber_run],
-      [:f, :fiber_switchpoint],
-      [:f, :fiber_event_poll_enter],
-      [:f, :fiber_schedule],
-      [:f, :fiber_event_poll_leave],
-      [:f, :fiber_run],
-      [:f, :fiber_terminate],
-      [:current, :fiber_switchpoint],
-      [:current, :fiber_event_poll_enter],
-      [:current, :fiber_schedule],
-      [:current, :fiber_event_poll_leave],
-      [:current, :fiber_run]
+      [:fiber_create, f],
+      [:fiber_schedule, f, nil],
+      [:fiber_switchpoint, Fiber.current],
+      [:fiber_run, f, nil],
+      [:fiber_switchpoint, f],
+      [:fiber_event_poll_enter, f],
+      [:fiber_schedule, f, nil],
+      [:fiber_event_poll_leave, f],
+      [:fiber_run, f, nil],
+      [:fiber_terminate, f, :byebye],
+      [:fiber_switchpoint, Fiber.current],
+      [:fiber_event_poll_enter, Fiber.current],
+      [:fiber_schedule, Fiber.current, nil],
+      [:fiber_event_poll_leave, Fiber.current],
+      [:fiber_run, Fiber.current, nil]
     ], events
   ensure
-    t&.disable
-    Polyphony.trace(nil)
+    Thread.backend.trace_proc = nil
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: 0.55.0
+  version: 0.59.1
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -324,6 +324,7 @@ files:
 - examples/core/erlang-style-genserver.rb
 - examples/core/forking.rb
 - examples/core/handling-signals.rb
+- examples/core/idle_gc.rb
 - examples/core/interrupt.rb
 - examples/core/nested.rb
 - examples/core/pingpong.rb
@@ -355,10 +356,12 @@ files:
 - examples/io/irb.rb
 - examples/io/net-http.rb
 - examples/io/open.rb
+- examples/io/pipe.rb
 - examples/io/pry.rb
 - examples/io/rack_server.rb
 - examples/io/raw.rb
 - examples/io/reline.rb
+- examples/io/splice_chunks.rb
 - examples/io/stdio.rb
 - examples/io/system.rb
 - examples/io/tcp_proxy.rb
@@ -414,6 +417,7 @@ files:
 - ext/liburing/setup.c
 - ext/liburing/syscall.c
 - ext/liburing/syscall.h
+- ext/polyphony/backend_common.c
 - ext/polyphony/backend_common.h
 - ext/polyphony/backend_io_uring.c
 - ext/polyphony/backend_io_uring_context.c
@@ -433,11 +437,11 @@ files:
 - ext/polyphony/ring_buffer.c
 - ext/polyphony/ring_buffer.h
 - ext/polyphony/runqueue.c
+- ext/polyphony/runqueue.h
 - ext/polyphony/runqueue_ring_buffer.c
 - ext/polyphony/runqueue_ring_buffer.h
 - ext/polyphony/socket_extensions.c
 - ext/polyphony/thread.c
-- ext/polyphony/tracing.c
 - lib/polyphony.rb
 - lib/polyphony/adapters/fs.rb
 - lib/polyphony/adapters/irb.rb
@@ -447,7 +451,6 @@ files:
 - lib/polyphony/adapters/readline.rb
 - lib/polyphony/adapters/redis.rb
 - lib/polyphony/adapters/sequel.rb
-- lib/polyphony/adapters/trace.rb
 - lib/polyphony/core/channel.rb
 - lib/polyphony/core/exceptions.rb
 - lib/polyphony/core/global_api.rb

data/ext/polyphony/tracing.c

@@ -1,11 +0,0 @@
-#include "polyphony.h"
-
-int __tracing_enabled__ = 0;
-
-VALUE __fiber_trace__(int argc, VALUE *argv, VALUE self) {
-  return rb_ary_new4(argc, argv);
-}
-
-void Init_Tracing() {
-  rb_define_global_function("__fiber_trace__", __fiber_trace__, -1);
-}