polyphony 0.32 → 0.33

data/ext/gyro/gyro.h

@@ -22,6 +22,7 @@ void Gyro_ref_count_incr();
 void Gyro_ref_count_decr();
 
 VALUE Gyro_Async_await(VALUE async);
+VALUE Gyro_Async_await_no_raise(VALUE async);
 
 VALUE IO_read_watcher(VALUE io);
 VALUE IO_write_watcher(VALUE io);

data/ext/gyro/queue.c

@@ -1,7 +1,6 @@
 #include "gyro.h"
 
 struct Gyro_Queue {
-  VALUE self;
   VALUE queue;
   VALUE wait_queue;
 };
@@ -45,7 +44,6 @@ static VALUE Gyro_Queue_initialize(VALUE self) {
   struct Gyro_Queue *queue;
   GetGyro_Queue(self, queue);
 
-  queue->self       = self;
   queue->queue      = rb_ary_new();
   queue->wait_queue = rb_ary_new();
   
@@ -69,15 +67,17 @@ VALUE Gyro_Queue_shift(VALUE self) {
   struct Gyro_Queue *queue;
   GetGyro_Queue(self, queue);
 
-  while (1) {
-    if (RARRAY_LEN(queue->queue) > 0) {
-      return rb_ary_shift(queue->queue);
-    }
-    
+  if (RARRAY_LEN(queue->queue) == 0) {
     VALUE async = rb_funcall(cGyro_Async, ID_new, 0);
     rb_ary_push(queue->wait_queue, async);
-    Gyro_Async_await(async);
+    VALUE ret = Gyro_Async_await_no_raise(async);
+    if (RTEST(rb_obj_is_kind_of(ret, rb_eException))) {
+      rb_ary_delete(queue->wait_queue, async);
+      return rb_funcall(rb_mKernel, ID_raise, 1, ret);
+    }
   }
+
+  return rb_ary_shift(queue->queue);
 }
 
 VALUE Gyro_Queue_shift_no_wait(VALUE self) {
@@ -96,7 +96,8 @@ VALUE Gyro_Queue_shift_each(VALUE self) {
 
   if (rb_block_given_p()) {
     long len = RARRAY_LEN(old_queue);
-    for (long i = 0; i < len; i++) {
+    long i;
+    for (i = 0; i < len; i++) {
       rb_yield(RARRAY_AREF(old_queue, i));
     }
     RB_GC_GUARD(old_queue);

data/ext/gyro/selector.c

@@ -85,9 +85,7 @@ static VALUE Gyro_Selector_initialize(VALUE self, VALUE thread) {
 
   ev_async_init(&selector->async, dummy_async_callback);
   ev_async_start(selector->ev_loop, &selector->async);
-
   ev_run(selector->ev_loop, EVRUN_NOWAIT);
-
   return Qnil;
 }
 
@@ -137,9 +135,9 @@ VALUE Gyro_Selector_break_out_of_ev_loop(VALUE self) {
 
   if (selector->ev_loop_running) {
     // Since the loop will run until at least one event has occurred, we signal
-    // the associated async watcher, which will cause the ev loop to return. In
-    // contrast to using `ev_break` to break out of the loop, which should be
-    // called from the same thread (from within the ev_loop), using an
+    // the selector's associated async watcher, which will cause the ev loop to
+    // return. In contrast to using `ev_break` to break out of the loop, which
+    // should be called from the same thread (from within the ev_loop), using an
     // `ev_async` allows us to interrupt the event loop across threads.
     ev_async_send(selector->ev_loop, &selector->async);
     return Qtrue;

data/ext/gyro/thread.c

@@ -7,7 +7,10 @@ static ID ID_empty;
 static ID ID_fiber_ref_count;
 static ID ID_ivar_event_selector_proc;
 static ID ID_ivar_event_selector;
+static ID ID_ivar_join_wait_queue;
 static ID ID_ivar_main_fiber;
+static ID ID_ivar_result;
+static ID ID_ivar_terminated;
 static ID ID_pop;
 static ID ID_push;
 static ID ID_run_queue;
@@ -247,21 +250,6 @@ VALUE Thread_fiber_break_out_of_ev_loop(VALUE self, VALUE fiber, VALUE resume_ob
   return self;
 }
 
-VALUE Thread_join_perform(VALUE self) {
-  if (!RTEST(rb_funcall(self, rb_intern("alive?"), 0))) {
-    return self;
-  }
-
-  VALUE async = rb_funcall(cGyro_Async, ID_new, 0);
-  VALUE wait_queue = rb_ivar_get(self, rb_intern("@join_wait_queue"));
-
-  Gyro_Queue_push(wait_queue, async);
-
-  VALUE ret = Gyro_Async_await(async);
-  RB_GC_GUARD(async);
-  return ret;
-}
-
 void Init_Thread() {
   cQueue = rb_const_get(rb_cObject, rb_intern("Queue"));
 
@@ -282,14 +270,15 @@ void Init_Thread() {
     Thread_schedule_fiber_with_priority, 2);
   rb_define_method(rb_cThread, "switch_fiber", Thread_switch_fiber, 0);
 
-  rb_define_method(rb_cThread, "join_perform", Thread_join_perform, 0);
-
   ID_create_event_selector    = rb_intern("create_event_selector");
   ID_empty                    = rb_intern("empty?");
   ID_fiber_ref_count          = rb_intern("fiber_ref_count");
   ID_ivar_event_selector      = rb_intern("@event_selector");
   ID_ivar_event_selector_proc = rb_intern("@event_selector_proc");
+  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_pop                      = rb_intern("pop");
   ID_push                     = rb_intern("push");
   ID_run_queue                = rb_intern("run_queue");

data/lib/polyphony.rb

@@ -23,6 +23,7 @@ module Polyphony
   exceptions = import './polyphony/core/exceptions'
   Cancel    = exceptions::Cancel
   MoveOn    = exceptions::MoveOn
+  Restart   = exceptions::Restart
   Terminate = exceptions::Terminate
 
   Net = import './polyphony/net'

data/lib/polyphony/core/exceptions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-export :MoveOn, :Cancel, :Terminate
+export :BaseException, :MoveOn, :Cancel, :Terminate, :Restart
 
 # Common exception class for interrupting fibers. These exceptions allow
 # control of fibers. BaseException exceptions can encapsulate a value and thus
@@ -26,3 +26,6 @@ class Cancel < BaseException; end
 
 # Terminate is used to interrupt a fiber once its parent fiber has terminated.
 class Terminate < BaseException; end
+
+# Restart is used to restart a fiber
+class Restart < BaseException; end

data/lib/polyphony/core/global_api.rb

@@ -73,6 +73,10 @@ module API
     Fiber.current.receive_pending
   end
 
+  def supervise(*args, &block)
+    Fiber.current.supervise(*args, &block)
+  end
+
   def sleep(duration = nil)
     return sleep_forever unless duration
 

data/lib/polyphony/extensions/core.rb

@@ -8,14 +8,15 @@ Exceptions = import('../core/exceptions')
 
 # Exeption overrides
 class ::Exception
+  EXIT_EXCEPTION_CLASSES = [::Interrupt, ::SystemExit].freeze
+
   class << self
     attr_accessor :__disable_sanitized_backtrace__
   end
 
-  alias_method :orig_initialize, :initialize
-
-  EXIT_EXCEPTION_CLASSES = [::Interrupt, ::SystemExit].freeze
+  attr_accessor :source_fiber
 
+  alias_method :orig_initialize, :initialize
   def initialize(*args)
     @__raising_fiber__ = Fiber.current
     orig_initialize(*args)

data/lib/polyphony/extensions/fiber.rb

@@ -27,6 +27,15 @@ module FiberControl
   end
   alias_method :stop, :interrupt
 
+  def restart(value = nil)
+    raise "Can''t restart main fiber" if @main
+    return parent.spin(&@block).tap { |f| f.schedule(value) } unless @running
+
+    schedule Exceptions::Restart.new(value)
+    self
+  end
+  alias_method :reset, :restart
+
   def cancel!
     return if @running == false
 
@@ -52,6 +61,35 @@ module FiberControl
     else RuntimeError.new
     end
   end
+
+  def supervise(on_error: nil, &block)
+    @on_child_done = proc { schedule }
+    loop { supervise_perform(on_error, &block) }
+  end
+
+  def supervise_perform(policy, &block)
+    suspend
+  rescue Polyphony::Restart
+    restart_all_children
+  rescue Exception => e
+    case e.source_fiber
+    when nil, self
+      Kernel.raise e
+    else
+      handle_supervisor_exception(e, e.source_fiber, policy, &block)
+    end
+  end
+
+  def handle_supervisor_exception(error, fiber, policy, &block)
+    return block.call(fiber, error) if block
+
+    case policy
+    when :restart
+      fiber.restart
+    when :restart_all
+      @children.keys.each(&:restart)
+    end
+  end
 end
 
 # Class methods for controlling fibers (namely await and select)
@@ -151,7 +189,7 @@ module ChildFiberControl
     (@children ||= {}).keys
   end
 
-  def spin(tag = nil, orig_caller = caller, &block)
+  def spin(tag = nil, orig_caller = Kernel.caller, &block)
     f = Fiber.new { |v| f.run(v) }
     f.prepare(tag, block, orig_caller, self)
     (@children ||= {})[f] = true
@@ -160,6 +198,7 @@ module ChildFiberControl
 
   def child_done(child_fiber)
     @children.delete(child_fiber)
+    @on_child_done&.(child_fiber)
   end
 
   def terminate_all_children
@@ -174,6 +213,11 @@ module ChildFiberControl
 
     Fiber.await(*@children.keys)
   end
+
+  def shutdown_all_children
+    terminate_all_children
+    await_all_children
+  end
 end
 
 # Fiber extensions
@@ -187,13 +231,13 @@ class ::Fiber
   attr_accessor :tag, :thread, :parent
 
   def prepare(tag, block, caller, parent)
-    __fiber_trace__(:fiber_create, self)
     @thread = Thread.current
     @tag = tag
     @parent = parent
     @caller = caller
     @block = block
     @mailbox = Gyro::Queue.new
+    __fiber_trace__(:fiber_create, self)
     schedule
   end
 
@@ -207,16 +251,21 @@ class ::Fiber
   end
 
   def run(first_value)
-    setup(first_value)
-    uncaught = nil
+    setup first_value
     result = @block.(first_value)
+    finalize result
+  rescue Exceptions::Restart => e
+    restart_self(e.value)
   rescue Exceptions::MoveOn, Exceptions::Terminate => e
-    result = e.value
+    finalize e.value
   rescue Exception => e
-    result = e
-    uncaught = true
-  ensure
-    finalize(result, uncaught)
+    e.source_fiber = self
+    finalize e, true
+  end
+
+  def restart_self(first_value)
+    @mailbox = Gyro::Queue.new
+    run(first_value)
   end
 
   def setup(first_value)
@@ -226,8 +275,7 @@ class ::Fiber
   end
 
   def finalize(result, uncaught_exception = false)
-    terminate_all_children
-    await_all_children
+    result, uncaught_exception = finalize_children(result, uncaught_exception)
     __fiber_trace__(:fiber_terminate, self, result)
     @result = result
     @running = false
@@ -236,6 +284,19 @@ class ::Fiber
     Thread.current.switch_fiber
   end
 
+  # Shuts down all children of the current fiber. If any exception occurs while
+  # the children are shut down, it is returned along with the uncaught_exception
+  # flag set. Otherwise, it returns the given arguments.
+  def finalize_children(result, uncaught_exception)
+    begin
+      shutdown_all_children
+    rescue Exception => e
+      result = e
+      uncaught_exception = true
+    end
+    [result, uncaught_exception]
+  end
+
   def inform_dependants(result, uncaught_exception)
     @parent.child_done(self)
     @when_done_procs&.each { |p| p.(result) }

data/lib/polyphony/extensions/thread.rb

@@ -4,24 +4,27 @@ Exceptions = import '../core/exceptions'
 
 # Thread extensions
 class ::Thread
-  attr_reader :main_fiber
+  attr_reader :main_fiber, :result
 
   alias_method :orig_initialize, :initialize
   def initialize(*args, &block)
     @join_wait_queue = Gyro::Queue.new
     @args = args
     @block = block
+    @finalization_mutex = Mutex.new
     orig_initialize { execute }
   end
 
   def execute
     setup
+    @ready = true
     result = @block.(*@args)
   rescue Exceptions::MoveOn, Exceptions::Terminate => e
     result = e.value
   rescue Exception => e
     result = e
   ensure
+    @ready = true
     finalize(result)
   end
 
@@ -36,7 +39,11 @@ class ::Thread
       Fiber.current.terminate_all_children
       Fiber.current.await_all_children
     end
-    signal_waiters(result)
+    @finalization_mutex.synchronize do
+      @terminated = true
+      @result = result
+      signal_waiters(result)
+    end
     stop_event_selector
   end
 
@@ -46,11 +53,15 @@ class ::Thread
 
   alias_method :orig_join, :join
   def join(timeout = nil)
-    if timeout
-      move_on_after(timeout) { join_perform }
-    else
-      join_perform
+    async = Gyro::Async.new
+    @finalization_mutex.synchronize do
+      if @terminated
+        @result.is_a?(Exception) ? (raise @result) : (return @result)
+      else
+        @join_wait_queue.push(async)
+      end
     end
+    timeout ? move_on_after(timeout) { async.await } : async.await
   end
   alias_method :await, :join
 
@@ -60,7 +71,9 @@ class ::Thread
     error = RuntimeError.new if error.nil?
     error = RuntimeError.new(error) if error.is_a?(String)
     error = error.new if error.is_a?(Class)
-    @main_fiber.raise(error)
+
+    sleep 0.0001 until @ready
+    main_fiber&.raise(error)
   end
 
   alias_method :orig_kill, :kill

data/lib/polyphony/version.rb

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

data/polyphony.gemspec

@@ -4,11 +4,11 @@ Gem::Specification.new do |s|
   s.name        = 'polyphony'
   s.version     = Polyphony::VERSION
   s.licenses    = ['MIT']
-  s.summary     = 'Polyphony: Fiber-based Concurrency for Ruby'
+  s.summary     = 'Fine grained concurrency for Ruby'
   s.author      = 'Sharon Rosner'
   s.email       = 'ciconia@gmail.com'
   s.files       = `git ls-files`.split
-  s.homepage    = 'https://dfab.gitbook.io/polyphony/'
+  s.homepage    = 'https://digital-fabric.github.io/polyphony'
   s.metadata    = {
     "source_code_uri" => "https://github.com/digital-fabric/polyphony",
     "documentation_uri" => "https://digital-fabric.github.io/polyphony/",

data/test/stress.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+@count = 0
+
+def run_tests
+  @count += 1
+  puts "!(#{@count})"
+  # output = `ruby test/test_thread.rb -n test_thread_inspect`
+  system('ruby test/run.rb')
+  return if $?.exitstatus == 0
+
+  exit!
+  # puts
+  # puts output
+  # exit!
+end
+
+loop {
+  run_tests
+}