rainbows 3.2.0 → 3.3.0

data/Documentation/comparison.haml

@@ -33,7 +33,7 @@
     %td.r18 Yes
     %td.r19 Yes
     %td.rbx Yes
-    %td.slow OK
+    %td.slow Yes
   %tr.comp_row
     %td.mod Coolio
     %td.tee No
@@ -47,7 +47,7 @@
     %td.r18 Yes
     %td.r19 Yes
     %td.rbx Yes
-    %td.slow OK
+    %td.slow Yes
   %tr.comp_row
     %td.mod EventMachine
     %td.tee No
@@ -118,6 +118,34 @@
     %td.r19 Yes
     %td.rbx Yes
     %td.slow no
+  %tr.comp_row
+    %td.mod Epoll
+    %td.tee no
+    %td.r18 Yes
+    %td.r19 Yes
+    %td.rbx Yes
+    %td.slow Yes
+  %tr.comp_row
+    %td.mod XEpoll
+    %td.tee no
+    %td.r18 Yes
+    %td.r19 Yes
+    %td.rbx Yes
+    %td.slow Yes
+  %tr.comp_row
+    %td.mod XEpollThreadSpawn
+    %td.tee Yes
+    %td.r18 Yes
+    %td.r19 Yes
+    %td.rbx Yes
+    %td.slow Yes
+  %tr.comp_row
+    %td.mod XEpollThreadPool
+    %td.tee Yes
+    %td.r18 Yes
+    %td.r19 Yes
+    %td.rbx Yes
+    %td.slow Yes
 %ul
   %li
     Cool.io should also work with Rubinius (though we haven't had time to test).
@@ -232,6 +260,26 @@
     %td.slowio avoid
     %td.thr Maybe
     %td.reent Maybe
+  %tr.comp_base
+    %td.mod Epoll
+    %td.slowio No
+    %td.thr No
+    %td.reent No
+  %tr.comp_base
+    %td.mod XEpoll
+    %td.slowio No
+    %td.thr No
+    %td.reent No
+  %tr.comp_base
+    %td.mod XEpollThreadSpawn
+    %td.slowio thread-safe Ruby
+    %td.thr Yes
+    %td.reent No
+  %tr.comp_base
+    %td.mod XEpollThreadPool
+    %td.slowio thread-safe Ruby
+    %td.thr Yes
+    %td.reent No
 %ul
   %li
     Requirements for single thread reentrancy are loose in that there is
@@ -264,91 +312,78 @@
     %th.lock
       %a(href="http://rack.rubyforge.org/doc/Rack/Lock.html") Rack::Lock
     %th.async async
-    %th.ws Web Sockets
   %tr.comp_row
     %td.mod Unicorn/Base
     %td.devfd no-op
     %td.app_pool no-op
     %td.lock no-op
     %td.async lots of RAM :P
-    %td.ws no
   %tr.comp_row
     %td.mod Revactor
     %td.devfd no-op
     %td.app_pool Yes
     %td.lock No!
     %td.async Revactor itself
-    %td.ws no
   %tr.comp_row
     %td.mod ThreadPool
     %td.devfd Yes
     %td.app_pool Yes
     %td.lock Yes
-    %td.async standard Ruby
-    %td.ws no
+    %td.async thread-safe Ruby
   %tr.comp_row
     %td.mod Coolio
     %td.devfd Yes
     %td.app_pool no-op
     %td.lock no-op
     %td.async DevFdResponse
-    %td.ws no
   %tr.comp_row
     %td.mod ThreadSpawn
     %td.devfd Yes
     %td.app_pool Yes
     %td.lock Yes
-    %td.async standard Ruby
-    %td.ws no
+    %td.async thread-safe Ruby
   %tr.comp_row
     %td.mod EventMachine
     %td.devfd Yes
     %td.app_pool no-op
     %td.lock no-op
     %td.async async_sinatra, Cramp, rack-fiber_pool
-    %td.ws no
   %tr.comp_row
     %td.mod CoolioThreadSpawn
     %td.devfd Yes
     %td.app_pool Yes
     %td.lock Dumb
-    %td.async standard Ruby
-    %td.ws no
+    %td.async thread-safe Ruby
   %tr.comp_row
     %td.mod FiberSpawn
     %td.devfd Yes
     %td.app_pool Yes
     %td.lock No!
     %td.async Rainbows::Fiber::IO, Rainbows.sleep
-    %td.ws no
   %tr.comp_row
     %td.mod FiberPool
     %td.devfd Yes
     %td.app_pool Yes
     %td.lock No!
     %td.async Rainbows::Fiber::IO, Rainbows.sleep
-    %td.ws no
   %tr.comp_row
     %td.mod ActorSpawn
     %td.devfd no-op
     %td.app_pool Yes
     %td.lock Yes
-    %td.async standard Ruby
-    %td.ws no
+    %td.async thread-safe Ruby
   %tr.comp_row
     %td.mod NeverBlock
     %td.devfd Yes
     %td.app_pool Yes*
     %td.lock Yes*
     %td.async NeverBlock, async_sinatra
-    %td.ws no
   %tr.comp_row
     %td.mod CoolioThreadPool
     %td.devfd Yes
     %td.app_pool Yes
     %td.lock Dumb
-    %td.async Coolio, standard Ruby
-    %td.ws no
+    %td.async Coolio, thread-safe Ruby
   %tr.comp_row
     %td.mod CoolioFiberSpawn
     %td.devfd Yes
@@ -360,15 +395,37 @@
     %td.devfd Yes
     %td.app_pool no-op
     %td.lock no-op
-    %td.async Standard Ruby in response body only
-    %td.ws response body only
+    %td.async thread-safe Ruby in response body only
   %tr.comp_row
     %td.mod WriterThreadSpawn
     %td.devfd Yes
     %td.app_pool no-op
     %td.lock no-op
-    %td.async Standard Ruby in response body only
-    %td.ws response body only
+    %td.async thread-safe Ruby in response body only
+  %tr.comp_row
+    %td.mod Epoll
+    %td.devfd Yes
+    %td.app_pool no-op
+    %td.lock no-op
+    %td.async DevFdResponse
+  %tr.comp_row
+    %td.mod XEpoll
+    %td.devfd Yes
+    %td.app_pool no-op
+    %td.lock no-op
+    %td.async DevFdResponse
+  %tr.comp_row
+    %td.mod XEpollThreadPool
+    %td.devfd Yes
+    %td.app_pool Yes
+    %td.lock Yes
+    %td.async thread-safe Ruby
+  %tr.comp_row
+    %td.mod XEpollThreadSpawn
+    %td.devfd Yes
+    %td.app_pool Yes
+    %td.lock Yes
+    %td.async thread-safe Ruby
 %ul
   %li
     "No!" means it's fundamentally incompatible, use an

data/FAQ

@@ -18,6 +18,9 @@ requests we service.
 === Isn't "rainbows" a branch of Unicorn?
 
 That functionality is now in the Revactor model of \Rainbows!
+However, \Revactor is not recommended since it is dormant
+upstream and requires your application (and all its libraries)
+to cooperate with \Revactor for concurrency.
 
 
 === What happened to the "gossamer" branch of Unicorn?

data/GIT-VERSION-GEN

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

data/LICENSE

@@ -1,8 +1,17 @@
-\Rainbows! is copyrighted Free Software by all contributors, see the
-logs in revision control for all of them.  You can redistribute it
-and/or modify it under either the terms of the
-{GPL2}[http://www.gnu.org/licenses/gpl-2.0.txt] (see link:COPYING) or
-the conditions below:
+\Rainbows! is copyrighted Free Software by all contributors, see the logs in
+revision control for names and email addresses of all of them.
+
+You can redistribute it and/or modify it under either the terms of the
+GNU General Public License (GPL) as published by the Free Software
+Foundation (FSF), version {3.0}[http://www.gnu.org/licenses/gpl-3.0.txt]
+or version {2.0}[http://www.gnu.org/licenses/gpl-2.0.txt]
+or the Ruby-specific license terms (see below).
+
+The \Rainbows! project leader (Eric Wong) reserves the right to add future
+versions of the GPL (and no other licenses) as published by the FSF to
+the licensing terms.
+
+=== Ruby-specific terms (if you're not using the GPLv2/GPLv3)
 
   1. You may make and give away verbatim copies of the source form of the
      software without restriction, provided that you duplicate all of the

data/README

@@ -22,18 +22,22 @@ suck; differently.
 For network concurrency, models we currently support are:
 
 * {Coolio}[link:Rainbows/Coolio.html]
+* {CoolioFiberSpawn}[link:Rainbows/CoolioFiberSpawn.html]
+* {CoolioThreadPool}[link:Rainbows/CoolioThreadPool.html]
+* {CoolioThreadSpawn}[link:Rainbows/CoolioThreadSpawn.html]
+* {Epoll}[link:Rainbows/Epoll.html]
 * {EventMachine}[link:Rainbows/EventMachine.html]
-* {FiberSpawn}[link:Rainbows/FiberSpawn.html]
 * {FiberPool}[link:Rainbows/FiberPool.html]
+* {FiberSpawn}[link:Rainbows/FiberSpawn.html]
 * {NeverBlock}[link:Rainbows/NeverBlock.html]
 * {Revactor}[link:Rainbows/Revactor.html]
 * {ThreadPool}[link:Rainbows/ThreadPool.html]
 * {ThreadSpawn}[link:Rainbows/ThreadSpawn.html]
 * {WriterThreadPool}[link:Rainbows/WriterThreadPool.html]
 * {WriterThreadSpawn}[link:Rainbows/WriterThreadSpawn.html]
-* {CoolioFiberSpawn}[link:Rainbows/CoolioFiberSpawn.html]
-* {CoolioThreadPool}[link:Rainbows/CoolioThreadPool.html]
-* {CoolioThreadSpawn}[link:Rainbows/CoolioThreadSpawn.html]
+* {XEpoll}[link:Rainbows/XEpoll.html]
+* {XEpollThreadPool}[link:Rainbows/XEpollThreadPool.html]
+* {XEpollThreadSpawn}[link:Rainbows/XEpollThreadSpawn.html]
 
 We have {many more on the way}[link:TODO.html] for handling network
 concurrency.  Additionally, we also use multiple processes (managed by
@@ -86,11 +90,8 @@ fast applications.
 == License
 
 \Rainbows! is copyright 2009,2010 by all contributors (see logs in git).
-It is based on Mongrel 1.1.5 and Unicorn and carries the same license.
-
-Mongrel is copyright 2007 Zed A. Shaw and contributors. It is licensed
-under the Ruby (1.8) license and the GPL2. See the included LICENSE file for
-details.
+\Rainbows! is licensed under the Ruby (1.8) license or the GPL (v2 or v3).
+See the included {LICENSE}[link:LICENSE.html] file for more details.
 
 \Rainbows! is 100% Free Software.
 

data/Sandbox

@@ -0,0 +1,25 @@
+= Tips for using \Rainbows! with Sandbox installation tools
+
+Most {tips for Unicorn}[http://unicorn.bogomips.org/Sandbox.html]
+for Bundler and Isolate apply to \Rainbows! as well.
+
+== TLDR (Bundler)
+
+You need to add "rainbows" to your Gemfile for Bundler and start
+\Rainbows! with:
+
+	bundle exec rainbows ...
+
+== TLDR (Isolate)
+
+Isolate "rainbows" and execute the "rainbows" launcher in your isolated
+GEM_PATH:
+
+	$APP_ROOT/tmp/ruby-1.9/bin/rainbows ...
+
+== Explanation
+
+Due to the variety of potential dependencies, \Rainbows! lazy loads many
+of its internals, often after the application itself is loaded.  This
+results in more potential to interact badly with sandbox tools that
+modify the gem environment.

data/TODO

@@ -3,35 +3,15 @@
 We're lazy and pick the easy items to do first, then the ones people
 care about.
 
-* documentation improvements
+* investigate non-Rack frameworks (e.g. Goliath)
 
-* Split out NeverBlock into NeverBlockEventMachine and NeverBlockReactor
-  NeverBlock will default to one of them (depending on NB upstream).
+* documentation improvements
 
 * allow _OPTIONAL_ splice(2) with DevFdResponse under Linux
   (splice is very broken under some older kernels)
 
-* use IO#trysendfile for EventMachine/NeverBlock
-
-* Open file cache Rack app/middleware (idea from nginx), since sendfile
-  (and IO.copy_stream) allows pread(2)-style offsets
-
 * Improve test suite coverage.  We won't waste cycles with puny
   unit tests, only integration tests that exercise externally
   visible parts.
 
-* EventMachine+Fibers+streaming input
-  (those who do not require streaming input can use
-  {rack-fiber_pool}[http://github.com/mperham/rack-fiber_pool])
-
-* CoolioFiberPool
-
-* ThreadPoolRevFiber{Spawn,Pool}: just because
-
-* Coolio + callcc - current Coolio model with callcc (should work with MBARI)
-
-* Omnibus - haven't looked into it, probably like Revactor with 1.8?
-
-* Packet - pure Ruby, EventMachine-like library
-
 * test and improve performance (throughput/latency/memory usage)

data/lib/rainbows.rb

@@ -1,6 +1,7 @@
 # -*- encoding: binary -*-
 require 'kgio'
 require 'unicorn'
+require 'io/wait'
 Unicorn::SocketHelper::DEFAULTS.merge!({
   # the value passed to TCP_DEFER_ACCEPT actually matters in Linux 2.6.32+
   :tcp_defer_accept => 60,
@@ -15,17 +16,16 @@ Unicorn::SocketHelper::DEFAULTS.merge!({
   :tcp_nopush => false,
 })
 
+# See http://rainbows.rubyforge.org/ for documentation
 module Rainbows
-
-  O = {} # :nodoc:
+  # :stopdoc:
+  O = {}
 
   # map of numeric file descriptors to IO objects to avoid using IO.new
   # and potentially causing race conditions when using /dev/fd/
   FD_MAP = {}
   FD_MAP.compare_by_identity if FD_MAP.respond_to?(:compare_by_identity)
 
-  # :startdoc:
-
   require 'rainbows/const'
   require 'rainbows/http_parser'
   require 'rainbows/http_server'
@@ -41,23 +41,25 @@ module Rainbows
   autoload :EvCore, 'rainbows/ev_core'
   autoload :SocketProxy, 'rainbows/socket_proxy'
 
+  # :startdoc:
   # Sleeps the current application dispatch.  This will pick the
   # optimal method to sleep depending on the concurrency model chosen
   # (which may still suck and block the entire process).  Using this
   # with the basic :Coolio or :EventMachine models is not recommended.
   # This should be used within your Rack application.
-  def self.sleep(nr)
+  def self.sleep(seconds)
     case Rainbows.server.use
     when :FiberPool, :FiberSpawn
-      Rainbows::Fiber.sleep(nr)
+      Rainbows::Fiber.sleep(seconds)
     when :RevFiberSpawn, :CoolioFiberSpawn
-      Rainbows::Fiber::Coolio::Sleeper.new(nr)
+      Rainbows::Fiber::Coolio::Sleeper.new(seconds)
     when :Revactor
-      Actor.sleep(nr)
+      Actor.sleep(seconds)
     else
-      Kernel.sleep(nr)
+      Kernel.sleep(seconds)
     end
   end
+  # :stopdoc:
 
   # runs the Rainbows! HttpServer with +app+ and +options+ and does
   # not return until the server has exited.
@@ -65,27 +67,30 @@ module Rainbows
     HttpServer.new(app, options).start.join
   end
 
-  # :stopdoc:
   class << self
-    attr_accessor :max_bytes, :keepalive_timeout
     attr_accessor :server
     attr_accessor :cur # may not always be used
     attr_reader :alive
     attr_writer :tick_io
+    attr_writer :forked
   end
-  # :startdoc:
-
-  # the default max body size is 1 megabyte (1024 * 1024 bytes)
-  @max_bytes = 1024 * 1024
 
-  # the default keepalive_timeout is 5 seconds
-  @keepalive_timeout = 5
+  def self.config!(mod, *opts)
+    @forked or abort "#{mod} should only be loaded in a worker process"
+    opts.each do |opt|
+      mod.const_set(opt.to_s.upcase, Rainbows.server.__send__(opt))
+    end
+  end
 
-  # :stopdoc:
   @alive = true
   @cur = 0
   @tick_mod = 0
   @expire = nil
+  @at_quit = []
+
+  def self.at_quit(&block)
+    @at_quit << block
+  end
 
   def self.tick
     @tick_io.chmod(@tick_mod = 0 == @tick_mod ? 1 : 0)
@@ -102,41 +107,36 @@ module Rainbows
       @alive = false
       Rainbows::HttpParser.quit
       @expire = Time.now + (@server.timeout * 2.0)
-      @server.class.const_get(:LISTENERS).map! { |s| s.close rescue nil }.clear
+      Unicorn::HttpServer::LISTENERS.each { |s| s.close rescue nil }.clear
+      @at_quit.each { |task| task.call }
     end
     false
   end
 
-  # maps models to default worker counts, default worker count numbers are
-  # pretty arbitrary and tuning them to your application and hardware is
-  # highly recommended
-  MODEL_WORKER_CONNECTIONS = {
-    :Base => 1, # this one can't change
-    :WriterThreadPool => 20,
-    :WriterThreadSpawn => 20,
-    :Revactor => 50,
-    :ThreadSpawn => 30,
-    :ThreadPool => 20,
-    :Rev => 50,
-    :RevThreadSpawn => 50,
-    :RevThreadPool => 50,
-    :RevFiberSpawn => 50,
-    :Coolio => 50,
-    :CoolioThreadSpawn => 50,
-    :CoolioThreadPool => 50,
-    :CoolioFiberSpawn => 50,
-    :Epoll => 50,
-    :XEpoll => 50,
-    :EventMachine => 50,
-    :FiberSpawn => 50,
-    :FiberPool => 50,
-    :ActorSpawn => 50,
-    :NeverBlock => 50,
-  }.each do |model, _|
-    u = model.to_s.gsub(/([a-z0-9])([A-Z0-9])/) { "#{$1}_#{$2.downcase!}" }
-    autoload model, "rainbows/#{u.downcase!}"
-  end
-  # :startdoc:
+  autoload :Base, "rainbows/base"
+  autoload :WriterThreadPool, "rainbows/writer_thread_pool"
+  autoload :WriterThreadSpawn, "rainbows/writer_thread_spawn"
+  autoload :Revactor, "rainbows/revactor"
+  autoload :ThreadSpawn, "rainbows/thread_spawn"
+  autoload :ThreadPool, "rainbows/thread_pool"
+  autoload :Rev, "rainbows/rev"
+  autoload :RevThreadSpawn, "rainbows/rev_thread_spawn"
+  autoload :RevThreadPool, "rainbows/rev_thread_pool"
+  autoload :RevFiberSpawn, "rainbows/rev_fiber_spawn"
+  autoload :Coolio, "rainbows/coolio"
+  autoload :CoolioThreadSpawn, "rainbows/coolio_thread_spawn"
+  autoload :CoolioThreadPool, "rainbows/coolio_thread_pool"
+  autoload :CoolioFiberSpawn, "rainbows/coolio_fiber_spawn"
+  autoload :Epoll, "rainbows/epoll"
+  autoload :XEpoll, "rainbows/xepoll"
+  autoload :EventMachine, "rainbows/event_machine"
+  autoload :FiberSpawn, "rainbows/fiber_spawn"
+  autoload :FiberPool, "rainbows/fiber_pool"
+  autoload :ActorSpawn, "rainbows/actor_spawn"
+  autoload :NeverBlock, "rainbows/never_block"
+  autoload :XEpollThreadSpawn, "rainbows/xepoll_thread_spawn"
+  autoload :XEpollThreadPool, "rainbows/xepoll_thread_pool"
+
   autoload :Fiber, 'rainbows/fiber' # core class
   autoload :StreamFile, 'rainbows/stream_file'
   autoload :HttpResponse, 'rainbows/http_response' # deprecated
@@ -145,6 +145,7 @@ module Rainbows
   autoload :SyncClose, 'rainbows/sync_close'
   autoload :ReverseProxy, 'rainbows/reverse_proxy'
   autoload :JoinThreads, 'rainbows/join_threads'
+  autoload :PoolSize, 'rainbows/pool_size'
 end
 
 require 'rainbows/error'