process_shared 0.1.6 → 0.1.7

data/README.rdoc

@@ -3,11 +3,23 @@
 Concurrency primitives that may be used in a cross-process way to
 coordinate share memory between processes.
 
-A small C library (libpsem) is compiled to provide portable access to
-semaphores (based on http://pyprocessing.berlios.de/).  This library
-is then accessed using FFI to implement Ruby classes
-ProcessShared::Semaphore, ProcessShared::BoundedSemaphore,
-ProcessShared::Mutex, and ProcessShared::SharedMemory.
+FFI is used to access POSIX semaphore on Linux or Mach semaphores on
+Mac.  Atop these semaphores are implemented ProcessShared::Semaphore,
+ProcessShared::Mutex.  POSIX shared memory is used to implement
+ProcessShared::SharedMemory.
+
+On Linux, POSIX semaphores support <tt>sem_timedwait()</tt> which can wait on
+a semaphore but stop waiting after a timeout.
+
+Mac OS X's implementation of POSIX semaphores does not support
+timeouts.  But, the Mach layer in Mac OS X has its own semaphores that
+do support timeouts.  Thus, process_shared implements a moderate
+subset of the Mach API, which is quite a bit different from POSIX.
+Namely, semaphores created in one process are not available in child
+processes created via <tt>fork()</tt>.  Mach does provide the means to copy
+capabilities between tasks (Mach equivalent to processes).
+process_shared overrides Ruby's <tt>fork</tt> methods so that semaphores are
+copied from parent to child to emulate the POSIX behavior.
 
 This is an incomplete work in progress.
 
@@ -80,14 +92,8 @@ Install the gem with:
 
 * Test ConditionVariable
 * Implement optional override of core Thread/Mutex classes
-* Extend libpsem to win32?  (See Python's processing library)
-* Break out tests that use PSem.getvalue() (which isn't supported on Mac OS X)
-  so that the test suite will pass
+* Extend to win32?  (See Python's processing library)
 * Add finalizer to Mutex? (finalizer on Semaphore objects may be enough) or a method to
   explicitly close and release resources?
 * Test semantics of crashing processes who still hold locks, etc.
 * Is SharedArray with Enumerable mixing sufficient Array-like interface?
-* Remove bsem from libpsem as it is of little use and doesn't work on Mac OS X
-* Possibly implement BoundedSemaphore with arbitrary bound (in Ruby
-  rather than relying on sem_getvalue()), but this is of little
-  utility beyond extra error checking..

data/ext/helper/extconf.rb

@@ -11,4 +11,4 @@ have_header('pthread.h')
 have_type('pthread_mutex_t', 'pthread.h')
 have_type('pthread_mutexattr_t', 'pthread.h')
 
-create_makefile('helper')
+create_makefile('process_shared/posix/helper')

data/lib/process_shared/monitor.rb

@@ -0,0 +1,31 @@
+require 'process_shared'
+require 'process_shared/mutex'
+
+module ProcessShared
+  class Monitor < Mutex
+    def initialize
+      super
+      @lock_count = 0
+    end
+
+    def lock
+      if locked_by == ::Process.pid
+        @lock_count += 1
+      else
+        super
+      end
+    end
+
+    def unlock
+      if locked_by == ::Process.pid
+        if @lock_count > 0
+          @lock_count -= 1
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/process_shared/monitor_mixin.rb

@@ -0,0 +1,42 @@
+require 'process_shared'
+
+module ProcessShared
+  module MonitorMixin
+    def self.extended(obj)
+      obj.send :mon_initialize
+    end
+
+    def mon_enter
+      @mon_monitor.lock
+    end
+    
+    def mon_exit
+      @mon_monitor.unlock
+    end
+    
+    def mon_synchronize
+      mon_enter
+      begin
+        yield
+      ensure
+        mon_exit
+      end
+    end
+    alias_method :synchronize, :mon_synchronize
+    
+    def mon_try_enter
+      raise NotImplementedError, 'not implemented'
+    end
+    alias_method :try_mon_enter, :mon_try_enter
+    
+    def new_cond
+      raise NotImplementedError, 'not implemented'
+    end
+
+    private
+
+    def mon_initialize
+      @mon_monitor = Monitor.new
+    end
+  end
+end

data/lib/process_shared/mutex.rb

@@ -94,7 +94,7 @@ module ProcessShared
       end
     end
 
-    private
+    protected
 
     def locked_by
       with_internal_lock do
@@ -108,13 +108,8 @@ module ProcessShared
       end
     end
 
-    def with_internal_lock
-      @internal_sem.wait
-      begin
-        yield
-      ensure
-        @internal_sem.post
-      end
+    def with_internal_lock(&block)
+      @internal_sem.synchronize &block
     end
   end
 end

data/lib/process_shared.rb

@@ -28,4 +28,6 @@ end
 require 'process_shared/binary_semaphore'
 require 'process_shared/mutex'
 require 'process_shared/condition_variable'
+require 'process_shared/monitor'
+require 'process_shared/monitor_mixin'
 

data/spec/process_shared/lock_behavior.rb

@@ -0,0 +1,60 @@
+module ProcessShared
+  # Classes that include this module should assign a lock object to
+  # @lock before each test.
+  module LockBehavior
+
+    # Fork +n+ processes.  In each, yield the block (passing the process
+    # number), then call Kernel.exit!  Waits for all processes to
+    # complete before returning.
+    def fork_many(n)
+      pids = []
+      n.times do |i|
+        pids << fork do
+          yield i
+          Kernel.exit!
+        end
+      end
+
+      pids.each { |pid| ::Process.wait(pid) }
+    end
+
+    def test_protects_access_to_a_shared_variable
+      mem = SharedMemory.new(:char)
+      mem.put_char(0, 0)
+
+      fork_many(10) do |i|
+        inc = (-1) ** i       # half the procs increment; half decrement
+        10.times do
+          @lock.lock
+          begin
+            mem.put_char(0, mem.get_char(0) + inc)
+            sleep 0.001
+          ensure
+            @lock.unlock
+          end
+        end
+      end
+
+      mem.get_char(0).must_equal(0)
+    end
+
+    def test_protects_access_to_a_shared_variable_with_synchronize
+      mem = SharedMemory.new(:char)
+      mem.put_char(0, 0)
+
+      fork_many(10) do |i|
+        inc = (-1) ** i         # half the procs increment; half decrement
+        10.times do
+          @lock.synchronize do
+            mem.put_char(0, mem.get_char(0) + inc)
+            sleep 0.001
+          end
+        end
+      end
+
+      mem.get_char(0).must_equal(0)
+    end
+
+
+  end
+end

data/spec/process_shared/monitor_mixin_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'process_shared'
+
+module ProcessShared
+  describe MonitorMixin do
+
+    before :each do
+      @obj = Object.new
+      @obj.extend(MonitorMixin)
+    end
+
+    it 'raises exception when unlocked by other process' do
+      pid = Kernel.fork do
+        @obj.mon_enter
+        sleep 0.2
+        @obj.mon_exit
+        Kernel.exit!
+      end
+
+      sleep 0.1
+      proc { @obj.mon_exit }.must_raise(ProcessError)
+
+      ::Process.wait(pid)
+    end
+
+    it 'raises nothing with nested lock' do
+      @obj.mon_enter
+      @obj.mon_enter
+      @obj.mon_exit
+      @obj.mon_exit
+    end
+  end
+end

data/spec/process_shared/monitor_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'process_shared'
+
+module ProcessShared
+  describe Monitor do
+
+    include LockBehavior
+
+    before :each do
+      @lock = Monitor.new
+    end
+
+    it 'raises exception when unlocked by other process' do
+      pid = Kernel.fork do
+        @lock.lock
+        sleep 0.2
+        @lock.unlock
+        Kernel.exit!
+      end
+
+      sleep 0.1
+      proc { @lock.unlock }.must_raise(ProcessError)
+
+      ::Process.wait(pid)
+    end
+
+    it 'raises nothing with nested lock' do
+      @lock.lock
+      @lock.lock
+      @lock.unlock
+      @lock.unlock
+    end
+  end
+end

data/spec/process_shared/mutex_spec.rb

@@ -3,79 +3,31 @@ require 'process_shared'
 
 module ProcessShared
   describe Mutex do
-    it 'protects access to a shared variable' do
-      mutex = Mutex.new
-      mem = SharedMemory.new(:char)
-      mem.put_char(0, 0)
 
-      pids = []
-      10.times do |i|
-        inc = (-1) ** i         # half the procs increment; half decrement
-        pids << fork do
-          10.times do
-            mutex.lock
-            begin
-              mem.put_char(0, mem.get_char(0) + inc)
-              sleep 0.001
-            ensure
-              mutex.unlock
-            end
-          end
-          Kernel.exit!
-        end
-      end
-
-      pids.each { |pid| ::Process.wait(pid) }
+    include LockBehavior
 
-      mem.get_char(0).must_equal(0)
+    before :each do
+      @lock = Mutex.new
     end
-
-    it 'protects access to a shared variable with synchronize' do
-      mutex = Mutex.new
-      mem = SharedMemory.new(:char)
-      mem.put_char(0, 0)
-
-      pids = []
-      10.times do |i|
-        inc = (-1) ** i         # half the procs increment; half decrement
-        pids << fork do
-          10.times do
-            mutex.synchronize do
-              mem.put_char(0, mem.get_char(0) + inc)
-              sleep 0.001
-            end
-          end
-          Kernel.exit!
-        end
-      end
-
-      pids.each { |pid| ::Process.wait(pid) }
-
-      mem.get_char(0).must_equal(0)
-    end
-
+    
     it 'raises exception when unlocked by other process' do
-      mutex = Mutex.new
-
       pid = Kernel.fork do
-        mutex.lock
+        @lock.lock
         sleep 0.2
-        mutex.unlock
+        @lock.unlock
         Kernel.exit!
       end
 
       sleep 0.1
-      proc { mutex.unlock }.must_raise(ProcessError)
+      proc { @lock.unlock }.must_raise(ProcessError)
 
       ::Process.wait(pid)
     end
 
     it 'raises exception when locked twice by same process' do
-      mutex = Mutex.new
-
-      mutex.lock
-      proc { mutex.lock }.must_raise(ProcessError)
-      mutex.unlock
+      @lock.lock
+      proc { @lock.lock }.must_raise(ProcessError)
+      @lock.unlock
     end
   end
 end

data/spec/process_shared/semaphore_spec.rb

@@ -5,6 +5,25 @@ require 'process_shared'
 
 module ProcessShared
   describe Semaphore do
+
+    describe 'As Lock' do
+
+      include LockBehavior
+
+      before :each do
+        @lock = Semaphore.new
+        class << @lock
+          alias_method :lock, :wait
+          alias_method :unlock, :post
+        end
+      end
+
+      after :each do
+        @lock.close
+      end
+
+    end
+
     it 'coordinates access to shared object' do
       nprocs = 4               # number of processes
       nincrs = 1000            # each process increments nincrs times

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require 'minitest/autorun'
 require 'minitest/matchers'
 
 require 'process_shared'
+require 'process_shared/lock_behavior'
 
 class RangeMatcher
   def initialize(operator, limit)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_shared
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-09 00:00:00.000000000Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &23371720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *23371720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &23370860 !ruby/object:Gem::Requirement
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23370860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: &23369400 !ruby/object:Gem::Requirement
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23369400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &23367920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,47 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23367920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-matchers
-  requirement: &23358140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23358140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: version
-  requirement: &23357400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,71 +133,72 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23357400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: FFI wrapper around portable semaphore library with mutex and condition
   vars built on top.
 email: pat@polycrystal.org
 executables: []
 extensions:
-- ext/pthread_sync_helper/extconf.rb
 - ext/helper/extconf.rb
 extra_rdoc_files:
 - README.rdoc
 - ChangeLog
 - COPYING
 files:
-- lib/mach.rb
-- lib/scratch.rb
-- lib/process_shared.rb
-- lib/mach/host.rb
 - lib/mach/clock.rb
-- lib/mach/semaphore.rb
-- lib/mach/functions.rb
-- lib/mach/time_spec.rb
 - lib/mach/error.rb
+- lib/mach/functions.rb
+- lib/mach/host.rb
 - lib/mach/port.rb
-- lib/mach/types.rb
+- lib/mach/semaphore.rb
 - lib/mach/task.rb
-- lib/process_shared/synchronizable_semaphore.rb
+- lib/mach/time_spec.rb
+- lib/mach/types.rb
+- lib/mach.rb
 - lib/process_shared/abstract_semaphore.rb
-- lib/process_shared/posix_call.rb
+- lib/process_shared/binary_semaphore.rb
+- lib/process_shared/condition_variable.rb
+- lib/process_shared/define_singleton_method.rb
+- lib/process_shared/mach/semaphore.rb
 - lib/process_shared/mach.rb
+- lib/process_shared/monitor.rb
+- lib/process_shared/monitor_mixin.rb
+- lib/process_shared/mutex.rb
 - lib/process_shared/object_buffer.rb
-- lib/process_shared/process_error.rb
-- lib/process_shared/thread.rb
 - lib/process_shared/open_with_self.rb
 - lib/process_shared/posix/errno.rb
+- lib/process_shared/posix/libc.rb
 - lib/process_shared/posix/semaphore.rb
+- lib/process_shared/posix/shared_memory.rb
 - lib/process_shared/posix/time_spec.rb
-- lib/process_shared/posix/shared_array.rb
 - lib/process_shared/posix/time_val.rb
-- lib/process_shared/posix/libc.rb
-- lib/process_shared/posix/shared_memory.rb
-- lib/process_shared/mutex.rb
-- lib/process_shared/shared_memory_io.rb
-- lib/process_shared/time_spec.rb
+- lib/process_shared/posix_call.rb
+- lib/process_shared/process_error.rb
 - lib/process_shared/rt.rb
-- lib/process_shared/mach/semaphore.rb
 - lib/process_shared/shared_array.rb
-- lib/process_shared/binary_semaphore.rb
-- lib/process_shared/define_singleton_method.rb
-- lib/process_shared/condition_variable.rb
-- ext/pthread_sync_helper/pthread_sync_helper.c
-- ext/semaphore.c
+- lib/process_shared/shared_memory_io.rb
+- lib/process_shared/synchronizable_semaphore.rb
+- lib/process_shared/time_spec.rb
+- lib/process_shared.rb
 - ext/helper/helper.c
-- ext/pthread_sync_helper/extconf.rb
 - ext/helper/extconf.rb
-- spec/mach/scratch2.rb
-- spec/mach/task_spec.rb
-- spec/mach/scratch.rb
 - spec/mach/port_spec.rb
 - spec/mach/semaphore_spec.rb
-- spec/process_shared/shared_memory_spec.rb
+- spec/mach/task_spec.rb
 - spec/process_shared/binary_semaphore_spec.rb
 - spec/process_shared/condition_variable_spec.rb
+- spec/process_shared/lock_behavior.rb
+- spec/process_shared/monitor_mixin_spec.rb
+- spec/process_shared/monitor_spec.rb
 - spec/process_shared/mutex_spec.rb
-- spec/process_shared/shared_array_spec.rb
 - spec/process_shared/semaphore_spec.rb
+- spec/process_shared/shared_array_spec.rb
+- spec/process_shared/shared_memory_spec.rb
 - spec/spec_helper.rb
 - README.rdoc
 - ChangeLog
@@ -159,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 615501367692780745
+      hash: -4453840700159840592
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -168,10 +226,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 615501367692780745
+      hash: -4453840700159840592
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: process-shared synchronization primitives