unicorn 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75575863e5a09d4ac351269084628052c8ec554c
-  data.tar.gz: 5f7fc37e895b8982c3076fc56642ec90d8632d46
+  metadata.gz: b81793b7bf9db70d6d014404f3d109cbe8528951
+  data.tar.gz: 80747270f849455aa5f6df45bd720452b366a681
 SHA512:
-  metadata.gz: 85c7d9f5d6c3056508758a7375809d477ee7e640167470711e4fda53e7f6c52ea6688e708fde80af5e54262dcdd218c0ef9fc966221c1e30762b0bdabf5c41fb
-  data.tar.gz: 1829ab9e474b1932617c97e37d6efa1075c1c147f8aa726777478741b5ae9106a163194647e03ff8d73786017dd2142afad8804d16625fde48876e10dc0e3a30
+  metadata.gz: 42b0045616f1243a945a24bf2c4f46f587655ecd24669f5c59b98aa25bef2e6b4a1ff47d580d41a9ad76f2490b09d5433229135cec52c7b7e2293c3086399949
+  data.tar.gz: 9bb45e6d41a3d1a8888b64f127269e67d3101f1ba0d637723820f5a881cc2754e3defcf83e9c98d41f4f25a3a95837be6cbef0538128717aac189ecac6fc9c5a

data/.manifest

@@ -140,6 +140,7 @@ test/benchmark/stack.ru
 test/exec/README
 test/exec/test_exec.rb
 test/test_helper.rb
+test/unit/test_ccc.rb
 test/unit/test_configurator.rb
 test/unit/test_droplet.rb
 test/unit/test_http_parser.rb

data/.olddoc.yml

@@ -12,7 +12,6 @@ noindex:
 - TODO
 - unicorn_rails_1
 public_email: unicorn-public@bogomips.org
-private_email: unicorn@bogomips.org
 nntp_url:
   - nntp://news.public-inbox.org/inbox.comp.lang.ruby.unicorn
   - nntp://news.gmane.org/gmane.comp.lang.ruby.unicorn.general

data/GIT-VERSION-FILE

@@ -1 +1 @@
-GIT_VERSION = 5.2.0
+GIT_VERSION = 5.3.0

data/GIT-VERSION-GEN

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-DEF_VER = "v5.2.0"
+DEF_VER = "v5.3.0"
 CONSTANT = "Unicorn::Const::UNICORN_VERSION"
 RVF = "lib/unicorn/version.rb"
 GVF = "GIT-VERSION-FILE"

data/HACKING

@@ -104,7 +104,6 @@ don't email the git mailing list or maintainer with Unicorn patches :)
 
 In order to build the gem, you must install the following components:
 
- * olddoc (RubyGem)
  * pandoc
 
 You can build the Unicorn gem with the following command:

data/ISSUES

@@ -9,14 +9,16 @@ submit patches and/or obtain support after you have searched the
 * Cc: all participants in a thread or commit, as subscription is optional
 * Do not {top post}[http://catb.org/jargon/html/T/top-post.html] in replies
 * Quote as little as possible of the message you're replying to
-* Do not send HTML mail or images, it will be flagged as spam
-* Anonymous and pseudonymous messages will always be welcome.
+* Do not send HTML mail or images,
+  they hurt reader privacy and will be flagged as spam
+* Anonymous and pseudonymous messages will ALWAYS be welcome
 * The email submission port (587) is enabled on the bogomips.org MX:
   https://bogomips.org/unicorn-public/20141004232241.GA23908@dcvr.yhbt.net/t/
 
 If your issue is of a sensitive nature or you're just shy in public,
-then feel free to email us privately at mailto:unicorn@bogomips.org
-instead and your issue will be handled discreetly.
+use anonymity tools such as Tor or Mixmaster; and rely on the public
+mail archives for responses.  Be sure to scrub sensitive log messages
+and such.
 
 If you don't get a response within a few days, we may have forgotten
 about it so feel free to ask again.
@@ -64,14 +66,14 @@ document distributed with git) on guidelines for patch submission.
 == Contact Info
 
 * public: mailto:unicorn-public@bogomips.org
-* private: mailto:unicorn@bogomips.org
 * nntp://news.gmane.org/gmane.comp.lang.ruby.unicorn.general
 * nntp://news.public-inbox.org/inbox.comp.lang.ruby.unicorn
 * https://bogomips.org/unicorn-public/
+* http://ou63pmih66umazou.onion/unicorn-public/
 
 Mailing list subscription is optional, so Cc: all participants.
 
-You can follow along via NNTP:
+You can follow along via NNTP (read-only):
 
 	nntp://news.public-inbox.org/inbox.comp.lang.ruby.unicorn
 	nntp://news.gmane.org/gmane.comp.lang.ruby.unicorn.general
@@ -79,6 +81,7 @@ You can follow along via NNTP:
 Or Atom feeds:
 
 	https://bogomips.org/unicorn-public/new.atom
+	http://ou63pmih66umazou.onion/unicorn-public/new.atom
 
 	The HTML archives at https://bogomips.org/unicorn-public/
 	also has links to per-thread Atom feeds and downloadable
@@ -88,3 +91,6 @@ You may optionally subscribe via plain-text email:
 
 	mailto:unicorn-public+subscribe@bogomips.org
 	(and confirming the auto-reply)
+
+Just keep in mind we suck at delivering email, so using NNTP,
+or Atom feeds might be a better bet...

data/LATEST

@@ -1,37 +1,83 @@
-=== unicorn 5.1.0 - rack is optional, again / 2016-04-01 00:35 UTC
+=== unicorn 5.3.0.pre1 / 2017-03-24 00:25 UTC
 
-  Note: no code changes since 5.1.0.pre1 from January.^WNo, wait,
-  last minute performance improvement added today.  See below.
+  A largish release with several new features.
 
-  The big change is rack is not required (but still recommended).
-  Applications are expected to depend on rack on their own so they can
-  specify the version of rack they prefer without unicorn pulling
-  in a newer, potentially incompatible version.
+  Simon Eskildsen contributed heavily using TCP_INFO under Linux
+  to implement the (now 5 year old) check_client_connection feature:
 
-  unicorn will always attempt to work with multiple versions of rack
-  as practical.
+    https://bogomips.org/unicorn/Unicorn/Configurator.html#method-i-check_client_connection
+    https://bogomips.org/unicorn-public/?q=s:check_client_connection&d:..20170324&x=t
 
-  The HTTP parser also switched to using the TypedData C-API for
-  extra type safety and memory usage accounting support in the
-  'objspace' extension.
+  This also led to FreeBSD and OpenBSD portability improvements in
+  one of our dependencies, raindrops:
 
-  Thanks to Adam Duke to bringing the rack change to our attention
-  and Aaron Patterson for helping with the matter.
+     https://bogomips.org/raindrops-public/20170323024829.GA5190@dcvr/T/#u
 
-  Last minute change: we now support the new leftpad() syscall under
-  Linux for major performance and security improvement:
+  Jeremy Evans contributed several new features.  First he
+  implemented after_worker_exit to aid debugging:
 
-      http://mid.gmane.org/1459463613-32473-1-git-send-email-richard@nod.at
+    https://bogomips.org/unicorn/Unicorn/Configurator.html#method-i-after_worker_exit
+    https://bogomips.org/unicorn-public/?q=s:after_worker_exit&d:..20170324&x=t#t
 
-  8^H9 changes since 5.0.1:
+  And then security-related features to isolate workers.  Workers
+  may now chroot to drop access to the master filesystem, and the
+  new after_worker_ready configuration hook now exists to aid with
+  chroot support in workers:
 
-        http: TypedData C-API conversion
-        various documentation updates
-        doc: bump olddoc to ~> 1.2 for extra NNTP URL
-        rack is optional at runtime, required for dev
-        doc update for ClientShutdown exceptions class
-        unicorn 5.1.0.pre1 - rack is optional, again
-        doc: reference --keep-file-descriptors for "bundle exec"
-        doc: further trimming to reduce noise
-        use leftpad Linux syscall for speed!
+    https://bogomips.org/unicorn/Unicorn/Configurator.html#method-i-after_worker_ready
+    https://bogomips.org/unicorn/Unicorn/Worker.html#method-i-user
+    https://bogomips.org/unicorn-public/?q=s:after_worker_ready&d:..20170324&x=t#t
+    https://bogomips.org/unicorn-public/?q=s:chroot&d:..20170324&x=t#t
+
+  Additionally, workers may run in a completely different VM space
+  (nullifying preload_app and any CoW savings) with the new
+  worker_exec option:
+
+    https://bogomips.org/unicorn/Unicorn/Configurator.html#method-i-worker_exec
+    https://bogomips.org/unicorn-public/?q=s:worker_exec&d:..20170324&x=t#t
+
+  There are also several improvements to FreeBSD and OpenBSD
+  support with the addition of these features.
+
+  34 changes since 5.2.0 (2016-10-31):
+
+  Eric Wong (27):
+        drop rb_str_set_len compatibility replacement
+        TUNING: document THP caveat for Linux users
+        tee_input: simplify condition for IO#write
+        remove response_start_sent
+        http_request: freeze constant strings passed IO#write
+        Revert "remove response_start_sent"
+        t/t0012-reload-empty-config.sh: access ivars directly if needed
+        t0011-active-unix-socket.sh: fix race condition in test
+        new test for check_client_connection
+        revert signature change to HttpServer#process_client
+        support "struct tcp_info" on non-Linux and Ruby 2.2+
+        unicorn_http: reduce rb_global_variable calls
+        oob_gc: rely on opt_aref_with optimization on Ruby 2.2+
+        http_request: reduce insn size for check_client_connection
+        freebsd: avoid EINVAL when setting accept filter
+        test-lib: expr(1) portability fix
+        tests: keep disabled tests defined
+        test_exec: SO_KEEPALIVE value only needs to be true
+        doc: fix links to raindrops project
+        http_request: support proposed Raindrops::TCP states on non-Linux
+        ISSUES: expand on mail archive info + subscription disclaimer
+        test_ccc: use a pipe to synchronize test
+        doc: remove private email support address
+        input: update documentation and hide internals.
+        http_server: initialize @pid ivar
+        gemspec: remove olddoc from build dependency
+        doc: add version annotations for new features
+
+  Jeremy Evans (6):
+        Add after_worker_exit configuration option
+        Fix code example in after_worker_exit documentation
+        Add support for chroot to Worker#user
+        Add after_worker_ready configuration option
+        Add worker_exec configuration option
+        Don't pass a block for fork when forking workers
+
+  Simon Eskildsen (1):
+        check_client_connection: use tcp state on linux
 

data/Links

@@ -23,7 +23,7 @@ or services behind them.
 * {golden_brindle}[https://github.com/simonoff/golden_brindle] - tool to
   manage multiple unicorn instances/applications on a single server
 
-* {raindrops}[http://raindrops.bogomips.org/] - real-time stats for
+* {raindrops}[https://bogomips.org/raindrops/] - real-time stats for
   preforking Rack servers
 
 * {UnXF}[https://bogomips.org/unxf/]  Un-X-Forward* the Rack environment,

data/NEWS

@@ -1,3 +1,116 @@
+=== unicorn 5.3.0.pre1 / 2017-03-24 00:25 UTC
+
+  A largish release with several new features.
+
+  Simon Eskildsen contributed heavily using TCP_INFO under Linux
+  to implement the (now 5 year old) check_client_connection feature:
+
+    https://bogomips.org/unicorn/Unicorn/Configurator.html#method-i-check_client_connection
+    https://bogomips.org/unicorn-public/?q=s:check_client_connection&d:..20170324&x=t
+
+  This also led to FreeBSD and OpenBSD portability improvements in
+  one of our dependencies, raindrops:
+
+     https://bogomips.org/raindrops-public/20170323024829.GA5190@dcvr/T/#u
+
+  Jeremy Evans contributed several new features.  First he
+  implemented after_worker_exit to aid debugging:
+
+    https://bogomips.org/unicorn/Unicorn/Configurator.html#method-i-after_worker_exit
+    https://bogomips.org/unicorn-public/?q=s:after_worker_exit&d:..20170324&x=t#t
+
+  And then security-related features to isolate workers.  Workers
+  may now chroot to drop access to the master filesystem, and the
+  new after_worker_ready configuration hook now exists to aid with
+  chroot support in workers:
+
+    https://bogomips.org/unicorn/Unicorn/Configurator.html#method-i-after_worker_ready
+    https://bogomips.org/unicorn/Unicorn/Worker.html#method-i-user
+    https://bogomips.org/unicorn-public/?q=s:after_worker_ready&d:..20170324&x=t#t
+    https://bogomips.org/unicorn-public/?q=s:chroot&d:..20170324&x=t#t
+
+  Additionally, workers may run in a completely different VM space
+  (nullifying preload_app and any CoW savings) with the new
+  worker_exec option:
+
+    https://bogomips.org/unicorn/Unicorn/Configurator.html#method-i-worker_exec
+    https://bogomips.org/unicorn-public/?q=s:worker_exec&d:..20170324&x=t#t
+
+  There are also several improvements to FreeBSD and OpenBSD
+  support with the addition of these features.
+
+  34 changes since 5.2.0 (2016-10-31):
+
+  Eric Wong (27):
+        drop rb_str_set_len compatibility replacement
+        TUNING: document THP caveat for Linux users
+        tee_input: simplify condition for IO#write
+        remove response_start_sent
+        http_request: freeze constant strings passed IO#write
+        Revert "remove response_start_sent"
+        t/t0012-reload-empty-config.sh: access ivars directly if needed
+        t0011-active-unix-socket.sh: fix race condition in test
+        new test for check_client_connection
+        revert signature change to HttpServer#process_client
+        support "struct tcp_info" on non-Linux and Ruby 2.2+
+        unicorn_http: reduce rb_global_variable calls
+        oob_gc: rely on opt_aref_with optimization on Ruby 2.2+
+        http_request: reduce insn size for check_client_connection
+        freebsd: avoid EINVAL when setting accept filter
+        test-lib: expr(1) portability fix
+        tests: keep disabled tests defined
+        test_exec: SO_KEEPALIVE value only needs to be true
+        doc: fix links to raindrops project
+        http_request: support proposed Raindrops::TCP states on non-Linux
+        ISSUES: expand on mail archive info + subscription disclaimer
+        test_ccc: use a pipe to synchronize test
+        doc: remove private email support address
+        input: update documentation and hide internals.
+        http_server: initialize @pid ivar
+        gemspec: remove olddoc from build dependency
+        doc: add version annotations for new features
+
+  Jeremy Evans (6):
+        Add after_worker_exit configuration option
+        Fix code example in after_worker_exit documentation
+        Add support for chroot to Worker#user
+        Add after_worker_ready configuration option
+        Add worker_exec configuration option
+        Don't pass a block for fork when forking workers
+
+  Simon Eskildsen (1):
+        check_client_connection: use tcp state on linux
+
+=== unicorn 5.2.0 / 2016-10-31 20:00 UTC
+
+  Most notably, this release allows us to support requests with
+  lines delimited by LF-only, as opposed to the standard CRLF
+  pair and allowed by RFC 2616 sec 19.3.
+
+  Thanks to Mishael A Sibiryakov for the explanation and change:
+
+    https://bogomips.org/unicorn-public/1476954332.1736.156.camel@junki.org/
+
+  Thanks to Let's Encrypt, the website also moves to HTTPS
+  <https://bogomips.org/unicorn/> to improve reader privacy.  The
+  "unicorn.bogomips.org" subdomain will be retired soon to reduce
+  subjectAltName bloat and speed up certificate renewals.
+
+  There's also the usual round of documentation and example
+  updates, too.
+
+  Eric Wong (7):
+        examples/init.sh: update to reduce upgrade raciness
+        doc: systemd should only kill master in example
+        examples/logrotate.conf: update example for systemd
+        doc: update gmane URLs to point to our own archives
+        relocate website to https://bogomips.org/unicorn/
+        TODO: remove Rack 2.x item
+        build: "install-gem" target avoids network
+
+  Mishael A Sibiryakov (1):
+        Add some tolerance (RFC2616 sec. 19.3)
+
 === unicorn 5.1.0 - rack is optional, again / 2016-04-01 00:35 UTC
 
   Note: no code changes since 5.1.0.pre1 from January.^WNo, wait,

data/TUNING

@@ -72,10 +72,28 @@ See Unicorn::Configurator for details on the config file format.
   have them unbuffered (File#sync = true) or they are
   record(line)-buffered in userspace before any writes.
 
-== Kernel Parameters (Linux sysctl)
+== Kernel Parameters (Linux sysctl and sysfs)
 
 WARNING: Do not change system parameters unless you know what you're doing!
 
+* Transparent hugepages (THP) improves performance in many cases,
+  but can also increase memory use when relying on a
+  copy-on-write(CoW)-friendly GC (Ruby 2.0+) with "preload_app true".
+  CoW operates at the page level, so writing to a huge page would
+  trigger a 2 MB copy (x86-64), as opposed to a 4 KB copy on a
+  regular (non-huge) page.
+
+  Consider only allowing THP to be used when it is requested via the
+  madvise(2) syscall:
+
+	echo madvise >/sys/kernel/mm/transparent_hugepage/enabled
+
+  Or disabling it system-wide, via "never".
+
+  n.b. "page" in this context only applies to the OS kernel,
+  Ruby GC implementations also use this term for the same concept
+  in a way that is agnostic to the OS.
+
 * net.core.rmem_max and net.core.wmem_max can increase the allowed
   size of :rcvbuf and :sndbuf respectively. This is mostly only useful
   for UNIX domain sockets which do not have auto-tuning buffer sizes.

data/ext/unicorn_http/common_field_optimization.h

@@ -60,7 +60,7 @@ static struct common_field common_http_fields[] = {
 #define HTTP_PREFIX_LEN (sizeof(HTTP_PREFIX) - 1)
 
 /* this function is not performance-critical, called only at load time */
-static void init_common_fields(void)
+static void init_common_fields(VALUE mark_ary)
 {
   int i;
   struct common_field *cf = common_http_fields;
@@ -77,7 +77,7 @@ static void init_common_fields(void)
       cf->value = rb_str_new(tmp, HTTP_PREFIX_LEN + cf->len);
     }
     cf->value = rb_obj_freeze(cf->value);
-    rb_global_variable(&cf->value);
+    rb_ary_push(mark_ary, cf->value);
   }
 }
 

data/ext/unicorn_http/ext_help.h

@@ -1,26 +1,6 @@
 #ifndef ext_help_h
 #define ext_help_h
 
-#ifndef RSTRING_PTR
-#define RSTRING_PTR(s) (RSTRING(s)->ptr)
-#endif /* !defined(RSTRING_PTR) */
-#ifndef RSTRING_LEN
-#define RSTRING_LEN(s) (RSTRING(s)->len)
-#endif /* !defined(RSTRING_LEN) */
-
-#ifndef HAVE_RB_STR_SET_LEN
-#  ifdef RUBINIUS
-#    error we should never get here with current Rubinius (1.x)
-#  endif
-/* this is taken from Ruby 1.8.7, 1.8.6 may not have it */
-static void rb_18_str_set_len(VALUE str, long len)
-{
-  RSTRING(str)->len = len;
-  RSTRING(str)->ptr[len] = '\0';
-}
-#  define rb_str_set_len(str,len) rb_18_str_set_len(str,len)
-#endif /* !defined(HAVE_RB_STR_SET_LEN) */
-
 /* not all Ruby implementations support frozen objects (Rubinius does not) */
 #if defined(OBJ_FROZEN)
 #  define assert_frozen(f) assert(OBJ_FROZEN(f) && "unfrozen object")

data/ext/unicorn_http/extconf.rb

@@ -4,7 +4,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_str_set_len", "ruby.h") or abort 'Ruby 1.9.3+ required'
 have_func("rb_hash_clear", "ruby.h") # Ruby 2.0+
 have_func("gmtime_r", "time.h")
 

data/ext/unicorn_http/global_variables.h

@@ -56,7 +56,7 @@ NORETURN(static void parser_raise(VALUE klass, const char *));
 /** Defines global strings in the init method. */
 #define DEF_GLOBAL(N, val) do { \
   g_##N = rb_obj_freeze(rb_str_new(val, sizeof(val) - 1)); \
-  rb_global_variable(&g_##N); \
+  rb_ary_push(mark_ary, g_##N); \
 } while (0)
 
 /* Defines the maximum allowed lengths for various input elements.*/
@@ -67,7 +67,7 @@ DEF_MAX_LENGTH(FRAGMENT, 1024); /* Don't know if this length is specified somewh
 DEF_MAX_LENGTH(REQUEST_PATH, 4096); /* common PATH_MAX on modern systems */
 DEF_MAX_LENGTH(QUERY_STRING, (1024 * 10));
 
-static void init_globals(void)
+static void init_globals(VALUE mark_ary)
 {
   DEF_GLOBAL(rack_url_scheme, "rack.url_scheme");
   DEF_GLOBAL(request_method, "REQUEST_METHOD");