right_speed 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a21c10b045dfb5591600c16d61a7fa9d09771db4960e0d3c3021b90c8fbdc48c
-  data.tar.gz: a71b06cde0b6b1028aabdab601673d827040824db08d6fce181c9c9816669d74
+  metadata.gz: 4a0fe25cf32e28c2aac8ee6c2621bd3d4dafef2823fffa4063e7ef6a3215f8f8
+  data.tar.gz: 9f77da3078ba68ac534e4124f858920d24d2b78b8b5077e4ebd5d7d874613acf
 SHA512:
-  metadata.gz: 490fb8ff447db76d7cdc16980d547de1b078d9648afe9534804a638abb708d63f572b84a64489707fedad4dfd29caf046b96456b390064ada334a7b14953b556
-  data.tar.gz: 52e3d420c923a0593f463aeff793911000bce92b8855723f02fa7ffc4e3da3744779d264e29f5ee0b4e46f5a63e5570a39c33f4c79d8c1cd3c2f4e718c6315bf
+  metadata.gz: 8ff327d684d9ac4e0404640512e5c40250c5a33bc89018f624257da6239d787527382e232b0b09845bbf5e96d466e12bd9968f2a07724c9f5ebcbc10556e5500
+  data.tar.gz: efa47cb44fd9fbf9b370cc451fde661aca0a7b2ea9bbb896780fcf860c6957dce9e20c87b39f1c027df823202fad926194dcdf680fdc948639dfbdf3edd843ca

data/README.md

@@ -12,8 +12,17 @@ Currently, RightSpeed supports the very limited set of Rack protocol specificati
 * Handling multipart contents flexisbly (using `rack.multipart.buffer_size` nor `rack.multipart.tempfile_factory`)
 * [Hijacking](https://github.com/rack/rack/blob/master/SPEC.rdoc#label-Hijacking)
 
+### Is Ractor-based server faster than prefork processes?
+
+It can be. In our opinion, it may not be a tremendous difference, but could be a little improvement because:
+* Accepted connection delivery inter-Ractor should be faster than bringing those over IPC
+* JIT compilation can be just once using multiple Ractor
+* ... and?
+
 ## Changelog
 
+* v0.2.0:
+  * Add worker-type "fair" and "accept" in addition to "roundrobin"
 * v0.1.0:
   * The first release just before RubyKaigi Takeout 2021
 
@@ -27,7 +36,7 @@ Install `right_speed` by `gem` command (`gem i right_speed`), then use it direct
 $ right_speed -c config.ru -p 8080 --workers 8
 
 # See right_speed --help for full options:
-$ right_speed --help
+$ bundle exec ruby bin/right_speed --help
 Usage: right_speed [options]
 
 OPTIONS
@@ -35,7 +44,7 @@ OPTIONS
   --port, -p PORT       The port number to listen (default: 8080)
   --backlog NUM         The number of backlog
   --workers NUM         The number of Ractors (default: CPU cores)
-  --worker-type TYPE    The type of workers, available options are read/accept (default: read)
+  --worker-type TYPE    The type of workers (available: roundrobin/fair/accept, default: roundrobin)
   --help                Show this message
 ```
 
@@ -47,6 +56,22 @@ $ rackup config.ru -s right_speed -p 8080 -O Workers=8
 
 The default number of worker Ractors is the number of CPU cores.
 
+### Worker Types
+
+The `--worker-type` option is to try some patterns of use of Ractors.
+
+* `roundrobin`
+  * Listener Ractor will accept connections, then send those to Worker Ractors in round-robin
+  * Worker Ractors will consume their input connections one-by-one
+* `fair`
+  * Listener Ractor will accept connections, and yield those to consumers (workers)
+  * Worker Ractors will take connections from Listener as soon as they become available
+* `accept`
+  * Listener does nothing
+  * Worker Ractors will accept connections, process requests individually
+
+Currently, any of above workers cannot work well. We observed SEGV or Ruby runtime busy after traffic in seconds.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tagomoris/right_speed.

data/bin/right_speed

@@ -26,10 +26,8 @@ module RightSpeed
     DEFAULT_PORT = Server::DEFAULT_PORT
     DEFAULT_WORKERS = Env.processors
     DEFAULT_WORKER_TYPE = Server::DEFAULT_WORKER_TYPE
-    DEFAULT_LISTENER_TYPE = Server::DEFAULT_LISTENER_TYPE
 
-    AVAILABLE_WORKER_TYPES = Server::AVAILABLE_WORKER_TYPES.map(:to_s).join('/')
-    AVAILABLE_LISTENER_TYPES = Server::AVAILABLE_LISTENER_TYPES.map(:to_s).join('/')
+    AVAILABLE_WORKER_TYPES = Server::AVAILABLE_WORKER_TYPES.map(&:to_s).join('/')
 
     def self.show_help(error: false, error_message: nil)
       STDERR.puts(error_message, "\n") if error_message

data/lib/right_speed/connection_closer.rb

@@ -4,6 +4,10 @@ require_relative "logger"
 
 module RightSpeed
   class ConnectionCloser
+    # This class was introduced to serialize closing connections
+    # (instead of closing those in each Ractor) to try to avoid SEGV.
+    # But SEGV is still happening, so this class may not be valueable.
+
     def run(workers)
       @ractor = Ractor.new(workers) do |workers|
         logger = RightSpeed.logger
@@ -23,5 +27,9 @@ module RightSpeed
         logger.error { "Unexpected error, #{e.class}:#{e.message}" }
       end
     end
+
+    def wait
+      @ractor.take
+    end
   end
 end

data/lib/right_speed/listener.rb

@@ -4,10 +4,12 @@ require_relative "logger"
 
 module RightSpeed
   module Listener
-    def self.setup(listener_type:, host:, port:, backlog: nil)
-      case listener_type
+    def self.setup(worker_type:, host:, port:, backlog: nil)
+      case worker_type
       when :roundrobin
         RoundRobinListener.new(host, port, backlog)
+      when :fair
+        FairListener.new(host, port, backlog)
       else
         SimpleListener.new(host, port, backlog)
       end
@@ -23,7 +25,7 @@ module RightSpeed
         @sock = nil
       end
 
-      def run(_processor)
+      def run
         @running = true
         @sock = TCPServer.open(@host, @port)
         @sock.listen(@backlog) if @backlog
@@ -43,6 +45,8 @@ module RightSpeed
     end
 
     class RoundRobinListener < SimpleListener
+      attr_reader :ractor
+
       def run(processor)
         @running = true
         @ractor = Ractor.new(@host, @port, @backlog, processor) do |host, port, backlog, processor|
@@ -65,5 +69,11 @@ module RightSpeed
         @ractor = nil # TODO: terminate the Ractor if possible
       end
     end
+
+    class FairListener < RoundRobinListener
+      def wait
+        # nothing to wait - @ractor.take consumes accepted connections unexpectedly
+      end
+    end
   end
 end

data/lib/right_speed/processor.rb

@@ -3,7 +3,8 @@
 require 'rack/builder'
 
 require_relative 'worker/accepter'
-require_relative 'worker/reader'
+require_relative 'worker/fair'
+require_relative 'worker/roundrobin'
 require_relative 'connection_closer'
 
 module RightSpeed
@@ -18,8 +19,10 @@ module RightSpeed
             end
       handler = Ractor.make_shareable(Handler.new(app))
       case worker_type
-      when :read
-        ReadProcessor.new(workers, handler)
+      when :roundrobin
+        RoundRobinProcessor.new(workers, handler)
+      when :fair
+        FairProcessor.new(workers, handler)
       when :accept
         AcceptProcessor.new(workers, handler)
       else
@@ -63,11 +66,11 @@ module RightSpeed
       end
     end
 
-    class ReadProcessor < Base
+    class RoundRobinProcessor < Base
       def initialize(workers, handler)
         @worker_num = workers
         @handler = handler
-        @workers = workers.times.map{|i| Worker::Reader.new(id: i, handler: @handler)}
+        @workers = workers.times.map{|i| Worker::RoundRobin.new(id: i, handler: @handler)}
         @closer = ConnectionCloser.new
         @counter = 0
       end
@@ -89,6 +92,35 @@ module RightSpeed
 
       def wait
         @workers.each{|w| w.wait}
+        @closer.wait
+      end
+    end
+
+    class FairProcessor < Base
+      def initialize(workers, handler)
+        @worker_num = workers
+        @handler = handler
+        @workers = workers.times.map{|i| Worker::Fair.new(id: i, handler: @handler)}
+        @closer = ConnectionCloser.new
+      end
+
+      def configure(listener:)
+        @listener = listener
+      end
+
+      def run
+        @listener.run(self)
+        @workers.each{|w| w.run(@listener.ractor)}
+        @closer.run(@workers.map{|w| w.ractor})
+      end
+
+      def process(conn)
+        Ractor.yield(conn, move: true)
+      end
+
+      def wait
+        # listener, workers are using those outgoing to pass connections
+        @closer.wait
       end
     end
 
@@ -97,24 +129,22 @@ module RightSpeed
         @worker_num = workers
         @handler = handler
         @workers = workers.times.map{|i| Worker::Accepter.new(id: i, handler: @handler) }
+        @closer = ConnectionCloser.new
       end
 
       def configure(listener:)
         @listener = listener
-        @workers.each do |w|
-          w.configure(listener.sock)
-        end
       end
 
       def run
-        @workers.each do |w|
-          w.run
-        end
-        # TODO: connection closer
+        @listener.run
+        @workers.each{|w| w.run(@listener.sock)}
+        @closer.run(@workers.map{|w| w.ractor})
       end
 
       def wait
-        @workers.each{|w| w.wait}
+        # workers are using those outgoing to pass connections
+        @closer.wait
       end
     end
   end

data/lib/right_speed/server.rb

@@ -15,12 +15,10 @@ module RightSpeed
   class Server
     DEFAULT_HOST = "127.0.0.1"
     DEFAULT_PORT = 8080
-    DEFAULT_WORKER_TYPE = :read
+    DEFAULT_WORKER_TYPE = :roundrobin
     DEFAULT_WORKERS = Env.processors
-    DEFAULT_SCHEDULER_TYPE = :roundrobin
 
-    AVAILABLE_WORKER_TYPES = [:read, :accept]
-    AVAILABLE_LISTENER_TYPES = [:roundrobin, :fair]
+    AVAILABLE_WORKER_TYPES = [:roundrobin, :fair, :accept]
 
     attr_reader :config_hooks
 
@@ -30,7 +28,6 @@ module RightSpeed
           port: DEFAULT_PORT,
           workers: DEFAULT_WORKERS,
           worker_type: DEFAULT_WORKER_TYPE,
-          scheduler_type: DEFAULT_SCHEDULER_TYPE,
           backlog: nil
         )
       @host = host
@@ -38,10 +35,6 @@ module RightSpeed
       @app = app
       @workers = workers
       @worker_type = worker_type
-      @listener_type = case @worker_type
-                       when :read then scheduler_type
-                       else :listen
-                       end
       @backlog = backlog
       @config_hooks = []
       @logger = nil
@@ -63,7 +56,7 @@ module RightSpeed
 
       begin
         processor = Processor.setup(app: @app, worker_type: @worker_type, workers: @workers)
-        listener = Listener.setup(listener_type: @listener_type, host: @host, port: @port, backlog: nil)
+        listener = Listener.setup(worker_type: @worker_type, host: @host, port: @port, backlog: nil)
         processor.configure(listener: listener)
         processor.run
         listener.wait

data/lib/right_speed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RightSpeed
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/right_speed/worker/accepter.rb

@@ -3,27 +3,27 @@ require_relative 'base'
 module RightSpeed
   module Worker
     class Accepter < Base
-      def configure(sock)
-        @sock = sock
-      end
-
-      def run
-        @ractor = Ractor.new(@id, @sock) do |id, sock|
+      def run(sock)
+        @ractor = Ractor.new(@id, sock, @handler) do |id, sock, handler|
+          logger = RightSpeed.logger
           while conn = sock.accept
             begin
-              data = conn.read
-              # TODO: process it
-              logger.info "[read|#{id}] Data: #{data}"
-              conn.write "200 OK"
-            ensure
-              conn.close rescue nil
+              handler.session(conn).process
+              # TODO: keep-alive?
+              Ractor.yield(conn, move: true) # to yield closing connections to ConnectionCloser
+            rescue => e
+              logger.error { "Unexpected error: #{e.message}\n" + e.backtrace.map{"\t#{_1}\n"}.join }
+              # TODO: print backtrace in better way
             end
           end
+          logger.info { "Worker#{id}: Finishing the Ractor" }
+          Ractor.yield(:closing) # to tell the outgoing path will be closed when stopping
         end
       end
 
       def wait
-        @ractor.take
+        # nothing to wait - @ractor.take consumes closed connections unexpectedly
+        # @ractor.wait ?
       end
     end
   end

data/lib/right_speed/worker/base.rb

@@ -4,16 +4,14 @@ require_relative "../handler"
 module RightSpeed
   module Worker
     class Base
+      attr_reader :ractor
+
       def initialize(id:, handler:)
         @id = id
         @handler = handler
         @ractor = nil
       end
 
-      def ractor
-        @ractor
-      end
-
       def stop
         @ractor # TODO: terminate if possible
       end

data/lib/right_speed/worker/fair.rb

@@ -0,0 +1,35 @@
+require_relative "base"
+require_relative "../logger"
+
+module RightSpeed
+  module Worker
+    class Fair < Base
+      def run(listener_ractor)
+        @ractor = Ractor.new(@id, @handler, listener_ractor) do |id, handler, listener|
+          logger = RightSpeed.logger
+          while conn = listener.take
+            begin
+              handler.session(conn).process
+              # TODO: keep-alive?
+              Ractor.yield(conn, move: true) # to yield closing connections to ConnectionCloser
+            rescue => e
+              logger.error { "Unexpected error: #{e.message}\n" + e.backtrace.map{"\t#{_1}\n"}.join }
+              # TODO: print backtrace in better way
+            end
+          end
+          logger.info { "Worker#{id}: Finishing the Ractor" }
+          Ractor.yield(:closing) # to tell the outgoing path will be closed when stopping
+        end
+      end
+
+      def process(conn)
+        raise "BUG: Worker::Fair#process should never be called"
+      end
+
+      def wait
+        # nothing to wait - @ractor.take consumes closed connections unexpectedly
+        # @ractor.wait ?
+      end
+    end
+  end
+end

data/lib/right_speed/worker/{reader.rb → roundrobin.rb}

@@ -3,7 +3,7 @@ require_relative "../logger"
 
 module RightSpeed
   module Worker
-    class Reader < Base
+    class RoundRobin < Base
       def run
         @ractor = Ractor.new(@id, @handler) do |id, handler|
           logger = RightSpeed.logger

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_speed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Satoshi Moris Tagomori
@@ -109,7 +109,8 @@ files:
 - lib/right_speed/version.rb
 - lib/right_speed/worker/accepter.rb
 - lib/right_speed/worker/base.rb
-- lib/right_speed/worker/reader.rb
+- lib/right_speed/worker/fair.rb
+- lib/right_speed/worker/roundrobin.rb
 - right_speed.gemspec
 homepage: https://github.com/tagomoris/right_speed
 licenses: