concurrent-ruby 1.1.10 → 1.2.0

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

@@ -1,66 +0,0 @@
-require 'concurrent/constants'
-
-module Concurrent
-
-  # @!macro thread_local_var
-  # @!macro internal_implementation_note
-  # @!visibility private
-  class AbstractThreadLocalVar
-
-    # @!macro thread_local_var_method_initialize
-    def initialize(default = nil, &default_block)
-      if default && block_given?
-        raise ArgumentError, "Cannot use both value and block as default value"
-      end
-
-      if block_given?
-        @default_block = default_block
-        @default = nil
-      else
-        @default_block = nil
-        @default = default
-      end
-
-      allocate_storage
-    end
-
-    # @!macro thread_local_var_method_get
-    def value
-      raise NotImplementedError
-    end
-
-    # @!macro thread_local_var_method_set
-    def value=(value)
-      raise NotImplementedError
-    end
-
-    # @!macro thread_local_var_method_bind
-    def bind(value, &block)
-      if block_given?
-        old_value = self.value
-        begin
-          self.value = value
-          yield
-        ensure
-          self.value = old_value
-        end
-      end
-    end
-
-    protected
-
-    # @!visibility private
-    def allocate_storage
-      raise NotImplementedError
-    end
-
-    # @!visibility private
-    def default
-      if @default_block
-        self.value = @default_block.call
-      else
-        @default
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-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/ruby_thread_local_var.rb

@@ -1,181 +0,0 @@
-require 'thread'
-require 'concurrent/atomic/abstract_thread_local_var'
-
-module Concurrent
-
-  # @!visibility private
-  # @!macro internal_implementation_note
-  class RubyThreadLocalVar < AbstractThreadLocalVar
-
-    # Each thread has a (lazily initialized) array of thread-local variable values
-    # Each time a new thread-local var is created, we allocate an "index" for it
-    # For example, if the allocated index is 1, that means slot #1 in EVERY
-    #   thread's thread-local array will be used for the value of that TLV
-    #
-    # The good thing about using a per-THREAD structure to hold values, rather
-    #   than a per-TLV structure, is that no synchronization is needed when
-    #    reading and writing those values (since the structure is only ever
-    #    accessed by a single thread)
-    #
-    # Of course, when a TLV is GC'd, 1) we need to recover its index for use
-    #   by other new TLVs (otherwise the thread-local arrays could get bigger
-    #   and bigger with time), and 2) we need to null out all the references
-    #   held in the now-unused slots (both to avoid blocking GC of those objects,
-    #   and also to prevent "stale" values from being passed on to a new TLV
-    #   when the index is reused)
-    # Because we need to null out freed slots, we need to keep references to
-    #   ALL the thread-local arrays -- ARRAYS is for that
-    # But when a Thread is GC'd, we need to drop the reference to its thread-local
-    #   array, so we don't leak memory
-
-    FREE                = []
-    LOCK                = Mutex.new
-    THREAD_LOCAL_ARRAYS = {} # used as a hash set
-
-    # synchronize when not on MRI
-    # on MRI using lock in finalizer leads to "can't be called from trap context" error
-    # so the code is carefully written to be tread-safe on MRI relying on GIL
-
-    if Concurrent.on_cruby?
-      # @!visibility private
-      def self.semi_sync(&block)
-        block.call
-      end
-    else
-      # @!visibility private
-      def self.semi_sync(&block)
-        LOCK.synchronize(&block)
-      end
-    end
-
-    private_constant :FREE, :LOCK, :THREAD_LOCAL_ARRAYS
-
-    # @!macro thread_local_var_method_get
-    def value
-      if (array = get_threadlocal_array)
-        value = array[@index]
-        if value.nil?
-          default
-        elsif value.equal?(NULL)
-          nil
-        else
-          value
-        end
-      else
-        default
-      end
-    end
-
-    # @!macro thread_local_var_method_set
-    def value=(value)
-      me = Thread.current
-      # We could keep the thread-local arrays in a hash, keyed by Thread
-      # But why? That would require locking
-      # Using Ruby's built-in thread-local storage is faster
-      unless (array = get_threadlocal_array(me))
-        array = set_threadlocal_array([], me)
-        self.class.semi_sync { THREAD_LOCAL_ARRAYS[array.object_id] = array }
-        ObjectSpace.define_finalizer(me, self.class.thread_finalizer(array.object_id))
-      end
-      array[@index] = (value.nil? ? NULL : value)
-      value
-    end
-
-    protected
-
-    # @!visibility private
-    def allocate_storage
-      @index = FREE.pop || next_index
-
-      ObjectSpace.define_finalizer(self, self.class.thread_local_finalizer(@index))
-    end
-
-    # @!visibility private
-    def self.thread_local_finalizer(index)
-      proc do
-        semi_sync do
-          # The cost of GC'ing a TLV is linear in the number of threads using TLVs
-          # But that is natural! More threads means more storage is used per TLV
-          # So naturally more CPU time is required to free more storage
-          #
-          # DO NOT use each_value which might conflict with new pair assignment
-          # into the hash in #value= method
-          THREAD_LOCAL_ARRAYS.values.each { |array| array[index] = nil }
-          # free index has to be published after the arrays are cleared
-          FREE.push(index)
-        end
-      end
-    end
-
-    # @!visibility private
-    def self.thread_finalizer(id)
-      proc do
-        semi_sync do
-          # The thread which used this thread-local array is now gone
-          # So don't hold onto a reference to the array (thus blocking GC)
-          THREAD_LOCAL_ARRAYS.delete(id)
-        end
-      end
-    end
-
-    private
-
-    # noinspection RubyClassVariableUsageInspection
-    @@next = 0
-    # noinspection RubyClassVariableUsageInspection
-    def next_index
-      LOCK.synchronize do
-        result = @@next
-        @@next += 1
-        result
-      end
-    end
-
-    if Thread.instance_methods.include?(:thread_variable_get)
-
-      def get_threadlocal_array(thread = Thread.current)
-        thread.thread_variable_get(:__threadlocal_array__)
-      end
-
-      def set_threadlocal_array(array, thread = Thread.current)
-        thread.thread_variable_set(:__threadlocal_array__, array)
-      end
-
-    else
-
-      def get_threadlocal_array(thread = Thread.current)
-        thread[:__threadlocal_array__]
-      end
-
-      def set_threadlocal_array(array, thread = Thread.current)
-        thread[:__threadlocal_array__] = array
-      end
-    end
-
-    # This exists only for use in testing
-    # @!visibility private
-    def value_for(thread)
-      if (array = get_threadlocal_array(thread))
-        value = array[@index]
-        if value.nil?
-          get_default
-        elsif value.equal?(NULL)
-          nil
-        else
-          value
-        end
-      else
-        get_default
-      end
-    end
-
-    # @!visibility private
-    def get_default
-      if @default_block
-        raise "Cannot use default_for with default block"
-      else
-        @default
-      end
-    end
-  end
-end

data/lib/concurrent-ruby/concurrent/synchronization/jruby_object.rb

@@ -1,45 +0,0 @@
-module Concurrent
-  module Synchronization
-
-    if Concurrent.on_jruby? && Concurrent.java_extensions_loaded?
-
-      # @!visibility private
-      module JRubyAttrVolatile
-        def self.included(base)
-          base.extend(ClassMethods)
-        end
-
-        module ClassMethods
-          def attr_volatile(*names)
-            names.each do |name|
-
-              ivar = :"@volatile_#{name}"
-
-              class_eval <<-RUBY, __FILE__, __LINE__ + 1
-                def #{name}
-                  instance_variable_get_volatile(:#{ivar})
-                end
-
-                def #{name}=(value)
-                  instance_variable_set_volatile(:#{ivar}, value)
-                end
-              RUBY
-
-            end
-            names.map { |n| [n, :"#{n}="] }.flatten
-          end
-        end
-      end
-
-      # @!visibility private
-      # @!macro internal_implementation_note
-      class JRubyObject < AbstractObject
-        include JRubyAttrVolatile
-
-        def initialize
-          # nothing to do
-        end
-      end
-    end
-  end
-end

data/lib/concurrent-ruby/concurrent/synchronization/mri_object.rb

@@ -1,44 +0,0 @@
-module Concurrent
-  module Synchronization
-
-    # @!visibility private
-    module MriAttrVolatile
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def attr_volatile(*names)
-          names.each do |name|
-            ivar = :"@volatile_#{name}"
-            class_eval <<-RUBY, __FILE__, __LINE__ + 1
-              def #{name}
-                #{ivar}
-              end
-
-              def #{name}=(value)
-                #{ivar} = value
-              end
-            RUBY
-          end
-          names.map { |n| [n, :"#{n}="] }.flatten
-        end
-      end
-
-      def full_memory_barrier
-        # relying on undocumented behavior of CRuby, GVL acquire has lock which ensures visibility of ivars
-        # https://github.com/ruby/ruby/blob/ruby_2_2/thread_pthread.c#L204-L211
-      end
-    end
-
-    # @!visibility private
-    # @!macro internal_implementation_note
-    class MriObject < AbstractObject
-      include MriAttrVolatile
-
-      def initialize
-        # nothing to do
-      end
-    end
-  end
-end

data/lib/concurrent-ruby/concurrent/synchronization/rbx_lockable_object.rb

@@ -1,71 +0,0 @@
-module Concurrent
-  module Synchronization
-
-    # @!visibility private
-    # @!macro internal_implementation_note
-    class RbxLockableObject < AbstractLockableObject
-      safe_initialization!
-
-      def initialize(*defaults)
-        super(*defaults)
-        @__Waiters__ = []
-        @__owner__   = nil
-      end
-
-      def initialize_copy(other)
-        super
-        @__Waiters__ = []
-        @__owner__   = nil
-      end
-
-      protected
-
-      def synchronize(&block)
-        if @__owner__ == Thread.current
-          yield
-        else
-          result = nil
-          Rubinius.synchronize(self) do
-            begin
-              @__owner__ = Thread.current
-              result     = yield
-            ensure
-              @__owner__ = nil
-            end
-          end
-          result
-        end
-      end
-
-      def ns_wait(timeout = nil)
-        wchan = Rubinius::Channel.new
-
-        begin
-          @__Waiters__.push wchan
-          Rubinius.unlock(self)
-          signaled = wchan.receive_timeout timeout
-        ensure
-          Rubinius.lock(self)
-
-          if !signaled && !@__Waiters__.delete(wchan)
-            # we timed out, but got signaled afterwards,
-            # so pass that signal on to the next waiter
-            @__Waiters__.shift << true unless @__Waiters__.empty?
-          end
-        end
-
-        self
-      end
-
-      def ns_signal
-        @__Waiters__.shift << true unless @__Waiters__.empty?
-        self
-      end
-
-      def ns_broadcast
-        @__Waiters__.shift << true until @__Waiters__.empty?
-        self
-      end
-    end
-  end
-end

data/lib/concurrent-ruby/concurrent/synchronization/rbx_object.rb

@@ -1,49 +0,0 @@
-module Concurrent
-  module Synchronization
-
-    # @!visibility private
-    module RbxAttrVolatile
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-
-        def attr_volatile(*names)
-          names.each do |name|
-            ivar = :"@volatile_#{name}"
-            class_eval <<-RUBY, __FILE__, __LINE__ + 1
-              def #{name}
-                Rubinius.memory_barrier
-                #{ivar}
-              end
-
-              def #{name}=(value)
-                #{ivar} = value
-                Rubinius.memory_barrier
-              end
-            RUBY
-          end
-          names.map { |n| [n, :"#{n}="] }.flatten
-        end
-
-      end
-
-      def full_memory_barrier
-        # Rubinius instance variables are not volatile so we need to insert barrier
-        # TODO (pitr 26-Nov-2015): check comments like ^
-        Rubinius.memory_barrier
-      end
-    end
-
-    # @!visibility private
-    # @!macro internal_implementation_note
-    class RbxObject < AbstractObject
-      include RbxAttrVolatile
-
-      def initialize
-        # nothing to do
-      end
-    end
-  end
-end

data/lib/concurrent-ruby/concurrent/synchronization/truffleruby_object.rb

@@ -1,47 +0,0 @@
-module Concurrent
-  module Synchronization
-
-    # @!visibility private
-    module TruffleRubyAttrVolatile
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def attr_volatile(*names)
-          names.each do |name|
-            ivar = :"@volatile_#{name}"
-
-            class_eval <<-RUBY, __FILE__, __LINE__ + 1
-              def #{name}
-                full_memory_barrier
-                #{ivar}                  
-              end
-
-              def #{name}=(value)
-                #{ivar} = value
-                full_memory_barrier
-              end
-            RUBY
-          end
-
-          names.map { |n| [n, :"#{n}="] }.flatten
-        end
-      end
-
-      def full_memory_barrier
-        TruffleRuby.full_memory_barrier
-      end
-    end
-
-    # @!visibility private
-    # @!macro internal_implementation_note
-    class TruffleRubyObject < AbstractObject
-      include TruffleRubyAttrVolatile
-
-      def initialize
-        # nothing to do
-      end
-    end
-  end
-end