concurrent-ruby 0.7.0-java

data/lib/concurrent/executor/ruby_thread_pool_executor.rb

@@ -0,0 +1,288 @@
+require 'thread'
+
+require_relative 'executor'
+require 'concurrent/atomic/event'
+require 'concurrent/executor/ruby_thread_pool_worker'
+
+module Concurrent
+
+  # @!macro thread_pool_executor
+  class RubyThreadPoolExecutor
+    include RubyExecutor
+
+    # Default maximum number of threads that will be created in the pool.
+    DEFAULT_MAX_POOL_SIZE = 2**15 # 32768
+
+    # Default minimum number of threads that will be retained in the pool.
+    DEFAULT_MIN_POOL_SIZE = 0
+
+    # Default maximum number of tasks that may be added to the task queue.
+    DEFAULT_MAX_QUEUE_SIZE = 0
+
+    # Default maximum number of seconds a thread in the pool may remain idle
+    # before being reclaimed.
+    DEFAULT_THREAD_IDLETIMEOUT = 60
+
+    # The set of possible overflow policies that may be set at thread pool creation.
+    OVERFLOW_POLICIES = [:abort, :discard, :caller_runs]
+
+    # The maximum number of threads that may be created in the pool.
+    attr_reader :max_length
+
+    # The minimum number of threads that may be retained in the pool.
+    attr_reader :min_length
+
+    # The largest number of threads that have been created in the pool since construction.
+    attr_reader :largest_length
+
+    # The number of tasks that have been scheduled for execution on the pool since construction.
+    attr_reader :scheduled_task_count
+
+    # The number of tasks that have been completed by the pool since construction.
+    attr_reader :completed_task_count
+
+    # The number of seconds that a thread may be idle before being reclaimed.
+    attr_reader :idletime
+
+    # The maximum number of tasks that may be waiting in the work queue at any one time.
+    # When the queue size reaches `max_queue` subsequent tasks will be rejected in
+    # accordance with the configured `overflow_policy`.
+    attr_reader :max_queue
+
+    # The policy defining how rejected tasks (tasks received once the queue size reaches
+    # the configured `max_queue`) are handled. Must be one of the values specified in
+    # `OVERFLOW_POLICIES`.
+    attr_reader :overflow_policy
+
+    # 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) the minimum
+    #   number of threads to be retained
+    # @option opts [Integer] :idletime (DEFAULT_THREAD_IDLETIMEOUT) the maximum
+    #   number of seconds a thread may be idle before being reclaimed
+    # @option opts [Integer] :max_queue (DEFAULT_MAX_QUEUE_SIZE) the maximum
+    #   number of tasks allowed in the work queue at any one time; a value of
+    #   zero means the queue may grow without bounnd
+    # @option opts [Symbol] :overflow_policy (:abort) the policy for handling new
+    #   tasks that are received when the queue size has reached `max_queue`
+    #
+    # @raise [ArgumentError] if `:max_threads` is less than one
+    # @raise [ArgumentError] if `:min_threads` is less than zero
+    # @raise [ArgumentError] if `:overflow_policy` is not one of the values specified
+    #   in `OVERFLOW_POLICIES`
+    #
+    # @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ThreadPoolExecutor.html
+    def initialize(opts = {})
+      @min_length = opts.fetch(:min_threads, DEFAULT_MIN_POOL_SIZE).to_i
+      @max_length = opts.fetch(:max_threads, DEFAULT_MAX_POOL_SIZE).to_i
+      @idletime = opts.fetch(:idletime, DEFAULT_THREAD_IDLETIMEOUT).to_i
+      @max_queue = opts.fetch(:max_queue, DEFAULT_MAX_QUEUE_SIZE).to_i
+      @overflow_policy = opts.fetch(:overflow_policy, :abort)
+
+      raise ArgumentError.new('max_threads must be greater than zero') if @max_length <= 0
+      raise ArgumentError.new('min_threads cannot be less than zero') if @min_length < 0
+      raise ArgumentError.new("#{overflow_policy} is not a valid overflow policy") unless OVERFLOW_POLICIES.include?(@overflow_policy)
+      raise ArgumentError.new('min_threads cannot be more than max_threads') if min_length > max_length
+
+      init_executor
+
+      @pool = []
+      @queue = Queue.new
+      @scheduled_task_count = 0
+      @completed_task_count = 0
+      @largest_length = 0
+
+      @gc_interval = opts.fetch(:gc_interval, 1).to_i # undocumented
+      @last_gc_time = Time.now.to_f - [1.0, (@gc_interval * 2.0)].max
+    end
+
+    # @!macro executor_module_method_can_overflow_question
+    def can_overflow?
+      @max_queue != 0
+    end
+
+    # The number of threads currently in the pool.
+    #
+    # @return [Integer] the length
+    def length
+      mutex.synchronize{ running? ? @pool.length : 0 }
+    end
+    alias_method :current_length, :length
+
+    # The number of tasks in the queue awaiting execution.
+    #
+    # @return [Integer] the queue_length
+    def queue_length
+      mutex.synchronize{ running? ? @queue.length : 0 }
+    end
+
+    # Number of tasks that may be enqueued before reaching `max_queue` and rejecting
+    # new tasks. A value of -1 indicates that the queue may grow without bound.
+    #
+    # @return [Integer] the remaining_capacity
+    def remaining_capacity
+      mutex.synchronize { @max_queue == 0 ? -1 : @max_queue - @queue.length }
+    end
+
+    # Returns an array with the status of each thread in the pool
+    #
+    # This method is deprecated and will be removed soon.
+    def status
+      warn '[DEPRECATED] `status` is deprecated and will be removed soon.'
+      mutex.synchronize { @pool.collect { |worker| worker.status } }
+    end
+
+    # Run on task completion.
+    #
+    # @!visibility private
+    def on_end_task
+      mutex.synchronize do
+        @completed_task_count += 1 #if success
+        break unless running?
+      end
+    end
+
+    # Run when a thread worker exits.
+    #
+    # @!visibility private
+    def on_worker_exit(worker)
+      mutex.synchronize do
+        @pool.delete(worker)
+        if @pool.empty? && ! running?
+          stop_event.set
+          stopped_event.set
+        end
+      end
+    end
+
+    protected
+
+    # @!visibility private
+    def execute(*args, &task)
+      prune_pool
+      if ensure_capacity?
+        @scheduled_task_count += 1
+        @queue << [args, task]
+      else
+        handle_overflow(*args, &task) if @max_queue != 0 && @queue.length >= @max_queue
+      end
+    end
+
+    # @!visibility private
+    def shutdown_execution
+      if @pool.empty?
+        stopped_event.set
+      else
+        @pool.length.times{ @queue << :stop }
+      end
+    end
+
+    # @!visibility private
+    def kill_execution
+      @queue.clear
+      drain_pool
+    end
+
+    # Check the thread pool configuration and determine if the pool
+    # has enought capacity to handle the request. Will grow the size
+    # of the pool if necessary.
+    #
+    # @return [Boolean] true if the pool has enough capacity else false
+    #
+    # @!visibility private
+    def ensure_capacity?
+      additional = 0
+      capacity = true
+
+      if @pool.size < @min_length
+        additional = @min_length - @pool.size
+      elsif @queue.empty? && @queue.num_waiting >= 1
+        additional = 0
+      elsif @pool.size == 0 && @min_length == 0
+        additional = 1
+      elsif @pool.size < @max_length || @max_length == 0
+        additional = 1
+      elsif @max_queue == 0 || @queue.size < @max_queue
+        additional = 0
+      else
+        capacity = false
+      end
+
+      additional.times do
+        @pool << create_worker_thread
+      end
+
+      if additional > 0
+        @largest_length = [@largest_length, @pool.length].max
+      end
+
+      capacity
+    end
+
+    # Handler which executes the `overflow_policy` once the queue size
+    # reaches `max_queue`.
+    #
+    # @param [Array] args the arguments to the task which is being handled.
+    #
+    # @!visibility private
+    def handle_overflow(*args)
+      case @overflow_policy
+      when :abort
+        raise RejectedExecutionError
+      when :discard
+        false
+      when :caller_runs
+        begin
+          yield(*args)
+        rescue => ex
+          # let it fail
+          log DEBUG, ex
+        end
+        true
+      end
+    end
+
+    # Scan all threads in the pool and reclaim any that are dead or
+    # have been idle too long. Will check the last time the pool was
+    # pruned and only run if the configured garbage collection
+    # interval has passed.
+    #
+    # @!visibility private
+    def prune_pool
+      if Time.now.to_f - @gc_interval >= @last_gc_time
+        @pool.delete_if do |worker|
+          worker.dead? ||
+            (@idletime == 0 ? false : Time.now.to_f - @idletime > worker.last_activity)
+        end
+        @last_gc_time = Time.now.to_f
+      end
+    end
+
+    # Reclaim all threads in the pool.
+    #
+    # @!visibility private
+    def drain_pool
+      @pool.each {|worker| worker.kill }
+      @pool.clear
+    end
+
+    # Create a single worker thread to be added to the pool.
+    #
+    # @return [Thread] the new thread.
+    #
+    # @!visibility private
+    def create_worker_thread
+      wrkr = RubyThreadPoolWorker.new(@queue, self)
+      Thread.new(wrkr, self) do |worker, parent|
+        Thread.current.abort_on_exception = false
+        worker.run
+        parent.on_worker_exit(worker)
+      end
+      return wrkr
+    end
+  end
+end

data/lib/concurrent/executor/ruby_thread_pool_worker.rb

@@ -0,0 +1,72 @@
+require 'thread'
+require 'concurrent/logging'
+
+module Concurrent
+
+  # @!visibility private
+  class RubyThreadPoolWorker
+    include Logging
+
+    # @!visibility private
+    def initialize(queue, parent)
+      @queue = queue
+      @parent = parent
+      @mutex = Mutex.new
+      @last_activity = Time.now.to_f
+    end
+
+    # @!visibility private
+    def dead?
+      return @mutex.synchronize do
+        @thread.nil? ? false : ! @thread.alive?
+      end
+    end
+
+    # @!visibility private
+    def last_activity
+      @mutex.synchronize { @last_activity }
+    end
+
+    def status
+      @mutex.synchronize do
+        return 'not running' if @thread.nil?
+        @thread.status
+      end
+    end
+
+    # @!visibility private
+    def kill
+      @mutex.synchronize do
+        Thread.kill(@thread) unless @thread.nil?
+        @thread = nil
+      end
+    end
+
+    # @!visibility private
+    def run(thread = Thread.current)
+      @mutex.synchronize do
+        raise StandardError.new('already running') unless @thread.nil?
+        @thread = thread
+      end
+
+      loop do
+        task = @queue.pop
+        if task == :stop
+          @thread = nil
+          @parent.on_worker_exit(self)
+          break
+        end
+
+        begin
+          task.last.call(*task.first)
+        rescue => ex
+          # let it fail
+          log DEBUG, ex
+        ensure
+          @last_activity = Time.now.to_f
+          @parent.on_end_task
+        end
+      end
+    end
+  end
+end

data/lib/concurrent/executor/safe_task_executor.rb

@@ -0,0 +1,35 @@
+require 'thread'
+
+module Concurrent
+
+  # A simple utility class that executes a callable and returns and array of three elements:
+  # success - indicating if the callable has been executed without errors
+  # value - filled by the callable result if it has been executed without errors, nil otherwise
+  # reason - the error risen by the callable if it has been executed with errors, nil otherwise
+  class SafeTaskExecutor
+
+    def initialize(task, opts = {})
+      @task = task
+      @mutex = Mutex.new
+      @exception_class = opts.fetch(:rescue_exception, false) ? Exception : StandardError
+    end
+
+    # @return [Array]
+    def execute(*args)
+      @mutex.synchronize do
+        success = false
+        value = reason = nil
+
+        begin
+          value = @task.call(*args)
+          success = true
+        rescue @exception_class => ex
+          reason = ex
+          success = false
+        end
+
+        [success, value, reason]
+      end
+    end
+  end
+end

data/lib/concurrent/executor/serialized_execution.rb

@@ -0,0 +1,126 @@
+require 'delegate'
+require 'concurrent/executor/executor'
+require 'concurrent/logging'
+require 'concurrent/atomic/synchronization'
+
+module Concurrent
+
+  # Ensures passed jobs in a serialized order never running at the same time.
+  class SerializedExecution
+    include Logging
+    include Synchronization
+
+    Job = Struct.new(:executor, :args, :block) do
+      def call
+        block.call *args
+      end
+    end
+
+    def initialize
+      synchronize do
+        @being_executed = false
+        @stash          = []
+      end
+    end
+
+    # Submit a task to the executor for asynchronous processing.
+    #
+    # @param [Executor] executor to be used for this job
+    #
+    # @param [Array] args zero or more arguments to be passed to the task
+    #
+    # @yield the asynchronous task to perform
+    #
+    # @return [Boolean] `true` if the task is queued, `false` if the executor
+    #   is not running
+    #
+    # @raise [ArgumentError] if no task is given
+    def post(executor, *args, &task)
+      posts [[executor, args, task]]
+      true
+    end
+
+    # As {#post} but allows to submit multiple tasks at once, it's guaranteed that they will not
+    # be interleaved by other tasks.
+    #
+    # @param [Array<Array(Executor, Array<Object>, Proc)>] posts array of triplets where
+    #   first is a {Executor}, second is array of args for task, third is a task (Proc)
+    def posts(posts)
+      # if can_overflow?
+      #   raise ArgumentError, 'SerializedExecution does not support thread-pools which can overflow'
+      # end
+
+      return nil if posts.empty?
+
+      jobs = posts.map { |executor, args, task| Job.new executor, args, task }
+
+      job_to_post = synchronize do
+        if @being_executed
+          @stash.push(*jobs)
+          nil
+        else
+          @being_executed = true
+          @stash.push(*jobs[1..-1])
+          jobs.first
+        end
+      end
+
+      call_job job_to_post if job_to_post
+      true
+    end
+
+    private
+
+    def call_job(job)
+      did_it_run = begin
+        job.executor.post { work(job) }
+        true
+      rescue RejectedExecutionError => ex
+        false
+      end
+
+      # TODO not the best idea to run it myself
+      unless did_it_run
+        begin
+          work job
+        rescue => ex
+          # let it fail
+          log DEBUG, ex
+        end
+      end
+    end
+
+    # ensures next job is executed if any is stashed
+    def work(job)
+      job.call
+    ensure
+      synchronize do
+        job = @stash.shift || (@being_executed = false)
+      end
+
+      call_job job if job
+    end
+  end
+
+  # A wrapper/delegator for any `Executor` or `ExecutorService` that
+  # guarantees serialized execution of tasks.
+  #
+  # @see [SimpleDelegator](http://www.ruby-doc.org/stdlib-2.1.2/libdoc/delegate/rdoc/SimpleDelegator.html)
+  # @see Concurrent::SerializedExecution
+  class SerializedExecutionDelegator < SimpleDelegator
+    include SerialExecutor
+
+    def initialize(executor)
+      @executor   = executor
+      @serializer = SerializedExecution.new
+      super(executor)
+    end
+
+    # @!macro executor_method_post
+    def post(*args, &task)
+      raise ArgumentError.new('no block given') unless block_given?
+      return false unless running?
+      @serializer.post(@executor, *args, &task)
+    end
+  end
+end