yahns 1.12.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0200645323cf0450da2a840cea7660fa17470606
-  data.tar.gz: 85b6a4bb94c485538c4f9ed715985072a7409321
+  metadata.gz: 9fd3617f72db8e2c7a45a5b0273571b721c9cfad
+  data.tar.gz: 144a50bd647079d46b5e78a80b659eed0b107a8d
 SHA512:
-  metadata.gz: 5bdda8b713ed199f2ffce4bcc455f5805eb9f31143ac6bdefc87794426904e577bd7da0867097ac5e4c32434ce0c43250cadf7b0583d6c5913e907ae457e9511
-  data.tar.gz: 3bd31164da8bbb367c8db649b470c7b64edb71dfde446901923d3f63e6eef0e4d555f27b28459db9ca12a1a916dfbd7e2de3070cab335c5262f93ac32c5a19f9
+  metadata.gz: 606ab401acd65b522b5f340103f958d68ff4ff4ca3d2f7b7d563115e0b53bf9dd27a207c2581b6bc3ec0bdfad92b3a47ff1e75bec53d8d1e1223e5023e6e0f66
+  data.tar.gz: c1b03ad4decab3a575873e8925d207809ab9201c805525eaa97d5d2822eb9d797c47354220035d4ef01eadc3a2f2dd2c5faf7de8ce34d327b071c6f398fb47db

data/Documentation/GNUmakefile

@@ -6,7 +6,6 @@ INSTALL = install
 POD2MAN = pod2man
 -include ../GIT-VERSION-FILE
 release := yahns $(VERSION)
-PANDOC_OPTS = -f markdown --email-obfuscation=none
 POD2MAN_OPTS = -v -r '$(release)' --stderr -d 1994-10-02 -c 'yahns user manual'
 pod2man = $(POD2MAN) $(POD2MAN_OPTS)
 POD2TEXT = pod2text

data/Documentation/design_notes.txt

@@ -24,12 +24,12 @@ nothing but accepting sockets and injecting into to the event queue
 worker thread pool
 ------------------
 
-This is where all the interesting application dispatch happens in yahns.
-epoll(2) (or kqueue(2)) descriptor is the heart of event queue.  This
-design allows clients to migrate between different threads as they
-become active, preventing head-of-line blocking in traditional designs
-where a client is pinned to a thread (at the cost of weaker cache
-locality).
+This is where all the interesting application dispatch happens in
+yahns.  A descriptor returned by epoll_create1(2) (or kqueue(2)) is
+the heart of event queue.  This design allows clients to migrate
+between different threads as they become active, preventing
+head-of-line blocking in traditional designs where a client is
+pinned to a thread (at the cost of weaker cache locality).
 
 The critical component for implementing this thread pool is "one-shot"
 notifications in the epoll and kqueue APIs, allowing them to be used as
@@ -37,8 +37,8 @@ readiness queues for feeding the thread pool.  Used correctly, this
 allows us to guarantee exclusive access to a client socket without
 additional locks managed in userspace.
 
-Idle threads will sit performing epoll_wait (or kqueue) indefinitely
-until a socket is reported as "ready" by the kernel.
+Idle threads will sit performing epoll_wait(2) (or kevent(2))
+indefinitely until a socket is reported as "ready" by the kernel.
 
 queue flow
 ----------
@@ -46,7 +46,7 @@ queue flow
 Once a client is accept(2)-ed, it is immediately pushed into the worker
 thread pool (via EPOLL_CTL_ADD or EV_ADD).  This mimics the effect of
 TCP_DEFER_ACCEPT (in Linux) and the "dataready" accept filter (in
-FreeBSD) from the perspective of the epoll_wait(2)/kqueue(2) caller.
+FreeBSD) from the perspective of the epoll_wait(2)/kevent(2) caller.
 No explicit locking controlled from userspace is necessary.
 
 TCP_DEFER_ACCEPT/"dataready"/"httpready" themselves are not used as it
@@ -70,12 +70,13 @@ have completed processing.
 
 "Yielding" a client is accomplished by re-arming the already "ready"
 socket by using EPOLL_CTL_MOD (with EPOLLONESHOT) with a one-shot
-notification requeues the descriptor at the end of the internal epoll
-ready queue; achieving a similar effect to yielding a thread (via
-sched_yield or Thread.pass) in a purely multi-threaded design.
+notification requeues the descriptor at the end of the internal
+epoll (or kevent) ready queue; achieving a similar effect to
+yielding a thread (via sched_yield or Thread.pass) in a purely
+multi-threaded design.
 
-Once the client is yielded, epoll_wait is called again to pull
-the next client off the ready queue.
+Once the client is yielded, epoll_wait or kevent is called again to
+pull the next client off the ready queue.
 
 Output buffering notes
 ----------------------

data/Documentation/yahns_config.pod

@@ -110,7 +110,7 @@ be given without a block to associate an app block with a named
 queue.
 
 Usually, only one queue is necessary.  Each queue corresponds to
-an epoll descriptor and worker thread pool.
+an epoll or kqueue descriptor and worker thread pool.
 
 Default: NAME defaults to :default
 
@@ -161,9 +161,10 @@ Default: / if daemonized, current working directory if not
 =item max_events INTEGER
 
 This controls the number of events a worker thread will fetch at
-once via L<epoll_wait(2)>.  There is no good reason to change this
+once via L<epoll_wait(2)> or L<kevent(2)>.
+There is no good reason to change this
 unless you use very few (e.g. 1) worker_threads.  Leaving this at
-1 will give the fairest load balancing behavior with epoll.
+1 will give the fairest load balancing behavior with epoll or kqueue.
 
 Default: 1
 

data/GIT-VERSION-GEN

@@ -5,7 +5,7 @@
 CONSTANT = "Yahns::VERSION"
 RVF = "lib/yahns/version.rb"
 GVF = "GIT-VERSION-FILE"
-DEF_VER = "v1.12.0"
+DEF_VER = "v1.12.1"
 vn = DEF_VER.dup
 
 # First see if there is a version file (included in release tarballs),

data/HACKING

@@ -4,10 +4,10 @@ development dependencies
 * minitest RubyGem (version 4 or 5, standard in Ruby 2.0+)
 * curl - http://curl.haxx.se/ - we don't trust our own Ruby abilities :>
 * dd(1) - standard POSIX tool - to feed curl
-* ab - http://httpd.apache.org - for concurrent testing
+* ab - http://httpd.apache.org/ - for concurrent testing
 * GNU make - https://www.gnu.org/software/make/
 * git - http://www.git-scm.com/
-* ruby - http://www.ruby-lang.org/
+* ruby - http://www.ruby-lang.org/en/
 
 	git clone git://yhbt.net/yahns
 
@@ -32,14 +32,12 @@ V - set to 1 for verbose test output (may be mangled if multithreaded)
 documentation
 -------------
 
-We use pandoc for converting Markdown to (groff) man:
-
-* pandoc - http://johnmacfarlane.net/pandoc/
+We use pod2man(1) distributed with Perl 5 for generating manpages.
 
 installing from git
 -------------------
 
-* make install-gem (pandoc is required for generating manpages)
+* make install-gem
 
 contact
 -------
@@ -51,7 +49,7 @@ formatted using git-request-pull(1).
 
 Mailing list archives: http://yhbt.net/yahns-public/
 No subscription is necessary to post to the mailing list.
-Please remember to Cc: all recipients.
+Please remember to Cc: all recipients as subscription is optional.
 
 Copyright (C) 2013-2016 all contributors <yahns-public@yhbt.net>
 License: GPL-3.0+ <http://www.gnu.org/licenses/gpl-3.0.txt>

data/README

@@ -102,17 +102,14 @@ multiple threads.
   1. blocking acceptors
   2. non-blocking event loop workers
 * epoll (or kqueue) acts as a queue (by using one-shot notifications)
-* acceptors accept new clients and put them in the epoll "queue"
+* acceptors accept new clients and put them in the queue
 * workers pull clients off the queue, rearming them to epoll on EAGAIN
 
 The end result is clients transition freely and fairly between threads
 and will always be able to find the next idle thread to run on.
 
-This design works with kqueue, too, and we support kqueue.  In fact, got
-our design inspiration from the name "kqueue" when working on another
-project.  We may also support libkqueue:
-
-    http://sourceforge.net/projects/libkqueue/
+The design inspiration from the name "kqueue" when working on another
+project.
 
 In addition to multiple threads, yahns optionally supports multiple
 processes to work around low FD limits as well as contention in the:
@@ -125,7 +122,7 @@ processes to work around low FD limits as well as contention in the:
 Copyright
 ---------
 
-Copyright 2013-2015, all contributors (see git repo).
+Copyright 2013-2016, all contributors (see git repo).
 License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
 
 yahns is copyrighted Free Software by all contributors, see logs in

data/extras/autoindex.rb

@@ -14,13 +14,29 @@ class Autoindex
   FN = %{<a href="%s">%s</a>}
   TFMT = "%Y-%m-%d %H:%M"
 
-  def initialize(app, index = %w(index.html), skip_gzip_static = true)
+  def initialize(app, *args)
     app.respond_to?(:root) or raise ArgumentError,
-       "wrapped app #{app.inspect} does not respond to :root"
+       "wrapped app #{app.inspect} does not respond to #root"
     @app = app
     @root = app.root
-    @index = index
-    @skip_gz = skip_gzip_static
+
+    @index = case args[0]
+    when Array then args.shift
+    when String then Array(args.shift)
+    else
+      %w(index.html)
+    end
+
+    @skip_gzip_static = @skip_dotfiles = nil
+    case args[0]
+    when Hash
+      @skip_gzip_static = args[0][:skip_gzip_static]
+      @skip_dotfiles = args[0][:skip_dotfiles]
+    when true, false
+      @skip_gzip_static = args.shift
+    end
+    @skip_gzip_static = true if @skip_gzip_static.nil?
+    @skip_dotfiles = false if @skip_dotfiles.nil?
   end
 
   def redirect_slash(env)
@@ -69,13 +85,15 @@ def call(env)
       # generate the index, show directories first
       dirs = []
       files = []
-      ngz_idx = {} if @skip_gz # used to avoid redundant stat()
+      ngz_idx = {} if @skip_gzip_static # used to avoid redundant stat()
       dir.each do |base|
         case base
         when "."
           next
         when ".."
           next if path_info == "/"
+        when /\A\./
+          next if @skip_dotfiles
         end
 
         begin

data/lib/yahns/http_client.rb

@@ -206,8 +206,17 @@ def app_call(input)
       end
     end
 
+    env.merge!(k.app_defaults)
+
+    # workaround stupid unicorn_http parser behavior when it parses HTTP_HOST
+    if env['HTTPS'] == 'on'.freeze &&
+        env['HTTP_HOST'] &&
+        env['SERVER_PORT'] == '80'.freeze
+      env['SERVER_PORT'] = '443'.freeze
+    end
+
     # run the rack app
-    status, headers, body = k.app.call(env.merge!(k.app_defaults))
+    status, headers, body = k.app.call(env)
     return :ignore if app_hijacked?(env, body)
     if status.to_i == 100
       rv = http_100_response(env) and return rv

data/lib/yahns/openssl_client.rb

@@ -1,3 +1,4 @@
+# -*- encoding: binary -*-
 # Copyright (C) 2013-2016 all contributors <yahns-public@yhbt.net>
 # License: GPL-3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt)
 # frozen_string_literal: true
@@ -7,8 +8,6 @@
 # this is to be included into a Kgio::Socket-derived class
 # this requires Ruby 2.1 and later for "exception: false"
 module Yahns::OpenSSLClient # :nodoc:
-  include Yahns::SendfileCompat
-
   def self.included(cls)
     # Forward these methods to OpenSSL::SSL::SSLSocket so hijackers
     # can rely on stdlib methods instead of ugly kgio stuff that
@@ -37,15 +36,25 @@ def sync
   def yahns_init_ssl(ssl_ctx)
     @need_accept = true
     @ssl = OpenSSL::SSL::SSLSocket.new(self, ssl_ctx)
+    @ssl_blocked = nil
   end
 
   def kgio_trywrite(buf)
-    rv = @ssl.write_nonblock(buf, exception: false)
-    Integer === rv and
-      rv = buf.bytesize == rv ? nil : buf.byteslice(rv, buf.bytesize)
+    buf = @ssl_blocked = buf.dup
+    case rv = @ssl.write_nonblock(buf, exception: false)
+    when :wait_readable, :wait_writable
+      return rv # do not clear ssl_blocked
+    when Integer
+      rv = buf.bytesize == rv ? nil : buf.byteslice(rv, buf.bytesize - rv)
+    end
+    @ssl_blocked = nil
     rv
   end
 
+  def kgio_trywritev(buf)
+    kgio_trywrite(buf.join)
+  end
+
   def kgio_syssend(buf, flags)
     kgio_trywrite(buf)
   end
@@ -63,6 +72,27 @@ def kgio_tryread(len, buf)
     @ssl.read_nonblock(len, buf, exception: false)
   end
 
+  def trysendfile(io, offset, count)
+    return 0 if count == 0
+
+    unless buf = @ssl_blocked
+      count = 0x4000 if count > 0x4000
+      buf = Thread.current[:yahns_sfbuf] ||= ''.dup
+      io.pos = offset
+      buf = io.read(count, buf) or return # nil for EOF
+      buf = @ssl_blocked = buf.dup
+    end
+
+    # call write_nonblock directly since kgio_trywrite allocates
+    # an unnecessary string
+    case rv = @ssl.write_nonblock(buf, exception: false)
+    when :wait_readable, :wait_writable
+      return rv # do not clear ssl_blocked
+    end
+    @ssl_blocked = nil
+    rv
+  end
+
   def close
     @ssl.close # flushes SSLSocket
     super # IO#close

data/test/test_ssl.rb

@@ -71,7 +71,7 @@ def test_ssl_basic
       cfg.instance_eval do
         ru = lambda do |env|
           case path_info = env['PATH_INFO']
-          when '/rack.url_scheme', '/HTTPS'
+          when '/rack.url_scheme', '/HTTPS', '/SERVER_PORT'
             s = env[path_info[1..-1]] # remove leading slash
             s = s.inspect if s.nil?
             [ 200, {
@@ -100,7 +100,8 @@ def test_ssl_basic
     buf = ''.dup
     { '/' => 'HI',
       '/rack.url_scheme' => 'https',
-      '/HTTPS' => 'on'
+      '/HTTPS' => 'on',
+      '/SERVER_PORT' => '443',
     }.each do |path, exp|
       client.write("GET #{path} HTTP/1.1\r\nHost: example.com\r\n\r\n")
       buf.clear
@@ -113,11 +114,25 @@ def test_ssl_basic
       assert_match %r{\AHTTP/1\.\d 200 OK\r\n}, head
     end
 
+    # use port in Host: header (implemented by unicorn_http parser)
+    exp = '666'
+    client.write("GET /SERVER_PORT HTTP/1.1\r\nHost: example.com:#{exp}\r\n\r\n")
+    re = /#{Regexp.escape(exp)}\z/
+    buf.clear
+    Timeout.timeout(60) do
+      buf << client.readpartial(111) until buf =~ re
+    end
+    head, body = buf.split("\r\n\r\n", 2)
+    assert_equal exp, body
+    assert_match %r{\AHTTP/1\.\d 200 OK\r\n}, head
+
     Net::HTTP.start(insecure.addr[3], insecure.addr[1]) do |h|
       res = h.get('/rack.url_scheme')
       assert_equal 'http', res.body
       res = h.get('/HTTPS')
       assert_equal 'nil', res.body
+      res = h.get('/SERVER_PORT')
+      assert_equal insecure.addr[1].to_s, res.body
     end
 
     # read static file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yahns
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.12.1
 platform: ruby
 authors:
 - yahns hackers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-14 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio