funl 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f896217f8f6185a6894823174f381b98be0af3d
-  data.tar.gz: 497d37bb1d3180d02e12eeebcbd47d643ed836cd
+  metadata.gz: 0b5ff91baeb01956c2e26427666b5ce60086a777
+  data.tar.gz: 49f96709858f97aa437782f3059dcda83d69cc39
 SHA512:
-  metadata.gz: dded12ff33c1585f69b04305b1942850734bd49017c01d277785907278f2fff0ea09cc664792df414187c86a75fbf96b84784ecd2abd157b469ecfd3687a707d
-  data.tar.gz: aa9fb5d8155ee50e9366327e2457e88bdfd0da12b92de899b8597855bbc9626f82bd69035858fb3999d0c84c143685d70e215519f245d1d97a0da6a7a537864e
+  metadata.gz: 022c1cfec28b024802f721039fbfe7aa5a4adff0f11b2f3bac58507dbdf6142a0507f340a85c9ce04d106424d617bd960911cb47fedb38431ed5735897e30217
+  data.tar.gz: fc5c636c27a20f99600f1c8fa208794cade737d11a225d6f9d054ead7fa033c42c0c24e7130a69ce69e9f3fee481349f7a1c5c7560eb59cea4d08e97f21b1571

data/README.md

@@ -1,4 +1,8 @@
 funl
 ====
 
-Sequences messages.
+Sequences messages.
+
+Funl is an [atomic broadcast protocol] (https://en.wikipedia.org/wiki/Atomic_broadcast).
+
+Funl is primarily developed for [tupelo] (https://github.com/vjoel/tupelo).

data/bench/funl-bench.rb

@@ -0,0 +1,132 @@
+require 'funl/message-sequencer-select'
+require 'funl/message-sequencer-nio'
+require 'socket'
+require 'tmpdir'
+
+include Funl
+
+class BenchmarkTask
+  attr_reader :name, :params
+
+  def initialize name, **params
+    @name = name
+    @params = params
+  end
+  
+  def inspect
+    ps = params.map{|k,v| "#{k}: #{v}" }
+    pstr = ps.empty? ? "" : " " + ps.join(', ')
+    "<#{name}#{pstr}>"
+  end
+end
+
+class WarmupTask < BenchmarkTask
+  def run make_stream
+    make_stream["1"]
+  end
+end
+
+# All clients run in the same process; mseq server is in a child process.
+class BenchmarkEnv
+  attr_reader :name, :dir, :path, :log, :stream_type, :tasks, :mseq_class
+
+  def initialize name, stream_type: ObjectStream::MSGPACK_TYPE,
+        mseq_class: MessageSequencer
+    @name = name
+    @log = Logger.new($stderr)
+    log.level = Logger::WARN
+    @stream_type = stream_type
+    @tasks = []
+    @mseq_class = mseq_class
+  end
+
+  def add_task task
+    @tasks << task
+  end
+  alias << add_task
+
+  def run
+    @dir = Dir.mktmpdir "funl-benchmark-#{name}-"
+    @path = File.join(dir, "sock")
+    svr = UNIXServer.new(path)
+    s0, s1 = UNIXSocket.pair
+    @pid = fork do
+      run_server svr, s1
+    end
+
+    log.progname = "client"
+
+    @mseq_ctrl = ObjectStreamWrapper.new(s0, type: stream_type)
+
+    puts mseq_class
+    printf "%6s %6s | %s\n", "client", "server", "task"
+    puts "-"*60
+    tasks.each do |task|
+      run_task task
+    end
+  ensure
+    close
+  end
+
+  def run_server svr, s
+    log.progname = "#{name}-mseq"
+    mseq = mseq_class.new svr, log: log,  stream_type: stream_type
+    mseq.start
+
+    run_control_loop(s)
+  rescue => ex
+    log.error ex
+  end
+
+  def run_control_loop s
+    t0 = Process.times
+    stream = ObjectStreamWrapper.new(s, type: stream_type)
+    loop do
+      stream.read do |msg|
+        case msg
+        when "dt"
+          t1 = Process.times
+          dt = t1.utime + t1.stime - (t0.utime + t0.stime)
+          t0 = t1
+          stream << dt
+        ## when GC start|enable|disable
+        else
+          raise "unknown control message: #{msg.inspect}"
+        end
+      end
+    end
+  end
+
+  def run_task task
+    t0 = Process.times
+    @mseq_ctrl << "dt"
+    task.run method(:make_stream)
+    t1 = Process.times
+    @mseq_ctrl << "dt"
+    
+    @mseq_ctrl.read
+    dt = @mseq_ctrl.read
+    
+    time = t1.utime + t1.stime - (t0.utime + t0.stime)
+    printf "%6.3f %6.3f | %p\n", time, dt, task
+  rescue => ex
+    log.error "#{task.inspect}: #{ex}"
+  end
+
+  def make_stream client_id = nil ## subscriptions?
+    conn = UNIXSocket.new(path)
+    stream = ObjectStreamWrapper.new(conn, type: stream_type)
+    stream.write_to_outbox({"client_id" => client_id})
+    stream.write(Message.control(SUBSCRIBE_ALL))
+    global_tick = stream.read["tick"]
+    stream.expect Message
+    ack = stream.read
+    stream
+  end
+
+  def close
+    Process.kill "TERM", @pid if @pid
+    Process.waitpid @pid
+    FileUtils.remove_entry dir if dir
+  end
+end

data/bench/msg-rate.rb

@@ -0,0 +1,56 @@
+require_relative 'funl-bench'
+
+# Measure the message rate through the sequencer.
+class MessageRateBenchmarkTask < BenchmarkTask
+  def run make_stream
+    n_msg = params[:n_msg] || 10
+    n_cli = params[:n_cli] || 2
+    cycle_sender = params[:cycle_sender] || false
+    
+    streams = n_cli.times.map {|i| make_stream[i]}
+    threads = n_cli.times.map do |i|
+      Thread.new do
+        n_msg.times do
+          streams[i].read
+        end
+      end
+    end
+    
+    n_msg.times do |i|
+      stream = cycle_sender ? streams[i % n_cli] : streams[0]
+      stream <<
+        Message[client: "1", local: i, global: nil, delta: nil,
+          tags: nil, blob: nil]
+    end
+    
+    threads.each {|th| th.join}
+  end
+end
+
+if __FILE__ == $0
+  b_sel = BenchmarkEnv.new("msg-rate", mseq_class: MessageSequencerSelect)
+
+  b_sel << WarmupTask.new("warmup")
+  b_sel << MessageRateBenchmarkTask.new("msg rate", n_msg: 100, n_cli: 2)
+  b_sel << MessageRateBenchmarkTask.new("msg rate", n_msg: 1000, n_cli: 2)
+  b_sel << MessageRateBenchmarkTask.new("msg rate", n_msg: 1000, n_cli: 10)
+#  b_sel << MessageRateBenchmarkTask.new("msg rate", n_msg: 1000, n_cli: 10,
+#    cycle_sender: false)
+#  b_sel << MessageRateBenchmarkTask.new("msg rate", n_msg: 1000, n_cli: 100)
+
+  b_sel.run
+  
+  puts
+
+  b_nio = BenchmarkEnv.new("msg-rate", mseq_class: MessageSequencerNio)
+
+  b_nio << WarmupTask.new("warmup")
+  b_nio << MessageRateBenchmarkTask.new("msg rate", n_msg: 100, n_cli: 2)
+  b_nio << MessageRateBenchmarkTask.new("msg rate", n_msg: 1000, n_cli: 2)
+  b_nio << MessageRateBenchmarkTask.new("msg rate", n_msg: 1000, n_cli: 10)
+#  b_nio << MessageRateBenchmarkTask.new("msg rate", n_msg: 1000, n_cli: 10,
+#    cycle_sender: false)
+#  b_nio << MessageRateBenchmarkTask.new("msg rate", n_msg: 1000, n_cli: 100)
+
+  b_nio.run
+end

data/lib/funl/message-sequencer-nio.rb

@@ -0,0 +1,37 @@
+require 'nio'
+require 'funl/message-sequencer'
+
+module Funl
+  class MessageSequencerNio < MessageSequencer
+    private
+
+    attr_reader :selector
+    
+    def init_selector
+      @selector = NIO::Selector.new
+      if server
+        monitor = selector.register server, :r
+        monitor.value = proc {accept_conn}
+      end
+    end
+
+    def register_stream stream
+      monitor = selector.register stream, :r
+      monitor.value = proc {read_conn stream}
+    end
+
+    def deregister_stream stream
+      selector.deregister stream
+    end
+
+    def registered_stream? stream
+      selector.registered? stream
+    end
+
+    def select_streams
+      selector.select do |monitor|
+        monitor.value.call(monitor)
+      end
+    end
+  end
+end

data/lib/funl/message-sequencer-select.rb

@@ -0,0 +1,38 @@
+require 'funl/message-sequencer'
+
+module Funl
+  class MessageSequencerSelect < MessageSequencer
+    private
+
+    attr_reader :streams
+    
+    def init_selector
+      @streams = []
+    end
+
+    def register_stream stream
+      streams << stream
+    end
+
+    def deregister_stream stream
+      streams.delete stream
+    end
+    
+    def registered_stream? stream
+      streams.include? stream
+    end
+
+    def select_streams
+      readables, _ = select [server, *streams]
+
+      readables.each do |readable|
+        case readable
+        when server
+          accept_conn
+        else
+          read_conn readable
+        end
+      end
+    end
+  end
+end

data/lib/funl/message-sequencer.rb

@@ -11,7 +11,6 @@ module Funl
 
     attr_reader :server
     attr_reader :server_thread
-    attr_reader :streams
     attr_reader :tick
     attr_reader :log
     attr_reader :stream_type
@@ -19,6 +18,15 @@ module Funl
     attr_reader :blob_type
     attr_reader :greeting
     attr_reader :subscribers
+
+    def self.new *a
+      if self == MessageSequencer
+        require 'funl/message-sequencer-select'
+        MessageSequencerSelect.new *a
+      else
+        super
+      end
+    end
     
     def initialize server, *conns, log: Logger.new($stderr),
         stream_type: ObjectStream::MSGPACK_TYPE,
@@ -34,7 +42,8 @@ module Funl
       @greeting = default_greeting
       @tick = tick
 
-      @streams = []
+      init_selector
+
       conns.each do |conn|
         try_conn conn
       end
@@ -50,16 +59,6 @@ module Funl
       }.freeze # can't change after initial conns read it
     end
 
-    def try_conn conn
-      stream = message_server_stream_for(conn)
-      current_greeting = greeting.merge({"tick" => tick})
-      if write_succeeds?(current_greeting, stream)
-        log.debug {"connected #{stream.inspect}"}
-        streams << stream
-      end
-    end
-    private :try_conn
-
     def start
       @server_thread = Thread.new do
         run
@@ -73,52 +72,58 @@ module Funl
     def wait
       server_thread.join
     end
-
+    
     def run
       loop do
-        readables, _ = select [server, *streams]
-
-        readables.each do |readable|
-          case readable
-          when server
-            begin
-              conn, addr = readable.accept_nonblock
-              log.debug {"accepted #{conn.inspect} from #{addr.inspect}"}
-              try_conn conn
-            rescue IO::WaitReadable
-              next
-            end
-
-          else
-            log.debug {"readable = #{readable}"}
-            begin
-              msgs = []
-              readable.read do |msg|
-                msgs << msg
-              end
-            rescue IOError, SystemCallError => ex
-              log.debug {"closing #{readable}: #{ex}"}
-              reject_stream readable
-            else
-              log.debug {
-                "read #{msgs.size} messages from #{readable.peer_name}"}
-            end
-
-            msgs.each do |msg|
-              if msg.control?
-                handle_control readable, *msg.control_op
-              else
-                handle_message msg, readable
-              end
-            end
-          end
-        end
+        select_streams
       end
     rescue => ex
       log.error ex
       raise
     end
 
+    private
+
+    def accept_conn
+      conn, addr = server.accept_nonblock
+      log.debug {"accepted #{conn.inspect} from #{addr.inspect}"}
+      try_conn conn
+    rescue IO::WaitReadable
+    end
+
+    def try_conn conn
+      stream = message_server_stream_for(conn)
+      current_greeting = greeting.merge({"tick" => tick})
+      if write_succeeds?(current_greeting, stream)
+        log.debug {"connected #{stream.inspect}"}
+        register_stream stream
+      end
+    end
+
+    def read_conn readable
+      log.debug {"readable = #{readable}"}
+      begin
+        msgs = []
+        readable.read do |msg|
+          msgs << msg
+        end
+      rescue IOError, SystemCallError => ex
+        log.debug {"closing #{readable}: #{ex}"}
+        reject_stream readable
+      else
+        log.debug {
+          "read #{msgs.size} messages from #{readable.peer_name}"}
+      end
+
+      msgs.each do |msg|
+        if msg.control?
+          handle_control readable, *msg.control_op
+        else
+          handle_message msg, readable
+        end
+      end
+    end
+
     def handle_control stream, op_type, tags = nil
       log.debug {"#{stream.peer_name} #{op_type} #{tags}"}
 
@@ -181,7 +186,6 @@ module Funl
         write_succeeds? msg, stream
       end
     end
-    private :handle_message
 
     def write_succeeds? data, stream
       stream << data
@@ -191,12 +195,11 @@ module Funl
       reject_stream stream
       false
     end
-    private :write_succeeds?
 
     def reject_stream stream
       stream.close unless stream.closed?
-      if streams.include? stream
-        streams.delete stream
+      if registered_stream? stream
+        deregister_stream stream
         @subscribers_to_all.delete stream
         tags = @tags.delete stream
         if tags

data/lib/funl/version.rb

@@ -1,3 +1,3 @@
 module Funl
-  VERSION = "0.5"
+  VERSION = "0.6"
 end

data/test/test-message-sequencer.rb

@@ -1,4 +1,13 @@
 require 'funl/message-sequencer'
+
+have_nio = begin
+  require 'funl/message-sequencer-nio'
+rescue LoadError
+  false
+else
+  true
+end
+
 require 'socket'
 require 'tmpdir'
 
@@ -8,6 +17,8 @@ require 'minitest/autorun'
 
 class TestMessageSequencer < Minitest::Test
   attr_reader :log
+  
+  def mseq_class; MessageSequencer; end
 
   def setup
     @dir = Dir.mktmpdir "funl-test-mseq-"
@@ -24,7 +35,7 @@ class TestMessageSequencer < Minitest::Test
   def test_initial_conns
     as = []; bs = []
     @n_clients.times {a, b = UNIXSocket.pair; as << a; bs << b}
-    mseq = MessageSequencer.new nil, *as, log: log
+    mseq = mseq_class.new nil, *as, log: log
     bs.each_with_index do |b, i|
       stream = ObjectStreamWrapper.new(b, type: mseq.stream_type)
       stream.write_to_outbox({"client_id" => "test_initial_conns #{i}"})
@@ -38,7 +49,7 @@ class TestMessageSequencer < Minitest::Test
     svr = UNIXServer.new(@path)
     pid = fork do
       log.progname = "mseq"
-      mseq = MessageSequencer.new svr, log: log,  stream_type: stream_type
+      mseq = mseq_class.new svr, log: log,  stream_type: stream_type
       mseq.start
       sleep
     end
@@ -103,8 +114,7 @@ class TestMessageSequencer < Minitest::Test
 
       path = "#{@path}-#{i}"
       svr = UNIXServer.new(path)
-      mseq = Funl::MessageSequencer.new svr, log: log,
-        tick: saved_tick
+      mseq = mseq_class.new svr, log: log, tick: saved_tick
       mseq.start
 
       conn = UNIXSocket.new(path)
@@ -132,3 +142,9 @@ class TestMessageSequencer < Minitest::Test
     mseq.stop rescue nil
   end
 end
+
+if have_nio
+  class TestMessageSequencerNio < TestMessageSequencer
+    def mseq_class; MessageSequencerNio; end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: funl
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Joel VanderWerf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-03 00:00:00.000000000 Z
+date: 2013-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: object-stream
@@ -35,23 +35,27 @@ files:
 - README.md
 - COPYING
 - Rakefile
-- lib/funl/client-sequencer.rb
-- lib/funl/message-sequencer.rb
-- lib/funl/history-worker.rb
 - lib/funl/stream.rb
-- lib/funl/client.rb
-- lib/funl/history-client.rb
+- lib/funl/blobber.rb
 - lib/funl/subscription-tracker.rb
+- lib/funl/history-client.rb
+- lib/funl/history-worker.rb
+- lib/funl/client.rb
+- lib/funl/message-sequencer.rb
+- lib/funl/message-sequencer-nio.rb
+- lib/funl/client-sequencer.rb
 - lib/funl/message.rb
-- lib/funl/blobber.rb
 - lib/funl/version.rb
-- test/test-stream.rb
-- test/test-message.rb
-- test/test-client.rb
+- lib/funl/message-sequencer-select.rb
+- bench/msg-rate.rb
+- bench/funl-bench.rb
+- test/test-message-sequencer.rb
 - test/test-client-sequencer.rb
-- test/test-subscribe.rb
 - test/test-reflect.rb
-- test/test-message-sequencer.rb
+- test/test-message.rb
+- test/test-stream.rb
+- test/test-subscribe.rb
+- test/test-client.rb
 homepage: https://github.com/vjoel/funl
 licenses:
 - BSD
@@ -79,16 +83,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Sequences messages
 test_files:
-- test/test-stream.rb
-- test/test-message.rb
-- test/test-client.rb
+- test/test-message-sequencer.rb
 - test/test-client-sequencer.rb
-- test/test-subscribe.rb
 - test/test-reflect.rb
-- test/test-message-sequencer.rb
+- test/test-message.rb
+- test/test-stream.rb
+- test/test-subscribe.rb
+- test/test-client.rb
 has_rdoc: