polyphony 0.46.1 → 0.47.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 831c85a16a22fe3877044430a4d1cc4a270d18dc73e9ceca8d4826623ab0ddc8
-  data.tar.gz: f0432473abb769be2805ad354dddf44465789ebe2d5220f194660e4c6521ec87
+  metadata.gz: f32962c9f1004bc9c63afcaddaad91dc8878da5e8290b8e9d42d591433311c0b
+  data.tar.gz: 3b43ad185ccb0778d88d9c8ac1043bbff291ac0a55d5bee80da8b6e08a1f6493
 SHA512:
-  metadata.gz: 9bfecbed04a8052c3a885dfde73975694313801d2a8341260041be84e4910ac459af71766f7df6fa96e5afad66a737b97e36531811bd47cab407ad43b239e073
-  data.tar.gz: 2caa40f7193cf1954b69adc5810844ad4e578a4472382602a6ee4204d548e8327344f913bc0aef076030e7deacb911cab1733b281f7a2e8849ffcbd009a00ebc
+  metadata.gz: b4ba80ea441862f22398e624996144e9ed7f8297b56e2f14035c537671282f4338b3843ff192959a7031134e761d273c5050043b08b5051c1653ecc3f986cddb
+  data.tar.gz: '04850a036f5278d221b6610259e70fbb7e44e8afd04237d9a6906fa826a836c786734123894a0b7197c5c98502a9b5304896b09a1e7b6d16433e363dbd1803e6'

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 0.47.4
+
+* Add support for Unix sockets
+
+## 0.47.3
+
+* Enable I/O in signal handlers (#45)
+* Accept `:interval` argument in `#spin_loop`
+
+## 0.47.2
+
+* Fix API compatibility between TCPSocket and IO
+
+## 0.47.0
+
+* Implement `#spin_scope` used for creating blocking fiber scopes 
+* Reimplement `move_on_after`, `cancel_after`, `Timeout.timeout` using
+  `Backend#timeout` (avoids creating canceller fiber for most common use case)
+* Implement `Backend#timeout` API
+* Implemented capped queues
+
 ## 0.46.1
 
 * Add `TCPServer#accept_loop`, `OpenSSL::SSL::SSLSocket#accept_loop` method

data/Gemfile.lock

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

data/TODO.md

@@ -1,5 +1,42 @@
+- Graceful shutdown again:
+
+  - Add `Polyphony::GracefulShutdown` exception
+  - Two exceptions for stopping fibers:
+    - `Polyphony::GracefulShutdown` - graceful shutdown
+    - `Polyphony::Terminate` - ungraceful shutdown
+  - Fiber API:
+    - `Fiber#shutdown_children` - graceful shutdown of all children
+    - `Fiber#terminate_children` - ungraceful shutdown of all children
+
+  - Add `Fiber#graceful_shutdown?` method
+    - Returns false unless a `Polyphony::GracefulShutdown` was raised
+  - Override `Polyphony::Terminate#invoke` to reset the `@graceful_shutdown` fiber
+    flag
+
+  And then we have:
+
+  ```ruby
+  spin do
+    loop { do_some_stuff }
+  ensure
+    return unless Fiber.current.graceful_shutdown?
+
+  shutdown_gracefully
+  end
+  ```
+
+  - When a fiber is stopped it should use `Polyphony::Terminate` to stop child
+    fibers, *unless* it was stopped with a `Polyphony::GracefulShutdown` (which it
+    can check with `@graceful_shutdown`).
+
+- More tight loops
+  - IO#gets_loop, Socket#gets_loop, OpenSSL::Socket#gets_loop (medium effort)
+  - Fiber#receive_loop (very little effort, should be implemented in C)
+
 ## Roadmap for Polyphony 1.0
 
+- check integration with rb-inotify
+
 - Check why worker-thread example doesn't work.
 - Add test that mimics the original design for Monocrono:
   - 256 fibers each waiting for a message
@@ -192,17 +229,3 @@ Prior art:
 
 - https://github.com/socketry/async-dns
 
-## Work on API
-
-- Add option for setting the exception raised on cancelling using `#cancel_after`:
-
-```ruby
-cancel_after(3, with_error: MyErrorClass) do
-  do_my_thing
-end
-# or a RuntimeError with message
-cancel_after(3, with_error: 'Cancelled due to timeout') do
-  do_my_thing
-end
-```
-

data/examples/core/enumerable.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+
+Exception.__disable_sanitized_backtrace__ = true
+
+module Enumerable
+  def map_concurrently(&block)
+    spin do
+      results = []
+      each_with_index do |i, idx|
+        spin { results[idx] = block.(i) }
+      end
+      Fiber.current.await_all_children
+      results
+    end.await
+  end
+
+  def each_concurrently(max_fibers: nil, &block)
+    return each_concurrently_with_fiber_pool(max_fibers, &block) if max_fibers
+
+    spin do
+      results = []
+      each do |i|
+        spin(&block).schedule(i)
+      end
+      Fiber.current.await_all_children
+    end.await
+    self
+  end
+
+  def each_concurrently_with_fiber_pool(max_fibers, &block)
+    spin do
+      fiber_count = 0
+      workers = []
+      each do |i|
+        if fiber_count < max_fibers
+          workers << spin do
+            loop do
+              item = receive
+              break if item == :__stop__
+              block.(item)
+            end
+          end
+        end
+
+        fiber = workers.shift
+        fiber << i
+        workers << fiber
+      end
+      workers.each { |f| f << :__stop__ }
+      Fiber.current.await_all_children
+    end.await
+    self
+  end
+end
+
+o = 1..3
+o.each_concurrently(max_fibers: 2) do |i|
+  puts "#{Fiber.current} sleep #{i}"
+  sleep(i)
+  puts "wakeup #{i}"
+end

data/examples/io/unix_socket.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+require 'fileutils'
+
+unix_path = '/tmp/polyphony-unix-socket'
+
+FileUtils.rm unix_path rescue nil
+server = UNIXServer.new(unix_path)
+spin do
+  server.accept_loop do |socket|
+    p [:accept, socket]
+    spin do
+      while (line = socket.gets)
+        socket.puts line
+      end
+    end
+  end
+end
+
+snooze
+client = UNIXSocket.new('/tmp/polyphony-unix-socket')
+p [:connected, client]
+client.puts 'hello!'
+p client.gets

data/examples/performance/fiber_resume.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'fiber'
+
+class Fiber
+  attr_accessor :next
+end
+
+# This program shows how the performance of Fiber.transfer degrades as the fiber
+# count increases
+
+def run(num_fibers)
+  count = 0
+
+  GC.start
+  GC.disable
+
+  fibers = []
+  num_fibers.times do
+    fibers << Fiber.new { loop { Fiber.yield } }
+  end
+
+  t0 = Time.now
+
+  while count < 1000000
+    fibers.each do |f|
+      count += 1
+      f.resume
+    end
+  end
+
+  elapsed = Time.now - t0
+
+  puts "fibers: #{num_fibers} count: #{count} rate: #{count / elapsed}"
+rescue Exception => e
+  puts "Stopped at #{count} fibers"
+  p e
+end
+
+run(100)
+run(1000)
+run(10000)
+run(100000)

data/examples/performance/thread-vs-fiber/compare.rb

@@ -0,0 +1,59 @@
+SERVERS = {
+  polyphony: {
+    port: 1234,
+    cmd: 'ruby examples/performance/thread-vs-fiber/polyphony_server.rb'
+  },
+  threaded: {
+    port: 1235,
+    cmd: 'ruby examples/performance/thread-vs-fiber/threaded_server.rb'
+  },
+  em: {
+    port: 1236,
+    cmd: 'ruby examples/performance/thread-vs-fiber/em_server.rb'
+  }
+}
+SETTINGS = [
+  '-t1 -c1',
+  '-t4 -c8',
+  '-t8 -c64',
+  '-t16 -c512',
+  '-t32 -c4096',
+  '-t64 -c8192',
+  '-t128 -c16384',
+  '-t256 -c32768'
+]
+
+def run_test(name, port, cmd, setting)
+  puts "*" * 80
+  puts "Run #{name} (#{port}): #{setting}"
+  puts "*" * 80
+  
+  pid = spawn("#{cmd} > /dev/null 2>&1")
+  sleep 1
+
+  output = `wrk -d60 #{setting} \"http://127.0.0.1:#{port}/\"`
+  puts output
+  (output =~ /Requests\/sec:\s+(\d+)/) && $1.to_i
+ensure
+  Process.kill('KILL', pid)
+  Process.wait(pid)
+  3.times { puts }
+end
+
+def perform_benchmark
+  results = []
+  SETTINGS.each do |s|
+    results << SERVERS.inject({}) do |h, (n, o)|
+      h[n] = run_test(n, o[:port], o[:cmd], s)
+      h
+    end
+  end
+  results
+end
+
+results = []
+3.times { results << perform_benchmark }
+
+require 'pp'
+puts "results:"
+pp results

data/examples/performance/thread-vs-fiber/em_server.rb

@@ -0,0 +1,33 @@
+require 'eventmachine'
+require 'http/parser'
+require 'socket'
+
+module HTTPServer
+  def post_init
+    @parser = Http::Parser.new
+    @pending_requests = []
+    @parser.on_message_complete = proc { @pending_requests << @parser }
+  end
+
+  def receive_data(data)
+    @parser << data
+    write_response while @pending_requests.shift
+  end
+
+  def write_response
+    status_code = "200 OK"
+    data = "Hello world!\n"
+    headers = "Content-Type: text/plain\r\nContent-Length: #{data.bytesize}\r\n"
+    send_data "HTTP/1.1 #{status_code}\r\n#{headers}\r\n#{data}"
+  end
+end
+
+EventMachine::run do
+  EventMachine::start_server(
+    '0.0.0.0',
+    1236,
+    HTTPServer
+  )
+  puts "pid #{Process.pid} EventMachine listening on port 1236"
+
+end

data/examples/performance/thread-vs-fiber/polyphony_server.rb

@@ -27,7 +27,8 @@ def write_response(socket)
 end
 
 server = TCPServer.open('0.0.0.0', 1234)
-puts "pid #{Process.pid}"
-puts "listening on port 1234"
+puts "pid #{Process.pid} Polyphony (#{Thread.current.backend.kind}) listening on port 1234"
 
-server.accept_loop { |c| handle_client(c) }
+server.accept_loop do |c|
+  spin { handle_client(c) }
+end

data/examples/performance/thread-vs-fiber/threaded_server.rb

@@ -1,23 +1,30 @@
-require 'thread'
 require 'http/parser'
 require 'socket'
 
-def handle_client(client)
-  Thread.new do
-    parser = Http::Parser.new
-    parser.on_message_complete = proc do |env|
-      status_code = 200
-      data = "Hello world!\n"
-      headers = "Content-Length: #{data.bytesize}\r\n"
-      client.write "HTTP/1.1 #{status_code}\r\n#{headers}\r\n#{data}"
-    end
-    client.read_loop { |data| parser << data }
-    client.close
+def handle_client(socket)
+  pending_requests = []
+  parser = Http::Parser.new
+  parser.on_message_complete = proc { pending_requests << parser }
+
+  while (data = socket.recv(8192))
+    parser << data
+    write_response(socket) while pending_requests.shift
   end
+rescue IOError, SystemCallError => e
+  # ignore
+ensure
+  socket.close
+end
+
+def write_response(socket)
+  status_code = "200 OK"
+  data = "Hello world!\n"
+  headers = "Content-Type: text/plain\r\nContent-Length: #{data.bytesize}\r\n"
+  socket.write "HTTP/1.1 #{status_code}\r\n#{headers}\r\n#{data}"
 end
 
-server = TCPServer.open(1234)
-puts "Listening on port 1234"
+server = TCPServer.open(1235)
+puts "pid #{Process.pid} threaded listening on port 1235"
 while socket = server.accept
-  handle_client(socket)
+  Thread.new { handle_client(socket) }
 end

data/examples/performance/thread_switch.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'fiber'
+
+class Fiber
+  attr_accessor :next
+end
+
+# This program shows how the performance of Fiber.transfer degrades as the fiber
+# count increases
+
+def run(num_threads)
+  count = 0
+
+  GC.start
+  GC.disable
+
+  threads = []
+  t0 = Time.now
+  limit = 10_000_000 / num_threads
+  num_threads.times do
+    threads << Thread.new do
+      individual_count = 0
+      loop do
+        individual_count += 1
+        count += 1
+        break if individual_count == limit
+      end
+    end
+  end
+
+  threads.each(&:join)
+  elapsed = Time.now - t0
+
+  puts "threads: #{num_threads} count: #{count} rate: #{count / elapsed}"
+rescue Exception => e
+  puts "Stopped at #{count} threads"
+  p e
+end
+
+run(100)
+run(1000)
+run(10000)
+run(100000)

data/ext/polyphony/backend_common.h

@@ -3,6 +3,26 @@
 #include "ruby.h"
 #include "ruby/io.h"
 
+VALUE cTCPSocket;
+VALUE cTCPServer;
+VALUE cUNIXSocket;
+VALUE cUNIXServer;
+
+void Init_SocketClasses() {
+  rb_require("socket");
+  cTCPSocket = rb_const_get(rb_cObject, rb_intern("TCPSocket"));
+  cTCPServer = rb_const_get(rb_cObject, rb_intern("TCPServer"));
+  cUNIXSocket = rb_const_get(rb_cObject, rb_intern("UNIXSocket"));
+  cUNIXServer = rb_const_get(rb_cObject, rb_intern("UNIXServer"));
+}
+
+VALUE ConnectionSocketClass(VALUE server) {
+  if (RTEST(rb_obj_is_kind_of(server, cTCPServer))) return cTCPSocket;
+  if (RTEST(rb_obj_is_kind_of(server, cUNIXServer))) return cUNIXSocket;
+
+  rb_raise(rb_eRuntimeError, "Invalid server class");
+}
+
 //////////////////////////////////////////////////////////////////////
 //////////////////////////////////////////////////////////////////////
 // the following is copied verbatim from the Ruby source code (io.c)
@@ -118,3 +138,12 @@ inline double current_time() {
   double t = ns;
   return t / 1e9;
 }
+
+inline VALUE backend_timeout_exception(VALUE exception) {
+  if (RTEST(rb_obj_is_kind_of(exception, rb_cArray)))
+    return rb_funcall(rb_ary_entry(exception, 0), ID_new, 1, rb_ary_entry(exception, 1));
+  else if (RTEST(rb_obj_is_kind_of(exception, rb_cClass)))
+    return rb_funcall(exception, ID_new, 0);
+  else
+    return rb_funcall(rb_eRuntimeError, ID_new, 1, exception);
+}