concurrent-ruby 0.7.0.rc0-x86-linux

data/lib/concurrent/promise.rb

@@ -0,0 +1,169 @@
+require 'thread'
+
+require 'concurrent/obligation'
+require 'concurrent/options_parser'
+
+module Concurrent
+
+  class Promise
+    include Obligation
+
+    # Initialize a new Promise with the provided options.
+    #
+    # @param [Hash] opts the options used to define the behavior at update and deref
+    #
+    # @option opts [Promise] :parent the parent `Promise` when building a chain/tree
+    # @option opts [Proc] :on_fulfill fulfillment handler
+    # @option opts [Proc] :on_reject rejection handler
+    #
+    # @option opts [Boolean] :operation (false) when `true` will execute the future on the global
+    #   operation pool (for long-running operations), when `false` will execute the future on the
+    #   global task pool (for short-running tasks)
+    # @option opts [object] :executor when provided will run all operations on
+    #   this executor rather than the global thread pool (overrides :operation)
+    #
+    # @option opts [String] :dup_on_deref (false) call `#dup` before returning the data
+    # @option opts [String] :freeze_on_deref (false) call `#freeze` before returning the data
+    # @option opts [String] :copy_on_deref (nil) call the given `Proc` passing the internal value and
+    #   returning the value returned from the proc
+    #
+    # @see http://wiki.commonjs.org/wiki/Promises/A
+    # @see http://promises-aplus.github.io/promises-spec/
+    def initialize(opts = {}, &block)
+      opts.delete_if { |k, v| v.nil? }
+
+      @executor = OptionsParser::get_executor_from(opts)
+      @parent = opts.fetch(:parent) { nil }
+      @on_fulfill = opts.fetch(:on_fulfill) { Proc.new { |result| result } }
+      @on_reject = opts.fetch(:on_reject) { Proc.new { |reason| raise reason } }
+
+      @promise_body = block || Proc.new { |result| result }
+      @state = :unscheduled
+      @children = []
+
+      init_obligation
+    end
+
+    # @return [Promise]
+    def self.fulfill(value, opts = {})
+      Promise.new(opts).tap { |p| p.send(:synchronized_set_state!, true, value, nil) }
+    end
+
+
+    # @return [Promise]
+    def self.reject(reason, opts = {})
+      Promise.new(opts).tap { |p| p.send(:synchronized_set_state!, false, nil, reason) }
+    end
+
+    # @return [Promise]
+    # @since 0.5.0
+    def execute
+      if root?
+        if compare_and_set_state(:pending, :unscheduled)
+          set_pending
+          realize(@promise_body)
+        end
+      else
+        @parent.execute
+      end
+      self
+    end
+
+    # @since 0.5.0
+    def self.execute(opts = {}, &block)
+      new(opts, &block).execute
+    end
+
+    # @return [Promise] the new promise
+    def then(rescuer = nil, &block)
+      raise ArgumentError.new('rescuers and block are both missing') if rescuer.nil? && !block_given?
+      block = Proc.new { |result| result } if block.nil?
+      child = Promise.new(
+        parent: self,
+        executor: @executor,
+        on_fulfill: block,
+        on_reject: rescuer
+      )
+
+      mutex.synchronize do
+        child.state = :pending if @state == :pending
+        child.on_fulfill(apply_deref_options(@value)) if @state == :fulfilled
+        child.on_reject(@reason) if @state == :rejected
+        @children << child
+      end
+
+      child
+    end
+
+    # @return [Promise]
+    def on_success(&block)
+      raise ArgumentError.new('no block given') unless block_given?
+      self.then &block
+    end
+
+    # @return [Promise]
+    def rescue(&block)
+      self.then(block)
+    end
+
+    alias_method :catch, :rescue
+    alias_method :on_error, :rescue
+
+    protected
+
+    def set_pending
+      mutex.synchronize do
+        @state = :pending
+        @children.each { |c| c.set_pending }
+      end
+    end
+
+    # @!visibility private
+    def root? # :nodoc:
+      @parent.nil?
+    end
+
+    # @!visibility private
+    def on_fulfill(result)
+      realize Proc.new { @on_fulfill.call(result) }
+      nil
+    end
+
+    # @!visibility private
+    def on_reject(reason)
+      realize Proc.new { @on_reject.call(reason) }
+      nil
+    end
+
+    def notify_child(child)
+      if_state(:fulfilled) { child.on_fulfill(apply_deref_options(@value)) }
+      if_state(:rejected) { child.on_reject(@reason) }
+    end
+
+    # @!visibility private
+    def realize(task)
+      @executor.post do
+        success, value, reason = SafeTaskExecutor.new(task).execute
+
+        children_to_notify = mutex.synchronize do
+          set_state!(success, value, reason)
+          @children.dup
+        end
+
+        children_to_notify.each { |child| notify_child(child) }
+      end
+    end
+
+    def set_state!(success, value, reason)
+      set_state(success, value, reason)
+      event.set
+    end
+
+    def synchronized_set_state!(success, value, reason)
+      mutex.lock
+      set_state!(success, value, reason)
+    ensure
+      mutex.unlock
+    end
+  end
+end

data/lib/concurrent/scheduled_task.rb

@@ -0,0 +1,78 @@
+require 'concurrent/ivar'
+require 'concurrent/utility/timer'
+require 'concurrent/executor/safe_task_executor'
+
+module Concurrent
+
+  class ScheduledTask < IVar
+
+    attr_reader :schedule_time
+
+    def initialize(intended_time, opts = {}, &block)
+      raise ArgumentError.new('no block given') unless block_given?
+      TimerSet.calculate_schedule_time(intended_time) # raises exceptons
+
+      super(NO_VALUE, opts)
+
+      self.observers = CopyOnNotifyObserverSet.new
+      @intended_time =  intended_time
+      @state = :unscheduled
+      @task = block
+    end
+
+    # @since 0.5.0
+    def execute
+      if compare_and_set_state(:pending, :unscheduled)
+        @schedule_time = TimerSet.calculate_schedule_time(@intended_time)
+        Concurrent::timer(@schedule_time.to_f - Time.now.to_f, &method(:process_task))
+        self
+      end
+    end
+
+    # @since 0.5.0
+    def self.execute(intended_time, opts = {}, &block)
+      return ScheduledTask.new(intended_time, opts, &block).execute
+    end
+
+    def cancelled?
+      state == :cancelled
+    end
+
+    def in_progress?
+      state == :in_progress
+    end
+
+    def cancel
+      if_state(:unscheduled, :pending) do
+        @state = :cancelled
+        event.set
+        true
+      end
+    end
+    alias_method :stop, :cancel
+
+    def add_observer(*args, &block)
+      if_state(:unscheduled, :pending, :in_progress) do
+        observers.add_observer(*args, &block)
+      end
+    end
+
+    protected :set, :fail, :complete
+
+    private
+
+    def process_task
+      if compare_and_set_state(:in_progress, :pending)
+        success, val, reason = SafeTaskExecutor.new(@task).execute
+
+        mutex.synchronize do
+          set_state(success, val, reason)
+          event.set
+        end
+
+        time = Time.now
+        observers.notify_and_delete_observers{ [time, self.value, reason] }
+      end
+    end
+  end
+end

data/lib/concurrent/supervisor.rb

@@ -0,0 +1,343 @@
+require 'thread'
+
+require 'concurrent/errors'
+
+module Concurrent
+
+  class Supervisor
+
+    DEFAULT_MONITOR_INTERVAL = 1
+    RESTART_STRATEGIES = [:one_for_one, :one_for_all, :rest_for_one]
+    DEFAULT_MAX_RESTART = 5
+    DEFAULT_MAX_TIME = 60
+    WORKER_API = {run: 0, stop: 0, running?: 0}
+
+    CHILD_TYPES = [:worker, :supervisor]
+    CHILD_RESTART_OPTIONS = [:permanent, :transient, :temporary]
+
+    WorkerContext = Struct.new(:worker, :type, :restart) do
+      attr_accessor :thread
+      attr_accessor :terminated
+
+      def alive?() return thread && thread.alive?; end
+
+      def needs_restart?
+        return false if thread && thread.alive?
+        return false if terminated
+        case self.restart
+        when :permanent
+          return true
+        when :transient
+          return thread.nil? || thread.status.nil?
+        else #when :temporary
+          return false
+        end
+      end
+    end
+
+    WorkerCounts = Struct.new(:specs, :supervisors, :workers) do
+      attr_accessor :status
+      def add(context)
+        self.specs += 1
+        self.supervisors += 1 if context.type == :supervisor
+        self.workers += 1 if context.type == :worker
+      end
+      def active() sleeping + running + aborting end
+      def sleeping() @status.reduce(0){|x, s| x += (s == 'sleep' ? 1 : 0) } end
+      def running() @status.reduce(0){|x, s| x += (s == 'run' ? 1 : 0) } end
+      def aborting() @status.reduce(0){|x, s| x += (s == 'aborting' ? 1 : 0) } end
+      def stopped() @status.reduce(0){|x, s| x += (s == false ? 1 : 0) } end
+      def abend() @status.reduce(0){|x, s| x += (s.nil? ? 1 : 0) } end
+    end
+
+    attr_reader :monitor_interval
+    attr_reader :restart_strategy
+    attr_reader :max_restart
+    attr_reader :max_time
+
+    alias_method :strategy, :restart_strategy
+    alias_method :max_r, :max_restart
+    alias_method :max_t, :max_time
+
+    def initialize(opts = {})
+      warn '[EXPERIMENTAL] Supervisor is being completely rewritten and will change soon.'
+      @restart_strategy = opts[:restart_strategy] || opts[:strategy] || :one_for_one
+      @monitor_interval = (opts[:monitor_interval] || DEFAULT_MONITOR_INTERVAL).to_f
+      @max_restart = (opts[:max_restart] || opts[:max_r] || DEFAULT_MAX_RESTART).to_i
+      @max_time = (opts[:max_time] || opts[:max_t] || DEFAULT_MAX_TIME).to_i
+
+      raise ArgumentError.new(":#{@restart_strategy} is not a valid restart strategy") unless RESTART_STRATEGIES.include?(@restart_strategy)
+      raise ArgumentError.new(':monitor_interval must be greater than zero') unless @monitor_interval > 0.0
+      raise ArgumentError.new(':max_restart must be greater than zero') unless @max_restart > 0
+      raise ArgumentError.new(':max_time must be greater than zero') unless @max_time > 0
+
+      @running = false
+      @mutex = Mutex.new
+      @workers = []
+      @monitor = nil
+
+      @count = WorkerCounts.new(0, 0, 0)
+      @restart_times = []
+
+      add_worker(opts[:worker]) unless opts[:worker].nil?
+      add_workers(opts[:workers]) unless opts[:workers].nil?
+    end
+
+    def run!
+      @mutex.synchronize do
+        raise StandardError.new('already running') if @running
+        @running = true
+        @monitor = Thread.new do
+          Thread.current.abort_on_exception = false
+          monitor
+        end
+      end
+      Thread.pass
+    end
+
+    def run
+      @mutex.synchronize do
+        raise StandardError.new('already running') if @running
+        @running = true
+      end
+      monitor
+      true
+    end
+
+    def stop
+      @mutex.synchronize do
+        return true unless @running
+
+        @running = false
+        unless @monitor.nil?
+          @monitor.run if @monitor.status == 'sleep'
+          if @monitor.join(0.1).nil?
+            @monitor.kill
+          end
+          @monitor = nil
+        end
+        @restart_times.clear
+
+        @workers.length.times do |i|
+          context = @workers[-1-i]
+          terminate_worker(context)
+        end
+        prune_workers
+      end
+
+      true
+    end
+
+    def running?
+      @mutex.synchronize { @running }
+    end
+
+    def length
+      @mutex.synchronize { @workers.length }
+    end
+    alias_method :size, :length
+
+    def current_restart_count
+      @restart_times.length
+    end
+
+    def count
+      @mutex.synchronize do
+        @count.status = @workers.collect{|w| w.thread ? w.thread.status : false }
+        @count.dup.freeze
+      end
+    end
+
+    def add_worker(worker, opts = {})
+      return nil if worker.nil? || ! behaves_as_worker?(worker)
+      @mutex.synchronize {
+        restart = opts[:restart] || :permanent
+        type = opts[:type] || (worker.is_a?(Supervisor) ? :supervisor : nil) || :worker
+        raise ArgumentError.new(":#{restart} is not a valid restart option") unless CHILD_RESTART_OPTIONS.include?(restart)
+        raise ArgumentError.new(":#{type} is not a valid child type") unless CHILD_TYPES.include?(type)
+        context = WorkerContext.new(worker, type, restart)
+        @workers << context
+        @count.add(context)
+        worker.run if @running
+        context.object_id
+      }
+    end
+    alias_method :add_child, :add_worker
+
+    def add_workers(workers, opts = {})
+      workers.collect do |worker|
+        add_worker(worker, opts)
+      end
+    end
+    alias_method :add_children, :add_workers
+
+    def remove_worker(worker_id)
+      @mutex.synchronize do
+        index, context = find_worker(worker_id)
+        break(nil) if context.nil?
+        break(false) if context.alive?
+        @workers.delete_at(index)
+        context.worker
+      end
+    end
+    alias_method :remove_child, :remove_worker
+
+    def stop_worker(worker_id)
+      @mutex.synchronize do
+        return true unless @running
+
+        index, context = find_worker(worker_id)
+        break(nil) if index.nil?
+        context.terminated = true
+        terminate_worker(context)
+        @workers.delete_at(index) if @workers[index].restart == :temporary
+        true
+      end
+    end
+    alias_method :stop_child, :stop_worker
+
+    def start_worker(worker_id)
+      @mutex.synchronize do
+        return false unless @running
+
+        index, context = find_worker(worker_id)
+        break(nil) if context.nil?
+        context.terminated = false
+        run_worker(context) unless context.alive?
+        true
+      end
+    end
+    alias_method :start_child, :start_worker
+
+    def restart_worker(worker_id)
+      @mutex.synchronize do
+        return false unless @running
+
+        index, context = find_worker(worker_id)
+        break(nil) if context.nil?
+        break(false) if context.restart == :temporary
+        context.terminated = false
+        terminate_worker(context)
+        run_worker(context)
+        true
+      end
+    end
+    alias_method :restart_child, :restart_worker
+
+    private
+
+    def behaves_as_worker?(obj)
+      WORKER_API.each do |method, arity|
+        break(false) unless obj.respond_to?(method) && obj.method(method).arity == arity
+        true
+      end
+    end
+
+    def monitor
+      @workers.each{|context| run_worker(context)}
+      loop do
+        sleep(@monitor_interval)
+        break unless running?
+        @mutex.synchronize do
+          prune_workers
+          self.send(@restart_strategy)
+        end
+        break unless running?
+      end
+    rescue MaxRestartFrequencyError => ex
+      stop
+    end
+
+    def run_worker(context)
+      context.thread = Thread.new do
+        Thread.current.abort_on_exception = false
+        context.worker.run
+      end
+      context
+    end
+
+    def terminate_worker(context)
+      if context.alive?
+        context.worker.stop
+        Thread.pass
+      end
+    rescue Exception => ex
+      begin
+        Thread.kill(context.thread)
+      rescue
+        # suppress
+      end
+    ensure
+      context.thread = nil
+    end
+
+    def prune_workers
+      @workers.delete_if{|w| w.restart == :temporary && ! w.alive? }
+    end
+
+    def find_worker(worker_id)
+      index = @workers.find_index{|worker| worker.object_id == worker_id}
+      if index.nil?
+        [nil, nil]
+      else
+        [index, @workers[index]]
+      end
+    end
+
+    def exceeded_max_restart_frequency?
+      @restart_times.unshift(Time.now.to_i)
+      diff = (@restart_times.first - @restart_times.last).abs
+      if @restart_times.length >= @max_restart && diff <= @max_time
+        return true
+      elsif diff >= @max_time
+        @restart_times.pop
+      end
+      false
+    end
+
+    #----------------------------------------------------------------
+    # restart strategies
+
+    def one_for_one
+      @workers.each do |context|
+        if context.needs_restart?
+          raise MaxRestartFrequencyError if exceeded_max_restart_frequency?
+          run_worker(context)
+        end
+      end
+    end
+
+    def one_for_all
+      restart = false
+
+      restart = @workers.each do |context|
+        if context.needs_restart?
+          raise MaxRestartFrequencyError if exceeded_max_restart_frequency?
+          break(true)
+        end
+      end
+
+      if restart
+        @workers.each do |context|
+          terminate_worker(context)
+        end
+        @workers.each{|context| run_worker(context)}
+      end
+    end
+
+    def rest_for_one
+      restart = false
+
+      @workers.each do |context|
+        if restart
+          terminate_worker(context)
+        elsif context.needs_restart?
+          raise MaxRestartFrequencyError if exceeded_max_restart_frequency?
+          restart = true
+        end
+      end
+
+      one_for_one if restart
+    end
+  end
+end