unicorn 4.9.0 → 5.0.1

data/NEWS

@@ -1,3 +1,162 @@
+=== unicorn 5.0.0.pre2 - another prerelease! / 2015-07-06 21:37 UTC
+
+  There is a minor TCP socket options are now applied to inherited
+  sockets, and we have native support for inheriting sockets from
+  systemd (by emulating the sd_listen_fds(3) function).
+
+  Dynamic changes in the application to Rack::Utils::HTTP_STATUS
+  codes is now supported, so you can use your own custom status
+  lines.
+
+  Ruby 2.2 and later is now favored for performance.
+  Optimizations by using constants which made sense in earlier
+  versions of Ruby are gone: so users of old Ruby versions
+  will see performance regressions.  Ruby 2.2 users should
+  see the same or better performance, and we have less code
+  as a result.
+
+  * doc: update some invalid URLs
+  * apply TCP socket options on inherited sockets
+  * reflect changes in Rack::Utils::HTTP_STATUS_CODES
+  * reduce constants and optimize for Ruby 2.2
+  * http_response: reduce size of multi-line header path
+  * emulate sd_listen_fds for systemd support
+  * test/unit/test_response.rb: compatibility with older test-unit
+
+  This also includes all changes in unicorn 5.0.0.pre1:
+
+  http://bogomips.org/unicorn-public/m/20150615225652.GA16164@dcvr.yhbt.net.html
+
+=== unicorn 5.0.0.pre1 - incompatible changes! / 2015-06-15 22:49 UTC
+
+  This release finally drops Ruby 1.8 support and requires Ruby 1.9.3
+  or later.  The horrible "Status:" header in our HTTP response is
+  finally gone, saving at least 16 precious bytes in every single HTTP
+  response.
+
+  Under Ruby 2.1 and later, the monotonic clock is used for timeout
+  handling for better accuracy.
+
+  Several experimental, unused and undocumented features are removed.
+
+  There's also tiny, minor performance and memory improvements from
+  dropping 1.8 compatibility, but probably nothing noticeable on a
+  typical real-life (bloated) app.
+
+  The biggest performance improvement we made was to our website by
+  switching to olddoc.  Depending on connection speed, latency, and
+  renderer performance, it typically loads two to four times faster.
+
+  Finally, for the billionth time: unicorn must never be exposed
+  to slow clients, as it will never ever use new-fangled things
+  like non-blocking socket I/O, threads, epoll or kqueue.  unicorn
+  must be used with a fully-buffering reverse proxy such as nginx
+  for slow clients.
+
+  * ISSUES: update with mailing list subscription
+  * GIT-VERSION-GEN: start 5.0.0 development
+  * http: remove xftrust options
+  * FAQ: add entry for Rails autoflush_log
+  * dev: remove isolate dependency
+  * unicorn.gemspec: depend on test-unit 3.0
+  * http_response: remove Status: header
+  * remove RubyForge and Freecode references
+  * remove mongrel.rubyforge.org references
+  * http: remove the keepalive requests limit
+  * http: reduce parser from 72 to 56 bytes on 64-bit
+  * examples: add run_once to before_fork hook example
+  * worker: remove old tmp accessor
+  * http_server: save 450+ bytes of memory on x86-64
+  * t/t0002-parser-error.sh: relax test for rack 1.6.0
+  * remove SSL support
+  * tmpio: drop the "size" method
+  * switch docs + website to olddoc
+  * README: clarify/reduce references to unicorn_rails
+  * gemspec: fixup olddoc migration
+  * use the monotonic clock under Ruby 2.1+
+  * http: -Wshorten-64-to-32 warnings on clang
+  * remove old inetd+git examples and exec_cgi
+  * http: standalone require + reduction in binary size
+  * GNUmakefile: fix clean gem build + reduce build cruft
+  * socket_helper: reduce constant lookups and caching
+  * remove 1.8, <= 1.9.1 fallback for missing IO#autoclose=
+  * favor IO#close_on_exec= over fcntl in 1.9+
+  * use require_relative to reduce syscalls at startup
+  * doc: update support status for Ruby versions
+  * fix uninstalled testing and reduce require paths
+  * test_socket_helper: do not depend on SO_REUSEPORT
+  * favor "a.b(&:c)" form over "a.b { |x| x.c }"
+  * ISSUES: add section for bugs in other projects
+  * http_server: favor ivars over constants
+  * explain 11 byte magic number for self-pipe
+  * const: drop constants used by Rainbows!
+  * reduce and localize constant string use
+  * Links: mark Rainbows! as historical, reference yahns
+  * save about 200 bytes of memory on x86-64
+  * http: remove deprecated reset method
+  * http: remove experimental dechunk! method
+  * socket_helper: update comments
+  * doc: document UNICORN_FD in manpage
+  * doc: document Etc.nprocessors for worker_processes
+  * favor more string literals for cold call sites
+  * tee_input: support for Rack::TempfileReaper middleware
+  * support TempfileReaper in deployment and development envs
+  * favor kgio_wait_readable for single FD over select
+  * Merge tag 'v4.9.0'
+  * http_request: support rack.hijack by default
+  * avoid extra allocation for hijack proc creation
+  * FAQ: add note about ECONNRESET errors from bodies
+  * process SIGWINCH unless stdin is a TTY
+  * ISSUES: discourage HTML mail strongly, welcome nyms
+  * http: use rb_hash_clear in Ruby 2.0+
+  * http_response: avoid special-casing for Rack < 1.5
+  * www: install NEWS.atom.xml properly
+  * http_server: remove a few more accessors and constants
+  * http_response: simplify regular expression
+  * move the socket into Rack env for hijacking
+  * http: move response_start_sent into the C ext
+  * FAQ: reorder bit on Rack 1.1.x and Rails 2.3.x
+  * ensure body is closed during hijack
+
+=== unicorn 4.9.0 - TempfileReaper support in Rack 1.6 / 2015-04-24 03:09 UTC
+
+  This release supports the Rack::TempfileReaper middleware found
+  in rack 1.6 for cleaning up disk space used by temporary files.
+  We also use Rack::TempfileReaper for cleaning up large temporary
+  files buffered with TeeInput.  Users on rack 1.5 and earlier
+  will see no changes.
+
+  There's also a bunch of documentation/build system improvements.
+
+  This is likely to be the last Ruby 1.8-compatible release,
+  unicorn 5.x will require 1.9.3 or later as well as dropping lots
+  of cruft (the stupid "Status:" header in responses being the
+  most notable).
+
+  21 changes backported from master:
+
+        ISSUES: update with mailing list subscription
+        FAQ: add entry for Rails autoflush_log
+        dev: remove isolate dependency
+        unicorn.gemspec: depend on test-unit 3.0
+        remove RubyForge and Freecode references
+        remove mongrel.rubyforge.org references
+        examples: add run_once to before_fork hook example
+        t/t0002-parser-error.sh: relax test for rack 1.6.0
+        switch docs + website to olddoc
+        README: clarify/reduce references to unicorn_rails
+        gemspec: fixup olddoc migration
+        GNUmakefile: fix clean gem build + reduce build cruft
+        doc: update support status for Ruby versions
+        fix uninstalled testing and reduce require paths
+        test_socket_helper: do not depend on SO_REUSEPORT
+        ISSUES: add section for bugs in other projects
+        explain 11 byte magic number for self-pipe
+        Links: mark Rainbows! as historical, reference yahns
+        doc: document UNICORN_FD in manpage
+        tee_input: support for Rack::TempfileReaper middleware
+        support TempfileReaper in deployment and development envs
+
 === unicorn 4.8.3 - the end of an era / 2014-05-07 07:50 UTC
 
   This release updates documentation to reflect the migration of the

data/PHILOSOPHY

@@ -137,9 +137,3 @@ unicorn is highly inefficient for Comet/reverse-HTTP/push applications
 where the HTTP connection spends a large amount of time idle.
 Nevertheless, the ease of troubleshooting, debugging, and management of
 unicorn may still outweigh the drawbacks for these applications.
-
-The {Rainbows!}[http://rainbows.bogomips.org/] aims to fill the gap for
-odd corner cases where the nginx + unicorn combination is not enough.
-While Rainbows! management/administration is largely identical to
-unicorn, Rainbows! is far more ambitious and has seen little real-world
-usage.

data/README

@@ -1,23 +1,23 @@
-= Unicorn: Rack HTTP server for fast clients and Unix
+= unicorn: Rack HTTP server for fast clients and Unix
 
-\Unicorn is an HTTP server for Rack applications designed to only serve
+unicorn is an HTTP server for Rack applications designed to only serve
 fast clients on low-latency, high-bandwidth connections and take
 advantage of features in Unix/Unix-like kernels.  Slow clients should
 only be served by placing a reverse proxy capable of fully buffering
-both the the request and response in between \Unicorn and slow clients.
+both the the request and response in between unicorn and slow clients.
 
 == Features
 
 * Designed for Rack, Unix, fast clients, and ease-of-debugging.  We
   cut out everything that is better supported by the operating system,
-  {nginx}[http://nginx.net/] or {Rack}[http://rack.github.io/].
+  {nginx}[http://nginx.org/] or {Rack}[http://rack.github.io/].
 
 * Compatible with Ruby 1.9.3 and later.
   unicorn 4.8.x will remain supported for Ruby 1.8 users.
 
-* Process management: \Unicorn will reap and restart workers that
+* Process management: unicorn will reap and restart workers that
   die from broken apps.  There is no need to manage multiple processes
-  or ports yourself.  \Unicorn can spawn and manage any number of
+  or ports yourself.  unicorn can spawn and manage any number of
   worker processes you choose to scale to your backend.
 
 * Load balancing is done entirely by the operating system kernel.
@@ -33,11 +33,11 @@ both the the request and response in between \Unicorn and slow clients.
 * Builtin reopening of all log files in your application via
   USR1 signal.  This allows logrotate to rotate files atomically and
   quickly via rename instead of the racy and slow copytruncate method.
-  \Unicorn also takes steps to ensure multi-line log entries from one
+  unicorn also takes steps to ensure multi-line log entries from one
   request all stay within the same file.
 
 * nginx-style binary upgrades without losing connections.
-  You can upgrade \Unicorn, your entire application, libraries
+  You can upgrade unicorn, your entire application, libraries
   and even your Ruby interpreter without dropping clients.
 
 * before_fork and after_fork hooks in case your application
@@ -60,15 +60,15 @@ both the the request and response in between \Unicorn and slow clients.
 
 == License
 
-\Unicorn is copyright 2009 by all contributors (see logs in git).
+unicorn is copyright 2009 by all contributors (see logs in git).
 It is based on Mongrel 1.1.5.
 Mongrel is copyright 2007 Zed A. Shaw and contributors.
 
-\Unicorn is licensed under (your choice) of the GPLv2 or later
+unicorn is licensed under (your choice) of the GPLv2 or later
 (GPLv3+ preferred), or Ruby (1.8)-specific terms.
 See the included LICENSE file for details.
 
-\Unicorn is 100% Free Software.
+unicorn is 100% Free Software.
 
 == Install
 
@@ -108,17 +108,17 @@ In RAILS_ROOT, run:
 
   unicorn_rails
 
-\Unicorn will bind to all interfaces on TCP port 8080 by default.
+unicorn will bind to all interfaces on TCP port 8080 by default.
 You may use the +--listen/-l+ switch to bind to a different
 address:port or a UNIX socket.
 
 === Configuration File(s)
 
-\Unicorn will look for the config.ru file used by rackup in APP_ROOT.
+unicorn will look for the config.ru file used by rackup in APP_ROOT.
 
-For deployments, it can use a config file for \Unicorn-specific options
+For deployments, it can use a config file for unicorn-specific options
 specified by the +--config-file/-c+ command-line switch.  See
-Unicorn::Configurator for the syntax of the \Unicorn-specific options.
+Unicorn::Configurator for the syntax of the unicorn-specific options.
 The default settings are designed for maximum out-of-the-box
 compatibility with existing applications.
 
@@ -130,7 +130,7 @@ supported.  Run `unicorn -h` to see command-line options.
 There is NO WARRANTY whatsoever if anything goes wrong, but
 {let us know}[link:ISSUES.html] and we'll try our best to fix it.
 
-\Unicorn is designed to only serve fast clients either on the local host
+unicorn is designed to only serve fast clients either on the local host
 or a fast LAN.  See the PHILOSOPHY and DESIGN documents for more details
 regarding this.
 
@@ -140,6 +140,11 @@ All feedback (bug reports, user/development dicussion, patches, pull
 requests) go to the mailing list/newsgroup.  See the ISSUES document for
 information on the {mailing list}[mailto:unicorn-public@bogomips.org].
 
-For the latest on \Unicorn releases, you may also finger us at
+The mailing list is archived at http://bogomips.org/unicorn-public/
+Read-only NNTP access is available at:
+nntp://news.public-inbox.org/inbox.comp.lang.ruby.unicorn and
+nntp://news.gmane.org/gmane.comp.lang.ruby.unicorn.general
+
+For the latest on unicorn releases, you may also finger us at
 unicorn@bogomips.org or check our NEWS page (and subscribe to our Atom
 feed).

data/SIGNALS

@@ -3,7 +3,7 @@
 In general, signals need only be sent to the master process.  However,
 the signals Unicorn uses internally to communicate with the worker
 processes are documented here as well.  With the exception of TTIN/TTOU,
-signal handling matches the behavior of {nginx}[http://nginx.net/] so it
+signal handling matches the behavior of {nginx}[http://nginx.org/] so it
 should be possible to easily share process management scripts between
 Unicorn and nginx.
 

data/Sandbox

@@ -1,10 +1,10 @@
-= Tips for using \Unicorn with Sandbox installation tools
+= Tips for using unicorn with Sandbox installation tools
 
 Since unicorn includes executables and is usually used to start a Ruby
 process, there are certain caveats to using it with tools that sandbox
 RubyGems installations such as
-{Bundler}[http://gembundler.com/] or
-{Isolate}[http://github.com/jbarnette/isolate].
+{Bundler}[http://bundler.io/] or
+{Isolate}[https://github.com/jbarnette/isolate].
 
 == General deployment
 
@@ -58,7 +58,7 @@ the before_exec hook:
 
 If you're using an older Bundler version (0.9.x), you may need to set or
 reset GEM_HOME, GEM_PATH and PATH environment variables in the
-before_exec hook as illustrated by http://gist.github.com/534668
+before_exec hook as illustrated by https://gist.github.com/534668
 
 === Ruby 2.0.0 close-on-exec and SIGUSR2 incompatibility
 

data/TUNING

@@ -1,10 +1,10 @@
-= Tuning \Unicorn
+= Tuning unicorn
 
-\Unicorn performance is generally as good as a (mostly) Ruby web server
+unicorn performance is generally as good as a (mostly) Ruby web server
 can provide.  Most often the performance bottleneck is in the web
 application running on Unicorn rather than Unicorn itself.
 
-== \Unicorn Configuration
+== unicorn Configuration
 
 See Unicorn::Configurator for details on the config file format.
 +worker_processes+ is the most-commonly needed tuning parameter.
@@ -14,12 +14,15 @@ See Unicorn::Configurator for details on the config file format.
 * worker_processes should be scaled to the number of processes your
   backend system(s) can support.  DO NOT scale it to the number of
   external network clients your application expects to be serving.
-  \Unicorn is NOT for serving slow clients, that is the job of nginx.
+  unicorn is NOT for serving slow clients, that is the job of nginx.
 
 * worker_processes should be *at* *least* the number of CPU cores on
-  a dedicated server.  If your application has occasionally slow
-  responses that are /not/ CPU-intensive, you may increase this to
-  workaround those inefficiencies.
+  a dedicated server (unless you do not have enough memory).
+  If your application has occasionally slow responses that are /not/
+  CPU-intensive, you may increase this to workaround those inefficiencies.
+
+* Under Ruby 2.2 or later, Etc.nprocessors may be used to determine
+  the number of CPU cores present.
 
 * worker_processes may be increased for Unicorn::OobGC users to provide
   more consistent response times.
@@ -55,7 +58,7 @@ See Unicorn::Configurator for details on the config file format.
 * UNIX domain sockets are slightly faster than TCP sockets, but only
   work if nginx is on the same machine.
 
-== Other \Unicorn settings
+== Other unicorn settings
 
 * Setting "preload_app true" can allow copy-on-write-friendly GC to
   be used to save memory.  It will probably not work out of the box with

data/bin/unicorn

@@ -29,7 +29,7 @@ op = OptionParser.new("", 24, '  ') do |opts|
 
   opts.on("-I", "--include PATH",
           "specify $LOAD_PATH (may be used more than once)") do |path|
-    $LOAD_PATH.unshift(*path.split(/:/))
+    $LOAD_PATH.unshift(*path.split(':'))
   end
 
   opts.on("-r", "--require LIBRARY",

data/bin/unicorn_rails

@@ -30,7 +30,7 @@ op = OptionParser.new("", 24, '  ') do |opts|
 
   opts.on("-I", "--include PATH",
           "specify $LOAD_PATH (may be used more than once)") do |path|
-    $LOAD_PATH.unshift(*path.split(/:/))
+    $LOAD_PATH.unshift(*path.split(':'))
   end
 
   opts.on("-r", "--require LIBRARY",

data/examples/nginx.conf

@@ -1,5 +1,5 @@
 # This is example contains the bare mininum to get nginx going with
-# Unicorn or Rainbows! servers.  Generally these configuration settings
+# unicorn servers.  Generally these configuration settings
 # are applicable to other HTTP application servers (and not just Ruby
 # ones), so if you have one working well for proxying another app
 # server, feel free to continue using it.
@@ -44,8 +44,8 @@ http {
   # click tracking!
   access_log /path/to/nginx.access.log combined;
 
-  # you generally want to serve static files with nginx since neither
-  # Unicorn nor Rainbows! is optimized for it at the moment
+  # you generally want to serve static files with nginx since
+  # unicorn is not and will never be optimized for it
   sendfile on;
 
   tcp_nopush on; # off may be better for *some* Comet/long-poll stuff
@@ -67,10 +67,10 @@ http {
              text/javascript application/x-javascript
              application/atom+xml;
 
-  # this can be any application server, not just Unicorn/Rainbows!
+  # this can be any application server, not just unicorn
   upstream app_server {
     # fail_timeout=0 means we always retry an upstream even if it failed
-    # to return a good HTTP response (in case the Unicorn master nukes a
+    # to return a good HTTP response (in case the unicorn master nukes a
     # single worker for timing out).
 
     # for UNIX domain socket setups:
@@ -132,12 +132,11 @@ http {
       # redirects, we set the Host: header above already.
       proxy_redirect off;
 
-      # set "proxy_buffering off" *only* for Rainbows! when doing
-      # Comet/long-poll/streaming.  It's also safe to set if you're using
-      # only serving fast clients with Unicorn + nginx, but not slow
-      # clients.  You normally want nginx to buffer responses to slow
-      # clients, even with Rails 3.1 streaming because otherwise a slow
-      # client can become a bottleneck of Unicorn.
+      # It's also safe to set if you're using only serving fast clients
+      # with unicorn + nginx, but not slow clients.  You normally want
+      # nginx to buffer responses to slow clients, even with Rails 3.1
+      # streaming because otherwise a slow client can become a bottleneck
+      # of unicorn.
       #
       # The Rack application may also set "X-Accel-Buffering (yes|no)"
       # in the response headers do disable/enable buffering on a

data/examples/unicorn.conf.rb

@@ -40,11 +40,8 @@ pid "/path/to/app/shared/pids/unicorn.pid"
 stderr_path "/path/to/app/shared/log/unicorn.stderr.log"
 stdout_path "/path/to/app/shared/log/unicorn.stdout.log"
 
-# combine Ruby 2.0.0dev or REE with "preload_app true" for memory savings
-# http://rubyenterpriseedition.com/faq.html#adapt_apps_for_cow
+# combine Ruby 2.0.0+ with "preload_app true" for memory savings
 preload_app true
-GC.respond_to?(:copy_on_write_friendly=) and
-  GC.copy_on_write_friendly = true
 
 # Enable this flag to have unicorn test client connections by writing the
 # beginning of the HTTP headers before calling the application.  This

data/examples/unicorn.socket

@@ -0,0 +1,11 @@
+# ==> /etc/systemd/system/unicorn.socket <==
+[Unit]
+Description = unicorn sockets
+
+[Socket]
+ListenStream = 127.0.0.1:8080
+ListenStream = /tmp/path/to/.unicorn.sock
+Service = unicorn@1.service
+
+[Install]
+WantedBy = sockets.target

data/examples/unicorn@.service

@@ -0,0 +1,26 @@
+# ==> /etc/systemd/system/unicorn@.service <==
+# Since SIGUSR2 upgrades do not work under systemd, this service file
+# allows starting two simultaneous services during upgrade time
+# (e.g. unicorn@1 unicorn@2) with the intention that they take
+# turns running in-between upgrades.  This should allow upgrading
+# without downtime.
+
+[Unit]
+Description = unicorn Rack application server %i
+Wants = unicorn.socket
+After = unicorn.socket
+
+[Service]
+ExecStart = /usr/bin/unicorn -c /path/to/unicorn.conf.rb /path/to/config.ru
+Sockets = unicorn.socket
+KillSignal = SIGQUIT
+User = nobody
+Group = nogroup
+ExecReload = /bin/kill -HUP $MAINPID
+
+# This is based on the Unicorn::Configurator#timeout directive,
+# adding a few seconds for scheduling differences:
+TimeoutStopSec = 62
+
+[Install]
+WantedBy = multi-user.target

data/ext/unicorn_http/extconf.rb

@@ -5,6 +5,7 @@ have_macro("SIZEOF_OFF_T", "ruby.h") or check_sizeof("off_t", "sys/types.h")
 have_macro("SIZEOF_SIZE_T", "ruby.h") or check_sizeof("size_t", "sys/types.h")
 have_macro("SIZEOF_LONG", "ruby.h") or check_sizeof("long", "sys/types.h")
 have_func("rb_str_set_len", "ruby.h")
+have_func("rb_hash_clear", "ruby.h") # Ruby 2.0+
 have_func("gmtime_r", "time.h")
 
 create_makefile("unicorn_http")

data/ext/unicorn_http/httpdate.c

@@ -66,7 +66,7 @@ static VALUE httpdate(VALUE self)
 
 void init_unicorn_httpdate(void)
 {
-	VALUE mod = rb_const_get(rb_cObject, rb_intern("Unicorn"));
+	VALUE mod = rb_define_module("Unicorn");
 	mod = rb_define_module_under(mod, "HttpResponse");
 
 	buf = rb_str_new(0, buf_capa - 1);