celluloid-task-pooledfiber 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce7677f3d306f7ab9e1fd473f2a45386a21ec953
+  data.tar.gz: 69a81b51fb510f73ffc68137c5f6fea66afdaa3e
+SHA512:
+  metadata.gz: 040302514e06883c48056eb92d5e074453ba992e2deb25fb961da5de9d37adf97b084fce49953497afe70e544b10a523d52b198b2cc9945e8021592bf8335dc3
+  data.tar.gz: c81f30f0a4aee9ba1b3bf9ea6384f02358f89bd3342c87c1f57f7e19d80a455c8d1899cd0e1bbbd566cea8f54ddfb9356650b0331e2ebe3b111d653713863a88

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+  - jruby-19mode

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in celluloid-task-pooled-fiber.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'rspec', '~> 3.2'
+  gem 'rspec-retry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Heald
+
+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,36 @@
+# Celluloid::TaskPooledFiber
+
+[![Build Status](https://travis-ci.org/celluloid/celluloid-task-pooledfiber.svg)](https://travis-ci.org/celluloid/celluloid-task-pooledfiber)
+
+Provides a Task implementation which reuses a pool of fibers to run tasks. This improves Celluloid's performance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'celluloid-task-pooledfiber'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install celluloid-task-pooledfiber
+
+## Usage
+
+In your application, before starting Celluloid:
+
+    require 'celluloid/task_pooled_fiber'
+    Celluloid.task_class = Celluloid::TaskPooledFiber
+
+That's it.
+
+## Contributing
+
+1. Fork it ( https://github.com/celluloid/celluloid-task-pooledfiber/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,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color --format documentation']
+end
+task :default => :spec

data/celluloid-task-pooledfiber.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "celluloid-task-pooledfiber"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Chris Heald"]
+  spec.email         = ["cheald@gmail.com"]
+
+  spec.summary       = %q{An alternate Task implementation for Celluloid which improves performance by reusing a pool of fibers to run tasks}
+  spec.description   = %q{An alternate Task implementation for Celluloid which improves performance by reusing a pool of fibers to run tasks}
+  spec.homepage      = "http://github.com/celluloid/celluloid-task-pooledfiber"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "celluloid", "~> 0.16"
+end

data/lib/celluloid/task/pooled_fiber.rb

@@ -0,0 +1 @@
+require_relative "../task_pooled_fiber.rb"

data/lib/celluloid/task_pooled_fiber.rb

@@ -0,0 +1,21 @@
+require 'celluloid'
+require 'thread'
+
+module Celluloid
+  require_relative './util/fiber_pool'
+
+  class TaskPooledFiber < TaskFiber
+    def self.fiber_pool
+      @fiber_pool ||= Util::FiberPool.new
+    end
+
+    def create(&block)
+      queue = Thread.current[:celluloid_queue]
+      @fiber = TaskPooledFiber.fiber_pool.acquire do
+        Thread.current[:celluloid_role] = :actor
+        Thread.current[:celluloid_queue] = queue
+        block.call
+      end
+    end
+  end
+end

data/lib/celluloid/util/fiber_pool.rb

@@ -0,0 +1,95 @@
+module Celluloid
+  module Util
+    class FiberPool
+      attr_accessor :stats
+
+      def initialize(trim_size = 64)
+        @trim_size = trim_size
+        @pool = {}
+        @stats = { created: 0, acquired: 0, trimmed: 0, sweep_counter: 0, terminated: 0, terminated_threads: 0, sweeps: 0 }
+        @mutex = Mutex.new
+      end
+
+      def acquire(&block)
+        trim
+        sweep
+        @stats[:acquired] += 1
+        fiber = fiber_pool.shift || create_fiber
+        fiber.resume(block)
+        fiber
+      end
+
+      private
+
+      def create_fiber
+        pool = fiber_pool
+        @stats[:created] += 1
+        Fiber.new do |blk|
+          loop do
+            # At this point, we have a pooled fiber ready for Celluloid to call #resume on.
+            Fiber.yield
+
+            # Once Celluloid resumes the fiber, we need to execute the block the task was
+            # created with. This may call suspend/resume; that's fine.
+            blk.call
+
+            # Once Celluloid completes the task, we release this Fiber back to the pool
+            pool << Fiber.current
+
+            # ...and yield for the next #acquire call.
+            blk = Fiber.yield
+            break if blk == :terminate
+          end
+        end
+      end
+
+      # If the fiber pool has grown too much, shift off and discard
+      # extra fibers so they may be GC'd. This isn't ideal, but it
+      # should guard against runaway resource consumption.
+      def trim
+        pool = fiber_pool
+        while pool.length > @trim_size
+          @stats[:trimmed] += 1
+          pool.shift.resume(:terminate)
+        end
+      end
+
+      def sweep
+        @mutex.synchronize do
+          @stats[:sweep_counter] += 1
+          if @stats[:sweep_counter] > 10_000
+            alive = []
+            Thread.list.each do |thread|
+              alive << thread.object_id if thread.alive? && @pool.key?(thread.object_id)
+            end
+
+            (@pool.keys - alive).each do |thread_id|
+              @pool[thread_id].each do |_fiber|
+                @stats[:terminated] += 1
+                # We can't resume the fiber here because we might resume cross-thread
+                # TODO: How do we deal with alive fibers in a dead thread?
+                # fiber.resume(:terminate)
+              end
+              @stats[:terminated_threads] += 1
+              @pool.delete thread_id
+            end
+            @stats[:sweep_counter] = 0
+            @stats[:sweeps] += 1
+          end
+        end
+      end
+
+      # Fiber pool for this thread. Fibers can't cross threads, so we have to maintain a
+      # pool per thread.
+      #
+      # We keep our pool in an instance variable rather than in thread locals so that we
+      # can sweep out old Fibers from dead threads. This keeps live Fiber instances in
+      # a thread local from keeping the thread from being GC'd.
+      def fiber_pool
+        @mutex.synchronize do
+          @pool[Thread.current.object_id] ||= []
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: celluloid-task-pooledfiber
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Heald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: An alternate Task implementation for Celluloid which improves performance
+  by reusing a pool of fibers to run tasks
+email:
+- cheald@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- celluloid-task-pooledfiber.gemspec
+- lib/celluloid/task/pooled_fiber.rb
+- lib/celluloid/task_pooled_fiber.rb
+- lib/celluloid/util/fiber_pool.rb
+homepage: http://github.com/celluloid/celluloid-task-pooledfiber
+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.4.6
+signing_key: 
+specification_version: 4
+summary: An alternate Task implementation for Celluloid which improves performance
+  by reusing a pool of fibers to run tasks
+test_files: []