concurrent-ruby 0.9.2 → 1.0.0.pre1

data/lib/concurrent/atomic/cyclic_barrier.rb

@@ -2,6 +2,8 @@ require 'concurrent/synchronization'
 
 module Concurrent
 
+  # A synchronization aid that allows a set of threads to all wait for each
+  # other to reach a common barrier point.
   class CyclicBarrier < Synchronization::Object
 
     # @!visibility private

data/lib/concurrent/atomic/java_count_down_latch.rb

@@ -0,0 +1,39 @@
+if Concurrent.on_jruby?
+
+  module Concurrent
+
+    # @!macro count_down_latch
+    # @!visibility private
+    # @!macro internal_implementation_note
+    class JavaCountDownLatch
+
+      # @!macro count_down_latch_method_initialize
+      def initialize(count = 1)
+        unless count.is_a?(Fixnum) && count >= 0
+          raise ArgumentError.new('count must be in integer greater than or equal zero')
+        end
+        @latch = java.util.concurrent.CountDownLatch.new(count)
+      end
+
+      # @!macro count_down_latch_method_wait
+      def wait(timeout = nil)
+        if timeout.nil?
+          @latch.await
+          true
+        else
+          @latch.await(1000 * timeout, java.util.concurrent.TimeUnit::MILLISECONDS)
+        end
+      end
+
+      # @!macro count_down_latch_method_count_down
+      def count_down
+        @latch.countDown
+      end
+
+      # @!macro count_down_latch_method_count
+      def count
+        @latch.getCount
+      end
+    end
+  end
+end

data/lib/concurrent/atomic/java_thread_local_var.rb

@@ -0,0 +1,50 @@
+require 'concurrent/atomic/abstract_thread_local_var'
+
+if Concurrent.on_jruby?
+
+  module Concurrent
+
+    # @!visibility private
+    # @!macro internal_implementation_note
+    class JavaThreadLocalVar < AbstractThreadLocalVar
+
+      # @!macro thread_local_var_method_get
+      def value
+        value = @var.get
+
+        if value.nil?
+          @default
+        elsif value == NIL_SENTINEL
+          nil
+        else
+          value
+        end
+      end
+
+      # @!macro thread_local_var_method_set
+      def value=(value)
+        @var.set(value)
+      end
+
+      # @!macro thread_local_var_method_bind
+      def bind(value, &block)
+        if block_given?
+          old_value = @var.get
+          begin
+            @var.set(value)
+            yield
+          ensure
+            @var.set(old_value)
+          end
+        end
+      end
+
+      protected
+
+      # @!visibility private
+      def allocate_storage
+        @var = java.lang.ThreadLocal.new
+      end
+    end
+  end
+end

data/lib/concurrent/atomic/mutex_atomic_boolean.rb

@@ -0,0 +1,60 @@
+require 'concurrent/synchronization'
+
+module Concurrent
+
+  # @!macro atomic_boolean
+  # @!visibility private
+  # @!macro internal_implementation_note
+  class MutexAtomicBoolean < Synchronization::Object
+
+    # @!macro atomic_boolean_method_initialize
+    def initialize(initial = false)
+      super()
+      synchronize { ns_initialize(initial) }
+    end
+
+    # @!macro atomic_boolean_method_value_get
+    def value
+      synchronize { @value }
+    end
+
+    # @!macro atomic_boolean_method_value_set
+    def value=(value)
+      synchronize { @value = !!value }
+    end
+
+    # @!macro atomic_boolean_method_true_question
+    def true?
+      synchronize { @value }
+    end
+
+    # @!macro atomic_boolean_method_false_question
+    def false?
+      synchronize { !@value }
+    end
+
+    # @!macro atomic_boolean_method_make_true
+    def make_true
+      synchronize { ns_make_value(true) }
+    end
+
+    # @!macro atomic_boolean_method_make_false
+    def make_false
+      synchronize { ns_make_value(false) }
+    end
+
+    protected
+
+    # @!visibility private
+    def ns_initialize(initial)
+      @value = !!initial
+    end
+
+    # @!visibility private
+    def ns_make_value(value)
+      old = @value
+      @value = value
+      old != @value
+    end
+  end
+end

data/lib/concurrent/atomic/mutex_atomic_fixnum.rb

@@ -0,0 +1,91 @@
+require 'concurrent/synchronization'
+
+module Concurrent
+
+  # @!macro atomic_fixnum
+  # @!visibility private
+  # @!macro internal_implementation_note
+  class MutexAtomicFixnum < Synchronization::Object
+
+    # http://stackoverflow.com/questions/535721/ruby-max-integer
+    MIN_VALUE = -(2**(0.size * 8 - 2))
+    MAX_VALUE = (2**(0.size * 8 - 2) - 1)
+
+    # @!macro atomic_fixnum_method_initialize
+    def initialize(initial = 0)
+      super()
+      synchronize { ns_initialize(initial) }
+    end
+
+    # @!macro atomic_fixnum_method_value_get
+    def value
+      synchronize { @value }
+    end
+
+    # @!macro atomic_fixnum_method_value_set
+    def value=(value)
+      synchronize { ns_set(value) }
+    end
+
+    # @!macro atomic_fixnum_method_increment
+    def increment(delta = 1)
+      synchronize { ns_set(@value + delta.to_i) }
+    end
+
+    alias_method :up, :increment
+
+    # @!macro atomic_fixnum_method_decrement
+    def decrement(delta = 1)
+      synchronize { ns_set(@value - delta.to_i) }
+    end
+
+    alias_method :down, :decrement
+
+    # @!macro atomic_fixnum_method_compare_and_set
+    def compare_and_set(expect, update)
+      synchronize do
+        if @value == expect.to_i
+          @value = update.to_i
+          true
+        else
+          false
+        end
+      end
+    end
+
+    # @!macro atomic_fixnum_method_update
+    def update
+      synchronize do
+        @value = yield @value
+      end
+    end
+
+    protected
+
+    # @!visibility private
+    def ns_initialize(initial)
+      ns_set(initial)
+    end
+
+    private
+
+    # @!visibility private
+    def ns_set(value)
+      range_check!(value)
+      @value = value
+    end
+
+    # @!visibility private
+    def range_check!(value)
+      if !value.is_a?(Fixnum)
+        raise ArgumentError.new('value value must be a Fixnum')
+      elsif value > MAX_VALUE
+        raise RangeError.new("#{value} is greater than the maximum value of #{MAX_VALUE}")
+      elsif value < MIN_VALUE
+        raise RangeError.new("#{value} is less than the maximum value of #{MIN_VALUE}")
+      else
+        value
+      end
+    end
+  end
+end

data/lib/concurrent/atomic/mutex_count_down_latch.rb

@@ -0,0 +1,43 @@
+require 'concurrent/synchronization'
+
+module Concurrent
+
+  # @!macro count_down_latch
+  # @!visibility private
+  # @!macro internal_implementation_note
+  class MutexCountDownLatch < Synchronization::Object
+
+    # @!macro count_down_latch_method_initialize
+    def initialize(count = 1)
+      unless count.is_a?(Fixnum) && count >= 0
+        raise ArgumentError.new('count must be in integer greater than or equal zero')
+      end
+      super()
+      synchronize { ns_initialize count }
+    end
+
+    # @!macro count_down_latch_method_wait
+    def wait(timeout = nil)
+      synchronize { ns_wait_until(timeout) { @count == 0 } }
+    end
+
+    # @!macro count_down_latch_method_count_down
+    def count_down
+      synchronize do
+        @count -= 1 if @count > 0
+        ns_broadcast if @count == 0
+      end
+    end
+
+    # @!macro count_down_latch_method_count
+    def count
+      synchronize { @count }
+    end
+
+    protected
+
+    def ns_initialize(count)
+      @count = count
+    end
+  end
+end

data/lib/concurrent/atomic/mutex_semaphore.rb

@@ -0,0 +1,115 @@
+require 'concurrent/synchronization'
+
+module Concurrent
+
+  # @!macro semaphore
+  # @!visibility private
+  # @!macro internal_implementation_note
+  class MutexSemaphore < Synchronization::Object
+
+    # @!macro semaphore_method_initialize
+    def initialize(count)
+      unless count.is_a?(Fixnum) && count >= 0
+        fail ArgumentError, 'count must be an non-negative integer'
+      end
+      super()
+      synchronize { ns_initialize count }
+    end
+
+    # @!macro semaphore_method_acquire
+    def acquire(permits = 1)
+      unless permits.is_a?(Fixnum) && permits > 0
+        fail ArgumentError, 'permits must be an integer greater than zero'
+      end
+      synchronize do
+        try_acquire_timed(permits, nil)
+        nil
+      end
+    end
+
+    # @!macro semaphore_method_available_permits
+    def available_permits
+      synchronize { @free }
+    end
+
+    # @!macro semaphore_method_drain_permits
+    #
+    #   Acquires and returns all permits that are immediately available.
+    #
+    #   @return [Integer]
+    def drain_permits
+      synchronize do
+        @free.tap { |_| @free = 0 }
+      end
+    end
+
+    # @!macro semaphore_method_try_acquire
+    def try_acquire(permits = 1, timeout = nil)
+      unless permits.is_a?(Fixnum) && permits > 0
+        fail ArgumentError, 'permits must be an integer greater than zero'
+      end
+      synchronize do
+        if timeout.nil?
+          try_acquire_now(permits)
+        else
+          try_acquire_timed(permits, timeout)
+        end
+      end
+    end
+
+    # @!macro semaphore_method_release
+    def release(permits = 1)
+      unless permits.is_a?(Fixnum) && permits > 0
+        fail ArgumentError, 'permits must be an integer greater than zero'
+      end
+      synchronize do
+        @free += permits
+        permits.times { ns_signal }
+      end
+      nil
+    end
+
+    # Shrinks the number of available permits by the indicated reduction.
+    #
+    # @param [Fixnum] reduction Number of permits to remove.
+    #
+    # @raise [ArgumentError] if `reduction` is not an integer or is negative
+    #
+    # @raise [ArgumentError] if `@free` - `@reduction` is less than zero
+    #
+    # @return [nil]
+    # 
+    # @!visibility private
+    def reduce_permits(reduction)
+      unless reduction.is_a?(Fixnum) && reduction >= 0
+        fail ArgumentError, 'reduction must be an non-negative integer'
+      end
+      synchronize { @free -= reduction }
+      nil
+    end
+
+    protected
+
+    # @!visibility private
+    def ns_initialize(count)
+      @free = count
+    end
+
+    private
+
+    # @!visibility private
+    def try_acquire_now(permits)
+      if @free >= permits
+        @free -= permits
+        true
+      else
+        false
+      end
+    end
+
+    # @!visibility private
+    def try_acquire_timed(permits, timeout)
+      ns_wait_until(timeout) { try_acquire_now(permits) }
+    end
+  end
+end

data/lib/concurrent/atomic/ruby_thread_local_var.rb

@@ -0,0 +1,172 @@
+require 'thread'
+require 'concurrent/atomic/abstract_thread_local_var'
+
+module Concurrent
+
+  # @!visibility private
+  # @!macro internal_implementation_note
+  class RubyThreadLocalVar < AbstractThreadLocalVar
+
+    # Each thread has a (lazily initialized) array of thread-local variable values
+    # Each time a new thread-local var is created, we allocate an "index" for it
+    # For example, if the allocated index is 1, that means slot #1 in EVERY
+    #   thread's thread-local array will be used for the value of that TLV
+    #
+    # The good thing about using a per-THREAD structure to hold values, rather
+    #   than a per-TLV structure, is that no synchronization is needed when
+    #    reading and writing those values (since the structure is only ever
+    #    accessed by a single thread)
+    #
+    # Of course, when a TLV is GC'd, 1) we need to recover its index for use
+    #   by other new TLVs (otherwise the thread-local arrays could get bigger
+    #   and bigger with time), and 2) we need to null out all the references
+    #   held in the now-unused slots (both to avoid blocking GC of those objects,
+    #   and also to prevent "stale" values from being passed on to a new TLV
+    #   when the index is reused)
+    # Because we need to null out freed slots, we need to keep references to
+    #   ALL the thread-local arrays -- ARRAYS is for that
+    # But when a Thread is GC'd, we need to drop the reference to its thread-local
+    #   array, so we don't leak memory
+
+    # @!visibility private
+    FREE = []
+    LOCK = Mutex.new
+    ARRAYS = {} # used as a hash set
+    @@next = 0
+    private_constant :FREE, :LOCK, :ARRAYS
+
+    # @!macro [attach] thread_local_var_method_initialize
+    #
+    #   Creates a thread local variable.
+    #
+    #   @param [Object] default the default value when otherwise unset
+    def initialize(default = nil)
+      @default = default
+      allocate_storage
+    end
+
+    # @!macro thread_local_var_method_get
+    def value
+      if array = get_threadlocal_array
+        value = array[@index]
+        if value.nil?
+          @default
+        elsif value.equal?(NIL_SENTINEL)
+          nil
+        else
+          value
+        end
+      else
+        @default
+      end
+    end
+
+    # @!macro thread_local_var_method_set
+    def value=(value)
+      me = Thread.current
+      # We could keep the thread-local arrays in a hash, keyed by Thread
+      # But why? That would require locking
+      # Using Ruby's built-in thread-local storage is faster
+      unless array = get_threadlocal_array(me)
+        array = set_threadlocal_array([], me)
+        LOCK.synchronize { ARRAYS[array.object_id] = array }
+        ObjectSpace.define_finalizer(me, self.class.thread_finalizer(array))
+      end
+      array[@index] = (value.nil? ? NIL_SENTINEL : value)
+      value
+    end
+
+    # @!macro thread_local_var_method_bind
+    def bind(value, &block)
+      if block_given?
+        old_value = self.value
+        begin
+          self.value = value
+          yield
+        ensure
+          self.value = old_value
+        end
+      end
+    end
+
+    protected
+
+    # @!visibility private
+    def allocate_storage
+      @index = LOCK.synchronize do
+        FREE.pop || begin
+        result = @@next
+        @@next += 1
+        result
+        end
+      end
+      ObjectSpace.define_finalizer(self, self.class.threadlocal_finalizer(@index))
+    end
+
+    # @!visibility private
+    def self.threadlocal_finalizer(index)
+      proc do
+        LOCK.synchronize do
+          FREE.push(index)
+          # The cost of GC'ing a TLV is linear in the number of threads using TLVs
+          # But that is natural! More threads means more storage is used per TLV
+          # So naturally more CPU time is required to free more storage
+          ARRAYS.each_value do |array|
+            array[index] = nil
+          end
+        end
+      end
+    end
+
+    # @!visibility private
+    def self.thread_finalizer(array)
+      proc do
+        LOCK.synchronize do
+          # The thread which used this thread-local array is now gone
+          # So don't hold onto a reference to the array (thus blocking GC)
+          ARRAYS.delete(array.object_id)
+        end
+      end
+    end
+
+    private
+
+    if Thread.instance_methods.include?(:thread_variable_get)
+
+      def get_threadlocal_array(thread = Thread.current)
+        thread.thread_variable_get(:__threadlocal_array__)
+      end
+
+      def set_threadlocal_array(array, thread = Thread.current)
+        thread.thread_variable_set(:__threadlocal_array__, array)
+      end
+
+    else
+
+      def get_threadlocal_array(thread = Thread.current)
+        thread[:__threadlocal_array__]
+      end
+
+      def set_threadlocal_array(array, thread = Thread.current)
+        thread[:__threadlocal_array__] = array
+      end
+    end
+
+    # This exists only for use in testing
+    # @!visibility private
+    def value_for(thread)
+      if array = get_threadlocal_array(thread)
+        value = array[@index]
+        if value.nil?
+          @default
+        elsif value.equal?(NIL_SENTINEL)
+          nil
+        else
+          value
+        end
+      else
+        @default
+      end
+    end
+  end
+end