Merge pull request #111 from ruby-concurrency/atomic-reference-with-actress

Atomic Reference with Actress

Author: jdantonio

.gitignore

@@ -1,6 +1,8 @@
 Gemfile.lock
-tests.txt
 *.gem
+lib/1.8
+lib/1.9
+lib/2.0
 .rvmrc
 .ruby-version
 .ruby-gemset
@@ -21,9 +23,14 @@ coverage
 .DS_Store
 TAGS
 tmtags
-*.swo
-*.swp
+*.sw?
 .idea
 .rbx/*
-*.py
-*.pyc
+lib/*.bundle
+lib/*.so
+lib/*.jar
+ext/*.bundle
+ext/*.so
+ext/*.jar
+pkg
+*.gem

.travis.yml

@@ -1,12 +1,14 @@
 language: ruby
 rvm:
-  - 2.1.0
+  - 2.1.2
   - 2.0.0
   - 1.9.3
   - ruby-head
   - jruby-19mode
   - jruby-head
   - rbx-2
+jdk:
+  - oraclejdk8
 branches:
   only:
     - master
@@ -15,4 +17,4 @@ matrix:
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: 1.9.3
-script: "bundle exec rspec --color --backtrace --seed 1 --format documentation ./spec"
+script: "bundle exec rake compile && bundle exec rspec --color --backtrace --seed 1 --format documentation ./spec"

Gemfile

@@ -2,18 +2,19 @@ source 'https://rubygems.org'
 
 gemspec
 
-
-group :development do
-  gem 'rake', '~> 10.2.2'
-  gem 'countloc', '~> 0.4.0', platforms: :mri
-  gem 'yard', '~> 0.8.7.4'
-  gem 'inch', '~> 0.4.1', platforms: :mri
-  gem 'redcarpet', platforms: :mri # understands github markdown
-end
+gem 'rake', '~> 10.3.2'
+gem 'rake-compiler', '~> 0.9.2'
 
 group :testing do
   gem 'rspec', '~> 2.14.1'
-  gem 'simplecov', '~> 0.8.2'
-  gem 'coveralls', '~> 0.7.0', require: false
+  gem 'simplecov', '~> 0.8.2', :require => false
+  gem 'coveralls', '~> 0.7.0', :require => false
   gem 'timecop', '~> 0.7.1'
 end
+
+group :documentation do
+  gem 'countloc', '~> 0.4.0', :platforms => :mri, :require => false
+  gem 'yard', '~> 0.8.7.4', :require => false
+  gem 'inch', '~> 0.4.1', :platforms => :mri, :require => false
+  gem 'redcarpet', '~> 3.1.2', platforms: :mri # understands github markdown
+end

Rakefile

@@ -1,23 +1,87 @@
-$:.push File.join(File.dirname(__FILE__), 'lib')
-$:.push File.join(File.dirname(__FILE__), 'tasks/support')
-
-require 'rubygems'
 require 'bundler/gem_tasks'
-require 'rspec'
-require 'rspec/core/rake_task'
+require 'rake/extensiontask'
+require 'rake/javaextensiontask'
 
-require 'concurrent'
+GEMSPEC = Gem::Specification.load('concurrent-ruby.gemspec')
+EXTENSION_NAME = 'concurrent_ruby_ext'
 
 Bundler::GemHelper.install_tasks
 
-RSpec::Core::RakeTask.new(:spec)
-$:.unshift 'tasks'
-Dir.glob('tasks/**/*.rake').each do|rakefile|
-  load rakefile
+$:.push File.join(File.dirname(__FILE__), 'lib')
+require 'extension_helper'
+
+def safe_load(file)
+  begin
+    load file
+  rescue LoadError => ex
+    puts 'Error loading rake tasks, but will continue...'
+    puts ex.message
+  end
 end
 
-RSpec::Core::RakeTask.new(:travis_spec) do |t|
-  t.rspec_opts = '--tag ~@not_on_travis'
+Dir.glob('tasks/**/*.rake').each do |rakefile|
+  safe_load rakefile
 end
 
-task :default => [:travis_spec]
+desc 'Run benchmarks'
+task :bench do
+  exec 'ruby -Ilib -Iext examples/bench_atomic.rb'
+end
+
+if defined?(JRUBY_VERSION)
+
+  Rake::JavaExtensionTask.new(EXTENSION_NAME, GEMSPEC) do |ext|
+    ext.ext_dir = 'ext'
+  end
+
+elsif Concurrent.use_c_extensions?
+
+  Rake::ExtensionTask.new(EXTENSION_NAME, GEMSPEC) do |ext|
+    ext.ext_dir = "ext/#{EXTENSION_NAME}"
+    ext.cross_compile = true
+    ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
+  end
+
+  ENV['RUBY_CC_VERSION'].to_s.split(':').each do |ruby_version|
+    platforms = {
+      'x86-mingw32' => 'i686-w64-mingw32',
+      'x64-mingw32' => 'x86_64-w64-mingw32'
+    }
+    platforms.each do |platform, prefix|
+      task "copy:#{EXTENSION_NAME}:#{platform}:#{ruby_version}" do |t|
+        %w[lib tmp/#{platform}/stage/lib].each do |dir|
+          so_file = "#{dir}/#{ruby_version[/^\d+\.\d+/]}/#{EXTENSION_NAME}.so"
+          if File.exists?(so_file)
+            sh "#{prefix}-strip -S #{so_file}"
+          end
+        end
+      end
+    end
+  end
+else
+  task :clean
+  task :compile
+  task "compile:#{EXTENSION_NAME}"
+end
+
+Rake::Task[:clean].enhance do
+  rm_rf 'pkg/classes'
+  rm_rf 'tmp'
+  rm_rf 'lib/1.9'
+  rm_rf 'lib/2.0'
+  rm_f Dir.glob('./lib/*.jar')
+  rm_f Dir.glob('./**/*.bundle')
+end
+
+begin
+  require 'rspec'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = '--color --backtrace --format documentation'
+  end
+
+  task :default => [:clean, :compile, :spec]
+rescue LoadError
+  puts 'Error loading Rspec rake tasks, probably building the gem...'
+end

concurrent-ruby.gemspec

@@ -18,12 +18,17 @@ Gem::Specification.new do |s|
     Inspired by Erlang, Clojure, Go, JavaScript, actors, and classic concurrency patterns.
   EOF
 
-  s.files            = Dir['README*', 'LICENSE*', 'CHANGELOG*']
-  s.files           += Dir['{lib,md,spec}/**/*']
-  s.test_files       = Dir['{spec}/**/*']
-  s.extra_rdoc_files = ['README.md']
+  s.files            = Dir['lib/**/*']
   s.extra_rdoc_files = Dir['README*', 'LICENSE*', 'CHANGELOG*']
   s.require_paths    = ['lib']
 
+  if defined?(JRUBY_VERSION)
+    s.files += Dir['lib/concurrent_ruby_ext.jar']
+    s.platform = 'java'
+  elsif ! ENV['BUILD_PURE_RUBY']
+    s.extensions = 'ext/concurrent_ruby_ext/extconf.rb'
+    s.files += Dir['ext/**/*.{h,c,cpp}']
+  end
+
   s.required_ruby_version = '>= 1.9.3'
 end

examples/atomic_example.rb

@@ -0,0 +1,12 @@
+require 'concurrent'
+
+my_atomic = Concurrent::Atomic.new(0)
+my_atomic.update {|v| v + 1}
+puts "new value: #{my_atomic.value}"
+
+begin
+  my_atomic.try_update {|v| v + 1}
+rescue Concurrent::Atomic::ConcurrentUpdateError => cue
+  # deal with it (retry, propagate, etc)
+end
+puts "new value: #{my_atomic.value}"

examples/bench_atomic.rb

@@ -0,0 +1,126 @@
+require 'benchmark'
+require 'rbconfig'
+require 'thread'
+require 'concurrent'
+Thread.abort_on_exception = true
+
+$go = false # for synchronizing parallel threads
+
+# number of updates on the value
+N = ARGV[1] ? ARGV[1].to_i : 100_000
+
+# number of threads for parallel test
+M = ARGV[0] ? ARGV[0].to_i : 10
+
+# list of platform-specific implementations
+ATOMICS = [
+  'MutexAtomic',
+  'CAtomic',
+  'JavaAtomic',
+  'RbxAtomic',
+]
+
+puts "Testing with #{RbConfig::CONFIG['ruby_install_name']} #{RUBY_VERSION}"
+
+puts
+puts '*** Sequential updates ***'
+Benchmark.bm(10) do |x|
+  value = 0
+  x.report 'no lock' do
+    N.times do
+      value += 1
+    end
+  end
+
+  @lock = Mutex.new
+  x.report 'mutex' do
+    value = 0
+    N.times do
+      @lock.synchronize do
+        value += 1
+      end
+    end
+  end
+
+  ATOMICS.each do |clazz|
+    if Concurrent.const_defined? clazz
+      @atom = Concurrent.const_get(clazz).new(0)
+      x.report clazz do
+        N.times do
+          @atom.update{|x| x += 1}
+        end
+      end
+    end
+  end
+end
+
+def para_setup(num_threads, count, &block)
+  if num_threads % 2 > 0
+    raise ArgumentError, 'num_threads must be a multiple of two'
+  end
+  raise ArgumentError, 'need block' unless block_given?
+
+  # Keep those threads together
+  tg = ThreadGroup.new
+
+  num_threads.times do |i|
+    diff = (i % 2 == 0) ? 1 : -1
+
+    t = Thread.new do
+      nil until $go
+      count.times do
+        yield diff
+      end
+    end
+
+    tg.add(t)
+  end
+
+  # Make sure all threads are started
+  while tg.list.find{|t| t.status != 'run'}
+    Thread.pass
+  end
+
+  # For good measure
+  GC.start
+
+  tg
+end
+
+def para_run(tg)
+  $go = true
+  tg.list.each{|t| t.join}
+  $go = false
+end
+
+puts
+puts '*** Parallel updates ***'
+Benchmark.bm(10) do |bm|
+  # This is not secure
+  value = 0
+  tg = para_setup(M, N/M) do |diff|
+    value += diff
+  end
+  bm.report('no lock'){ para_run(tg) }
+
+  value = 0
+  @lock = Mutex.new
+  tg = para_setup(M, N/M) do |diff|
+    @lock.synchronize do
+      value += diff
+    end
+  end
+  bm.report('mutex'){ para_run(tg) }
+  raise unless value == 0
+
+  ATOMICS.each do |clazz|
+    if Concurrent.const_defined? clazz
+      @atom = Concurrent.const_get(clazz).new(0)
+      tg = para_setup(M, N/M) do |diff|
+        @atom.update{|x| x + diff}
+      end
+      bm.report(clazz){ para_run(tg) }
+      raise unless @atom.value == 0
+    end
+  end
+end