forkworker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbe42b40a14925ceef50b2ca98e2428eedf4385fbdbe24b83e8d7036ef478c6b
+  data.tar.gz: a9a150452ff9f4d2df1c7f7f31f5bc3d4247aec0977c1774ae897ed306021e05
+SHA512:
+  metadata.gz: 3324c1e818b7d9fd7111cbed80e0ffa94712b0125581bb29d445561acb4a1f433ae0bf383c6290b79da6d9af196bfa0cd764b4ea434a1a2ed8a44e9075de4e57
+  data.tar.gz: 9e0e70f96f16b3f8b41953e372be5ad36509ba2cf877cb0dcf30eb8294b6eb9fc964d6682c55a532ad6cb6b1ac0d9d370829a7760e07e799b0156c3ed33ffedd

data/lib/forkworker.rb

@@ -0,0 +1,7 @@
+require "forkworker/logger"
+require "forkworker/leader"
+require "forkworker/worker"
+
+module Forkworker
+  class NoMoreWork < StandardError; end
+end

data/lib/forkworker/leader.rb

@@ -0,0 +1,162 @@
+module Forkworker
+  class Leader
+    include Forkworker::Logger
+
+    def initialize(worker_num, pidfile: nil, setup_block: nil, prefork_block: nil, fork_block: nil, reporting_block: nil)
+      @wanted_number_of_workers = worker_num
+      @running = true
+      @worker_pids = []
+      @signals_received = []
+      @pidfile = pidfile
+
+      @setup_block = setup_block
+      @prefork_block = prefork_block
+      @fork_block = fork_block
+      @reporting_block = reporting_block
+
+      write_pid if @pidfile
+    end
+
+    def start!
+      traps
+      update_leader_title
+      @setup_block.call if @setup_block
+      spawn_missing_workers
+
+      gameloop = 1
+
+      until @worker_pids.dup.length == 0 && @running == false
+        sleep 0.25
+
+        # Handle actions
+        while(signal = @signals_received.shift)
+          case signal
+          when 'CHLD'
+            @worker_pids.dup.each do |wpid|
+              begin
+                wpid, _status = Process.waitpid(wpid, Process::WNOHANG)
+                @worker_pids.delete(wpid)
+              rescue Errno::ECHILD
+              end
+            end
+          when 'TTIN'
+            debug "-- handled #{signal}: wanted number of workers are now: #{@wanted_number_of_workers}"
+
+            @wanted_number_of_workers += 1
+          when 'TTOU'
+            unless @wanted_number_of_workers == 0
+              @wanted_number_of_workers -= 1
+            end
+
+            debug "-- handled #{signal}: wanted number of workers are now: #{@wanted_number_of_workers}"
+          when 'TERM'
+            debug "-- handled #{signal}"
+
+            @running = false
+            shutdown_each_worker(:TERM)
+          when 'QUIT'
+            debug "-- handled #{signal}"
+
+            @running = false
+            shutdown_each_worker(:QUIT)
+          end
+        end
+
+        # Spawn missing workers if we are not getting shut down
+        if @running
+          spawn_missing_workers
+        end
+
+        if gameloop % 20 == 0 && @reporting_block
+          @reporting_block.call
+        end
+
+        update_leader_title
+
+        gameloop += 1
+      end
+    end
+
+   private
+
+    def spawn_missing_workers
+      begin
+        while (@worker_pids.length + 1) <= @wanted_number_of_workers
+          worker_data = if @prefork_block
+            @prefork_block.call
+          else
+            nil
+          end
+
+          if(pid = fork)
+            @worker_pids << pid
+            update_leader_title
+          else
+            Worker.new.work!(worker_data, &@fork_block)
+          end
+        end
+      rescue Forkworker::NoMoreWork
+        debug "-- No more work, so we're just finishing up running processes"
+        @running = false
+      end
+    end
+
+    def traps
+      # By trapping the :CHLD signal our process will be notified by the kernel when one of its children exits.
+      trap(:CHLD) do
+        @signals_received << 'CHLD'
+      end
+
+      trap(:TERM) do
+        @signals_received << 'TERM'
+      end
+
+      trap(:TTIN) do
+        @signals_received << 'TTIN'
+      end
+
+      trap(:TTOU) do
+        @signals_received << 'TTOU'
+      end
+
+      [:QUIT, :INT].each do |signal|
+        trap(signal) do
+          @signals_received << 'QUIT'
+        end
+      end
+    end
+
+    def update_leader_title
+      run_state = @running ? 'running' : 'shutting down'
+      $PROGRAM_NAME = "Leader ##{Process.pid} | #{run_state} | Workers=#{@worker_pids.length}/#{@wanted_number_of_workers}"
+    end
+
+    def shutdown_worker(signal, wpid)
+      begin
+        Process.kill(signal, wpid)
+      rescue Errno::ESRCH
+      end
+    end
+
+    def shutdown_each_worker(signal)
+      @worker_pids.dup.each { |wpid| shutdown_worker(signal, wpid) }
+    end
+
+    def write_pid
+      if File.exist?(@pidfile) && (pid = File.read(@pidfile))
+        begin
+          Process.getpgid(pid.to_i) # throws Errno::ESRCH if process with pid exists
+          debug "Program is already running on pid #{pid} specified in #{@pidfile}"
+          exit 1
+        rescue Errno::ESRCH
+          false
+        end
+      end
+
+      File.open(@pidfile, 'w') do |f|
+        f.write Process.pid
+      end
+    end
+
+  end
+end

data/lib/forkworker/logger.rb

@@ -0,0 +1,7 @@
+module Forkworker
+  module Logger
+    def debug(logline)
+      puts logline if ENV["DEBUG"] == "1"
+    end
+  end
+end

data/lib/forkworker/worker.rb

@@ -0,0 +1,32 @@
+module Forkworker
+  class Worker
+    include Forkworker::Logger
+
+    def work!(worker_data, &block)
+      @worker_data = worker_data
+      @running = true
+      update_title("spawned")
+      traps
+
+      instance_eval(&block)
+
+      exit(0)
+    end
+
+    private
+
+    def traps
+      trap(:TERM) do
+        @running = false
+        update_title
+      end
+    end
+
+    def update_title(status = nil)
+      @last_status = status if status
+      run_state = @running ? 'running' : 'shutting down'
+
+      $PROGRAM_NAME = "Worker ##{Process.pid} | #{run_state} | #{@last_status}"
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: forkworker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kasper Grubbe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+description: Forkworker lets you manage forking workloads easily
+email: rubygems@kaspergrubbe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/forkworker.rb
+- lib/forkworker/leader.rb
+- lib/forkworker/logger.rb
+- lib/forkworker/worker.rb
+homepage: https://rubygems.org/gems/forkworker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Manage forking workloads with ease
+test_files: []