yahns 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33525c7e184e8f29a1667fb401ce20bcda42f30e
-  data.tar.gz: 13d18fdee5cfbd47bb3d83046c5e388e06c08495
+  metadata.gz: 0a9749686719fc4ebab52f18c57c3c3b9cf00ab8
+  data.tar.gz: 82df4e6686e4ee97cad0462fb1d0c809d19f9a10
 SHA512:
-  metadata.gz: c1cdd01498c6a8719efa5e246783ca00fd7dd2c31caaf4e7a345cbd3716f67ab962ecd1dd3c39819cc74cb4e58900fa08c6497554dfeefb1152c7cabf89d1b40
-  data.tar.gz: 3b087200a116d46b7b7c4ebfc5e2c58f7315ff53c19ff02414b289258f43d40e0ecd79348ba96731bbd081d1bea6cd04695aeb18d0cfbcef96ec359db782600d
+  metadata.gz: f5f385fabee64576cadcea538d77065ec625e50ee6c9c40ebba09d662995f6ad9c1740a422ee219078c1f1a7c7198120927625d08632b5d16d6f96dfd8039fb3
+  data.tar.gz: 12080fba5d268e326f648da62708ec2927063b2de470a3590be6d55d21968ea5150e94d8b18165dba22ca9388fbb535c9f5180039926a75df372d4f602d60c76

data/GIT-VERSION-FILE

@@ -1 +1 @@
-VERSION = 1.0.0
+VERSION = 1.1.0

data/GIT-VERSION-GEN

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

data/NEWS

@@ -1,3 +1,23 @@
+yahns 1.1.0 - MOAR SLEEPY / 2014-02-04
+--------------------------------------
+
+On responses with a known, non-zero Content-Length, yahns will now
+automatically use the MSG_MORE flag when sending HTTP headers.  This
+reduces TCP packet transmits and allows clients to wake up and read
+one less time.
+
+This is similar to the TCP_NOPUSH/TCP_CORK functionality of other
+servers, but requires no additional syscalls.  It is only supported
+on the Linux kernel, however (but yahns is currently epoll-only
+with kqueue support on the horizon).
+
+Eric Wong (5):
+      quiet down EHOSTUNREACH errors
+      http_response: use kgio_syssend with MSG_MORE
+      load yahns/version file
+      socket_helper: remove SO_REUSEPORT define for untested arches
+      response: do not use MSG_MORE on empty bodies
+
 yahns 1.0.0 / 2014-01-02
 ------------------------
 

data/lib/yahns/http_client.rb

@@ -270,7 +270,7 @@ class Yahns::HttpClient < Kgio::Socket # :nodoc:
   def handle_error(e)
     code = case e
     when EOFError,Errno::ECONNRESET,Errno::EPIPE,Errno::ENOTCONN,
-         Errno::ETIMEDOUT
+         Errno::ETIMEDOUT,Errno::EHOSTUNREACH
       return # don't send response, drop the connection
     when Yahns::ClientTimeout
       408

data/lib/yahns/http_response.rb

@@ -31,6 +31,22 @@ module Yahns::HttpResponse # :nodoc:
   R100_RAW = "HTTP/1.1 100 Continue\r\n\r\n"
   R100_CCC = "100 Continue\r\n\r\nHTTP/1.1 "
   HTTP_EXPECT = "HTTP_EXPECT"
+  REQUEST_METHOD = "REQUEST_METHOD"
+  HEAD = "HEAD"
+
+  # no point in using one without the other, these have been in Linux
+  # for ages
+  if Socket.const_defined?(:MSG_MORE) && Socket.const_defined?(:MSG_DONTWAIT)
+    MSG_MORE = Socket::MSG_MORE
+    MSG_DONTWAIT = Socket::MSG_DONTWAIT
+  else
+    MSG_MORE = 0
+    MSG_DONTWAIT = 0
+
+    def kgio_syssend(buf, flags)
+      kgio_trywrite(buf)
+    end
+  end
 
   def response_start
     @response_start_sent ? Z : RESPONSE_START
@@ -109,6 +125,10 @@ module Yahns::HttpResponse # :nodoc:
     end
   end
 
+  def have_more?(value)
+    value.to_i > 0 && @hs.env[REQUEST_METHOD] != HEAD
+  end
+
   # writes the rack_response to socket as an HTTP response
   # returns :wait_readable, :wait_writable, :forget, or nil
   def http_response_write(status, headers, body)
@@ -117,6 +137,7 @@ module Yahns::HttpResponse # :nodoc:
     count = hijack = nil
     k = self.class
     alive = @hs.next? && k.persistent_connections
+    flags = MSG_DONTWAIT
 
     if @hs.headers?
       buf = "#{response_start}#{status}\r\nDate: #{httpdate}\r\n"
@@ -133,6 +154,9 @@ module Yahns::HttpResponse # :nodoc:
         when %r{\AConnection\z}i
           # allow Rack apps to tell us they want to drop the client
           alive = false if value =~ /\bclose\b/i
+        when %r{\AContent-Length\z}i
+          flags |= MSG_MORE if have_more?(value)
+          buf << kv_str(key, value)
         when "rack.hijack"
           hijack = value
           body = nil # ensure we do not close body
@@ -141,10 +165,11 @@ module Yahns::HttpResponse # :nodoc:
         end
       end
       buf << (alive ? CONN_KA : CONN_CLOSE)
-      case rv = kgio_trywrite(buf)
+      case rv = kgio_syssend(buf, flags)
       when nil # all done, likely
         break
       when String
+        flags = MSG_DONTWAIT
         buf = rv # hope the skb grows
       when :wait_writable, :wait_readable
         if k.output_buffering

data/lib/yahns/socket_helper.rb

@@ -9,11 +9,7 @@ module Yahns::SocketHelper # :nodoc:
     if defined?(Socket::SO_REUSEPORT)
       Socket::SO_REUSEPORT
     elsif RUBY_PLATFORM =~ /linux/
-      if RUBY_PLATFORM =~ /(?:alpha|mips|parisc|sparc)/
-        0x0200 # untested
-      else
-        15 # only tested on x86_64 and i686
-      end
+      15 # only tested on x86_64 and i686
     else
       nil
     end

data/lib/yahns/version.rb

@@ -1 +1 @@
-Yahns::VERSION = '1.0.0' # :nodoc:
+Yahns::VERSION = '1.1.0' # :nodoc:

data/lib/yahns.rb

@@ -74,3 +74,4 @@ require_relative 'yahns/server'
 require_relative 'yahns/fdmap'
 require_relative 'yahns/acceptor'
 require_relative 'yahns/wbuf'
+require_relative 'yahns/version'

data/man/yahns-rackup.1

@@ -12,42 +12,45 @@ It is expected to start in your application root (APP_ROOT).
 .SH RACKUP FILE
 .PP
 This defaults to "config.ru" in APP_ROOT.
-It should be the same file used by rackup(1) and other Rack launchers,
-it uses the \f[I]Rack::Builder\f[] DSL.
+It should be the same file used by rackup(1) and other Rack
+launchers, it uses the \f[I]Rack::Builder\f[] DSL.
 .SH YAHNS OPTIONS
 .TP
 .B -O client_timeout=SECONDS
 Defines the timeout expiring idle connections.
 .RS
 .PP
-Increase this if your application takes longer to run than the default
-timeout.
+Increase this if your application takes longer to run than the
+default timeout.
 Lower this if you run out of FDs.
 .PP
 Default: 15 (seconds)
 .RE
 .TP
-.B -O listen=ADDRESS[,ADDRESS...]
+.B -O listen=ADDRESS[,ADDRESS\&...]
 Listens on a given ADDRESS.
-ADDRESS may be in the form of HOST:PORT or PATH, HOST:PORT is taken to
-mean a TCP socket and PATH is meant to be a path to a UNIX domain
-socket.
-Defaults to "0.0.0.0:9292" (all addresses on TCP port 9292).
+ADDRESS may be in the form of HOST:PORT or PATH, HOST:PORT is taken
+to mean a TCP socket and PATH is meant to be a path to a UNIX
+domain socket.
+Defaults to \[lq]0.0.0.0:9292\[rq] (all addresses on TCP port
+9292).
 Multiple addresses may be separated with commas.
 .RS
 .RE
 .TP
 .B -O stderr_path=PATHNAME
 Allow redirecting $stderr to a given path.
-Unlike doing this from the shell, this allows the yahns process to know
-the path its writing to and rotate the file if it is used for logging.
-The file will be opened with the O_APPEND flag and writes synchronized
-to the kernel (but not necessarily to \f[I]disk\f[]) so multiple
-processes can safely append to it.
+Unlike doing this from the shell, this allows the yahns process to
+know the path its writing to and rotate the file if it is used for
+logging.
+The file will be opened with the O_APPEND flag and writes
+synchronized to the kernel (but not necessarily to \f[I]disk\f[])
+so multiple processes can safely append to it.
 .RS
 .PP
-If you are daemonizing and using the default logger, it is important to
-specify this as errors will otherwise be lost to /dev/null.
+If you are daemonizing and using the default logger, it is
+important to specify this as errors will otherwise be lost to
+/dev/null.
 Some applications/libraries may also triggering warnings that go to
 stderr, and they will end up here.
 .PP
@@ -56,8 +59,8 @@ Default: /dev/null if daemonized, controlling terminal if not
 .TP
 .B -O stdout_path=PATH
 Same as stderr_path, except for $stdout.
-Not many applications write to $stdout, but any that do will have their
-output written here.
+Not many applications write to $stdout, but any that do will have
+their output written here.
 It is safe to point this to the same location a stderr_path.
 Like stderr_path, this defaults to /dev/null when daemonized.
 .RS
@@ -68,9 +71,11 @@ Default: /dev/null if daemonized, controlling terminal if not
 .B -O worker_threads=INTEGER
 This controls the number of threads for application processing.
 Each queue has its own thread pool.
-Increase this number if your applications are able to use more threads
-effectively or if either (or both) input/output buffering are disabled.
-Lower this number if you do not need multi-thread concurrency at all.
+Increase this number if your applications are able to use more
+threads effectively or if either (or both) input/output buffering
+are disabled.
+Lower this number if you do not need multi-thread concurrency at
+all.
 .RS
 .PP
 Default: 7
@@ -81,8 +86,8 @@ Default: 7
 Run daemonized in the background.
 The process is detached from the controlling terminal and stdin is
 redirected to /dev/null.
-Unless specified via stderr_path and stdout_path, stderr and stdout will
-also be redirected to "/dev/null".
+Unless specified via stderr_path and stdout_path, stderr and stdout
+will also be redirected to \[lq]/dev/null\[rq].
 .RS
 .RE
 .TP
@@ -93,28 +98,31 @@ See the RACK ENVIRONMENT section for more details.
 .RE
 .TP
 .B -o, --host HOST
-Listen on a TCP socket belonging to HOST, default is "0.0.0.0" (all
-addresses).
-If specified multiple times on the command-line, only the last-specified
-value takes effect.
-This option only exists for compatibility with the rackup(1) command,
-use of "-l"/"--listen" switch is recommended instead.
+Listen on a TCP socket belonging to HOST, default is
+\[lq]0.0.0.0\[rq] (all addresses).
+If specified multiple times on the command-line, only the
+last-specified value takes effect.
+This option only exists for compatibility with the rackup(1)
+command, use of \[lq]-l\[rq]/\[lq]--listen\[rq] switch is
+recommended instead.
 .RS
 .RE
 .TP
 .B -p, --port PORT
 Listen on the specified TCP PORT, default is 9292.
-If specified multiple times on the command-line, only the last-specified
-value takes effect.
-This option only exists for compatibility with the rackup(1) command,
-use of "-l"/"--listen" switch is recommended instead.
+If specified multiple times on the command-line, only the
+last-specified value takes effect.
+This option only exists for compatibility with the rackup(1)
+command, use of \[lq]-l\[rq]/\[lq]--listen\[rq] switch is
+recommended instead.
 .RS
 .RE
 .SH RUBY OPTIONS
 .TP
 .B -e, --eval LINE
 Evaluate a LINE of Ruby code.
-This evaluation happens immediately as the command-line is being parsed.
+This evaluation happens immediately as the command-line is being
+parsed.
 .RS
 .RE
 .TP
@@ -131,17 +139,18 @@ Turn on verbose warnings, the $VERBOSE variable is set to true.
 .B -I, --include PATH
 specify $LOAD_PATH.
 PATH will be prepended to $LOAD_PATH.
-The \[aq]:\[aq] character may be used to delimit multiple directories.
+The \[aq]:\[aq] character may be used to delimit multiple
+directories.
 This directive may be used more than once.
-Modifications to $LOAD_PATH take place immediately and in the order they
-were specified on the command-line.
+Modifications to $LOAD_PATH take place immediately and in the order
+they were specified on the command-line.
 .RS
 .RE
 .TP
 .B -r, --require LIBRARY
 require a specified LIBRARY before executing the application.
-The "require" statement will be executed immediately and in the order
-they were specified on the command-line.
+The "require" statement will be executed immediately and in the
+order they were specified on the command-line.
 .RS
 .RE
 .SH SIGNALS
@@ -157,18 +166,22 @@ If RACK_ENV is already set, it will be used unless -E is used.
 See rackup documentation for more details.
 .SH CONTACT
 .PP
-All feedback welcome via plain-text mail to <yahns-public@rubyforge.org>
+All feedback welcome via plain-text mail to
+<yahns-public@rubyforge.org>
 .PD 0
 .P
 .PD
-No subscription is necessary to post to the mailing list.
+No subscription is
+necessary to post to the mailing list.
 .SH COPYRIGHT
 .PP
-Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all
+contributors.
 .PD 0
 .P
 .PD
-License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>
+License: GPLv3 or later
+<http://www.gnu.org/licenses/gpl-3.0.txt>
 .SH SEE ALSO
 .PP
 yahns(1), yahns_config(5)
@@ -178,3 +191,4 @@ yahns(1), yahns_config(5)
 Rack RDoc (http://rack.rubyforge.org/doc/)
 .IP \[bu] 2
 Rackup HowTo (http://wiki.github.com/rack/rack/tutorial-rackup-howto)
+

data/man/yahns.1

@@ -4,19 +4,20 @@
 yahns - multi-threaded, non-blocking application server for Ruby
 .SH SYNOPSYS
 .PP
-yahns -c CONFIG_FILE [-D|--daemonize]
+yahns -c CONFIG_FILE [-D|\[em]daemonize]
 .SH DESCRIPTION
 .PP
 yahns(1) is the primary interface for launching a yahns application
 server.
 The configuration file is documented in yahns_config(5).
-yahns hosts Rack HTTP applications, but may support others in the future
-such as DRb.
+yahns hosts Rack HTTP applications, but may support others in the
+future such as DRb.
 .SH SIGNALS
 .PP
-The following UNIX signals may be sent to the running yahns process.
-If yahns is configured for worker_processes (optional), signals should
-only be sent to the master process.
+The following UNIX signals may be sent to the running yahns
+process.
+If yahns is configured for worker_processes (optional), signals
+should only be sent to the master process.
 .IP \[bu] 2
 INT/TERM/QUIT - graceful shutdown.
 If repeated (any of these signals is sent twice), shutdown occurs
@@ -29,10 +30,10 @@ O_APPEND file flag and buffering disabled (IO#sync==false)
 USR2 - reexecute the running binary.
 A separate QUIT should be sent to
 .IP \[bu] 2
-HUP - if worker_processes are not used, this will reexecute the running
-binary and gracefully exit the running process.
-If worker_processes are used, this will reload config file, app, and
-gracefully restart all workers
+HUP - if worker_processes are not used, this will reexecute the
+running binary and gracefully exit the running process.
+If worker_processes are used, this will reload config file, app,
+and gracefully restart all workers
 .IP \[bu] 2
 WINCH - gracefully stops workers but keep the master running.
 This will only work for daemonized processes and only if the
@@ -46,30 +47,36 @@ worker_processes directive is used)
 .SH ENVIRONMENT
 .PP
 yahns(1) itself requires no special environment variables.
-However, environment variables such as RACK_ENV and RAILS_ENV can affect
-Rack and Rails applications it hosts.
-Ruby and C library implementation-specific environment variables will
-also affect it.
+However, environment variables such as RACK_ENV and RAILS_ENV can
+affect Rack and Rails applications it hosts.
+Ruby and C library implementation-specific environment variables
+will also affect it.
 .PP
 yahns will update the PWD (current working directory) env if the
 working_directory directive is set (see yahns_config(5)).
 .SH FILES
 .PP
-See yahns_config(5) for documentation on the configuration file format.
+See yahns_config(5) for documentation on the configuration file
+format.
 .SH CONTACT
 .PP
-All feedback welcome via plain-text mail to <yahns-public@rubyforge.org>
+All feedback welcome via plain-text mail to
+<yahns-public@rubyforge.org>
 .PD 0
 .P
 .PD
-No subscription is necessary to post to the mailing list.
+No subscription is
+necessary to post to the mailing list.
 .SH COPYRIGHT
 .PP
-Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all
+contributors.
 .PD 0
 .P
 .PD
-License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>
+License: GPLv3 or later
+<http://www.gnu.org/licenses/gpl-3.0.txt>
 .SH SEE ALSO
 .PP
 yahns-rackup(1), yahns_config(5)
+

data/test/server_helper.rb

@@ -100,4 +100,9 @@ module TrywriteBlocked
     return :wait_writable if $_tw_block_on.include?($_tw_blocked += 1)
     super
   end
+
+  def kgio_syssend(*args)
+    return :wait_writable if $_tw_block_on.include?($_tw_blocked += 1)
+    super
+  end
 end

data/test/test_response.rb

@@ -0,0 +1,84 @@
+# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+require_relative 'server_helper'
+
+class TestResponse < Testcase
+  ENV["N"].to_i > 1 and parallelize_me!
+  include ServerHelper
+  alias setup server_helper_setup
+  alias teardown server_helper_teardown
+
+  def test_response_time_empty_body
+    err = @err
+    cfg = Yahns::Config.new
+    host, port = @srv.addr[3], @srv.addr[1]
+    cfg.instance_eval do
+      GTL.synchronize do
+        app = Rack::Builder.new do
+          use Rack::ContentLength
+          use Rack::ContentType, "text/plain"
+          run lambda { |_| [ 200, {}, [] ] }
+        end
+        app(:rack, app) do
+          listen "#{host}:#{port}"
+        end
+      end
+      logger(Logger.new(err.path))
+    end
+    pid = mkserver(cfg)
+    Net::HTTP.start(host, port) { |h|
+      # warmup request
+      res = h.get("/")
+      assert_empty res.body
+
+      t0 = Time.now
+      nr = 10
+      nr.times do
+        res = h.get("/")
+        assert_empty res.body
+      end
+      diff = Time.now - t0
+      assert_operator diff, :<, (0.200 * nr)
+    }
+  ensure
+    quit_wait(pid)
+  end
+
+  def test_response_time_head
+    err = @err
+    cfg = Yahns::Config.new
+    host, port = @srv.addr[3], @srv.addr[1]
+    cfg.instance_eval do
+      GTL.synchronize do
+        require 'rack/lobster'
+        app = Rack::Builder.new do
+          use Rack::Head
+          use Rack::ContentLength
+          use Rack::ContentType, "text/plain"
+          run Rack::Lobster.new
+        end
+        app(:rack, app) do
+          listen "#{host}:#{port}"
+        end
+      end
+      logger(Logger.new(err.path))
+    end
+    pid = mkserver(cfg)
+    Net::HTTP.start(host, port) { |h|
+      # warmup request
+      res = h.head("/")
+      assert_equal 200, res.code.to_i
+
+      t0 = Time.now
+      nr = 10
+      nr.times do
+        res = h.head("/")
+        assert_equal 200, res.code.to_i
+      end
+      diff = Time.now - t0
+      assert_operator diff, :<, (0.200 * nr)
+    }
+  ensure
+    quit_wait(pid)
+  end
+end

data/yahns.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email = %q{yahns@yhbt.net}
   s.executables = manifest.grep(%r{\Abin/}).map { |s| s.sub(%r{\Abin/}, "") }
   s.files = manifest
-  s.add_dependency(%q<kgio>, '~> 2.8')
+  s.add_dependency(%q<kgio>, '~> 2.9')
   s.add_dependency(%q<sleepy_penguin>, '~> 3.2')
   s.add_dependency(%q<sendfile>, '~> 1.2.1')
   s.add_dependency(%q<unicorn>, '~> 4.6', '>= 4.6.3')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yahns
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - yahns hackers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-02 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: sleepy_penguin
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +196,7 @@ files:
 - test/test_rack.rb
 - test/test_rack_hijack.rb
 - test/test_reopen_logs.rb
+- test/test_response.rb
 - test/test_serve_static.rb
 - test/test_server.rb
 - test/test_stream_file.rb