webrick-high-performance 1.0.0

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright 2005 Eric Hodel, The Robot Co-op.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/Manifest.txt

@@ -0,0 +1,5 @@
+LICENSE
+Manifest.txt
+README
+Rakefile
+lib/webrick/highperformanceserver.rb

data/README

@@ -0,0 +1,54 @@
+= WEBrick High Performance
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/rctools/
+
+Documentation:
+
+http://dev.robotcoop.com/Libraries/webrick-high-performance/
+
+== About
+
+WEBrick High Performance adds a new HTTP server class that takes advantage of
+sendfile(2) and fork(2) to drastically improve static file server performance.
+
+Since HighPerformanceServer is a forking webserver it may also speed up regular
+WEBrick servlets by spreading load across multiple CPUs.
+
+The sendfile(2) system call allows web server writers to offload the job of
+transfering files from the disk to the socket onto the kernel.  The work of
+parsing HTTP headers is very easy and very fast and WEBrick is nearly fast
+enough to match Apache.
+
+When additional work is needed to look up or validate file access (for example,
+the file is stored in MogileFS) it is more performant to write the code in Ruby
+and use HighPerformanceServer than to write a FastCGI handler and easier than writing an Apache module.
+
+== Installing webrick-high-performance
+
+webrick-high-performance depends upon socket_sendfile, and as of 1.0.0
+socket_sendfile is only known to work on FreeBSD.
+
+So if you've got FreeBSD you only need to install the gem:
+
+  $ sudo gem install webrick-high-performance
+
+== Using webrick-high-performance
+
+  #!/usr/local/bin/ruby -w
+  
+  require 'rubygems'
+  require 'webrick'
+  require 'webrick/highperformanceserver'
+  
+  config = {}
+  config[:Port] = 8000
+  config[:Root] = File.expand_path '~/public_html'
+  
+  WEBrick::HighPerformanceServer.create config do |server|
+    trap 'INT' do server.shutdown end
+    trap 'TERM' do server.shutdown end
+    server.start
+  end
+

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$VERBOSE = nil
+
+spec = Gem::Specification.new do |s|
+  s.name = 'webrick-high-performance'
+  s.version = '1.0.0'
+  s.summary = 'A high-performance WEBrick server'
+  s.description = 'A high-performance WEBrick server that takes advantage of sendfile(2) and fork(2) to serve static files really fast.'
+  s.author = 'Eric Hodel'
+  s.email = 'eric@robotcoop.com'
+
+  s.has_rdoc = true
+  s.files = File.read('Manifest.txt').split($/)
+  s.require_path = 'lib'
+
+  s.test_files = Dir.glob('test/test_*.rb')
+
+  s.add_dependency 'socket_sendfile', '>= 1.1.0'
+  s.add_dependency 'socket_accept_filter', '>= 1.0.0'
+end
+
+desc 'Run tests'
+task :default => [ :test ]
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Update Manifest.txt'
+task :update_manifest do
+  sh "find . -type f | sed -e 's%./%%' | egrep -v 'svn|swp|~' | egrep -v '^(doc|pkg)/' | sort > Manifest.txt"
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new :rdoc do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+end
+
+desc 'Generate RDoc for dev.robotcoop.com'
+Rake::RDocTask.new :dev_rdoc do |rd|
+  rd.rdoc_dir = '../../../www/trunk/dev/html/Libraries/webrick-high-performance'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Clean up'
+task :clean => [ :clobber_rdoc, :clobber_package ]
+
+desc 'Clean up'
+task :clobber => [ :clean ]
+
+# vim: syntax=Ruby
+

data/lib/webrick/highperformanceserver.rb

@@ -0,0 +1,156 @@
+require 'webrick'
+require 'socket_accept_filter' rescue LoadError
+require 'socket_sendfile'
+
+class WEBrick::HTTPResponse # :nodoc:
+
+  alias old_send_body_io send_body_io
+  alias old_chunked? chunked?
+
+  def chunked?
+    return @body.is_a?(File) ? false : @chunked
+  end
+  
+  ##
+  # Copied from WEBrick::HTTPResponse to add sendfile support.
+
+  def send_body_io(socket)
+    socket.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1 # HACK yuck
+
+    if @request_method == "HEAD"
+      # do nothing
+    elsif @body.kind_of? File
+      socket.sendfile @body
+    elsif chunked?
+      while buf = @body.read(BUFSIZE)
+        next if buf.empty?
+        data = ""
+        data << format("%x", buf.size) << CRLF
+        data << buf << CRLF
+        _write_data(socket, data)
+        @sent_size += buf.size
+      end
+      _write_data(socket, "0#{CRLF}#{CRLF}")
+    else
+      size = @header['content-length'].to_i
+      _send_file(socket, @body, 0, size)
+      @sent_size = size
+    end
+  ensure
+    @body.close
+  end
+
+end
+
+module WEBrick::Config
+
+  ##
+  # HighPerformanceServer default configuration.
+
+  HighPerformance = HTTP.dup.update(
+    :RequestTimeout => 2,
+    :Processes => 8
+  )
+
+end
+
+##
+# A high performance WEBrick server that takes advantage of sendfile(2) and
+# fork(2) to drastically increase the performance of serving static files.
+#
+# Instead of starting a HighPerformanceServer like a regular HTTPServer, use
+# HighPerformanceServer::create.
+
+class WEBrick::HighPerformanceServer < WEBrick::HTTPServer
+
+  ##
+  # This process starts up a bunch of listeners than forks children to do the
+  # actual work.
+
+  @listeners = []
+
+  class << self
+
+    ##
+    # Server sockets for my children.
+
+    attr_accessor :listeners
+
+    ##
+    # Creates :Processes new HighPerformanceServers all listening on the same
+    # server sockets.
+    #
+    # +config+ and +default+ work the same as they do for HTTPServer.
+    #
+    # yields each forked child's server object.  The server will not be
+    # started nor will signals be caught.
+    #
+    # Returns the pids of the created HighPerformanceServer children.
+    #
+    # Typical usage:
+    #
+    #   WEBrick::HighPerformanceServer.create do |server|
+    #     server.mount '/', WEBrick::HTTPServlet::FileHandler,
+    #                  '/usr/local/www/data'
+    #     trap 'INT' do server.shutdown end
+    #     trap 'TERM' do server.shutdown end
+    #     server.start
+    #   end
+
+    def create(config = {}, default = WEBrick::Config::HighPerformance)
+      config = default.dup.update config
+      bind_address = config[:BindAddress]
+      port = config[:Port]
+      processes = config[:Processes]
+      config[:Logger] ||= WEBrick::Log.new
+
+      @listeners = WEBrick::Utils.create_listeners bind_address, port
+      if @listeners.first.respond_to? :set_accept_filter then
+        @listeners.each do |server|
+          server.set_accept_filter 'httpready'
+        end
+      end
+
+      pids = []
+
+      processes.times do
+        pids << fork do
+          server = self.new config, default
+          yield server
+        end
+      end
+
+      return pids
+    end
+
+  end
+
+  ##
+  # Only need to override default.
+
+  def initialize(config = {}, default = WEBrick::Config::HighPerformance)
+    super config, default
+  end
+
+  ##
+  # HighPerformanceServer doesn't log.  Oh you want access logs?  Well tough!
+
+  def access_log(*args)
+  end
+
+  ##
+  # Our listeners have already been created, so suck them in from the class.
+
+  def listen(address, port)
+    @listeners = self.class.listeners
+  end
+
+  ##
+  # Don't close the listeners, just stop.
+
+  def shutdown
+    stop
+  end
+
+end
+

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11.6
+specification_version: 1
+name: webrick-high-performance
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-03-24 00:00:00 -08:00
+summary: A high-performance WEBrick server
+require_paths: 
+- lib
+email: eric@robotcoop.com
+homepage: 
+rubyforge_project: 
+description: A high-performance WEBrick server that takes advantage of sendfile(2) and fork(2) to serve static files really fast.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Eric Hodel
+files: 
+- LICENSE
+- Manifest.txt
+- README
+- Rakefile
+- lib/webrick/highperformanceserver.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: socket_sendfile
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: socket_accept_filter
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: