unicorn 3.3.1 → 3.4.0

data/.wrongdoc.yml

@@ -1,6 +1,6 @@
 ---
-cgit_url: http://git.bogomips.org/cgit/unicorn.git
-git_url: git://git.bogomips.org/unicorn.git
+cgit_url: http://bogomips.org/unicorn.git
+git_url: git://bogomips.org/unicorn.git
 rdoc_url: http://unicorn.bogomips.org/
 changelog_start: v1.1.5
 merge_html:

data/GIT-VERSION-GEN

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

data/KNOWN_ISSUES

@@ -3,16 +3,17 @@
 Occasionally odd {issues}[link:ISSUES.html] arise without a transparent or
 acceptable solution.  Those issues are documented here.
 
+* Under some versions of Ruby 1.8, it is necessary to call +srand+ in an
+  after_fork hook to get correct random number generation.
+
+  See http://redmine.ruby-lang.org/issues/show/4338
+
 * For notes on sandboxing tools such as Bundler or Isolate,
   see the {Sandbox}[link:Sandbox.html] page.
 
-* Under Ruby 1.9.1, methods like Array#shuffle and Array#sample will
-  segfault if called after forking.  This is fixed in trunk (r26936) and
-  should be backported to the next 1.9.1 stable release (after p378).
-  Until then, it is advisable to call "Kernel.rand" in your after_fork
-  hook to reinitialize the random number generator.
-
-  See http://redmine.ruby-lang.org/issues/show/2962 for more details
+* nginx with "sendfile on" under FreeBSD 8 is broken when
+  uploads are buffered to disk.  Disabling sendfile is required to
+  work around this bug which should be fixed in newer versions of FreeBSD.
 
 * When using "preload_app true", with apps using background threads
   need to restart them in the after_fork hook because threads are never
@@ -22,6 +23,15 @@ acceptable solution.  Those issues are documented here.
   deadlocks.  The core Ruby Logger class needlessly uses a MonitorMutex
   which can be disabled with a {monkey patch}[link:examples/logger_mp_safe.rb]
 
+== Known Issues (Old)
+
+* Under Ruby 1.9.1, methods like Array#shuffle and Array#sample will
+  segfault if called after forking.  Upgrade to Ruby 1.9.2 or call
+  "Kernel.rand" in your after_fork hook to reinitialize the random
+  number generator.
+
+  See http://redmine.ruby-lang.org/issues/show/2962 for more details
+
 * Rails 2.3.2 bundles its own version of Rack.  This may cause subtle
   bugs when simultaneously loaded with the system-wide Rack Rubygem
   which Unicorn depends on.  Upgrading to Rails 2.3.4 (or later) is

data/README

@@ -85,13 +85,13 @@ You may also install it via RubyGems on Gemcutter:
 You can get the latest source via git from the following locations
 (these versions may not be stable):
 
-  git://git.bogomips.org/unicorn.git
+  git://bogomips.org/unicorn.git
   git://repo.or.cz/unicorn.git (mirror)
 
 You may browse the code from the web and download the latest snapshot
 tarballs here:
 
-* http://git.bogomips.org/cgit/unicorn.git (cgit)
+* http://bogomips.org/unicorn.git (cgit)
 * http://repo.or.cz/w/unicorn.git (gitweb)
 
 See the HACKING guide on how to contribute and build prerelease gems

data/Rakefile

@@ -1,8 +1,9 @@
 # -*- encoding: binary -*-
 autoload :Gem, 'rubygems'
+require 'wrongdoc'
 
-cgit_url = "http://git.bogomips.org/cgit/unicorn.git"
-git_url = ENV['GIT_URL'] || 'git://git.bogomips.org/unicorn.git'
+cgit_url = Wrongdoc.config[:cgit_url]
+git_url = Wrongdoc.config[:git_url]
 
 desc "post to RAA"
 task :raa_update do

data/examples/nginx.conf

@@ -83,9 +83,9 @@ http {
   }
 
   server {
+    # enable one of the following if you're on Linux or FreeBSD
     # listen 80 default deferred; # for Linux
     # listen 80 default accept_filter=httpready; # for FreeBSD
-    listen 80 default;
 
     client_max_body_size 4G;
     server_name _;
@@ -98,7 +98,16 @@ http {
     # path for static files
     root /path/to/app/current/public;
 
-    location / {
+    # Prefer to serve static files directly from nginx to avoid unnecessary
+    # data copies from the application server.
+    #
+    # try_files directive appeared in in nginx 0.7.27 and has stabilized
+    # over time.  Older versions of nginx (e.g. 0.6.x) requires
+    # "if (!-f $request_filename)" which was less efficient:
+    # http://bogomips.org/unicorn.git/tree/examples/nginx.conf?id=v3.3.1#n127
+    try_files $uri/index.html $uri.html $uri @app;
+
+    location @app {
       # an HTTP header important enough to have its own Wikipedia entry:
       #   http://en.wikipedia.org/wiki/X-Forwarded-For
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -122,12 +131,7 @@ http {
       # clients, really.
       # proxy_buffering off;
 
-      # Try to serve static files from nginx, no point in making an
-      # *application* server like Unicorn/Rainbows! serve static files.
-      if (!-f $request_filename) {
-        proxy_pass http://app_server;
-        break;
-      }
+      proxy_pass http://app_server;
     }
 
     # Rails error pages

data/ext/unicorn_http/unicorn_http.rl

@@ -505,7 +505,18 @@ static void set_server_vars(VALUE env, VALUE *server_port)
   if (!NIL_P(host)) {
     char *host_ptr = RSTRING_PTR(host);
     long host_len = RSTRING_LEN(host);
-    char *colon = memchr(host_ptr, ':', host_len);
+    char *colon;
+
+    if (*host_ptr == '[') { /* ipv6 address format */
+      char *rbracket = memchr(host_ptr + 1, ']', host_len - 1);
+
+      if (rbracket)
+        colon = (rbracket[1] == ':') ? rbracket + 1 : NULL;
+      else
+        colon = memchr(host_ptr + 1, ':', host_len - 1);
+    } else {
+      colon = memchr(host_ptr, ':', host_len);
+    }
 
     if (colon) {
       long port_start = colon - host_ptr + 1;

data/ext/unicorn_http/unicorn_http_common.rl

@@ -26,7 +26,7 @@
 
 # URI schemes and absolute paths
   scheme = ( "http"i ("s"i)? ) $downcase_char >mark %scheme;
-  hostname = (alnum | "-" | "." | "_")+;
+  hostname = ((alnum | "-" | "." | "_")+ | ("[" (":" | xdigit)+ "]"));
   host_with_port = (hostname (":" digit*)?) >mark %host;
   userinfo = ((unreserved | escape | ";" | ":" | "&" | "=" | "+")+ "@")*;
 

data/lib/unicorn/app/exec_cgi.rb

@@ -28,6 +28,24 @@ module Unicorn::App
       SERVER_SOFTWARE
     ).map { |x| x.freeze } # frozen strings are faster for Hash assignments
 
+    class Body < Unicorn::TmpIO
+      def body_offset=(n)
+        sysseek(@body_offset = n)
+      end
+
+      def each(&block)
+        sysseek @body_offset
+        # don't use a preallocated buffer for sysread since we can't
+        # guarantee an actual socket is consuming the yielded string
+        # (or if somebody is pushing to an array for eventual concatenation
+        begin
+          yield sysread(CHUNK_SIZE)
+        rescue EOFError
+          break
+        end while true
+      end
+    end
+
     # Intializes the app, example of usage in a config.ru
     #   map "/cgit" do
     #     run Unicorn::App::ExecCgi.new("/path/to/cgit.cgi")
@@ -43,7 +61,7 @@ module Unicorn::App
 
     # Calls the app
     def call(env)
-      out, err = Unicorn::TmpIO.new, Unicorn::TmpIO.new
+      out, err = Body.new, Unicorn::TmpIO.new
       inp = force_file_input(env)
       pid = fork { run_child(inp, out, err, env) }
       inp.close
@@ -67,9 +85,9 @@ module Unicorn::App
       ENV['GATEWAY_INTERFACE'] = 'CGI/1.1'
       env.keys.grep(/^HTTP_/) { |key| ENV[key] = env[key] }
 
-      a = IO.new(0).reopen(inp)
-      b = IO.new(1).reopen(out)
-      c = IO.new(2).reopen(err)
+      $stdin.reopen(inp)
+      $stdout.reopen(out)
+      $stderr.reopen(err)
       exec(*args)
     end
 
@@ -87,23 +105,7 @@ module Unicorn::App
         offset = 4
       end
       offset += head.length
-
-      # Allows +out+ to be used as a Rack body.
-      out.instance_eval { class << self; self; end }.instance_eval {
-        define_method(:each) { |&blk|
-          sysseek(offset)
-
-          # don't use a preallocated buffer for sysread since we can't
-          # guarantee an actual socket is consuming the yielded string
-          # (or if somebody is pushing to an array for eventual concatenation
-          begin
-            blk.call(sysread(CHUNK_SIZE))
-          rescue EOFError
-            break
-          end while true
-        }
-      }
-
+      out.body_offset = offset
       size -= offset
       prev = nil
       headers = Rack::Utils::HeaderHash.new
@@ -113,8 +115,9 @@ module Unicorn::App
         when /^[ \t]/ then headers[prev] << "\n#{line}" if prev
         end
       end
+      status = headers.delete("Status") || 200
       headers['Content-Length'] = size.to_s
-      [ 200, headers, out ]
+      [ status, headers, out ]
     end
 
     # ensures rack.input is a file handle that we can redirect stdin to

data/lib/unicorn/configurator.rb

@@ -247,13 +247,13 @@ class Unicorn::Configurator
   #
   # Default: operating system defaults (usually Nagle's algorithm enabled)
   #
-  # +:tcp_nopush+: enables TCP_CORK in Linux or TCP_NOPUSH in FreeBSD
+  # +:tcp_nopush+: enables/disables TCP_CORK in Linux or TCP_NOPUSH in FreeBSD
   #
-  # This will prevent partial TCP frames from being sent out.
-  # Enabling +tcp_nopush+ is generally not needed or recommended as
-  # controlling +tcp_nodelay+ already provides sufficient latency
-  # reduction whereas Unicorn does not know when the best times are
-  # for flushing corked sockets.
+  # This is enabled by default as of Unicorn 3.4.  This prevents partial
+  # TCP frames from being sent out and reduces wakeups in nginx if it is
+  # on a different machine.  Since Unicorn is only designed for applications
+  # that send the response body quickly without keepalive, sockets will
+  # always be flushed on close to prevent delays.
   #
   # This has no effect on UNIX sockets.
   #
@@ -455,7 +455,7 @@ class Unicorn::Configurator
   # Rainbows!/Zbatery installations facing untrusted clients directly
   # should set this to +false+.  This is +true+ by default as Unicorn
   # is designed to only sit behind trusted nginx proxies.
-  def trust_x_forwarded(bool)
+  def trust_x_forwarded(bool) # :nodoc:
     set_bool(:trust_x_forwarded, bool)
   end
 
@@ -473,10 +473,10 @@ class Unicorn::Configurator
       File.expand_path(address)
     when %r{\A(?:\*:)?(\d+)\z}
       "0.0.0.0:#$1"
-    when %r{\A(.*):(\d+)\z}
-      # canonicalize the name
-      packed = Socket.pack_sockaddr_in($2.to_i, $1)
-      Socket.unpack_sockaddr_in(packed).reverse!.join(':')
+    when %r{\A\[([a-fA-F0-9:]+)\]\z}, %r/\A((?:\d+\.){3}\d+)\z/
+      canonicalize_tcp($1, 80)
+    when %r{\A\[([a-fA-F0-9:]+)\]:(\d+)\z}, %r{\A(.*):(\d+)\z}
+      canonicalize_tcp($1, $2.to_i)
     else
       address
     end
@@ -489,6 +489,12 @@ private
     set[var] = n
   end
 
+  def canonicalize_tcp(addr, port)
+    packed = Socket.pack_sockaddr_in(port, addr)
+    port, addr = Socket.unpack_sockaddr_in(packed)
+    /:/ =~ addr ? "[#{addr}]:#{port}" : "#{addr}:#{port}"
+  end
+
   def set_path(var, path) #:nodoc:
     case path
     when NilClass, String

data/lib/unicorn/const.rb

@@ -7,8 +7,8 @@
 # improve things much compared to constants.
 module Unicorn::Const
 
-  # The current version of Unicorn, currently 3.3.1
-  UNICORN_VERSION = "3.3.1"
+  # The current version of Unicorn, currently 3.4.0
+  UNICORN_VERSION = "3.4.0"
 
   # default TCP listen host address (0.0.0.0, all interfaces)
   DEFAULT_HOST = "0.0.0.0"

data/lib/unicorn/http_response.rb

@@ -26,7 +26,7 @@ module Unicorn::HttpResponse
             "Status: #{status}\r\n" \
             "Connection: close\r\n"
       headers.each do |key, value|
-        next if %r{\A(?:Date\z|Status\z|Connection\z)}i =~ key
+        next if %r{\A(?:Date\z|Connection\z)}i =~ key
         if value =~ /\n/
           # avoiding blank, key-only cookies with /\n+/
           buf << value.split(/\n+/).map! { |v| "#{key}: #{v}\r\n" }.join

data/lib/unicorn/http_server.rb

@@ -424,7 +424,6 @@ class Unicorn::HttpServer
 
     if pid
       old_pid = "#{pid}.oldbin"
-      prev_pid = pid.dup
       begin
         self.pid = old_pid  # clear the path for a new pid file
       rescue ArgumentError

data/lib/unicorn/socket_helper.rb

@@ -23,6 +23,10 @@ module Unicorn
 
       # same default value as Mongrel
       :backlog => 1024,
+
+      # since we don't do keepalive, we'll always flush-on-close and
+      # this saves packets for everyone.
+      :tcp_nopush => true,
     }
     #:startdoc:
 
@@ -45,17 +49,19 @@ module Unicorn
 
     def set_tcp_sockopt(sock, opt)
       # highly portable, but off by default because we don't do keepalive
-      if defined?(TCP_NODELAY) && ! (val = opt[:tcp_nodelay]).nil?
+      if defined?(TCP_NODELAY)
+        val = opt[:tcp_nodelay]
+        val = DEFAULTS[:tcp_nodelay] if nil == val
         sock.setsockopt(IPPROTO_TCP, TCP_NODELAY, val ? 1 : 0)
       end
 
-      unless (val = opt[:tcp_nopush]).nil?
-        val = val ? 1 : 0
-        if defined?(TCP_CORK) # Linux
-          sock.setsockopt(IPPROTO_TCP, TCP_CORK, val)
-        elsif defined?(TCP_NOPUSH) # TCP_NOPUSH is untested (FreeBSD)
-          sock.setsockopt(IPPROTO_TCP, TCP_NOPUSH, val)
-        end
+      val = opt[:tcp_nopush]
+      val = DEFAULTS[:tcp_nopush] if nil == val
+      val = val ? 1 : 0
+      if defined?(TCP_CORK) # Linux
+        sock.setsockopt(IPPROTO_TCP, TCP_CORK, val)
+      elsif defined?(TCP_NOPUSH) # TCP_NOPUSH is untested (FreeBSD)
+        sock.setsockopt(IPPROTO_TCP, TCP_NOPUSH, val)
       end
 
       # No good reason to ever have deferred accepts off
@@ -64,17 +70,17 @@ module Unicorn
         # this differs from nginx, since nginx doesn't allow us to
         # configure the the timeout...
         seconds = opt[:tcp_defer_accept]
-        seconds = DEFAULTS[:tcp_defer_accept] if seconds == true
+        seconds = DEFAULTS[:tcp_defer_accept] if [true,nil].include?(seconds)
         seconds = 0 unless seconds # nil/false means disable this
         sock.setsockopt(SOL_TCP, TCP_DEFER_ACCEPT, seconds)
       elsif respond_to?(:accf_arg)
-        if name = opt[:accept_filter]
-          begin
-            sock.setsockopt(SOL_SOCKET, SO_ACCEPTFILTER, accf_arg(name))
-          rescue => e
-            logger.error("#{sock_name(sock)} " \
-                         "failed to set accept_filter=#{name} (#{e.inspect})")
-          end
+        name = opt[:accept_filter]
+        name = DEFAULTS[:accept_filter] if nil == name
+        begin
+          sock.setsockopt(SOL_SOCKET, SO_ACCEPTFILTER, accf_arg(name))
+        rescue => e
+          logger.error("#{sock_name(sock)} " \
+                       "failed to set accept_filter=#{name} (#{e.inspect})")
         end
       end
     end
@@ -130,7 +136,8 @@ module Unicorn
         ensure
           File.umask(old_umask)
         end
-      elsif address =~ /^(\d+\.\d+\.\d+\.\d+):(\d+)$/
+      elsif /\A(\d+\.\d+\.\d+\.\d+):(\d+)\z/ =~ address ||
+            /\A\[([a-fA-F0-9:]+)\]:(\d+)\z/ =~ address
         Kgio::TCPServer.new($1, $2.to_i)
       else
         raise ArgumentError, "Don't know how to bind: #{address}"
@@ -139,6 +146,13 @@ module Unicorn
       sock
     end
 
+    # returns rfc2732-style (e.g. "[::1]:666") addresses for IPv6
+    def tcp_name(sock)
+      port, addr = Socket.unpack_sockaddr_in(sock.getsockname)
+      /:/ =~ addr ? "[#{addr}]:#{port}" : "#{addr}:#{port}"
+    end
+    module_function :tcp_name
+
     # Returns the configuration name of a socket as a string.  sock may
     # be a string value, in which case it is returned as-is
     # Warning: TCP sockets may not always return the name given to it.
@@ -148,10 +162,10 @@ module Unicorn
       when UNIXServer
         Socket.unpack_sockaddr_un(sock.getsockname)
       when TCPServer
-        Socket.unpack_sockaddr_in(sock.getsockname).reverse!.join(':')
+        tcp_name(sock)
       when Socket
         begin
-          Socket.unpack_sockaddr_in(sock.getsockname).reverse!.join(':')
+          tcp_name(sock)
         rescue ArgumentError
           Socket.unpack_sockaddr_un(sock.getsockname)
         end

data/lib/unicorn/tee_input.rb

@@ -118,7 +118,7 @@ private
   end
 
   def tee(buffer)
-    if buffer && (n = buffer.size) > 0
+    if buffer && buffer.size > 0
       @tmp.write(buffer)
       @tmp.seek(0, IO::SEEK_END) # workaround FreeBSD/OSX + MRI 1.8.x bug
     end

data/script/isolate_for_tests

@@ -17,7 +17,7 @@ opts = {
 pid = fork do
   Isolate.now!(opts) do
     gem 'sqlite3-ruby', '1.2.5'
-    gem 'kgio', '2.1.1'
+    gem 'kgio', '2.2.0'
     gem 'rack', '1.1.0'
   end
 end