polyphony 0.49.2 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18278f9c013191fd5a96520a07e3b6e5c4bc088665a1b1a769b02552bd0e5448
-  data.tar.gz: 4e1e42fa5e2a6ddc6dcff7982415dd16246a0d75212aa2eb9ae7a97e030a2bdb
+  metadata.gz: 2aac80a08ca16498c3ee0044b0ba6de039b179425051cbcee67af4c9b948c349
+  data.tar.gz: bbe016d6b2ad3c5c89129089f9ebb8457a37159e03be2ff84f2572454880b0c2
 SHA512:
-  metadata.gz: 483158709045a9dc59fa75c912067c4fafbb02885e15f3fa57f482b97903a0c919abbb5ad19bea85837222a44d5ec2778f1e1421839c2e6a595a64e84f2d707d
-  data.tar.gz: c1162de70de5aa2d92804e7c4ccb3a372c5839d5600a7f68ae6f84363677a52f23923dbe8e407a84607ac4f0145736c7a5b9ada8b4956fd9c742cec182ed3a70
+  metadata.gz: 2f91d0b40bceb4600e4bbd22f39cdbd6bfd4ac5b5fc038f77deb7d26a464ce3cad177884f9aadde60c78bc48df170ab6909c44d133283af3abf77a090ac58332
+  data.tar.gz: 37dfa412a25f41dd704a203a865817bf273a23db0ccbe1bbec1a3f6017b9cd953301d67077e3b58601485f4dd96db94bef77da3d46cabd57fb563d3652173175

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polyphony (0.49.2)
+    polyphony (0.50.0)
 
 GEM
   remote: https://rubygems.org/

data/TODO.md

@@ -1,6 +1,9 @@
 - 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
 
 - Add support for `break` and `StopIteration` in all loops (with tests)

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/ext/polyphony/backend_common.h

@@ -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/fiber.c

@@ -101,7 +101,8 @@ VALUE Fiber_await(VALUE self) {
   }
   rb_hash_aset(waiting_fibers, fiber, Qtrue);
 
-  result = Thread_switch_fiber(rb_thread_current());
+  VALUE backend = rb_ivar_get(rb_thread_current(), ID_ivar_backend);
+  result = Backend_wait_event(backend, Qnil);
 
   rb_hash_delete(waiting_fibers, fiber);
   RAISE_IF_EXCEPTION(result);

data/ext/polyphony/polyphony.h

@@ -84,6 +84,7 @@ void Runqueue_push(VALUE self, VALUE fiber, VALUE value, int reschedule);
 void Runqueue_unshift(VALUE self, VALUE fiber, VALUE value, int reschedule);
 runqueue_entry Runqueue_shift(VALUE self);
 void Runqueue_delete(VALUE self, VALUE fiber);
+int Runqueue_index_of(VALUE self, VALUE fiber);
 void Runqueue_clear(VALUE self);
 long Runqueue_len(VALUE self);
 int Runqueue_empty_p(VALUE self);

data/ext/polyphony/runqueue.c

@@ -74,6 +74,12 @@ void Runqueue_delete(VALUE self, VALUE fiber) {
   runqueue_ring_buffer_delete(&runqueue->entries, fiber);
 }
 
+int Runqueue_index_of(VALUE self, VALUE fiber) {
+  Runqueue_t *runqueue;
+  GetRunqueue(self, runqueue);
+  return runqueue_ring_buffer_index_of(&runqueue->entries, fiber);
+}
+
 void Runqueue_clear(VALUE self) {
   Runqueue_t *runqueue;
   GetRunqueue(self, runqueue);

data/ext/polyphony/runqueue_ring_buffer.c

@@ -80,6 +80,15 @@ void runqueue_ring_buffer_delete(runqueue_ring_buffer *buffer, VALUE fiber) {
   }
 }
 
+int runqueue_ring_buffer_index_of(runqueue_ring_buffer *buffer, VALUE fiber) {
+  for (unsigned int i = 0; i < buffer->count; i++) {
+    unsigned int idx = (buffer->head + i) % buffer->size;
+    if (buffer->entries[idx].fiber == fiber)
+      return i;
+  }
+  return -1;
+}
+
 void runqueue_ring_buffer_clear(runqueue_ring_buffer *buffer) {
   buffer->count = buffer->head = buffer->tail = 0;
 }

data/ext/polyphony/runqueue_ring_buffer.h

@@ -27,5 +27,6 @@ void runqueue_ring_buffer_unshift(runqueue_ring_buffer *buffer, VALUE fiber, VAL
 void runqueue_ring_buffer_push(runqueue_ring_buffer *buffer, VALUE fiber, VALUE value);
 
 void runqueue_ring_buffer_delete(runqueue_ring_buffer *buffer, VALUE fiber);
+int runqueue_ring_buffer_index_of(runqueue_ring_buffer *buffer, VALUE fiber);
 
 #endif /* RUNQUEUE_RING_BUFFER_H */

data/ext/polyphony/thread.c

@@ -59,6 +59,18 @@ void schedule_fiber(VALUE self, VALUE fiber, VALUE value, int prioritize) {
   }
 }
 
+VALUE Thread_fiber_scheduling_index(VALUE self, VALUE fiber) {
+  VALUE runqueue = rb_ivar_get(self, ID_ivar_runqueue);
+
+  return INT2NUM(Runqueue_index_of(runqueue, fiber));
+}
+
+VALUE Thread_fiber_unschedule(VALUE self, VALUE fiber) {
+  VALUE runqueue = rb_ivar_get(self, ID_ivar_runqueue);
+  Runqueue_delete(runqueue, fiber);
+  return self;
+}
+
 VALUE Thread_schedule_fiber(VALUE self, VALUE fiber, VALUE value) {
   schedule_fiber(self, fiber, value, 0);
   return self;
@@ -135,6 +147,8 @@ void Init_Thread() {
   rb_define_method(rb_cThread, "schedule_fiber_with_priority",
     Thread_schedule_fiber_with_priority, 2);
   rb_define_method(rb_cThread, "switch_fiber", Thread_switch_fiber, 0);
+  rb_define_method(rb_cThread, "fiber_scheduling_index", Thread_fiber_scheduling_index, 1);
+  rb_define_method(rb_cThread, "fiber_unschedule", Thread_fiber_unschedule, 1);
 
   rb_define_method(rb_cThread, "debug!", Thread_debug, 0);
 

data/lib/polyphony/core/exceptions.rb

@@ -13,6 +13,7 @@ module Polyphony
     def initialize(value = nil)
       @caller_backtrace = caller
       @value = value
+      super
     end
   end
 

data/lib/polyphony/core/global_api.rb

@@ -29,7 +29,7 @@ module Polyphony
       spin do
         sleep interval
         exception = cancel_exception(with_exception)
-        exception.__raising_fiber__ = nil
+        exception.raising_fiber = nil
         fiber.schedule exception
       end
     end

data/lib/polyphony/core/timer.rb

@@ -11,12 +11,45 @@ module Polyphony
     def stop
       @fiber.stop
     end
+
+    def sleep(duration)
+      fiber = Fiber.current
+      @timeouts[fiber] = {
+        interval: duration,
+        target_stamp: now + duration
+      }
+      Thread.current.backend.wait_event(true)
+    ensure
+      @timeouts.delete(fiber)
+    end
+
+    def after(interval, &block)
+      spin do
+        self.sleep interval
+        block.()
+      end
+    end
+
+    def every(interval)
+      fiber = Fiber.current
+      @timeouts[fiber] = {
+        interval: interval,
+        target_stamp: now + interval,
+        recurring: true
+      }
+      while true
+        Thread.current.backend.wait_event(true)
+        yield
+      end
+    ensure
+      @timeouts.delete(fiber)
+    end
   
-    def cancel_after(duration, with_exception: Polyphony::Cancel)
+    def cancel_after(interval, with_exception: Polyphony::Cancel)
       fiber = Fiber.current
       @timeouts[fiber] = {
-        duration: duration,
-        target_stamp: Time.now + duration,
+        interval: interval,
+        target_stamp: now + interval,
         exception: with_exception
       }
       yield
@@ -24,12 +57,12 @@ module Polyphony
       @timeouts.delete(fiber)
     end
 
-    def move_on_after(duration, with_value: nil)
+    def move_on_after(interval, with_value: nil)
       fiber = Fiber.current
       @timeouts[fiber] = {
-        duration: duration,
-        target_stamp: Time.now + duration,
-        value: with_value
+        interval: interval,
+        target_stamp: now + interval,
+        exception: [Polyphony::MoveOn, with_value]
       }
       yield
     rescue Polyphony::MoveOn => e
@@ -37,36 +70,46 @@ module Polyphony
     ensure
       @timeouts.delete(fiber)
     end
-  
+
     def reset
       record = @timeouts[Fiber.current]
       return unless record
   
-      record[:target_stamp] = Time.now + record[:duration]
+      record[:target_stamp] = now + record[:interval]
     end
-  
+
     private
 
+    def now
+      ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+    end
+
     def timeout_exception(record)
       case (exception = record[:exception])
-      when Class then exception.new
-      when Array then exception[0].new(exception[1])
-      when nil then Polyphony::MoveOn.new(record[:value])
-      else RuntimeError.new(exception)
+      when Array
+        exception[0].new(exception[1])
+      when Class
+        exception.new
+      else
+        RuntimeError.new(exception)
       end
     end
 
     def update
-      now = Time.now
-      # elapsed = nil
+      return if @timeouts.empty?
+
       @timeouts.each do |fiber, record|
         next if record[:target_stamp] > now
 
-        exception = timeout_exception(record)
-        # (elapsed ||= []) << fiber
-        fiber.schedule exception
+        value = record[:exception] ? timeout_exception(record) : record[:value]
+        fiber.schedule value
+
+        next unless record[:recurring]
+
+        while record[:target_stamp] <= now
+          record[:target_stamp] += record[:interval]
+        end
       end
-      # elapsed&.each { |f| @timeouts.delete(f) }
     end
   end
 end

data/lib/polyphony/extensions/core.rb

@@ -12,11 +12,11 @@ class ::Exception
     attr_accessor :__disable_sanitized_backtrace__
   end
 
-  attr_accessor :source_fiber, :__raising_fiber__
+  attr_accessor :source_fiber, :raising_fiber
 
   alias_method :orig_initialize, :initialize
   def initialize(*args)
-    @__raising_fiber__ = Fiber.current
+    @raising_fiber = Fiber.current
     orig_initialize(*args)
   end
 
@@ -31,10 +31,10 @@ class ::Exception
   end
 
   def sanitized_backtrace
-    return sanitize(orig_backtrace) unless @__raising_fiber__
+    return sanitize(orig_backtrace) unless @raising_fiber
 
     backtrace = orig_backtrace || []
-    sanitize(backtrace + @__raising_fiber__.caller)
+    sanitize(backtrace + @raising_fiber.caller)
   end
 
   POLYPHONY_DIR = File.expand_path(File.join(__dir__, '..'))

data/lib/polyphony/extensions/fiber.rb

@@ -316,6 +316,8 @@ module Polyphony
       @running = false
       inform_dependants(result, uncaught_exception)
     ensure
+      # Prevent fiber from being resumed after terminating
+      @thread.fiber_unschedule(self)
       Thread.current.switch_fiber
     end
 

data/lib/polyphony/version.rb

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

data/test/test_fiber.rb

@@ -349,6 +349,22 @@ class FiberTest < MiniTest::Test
     assert_equal [:foo, :terminate], buffer
   end
 
+  CMD_TERMINATE_MAIN_FIBER = <<~BASH
+    ruby -rbundler/setup -rpolyphony -e"spin { sleep 0.1; Thread.current.main_fiber.terminate }; begin; sleep; rescue Polyphony::Terminate; STDOUT << 'terminated'; end" 2>&1
+  BASH
+
+  CMD_TERMINATE_CHILD_FIBER = <<~BASH
+    ruby -rbundler/setup -rpolyphony -e"f = spin { sleep }; spin { sleep 0.1; f.terminate }; f.await" 2>&1
+  BASH
+
+  def test_terminate_main_fiber
+    output = `#{CMD_TERMINATE_CHILD_FIBER}`
+    assert_equal '', output
+
+    output = `#{CMD_TERMINATE_MAIN_FIBER}`
+    assert_equal 'terminated', output
+  end
+
   def test_interrupt_timer
     result = []
     f = Fiber.current.spin do

data/test/test_timer.rb

@@ -11,7 +11,7 @@ class TimerMoveOnAfterTest < MiniTest::Test
     @timer.stop
   end
 
-  def test_move_on_after
+  def test_timer_move_on_after
     t0 = Time.now
     v = @timer.move_on_after(0.1) do
       sleep 1
@@ -23,7 +23,7 @@ class TimerMoveOnAfterTest < MiniTest::Test
     assert_nil v
   end
 
-  def test_move_on_after_with_value
+  def test_timer_move_on_after_with_value
     t0 = Time.now
     v = @timer.move_on_after(0.01, with_value: :bar) do
       sleep 1
@@ -35,7 +35,7 @@ class TimerMoveOnAfterTest < MiniTest::Test
     assert_equal :bar, v
   end
 
-  def test_move_on_after_with_reset
+  def test_timer_move_on_after_with_reset
     t0 = Time.now
     v = @timer.move_on_after(0.01, with_value: :moved_on) do
       sleep 0.007
@@ -48,7 +48,7 @@ class TimerMoveOnAfterTest < MiniTest::Test
     t1 = Time.now
 
     assert_nil v
-    assert_in_range 0.02..0.03, t1 - t0
+    assert_in_range 0.015..0.03, t1 - t0
   end
 end
 
@@ -61,7 +61,7 @@ class TimerCancelAfterTest < MiniTest::Test
     @timer.stop
   end
 
-  def test_cancel_after
+  def test_timer_cancel_after
     t0 = Time.now
 
     assert_raises Polyphony::Cancel do
@@ -74,7 +74,7 @@ class TimerCancelAfterTest < MiniTest::Test
     assert_in_range 0.01..0.03, t1 - t0
   end
 
-  def test_cancel_after_with_reset
+  def test_timer_cancel_after_with_reset
     t0 = Time.now
     @timer.cancel_after(0.01) do
       sleep 0.007
@@ -82,13 +82,13 @@ class TimerCancelAfterTest < MiniTest::Test
       sleep 0.007
     end
     t1 = Time.now
-    assert_in_range 0.014..0.024, t1 - t0
+    assert_in_range 0.013..0.024, t1 - t0
   end
 
   class CustomException < Exception
   end
 
-  def test_cancel_after_with_custom_exception
+  def test_timer_cancel_after_with_custom_exception
     assert_raises CustomException do
       @timer.cancel_after(0.01, with_exception: CustomException) do
         sleep 1
@@ -122,3 +122,36 @@ class TimerCancelAfterTest < MiniTest::Test
     end
   end
 end
+
+class TimerMiscTest < MiniTest::Test
+  def setup
+    @timer = Polyphony::Timer.new(resolution: 0.001)
+    sleep 0
+  end
+  
+  def teardown
+    @timer.stop
+  end
+    
+  def test_timer_after
+    buffer = []
+    f = @timer.after(0.01) { buffer << 2 }
+    assert_kind_of Fiber, f
+    snooze
+    assert_equal [], buffer
+    sleep 0.1
+    p :post_sleep
+    assert_equal [2], buffer
+  end
+
+  def test_timer_every
+    buffer = []
+    t0 = Time.now
+    f = spin do
+      @timer.every(0.01) { buffer << 1 }
+    end
+    sleep 0.05
+    f.stop
+    assert_in_range 4..6, buffer.size
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: 0.49.2
+  version: 0.50.0
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -353,6 +353,7 @@ files:
 - examples/core/forking.rb
 - examples/core/handling-signals.rb
 - examples/core/interrupt.rb
+- examples/core/nested.rb
 - examples/core/pingpong.rb
 - examples/core/recurrent-timer.rb
 - examples/core/resource_delegate.rb
@@ -360,6 +361,8 @@ files:
 - examples/core/spin_error_backtrace.rb
 - examples/core/supervise-process.rb
 - examples/core/supervisor.rb
+- examples/core/suspend.rb
+- examples/core/terminate_main_fiber.rb
 - examples/core/thread-sleep.rb
 - examples/core/thread_pool.rb
 - examples/core/throttling.rb