yahns 0.0.0TP1

data/GIT-VERSION-GEN

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+CONSTANT = "Yahns::VERSION"
+RVF = "lib/yahns/version.rb"
+GVF = "GIT-VERSION-FILE"
+DEF_VER = "v0.0.0TP1"
+vn = DEF_VER
+
+# First see if there is a version file (included in release tarballs),
+# then try git-describe, then default.
+if File.exist?(".git")
+  describe = `git describe --abbrev=4 HEAD 2>/dev/null`.strip
+  case describe
+  when /\Av[0-9]*/
+    vn = describe
+    system(*%w(git update-index -q --refresh))
+    unless `git diff-index --name-only HEAD --`.chomp.empty?
+      vn << "-dirty"
+    end
+    vn.tr!('-', '.')
+  end
+end
+
+vn = vn.sub!(/\Av/, "")
+new_ruby_version = "#{CONSTANT} = '#{vn}' # :nodoc:\n"
+cur_ruby_version = File.read(RVF) rescue nil
+if new_ruby_version != cur_ruby_version
+  File.open(RVF, "w") { |fp| fp.write(new_ruby_version) }
+end
+File.chmod(0644, RVF)
+
+# generate the makefile snippet
+new_make_version = "VERSION = #{vn}\n"
+cur_make_version = File.read(GVF) rescue nil
+if new_make_version != cur_make_version
+  File.open(GVF, "w") { |fp| fp.write(new_make_version) }
+end
+File.chmod(0644, GVF)
+
+puts vn if $0 == __FILE__

data/GNUmakefile

@@ -0,0 +1,90 @@
+# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+all::
+pkg = yahns
+RUBY = ruby
+GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
+	@./GIT-VERSION-GEN
+-include GIT-VERSION-FILE
+lib := lib
+
+all:: test
+test_units := $(wildcard test/test_*.rb)
+test: $(test_units)
+$(test_units):
+	$(RUBY) -w -I $(lib) $@ -v
+
+test-mt: export N = $(shell nproc 2>/dev/null || echo 4)
+test-mt:
+	$(RUBY) -w -I $(lib) $(addprefix -r./,$(test_units)) -eexit --
+
+check-warnings:
+	@(for i in $$(git ls-files '*.rb'| grep -v '^setup\.rb$$'); \
+	  do $(RUBY) -d -W2 -c $$i; done) | grep -v '^Syntax OK$$' || :
+
+check: test
+coverage: export COVERAGE=1
+coverage:
+	> coverage.dump
+	$(MAKE) check
+	$(RUBY) ./test/covshow.rb
+
+coverage-mt: export COVERAGE=1
+coverage-mt:
+	> coverage.dump
+	$(MAKE) test-mt
+	$(RUBY) ./test/covshow.rb
+
+pkggem := pkg/$(pkg)-$(VERSION).gem
+pkgtgz := pkg/$(pkg)-$(VERSION).tar.gz
+
+fix-perms:
+	git ls-tree -r HEAD | awk '/^100644 / {print $$NF}' | xargs chmod 644
+	git ls-tree -r HEAD | awk '/^100755 / {print $$NF}' | xargs chmod 755
+
+gem: $(pkggem)
+
+install-gem: $(pkggem)
+	gem install $(CURDIR)/$<
+
+$(pkggem): .gem-manifest
+	VERSION=$(VERSION) gem build $(pkg).gemspec
+	mkdir -p pkg
+	mv $(@F) $@
+
+pkg_extra := GIT-VERSION-FILE lib/yahns/version.rb NEWS
+NEWS:
+	rake -s $@
+
+gem-man:
+	$(MAKE) -C Documentation/ gem-man
+tgz-man:
+	$(MAKE) -C Documentation/ install-man mandir=$(CURDIR)/man
+.PHONY: tgz-man gem-man
+
+.gem-manifest: .manifest
+	# (ls man/*.?; cat .manifest) | LC_ALL=C sort > $@+
+	LC_ALL=C sort < .manifest > $@+
+	cmp $@+ $@ || mv $@+ $@; rm -f $@+
+.tgz-manifest: .manifest
+	LC_ALL=C sort < .manifest > $@+
+	cmp $@+ $@ || mv $@+ $@; rm -f $@+
+.manifest: NEWS fix-perms
+	rm -rf man
+	(git ls-files; \
+	 for i in $(pkg_extra); do echo $$i; done) | \
+	 LC_ALL=C sort > $@+
+	cmp $@+ $@ || mv $@+ $@; rm -f $@+
+$(pkgtgz): distdir = pkg/$(pkg)-$(VERSION)
+$(pkgtgz): .tgz-manifest
+	@test -n "$(distdir)"
+	$(RM) -r $(distdir)
+	mkdir -p $(distdir)
+	tar cf - $$(cat .tgz-manifest) | (cd $(distdir) && tar xf -)
+	cd pkg && tar cf - $(pkg)-$(VERSION) | gzip -9 > $(@F)+
+	mv $@+ $@
+
+package: $(pkgtgz) $(pkggem)
+
+.PHONY: all .FORCE-GIT-VERSION-FILE test $(test_units) NEWS
+.PHONY: check-warnings fix-perms

data/README

@@ -0,0 +1,127 @@
+yahns - sleepy, multi-threaded, non-blocking application server for Ruby
+------------------------------------------------------------------------
+
+A Free Software, multi-threaded, non-blocking network application server
+designed for low _idle_ power consumption.  It is primarily optimized
+for applications with occasional users which see little or no traffic.
+yahns currently hosts Rack/HTTP applications, but may eventually support
+other application types.  Unlike some existing servers, yahns is
+extremely sensitive to fatal bugs in the applications it hosts.
+
+Features
+--------
+
+* _zero_ wakeups when all clients are idle
+* idle client connections may live forever if there is no FD pressure
+* suitable for slow clients, fast clients, or a mixture of both
+* HTTP/0.9 support
+* HTTP/1.1 persistent connections and pipelining
+* decodes HTTP chunked encoding for requests
+* parses HTTP/1.1 trailers in requests
+* supports streaming responses with lazy buffering for slow clients
+* optional streaming input for fast clients
+* able to host multiple applications with different settings
+* uses epoll to scale to many idle connections
+* abuses epoll as a load balancer between threads inside a process
+* optional multi-process support (in addition to threads)
+* fairly balances new clients between multiple processes (on Linux)
+
+Supported Platforms
+-------------------
+
+yahns is developed primarily for modern GNU/Linux systems.
+
+We may support kqueue for FreeBSD/OpenBSD/NetBSD if there is significant
+interest.  Non-Free systems/dependencies will never be supported
+
+Supported Ruby implementations:
+* (Matz) Ruby 2.0 or later
+* Rubinius 2.0 or later (planned)
+
+Contact
+-------
+
+We are happy to see feedback of all types via plain-text email.
+Please send comments, user/dev discussion, patches, bug reports,
+and pull requests to Eric Wong at: normalperson@yhbt.net
+
+Public mailing list coming soon.
+
+This README is our homepage, we would rather be working on HTTP servers
+all day than worrying about the next browser vulnerability because
+HTML/CSS/JS is too complicated for us.
+
+* http://yahns.yhbt.net/README
+
+Hacking
+-------
+
+We use git and follow the same development model as git itself
+(mailing list-oriented, benevolent dictator).
+
+  git clone git://yahns.yhbt.net/yahns
+
+Please use git-format-patch(1) and git-send-email(1) distributed with
+the git(7) suite for generating and sending patches.  Please format
+pull requests with the git-request-pull(1) script (also distributed
+with git(7)) and send them via email.
+
+See http://www.git-scm.com/ for more information on git.
+
+Design
+------
+
+yahns is designed to optimimally use multiple threads with non-blocking I/O.
+The event loop is not a traditional single-threaded design with a mutex
+slapped on as an afterthought, but designed from the beginning to utilize
+multiple threads.
+
+* two classes of long-lived, persistent threads
+  1. blocking acceptors
+  2. non-blocking event loop workers
+* epoll acts as a queue (by using one-shot notifications)
+* acceptors accept new clients and put them in the epoll "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 will support kqueue if there
+is interest.  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/
+
+In addition to multiple threads, yahns optionally supports multiple
+processes to work around low FD limits as well as contention in the:
+
+* kernel (socket (de)allocation from accept/close)
+* standard C library (malloc/free)
+* Ruby VM (GVL, GC)
+* application it hosts
+
+Copyright
+---------
+
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
+License: GPLv3 or later <https://www.gnu.org/licenses/gpl-3.0.txt>
+
+yahns is copyrighted Free Software by all contributors, see logs in
+revision control for names and email addresses of all of them.  yahns
+contains code from Mongrel, unicorn, and Rainbows! which may also be
+licensed under the GPLv2 or later.
+
+yahns is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 3 of the License, or (at your
+option) any later version.
+
+yahns is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, see https://www.gnu.org/licenses/gpl-3.0.txt
+
+lrg nabgure ubeevoyl-anzrq freire :>

data/Rakefile

@@ -0,0 +1,60 @@
+# 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 'tempfile'
+include Rake::DSL
+task "NEWS" do
+  latest = nil
+  fp = Tempfile.new("NEWS", ".")
+  fp.sync = true
+  `git tag -l`.split(/\n/).reverse.each do |tag|
+    %r{\Av(.+)} =~ tag or next
+    version = $1
+    header, subject, body = `git cat-file tag #{tag}`.split(/\n\n/, 3)
+    header = header.split(/\n/)
+    tagger = header.grep(/\Atagger /)[0]
+    time = Time.at(tagger.split(/ /)[-2].to_i).utc
+    latest ||= time
+    date = time.strftime("%Y-%m-%d")
+    fp.puts "# #{version} / #{date}\n\n#{subject}"
+    if body && body.strip.size > 0
+      fp.puts "\n\n#{body}"
+    end
+    fp.puts
+  end
+  fp.write("Unreleased\n\n") unless fp.size > 0
+  fp.puts "# COPYRIGHT"
+  bdfl = 'Eric Wong <normalperson@yhbt.net>'
+  fp.puts "Copyright (C) 2013, #{bdfl} and all contributors"
+  fp.puts "License: GPLv3 or later (http://www.gnu.org/licenses/gpl-3.0.txt)"
+  fp.rewind
+  assert_equal fp.read, File.read("NEWS") rescue nil
+  fp.chmod 0644
+  File.rename(fp.path, "NEWS")
+  fp.close!
+end
+
+task rsync_docs: "NEWS" do
+  dest = ENV["RSYNC_DEST"] || "yahns.yhbt.net:/srv/yahns/"
+  top = %w(NEWS README COPYING)
+  files = []
+
+  # git-set-file-times is distributed with rsync,
+  # Also available at: http://yhbt.net/git-set-file-times
+  # on Debian systems: /usr/share/doc/rsync/scripts/git-set-file-times.gz
+  sh("git", "set-file-times", "examples", *top)
+
+  `git ls-files Documentation/*.txt`.split(/\n/).concat(top).each do |txt|
+    gz = "#{txt}.gz"
+    tmp = "#{gz}.#$$"
+    sh("gzip -9 < #{txt} > #{tmp}")
+    st = File.stat(txt)
+    File.utime(st.atime, st.mtime, tmp) # make nginx gzip_static happy
+    File.rename(tmp, gz)
+    files << txt
+    files << gz
+  end
+  sh("rsync --chmod=Fugo=r -av #{files.join(' ')} #{dest}")
+
+  examples = `git ls-files examples`.split("\n")
+  sh("rsync --chmod=Fugo=r -av #{examples.join(' ')} #{dest}/examples/")
+end

data/bin/yahns

@@ -0,0 +1,32 @@
+#!/this/will/be/overwritten/or/wrapped/anyways/do/not/worry/ruby
+# -*- encoding: binary -*-
+# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
+# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
+$stdout.sync = $stderr.sync = true
+require 'yahns'
+require 'optparse'
+config_file = daemonize = nil
+OptionParser.new("", 24, "  ") do |opts|
+  cmd = File.basename($0)
+  opts.banner = "Usage: #{cmd} [options]"
+  opts.separator "#{cmd} options:"
+  opts.on("-D", "--daemonize", "run daemonized in the background") do |d|
+    daemonize = !!d
+  end
+  opts.on("-c", "--config-file FILE", "yahns config file") do |f|
+    config_file = f
+  end
+  opts.separator "Common options:"
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts.to_s
+    exit
+  end
+  opts.on_tail("-v", "--version", "Show version") do
+    puts "#{cmd} v#{Yahns::VERSION}"
+    exit
+  end
+  opts.parse!(ARGV)
+end
+server = Yahns::Server.new(Yahns::Config.new(config_file))
+Yahns::Daemon.daemon(server) if daemonize
+server.start.join

data/examples/README

@@ -0,0 +1,3 @@
+All files in this example directory (including this one) are CC0:
+To the extent possible under law, Eric Wong has waived all copyright and
+related or neighboring rights to these examples.

data/examples/init.sh

@@ -0,0 +1,76 @@
+#!/bin/sh
+# To the extent possible under law, Eric Wong has waived all copyright and
+# related or neighboring rights to this examples
+set -e
+# Example init script, this can be used with nginx, too,
+# since nginx and yahns accept the same signals
+
+# Feel free to change any of the following variables for your app:
+TIMEOUT=${TIMEOUT-60}
+APP_ROOT=/home/x/my_app/current
+PID=$APP_ROOT/tmp/pids/yahns.pid
+CMD="/usr/bin/yahns -D -c $APP_ROOT/config/yahns.rb"
+INIT_CONF=$APP_ROOT/config/init.conf
+action="$1"
+set -u
+
+test -f "$INIT_CONF" && . $INIT_CONF
+
+old_pid="$PID.oldbin"
+
+cd $APP_ROOT || exit 1
+
+sig () {
+	test -s "$PID" && kill -$1 `cat $PID`
+}
+
+oldsig () {
+	test -s $old_pid && kill -$1 `cat $old_pid`
+}
+
+case $action in
+start)
+	sig 0 && echo >&2 "Already running" && exit 0
+	$CMD
+	;;
+stop)
+	sig QUIT && exit 0
+	echo >&2 "Not running"
+	;;
+force-stop)
+	sig TERM && exit 0
+	echo >&2 "Not running"
+	;;
+restart|reload)
+	sig HUP && echo reloaded OK && exit 0
+	echo >&2 "Couldn't reload, starting '$CMD' instead"
+	$CMD
+	;;
+upgrade)
+	if sig USR2 && sleep 2 && sig 0 && oldsig QUIT
+	then
+		n=$TIMEOUT
+		while test -s $old_pid && test $n -ge 0
+		do
+			printf '.' && sleep 1 && n=$(( $n - 1 ))
+		done
+		echo
+
+		if test $n -lt 0 && test -s $old_pid
+		then
+			echo >&2 "$old_pid still exists after $TIMEOUT seconds"
+			exit 1
+		fi
+		exit 0
+	fi
+	echo >&2 "Couldn't upgrade, starting '$CMD' instead"
+	$CMD
+	;;
+reopen-logs)
+	sig USR1
+	;;
+*)
+	echo >&2 "Usage: $0 <start|stop|restart|upgrade|force-stop|reopen-logs>"
+	exit 1
+	;;
+esac

data/examples/logger_mp_safe.rb

@@ -0,0 +1,28 @@
+# To the extent possible under law, Eric Wong has waived all copyright and
+# related or neighboring rights to this examples
+#
+# Multi-Processing-safe monkey patch for Logger
+#
+# This monkey patch fixes the case where "preload: true" is used and
+# the application spawns a background thread upon being loaded.
+#
+# This removes all lock from the Logger code and solely relies on the
+# underlying filesystem to handle write(2) system calls atomically when
+# O_APPEND is used.  This is safe in the presence of both multiple
+# threads (native or green) and multiple processes when writing to
+# a filesystem with POSIX O_APPEND semantics.
+#
+# It should be noted that the original locking on Logger could _never_ be
+# considered reliable on non-POSIX filesystems with multiple processes,
+# either, so nothing is lost in that case.
+
+require 'logger'
+class Logger::LogDevice
+  def write(message)
+    @dev.syswrite(message)
+  end
+
+  def close
+    @dev.close
+  end
+end