atomic 1.1.7-java → 1.1.8-java

data/.gitignore

@@ -3,3 +3,5 @@ lib/atomic_reference.jar
 ext/*.bundle
 ext/*.so
 ext/*.jar
+pkg
+*.gem

data/atomic.gemspec

@@ -1,8 +1,8 @@
 # -*- encoding: utf-8 -*-
 
 # Update these to get proper version and commit history
-new_version = "1.1.7"
-old_version = "1.1.6"
+new_version = "1.1.8"
+old_version = "1.1.7"
 
 git_lines = `git log --oneline #{old_version}...#{new_version}`.lines.map {|str| "* #{str}"}.join
 doc_lines = File.readlines("README.rdoc")
@@ -12,7 +12,6 @@ description = <<EOS
 == Changes since #{old_version}
 
 #{git_lines}
-#{doc_lines[2..-1].join("\n")}
 EOS
 
 Gem::Specification.new do |s|
@@ -25,6 +24,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/headius/ruby-atomic"
   s.require_paths = ["lib"]
   s.summary = "An atomic reference implementation for JRuby, Rubinius, and MRI"
+  s.licenses = ["Apache-2.0"]
   s.test_files = Dir["test/test*.rb"]
   if defined?(JRUBY_VERSION)
     s.files = Dir['lib/atomic_reference.jar']

data/ext/extconf.rb

@@ -14,7 +14,12 @@ require 'mkmf'
 extension_name = 'atomic_reference'
 dir_config(extension_name)
 
-try_run(<<CODE) && ($defs << '-DHAVE_GCC_CAS')
+case CONFIG["arch"]
+when /mswin32|mingw/
+    $CFLAGS += " -march=native"
+end
+
+try_run(<<CODE,$CFLAGS) && ($defs << '-DHAVE_GCC_CAS')
 int main() {
   int i = 1;
   __sync_bool_compare_and_swap(&i, 1, 4);
@@ -22,9 +27,4 @@ int main() {
 }
 CODE
 
-case CONFIG["arch"]
-when /mswin32|mingw/
-    $CFLAGS += " -march=native"
-end
-
 create_makefile(extension_name)

data/ext/org/jruby/ext/atomic/AtomicReferenceLibrary.java

@@ -17,6 +17,7 @@ import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
 import org.jruby.Ruby;
 import org.jruby.RubyClass;
 import org.jruby.RubyModule;
+import org.jruby.RubyNumeric;
 import org.jruby.RubyObject;
 import org.jruby.anno.JRubyClass;
 import org.jruby.anno.JRubyMethod;
@@ -103,8 +104,15 @@ public class AtomicReferenceLibrary implements Library {
         }
 
         @JRubyMethod(name = {"compare_and_set", "compare_and_swap"})
-        public IRubyObject compare_and_set(ThreadContext context, IRubyObject oldValue, IRubyObject newValue) {
-            return context.runtime.newBoolean(UNSAFE.compareAndSwapObject(this, referenceOffset, oldValue, newValue));
+        public IRubyObject compare_and_set(ThreadContext context, IRubyObject expectedValue, IRubyObject newValue) {
+            Ruby runtime = context.runtime;
+            
+            if (expectedValue instanceof RubyNumeric) {
+                // numerics are not always idempotent in Ruby, so we need to do slower logic
+                return compareAndSetNumeric(context, expectedValue, newValue);
+            }
+            
+            return runtime.newBoolean(UNSAFE.compareAndSwapObject(this, referenceOffset, expectedValue, newValue));
         }
 
         @JRubyMethod(name = {"get_and_set", "swap"})
@@ -117,6 +125,35 @@ public class AtomicReferenceLibrary implements Library {
                 }
             }
         }
+        
+        private IRubyObject compareAndSetNumeric(ThreadContext context, IRubyObject expectedValue, IRubyObject newValue) {
+            Ruby runtime = context.runtime;
+            
+            // loop until:
+            // * reference CAS would succeed for same-valued objects
+            // * current and expected have different values as determined by #equals
+            while (true) {
+                IRubyObject current = reference;
+
+                if (!(current instanceof RubyNumeric)) {
+                    // old value is not numeric, CAS fails
+                    return runtime.getFalse();
+                }
+
+                RubyNumeric currentNumber = (RubyNumeric)current;
+                if (!currentNumber.equals(expectedValue)) {
+                    // current number does not equal expected, fail CAS
+                    return runtime.getFalse();
+                }
+
+                // check that current has not changed, or else allow loop to repeat
+                boolean success = UNSAFE.compareAndSwapObject(this, referenceOffset, current, newValue);
+                if (success) {
+                    // value is same and did not change in interim...success
+                    return runtime.getTrue();
+                }
+            }
+        }
     }
     
     public static class JRubyReference8 extends JRubyReference {

data/lib/atomic.rb

@@ -11,8 +11,15 @@
 # limitations under the License.
 
 begin
-  ruby_engine = defined?(RUBY_ENGINE)? RUBY_ENGINE : 'ruby'
+  # force fallback impl with FORCE_ATOMIC_FALLBACK=1
+  if /[^0fF]/ =~ ENV['FORCE_ATOMIC_FALLBACK']
+    ruby_engine = 'fallback'
+  else
+    ruby_engine = defined?(RUBY_ENGINE)? RUBY_ENGINE : 'ruby'
+  end
+  
   require "atomic/#{ruby_engine}"
 rescue LoadError
+  warn "#{__FILE__}:#{__LINE__}: unsupported Ruby engine `#{RUBY_ENGINE}', using less-efficient Atomic impl"
   require 'atomic/fallback'
 end

data/lib/atomic/concurrent_update_error.rb

@@ -1,3 +1,15 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 class Atomic
   class ConcurrentUpdateError < ThreadError
     # frozen pre-allocated backtrace to speed ConcurrentUpdateError

data/lib/atomic/delegated_update.rb

@@ -1,3 +1,15 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require 'atomic/concurrent_update_error'
 
 # Define update methods that delegate to @ref field

data/lib/atomic/direct_update.rb

@@ -1,3 +1,15 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require 'atomic/concurrent_update_error'
 
 # Define update methods that use direct paths

data/lib/atomic/fallback.rb

@@ -1,4 +1,14 @@
-warn "#{__FILE__}:#{__LINE__}: unsupported Ruby engine `#{RUBY_ENGINE}', using less-efficient Atomic impl"
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 require 'thread'
 require 'atomic/direct_update'
@@ -39,5 +49,6 @@ class Atomic #:nodoc: all
     end
     true
   end
-  alias compare_and_swap compare_and_set
+  
+  require 'atomic/numeric_cas_wrapper'
 end

data/lib/atomic/jruby.rb

@@ -1,2 +1,14 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require 'atomic_reference'
 require 'atomic/direct_update'

data/lib/atomic/numeric_cas_wrapper.rb

@@ -0,0 +1,32 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Atomic
+  alias _compare_and_set compare_and_set
+  def compare_and_set(expected, new)
+    if expected.kind_of? Numeric
+      while true
+        old = get
+        
+        return false unless old.kind_of? Numeric
+        
+        return false unless old == expected
+        
+        result = _compare_and_set(old, new)
+        return result if result
+      end
+    else
+      _compare_and_set(expected, new)
+    end
+  end
+  alias compare_and_swap compare_and_set
+end

data/lib/atomic/rbx.rb

@@ -1,11 +1,21 @@
-Atomic = Rubinius::AtomicReference
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
-require 'atomic/direct_update'
-
-# define additional aliases
-class Atomic
+# extend Rubinius's version adding aliases and numeric logic
+class Atomic < Rubinius::AtomicReference
   alias value get
   alias value= set
-  alias compare_and_swap compare_and_set
   alias swap get_and_set
-end
+end
+
+require 'atomic/direct_update'
+require 'atomic/numeric_cas_wrapper'

data/lib/atomic/ruby.rb

@@ -1,2 +1,15 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require 'atomic_reference'
-require 'atomic/direct_update'
+require 'atomic/direct_update'
+require 'atomic/numeric_cas_wrapper'

data/test/test_atomic.rb

@@ -72,4 +72,68 @@ class TestAtomic < Test::Unit::TestCase
     atomic.update{|v| tries += 1 ; atomic.value = 1001 ; v + 1}
     assert_equal 2, tries
   end
+  
+  def test_numeric_cas
+    atomic = Atomic.new(0)
+    
+    # 9-bit idempotent Fixnum (JRuby)
+    max_8 = 2**256 - 1
+    min_8 = -(2**256)
+    
+    atomic.set(max_8)
+    max_8.upto(max_8 + 2) do |i|
+      assert atomic.compare_and_swap(i, i+1), "CAS failed for numeric #{i} => #{i + 1}"
+    end
+    
+    atomic.set(min_8)
+    min_8.downto(min_8 - 2) do |i|
+      assert atomic.compare_and_swap(i, i-1), "CAS failed for numeric #{i} => #{i - 1}"
+    end
+    
+    # 64-bit idempotent Fixnum (MRI, Rubinius)
+    max_64 = 2**62 - 1
+    min_64 = -(2**62)
+    
+    atomic.set(max_64)
+    max_64.upto(max_64 + 2) do |i|
+      assert atomic.compare_and_swap(i, i+1), "CAS failed for numeric #{i} => #{i + 1}"
+    end
+    
+    atomic.set(min_64)
+    min_64.downto(min_64 - 2) do |i|
+      assert atomic.compare_and_swap(i, i-1), "CAS failed for numeric #{i} => #{i - 1}"
+    end
+    
+    # 64-bit overflow into Bignum (JRuby)
+    max_64 = 2**63 - 1
+    min_64 = (-2**63)
+    
+    atomic.set(max_64)
+    max_64.upto(max_64 + 2) do |i|
+      assert atomic.compare_and_swap(i, i+1), "CAS failed for numeric #{i} => #{i + 1}"
+    end
+    
+    atomic.set(min_64)
+    min_64.downto(min_64 - 2) do |i|
+      assert atomic.compare_and_swap(i, i-1), "CAS failed for numeric #{i} => #{i - 1}"
+    end
+    
+    # non-idempotent Float (JRuby, Rubinius, MRI < 2.0.0 or 32-bit)
+    atomic.set(1.0 + 0.1)
+    assert atomic.compare_and_set(1.0 + 0.1, 1.2), "CAS failed for #{1.0 + 0.1} => 1.2"
+    
+    # Bignum
+    atomic.set(2**100)
+    assert atomic.compare_and_set(2**100, 0), "CAS failed for #{2**100} => 0"
+    
+    # Rational
+    require 'rational' unless ''.respond_to? :to_r
+    atomic.set(Rational(1,3))
+    assert atomic.compare_and_set(Rational(1,3), 0), "CAS failed for #{Rational(1,3)} => 0"
+    
+    # Complex
+    require 'complex' unless ''.respond_to? :to_c
+    atomic.set(Complex(1,2))
+    assert atomic.compare_and_set(Complex(1,2), 0), "CAS failed for #{Complex(1,2)} => 0"
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: atomic
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 1.1.7
+  version: 1.1.8
 platform: java
 authors:
 - Charles Oliver Nutter
@@ -11,100 +11,26 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-04-16 00:00:00.000000000 Z
 dependencies: []
-description: |
+description: |+
   = An atomic reference implementation for JRuby, Rubinius, and MRI.
 
 
-  == Changes since 1.1.6
+  == Changes since 1.1.7
 
-  * fa74e58 Bump version to 1.1.7.
-  * 9b58cf0 Merge pull request #20 from lazyspark/master
-  * 14fc4a9 Removed compiled gem from src
-  * 7d0ade6 Changing the arch to native, to make it successfully compile using mingw
+  * 0b1cd2d Add license to gemspec.
+  * e8d43f1 Limit gem description to just commit log.
+  * 6869b89 Version 1.1.8.
+  * ed84820 Add numeric CAS logic for fallback, MRI, and Rubinius.
+  * 40eca8e Make test work under 1.8-compat.
+  * b6398e5 Add some missing license headers.
+  * c291231 Allow forcing fallback impl.
+  * 6c2ce92 Fix #21 by moving win32 CFLAGS tweak above other test compiles.
+  * e59e92b Add CAS tests for more numeric types.
+  * 0749145 Add pkg/ and *.gem to gitignore.
+  * 073b4c1 Partial fix for numeric idempotence differences across Rubies.
 
-  == Summary
-
-
-
-  This library provides:
-
-
-
-  * an Atomic class that guarantees atomic updates to its contained value
-
-
-
-  The Atomic class provides accessors for the contained "value" plus two update methods:
-
-
-
-  * update will run the provided block, passing the current value and replacing it with the block result iff the value has not been changed in the mean time. It may run the block repeatedly if there are other concurrent updates in progress.
-
-  * try_update will run the provided block, passing the current value and replacing it with the block result. If the value changes before the update can happen, it will throw Atomic::ConcurrentUpdateError.
-
-
-
-  The atomic repository is at http://github.com/headius/ruby-atomic.
-
-
-
-  == Usage
-
-
-
-  The simplest way to use "atomic" is to call the "update" or "try_update" methods.
-
-
-
-  "try_update" and "update" both call the given block, passing the current value and using the block's result as the new value. If the value is updated by another thread before the block completes, "try update" raises a ConcurrentUpdateError and "update" retries the block. Because "update" may call the block several times when multiple threads are all updating the same value, the block's logic should be kept as simple as possible.
-
-
-
-      require 'atomic'
-
-
-
-      my_atomic = Atomic.new(0)
-
-      my_atomic.update {|v| v + 1}
-
-      begin
-
-        my_atomic.try_update {|v| v + 1}
-
-      rescue Atomic::ConcurrentUpdateError => cue
-
-        # deal with it (retry, propagate, etc)
-
-      end
-
-
-
-  It's also possible to use the regular get/set operations on the Atomic, if you want to avoid the exception and respond to contended changes in some other way.
-
-
-
-      my_atomic = Atomic.new(0)
-
-      my_atomic.value # => 0
-
-      my_atomic.value = 1
-
-      my_atomic.swap(2) # => 1
-
-      my_atomic.compare_and_swap(2, 3) # => true, updated to 3
-
-      my_atomic.compare_and_swap(2, 3) # => false, current is not 2
-
-
-
-  == Building
-
-
-
-  As of 1.1.0, JDK8 is required to build the atomic gem, since it attempts to use the new atomic Unsafe.getAndSetObject method only in JDK8. The resulting code should still work fine as far back as Java 5.
 email:
 - headius@headius.com
 - mental@rydia.net
@@ -135,10 +61,12 @@ files:
 - lib/atomic/direct_update.rb
 - lib/atomic/fallback.rb
 - lib/atomic/jruby.rb
+- lib/atomic/numeric_cas_wrapper.rb
 - lib/atomic/rbx.rb
 - lib/atomic/ruby.rb
 homepage: http://github.com/headius/ruby-atomic
-licenses: []
+licenses:
+- Apache-2.0
 post_install_message:
 rdoc_options: []
 require_paths: