butterflies 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce23457f770db65a47f7aabeb9c4fc581b283eeb
+  data.tar.gz: b6be8a5b8a668ddeee13ab0075cf1faf95311c1f
+SHA512:
+  metadata.gz: 26f86d39b06db05e84581c880fd38002863768c99d7ec53b42c25d666c7c765abf13a7246ced6c36cef2bce3d1b030cf8fff3cb86404865b411483432b7582b8
+  data.tar.gz: 8b6f4737f29a8bf9a11f7dc02f674a1ca4b76c01c5aeed666b4a983adb6fb345d8e661987b457519bd853549efe757490853c036610b9e143c6bd43aa3e23f39

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in butterflies.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Richard Bishop
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# Butterflies
+
+Butterflies is an experimental web server for Ruby applications that takes 
+advantage of modern Linux kernel (version 3.14+) features and threads.
+
+## Design
+
+Butterflies is inspired by the Erlang HTTP web server Cowboy. While we can't emulate
+everything Cowboy does in Ruby, due to the differences between Ruby and Erlang,
+we can borrow a little bit from Cowboy's design.
+
+Cowboy works by spawning a listening socket and then sharing that socket with a
+pool (potentially thousands of acceptors) of Erlang processes that accept on
+the socket. Erlang's unit of concurrency is known as a process. Erlang
+processes spawn very quickly so this model works well. In Ruby we have threads
+for concurrency, which unfortunately don't spawn that fast. It is best to spawn
+the threads you need upfront and re-use them.
+
+The two premier Ruby web servers today, Unicorn and Puma, work in very
+interesting and different ways. Unicorn is a lot like Cowboy in that it shares
+a listening socket among many child processes that then accept on this socket.
+The problem is that Unicorn's processes are operating processes which consume a
+lot more memory than a Thread or an Erlang process. This also means one process
+is only ever handling one request at a time. The advantage of this approach is
+that the kernel of the underlying operating system load balances requests for
+you.
+
+Puma works by using threads for handling requests. Puma manages this by having
+a thread listen for new connections and then pushing the connections onto a
+queue. There is then a pool of threads that monitor and handle requests. Puma
+also has a Reactor where you can check-in long lived connections.This is ideal
+because regardless of the runtime you're using you can serve more than one
+request in parallel per operating system process. The disadvantage is that you
+have only one acceptor and have to manage the log of waiting connections
+instead of letting the operating systen kernel do this for you.
+
+Like Puma, Butterflies is designed using threads. Butterflies takes advantage of the
+`SO_REUSEPORT` socket option that is available in Linux kernel version 3.9+ and
+BSD operating systems. Each Butterflies thread can listen and accept connections on
+the same port.  The back log of connections will be load balanced by the
+underlying kernel so you get performance and reliability without having to
+manage that complexity yourself.  You get the simplicity of Unicorn with the
+parallel request handling of Puma!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'butterflies'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install butterflies
+
+## Usage
+
+This gem is not ready to be used yet.
+
+## TODO
+
+- [ ] epoll FFI binding for Ruby or just use nio4r
+- [ ] TCP_FASTOPEN (Linux kernel 3.7+)
+- [ ] TCP_AUTOCORKING (Linux kernel 3.14+)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/butterflies/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/butterflies.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'butterflies/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "butterflies"
+  spec.version       = Butterflies::VERSION
+  spec.authors       = ["Richard Bishop"]
+  spec.email         = ["richard@rubiquity.com"]
+  spec.summary       = %q{An experimental web server using modern Linux kernel features.}
+  spec.description   = %q{An experimental web server using modern Linux kernel features.}
+  spec.homepage      = "https://github.com/rbishop/butterflies"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "http_parser.rb", "~> 0.6"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/example/config.ru

@@ -0,0 +1 @@
+run Proc.new { |env| [200, {'Content-Type' => 'text/html'}, ["Hello, World from #{Thread.current.object_id}"]] }

data/lib/butterflies.rb

@@ -0,0 +1,10 @@
+require 'socket'
+require 'thread'
+require "butterflies/version"
+require "butterflies/master"
+require "butterflies/acceptor"
+require "butterflies/rack_default"
+
+module Butterflies
+  # Your code goes here...
+end

data/lib/butterflies/acceptor.rb

@@ -0,0 +1,108 @@
+require "http/parser"
+require "stringio"
+require "io/wait"
+
+Thread.abort_on_exception = true
+
+module Butterflies
+  class Acceptor
+    attr_reader :thr
+
+    def initialize(app)
+      @app = app
+      accept
+    end
+
+    def accept
+      @thr = Thread.new do
+        puts "Spawning: #{Thread.current.object_id}"
+        server = Socket.new(:INET, :STREAM)
+        server.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEPORT, 1)
+        sockaddr = Socket.pack_sockaddr_in(3000, '127.0.0.1')
+        server.bind(sockaddr)
+        server.listen(1024)
+
+        loop do
+          begin
+            client, _ = server.accept_nonblock
+            puts Thread.current.object_id
+
+            parser = Http::Parser.new(self)
+            eof = false
+            parser.on_headers_complete = proc { eof = true }
+
+            until eof
+              body = client.read_nonblock(64, exception: false)
+              parser << body unless body == :wait_readable || body.nil?
+
+              if body == :wait_readable && !eof
+                IO.select([client])
+                next
+              end
+            end
+            
+            status, headers, body = @app.call(env.merge(header_vars(parser.headers)))
+            response = headers.reduce("HTTP/1.1 #{status} OK\r\n") do |res, (key, value)|
+              res += "#{key}: #{value}\r\n"
+            end
+
+            response += "\r\n" 
+            body.each do |line|
+              response += line
+            end
+
+            until response == ""
+              bytes = client.write_nonblock(response, exception: false)
+
+              if bytes == :wait_writeable
+                puts 'selecting'
+                IO.select(nil, [client])
+                next
+              end
+
+              response = response.byteslice(bytes..-1)
+            end
+            
+            body.close
+            client.close
+          rescue IO::WaitReadable
+            IO.select([server])
+            next
+          end
+        end
+      end
+
+      @thr
+    end
+
+    def join
+      @thr.join
+    end
+
+    def env
+      {
+        "REQUEST_METHOD" => "GET",
+        "SCRIPT_NAME" => "",
+        "PATH_INFO" => "",
+        "QUERY_STRING" => "",
+        "SERVER_NAME" => "Butterflies #{Butterflies::VERSION}",
+        "SERVER_PORT" => "3000",
+        "rack.version" => Rack::VERSION,
+        "rack.url_scheme" => "http",
+        "rack.multithread" => true,
+        "rack.multiprocess" => false,
+        "rack.run_once" => false,
+        "rack.input" => StringIO.new.set_encoding(Encoding::ASCII_8BIT),
+        "rack.errors" => $stderr
+      }
+    end
+
+    def header_vars(headers)
+      hdrs = {}
+      headers.each_pair do |key, value|
+        hdrs["HTTP_#{key.upcase.gsub("-", "_")}"] = value
+      end
+      hdrs
+    end
+  end
+end

data/lib/butterflies/master.rb

@@ -0,0 +1,13 @@
+module Butterflies
+  class Master
+    
+    def initialize(app)
+     @app = app
+    end
+
+    def run
+      @acceptors = 4.times.map { Acceptor.new(@app) }
+      @acceptors.map(&:join)
+    end
+  end
+end

data/lib/butterflies/rack_default.rb

@@ -0,0 +1,5 @@
+module Rack::Handler
+  def self.default(options = {})
+    Rack::Handler::Butterflies
+  end
+end

data/lib/butterflies/version.rb

@@ -0,0 +1,3 @@
+module Butterflies
+  VERSION = "0.0.1"
+end

data/lib/rack/handler/indian.rb

@@ -0,0 +1,27 @@
+require 'rack/handler'
+require 'butterflies'
+
+module Rack
+  module Handler
+    module Butterflies
+      def self.run(app, opts = {})
+        master = ::Butterflies::Master.new(app)
+
+        puts "Butterflies #{::Butterflies::VERSION} starting..."
+        puts "* Process ID #{Process.pid}"
+        puts "* Environment: #{ENV['RACK_ENV']}"
+        puts "* Listening on localhost:3000"
+
+        begin
+          master.run
+        rescue Interrupt
+          puts "* Shutting down..."
+          master.stop
+          puts "* See-ya!"
+        end
+      end
+    end
+
+    register :butterflies, Butterflies
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: butterflies
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Richard Bishop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http_parser.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: An experimental web server using modern Linux kernel features.
+email:
+- richard@rubiquity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- butterflies.gemspec
+- example/config.ru
+- lib/butterflies.rb
+- lib/butterflies/acceptor.rb
+- lib/butterflies/master.rb
+- lib/butterflies/rack_default.rb
+- lib/butterflies/version.rb
+- lib/rack/handler/indian.rb
+homepage: https://github.com/rbishop/butterflies
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An experimental web server using modern Linux kernel features.
+test_files: []