o-concurrent-ruby 1.1.11

data/lib/concurrent-ruby/concurrent/atomic/count_down_latch.rb

@@ -0,0 +1,100 @@
+require 'concurrent/utility/engine'
+require 'concurrent/atomic/mutex_count_down_latch'
+require 'concurrent/atomic/java_count_down_latch'
+
+module Concurrent
+
+  ###################################################################
+
+  # @!macro count_down_latch_method_initialize
+  #
+  #   Create a new `CountDownLatch` with the initial `count`.
+  #
+  #   @param [new] count the initial count
+  #
+  #   @raise [ArgumentError] if `count` is not an integer or is less than zero
+
+  # @!macro count_down_latch_method_wait
+  #
+  #   Block on the latch until the counter reaches zero or until `timeout` is reached.
+  #
+  #   @param [Fixnum] timeout the number of seconds to wait for the counter or `nil`
+  #     to block indefinitely
+  #   @return [Boolean] `true` if the `count` reaches zero else false on `timeout`
+
+  # @!macro count_down_latch_method_count_down
+  #
+  #   Signal the latch to decrement the counter. Will signal all blocked threads when
+  #   the `count` reaches zero.
+
+  # @!macro count_down_latch_method_count
+  #
+  #   The current value of the counter.
+  #
+  #   @return [Fixnum] the current value of the counter
+
+  ###################################################################
+
+  # @!macro count_down_latch_public_api
+  #
+  #   @!method initialize(count = 1)
+  #     @!macro count_down_latch_method_initialize
+  #
+  #   @!method wait(timeout = nil)
+  #     @!macro count_down_latch_method_wait
+  #
+  #   @!method count_down
+  #     @!macro count_down_latch_method_count_down
+  #
+  #   @!method count
+  #     @!macro count_down_latch_method_count
+
+  ###################################################################
+
+  # @!visibility private
+  # @!macro internal_implementation_note
+  CountDownLatchImplementation = case
+                                 when Concurrent.on_jruby?
+                                   JavaCountDownLatch
+                                 else
+                                   MutexCountDownLatch
+                                 end
+  private_constant :CountDownLatchImplementation
+
+  # @!macro count_down_latch
+  #
+  #   A synchronization object that allows one thread to wait on multiple other threads.
+  #   The thread that will wait creates a `CountDownLatch` and sets the initial value
+  #   (normally equal to the number of other threads). The initiating thread passes the
+  #   latch to the other threads then waits for the other threads by calling the `#wait`
+  #   method. Each of the other threads calls `#count_down` when done with its work.
+  #   When the latch counter reaches zero the waiting thread is unblocked and continues
+  #   with its work. A `CountDownLatch` can be used only once. Its value cannot be reset.
+  #
+  # @!macro count_down_latch_public_api
+  # @example Waiter and Decrementer
+  #   latch = Concurrent::CountDownLatch.new(3)
+  #
+  #   waiter = Thread.new do
+  #     latch.wait()
+  #     puts ("Waiter released")
+  #   end
+  #
+  #   decrementer = Thread.new do
+  #     sleep(1)
+  #     latch.count_down
+  #     puts latch.count
+  #
+  #     sleep(1)
+  #     latch.count_down
+  #     puts latch.count
+  #
+  #     sleep(1)
+  #     latch.count_down
+  #     puts latch.count
+  #   end
+  #
+  #   [waiter, decrementer].each(&:join)
+  class CountDownLatch < CountDownLatchImplementation
+  end
+end

data/lib/concurrent-ruby/concurrent/atomic/cyclic_barrier.rb

@@ -0,0 +1,128 @@
+require 'concurrent/synchronization'
+require 'concurrent/utility/native_integer'
+
+module Concurrent
+
+  # A synchronization aid that allows a set of threads to all wait for each
+  # other to reach a common barrier point.
+  # @example
+  #   barrier = Concurrent::CyclicBarrier.new(3)
+  #   jobs    = Array.new(3) { |i| -> { sleep i; p done: i } }
+  #   process = -> (i) do
+  #     # waiting to start at the same time
+  #     barrier.wait
+  #     # execute job
+  #     jobs[i].call
+  #     # wait for others to finish
+  #     barrier.wait
+  #   end
+  #   threads = 2.times.map do |i|
+  #     Thread.new(i, &process)
+  #   end
+  #
+  #   # use main as well
+  #   process.call 2
+  #
+  #   # here we can be sure that all jobs are processed
+  class CyclicBarrier < Synchronization::LockableObject
+
+    # @!visibility private
+    Generation = Struct.new(:status)
+    private_constant :Generation
+
+    # Create a new `CyclicBarrier` that waits for `parties` threads
+    #
+    # @param [Fixnum] parties the number of parties
+    # @yield an optional block that will be executed that will be executed after
+    #  the last thread arrives and before the others are released
+    #
+    # @raise [ArgumentError] if `parties` is not an integer or is less than zero
+    def initialize(parties, &block)
+      Utility::NativeInteger.ensure_integer_and_bounds parties
+      Utility::NativeInteger.ensure_positive_and_no_zero parties
+
+      super(&nil)
+      synchronize { ns_initialize parties, &block }
+    end
+
+    # @return [Fixnum] the number of threads needed to pass the barrier
+    def parties
+      synchronize { @parties }
+    end
+
+    # @return [Fixnum] the number of threads currently waiting on the barrier
+    def number_waiting
+      synchronize { @number_waiting }
+    end
+
+    # Blocks on the barrier until the number of waiting threads is equal to
+    # `parties` or until `timeout` is reached or `reset` is called
+    # If a block has been passed to the constructor, it will be executed once by
+    #  the last arrived thread before releasing the others
+    # @param [Fixnum] timeout the number of seconds to wait for the counter or
+    #  `nil` to block indefinitely
+    # @return [Boolean] `true` if the `count` reaches zero else false on
+    #  `timeout` or on `reset` or if the barrier is broken
+    def wait(timeout = nil)
+      synchronize do
+
+        return false unless @generation.status == :waiting
+
+        @number_waiting += 1
+
+        if @number_waiting == @parties
+          @action.call if @action
+          ns_generation_done @generation, :fulfilled
+          true
+        else
+          generation = @generation
+          if ns_wait_until(timeout) { generation.status != :waiting }
+            generation.status == :fulfilled
+          else
+            ns_generation_done generation, :broken, false
+            false
+          end
+        end
+      end
+    end
+
+    # resets the barrier to its initial state
+    # If there is at least one waiting thread, it will be woken up, the `wait`
+    # method will return false and the barrier will be broken
+    # If the barrier is broken, this method restores it to the original state
+    #
+    # @return [nil]
+    def reset
+      synchronize { ns_generation_done @generation, :reset }
+    end
+
+    # A barrier can be broken when:
+    # - a thread called the `reset` method while at least one other thread was waiting
+    # - at least one thread timed out on `wait` method
+    #
+    # A broken barrier can be restored using `reset` it's safer to create a new one
+    # @return [Boolean] true if the barrier is broken otherwise false
+    def broken?
+      synchronize { @generation.status != :waiting }
+    end
+
+    protected
+
+    def ns_generation_done(generation, status, continue = true)
+      generation.status = status
+      ns_next_generation if continue
+      ns_broadcast
+    end
+
+    def ns_next_generation
+      @generation     = Generation.new(:waiting)
+      @number_waiting = 0
+    end
+
+    def ns_initialize(parties, &block)
+      @parties = parties
+      @action  = block
+      ns_next_generation
+    end
+  end
+end

data/lib/concurrent-ruby/concurrent/atomic/event.rb

@@ -0,0 +1,109 @@
+require 'thread'
+require 'concurrent/synchronization'
+
+module Concurrent
+
+  # Old school kernel-style event reminiscent of Win32 programming in C++.
+  #
+  # When an `Event` is created it is in the `unset` state. Threads can choose to
+  # `#wait` on the event, blocking until released by another thread. When one
+  # thread wants to alert all blocking threads it calls the `#set` method which
+  # will then wake up all listeners. Once an `Event` has been set it remains set.
+  # New threads calling `#wait` will return immediately. An `Event` may be
+  # `#reset` at any time once it has been set.
+  #
+  # @see http://msdn.microsoft.com/en-us/library/windows/desktop/ms682655.aspx
+  # @example
+  #   event = Concurrent::Event.new
+  #
+  #   t1 = Thread.new do
+  #     puts "t1 is waiting"
+  #     event.wait(1)
+  #     puts "event occurred"
+  #   end
+  #
+  #   t2 = Thread.new do
+  #     puts "t2 calling set"
+  #     event.set
+  #   end
+  #
+  #   [t1, t2].each(&:join)
+  #
+  #   # prints:
+  #   # t1 is waiting
+  #   # t2 calling set
+  #   # event occurred
+  class Event < Synchronization::LockableObject
+
+    # Creates a new `Event` in the unset state. Threads calling `#wait` on the
+    # `Event` will block.
+    def initialize
+      super
+      synchronize { ns_initialize }
+    end
+
+    # Is the object in the set state?
+    #
+    # @return [Boolean] indicating whether or not the `Event` has been set
+    def set?
+      synchronize { @set }
+    end
+
+    # Trigger the event, setting the state to `set` and releasing all threads
+    # waiting on the event. Has no effect if the `Event` has already been set.
+    #
+    # @return [Boolean] should always return `true`
+    def set
+      synchronize { ns_set }
+    end
+
+    def try?
+      synchronize { @set ? false : ns_set }
+    end
+
+    # Reset a previously set event back to the `unset` state.
+    # Has no effect if the `Event` has not yet been set.
+    #
+    # @return [Boolean] should always return `true`
+    def reset
+      synchronize do
+        if @set
+          @set       = false
+          @iteration +=1
+        end
+        true
+      end
+    end
+
+    # Wait a given number of seconds for the `Event` to be set by another
+    # thread. Will wait forever when no `timeout` value is given. Returns
+    # immediately if the `Event` has already been set.
+    #
+    # @return [Boolean] true if the `Event` was set before timeout else false
+    def wait(timeout = nil)
+      synchronize do
+        unless @set
+          iteration = @iteration
+          ns_wait_until(timeout) { iteration < @iteration || @set }
+        else
+          true
+        end
+      end
+    end
+
+    protected
+
+    def ns_set
+      unless @set
+        @set = true
+        ns_broadcast
+      end
+      true
+    end
+
+    def ns_initialize
+      @set       = false
+      @iteration = 0
+    end
+  end
+end

data/lib/concurrent-ruby/concurrent/atomic/java_count_down_latch.rb

@@ -0,0 +1,42 @@
+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)
+        Utility::NativeInteger.ensure_integer_and_bounds(count)
+        Utility::NativeInteger.ensure_positive(count)
+        @latch = java.util.concurrent.CountDownLatch.new(count)
+      end
+
+      # @!macro count_down_latch_method_wait
+      def wait(timeout = nil)
+        result = nil
+        if timeout.nil?
+          Synchronization::JRuby.sleep_interruptibly { @latch.await }
+          result = true
+        else
+          Synchronization::JRuby.sleep_interruptibly do
+            result = @latch.await(1000 * timeout, java.util.concurrent.TimeUnit::MILLISECONDS)
+          end
+        end
+        result
+      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-ruby/concurrent/atomic/java_thread_local_var.rb

@@ -0,0 +1,37 @@
+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
+
+      protected
+
+      # @!visibility private
+      def allocate_storage
+        @var = java.lang.ThreadLocal.new
+      end
+    end
+  end
+end

data/lib/concurrent-ruby/concurrent/atomic/mutex_atomic_boolean.rb

@@ -0,0 +1,62 @@
+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
+
+    private
+
+    # @!visibility private
+    def ns_make_value(value)
+      old = @value
+      @value = value
+      old != @value
+    end
+  end
+end

data/lib/concurrent-ruby/concurrent/atomic/mutex_atomic_fixnum.rb

@@ -0,0 +1,75 @@
+require 'concurrent/synchronization'
+require 'concurrent/utility/native_integer'
+
+module Concurrent
+
+  # @!macro atomic_fixnum
+  # @!visibility private
+  # @!macro internal_implementation_note
+  class MutexAtomicFixnum < Synchronization::LockableObject
+
+    # @!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)
+      Utility::NativeInteger.ensure_integer_and_bounds value
+      @value = value
+    end
+  end
+end

data/lib/concurrent-ruby/concurrent/atomic/mutex_count_down_latch.rb

@@ -0,0 +1,44 @@
+require 'concurrent/synchronization'
+require 'concurrent/utility/native_integer'
+
+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)
+      Utility::NativeInteger.ensure_integer_and_bounds count
+      Utility::NativeInteger.ensure_positive count
+
+      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