thread_tools 0.27 → 0.28

data/lib/thread_tools/debugmutex.rb

@@ -31,6 +31,11 @@ require 'thread'
 module ThreadTools
 
     class EMutexOrder < Exception
+        attr_reader :mutex
+        def initialize(mutex, str)
+            @mutex = mutex
+            super(str)
+        end
     end
 
     class DebugMutex < Mutex
@@ -80,7 +85,7 @@ module ThreadTools
                 else
                     if @owner[:locks].delete(self)
                         @out_of_order_locks += 1
-                        raise EMutexOrder.new("Expected #{@owner[:locks].last}")
+                        raise EMutexOrder.new(self, "Expected #{@owner[:locks].last}")
                     end
                     # if called again let it pass
                 end

data/lib/thread_tools/threadpool.rb

@@ -33,6 +33,7 @@ module ThreadTools
         # if set to true a new worker is created if the pool is empty
         attr_accessor :create_on_spawn
 
+
         # *_size* should be at least 1, *_thr_group* (optional) thread group
         def initialize(_size, _thr_group = nil)
             @kill_worker_on_exception = false
@@ -40,7 +41,8 @@ module ThreadTools
             @pool_mtx = Mutex.new
             @pool_cv = ConditionVariable.new
             @pool = []
-            @thr_grp = _thr_group
+            @dummy_grp = ThreadGroup.new
+            @busy_grp = _thr_group.nil? ? ThreadGroup.new : _thr_group
             @create_on_spawn = false
             _size = 1 if _size < 1
             _size.times { create_worker }
@@ -48,35 +50,31 @@ module ThreadTools
 
         def create_worker
             Thread.new do
-                thr = Thread.current
-                @pool_mtx.synchronize do
-                    @size += 1
-                    if (!@thr_grp.nil?)
-                        @thr_grp.add(thr)
-                    end
-                end
-                thr[:jobs] = []         # XXX array not really necessary
-                thr[:sem] = Semaphore.new(0)
-                loop do
-                    @pool_mtx.synchronize do
-                        @pool << thr    # puts this thread in the pool
-                        @pool_cv.signal
-                    end
-                    thr[:sem].acquire   # wait here for jobs to become available
-                    job = thr[:jobs].shift  # pop out a job
-                    if (job.nil? || job[:block].nil?)
-                        break           # exit thread if job or block is nil
-                    end
-                    begin
-                        job[:block].call(*job[:args])       # call block
-                    rescue
-                        if (@kill_worker_on_exception)
-                            break       # exit thread on exception
+                @pool_mtx.synchronize do @size += 1 end
+                begin
+                    thr = Thread.current
+                    thr[:jobs] = []         # XXX array not really necessary
+                    thr[:sem] = Semaphore.new(0)
+                    loop do
+                        @pool_mtx.synchronize do
+                            @pool << thr    # puts this thread in the pool
+                            @pool_cv.signal
+                        end
+                        thr[:sem].acquire   # wait here for jobs to become available
+                        job = thr[:jobs].shift  # pop out a job
+                        if (job.nil? || job[:block].nil?)
+                            break           # exit thread if job or block is nil
+                        end
+                        begin
+                            @busy_grp.add(thr)  # adds the thread
+                            job[:block].call(*job[:args])   # call block
+                            @dummy_grp.add(thr) # removes from the previous group
+                        rescue
+                            break if @kill_worker_on_exception  # exit thread on exception
                         end
                     end
-                end
-                @pool_mtx.synchronize do
-                    @size -= 1
+                ensure
+                    @pool_mtx.synchronize do @size -= 1 end
                 end
             end
         end
@@ -85,9 +83,7 @@ module ThreadTools
             thr = nil
             @pool_mtx.synchronize do
                 # creates a new worker thread if pool is empty and flag is set
-                if (@create_on_spawn && @pool.empty?)
-                    create_worker
-                end
+                create_worker if @create_on_spawn && @pool.empty?
                 # wait here until a worker is available
                 @pool_cv.wait(@pool_mtx) until !(thr = @pool.shift).nil?
                 thr[:jobs] << { :args => args, :block => block }
@@ -105,10 +101,18 @@ module ThreadTools
                 thr[:jobs].clear    # clear any pending job
                 thr[:jobs] << nil   # queue a nil job
                 thr[:sem].release
-                if (_sync)
-                    thr.join        # wait here for the thread to die
-                end
+                thr.join if _sync   # wait here for the thread to die
             end
+            busy_list = @busy_grp.list
+            busy_list.each do |athr|
+                athr.raise('shutdown')   # XXX we could .kill instead
+                athr.join if _sync       # wait here for the thread to die
+            end
+        end
+
+        # returns the number of busy workers
+        def busy_size
+            @busy_grp.list.size
         end
     end
 

data/test/test_threadpool.rb

@@ -6,36 +6,53 @@ class ThreadPoolTest < Test::Unit::TestCase
     def setup
         super
         @tpool = ThreadTools::ThreadPool.new(2)
-        @tpool.kill_worker_on_exception = true
     end
 
-    def test_thread_spawn
+    def test_spawn
         uniq_threads = {}
         sum_orig = 0
-        sum_lock = Mutex.new
         sum_thr = 0
-        4.times {|i|
+        sum_lock = Mutex.new
+        4.times do |i|
             sum_orig += i
-            @tpool.spawn(i) {|ti|
-                sum_lock.synchronize do
-                    sum_thr += ti
-                end
+            @tpool.spawn(i) do |j|
+                sum_lock.synchronize { sum_thr += j }
                 uniq_threads[Thread.current] = true
-                if (ti == 3)
-                  # this exception should kill this worker
-                  raise "oups"
-                end
-            }
-        }
+            end
+        end
         sleep 0.1
-        # 2 workers - 1 from raised exceptions = 1
-        assert_equal(@tpool.size, 1)
-        @tpool.shutdown
         # same sum
         assert_equal(sum_orig, sum_thr)
         # number of different threads
         assert_equal(uniq_threads.size, 2)
+    end
+ 
+    def test_raise
+        @tpool.kill_worker_on_exception = true
+        2.times do |i|
+            @tpool.spawn(i+1) do |j|
+                raise 'oups' if j == 2
+            end
+        end
+        sleep 0.1
+        # 2 workers - 1 from raised exceptions = 1
+        assert_equal(@tpool.size, 1)
+    end
+ 
+    def test_shutdown
+        # initial number of threads
+        assert_equal(@tpool.size, 2)
+        @tpool.shutdown
         # after shutdown all threads are dead
         assert_equal(@tpool.size, 0)
     end
+
+    def test_spawn_create
+        # kill all workers first
+        @tpool.shutdown
+        @tpool.create_on_spawn = true
+        @tpool.spawn {}
+        # a new worker was created
+        assert_equal(@tpool.size, 1)
+    end
 end

data/thread_tools.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
     s.name = %q{thread_tools}
-    s.version = '0.27'
+    s.version = '0.28'
     s.summary = %q{Utilities for threaded apps}
     s.platform = Gem::Platform::RUBY
     s.email = %q{daniel@tralamazza.com}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thread_tools
 version: !ruby/object:Gem::Version 
-  version: "0.27"
+  version: "0.28"
 platform: ruby
 authors: 
 - Daniel Tralamazza
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-06 00:00:00 +02:00
+date: 2009-10-14 00:00:00 +02:00
 default_executable: 
 dependencies: []