polyphony 0.43.8 → 0.43.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bea457e28d23f96570d448855d00cf76250a55fcb02e12c4305cb551cb55faf4
-  data.tar.gz: dc97409e61ce82c20eef25101a2c53046635461ef81302e54b121e5bb9c25aa1
+  metadata.gz: 14930ef46f39537ad6f2233b23691a05d910ecf6c22cd8429a8a82dcf4f2af51
+  data.tar.gz: a2c53e7082c35025cce3024113162ed5e67032eed82d49c363516441c3293898
 SHA512:
-  metadata.gz: 53d345ee472bc77fc993880a1a725064bb934ec2789fa72bd97ec07b558942369860fb7077e0fcff6c95cfcff0c0d712090f70b1d9ff7f652160d15ddfc77de4
-  data.tar.gz: 513a79eeb8a7766078d159cf85d367a6f3f50a0870825275408081d9cfe4e446e7f0b0120bd712f6281ccd0787779ec464b20c9e17c3c60178ceb39c061033c7
+  metadata.gz: ac9d80b5a0fad4b4d164bed60c42d386fc49e978b381a2a9fd6174bf616cb5a97cb4232c317c62ac0439f534d753e5c9a1e9cbb98be41145a9d288d6d719adcc
+  data.tar.gz: 95a8d13b133a0256ffb71df70e4348845dbcbe0c848a94feb0ceaf205e274f918d84529ef7d0773884e51f2e504625a96a4fdf548b17f03fa408c39f763609b6

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.43.9 2020-07-22
+
+* Rewrite `Channel` using `Queue`
+* Rewrite `Mutex` using `Queue`
+* Reimplement `Event` in C to prevent cross-thread race condition
+* Reimplement `ResourcePool` using `Queue`
+* Implement `Queue#size`
+
 ## 0.43.8 2020-07-21
 
 * Rename `LibevQueue` to `Queue`

data/Gemfile.lock

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

data/README.md

@@ -1,10 +1,25 @@
-<p align="center"><img src="docs/polyphony-logo.png" /></p>
+<h1 align="center">
+  <a href="https://digital-fabric.github.io/polyphony/">
+    <img src="docs/polyphony-logo.png" alt="Polyphony">
+  </a>
+  <br>
+  Polyphony
+  <br>
+</h1>
 
-# Polyphony - Fine-Grained Concurrency for Ruby
+<h4 align="center">Fine-Grained Concurrency for Ruby</h4>
 
-[![Gem Version](https://badge.fury.io/rb/polyphony.svg)](http://rubygems.org/gems/polyphony)
-[![Modulation Test](https://github.com/digital-fabric/polyphony/workflows/Tests/badge.svg)](https://github.com/digital-fabric/polyphony/actions?query=workflow%3ATests)
-[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/digital-fabric/polyphony/blob/master/LICENSE)
+<p align="center">
+  <a href="http://rubygems.org/gems/polyphony">
+    <img src="https://badge.fury.io/rb/polyphony.svg" alt="Ruby gem">
+  </a>
+  <a href="https://github.com/digital-fabric/polyphony/actions?query=workflow%3ATests">
+    <img src="https://github.com/digital-fabric/polyphony/workflows/Tests/badge.svg" alt="Tests">
+  </a>
+  <a href="https://github.com/digital-fabric/polyphony/blob/master/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License">
+  </a>
+</p>
 
 [DOCS](https://digital-fabric.github.io/polyphony/) |
 [EXAMPLES](examples)

data/TODO.md

@@ -1,5 +1,5 @@
 - Implement `LibevAgent#connect` API
-- Reimplement ResourcePool, Channel, Mutex using Queue
+
 -- Add `Fiber#schedule_with_priority` method, aliased by `Fiber#wakeup`
 - Implement agent interface is virtual function table
 - Implement proxy agent for plugging in a user-provided agent class

data/bin/stress.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+`rake recompile`
+
+count = ARGV[0] ? ARGV[0].to_i : 100
+
+TEST_CMD = 'ruby test/run.rb'
+
+def run_test(count)
+  puts "#{count}: running tests..."
+  system(TEST_CMD)
+  return if $?.exitstatus == 0
+
+  puts "Failure after #{count} tests"
+  exit!
+end
+
+trap('INT') { exit! }
+t0 = Time.now
+count.times { |i| run_test(i + 1) }
+elapsed = Time.now - t0
+puts format(
+  "Successfully ran %d tests in %f seconds (%f per test)",
+  count,
+  elapsed,
+  elapsed / count
+)

data/examples/core/xx-channels.rb

@@ -2,10 +2,12 @@
 
 require 'bundler/setup'
 require 'polyphony'
+require 'polyphony/core/channel'
 
 def echo(cin, cout)
   puts 'start echoer'
   while (msg = cin.receive)
+    puts "echoer received #{msg}"
     cout << "you said: #{msg}"
   end
 ensure
@@ -20,7 +22,7 @@ spin do
   puts 'start receiver'
   while (msg = chan2.receive)
     puts msg
-    $main.resume if msg =~ /world/
+    $main.schedule if msg =~ /world/
   end
 ensure
   puts 'receiver stopped'
@@ -42,4 +44,4 @@ $main = spin do
   puts "done #{Time.now - t0}"
 end
 
-suspend
+$main.await

data/examples/core/xx-using-a-mutex.rb

@@ -2,6 +2,7 @@
 
 require 'bundler/setup'
 require 'polyphony'
+require 'polyphony/core/sync'
 
 def loop_it(number, lock)
   loop do
@@ -13,7 +14,7 @@ def loop_it(number, lock)
   end
 end
 
-lock = Polyphony::Sync::Mutex.new
+lock = Polyphony::Mutex.new
 spin { loop_it(1, lock) }
 spin { loop_it(2, lock) }
 spin { loop_it(3, lock) }

data/ext/polyphony/event.c

@@ -0,0 +1,86 @@
+#include "polyphony.h"
+#include "ring_buffer.h"
+
+typedef struct event {
+  VALUE waiting_fiber;
+} Event_t;
+
+VALUE cEvent = Qnil;
+
+static void Event_mark(void *ptr) {
+  Event_t *event = ptr;
+  rb_gc_mark(event->waiting_fiber);
+}
+
+static void Event_free(void *ptr) {
+  xfree(ptr);
+}
+
+static size_t Event_size(const void *ptr) {
+  return sizeof(Event_t);
+}
+
+static const rb_data_type_t Event_type = {
+  "Event",
+  {Event_mark, Event_free, Event_size,},
+  0, 0, 0
+};
+
+static VALUE Event_allocate(VALUE klass) {
+  Event_t *event;
+
+  event = ALLOC(Event_t);
+  return TypedData_Wrap_Struct(klass, &Event_type, event);
+}
+
+#define GetEvent(obj, event) \
+  TypedData_Get_Struct((obj), Event_t, &Event_type, (event))
+
+static VALUE Event_initialize(VALUE self) {
+  Event_t *event;
+  GetEvent(self, event);
+
+  event->waiting_fiber = Qnil;
+
+  return self;
+}
+
+VALUE Event_signal(int argc, VALUE *argv, VALUE self) {
+  VALUE value = argc > 0 ? argv[0] : Qnil;
+  Event_t *event;
+  GetEvent(self, event);
+
+  if (event->waiting_fiber != Qnil) {
+    Fiber_make_runnable(event->waiting_fiber, value);
+    event->waiting_fiber = Qnil;
+  }
+  return self;
+}
+
+VALUE Event_await(VALUE self) {
+  Event_t *event;
+  GetEvent(self, event);
+
+  if (event->waiting_fiber != Qnil)
+    rb_raise(rb_eRuntimeError, "Event is already awaited by another fiber");
+
+  VALUE agent = rb_ivar_get(rb_thread_current(), ID_ivar_agent);
+  event->waiting_fiber = rb_fiber_current();
+  VALUE switchpoint_result = LibevAgent_wait_event(agent, Qnil);
+  event->waiting_fiber = Qnil;
+
+  TEST_RESUME_EXCEPTION(switchpoint_result);
+  RB_GC_GUARD(agent);
+  RB_GC_GUARD(switchpoint_result);
+
+  return switchpoint_result;
+}
+
+void Init_Event() {
+  cEvent = rb_define_class_under(mPolyphony, "Event", rb_cData);
+  rb_define_alloc_func(cEvent, Event_allocate);
+
+  rb_define_method(cEvent, "initialize", Event_initialize, 0);
+  rb_define_method(cEvent, "await", Event_await, 0);
+  rb_define_method(cEvent, "signal", Event_signal, -1);
+}

data/ext/polyphony/fiber.c

@@ -9,8 +9,6 @@ ID ID_trace_runnable;
 ID ID_trace_terminate;
 ID ID_trace_wait;
 
-VALUE cEvent = Qnil;
-
 VALUE SYM_dead;
 VALUE SYM_running;
 VALUE SYM_runnable;
@@ -35,9 +33,6 @@ static VALUE Fiber_safe_transfer(int argc, VALUE *argv, VALUE self) {
 
 inline VALUE Fiber_auto_watcher(VALUE self) {
   VALUE watcher;
-  if (cEvent == Qnil) {
-    cEvent = rb_const_get(mPolyphony, rb_intern("Event"));
-  }
 
   watcher = rb_ivar_get(self, ID_ivar_auto_watcher);
   if (watcher == Qnil) {

data/ext/polyphony/polyphony_ext.c

@@ -4,6 +4,7 @@ void Init_Fiber();
 void Init_Polyphony();
 void Init_LibevAgent();
 void Init_Queue();
+void Init_Event();
 void Init_Thread();
 void Init_Tracing();
 
@@ -13,6 +14,7 @@ void Init_polyphony_ext() {
   Init_Polyphony();
   Init_LibevAgent();
   Init_Queue();
+  Init_Event();
 
   Init_Fiber();
   Init_Thread();

data/ext/polyphony/queue.c

@@ -139,6 +139,18 @@ VALUE Queue_shift_all(VALUE self) {
   return ring_buffer_shift_all(&queue->values);
 }
 
+VALUE Queue_flush_waiters(VALUE self, VALUE value) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  while(1) {
+    VALUE fiber = ring_buffer_shift(&queue->shift_queue);
+    if (fiber == Qnil) return self;
+    
+    Fiber_make_runnable(fiber, value);
+  }
+}
+
 VALUE Queue_empty_p(VALUE self) {
   Queue_t *queue;
   GetQueue(self, queue);
@@ -146,6 +158,13 @@ VALUE Queue_empty_p(VALUE self) {
   return (queue->values.count == 0) ? Qtrue : Qfalse;
 }
 
+VALUE Queue_size_m(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  return INT2NUM(queue->values.count);
+}
+
 void Init_Queue() {
   cQueue = rb_define_class_under(mPolyphony, "Queue", rb_cData);
   rb_define_alloc_func(cQueue, Queue_allocate);
@@ -162,7 +181,7 @@ void Init_Queue() {
 
   rb_define_method(cQueue, "shift_each", Queue_shift_each, 0);
   rb_define_method(cQueue, "shift_all", Queue_shift_all, 0);
+  rb_define_method(cQueue, "flush_waiters", Queue_flush_waiters, 1);
   rb_define_method(cQueue, "empty?", Queue_empty_p, 0);
+  rb_define_method(cQueue, "size", Queue_size_m, 0);
 }
-
-

data/ext/polyphony/thread.c

@@ -53,11 +53,9 @@ VALUE Thread_schedule_fiber(VALUE self, VALUE fiber, VALUE value) {
   if (rb_fiber_alive_p(fiber) != Qtrue) return self;
 
   FIBER_TRACE(3, SYM_fiber_schedule, fiber, value);
-  // if fiber is already scheduled, just set the scheduled value, then return
   rb_ivar_set(fiber, ID_runnable_value, value);
-  if (rb_ivar_get(fiber, ID_runnable) != Qnil) {
-    return self;
-  }
+  // if fiber is already scheduled, just set the scheduled value, then return
+  if (rb_ivar_get(fiber, ID_runnable) != Qnil) return self;
 
   queue = rb_ivar_get(self, ID_run_queue);
   Queue_push(queue, fiber);

data/lib/polyphony.rb

@@ -23,7 +23,6 @@ require_relative './polyphony/core/global_api'
 require_relative './polyphony/core/resource_pool'
 require_relative './polyphony/net'
 require_relative './polyphony/adapters/process'
-require_relative './polyphony/event'
 
 # Main Polyphony API
 module Polyphony

data/lib/polyphony/core/channel.rb

@@ -5,42 +5,11 @@ require_relative './exceptions'
 module Polyphony
   # Implements a unidirectional communication channel along the lines of Go
   # (buffered) channels.
-  class Channel
-    def initialize
-      @payload_queue = []
-      @waiting_queue = []
-    end
+  class Channel < Polyphony::Queue
+    alias_method :receive, :shift
 
     def close
-      stop = Polyphony::MoveOn.new
-      @waiting_queue.slice(0..-1).each { |f| f.schedule(stop) }
-    end
-
-    def <<(value)
-      if @waiting_queue.empty?
-        @payload_queue << value
-      else
-        @waiting_queue.shift&.schedule(value)
-      end
-      snooze
-    end
-
-    def receive
-      Thread.current.agent.ref
-      if @payload_queue.empty?
-        @waiting_queue << Fiber.current
-        suspend
-      else
-        receive_from_queue
-      end
-    ensure
-      Thread.current.agent.unref
-    end
-
-    def receive_from_queue
-      payload = @payload_queue.shift
-      snooze
-      payload
+      flush_waiters(Polyphony::MoveOn.new)
     end
   end
 end

data/lib/polyphony/core/resource_pool.rb

@@ -10,13 +10,10 @@ module Polyphony
     # @param &block [Proc] allocator block
     def initialize(opts, &block)
       @allocator = block
-
-      @stock = []
-      @queue = []
-      @acquired_resources = {}
-
       @limit = opts[:limit] || 4
       @size = 0
+      @stock = Polyphony::Queue.new
+      @acquired_resources = {}
     end
 
     def available
@@ -25,58 +22,17 @@ module Polyphony
 
     def acquire
       fiber = Fiber.current
-      if @acquired_resources[fiber]
-        yield @acquired_resources[fiber]
-      else
-        begin
-          Thread.current.agent.ref
-          resource = wait_for_resource
-          return unless resource
-          
-          @acquired_resources[fiber] = resource
-          yield resource
-        ensure
-          @acquired_resources.delete fiber
-          Thread.current.agent.unref
-          release(resource) if resource
-        end
-      end
-    end
-        
-    def wait_for_resource
-      fiber = Fiber.current
-      @queue << fiber
-      ready_resource = from_stock
-      return ready_resource if ready_resource
+      return @acquired_resources[fiber] if @acquired_resources[fiber]
 
-      suspend
+      add_to_stock if @size < @limit && @stock.empty?
+      resource = @stock.shift
+      @acquired_resources[fiber] = resource
+      yield resource
     ensure
-      @queue.delete(fiber)
-    end
-
-    def release(resource)
-      if resource.__discarded__
-        @size -= 1
-      elsif resource
-        return_to_stock(resource)
-        dequeue
-      end
-    end
-
-    def dequeue
-      return if @queue.empty? || @stock.empty?
-
-      @queue.shift.schedule(@stock.shift)
+      @acquired_resources.delete(fiber)
+      @stock.push resource if resource
     end
-
-    def return_to_stock(resource)
-      @stock << resource
-    end
-
-    def from_stock
-      @stock.shift || (@size < @limit && allocate)
-    end
-
+        
     def method_missing(sym, *args, &block)
       acquire { |r| r.send(sym, *args, &block) }
     end
@@ -85,33 +41,15 @@ module Polyphony
       true
     end
 
-    # Extension to allow discarding of resources
-    module ResourceExtensions
-      def __discarded__
-        @__discarded__
-      end
-
-      def __discard__
-        @__discarded__ = true
-      end
-    end
-
     # Allocates a resource
     # @return [any] allocated resource
-    def allocate
-      @size += 1
-      @allocator.().tap { |r| r.extend ResourceExtensions }
-    end
-
-    def <<(resource)
+    def add_to_stock
       @size += 1
-      resource.extend ResourceExtensions
-      @stock << resource
-      dequeue
+      @stock << @allocator.call
     end
 
     def preheat!
-      (@limit - @size).times { @stock << allocate }
+      add_to_stock while @size < @limit
     end
   end
 end

data/lib/polyphony/core/sync.rb

@@ -4,18 +4,21 @@ module Polyphony
   # Implements mutex lock for synchronizing access to a shared resource
   class Mutex
     def initialize
-      @waiting_fibers = Polyphony::Queue.new
+      @store = Queue.new
+      @store << :token
     end
 
     def synchronize
-      fiber = Fiber.current
-      @waiting_fibers << fiber
-      suspend if @waiting_fibers.size > 1
-      yield
-    ensure
-      @waiting_fibers.delete(fiber)
-      @waiting_fibers.first&.schedule
-      snooze
+      return yield if @holding_fiber == Fiber.current
+
+      begin
+        token = @store.shift
+        @holding_fiber = Fiber.current
+        yield
+      ensure
+        @holding_fiber = nil
+        @store << token
+      end
     end
   end
 end

data/lib/polyphony/version.rb

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

data/test/test_event.rb

@@ -34,6 +34,7 @@ class EventTest < MiniTest::Test
       }
     }
     snooze
+
     t = Thread.new do
       orig_sleep 0.001
       3.times { a.signal }

data/test/test_queue.rb

@@ -109,4 +109,24 @@ class QueueTest < MiniTest::Test
     @queue << :foo
     assert_nil f1.await
   end
+
+  def test_queue_size
+    assert_equal 0, @queue.size
+
+    @queue.push 1
+    
+    assert_equal 1, @queue.size
+
+    @queue.push 2
+    
+    assert_equal 2, @queue.size
+
+    @queue.shift
+
+    assert_equal 1, @queue.size
+
+    @queue.shift
+
+    assert_equal 0, @queue.size
+  end
 end

data/test/test_resource_pool.rb

@@ -37,49 +37,6 @@ class ResourcePoolTest < MiniTest::Test
     assert_equal 2, pool.size
   end
 
-  def test_discard
-    resources = [+'a', +'b']
-    pool = Polyphony::ResourcePool.new(limit: 2) { resources.shift }
-
-    results = []
-    4.times {
-      spin {
-        snooze
-        pool.acquire { |resource|
-          results << resource
-          resource.__discard__ if resource == 'b'
-          snooze
-        }
-      }
-    }
-    6.times { snooze }
-
-    assert_equal ['a', 'b', 'a', 'a'], results
-    assert_equal 1, pool.size
-  end
-
-  def test_add
-    resources = [+'a', +'b']
-    pool = Polyphony::ResourcePool.new(limit: 2) { resources.shift }
-
-    pool << +'c'
-
-    results = []
-    4.times {
-      spin {
-        snooze
-        pool.acquire { |resource|
-          results << resource
-          resource.__discard__ if resource == 'b'
-          snooze
-        }
-      }
-    }
-    6.times { snooze }
-
-    assert_equal ['c', 'a', 'c', 'a'], results
-  end
-
   def test_single_resource_limit
     resources = [+'a', +'b']
     pool = Polyphony::ResourcePool.new(limit: 1) { resources.shift }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: 0.43.8
+  version: 0.43.9
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -241,6 +241,7 @@ files:
 - Rakefile
 - TODO.md
 - bin/polyphony-debug
+- bin/stress.rb
 - docs/_config.yml
 - docs/_includes/head.html
 - docs/_includes/title.html
@@ -388,6 +389,7 @@ files:
 - ext/libev/ev_win32.c
 - ext/libev/ev_wrap.h
 - ext/libev/test_libev_win32.c
+- ext/polyphony/event.c
 - ext/polyphony/extconf.rb
 - ext/polyphony/fiber.c
 - ext/polyphony/libev.c
@@ -415,7 +417,6 @@ files:
 - lib/polyphony/core/sync.rb
 - lib/polyphony/core/thread_pool.rb
 - lib/polyphony/core/throttler.rb
-- lib/polyphony/event.rb
 - lib/polyphony/extensions/core.rb
 - lib/polyphony/extensions/fiber.rb
 - lib/polyphony/extensions/io.rb

data/lib/polyphony/event.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Polyphony
-  # Event watcher for thread-safe synchronisation
-  class Event
-    def await
-      @fiber = Fiber.current
-      Thread.current.agent.wait_event(true)
-    end
-
-    def signal(value = nil)
-      @fiber&.schedule(value)
-    ensure
-      @fiber = nil
-    end
-  end
-end