async-container 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74fb6a60e18be3ebd4876fa168b27fbda82701c6fbd475b09f5a21ea24b19911
-  data.tar.gz: 49d1a26bffd2e7a836ff46e954ccfb76a3041cc9babe9e856c1b5a089844e97f
+  metadata.gz: 38a0f42651154dff3a1d914b9112c847233dce1636f14c69b4314a254f27cbcf
+  data.tar.gz: 7634511012e538ce9564c0dcfb87915ae0d53d46cd222cd1ee813a8ed3418607
 SHA512:
-  metadata.gz: a80baba7a0f2f148cbfcf72bfc3cda444f81a550f9c9583178e729af0241d181f6053a85a0f2aa74b14cbb8dc4e3ac42d89383aa11962720a97dd2e4bef97654
-  data.tar.gz: a1d3d589b9bc3500d7ff0a53800f2bced7bc8cdf868d538b8ef0c5ea1e4014806c2c804d5c3fd9a8cee2a9a9e3a5958de8661774a43c1271d1668dd3cf270f1c
+  metadata.gz: bc085b10275b339f7dd680ace8d4462ff5d9f462b5e0cc1ab595200d009a743789c0b999a4bfa11df8d2bf9efe09659ebda702dde60398dc276183a244354616
+  data.tar.gz: 1e50231bca1d3aceb8f66f162f290edfd3ef1d00b9d0f3009c412b9bc594db78d96d3812ffd80d1517548333609a6a572a1672a773db81f35412a7d6308dd525

data/lib/async/container.rb

@@ -27,8 +27,12 @@ require 'etc'
 module Async
 	# Containers execute one or more "instances" which typically contain a reactor. A container spawns "instances" using threads and/or processes. Because these are resources that must be cleaned up some how (either by `join` or `waitpid`), their creation is deferred until the user invokes `Container#wait`. When executed this way, the container guarantees that all "instances" will be complete once `Container#wait` returns. Containers are constructs for achieving parallelism, and are not designed to be used directly for concurrency. Typically, you'd create one or more container, add some tasks to it, and then wait for it to complete.
 	module Container
-		def self.run(concurrency_class: Threaded, **options, &block)
-			concurrency_class.run(**options, &block)
+		def self.best_container_class
+			if Process.respond_to?(:fork) and Process.respond_to(:setpgid)
+				return Forked
+			else
+				return Threaded
+			end
 		end
 		
 		def self.processor_count
@@ -36,5 +40,9 @@ module Async
 		rescue
 			2
 		end
+		
+		def self.new
+			best_container_class.new(*arguments)
+		end
 	end
 end

data/lib/async/container/controller.rb

@@ -23,20 +23,22 @@ require 'async/reactor'
 module Async
 	module Container
 		class Controller
-			def initialize
-				@containers = []
+			def async(**options, &block)
+				spawn(**options) do |instance|
+					begin
+						Async::Reactor.run(instance, &block)
+					rescue Interrupt
+						# Graceful exit.
+					end
+				end
 			end
 			
-			def << container
-				@containers << container
-			end
-			
-			def wait
-				@containers.each(&:wait)
-			end
-			
-			def stop
-				@containers.each(&:stop)
+			def run(count: Container.processor_count, **options, &block)
+				count.times do
+					async(**options, &block)
+				end
+				
+				return self
 			end
 		end
 	end

data/lib/async/container/forked.rb

@@ -19,13 +19,15 @@
 # THE SOFTWARE.
 
 require 'async/reactor'
-require 'process/group'
+
+require_relative 'group'
+require_relative 'controller'
 require_relative 'statistics'
 
 module Async
 	# Manages a reactor within one or more threads.
 	module Container
-		class Forked
+		class Forked < Controller
 			UNNAMED = "Unnamed"
 			
 			class Instance
@@ -38,26 +40,20 @@ module Async
 				self.new.run(*args, &block)
 			end
 			
+			def self.multiprocess?
+				true
+			end
+			
 			def initialize
-				@group = ::Process::Group.new
+				@group = Group.new
 				@statistics = Statistics.new
-				
-				@running = true
 			end
 			
 			attr :statistics
 			
-			def run(count: Container.processor_count, **options, &block)
-				count.times do
-					async(**options, &block)
-				end
-				
-				return self
-			end
-			
 			def spawn(name: nil, restart: false)
 				Fiber.new do
-					while @running
+					while true
 						@statistics.spawn!
 						exit_status = @group.fork do
 							::Process.setproctitle(name) if name
@@ -83,35 +79,15 @@ module Async
 				return self
 			end
 			
-			def async(**options, &block)
-				spawn(**options) do |instance|
-					begin
-						Async::Reactor.run(instance, &block)
-					rescue Interrupt
-						# Graceful exit.
-					end
-				end
-			end
-			
-			def self.multiprocess?
-				true
-			end
-			
-			def wait(&block)
-				@group.wait(&block)
+			def wait
+				@group.wait
 			rescue Interrupt
 				# Graceful exit.
 			end
 			
 			# Gracefully shut down all children processes.
-			def stop(graceful = true, &block)
-				@running = false
-				
-				@group.kill(graceful ? :INT : :TERM)
-				
-				self.wait(&block)
-			ensure
-				@running = true
+			def stop(graceful = true)
+				@group.stop(graceful)
 			end
 		end
 	end

data/lib/async/container/group.rb

@@ -0,0 +1,150 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'async/reactor'
+
+require_relative 'controller'
+require_relative 'statistics'
+
+module Async
+	# Manages a reactor within one or more threads.
+	module Container
+		class Group
+			def initialize
+				@pgid = nil
+				@running = {}
+			end
+			
+			def spawn(*arguments)
+				if pid = ::Process.spawn(*arguments)
+					wait_for(pid)
+				end
+			end
+			
+			def fork(&block)
+				if pid = ::Process.fork(&block)
+					wait_for(pid)
+				end
+			end
+			
+			def any?
+				@running.any?
+			end
+			
+			def wait
+				while self.any?
+					self.wait_one
+				end
+			rescue Interrupt
+				# If the user interrupts the wait, interrupt the process group and wait for them to finish:
+				self.kill(:INT)
+				
+				# If user presses Ctrl-C again (or something else goes wrong), we will come out and kill(:TERM) in the ensure below:
+				wait_all
+
+				raise
+			ensure
+				self.close
+			end
+			
+			def kill(signal = :INT)
+				::Process.kill(signal, -@pgid) if @pgid
+			end
+			
+			def stop(graceful = false)
+				if graceful
+					self.kill(:INT)
+					wait_all
+				end
+			ensure
+				self.close
+			end
+			
+			def close
+				begin
+					self.kill(:TERM)
+				rescue Errno::EPERM
+					# Sometimes, `kill` code can give EPERM, if any signal couldn't be delivered to a child. This might occur if an exception is thrown in the user code (e.g. within the fiber), and there are other zombie processes which haven't been reaped yet. These should be dealt with below, so it shouldn't be an issue to ignore this condition.
+				end
+				
+				# Clean up zombie processes - if user presses Ctrl-C or for some reason something else blows up, exception would propagate back to caller:
+				wait_all
+			end
+			
+			protected
+			
+			def wait_all
+				while self.any?
+					self.wait_one do |fiber, status|
+						begin
+							fiber.resume(nil)
+						rescue Interrupt
+							# Graceful exit.
+						end
+					end
+				end
+			end
+			
+			# Wait for one process, should only be called when a child process has finished, otherwise would block.
+			def wait_one(flags = 0)
+				return unless @pgid
+				
+				# Wait for processes in this group:
+				pid, status = ::Process.wait2(-@pgid, flags)
+				
+				return if flags & ::Process::WNOHANG and pid == nil
+				
+				fiber = @running.delete(pid)
+				
+				if @running.empty?
+					@pgid = nil
+				end
+				
+				if block_given?
+					yield fiber, status
+				else
+					fiber.resume(status)
+				end
+			end
+			
+			def wait_for(pid)
+				if @pgid
+					# Set this process as part of the existing process group:
+					::Process.setpgid(pid, @pgid)
+				else
+					# Establishes the child process as a process group leader:
+					::Process.setpgid(pid, 0)
+					
+					# Save the process group id:
+					@pgid = pid
+				end
+				
+				@running[pid] = Fiber.current
+				
+				# Return process status:
+				if result = Fiber.yield
+					return result
+				else
+					raise Interrupt
+				end
+			end
+		end
+	end
+end

data/lib/async/container/threaded.rb

@@ -20,12 +20,14 @@
 
 require 'async/reactor'
 require 'thread'
+
+require_relative 'controller'
 require_relative 'statistics'
 
 module Async
 	module Container
 		# Manages a reactor within one or more threads.
-		class Threaded
+		class Threaded < Controller
 			class Instance
 				def initialize(thread)
 					@thread = thread
@@ -40,6 +42,10 @@ module Async
 				self.new.run(*args, &block)
 			end
 			
+			def self.multiprocess?
+				false
+			end
+			
 			def initialize
 				@threads = []
 				@running = true
@@ -48,14 +54,6 @@ module Async
 			
 			attr :statistics
 			
-			def run(count: Container.processor_count, **options, &block)
-				count.times do
-					async(**options, &block)
-				end
-				
-				return self
-			end
-			
 			def spawn(name: nil, restart: false, &block)
 				@statistics.spawn!
 				
@@ -90,25 +88,7 @@ module Async
 				return self
 			end
 			
-			def async(name: nil, restart: false, &block)
-				spawn do |instance|
-					begin
-						Async::Reactor.run(instance, &block)
-					rescue Interrupt
-						# Graceful exit.
-					end
-				end
-				
-				return self
-			end
-			
-			def self.multiprocess?
-				false
-			end
-			
 			def wait
-				yield if block_given?
-				
 				@threads.each(&:join)
 				@threads.clear
 				
@@ -118,7 +98,7 @@ module Async
 			end
 			
 			# Gracefully shut down all reactors.
-			def stop(graceful = true, &block)
+			def stop(graceful = true)
 				@running = false
 				
 				if graceful
@@ -127,7 +107,7 @@ module Async
 					@threads.each(&:kill)
 				end
 				
-				self.wait(&block)
+				self.wait
 			ensure
 				@running = true
 			end

data/lib/async/container/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module Container
-		VERSION = "0.10.2"
+		VERSION = "0.11.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-container
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2019-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: process-group
@@ -144,11 +144,11 @@ files:
 - lib/async/container.rb
 - lib/async/container/controller.rb
 - lib/async/container/forked.rb
+- lib/async/container/group.rb
 - lib/async/container/hybrid.rb
 - lib/async/container/statistics.rb
 - lib/async/container/threaded.rb
 - lib/async/container/version.rb
-- spec/async/container/controller_spec.rb
 - spec/async/container/forked_spec.rb
 - spec/async/container/hybrid_spec.rb
 - spec/async/container/shared_examples.rb
@@ -180,7 +180,6 @@ signing_key:
 specification_version: 4
 summary: Async is an asynchronous I/O framework based on nio4r.
 test_files:
-- spec/async/container/controller_spec.rb
 - spec/async/container/forked_spec.rb
 - spec/async/container/hybrid_spec.rb
 - spec/async/container/shared_examples.rb

data/spec/async/container/controller_spec.rb

@@ -1,43 +0,0 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require "async/container/controller"
-
-RSpec.describe Async::Container::Controller do
-	it 'can manage multiple containers' do
-		mutex = Mutex.new
-		count = 0
-		
-		subject << Async::Container::Threaded.run(count: 2) do
-			mutex.synchronize do
-				count += 1
-			end
-		end
-		
-		subject << Async::Container::Threaded.run(count: 2) do
-			mutex.synchronize do
-				count += 1
-			end
-		end
-		
-		subject.wait
-		expect(count).to be == 4
-	end
-end