concurrent-ruby 0.9.2-java → 1.0.0-java

data/lib/concurrent/atomic/cyclic_barrier.rb

@@ -2,7 +2,9 @@ require 'concurrent/synchronization'
 
 module Concurrent
 
-  class CyclicBarrier < Synchronization::Object
+  # A synchronization aid that allows a set of threads to all wait for each
+  # other to reach a common barrier point.
+  class CyclicBarrier < Synchronization::LockableObject
 
     # @!visibility private
     Generation = Struct.new(:status)

data/lib/concurrent/atomic/event.rb

@@ -13,7 +13,7 @@ module Concurrent
   # `#reset` at any time once it has been set.
   #
   # @see http://msdn.microsoft.com/en-us/library/windows/desktop/ms682655.aspx
-  class Event < Synchronization::Object
+  class Event < Synchronization::LockableObject
 
     # Creates a new `Event` in the unset state. Threads calling `#wait` on the
     # `Event` will block.

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 == NULL
+          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::LockableObject
+
+    # @!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::LockableObject
+
+    # 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::LockableObject
+
+    # @!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::LockableObject
+
+    # @!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/read_write_lock.rb

@@ -41,10 +41,12 @@ module Concurrent
     # @!visibility private
     MAX_WRITERS    = RUNNING_WRITER - MAX_READERS - 1
 
-    # Implementation notes: 
+    safe_initialization!
+
+    # Implementation notes:
     # A goal is to make the uncontended path for both readers/writers lock-free
     # Only if there is reader-writer or writer-writer contention, should locks be used
-    # Internal state is represented by a single integer ("counter"), and updated 
+    # Internal state is represented by a single integer ("counter"), and updated
     #  using atomic compare-and-swap operations
     # When the counter is 0, the lock is free
     # Each reader increments the counter by 1 when acquiring a read lock
@@ -54,11 +56,10 @@ module Concurrent
 
     # Create a new `ReadWriteLock` in the unlocked state.
     def initialize
+      super()
       @Counter   = AtomicFixnum.new(0) # single integer which represents lock state
       @ReadLock  = Synchronization::Lock.new
       @WriteLock = Synchronization::Lock.new
-      ensure_ivar_visibility!
-      super()
     end
 
     # Execute a block operation within a read lock.