slave 0.0.0

data/gemspec.rb

@@ -0,0 +1,23 @@
+lib, version = File::basename(File::dirname(File::expand_path(__FILE__))).split %r/-/, 2
+
+require 'rubygems'
+
+Gem::Specification::new do |spec|
+  spec.name = lib 
+  spec.version = version 
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = lib 
+
+  spec.files = Dir::glob "**/**"
+  spec.executables = Dir::glob("bin/*").map{|exe| File::basename exe}
+  
+  spec.require_path = "lib" 
+  spec.autorequire = lib
+
+  spec.has_rdoc = File::exist? "doc" 
+  spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"
+
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@noaa.gov"
+  spec.homepage = "http://codeforpeople.com/lib/ruby/#{ lib }/"
+end

data/install.rb

@@ -0,0 +1,201 @@
+#!/usr/bin/env ruby
+require 'rbconfig'
+require 'find'
+require 'ftools'
+require 'tempfile'
+include Config
+
+LIBDIR      = "lib"
+LIBDIR_MODE = 0644
+
+BINDIR      = "bin"
+BINDIR_MODE = 0755
+
+
+$srcdir            = CONFIG["srcdir"]
+$version           = CONFIG["MAJOR"]+"."+CONFIG["MINOR"]
+$libdir            = File.join(CONFIG["libdir"], "ruby", $version)
+$archdir           = File.join($libdir, CONFIG["arch"])
+$site_libdir       = $:.find {|x| x =~ /site_ruby$/}
+$bindir            = CONFIG["bindir"] || CONFIG['BINDIR']
+$ruby_install_name = CONFIG['ruby_install_name'] || CONFIG['RUBY_INSTALL_NAME'] || 'ruby'
+$ruby_ext          = CONFIG['EXEEXT'] || ''
+$ruby              = File.join($bindir, ($ruby_install_name + $ruby_ext))
+
+if !$site_libdir
+  $site_libdir = File.join($libdir, "site_ruby")
+elsif $site_libdir !~ %r/#{Regexp.quote($version)}/
+  $site_libdir = File.join($site_libdir, $version)
+end
+
+def install_rb(srcdir=nil, destdir=nil, mode=nil, bin=nil)
+#{{{
+  path   = []
+  dir    = []
+  Find.find(srcdir) do |f|
+    next unless FileTest.file?(f)
+    next if (f = f[srcdir.length+1..-1]) == nil
+    next if (/CVS$/ =~ File.dirname(f))
+    next if f =~ %r/\.lnk/
+    path.push f
+    dir |= [File.dirname(f)]
+  end
+  for f in dir
+    next if f == "."
+    next if f == "CVS"
+    File::makedirs(File.join(destdir, f))
+  end
+  for f in path
+    next if (/\~$/ =~ f)
+    next if (/^\./ =~ File.basename(f))
+    unless bin
+      File::install(File.join(srcdir, f), File.join(destdir, f), mode, true)
+    else
+      from = File.join(srcdir, f)
+      to = File.join(destdir, f)
+      shebangify(from) do |sf|
+        $deferr.print from, " -> ", File::catname(from, to), "\n"
+        $deferr.printf "chmod %04o %s\n", mode, to 
+        File::install(sf, to, mode, false)
+      end
+    end
+  end
+#}}}
+end
+def shebangify f
+#{{{
+  open(f) do |fd|
+    buf = fd.read 42 
+    if buf =~ %r/^\s*#\s*!.*ruby/o
+      ftmp = Tempfile::new("#{ $$ }_#{ File::basename(f) }")
+      begin
+        fd.rewind
+        ftmp.puts "#!#{ $ruby  }"
+        while((buf = fd.read(8192)))
+          ftmp.write buf
+        end
+        ftmp.close
+        yield ftmp.path
+      ensure
+        ftmp.close!
+      end
+    else
+      yield f
+    end
+  end
+#}}}
+end
+def ARGV.switch
+#{{{
+  return nil if self.empty?
+  arg = self.shift
+  return nil if arg == '--'
+  if arg =~ /^-(.)(.*)/
+    return arg if $1 == '-'
+    raise 'unknown switch "-"' if $2.index('-')
+    self.unshift "-#{$2}" if $2.size > 0
+    "-#{$1}"
+  else
+    self.unshift arg
+    nil
+  end
+#}}}
+end
+def ARGV.req_arg
+#{{{
+  self.shift || raise('missing argument')
+#}}}
+end
+def linkify d, linked = []
+#--{{{
+  if test ?d, d
+    versioned = Dir[ File::join(d, "*-[0-9].[0-9].[0-9].rb") ]
+    versioned.each do |v| 
+      src, dst = v, v.gsub(%r/\-[\d\.]+\.rb$/, '.rb')
+      lnk = nil
+      begin
+        if test ?l, dst
+          lnk = "#{ dst }.lnk"
+          puts "#{ dst } -> #{ lnk }"
+          File::rename dst, lnk
+        end
+        unless test ?e, dst
+          puts "#{ src } -> #{ dst }"
+          File::copy src, dst 
+          linked << dst
+        end
+      ensure
+        if lnk
+          at_exit do
+            puts "#{ lnk } -> #{ dst }"
+            File::rename lnk, dst
+          end
+        end
+      end
+    end
+  end
+  linked
+#--}}}
+end
+
+
+#
+# main program
+#
+
+libdir = $site_libdir
+bindir = $bindir
+no_linkify = false
+linked = nil
+help = false
+
+usage = <<-usage
+  #{ File::basename $0 }
+    -d, --destdir    <destdir>
+    -l, --libdir     <libdir>
+    -b, --bindir     <bindir>
+    -r, --ruby       <ruby>
+    -n, --no_linkify
+    -h, --help
+usage
+
+begin
+  while switch = ARGV.switch
+    case switch
+    when '-d', '--destdir'
+      libdir = ARGV.req_arg
+    when '-l', '--libdir'
+      libdir = ARGV.req_arg
+    when '-b', '--bindir'
+      bindir = ARGV.req_arg
+    when '-r', '--ruby'
+      $ruby = ARGV.req_arg
+    when '-n', '--no_linkify'
+      no_linkify = true
+    when '-h', '--help'
+      help = true
+    else
+      raise "unknown switch #{switch.dump}"
+    end
+  end
+rescue
+  STDERR.puts $!.to_s
+  STDERR.puts usage
+  exit 1
+end    
+
+if help
+  STDOUT.puts usage
+  exit
+end
+
+unless no_linkify
+  linked = linkify('lib') + linkify('bin')
+end
+
+install_rb(LIBDIR, libdir, LIBDIR_MODE)
+install_rb(BINDIR, bindir, BINDIR_MODE, bin=true)
+
+if linked
+  linked.each{|path| File::rm_f path}
+end

data/lib/slave-0.0.0.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