fiber_pool 0.9.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,45 @@
+# What is this ?
+
+It is a basic implementation of a fiber pool extracted for my projects,
+I need a pool in many project and I am tired of having to reimplement it
+in every project so here goes my gem !
+
+My implementation is based on the neverblock one but I added some changes of
+my own over time.
+
+# Features
+
+- Constant count of fibers with a queue (I am sure you would have never guessed ;) )
+- should any uncaught error occur in one fiber of the poll then another one
+  will be spawned to keep the pool state (you should not let errors uncaught but
+  my experience clearly shows me that it can happen and it can trigger really weird bug
+  if your poll runs out of fibers)
+
+# Usage
+
+I use it mainly with EventMachine but it is in no way required, that said it may not be
+of much use without, I did not gave it much thoughts :)
+
+    # create a pool contained 10 fibers
+    pool = FiberPool.new(10)
+    
+    # and spawn a job
+    # if a fiber is free it will be executed immediatly
+    # otherwise the block is queued
+    pool.spawn{ do_something() }
+
+
+# Warning
+
+If you use this You should already be aware of how fibers work, If not go read about them
+and keep in mind that when a Fiber is running nothing else will, they are like threads but
+you are responsible for the scheduling.
+
+
+# Supported Runtimes
+
+- MRI 1.8.6+  (in ruby 1.8 the thread based fiber implementation will be used)
+- Rubinius 1.2.2+ (fiber support is still experimental so be careful what you do this it here)
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/fiber_pool.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fiber_pool/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fiber_pool"
+  s.version     = FiberPool::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Julien Ammmous"]
+  s.email       = []
+  s.homepage    = ""
+  s.summary     = %q{Fiber Pool Implementation}
+  s.description = %q{A General purpose fiber pool}
+
+  s.rubyforge_project = "fiber_pool"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  
+end

data/lib/fiber_pool/fiber18.rb

@@ -0,0 +1,83 @@
+# Poor Man's Fiber (API compatible Thread based Fiber implementation for Ruby 1.8)
+# (c) 2008 Aman Gupta (tmm1)
+
+unless defined? Fiber
+  $:.unshift File.expand_path(File.dirname(__FILE__)) + '/compat'
+  require 'thread'
+
+  class FiberError < StandardError; end
+
+  class Fiber
+    def initialize
+      raise ArgumentError, 'new Fiber requires a block' unless block_given?
+
+      @yield = Queue.new
+      @resume = Queue.new
+
+      @thread = Thread.new{ @yield.push [yield(*@resume.pop)] }
+      @thread.abort_on_exception = true
+      @thread[:fiber] = self
+    end
+    attr_reader :thread
+
+    def resume *args
+      raise FiberError, 'dead fiber called' unless @thread.alive?
+      @resume.push(args)
+      result = @yield.pop
+      result.size > 1 ? result : result.first
+    end
+
+    def yield *args
+      @yield.push(args)
+      result = @resume.pop
+      result.size > 1 ? result : result.first
+    end
+    
+    def alive?
+      @thread.alive?
+    end
+
+    def self.yield *args
+      if fiber = Thread.current[:fiber]
+        fiber.yield(*args)
+      else
+        raise FiberError, 'not inside a fiber'
+      end
+    end
+
+    def self.current
+      if Thread.current == Thread.main
+        return Thread.main[:fiber] ||= RootFiber.new
+      end
+
+      Thread.current[:fiber] or raise FiberError, 'not inside a fiber'
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}>"
+    end
+  end
+
+  class RootFiber < Fiber
+    def initialize
+      # XXX: what is a root fiber anyway?
+    end
+
+    def self.yield *args
+      raise FiberError, "can't yield from root fiber"
+    end
+  end
+end
+
+if __FILE__ == $0
+  f = Fiber.new{ |sym|
+    p(sym)
+    puts 'hi'
+    p(Fiber.yield 1)
+    puts 'bye'
+    :end
+  }
+  p(f.resume :begin)
+  p(f.resume 2)
+end
+

data/lib/fiber_pool/pool.rb

@@ -0,0 +1,95 @@
+begin
+  require 'fiber'
+  if defined?(Rubinius::Fiber)
+    Fiber = Rubinius::Fiber
+  end
+  
+rescue LoadError
+  require File.expand_path('../fiber18', __FILE__)
+end
+
+class FiberPool
+  # Prepare a list of fibers that are able to run different blocks of code
+  # every time. Once a fiber is done with its block, it attempts to fetch
+  # another one from the queue
+  def initialize(count = 100)
+    @fibers,@busy_fibers,@queue = [],{},[]
+    
+    count.times do |i|
+      add_fiber()
+    end
+  end
+  
+  def add_fiber
+    fiber = Fiber.new do |block|
+      loop do
+        block.call
+        unless @queue.empty?
+          block = @queue.shift
+        else
+          @busy_fibers.delete(Fiber.current.object_id)
+          @fibers.unshift Fiber.current
+          block = Fiber.yield
+        end
+      end
+    end
+    
+    @fibers << fiber
+    fiber
+  end
+
+  # If there is an available fiber use it, otherwise, leave it to linger
+  # in a queue
+  def spawn(&block)
+    # resurrect dead fibers
+    @busy_fibers.values.reject(&:alive?).each do |f|
+      @busy_fibers.delete(f.object_id)
+      add_fiber()
+    end
+    
+    if fiber = @fibers.shift
+      @busy_fibers[fiber.object_id] = fiber
+      fiber.resume(block)
+    else
+      @queue << block
+    end
+    
+    fiber
+  end
+  
+end
+
+
+if $0 == __FILE__
+  pool = FiberPool.new(2)
+  f1 = pool.spawn do
+    puts "1"
+    puts Fiber.yield
+  end
+  
+  begin
+    pool.spawn do
+      puts "2"
+      f1.resume(42)
+      raise 'arggggg'
+    end
+  rescue => err
+    p err.inspect
+  end
+  
+  begin
+    pool.spawn do
+      raise 'arggggg 222'
+    end
+    
+  rescue => err
+    p err.inspect
+  end
+  
+  
+  pool.spawn do
+    puts "I am alive !!!"
+  end
+  
+end
+

data/lib/fiber_pool/version.rb

@@ -0,0 +1,3 @@
+module FiberPool
+  VERSION = "0.9.0"
+end

data/lib/fiber_pool.rb

@@ -0,0 +1,7 @@
+module FiberPool
+  def self.require_lib(path)
+    require File.expand_path("../#{path}", __FILE__)
+  end
+  
+  require_lib("fiber_pool/version")
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: fiber_pool
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Julien Ammmous
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-24 00:00:00 Z
+dependencies: []
+
+description: A General purpose fiber pool
+email: []
+
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- fiber_pool.gemspec
+- lib/fiber_pool.rb
+- lib/fiber_pool/fiber18.rb
+- lib/fiber_pool/pool.rb
+- lib/fiber_pool/version.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: fiber_pool
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Fiber Pool Implementation
+test_files: []
+
+has_rdoc: