slave 0.0.0

data/lib/slave.rb

@@ -0,0 +1,292 @@
+require 'drb/drb'
+require 'fileutils'
+require 'tmpdir'
+require 'tempfile'
+
+#
+# the Slave class encapsulates the work of setting up a drb server in another
+# process. 
+#
+  class Slave
+#--{{{
+    DEFAULT_SOCKET_CREATION_ATTEMPTS =
+      Integer(ENV['SLAVE_SOCKET_CREATION_ATTEMPTS'] || 42)
+
+    DEFAULT_PULSE_RATE = 
+      Float(ENV['SLAVE_PULSE_RATE'] || 8)
+
+    DEFAULT_DEBUG = 
+      (ENV['SLAVE_DEBUG'] ? true : false)
+
+    @socket_creation_attempts = DEFAULT_SOCKET_CREATION_ATTEMPTS
+    @pulse_rate = DEFAULT_PULSE_RATE
+    @debug = DEFAULT_DEBUG
+
+    class << self
+#--{{{
+      # defineds how many attempts will be made to create a temporary unix domain
+      # socket
+      attr :socket_creation_attempts, true
+
+      # defined the rate of pinging in the Heartbeat object
+      attr :pulse_rate, true
+
+      # if this is true and you are running from a terminal information is printed
+      # on STDERR
+      attr :debug, true
+
+      # look up a value in an option hash failing back to class defaults
+      def getval key, opts = {}
+#--{{{
+        keys = [key, key.to_s, key.to_s.intern]
+        keys.each{|k| return opts[k] if opts.has_key?(k)}
+        send key rescue nil
+#--}}}
+      end
+      # just fork with out silly warnings
+      def fork &block
+#--{{{
+        v = $VERBOSE
+        begin
+          $VERBOSE = nil
+          Process::fork &block
+        ensure
+        $VERBOSE = v
+        end
+#--}}}
+      end
+#--}}}
+    end
+
+    attr :object
+    attr :obj
+    attr :psname
+    attr :pid
+    attr :ppid
+    attr :uri
+    attr :pulse_rate
+    attr :socket
+    attr :debug
+
+    # 'obj' can be any object and 'opts' may contain the keys
+    # 'socket_creation_attempts', 'pulse_rate', 'psname', or 'debug'
+    def initialize obj, opts = {}
+#--{{{
+      @obj = obj
+
+      @socket_creation_attempts = getval('socket_creation_attempts', opts)
+      @pulse_rate = getval('pulse_rate', opts)
+      @debug = getval('debug', opts)
+      @psname = getval('psname', opts) || gen_psname(@obj)
+
+      trace{ "socket_creation_attempts <#{ @socket_creation_attempts }>" }
+      trace{ "pulse_rate <#{ @pulse_rate }>" }
+      trace{ "psname <#{ @psname }>" }
+
+      @shutdown = false
+
+      @heartbeat = Heartbeat::new @pulse_rate, @debug
+      @r, @w = IO::pipe
+    #
+    # child
+    #
+      unless((@pid = Slave::fork))
+        begin
+          $0 = @psname 
+          @pid = Process::pid
+          @ppid = Process::ppid
+
+          @r.close
+          @socket = nil
+          @uri = nil
+
+          tmpdir = Dir::tmpdir
+          basename = File::basename @psname
+
+          @socket_creation_attempts.times do |attempt|
+            begin
+              s = File::join(tmpdir, "#{ basename }_#{ attempt }")
+              u = "drbunix://#{ s }"
+              DRb::start_service u, obj 
+              @socket = s
+              @uri = u
+              trace{ "child - socket <#{ @socket }>" }
+              trace{ "child - uri <#{ @uri }>" }
+              break
+            rescue Errno::EADDRINUSE
+              nil
+            end
+          end
+
+          if @socket and @uri
+            @heartbeat.start
+            @w.write @socket 
+            @w.close
+            trap('SIGUSR2') do
+              @heartbeat.stop rescue nil
+              DBb::thread.kill rescue nil
+              FileUtils::rm_f @socket rescue nil
+              exit!
+            end
+            DRb::thread.join
+          else
+            @w.close
+          end
+        rescue => e
+          trace{ %Q[#{ e.message } (#{ e.class })\n#{ e.backtrace.join "\n" }] }
+        ensure
+          exit!
+        end
+    #
+    # parent 
+    #
+      else
+        Process::detach @pid
+        @w.close
+        @socket = @r.read
+        @r.close
+
+        trace{ "parent - socket <#{ @socket }>" }
+
+        if @socket and File::exist? @socket
+          at_exit{ FileUtils::rm_f @socket }
+          @uri = "drbunix://#{ socket }"
+          trace{ "parent - uri <#{ @uri }>" }
+          @heartbeat.start
+        #
+        # starting drb on localhost avoids dns lookups!
+        #
+          DRb::start_service('druby://localhost:0', nil) unless DRb::thread
+          @object = DRbObject::new nil, @uri
+        else
+          raise "failed to find slave socket <#{ @socket }>"
+        end
+      end
+#--}}}
+    end
+    # stops the heartbeat thread and kills the child process
+    def shutdown
+#--{{{
+      raise "already shutdown" if @shutdown
+      @heartbeat.stop rescue nil
+      Process::kill('SIGUSR2', @pid) rescue nil
+      Process::kill('SIGTERM', @pid) rescue nil
+      FileUtils::rm_f @socket
+      @shutdown = true
+#--}}}
+    end
+    # generate a default name to appear in ps/top
+    def gen_psname obj
+#--{{{
+      "#{ obj.class }_slave_of_#{ Process::pid }".downcase
+#--}}}
+    end
+    # see docs for class.getval
+    def getval key, opts = {}
+#--{{{
+      self.class.getval key
+#--}}}
+    end
+    # debugging output
+    def trace
+#--{{{
+      STDERR.puts(yield) if @debug and STDERR.tty?
+#--}}}
+    end
+
+  #
+  # the Heartbeat class is essentially wrapper over an IPC channel that sends a
+  # ping on the channel indicating process health.  if either end of the channel
+  # is detached the ping will fail and an error will be raised.  in this was it
+  # is ensured that Slave object cannot continue to live without their parent
+  # being alive.
+  #
+    class Heartbeat
+#--{{{
+      def initialize pulse_rate = 4.2, debug = false
+#--{{{
+        @pulse_rate = Float pulse_rate
+        @debug = debug
+        @r, @w = IO::pipe
+        @pid = Process::pid
+        @ppid = Process::ppid
+        @cid = nil
+        @thread = nil
+        @ppid = nil
+        @whoami = nil
+        @beating = nil
+        @pipe = nil
+#--}}}
+      end
+      def start 
+#--{{{
+        if Process::pid == @pid
+          @w.close
+          @pipe = @r
+          parent_start
+        else
+          @r.close
+          @pipe = @w
+          child_start
+        end
+        @beating = true 
+#--}}}
+      end
+      def parent_start
+#--{{{
+        @whoami = 'parent' 
+        @thread =
+          Thread::new(Thread::current) do |cur|
+            begin
+              loop do 
+                buf = @pipe.gets
+                trace{ "<#{ @whoami }> <#{ @pid }> gets <#{ buf.inspect }>" }
+                @cid = Integer buf.strip if @cid.nil? and buf =~ %r/^\s*\d+\s*$/
+              end
+            rescue => e
+              cur.raise e
+            ensure
+              @pipe.close rescue nil
+            end
+          end
+#--}}}
+      end
+      def child_start
+#--{{{
+        @whoami = 'child' 
+        @pid = Process::pid
+        @ppid = Process::ppid
+        @thread =
+          Thread::new(Thread::current) do |cur|
+            begin
+              loop do
+                trace{ "<#{ @whoami }> <#{ @pid }> puts <#{ @pid }>" }
+                @pipe.puts @pid 
+                Process::kill 0, @ppid
+                sleep @pulse_rate 
+              end
+            rescue => e
+              cur.raise e
+            ensure
+              @pipe.close rescue nil
+            end
+          end
+#--}}}
+      end
+      def stop 
+#--{{{
+        raise "not beating" unless @beating
+        @thread.kill
+        @pipe.close rescue nil
+        @beating = false
+#--}}}
+      end
+      def trace
+#--{{{
+        STDERR.puts(yield) if @debug and STDERR.tty?
+#--}}}
+      end
+#--}}}
+    end # class Heartbeat
+#--}}}
+  end # class Slave 

data/rdoc.cmd

@@ -0,0 +1 @@
+rdoc -a -d -F -S -m README -I jpg -N README VERSION lib/slave.rb

data/sample/a.rb

@@ -0,0 +1,102 @@
+$:.unshift 'lib'
+$:.unshift '../lib'
+
+require 'slave'
+
+class Incrementer
+  attr :decrementer, true
+  def increment n
+    n + 1
+  end
+  def decrement n
+    @decrementer.decrement n
+  end
+end
+
+class Decrementer
+  attr :incrementer, true
+  def increment n
+    @incrementer.increment n
+  end
+  def decrement n
+    n - 1
+  end
+end
+
+
+#
+#
+# here we set up a triangle of communicating processes
+#
+#      incrementer------decrementer
+#           \               /
+#            \             /
+#             \           /
+#              \         /
+#               \       /
+#                 parent
+#
+#
+
+incrementer_slave = Slave::new Incrementer::new
+incrementer = incrementer_slave.object 
+
+puts '---'
+puts 'incrementer :'
+puts "  sockect   : #{ incrementer_slave.socket.inspect }"
+puts "  uri       : #{ incrementer_slave.uri.inspect }"
+puts "  pid       : #{ incrementer_slave.pid.inspect }"
+puts
+
+decrementer_slave = Slave::new Decrementer::new
+decrementer = decrementer_slave.object 
+
+puts '---'
+puts 'decrementer :'
+puts "  sockect   : #{ decrementer_slave.socket.inspect }"
+puts "  uri       : #{ decrementer_slave.uri.inspect }"
+puts "  pid       : #{ decrementer_slave.pid.inspect }"
+puts
+
+#
+# connect incrementer and decrementer
+#
+
+incrementer.decrementer = decrementer
+decrementer.incrementer = incrementer
+
+#
+# now we can call methods on each drb object, and they can also call methods on
+# each other
+#
+
+n = 0 
+
+n = incrementer.increment n
+p n #=> 1
+
+n = decrementer.decrement n 
+p n #=> 0
+
+n = decrementer.increment n
+p n #=> 1
+
+n = incrementer.decrement n
+p n #=> 0
+
+#
+# we can explicitly shutdown certain slaves
+#
+
+incrementer_slave.shutdown
+n = decrementer.decrement 43 
+p n #=> 42 
+
+#
+# Slaves cannot live beyond their parent so we simply exit and all living slaves
+# will eventually die.  how long it takes to die is determined by the
+# pulse_rate - the next time the Heartbeat trys to ping the parent the Slave
+# will die.
+#
+
+exit

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: slave
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+date: 2006-05-27 00:00:00.000000 -06:00
+summary: slave
+require_paths: 
+  - lib
+email: ara.t.howard@noaa.gov
+homepage: http://codeforpeople.com/lib/ruby/slave/
+rubyforge_project: 
+description: 
+autorequire: slave
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+  - Ara T. Howard
+files: 
+  - install.rb
+  - lib
+  - sample
+  - rdoc.cmd
+  - doc
+  - VERSION
+  - README
+  - gemspec.rb
+  - slave-0.0.0.gem
+  - lib/slave-0.0.0.rb
+  - lib/slave.rb
+  - sample/a.rb
+  - doc/created.rid
+  - doc/dot
+  - doc/rdoc-style.css
+  - doc/files
+  - doc/classes
+  - doc/fr_file_index.html
+  - doc/fr_class_index.html
+  - doc/fr_method_index.html
+  - doc/index.html
+  - doc/dot/f_0.dot
+  - doc/dot/f_0.jpg
+  - doc/dot/f_1.dot
+  - doc/dot/f_1.jpg
+  - doc/dot/f_2.dot
+  - doc/dot/f_2.jpg
+  - doc/files/VERSION.html
+  - doc/files/lib
+  - doc/files/README.html
+  - doc/files/lib/slave_rb.html
+  - doc/classes/Slave.html
+  - doc/classes/Slave
+  - doc/classes/Slave/Heartbeat.html
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: []