rainbows 3.3.0 → 3.4.0

data/.gitignore

@@ -17,3 +17,5 @@ pkg/
 /GIT-VERSION-FILE
 /man
 /LATEST
+tags
+TAGS

data/GIT-VERSION-GEN

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 GVF=GIT-VERSION-FILE
-DEF_VER=v3.3.0.GIT
+DEF_VER=v3.4.0.GIT
 
 LF='
 '

data/lib/rainbows/client.rb

@@ -29,4 +29,6 @@ class Rainbows::Client < Kgio::Socket
       end
     end while true
   end
+
+  alias write kgio_write
 end

data/lib/rainbows/configurator.rb

@@ -190,7 +190,9 @@ module Rainbows::Configurator
   #   end
   #
   # Keep in mind that splice(2) itself is a relatively new system call
-  # and has been buggy in many older Linux kernels.
+  # and has been buggy in many older Linux kernels.  If you're proxying
+  # the output of sockets to the client, be sure to use "io_splice"
+  # 4.1.1 or later to avoid stalling responses.
   #
   # Default: IO on Ruby 1.9+, false otherwise
   def copy_stream(klass)

data/lib/rainbows/coolio/heartbeat.rb

@@ -9,6 +9,7 @@ class Rainbows::Coolio::Heartbeat < Coolio::TimerWatcher
   KATO = Rainbows::Coolio::KATO
   CONN = Rainbows::Coolio::CONN
   Rainbows.config!(self, :keepalive_timeout)
+  Rainbows.at_quit { KATO.each_key { |client| client.timeout? }.clear }
 
   def on_timer
     if (ot = KEEPALIVE_TIMEOUT) >= 0

data/lib/rainbows/epoll.rb

@@ -22,44 +22,27 @@ require 'sendfile'
 # === RubyGem Requirements
 #
 # * raindrops 0.6.0 or later
-# * sleepy_penguin 2.0.0 or later
+# * sleepy_penguin 3.0.1 or later
 # * sendfile 1.1.0 or later
 #
 module Rainbows::Epoll
   # :stopdoc:
   include Rainbows::Base
-  ReRun = []
   autoload :Server, 'rainbows/epoll/server'
   autoload :Client, 'rainbows/epoll/client'
   autoload :ResponsePipe, 'rainbows/epoll/response_pipe'
   autoload :ResponseChunkPipe, 'rainbows/epoll/response_chunk_pipe'
-  class << self
-    attr_writer :nr_clients
-  end
-
-  def self.loop
-    begin
-      EP.wait(nil, 1000) { |_, obj| obj.epoll_run }
-      while obj = ReRun.shift
-        obj.epoll_run
-      end
-      Rainbows::Epoll::Client.expire
-    rescue Errno::EINTR
-    rescue => e
-      Rainbows::Error.listen_loop(e)
-    end while Rainbows.tick || @nr_clients.call > 0
-  end
 
   def init_worker_process(worker)
     super
-    Rainbows::Epoll.const_set :EP, SleepyPenguin::Epoll.new
-    Rainbows.at_quit { Rainbows::Epoll::EP.close }
+    Rainbows.const_set(:EP, SleepyPenguin::Epoll.new)
     Rainbows::Client.__send__ :include, Client
+    LISTENERS.each { |io| io.extend(Server) }
   end
 
   def worker_loop(worker) # :nodoc:
     init_worker_process(worker)
-    Server.run
+    Client.loop
   end
   # :startdoc:
 end

data/lib/rainbows/epoll/client.rb

@@ -10,8 +10,10 @@ module Rainbows::Epoll::Client
   OUT = SleepyPenguin::Epoll::OUT | SleepyPenguin::Epoll::ET
   KATO = {}
   KATO.compare_by_identity if KATO.respond_to?(:compare_by_identity)
+  Rainbows.at_quit { KATO.each_key { |k| k.timeout! }.clear }
   Rainbows.config!(self, :keepalive_timeout)
-  EP = Rainbows::Epoll::EP
+  EP = Rainbows::EP
+  ReRun = []
   @@last_expire = Time.now
 
   def self.expire
@@ -23,6 +25,19 @@ module Rainbows::Epoll::Client
     @@last_expire = now
   end
 
+  def self.loop
+    begin
+      EP.wait(nil, 1000) { |_, obj| obj.epoll_run }
+      while obj = ReRun.shift
+        obj.epoll_run
+      end
+      expire
+    rescue Errno::EINTR
+    rescue => e
+      Rainbows::Error.listen_loop(e)
+    end while Rainbows.tick || Server.nr > 0
+  end
+
   # only call this once
   def epoll_once
     @wr_queue = [] # may contain String, ResponsePipe, and StreamFile objects
@@ -100,7 +115,7 @@ module Rainbows::Epoll::Client
   end
 
   def want_more
-    Rainbows::Epoll::ReRun << self
+    ReRun << self
   end
 
   def on_deferred_write_complete

data/lib/rainbows/epoll/response_pipe.rb

@@ -5,7 +5,7 @@ class Rainbows::Epoll::ResponsePipe
   attr_reader :io
   alias to_io io
   RBUF = Rainbows::EvCore::RBUF
-  EP = Rainbows::Epoll::EP
+  EP = Rainbows::EP
 
   def initialize(io, client, body)
     @io, @client, @body = io, client, body

data/lib/rainbows/epoll/server.rb

@@ -2,16 +2,14 @@
 # :enddoc:
 module Rainbows::Epoll::Server
   @@nr = 0
-  Rainbows::Epoll.nr_clients = lambda { @@nr }
   IN = SleepyPenguin::Epoll::IN | SleepyPenguin::Epoll::ET
   MAX = Rainbows.server.worker_connections
   THRESH = MAX - 1
   LISTENERS = Rainbows::HttpServer::LISTENERS
-  EP = Rainbows::Epoll::EP
+  EP = Rainbows::EP
 
-  def self.run
-    LISTENERS.each { |sock| EP.add(sock.extend(self), IN) }
-    Rainbows::Epoll.loop
+  def self.nr
+    @@nr
   end
 
   # rearms all listeners when there's a free slot
@@ -19,6 +17,10 @@ module Rainbows::Epoll::Server
     THRESH == (@@nr -= 1) and LISTENERS.each { |sock| EP.set(sock, IN) }
   end
 
+  def self.extended(sock)
+    EP.set(sock, IN)
+  end
+
   def epoll_run
     return EP.delete(self) if @@nr >= MAX
     while io = kgio_tryaccept

data/lib/rainbows/event_machine.rb

@@ -32,9 +32,7 @@ EM::VERSION >= '0.12.10' or abort 'eventmachine 0.12.10 is required'
 # all request processing is complete.
 #
 # Merb (and other frameworks/apps) supporting +deferred?+ execution as
-# documented at http://brainspl.at/articles/2008/04/18/deferred-requests-with-merb-ebb-and-thin
-# will also get the ability to conditionally defer request processing
-# to a separate thread.
+# documented at Rainbows::EventMachine::TryDefer
 #
 # This model does not implement as streaming "rack.input" which allows
 # the Rack application to process data as it arrives.  This means
@@ -74,11 +72,11 @@ module Rainbows::EventMachine
       conns = EM.instance_variable_get(:@conns) or
         raise RuntimeError, "EM @conns instance variable not accessible!"
       Rainbows::EventMachine::Server.const_set(:CUR, conns)
+      Rainbows.at_quit do
+        EM.next_tick { conns.each_value { |c| client_class === c and c.quit } }
+      end
       EM.add_periodic_timer(1) do
-        unless Rainbows.tick
-          conns.each_value { |c| client_class === c and c.quit }
-          EM.stop if conns.empty? && EM.reactor_running?
-        end
+        EM.stop if ! Rainbows.tick && conns.empty? && EM.reactor_running?
       end
       LISTENERS.map! do |s|
         EM.watch(s, Rainbows::EventMachine::Server) do |c|

data/lib/rainbows/event_machine/try_defer.rb

@@ -1,27 +1,32 @@
 # -*- encoding: binary -*-
-# :enddoc:
 
 # Middleware that will run the app dispatch in a separate thread.
 # This middleware is automatically loaded by Rainbows! when using
 # EventMachine and if the app responds to the +deferred?+ method.
-class Rainbows::EventMachine::TryDefer < Struct.new(:app)
+#
+# Use EM.threadpool_size in your \Rainbows! config file to control
+# the number of threads used by EventMachine.
+#
+# See http://brainspl.at/articles/2008/04/18/deferred-requests-with-merb-ebb-and-thin
+# for more information.
+class Rainbows::EventMachine::TryDefer
   # shortcuts
-  ASYNC_CALLBACK = Rainbows::EvCore::ASYNC_CALLBACK
+  ASYNC_CALLBACK = Rainbows::EvCore::ASYNC_CALLBACK # :nodoc:
 
-  def initialize(app)
+  def initialize(app) # :nodoc:
     # the entire app becomes multithreaded, even the root (non-deferred)
     # thread since any thread can share processes with others
     Rainbows::Const::RACK_DEFAULTS['rack.multithread'] = true
-    super
+    @app = app
   end
 
-  def call(env)
-    if app.deferred?(env)
-      EM.defer(proc { catch(:async) { app.call(env) } }, env[ASYNC_CALLBACK])
+  def call(env) # :nodoc:
+    if @app.deferred?(env)
+      EM.defer(proc { catch(:async) { @app.call(env) } }, env[ASYNC_CALLBACK])
       # all of the async/deferred stuff breaks Rack::Lint :<
       nil
     else
-      app.call(env)
+      @app.call(env)
     end
   end
 end

data/lib/rainbows/xepoll.rb

@@ -10,7 +10,7 @@ require 'rainbows/epoll'
 # === RubyGem Requirements
 #
 # * raindrops 0.6.0 or later
-# * sleepy_penguin 2.0.0 or later
+# * sleepy_penguin 3.0.1 or later
 # * sendfile 1.1.0 or later
 module Rainbows::XEpoll
   # :stopdoc:
@@ -19,14 +19,13 @@ module Rainbows::XEpoll
 
   def init_worker_process(worker)
     super
-    Rainbows::Epoll.const_set :EP, SleepyPenguin::Epoll.new
-    Rainbows.at_quit { Rainbows::Epoll::EP.close }
+    Rainbows.const_set(:EP, SleepyPenguin::Epoll.new)
     Rainbows::Client.__send__ :include, Client
   end
 
   def worker_loop(worker) # :nodoc:
     init_worker_process(worker)
-    Client.run
+    Client.loop
   end
   # :startdoc:
 end

data/lib/rainbows/xepoll/client.rb

@@ -3,9 +3,7 @@
 
 module Rainbows::XEpoll::Client
   N = Raindrops.new(1)
-  Rainbows::Epoll.nr_clients = lambda { N[0] }
   include Rainbows::Epoll::Client
-  EP = Rainbows::Epoll::EP
   ACCEPTORS = Rainbows::HttpServer::LISTENERS.dup
   extend Rainbows::WorkerYield
 
@@ -26,8 +24,17 @@ module Rainbows::XEpoll::Client
     end
   end
 
-  def self.run
-    Rainbows::Epoll.loop
+  def self.loop
+    begin
+      EP.wait(nil, 1000) { |_, obj| obj.epoll_run }
+      while obj = ReRun.shift
+        obj.epoll_run
+      end
+      Rainbows::Epoll::Client.expire
+    rescue Errno::EINTR
+    rescue => e
+      Rainbows::Error.listen_loop(e)
+    end while Rainbows.tick || N[0] > 0
     Rainbows::JoinThreads.acceptors(ACCEPTORS)
   end
 

data/lib/rainbows/xepoll_thread_pool.rb

@@ -61,7 +61,7 @@ require "raindrops"
 # === RubyGem Requirements
 #
 # * raindrops 0.6.0 or later
-# * sleepy_penguin 2.0.0 or later
+# * sleepy_penguin 3.0.1 or later
 module Rainbows::XEpollThreadPool
   extend Rainbows::PoolSize
 

data/lib/rainbows/xepoll_thread_pool/client.rb

@@ -37,11 +37,15 @@ module Rainbows::XEpollThreadPool::Client
 
   ep = SleepyPenguin::Epoll
   EP = ep.new
-  Rainbows.at_quit { EP.close }
   IN = ep::IN | ep::ET | ep::ONESHOT
   KATO = {}
   KATO.compare_by_identity if KATO.respond_to?(:compare_by_identity)
   LOCK = Mutex.new
+  Rainbows.at_quit do
+    clients = nil
+    LOCK.synchronize { clients = KATO.keys; KATO.clear }
+    clients.each { |io| io.closed? or io.close }
+  end
   @@last_expire = Time.now
 
   def kato_set
@@ -123,7 +127,7 @@ module Rainbows::XEpollThreadPool::Client
   def pipeline_ready(hp)
     # be fair to other clients, let others run first
     hp.parse and return queue!
-    kato_set
+    epoll_run("")
     false
   end
 end

data/lib/rainbows/xepoll_thread_spawn.rb

@@ -39,7 +39,7 @@ require "raindrops"
 # === RubyGem Requirements
 #
 # * raindrops 0.6.0 or later
-# * sleepy_penguin 2.0.0 or later
+# * sleepy_penguin 3.0.1 or later
 module Rainbows::XEpollThreadSpawn
   # :stopdoc:
   include Rainbows::Base

data/lib/rainbows/xepoll_thread_spawn/client.rb

@@ -26,11 +26,15 @@ module Rainbows::XEpollThreadSpawn::Client
 
   ep = SleepyPenguin::Epoll
   EP = ep.new
-  Rainbows.at_quit { EP.close }
   IN = ep::IN | ep::ET | ep::ONESHOT
   KATO = {}
   KATO.compare_by_identity if KATO.respond_to?(:compare_by_identity)
   LOCK = Mutex.new
+  Rainbows.at_quit do
+    clients = nil
+    LOCK.synchronize { clients = KATO.keys; KATO.clear }
+    clients.each { |io| io.closed? or io.close }
+  end
   @@last_expire = Time.now
 
   def kato_set

data/pkg.mk

@@ -69,7 +69,7 @@ doc:: .document .wrongdoc.yml $(pkg_extra)
 	$(RM) -r doc
 	$(WRONGDOC) all
 	install -m644 COPYING doc/COPYING
-	install -m644 $(shell grep '^[A-Z]' .document) doc/
+	install -m644 $(shell LC_ALL=C grep '^[A-Z]' .document) doc/
 
 ifneq ($(VERSION),)
 pkggem := pkg/$(rfpackage)-$(VERSION).gem
@@ -168,7 +168,7 @@ doc_gz:
 	for i in $(docs); do \
 	  gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done
 check-warnings:
-	@(for i in $$(git ls-files '*.rb'|grep -v '^setup\.rb$$'); \
+	@(for i in $$(git ls-files '*.rb'| grep -v '^setup\.rb$$'); \
 	  do $(RUBY) -d -W2 -c $$i; done) | grep -v '^Syntax OK$$' || :
 
 .PHONY: all .FORCE-GIT-VERSION-FILE doc test $(test_units) manifest

data/t/large-file-response.ru

@@ -9,6 +9,9 @@ map "/rss" do
     [ 200, {}, [ ($1.to_i * 1024).to_s ] ]
   }
 end
+map "/pid" do
+  run lambda { |env| [ 200, {}, [ "#{Process.pid}\n" ] ] }
+end
 map "/" do
   run Rack::File.new(Dir.pwd)
 end

data/t/t0043-quit-keepalive-disconnect.sh

@@ -0,0 +1,59 @@
+#!/bin/sh
+. ./test-lib.sh
+case $model in
+Coolio|CoolioThreadSpawn|CoolioThreadPool|EventMachine) ;;
+Epoll|XEpoll|XEpollThreadPool|XEpollThreadSpawn) ;;
+*)
+	t_info "$0 not supported for $model"
+	exit 0
+	;;
+esac
+
+t_plan 7 "keepalive clients disconnected on SIGQUIT for $model"
+
+t_begin "setup and start" && {
+	rainbows_setup $model 50 30
+	rainbows -E none -D env.ru -c $unicorn_config
+	rainbows_wait_start
+}
+
+t_begin "start a keepalive request" && {
+	(
+		cat < $fifo > $tmp &
+		printf 'GET / HTTP/1.1\r\nHost: example.com\r\n\r\n'
+		wait
+	) | socat - TCP4:$listen > $fifo &
+}
+
+t_begin "wait for response" && {
+	while ! tail -1 < $tmp | grep '}$' >/dev/null
+	do
+		sleep 1
+	done
+}
+
+t_begin "stop Rainbows! gracefully" && {
+	t0=$(date +%s)
+	kill -QUIT $rainbows_pid
+}
+
+t_begin "keepalive client disconnected quickly" && {
+	wait
+	diff=$(( $(date +%s) - $t0 ))
+	test $diff -le 2 || die "client diff=$diff > 2"
+}
+
+t_begin "wait for termination" && {
+	while kill -0 $rainbows_pid
+	do
+		sleep 1
+	done
+	diff=$(( $(date +%s) - $t0 ))
+	test $diff -le 4 || die "server diff=$diff > 4"
+}
+
+t_begin "check stderr" && {
+	check_stderr
+}
+
+t_done

data/t/t0044-autopush.sh

@@ -0,0 +1,120 @@
+#!/bin/sh
+. ./test-lib.sh
+STRACE=$(which strace 2>/dev/null || :)
+if ! test -x "$STRACE"
+then
+	t_info "strace not found, skipping $T"
+	exit 0
+fi
+if test x"$(uname -s)" != xLinux
+then
+	t_info "Linux is the only supported OS for $T"
+	exit 0
+fi
+
+# these buffer internally in external libraries, so we can't detect when
+# to use TCP_CORK
+skip_models EventMachine NeverBlock
+skip_models Coolio CoolioThreadPool CoolioThreadSpawn
+skip_models Revactor Rev RevThreadPool RevThreadSpawn
+
+# not sure why, but we don't have time to care about Ruby 1.8 too much
+case $RUBY_VERSION in
+1.8.*) skip_models WriterThreadSpawn WriterThreadPool ;;
+esac
+
+t_plan 13 "Kgio autopush tests"
+
+start_strace () {
+	# dbgcat strace_out
+	> $strace_out
+	sleep 1
+	strace -p $worker_pid -e '!futex' -f -o $strace_out &
+	strace_pid=$!
+	while ! test -s $strace_out; do sleep 1; done
+}
+
+check_TCP_CORK () {
+	nr=0
+	while test 2 -gt $(grep TCP_CORK $strace_out | wc -l)
+	do
+		nr=$(( $nr + 1 ))
+		if test $nr -gt 30
+		then
+			dbgcat strace_out
+			die "waited too long ($nr seconds) for TCP_CORK"
+		fi
+		sleep 1
+	done
+
+	test 2 -eq $(grep TCP_CORK $strace_out | wc -l)
+	fgrep 'SOL_TCP, TCP_CORK, [0], 4) = 0' $strace_out
+	fgrep 'SOL_TCP, TCP_CORK, [1], 4) = 0' $strace_out
+}
+
+t_begin "setup and start" && {
+	rainbows_setup $model 1 1
+	rtmpfiles strace_out
+	ed -s $unicorn_config <<EOF
+,s/^listen.*/listen "$listen", :tcp_nodelay => true, :tcp_nopush => true/
+w
+EOF
+	rainbows -D large-file-response.ru -c $unicorn_config -E none
+	rainbows_wait_start
+}
+
+t_begin "read worker pid" && {
+	worker_pid=$(curl -sSf http://$listen/pid)
+	kill -0 $worker_pid
+}
+
+t_begin "start strace on worker" && start_strace
+
+t_begin "reading RSS uncorks" && {
+	curl -sSf http://$listen/rss >/dev/null
+}
+
+t_begin "restart strace on worker" && {
+	kill $strace_pid
+	wait
+	start_strace
+}
+
+t_begin "reading static file uncorks" && {
+	curl -sSf http://$listen/random_blob >/dev/null
+	check_TCP_CORK
+}
+
+t_begin "stop strace on worker" && {
+	kill $strace_pid
+	wait
+}
+
+t_begin "enable sendfile" && {
+	echo >> $unicorn_config 'require "sendfile"'
+	kill -HUP $rainbows_pid
+	test xSTART = x"$(cat $fifo)"
+}
+
+t_begin "reread worker pid" && {
+	worker_pid=$(curl -sSf http://$listen/pid)
+	kill -0 $worker_pid
+}
+
+t_begin "restart strace on the worker" && start_strace
+
+t_begin "HTTP/1.x GET on static file with sendfile uncorks" && {
+	curl -sSf http://$listen/random_blob >/dev/null
+	check_TCP_CORK
+}
+
+t_begin "killing succeeds" && {
+	kill $strace_pid
+	wait
+	# dbgcat strace_out
+	kill $rainbows_pid
+}
+
+t_begin "check stderr" && check_stderr
+
+t_done

data/t/test_isolate.rb

@@ -38,10 +38,10 @@ Isolate.now!(opts) do
   end
 
   if RUBY_PLATFORM =~ /linux/
-    gem 'sleepy_penguin', '2.0.0'
+    gem 'sleepy_penguin', '3.0.1'
 
     # is 2.6.32 new enough?
-    gem 'io_splice', '4.1.0' if `uname -r`.strip > '2.6.32'
+    gem 'io_splice', '4.1.1' if `uname -r`.strip > '2.6.32'
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rainbows
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 23
   prerelease: 
   segments: 
   - 3
-  - 3
+  - 4
   - 0
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors: 
 - Rainbows! hackers
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 Z
+date: 2011-05-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
@@ -458,6 +458,8 @@ files:
 - t/t0040-keepalive_requests-setting.sh
 - t/t0041-optional-pool-size.sh
 - t/t0042-client_header_buffer_size.sh
+- t/t0043-quit-keepalive-disconnect.sh
+- t/t0044-autopush.sh
 - t/t0050-response-body-close-has-env.sh
 - t/t0100-rack-input-hammer-chunked.sh
 - t/t0100-rack-input-hammer-content-length.sh