concurrent-ruby 1.0.5 → 1.1.6

data/lib/{concurrent → concurrent-ruby/concurrent}/executor/ruby_thread_pool_executor.rb

@@ -122,8 +122,6 @@ module Concurrent
       raise ArgumentError.new("`min_threads` cannot be less than #{DEFAULT_MIN_POOL_SIZE}") if @min_length < DEFAULT_MIN_POOL_SIZE
       raise ArgumentError.new("`min_threads` cannot be more than `max_threads`") if min_length > max_length
 
-      self.auto_terminate = opts.fetch(:auto_terminate, true)
-
       @pool                 = [] # all workers
       @ready                = [] # used as a stash (most idle worker is at the start)
       @queue                = [] # used as queue
@@ -131,6 +129,7 @@ module Concurrent
       @scheduled_task_count = 0
       @completed_task_count = 0
       @largest_length       = 0
+      @workers_counter      = 0
       @ruby_pid             = $$ # detects if Ruby has forked
 
       @gc_interval  = opts.fetch(:gc_interval, @idletime / 2.0).to_i # undocumented
@@ -224,7 +223,8 @@ module Concurrent
     def ns_add_busy_worker
       return if @pool.size >= @max_length
 
-      @pool << (worker = Worker.new(self))
+      @workers_counter += 1
+      @pool << (worker = Worker.new(self, @workers_counter))
       @largest_length = @pool.length if @pool.length > @largest_length
       worker
     end
@@ -284,6 +284,7 @@ module Concurrent
         @scheduled_task_count = 0
         @completed_task_count = 0
         @largest_length       = 0
+        @workers_counter      = 0
         @ruby_pid             = $$
       end
     end
@@ -292,11 +293,15 @@ module Concurrent
     class Worker
       include Concern::Logging
 
-      def initialize(pool)
+      def initialize(pool, id)
         # instance variables accessed only under pool's lock so no need to sync here again
         @queue  = Queue.new
         @pool   = pool
         @thread = create_worker @queue, pool, pool.idletime
+
+        if @thread.respond_to?(:name=)
+          @thread.name = [pool.name, 'worker', id].compact.join('-')
+        end
       end
 
       def <<(message)

data/lib/{concurrent → concurrent-ruby/concurrent}/executor/simple_executor_service.rb

@@ -91,7 +91,7 @@ module Concurrent
 
     private
 
-    def ns_initialize
+    def ns_initialize(*args)
       @running = Concurrent::AtomicBoolean.new(true)
       @stopped = Concurrent::Event.new
       @count = Concurrent::AtomicFixnum.new(0)

data/lib/{concurrent → concurrent-ruby/concurrent}/executor/single_thread_executor.rb

@@ -1,3 +1,4 @@
+require 'concurrent/utility/engine'
 require 'concurrent/executor/ruby_single_thread_executor'
 
 module Concurrent
@@ -14,7 +15,7 @@ module Concurrent
                                        end
   private_constant :SingleThreadExecutorImplementation
 
-  # @!macro [attach] single_thread_executor
+  # @!macro single_thread_executor
   #
   #   A thread pool with a single thread an unlimited queue. Should the thread
   #   die for any reason it will be removed and replaced, thus ensuring that
@@ -35,7 +36,7 @@ module Concurrent
   # @!macro abstract_executor_service_public_api
   class SingleThreadExecutor < SingleThreadExecutorImplementation
 
-    # @!macro [new] single_thread_executor_method_initialize
+    # @!macro single_thread_executor_method_initialize
     #
     #   Create a new thread pool.
     #

data/lib/{concurrent → concurrent-ruby/concurrent}/executor/thread_pool_executor.rb

@@ -15,7 +15,7 @@ module Concurrent
                                      end
   private_constant :ThreadPoolExecutorImplementation
 
-  # @!macro [attach] thread_pool_executor
+  # @!macro thread_pool_executor
   #
   #   An abstraction composed of one or more threads and a task queue. Tasks
   #   (blocks or `proc` objects) are submitted to the pool and added to the queue.
@@ -55,12 +55,12 @@ module Concurrent
   # @!macro thread_pool_executor_public_api
   class ThreadPoolExecutor < ThreadPoolExecutorImplementation
 
-    # @!macro [new] thread_pool_executor_method_initialize
+    # @!macro thread_pool_executor_method_initialize
     #
     #   Create a new thread pool.
-    #  
+    #
     #   @param [Hash] opts the options which configure the thread pool.
-    #  
+    #
     #   @option opts [Integer] :max_threads (DEFAULT_MAX_POOL_SIZE) the maximum
     #     number of threads to be created
     #   @option opts [Integer] :min_threads (DEFAULT_MIN_POOL_SIZE) When a new task is submitted
@@ -73,12 +73,12 @@ module Concurrent
     #   @option opts [Symbol] :fallback_policy (:abort) the policy for handling new
     #     tasks that are received when the queue size has reached
     #     `max_queue` or the executor has shut down
-    #  
+    #
     #   @raise [ArgumentError] if `:max_threads` is less than one
     #   @raise [ArgumentError] if `:min_threads` is less than zero
     #   @raise [ArgumentError] if `:fallback_policy` is not one of the values specified
     #     in `FALLBACK_POLICIES`
-    #  
+    #
     #   @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ThreadPoolExecutor.html
 
     # @!method initialize(opts = {})

data/lib/{concurrent → concurrent-ruby/concurrent}/executor/timer_set.rb

@@ -20,7 +20,7 @@ module Concurrent
 
     # Create a new set of timed tasks.
     #
-    # @!macro [attach] executor_options
+    # @!macro executor_options
     #
     #   @param [Hash] opts the options used to specify the executor on which to perform actions
     #   @option opts [Executor] :executor when set use the given `Executor` instance.
@@ -48,11 +48,9 @@ module Concurrent
     def post(delay, *args, &task)
       raise ArgumentError.new('no block given') unless block_given?
       return false unless running?
-      opts = {
-        executor: @task_executor,
-        args: args,
-        timer_set: self
-      }
+      opts = { executor:  @task_executor,
+               args:      args,
+               timer_set: self }
       task = ScheduledTask.execute(delay, opts, &task) # may raise exception
       task.unscheduled? ? false : task
     end
@@ -74,12 +72,11 @@ module Concurrent
     # @param [Hash] opts the options to create the object with.
     # @!visibility private
     def ns_initialize(opts)
-      @queue          = Collection::NonConcurrentPriorityQueue.new(order: :min)
-      @task_executor  = Options.executor_from_options(opts) || Concurrent.global_io_executor
-      @timer_executor = SingleThreadExecutor.new
-      @condition      = Event.new
-      @ruby_pid       = $$ # detects if Ruby has forked
-      self.auto_terminate = opts.fetch(:auto_terminate, true)
+      @queue              = Collection::NonConcurrentPriorityQueue.new(order: :min)
+      @task_executor      = Options.executor_from_options(opts) || Concurrent.global_io_executor
+      @timer_executor     = SingleThreadExecutor.new
+      @condition          = Event.new
+      @ruby_pid           = $$ # detects if Ruby has forked
     end
 
     # Post the task to the internal queue.
@@ -90,7 +87,7 @@ module Concurrent
     #
     # @!visibility private
     def post_task(task)
-      synchronize{ ns_post_task(task) }
+      synchronize { ns_post_task(task) }
     end
 
     # @!visibility private
@@ -98,7 +95,7 @@ module Concurrent
       return false unless ns_running?
       ns_reset_if_forked
       if (task.initial_delay) <= 0.01
-        task.executor.post{ task.process_task }
+        task.executor.post { task.process_task }
       else
         @queue.push(task)
         # only post the process method when the queue is empty
@@ -116,7 +113,7 @@ module Concurrent
     #
     # @!visibility private
     def remove_task(task)
-      synchronize{ @queue.delete(task) }
+      synchronize { @queue.delete(task) }
     end
 
     # `ExecutorService` callback called during shutdown.
@@ -148,7 +145,7 @@ module Concurrent
         task = synchronize { @condition.reset; @queue.peek }
         break unless task
 
-        now = Concurrent.monotonic_time
+        now  = Concurrent.monotonic_time
         diff = task.schedule_time - now
 
         if diff <= 0
@@ -165,7 +162,7 @@ module Concurrent
           # queue now must have the same pop time, or a closer one, as
           # when we peeked).
           task = synchronize { @queue.pop }
-          task.executor.post{ task.process_task }
+          task.executor.post { task.process_task }
         else
           @condition.wait([diff, 60].min)
         end

data/lib/{concurrent → concurrent-ruby/concurrent}/future.rb

@@ -6,9 +6,12 @@ require 'concurrent/executor/safe_task_executor'
 
 require 'concurrent/options'
 
+# TODO (pitr-ch 14-Mar-2017): deprecate, Future, Promise, etc.
+
+
 module Concurrent
 
-  # {include:file:doc/future.md}
+  # {include:file:docs-source/future.md}
   #
   # @!macro copy_options
   #

data/lib/concurrent-ruby/concurrent/hash.rb

@@ -0,0 +1,59 @@
+require 'concurrent/utility/engine'
+require 'concurrent/thread_safe/util'
+
+module Concurrent
+
+  # @!macro concurrent_hash
+  #
+  #   A thread-safe subclass of Hash. This version locks against the object
+  #   itself for every method call, ensuring only one thread can be reading
+  #   or writing at a time. This includes iteration methods like `#each`,
+  #   which takes the lock repeatedly when reading an item.
+  #
+  #   @see http://ruby-doc.org/core-2.2.0/Hash.html Ruby standard library `Hash`
+
+  # @!macro internal_implementation_note
+  HashImplementation = case
+                       when Concurrent.on_cruby?
+                         # Hash is thread-safe in practice because CRuby runs
+                         # threads one at a time and does not do context
+                         # switching during the execution of C functions.
+                         ::Hash
+
+                       when Concurrent.on_jruby?
+                         require 'jruby/synchronized'
+
+                         class JRubyHash < ::Hash
+                           include JRuby::Synchronized
+                         end
+                         JRubyHash
+
+                       when Concurrent.on_rbx?
+                         require 'monitor'
+                         require 'concurrent/thread_safe/util/data_structures'
+
+                         class RbxHash < ::Hash
+                         end
+                         ThreadSafe::Util.make_synchronized_on_rbx RbxHash
+                         RbxHash
+
+                       when Concurrent.on_truffleruby?
+                         require 'concurrent/thread_safe/util/data_structures'
+
+                         class TruffleRubyHash < ::Hash
+                         end
+
+                         ThreadSafe::Util.make_synchronized_on_truffleruby TruffleRubyHash
+                         TruffleRubyHash
+
+                       else
+                         warn 'Possibly unsupported Ruby implementation'
+                         ::Hash
+                       end
+  private_constant :HashImplementation
+
+  # @!macro concurrent_hash
+  class Hash < HashImplementation
+  end
+
+end

data/lib/{concurrent → concurrent-ruby/concurrent}/immutable_struct.rb

@@ -70,6 +70,14 @@ module Concurrent
       ns_select(&block)
     end
 
+    private
+
+    # @!visibility private
+    def initialize_copy(original)
+      super(original)
+      ns_initialize_copy
+    end
+
     # @!macro struct_new
     def self.new(*args, &block)
       clazz_name = nil

data/lib/{concurrent → concurrent-ruby/concurrent}/ivar.rb

@@ -98,10 +98,10 @@ module Concurrent
       observer
     end
 
-    # @!macro [attach] ivar_set_method
+    # @!macro ivar_set_method
     #   Set the `IVar` to a value and wake or notify all threads waiting on it.
     #
-    #   @!macro [attach] ivar_set_parameters_and_exceptions
+    #   @!macro ivar_set_parameters_and_exceptions
     #     @param [Object] value the value to store in the `IVar`
     #     @yield A block operation to use for setting the value
     #     @raise [ArgumentError] if both a value and a block are given
@@ -124,7 +124,7 @@ module Concurrent
       self
     end
 
-    # @!macro [attach] ivar_fail_method
+    # @!macro ivar_fail_method
     #   Set the `IVar` to failed due to some error and wake or notify all threads waiting on it.
     #
     #   @param [Object] reason for the failure
@@ -157,9 +157,8 @@ module Concurrent
       self.observers = Collection::CopyOnWriteObserverSet.new
       set_deref_options(opts)
 
-      if value == NULL
-        @state = :pending
-      else
+      @state = :pending
+      if value != NULL
         ns_complete_without_notification(true, value, nil)
       end
     end

data/lib/concurrent-ruby/concurrent/map.rb

@@ -0,0 +1,337 @@
+require 'thread'
+require 'concurrent/constants'
+require 'concurrent/synchronization'
+require 'concurrent/utility/engine'
+
+module Concurrent
+  # @!visibility private
+  module Collection
+
+    # @!visibility private
+    MapImplementation = case
+                        when Concurrent.on_jruby?
+                          # noinspection RubyResolve
+                          JRubyMapBackend
+                        when Concurrent.on_cruby?
+                          require 'concurrent/collection/map/mri_map_backend'
+                          MriMapBackend
+                        when Concurrent.on_rbx? || Concurrent.on_truffleruby?
+                          require 'concurrent/collection/map/atomic_reference_map_backend'
+                          AtomicReferenceMapBackend
+                        else
+                          warn 'Concurrent::Map: unsupported Ruby engine, using a fully synchronized Concurrent::Map implementation'
+                          require 'concurrent/collection/map/synchronized_map_backend'
+                          SynchronizedMapBackend
+                        end
+  end
+
+  # `Concurrent::Map` is a hash-like object and should have much better performance
+  # characteristics, especially under high concurrency, than `Concurrent::Hash`.
+  # However, `Concurrent::Map `is not strictly semantically equivalent to a ruby `Hash`
+  # -- for instance, it does not necessarily retain ordering by insertion time as `Hash`
+  # does. For most uses it should do fine though, and we recommend you consider
+  # `Concurrent::Map` instead of `Concurrent::Hash` for your concurrency-safe hash needs.
+  class Map < Collection::MapImplementation
+
+    # @!macro map.atomic_method
+    #   This method is atomic.
+
+    # @!macro map.atomic_method_with_block
+    #   This method is atomic.
+    #   @note Atomic methods taking a block do not allow the `self` instance
+    #     to be used within the block. Doing so will cause a deadlock.
+
+    # @!method compute_if_absent(key)
+    #   Compute and store new value for key if the key is absent.
+    #   @param [Object] key
+    #   @yield new value
+    #   @yieldreturn [Object] new value
+    #   @return [Object] new value or current value
+    #   @!macro map.atomic_method_with_block
+
+    # @!method compute_if_present(key)
+    #   Compute and store new value for key if the key is present.
+    #   @param [Object] key
+    #   @yield new value
+    #   @yieldparam old_value [Object]
+    #   @yieldreturn [Object, nil] new value, when nil the key is removed
+    #   @return [Object, nil] new value or nil
+    #   @!macro map.atomic_method_with_block
+
+    # @!method compute(key)
+    #   Compute and store new value for key.
+    #   @param [Object] key
+    #   @yield compute new value from old one
+    #   @yieldparam old_value [Object, nil] old_value, or nil when key is absent
+    #   @yieldreturn [Object, nil] new value, when nil the key is removed
+    #   @return [Object, nil] new value or nil
+    #   @!macro map.atomic_method_with_block
+
+    # @!method merge_pair(key, value)
+    #   If the key is absent, the value is stored, otherwise new value is
+    #   computed with a block.
+    #   @param [Object] key
+    #   @param [Object] value
+    #   @yield compute new value from old one
+    #   @yieldparam old_value [Object] old value
+    #   @yieldreturn [Object, nil] new value, when nil the key is removed
+    #   @return [Object, nil] new value or nil
+    #   @!macro map.atomic_method_with_block
+
+    # @!method replace_pair(key, old_value, new_value)
+    #   Replaces old_value with new_value if key exists and current value
+    #   matches old_value
+    #   @param [Object] key
+    #   @param [Object] old_value
+    #   @param [Object] new_value
+    #   @return [true, false] true if replaced
+    #   @!macro map.atomic_method
+
+    # @!method replace_if_exists(key, new_value)
+    #   Replaces current value with new_value if key exists
+    #   @param [Object] key
+    #   @param [Object] new_value
+    #   @return [Object, nil] old value or nil
+    #   @!macro map.atomic_method
+
+    # @!method get_and_set(key, value)
+    #   Get the current value under key and set new value.
+    #   @param [Object] key
+    #   @param [Object] value
+    #   @return [Object, nil] old value or nil when the key was absent
+    #   @!macro map.atomic_method
+
+    # @!method delete(key)
+    #   Delete key and its value.
+    #   @param [Object] key
+    #   @return [Object, nil] old value or nil when the key was absent
+    #   @!macro map.atomic_method
+
+    # @!method delete_pair(key, value)
+    #   Delete pair and its value if current value equals the provided value.
+    #   @param [Object] key
+    #   @param [Object] value
+    #   @return [true, false] true if deleted
+    #   @!macro map.atomic_method
+
+
+    def initialize(options = nil, &block)
+      if options.kind_of?(::Hash)
+        validate_options_hash!(options)
+      else
+        options = nil
+      end
+
+      super(options)
+      @default_proc = block
+    end
+
+    # Get a value with key
+    # @param [Object] key
+    # @return [Object] the value
+    def [](key)
+      if value = super # non-falsy value is an existing mapping, return it right away
+        value
+        # re-check is done with get_or_default(key, NULL) instead of a simple !key?(key) in order to avoid a race condition, whereby by the time the current thread gets to the key?(key) call
+        # a key => value mapping might have already been created by a different thread (key?(key) would then return true, this elsif branch wouldn't be taken and an incorrent +nil+ value
+        # would be returned)
+        # note: nil == value check is not technically necessary
+      elsif @default_proc && nil == value && NULL == (value = get_or_default(key, NULL))
+        @default_proc.call(self, key)
+      else
+        value
+      end
+    end
+
+    alias_method :get, :[]
+    # TODO (pitr-ch 30-Oct-2018): doc
+    alias_method :put, :[]=
+
+    # Get a value with key, or default_value when key is absent,
+    # or fail when no default_value is given.
+    # @param [Object] key
+    # @param [Object] default_value
+    # @yield default value for a key
+    # @yieldparam key [Object]
+    # @yieldreturn [Object] default value
+    # @return [Object] the value or default value
+    # @raise [KeyError] when key is missing and no default_value is provided
+    # @!macro map_method_not_atomic
+    #   @note The "fetch-then-act" methods of `Map` are not atomic. `Map` is intended
+    #     to be use as a concurrency primitive with strong happens-before
+    #     guarantees. It is not intended to be used as a high-level abstraction
+    #     supporting complex operations. All read and write operations are
+    #     thread safe, but no guarantees are made regarding race conditions
+    #     between the fetch operation and yielding to the block. Additionally,
+    #     this method does not support recursion. This is due to internal
+    #     constraints that are very unlikely to change in the near future.
+    def fetch(key, default_value = NULL)
+      if NULL != (value = get_or_default(key, NULL))
+        value
+      elsif block_given?
+        yield key
+      elsif NULL != default_value
+        default_value
+      else
+        raise_fetch_no_key
+      end
+    end
+
+    # Fetch value with key, or store default value when key is absent,
+    # or fail when no default_value is given. This is a two step operation,
+    # therefore not atomic. The store can overwrite other concurrently
+    # stored value.
+    # @param [Object] key
+    # @param [Object] default_value
+    # @yield default value for a key
+    # @yieldparam key [Object]
+    # @yieldreturn [Object] default value
+    # @return [Object] the value or default value
+    # @!macro map.atomic_method_with_block
+    def fetch_or_store(key, default_value = NULL)
+      fetch(key) do
+        put(key, block_given? ? yield(key) : (NULL == default_value ? raise_fetch_no_key : default_value))
+      end
+    end
+
+    # Insert value into map with key if key is absent in one atomic step.
+    # @param [Object] key
+    # @param [Object] value
+    # @return [Object, nil] the previous value when key was present or nil when there was no key
+    def put_if_absent(key, value)
+      computed = false
+      result   = compute_if_absent(key) do
+        computed = true
+        value
+      end
+      computed ? nil : result
+    end unless method_defined?(:put_if_absent)
+
+    # Is the value stored in the map. Iterates over all values.
+    # @param [Object] value
+    # @return [true, false]
+    def value?(value)
+      each_value do |v|
+        return true if value.equal?(v)
+      end
+      false
+    end
+
+    # All keys
+    # @return [::Array<Object>] keys
+    def keys
+      arr = []
+      each_pair { |k, v| arr << k }
+      arr
+    end unless method_defined?(:keys)
+
+    # All values
+    # @return [::Array<Object>] values
+    def values
+      arr = []
+      each_pair { |k, v| arr << v }
+      arr
+    end unless method_defined?(:values)
+
+    # Iterates over each key.
+    # @yield for each key in the map
+    # @yieldparam key [Object]
+    # @return [self]
+    # @!macro map.atomic_method_with_block
+    def each_key
+      each_pair { |k, v| yield k }
+    end unless method_defined?(:each_key)
+
+    # Iterates over each value.
+    # @yield for each value in the map
+    # @yieldparam value [Object]
+    # @return [self]
+    # @!macro map.atomic_method_with_block
+    def each_value
+      each_pair { |k, v| yield v }
+    end unless method_defined?(:each_value)
+
+    # Iterates over each key value pair.
+    # @yield for each key value pair in the map
+    # @yieldparam key [Object]
+    # @yieldparam value [Object]
+    # @return [self]
+    # @!macro map.atomic_method_with_block
+    def each_pair
+      return enum_for :each_pair unless block_given?
+      super
+    end
+
+    alias_method :each, :each_pair unless method_defined?(:each)
+
+    # Find key of a value.
+    # @param [Object] value
+    # @return [Object, nil] key or nil when not found
+    def key(value)
+      each_pair { |k, v| return k if v == value }
+      nil
+    end unless method_defined?(:key)
+    alias_method :index, :key if RUBY_VERSION < '1.9'
+
+    # Is map empty?
+    # @return [true, false]
+    def empty?
+      each_pair { |k, v| return false }
+      true
+    end unless method_defined?(:empty?)
+
+    # The size of map.
+    # @return [Integer] size
+    def size
+      count = 0
+      each_pair { |k, v| count += 1 }
+      count
+    end unless method_defined?(:size)
+
+    # @!visibility private
+    def marshal_dump
+      raise TypeError, "can't dump hash with default proc" if @default_proc
+      h = {}
+      each_pair { |k, v| h[k] = v }
+      h
+    end
+
+    # @!visibility private
+    def marshal_load(hash)
+      initialize
+      populate_from(hash)
+    end
+
+    undef :freeze
+
+    # @!visibility private
+    def inspect
+      format '%s entries=%d default_proc=%s>', to_s[0..-2], size.to_s, @default_proc.inspect
+    end
+
+    private
+
+    def raise_fetch_no_key
+      raise KeyError, 'key not found'
+    end
+
+    def initialize_copy(other)
+      super
+      populate_from(other)
+    end
+
+    def populate_from(hash)
+      hash.each_pair { |k, v| self[k] = v }
+      self
+    end
+
+    def validate_options_hash!(options)
+      if (initial_capacity = options[:initial_capacity]) && (!initial_capacity.kind_of?(Integer) || initial_capacity < 0)
+        raise ArgumentError, ":initial_capacity must be a positive Integer"
+      end
+      if (load_factor = options[:load_factor]) && (!load_factor.kind_of?(Numeric) || load_factor <= 0 || load_factor > 1)
+        raise ArgumentError, ":load_factor must be a number between 0 and 1"
+      end
+    end
+  end
+end