polyphony 0.45.1 → 0.45.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f54b88851ca73f121975839812e0a1ad5686d017199b83a6365deda2b656d3a
-  data.tar.gz: 92671a26215f19e36c0b0f49edb990a6818e2c64d7a8ed8bc9c4f2621a5de170
+  metadata.gz: a2fa4fa731ff52272d3aed456f7a26751e76c63b4335366919bffaf089bf96dd
+  data.tar.gz: 1afe67258c5c73d9cc1082ca238eb358dac0f5b7a975f90a77b4f6de6a23b2a4
 SHA512:
-  metadata.gz: fd3caf340b523eccb1f86b10e06996ec26704ed1906bd82188363fb5142901b585992df8d88d0ca20adc188e51a010144fba8f10843ba79503d2984f63a08a05
-  data.tar.gz: 2b44d80a6ac0bf3f0f42ece1b7d2008c3d0b933c1df11be7f698bbc9dae80341bd1d302a1e0ccaa56b223468b607b7f024bbaa949a88ff1c343028d6cd256ba5
+  metadata.gz: 175edf315d759f85d2c0d934be36b9fcacd68342206d984ad64f800120a8b65668e9ea81595f47cbbb439402c256b47fde78f0cdad4b42e0c3b1d6ee321135b9
+  data.tar.gz: 01cfe1d8b51d60a736adb80062eb22e7983a1879a5491cb7a2e47ec4ad5734e0c8bd8664653870a4393276b42fa912953721658ecff634521a672419c8d3cab6

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.45.2
+
+* Rewrite `Fiber#<<`, `Fiber#await`, `Fiber#receive` in C
+
 ## 0.45.1
 
 * Fix Net::HTTP compatibility

data/Gemfile.lock

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

data/TODO.md

@@ -1,4 +1,4 @@
-0.45.1
+0.45.2
 
 - Adapter for Pry and IRB (Which fixes #5 and #6)
 - Redesign signal handling - the current mechanism is problematic in that it

data/ext/polyphony/fiber.c

@@ -2,12 +2,9 @@
 
 ID ID_fiber_trace;
 ID ID_ivar_auto_watcher;
-ID ID_trace_ev_loop_enter;
-ID ID_trace_ev_loop_leave;
-ID ID_trace_run;
-ID ID_trace_runnable;
-ID ID_trace_terminate;
-ID ID_trace_wait;
+ID ID_ivar_mailbox;
+ID ID_ivar_result;
+ID ID_ivar_waiting_fibers;
 
 VALUE SYM_dead;
 VALUE SYM_running;
@@ -67,6 +64,57 @@ void Fiber_make_runnable(VALUE fiber, VALUE value) {
   }
 }
 
+VALUE Fiber_await(VALUE self) {
+  VALUE result;
+
+  // we compare with false, since a fiber that has not yet started will have
+  // @running set to nil
+  if (rb_ivar_get(self, ID_ivar_running) == Qfalse) {
+    result = rb_ivar_get(self, ID_ivar_result);
+    TEST_RESUME_EXCEPTION(result);
+    return result;
+  }
+
+  VALUE fiber = rb_fiber_current();
+  VALUE waiting_fibers = rb_ivar_get(self, ID_ivar_waiting_fibers);
+  if (waiting_fibers == Qnil) {
+    waiting_fibers = rb_hash_new();
+    rb_ivar_set(self, ID_ivar_waiting_fibers, waiting_fibers);
+  }
+  rb_hash_aset(waiting_fibers, fiber, Qtrue);
+
+  result = Thread_switch_fiber(rb_thread_current());
+
+  rb_hash_delete(waiting_fibers, fiber);
+  TEST_RESUME_EXCEPTION(result);
+  RB_GC_GUARD(result);
+  return result;
+}
+
+VALUE Fiber_send(VALUE self, VALUE value) {
+  VALUE mailbox = rb_ivar_get(self, ID_ivar_mailbox);
+  if (mailbox == Qnil) {
+    mailbox = rb_funcall(cQueue, ID_new, 0);
+    rb_ivar_set(self, ID_ivar_mailbox, mailbox);
+  }
+  Queue_push(mailbox, value);
+  return self;
+}
+
+VALUE Fiber_receive(VALUE self) {
+  VALUE mailbox = rb_ivar_get(self, ID_ivar_mailbox);
+  if (mailbox == Qnil) {
+    mailbox = rb_funcall(cQueue, ID_new, 0);
+    rb_ivar_set(self, ID_ivar_mailbox, mailbox);
+  }
+  return Queue_shift(mailbox);  
+}
+
+VALUE Fiber_receive_all_pending(VALUE self) {
+  VALUE mailbox = rb_ivar_get(self, ID_ivar_mailbox);
+  return (mailbox == Qnil) ? rb_ary_new() : Queue_shift_all(mailbox);
+}
+
 void Init_Fiber() {
   VALUE cFiber = rb_const_get(rb_cObject, rb_intern("Fiber"));
   rb_define_method(cFiber, "safe_transfer", Fiber_safe_transfer, -1);
@@ -74,6 +122,15 @@ void Init_Fiber() {
   rb_define_method(cFiber, "state", Fiber_state, 0);
   rb_define_method(cFiber, "auto_watcher", Fiber_auto_watcher, 0);
 
+  rb_define_method(cFiber, "await", Fiber_await, 0);
+  rb_define_method(cFiber, "join", Fiber_await, 0);
+
+  rb_define_method(cFiber, "<<", Fiber_send, 1);
+  rb_define_method(cFiber, "send", Fiber_send, 1);
+
+  rb_define_method(cFiber, "receive", Fiber_receive, 0);
+  rb_define_method(cFiber, "receive_all_pending", Fiber_receive_all_pending, 0);
+
   SYM_dead = ID2SYM(rb_intern("dead"));
   SYM_running = ID2SYM(rb_intern("running"));
   SYM_runnable = ID2SYM(rb_intern("runnable"));
@@ -85,6 +142,9 @@ void Init_Fiber() {
 
   ID_fiber_trace          = rb_intern("__fiber_trace__");
   ID_ivar_auto_watcher    = rb_intern("@auto_watcher");
+  ID_ivar_mailbox         = rb_intern("@mailbox");
+  ID_ivar_result          = rb_intern("@result");
+  ID_ivar_waiting_fibers  = rb_intern("@waiting_fibers");
 
   SYM_fiber_create        = ID2SYM(rb_intern("fiber_create"));
   SYM_fiber_ev_loop_enter = ID2SYM(rb_intern("fiber_ev_loop_enter"));

data/ext/polyphony/polyphony.h

@@ -72,6 +72,7 @@ void Fiber_make_runnable(VALUE fiber, VALUE value);
 VALUE Queue_push(VALUE self, VALUE value);
 VALUE Queue_unshift(VALUE self, VALUE value);
 VALUE Queue_shift(VALUE self);
+VALUE Queue_shift_all(VALUE self);
 VALUE Queue_shift_no_wait(VALUE self);
 VALUE Queue_clear(VALUE self);
 VALUE Queue_delete(VALUE self, VALUE value);

data/lib/polyphony/core/global_api.rb

@@ -92,8 +92,8 @@ module Polyphony
       Fiber.current.receive
     end
 
-    def receive_pending
-      Fiber.current.receive_pending
+    def receive_all_pending
+      Fiber.current.receive_all_pending
     end
 
     def supervise(*args, &block)

data/lib/polyphony/extensions/fiber.rb

@@ -7,20 +7,6 @@ require_relative '../core/exceptions'
 module Polyphony
   # Fiber control API
   module FiberControl
-    def await
-      if @running == false
-        return @result.is_a?(Exception) ? (Kernel.raise @result) : @result
-      end
-
-      fiber = Fiber.current
-      @waiting_fibers ||= {}
-      @waiting_fibers[fiber] = true
-      suspend
-    ensure
-      @waiting_fibers&.delete(fiber)
-    end
-    alias_method :join, :await
-
     def interrupt(value = nil)
       return if @running == false
 
@@ -181,22 +167,6 @@ module Polyphony
     end
   end
 
-  # Messaging functionality
-  module FiberMessaging
-    def <<(value)
-      @mailbox << value
-    end
-    alias_method :send, :<<
-
-    def receive
-      @mailbox.shift
-    end
-
-    def receive_pending
-      @mailbox.shift_all
-    end
-  end
-
   # Methods for controlling child fibers
   module ChildFiberControl
     def children
@@ -225,14 +195,14 @@ module Polyphony
     def await_all_children
       return unless @children && !@children.empty?
 
-      @results = @children.dup
+      results = @children.dup
       @on_child_done = proc do |c, r|
-        @results[c] = r
+        results[c] = r
         schedule if @children.empty?
       end
       suspend
       @on_child_done = nil
-      @results.values
+      results.values
     end
 
     def shutdown_all_children
@@ -249,7 +219,6 @@ module Polyphony
       @parent = parent
       @caller = caller
       @block = block
-      @mailbox = Polyphony::Queue.new
       __fiber_trace__(:fiber_create, self)
       schedule
     end
@@ -279,7 +248,6 @@ module Polyphony
     # allows the fiber to be scheduled and to receive messages.
     def setup_raw
       @thread = Thread.current
-      @mailbox = Polyphony::Queue.new
     end
 
     def setup_main_fiber
@@ -288,11 +256,10 @@ module Polyphony
       @thread = Thread.current
       @running = true
       @children&.clear
-      @mailbox = Polyphony::Queue.new
     end
 
     def restart_self(first_value)
-      @mailbox = Polyphony::Queue.new
+      @mailbox = nil
       @when_done_procs = nil
       @waiting_fibers = nil
       run(first_value)
@@ -324,13 +291,10 @@ module Polyphony
     def inform_dependants(result, uncaught_exception)
       @parent&.child_done(self, result)
       @when_done_procs&.each { |p| p.(result) }
-      @waiting_fibers&.each_key do |f|
-        f.schedule(result)
-      end
-      return unless uncaught_exception && !@waiting_fibers
-
+      @waiting_fibers&.each_key { |f| f.schedule(result) }
+      
       # propagate unaught exception to parent
-      @parent&.schedule(result)
+      @parent&.schedule(result) if uncaught_exception && !@waiting_fibers
     end
 
     def when_done(&block)
@@ -344,7 +308,6 @@ end
 class ::Fiber
   prepend Polyphony::FiberControl
   include Polyphony::FiberSupervision
-  include Polyphony::FiberMessaging
   include Polyphony::ChildFiberControl
   include Polyphony::FiberLifeCycle
 

data/lib/polyphony/version.rb

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

data/test/test_fiber.rb

@@ -700,15 +700,16 @@ class FiberTest < MiniTest::Test
     buffer = []
     f = Fiber.new { buffer << receive }
     
-    assert_raises(NoMethodError) { f << 'foo' }
+    assert_nil f.thread
     snooze
     f.setup_raw
     assert_equal Thread.current, f.thread
     assert_nil f.parent
 
     f.schedule
+    snooze
     f << 'bar'
-    2.times { snooze }
+    snooze
     assert_equal ['bar'], buffer
   end
 end
@@ -811,20 +812,20 @@ class MailboxTest < MiniTest::Test
     assert_equal ['foo'] * 100, messages
   end
 
-  def test_receive_pending
-    assert_equal [], receive_pending
+  def test_receive_all_pending
+    assert_equal [], receive_all_pending
 
     (1..5).each { |i| Fiber.current << i }
-    assert_equal (1..5).to_a, receive_pending
-    assert_equal [], receive_pending
+    assert_equal (1..5).to_a, receive_all_pending
+    assert_equal [], receive_all_pending
   end
 
-  def test_receive_pending_on_termination
+  def test_receive_all_pending_on_termination
     buffer = []
     worker = spin do
       loop { buffer << receive }
     rescue Polyphony::Terminate
-      receive_pending.each { |r| buffer << r }
+      receive_all_pending.each { |r| buffer << r }
     end
 
     worker << 1

data/test/test_throttler.rb

@@ -12,7 +12,6 @@ class ThrottlerTest < MiniTest::Test
     f.stop
     elapsed = Time.now - t0
     expected = (elapsed * 10).to_i
-    STDOUT.orig_write "xxxxxxxx #{[elapsed, expected].inspect}\n"
     assert buffer.size >= expected - 1 && buffer.size <= expected + 1
   ensure
     t.stop

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: 0.45.1
+  version: 0.45.2
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-01 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler