thoughtafter-lockfile 2.0.0

data/samples/a.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+$:.unshift '../lib'
+#
+# puts this script in an nfs located directory and run from a couple of nodes at
+# once.  the list should appear ordered from either host - note that times may
+# not be ordered depending on the system clocks
+#
+
+#
+# builtin
+#
+  require 'socket'
+  require 'pstore'
+#
+# do what we can to invalidate any nfs caching
+#
+  def timestamp time = Time.now
+#{{{
+    usec = "#{ time.usec }"
+    usec << ('0' * (6 - usec.size)) if usec.size < 6 
+    time.strftime('%Y-%m-%d %H:%M:%S.') << usec
+#}}}
+  end
+  def hostname
+#{{{
+    @__hostname__ ||= Socket::gethostname
+#}}}
+  end
+  def tmpnam dir = Dir.tmpdir, seed = File.basename($0)
+#{{{
+    pid = Process.pid
+    path = "%s_%s_%s_%s_%d" % 
+      [hostname, seed, pid, timestamp.gsub(/\s+/o,'_'), rand(101010)]
+    File.join(dir, path)
+#}}}
+  end
+  def uncache file 
+#{{{
+    refresh = nil
+    begin
+      is_a_file = File === file
+      path = (is_a_file ? file.path : file.to_s) 
+      stat = (is_a_file ? file.stat : File.stat(file.to_s)) 
+      refresh = tmpnam(File.dirname(path))
+      File.link path, refresh rescue File.symlink path, refresh
+      File.chmod stat.mode, path
+      File.utime stat.atime, stat.mtime, path
+    ensure 
+      begin
+        File.unlink refresh if refresh
+      rescue Errno::ENOENT
+      end
+    end
+#}}}
+  end
+#
+# raa - http://raa.ruby-lang.org/project/lockfile/
+#
+  require 'lockfile'
+  pstore = PStore.new 'test.db'
+  timeout = 60
+  max_age = 8
+  refresh = 2
+  debug = false
+  lockfile = Lockfile.new 'test.lock', 
+                          :timeout => timeout,
+                          :max_age => max_age,
+                          :refresh => refresh,
+                          :debug   => debug
+#
+# flock throws ENOLCK on nfs file systems in newer linux kernels
+# plus we want to show that lockfile alone can do the locking
+#
+  class File
+    def flock(*args,&block);true;end
+  end
+#
+# if locking does not work this loop will blow up (Marshal load error) or appear
+# un-ordered.  actually it will eventually blow up due to nfs caching - but that
+# is not the fault of the lockfile class!  for the most part it is a simply demo
+# of locking.  the file will never become corrupt, it just will be unreadable at
+# times due to kernel caching.
+#
+  loop do
+    lockfile.lock do
+      uncache pstore.path 
+      pstore.transaction do
+      #
+      # get/update list
+      #
+        pstore[:list] = [] unless pstore.root? :list
+        list = pstore[:list]
+        tuple = [list.size, hostname, Time.now.to_f]
+        list << tuple
+      #
+      # show last 16 elements
+      #
+        puts '---'
+        list[-([list.size, 16].min)..-1].each{|tuple| p tuple}
+        puts '---'
+      #
+      # keep it a reasonable size
+      #
+        list.shift while list.size > 1024
+      #
+      # write back updates
+      #
+        pstore[:list] = list
+      end
+    end
+    sleep 1 
+  end

data/samples/lock

@@ -0,0 +1,4 @@
+host: jib.ngdc.noaa.gov
+pid: 18176
+ppid: 5245
+time: 2004-11-18 14:40:43.218731

data/samples/lock.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+export RUBYLIB="../lib:./lib"
+
+export PATH="../bin:./bin:$PATH"
+
+#export LOCKFILE_DEBUG=1
+
+(r=`ruby -e 'p(rand(2))'`; sleep $r; rlock ./lockfile 'sleep 1; printf "\n$$ aquired lock @ `date`\n\n"') &
+(r=`ruby -e 'p(rand(2))'`; sleep $r; rlock ./lockfile 'sleep 1; printf "\n$$ aquired lock @ `date`\n\n"') &
+(r=`ruby -e 'p(rand(2))'`; sleep $r; rlock ./lockfile 'sleep 1; printf "\n$$ aquired lock @ `date`\n\n"') &
+
+wait

data/samples/lockfile

@@ -0,0 +1,4 @@
+host: jib.ngdc.noaa.gov
+pid: 18193
+ppid: 5245
+time: 2004-11-18 14:41:59.320552

data/samples/nfsstore.rb

@@ -0,0 +1,203 @@
+#
+# How to use:
+#
+# db = NFSStore.new("/tmp/foo")
+# db.transaction do
+#   p db.roots
+#   ary = db["root"] = [1,2,3,4]
+#   ary[0] = [1,1.5]
+# end
+
+# db.transaction do
+#   p db["root"]
+# end
+
+require "ftools"
+require "digest/md5"
+require "socket"
+
+require 'lockfile'
+
+class NFSStore
+  HOSTNAME = Socket::gethostname
+  class Error < StandardError
+  end
+
+  def initialize(file)
+    dir = File::dirname(file)
+    unless File::directory? dir
+      raise NFSStore::Error, format("directory %s does not exist", dir)
+    end
+    if File::exist? file and not File::readable? file
+      raise NFSStore::Error, format("file %s not readable", file)
+    end
+    @transaction = false
+    @filename = file
+    @lockfile = Lockfile.new "#{ @filename }.lock",:max_age=>64,:refresh=>8
+    @abort = false
+  end
+
+  def in_transaction
+    raise NFSStore::Error, "not in transaction" unless @transaction
+  end
+  private :in_transaction
+
+  def [](name)
+    in_transaction
+    @table[name]
+  end
+  def fetch(name, default=NFSStore::Error)
+    unless @table.key? name
+      if default==NFSStore::Error
+	raise NFSStore::Error, format("undefined root name `%s'", name)
+      else
+	default
+      end
+    end
+    self[name]
+  end
+  def []=(name, value)
+    in_transaction
+    @table[name] = value
+  end
+  def delete(name)
+    in_transaction
+    @table.delete name
+  end
+  def roots
+    in_transaction
+    @table.keys
+  end
+  def root?(name)
+    in_transaction
+    @table.key? name
+  end
+  def path
+    @filename
+  end
+  def commit
+    in_transaction
+    @abort = false
+    throw :pstore_abort_transaction
+  end
+  def abort
+    in_transaction
+    @abort = true
+    throw :pstore_abort_transaction
+  end
+
+  # do what we can to invalidate any nfs caching
+  def uncache file 
+    begin
+      stat = file.stat
+      path = file.path
+      refresh = "%s.%s.%s.%s" % [path, HOSTNAME, $$, Time.now.to_i % 1024] 
+      File.link path, refresh
+      file.chmod stat.mode
+      File.utime stat.atime, stat.mtime, path
+    rescue Exception => e 
+      warn e
+    ensure
+      begin
+        File.unlink refresh if File.exist? refresh
+      rescue Exception => e
+        warn e
+      end
+    end
+  end
+
+
+  def transaction(read_only=false)
+    raise NFSStore::Error, "nested transaction" if @transaction
+    file = nil
+    value = nil
+
+@lockfile.lock do
+      begin
+        @transaction = true
+        backup = @filename+"~"
+        begin
+          file = File::open(@filename, read_only ? "rb" : "rb+")
+          orig = true
+        rescue Errno::ENOENT
+          raise if read_only
+          file = File::open(@filename, "wb+")
+        end
+        #file.flock(read_only ? File::LOCK_SH : File::LOCK_EX)
+        uncache file
+        file.rewind
+        if read_only
+          @table = Marshal::load(file)
+        elsif orig and (content = file.read) != ""
+          @table = Marshal::load(content)
+          size = content.size
+          md5 = Digest::MD5.digest(content)
+          content = nil		# unreference huge data
+        else
+          @table = {}
+        end
+        begin
+          catch(:pstore_abort_transaction) do
+            value = yield(self)
+          end
+        rescue Exception
+          @abort = true
+          raise
+        ensure
+          if !read_only and !@abort
+            file.rewind
+            content = Marshal::dump(@table)
+            if !md5 || size != content.size || md5 != Digest::MD5.digest(content)
+              File::copy @filename, backup
+              begin
+                file.write(content)
+                file.truncate(file.pos)
+                content = nil		# unreference huge data
+              rescue
+                File::rename backup, @filename if File::exist?(backup)
+                raise
+              end
+            end
+          end
+          if @abort and !orig
+            File.unlink(@filename)
+          end
+          @abort = false
+        end
+      ensure
+        @table = nil
+        @transaction = false
+        file.close if file
+      end
+end
+      value
+  end
+end
+
+
+
+
+
+
+
+
+
+if __FILE__ == $0
+  db = NFSStore.new("/tmp/foo")
+  db.transaction do
+    p db.roots
+    ary = db["root"] = [1,2,3,4]
+    ary[1] = [1,1.5]
+  end
+
+  1000.times do
+    db.transaction do
+      db["root"][0] += 1
+      p db["root"][0]
+    end
+  end
+
+  db.transaction(true) do
+    p db["root"]
+  end
+end

data/samples/out

@@ -0,0 +1,80 @@
+lock_id <
+{"pid"=>"15681", "time"=>"2004-11-16 17:08:42.931418", "host"=>"jib.ngdc.noaa.gov", "ppid"=>"15674"}
+>
+attempting to lock <./lockfile>...
+polling attempt <0>...
+aquired lock <./lockfile>
+touched <./lockfile> @ <1100650122.93628>
+loaded <
+{"pid"=>"15681", "time"=>"2004-11-16 17:08:42.931418", "host"=>"jib.ngdc.noaa.gov", "ppid"=>"15674"}
+>
+
+
+
+15682 aquired lock @ Tue Nov 16 17:08:43 MST 2004
+
+
+lock_id <
+{"pid"=>"15685", "time"=>"2004-11-16 17:08:43.962744", "host"=>"jib.ngdc.noaa.gov", "ppid"=>"15676"}
+>
+attempting to lock <./lockfile>...
+polling attempt <0>...
+poll sleep <0.08>...
+lock_id <
+{"pid"=>"15684", "time"=>"2004-11-16 17:08:43.964636", "host"=>"jib.ngdc.noaa.gov", "ppid"=>"15672"}
+>
+attempting to lock <./lockfile>...
+polling attempt <0>...
+poll sleep <0.08>...
+polling attempt <1>...polling attempt <1>...
+
+aquired lock <./lockfile>
+poll sleep <0.08>...
+touched <./lockfile> @ <1100650124.04751>
+loaded <
+{"pid"=>"15685", "time"=>"2004-11-16 17:08:43.962744", "host"=>"jib.ngdc.noaa.gov", "ppid"=>"15676"}
+>
+polling attempt <2>...
+poll sleep <0.08>...
+polling attempt <3>...
+poll sleep <0.08>...
+polling attempt <4>...
+poll sleep <0.08>...
+polling attempt <5>...
+poll sleep <0.08>...
+polling attempt <6>...
+poll sleep <0.08>...
+polling attempt <7>...
+poll sleep <0.08>...
+polling attempt <8>...
+poll sleep <0.08>...
+polling attempt <9>...
+poll sleep <0.08>...
+polling attempt <10>...
+poll sleep <0.08>...
+polling attempt <11>...
+poll sleep <0.08>...
+polling attempt <12>...
+poll sleep <0.08>...
+polling attempt <13>...
+poll sleep <0.08>...
+
+
+
+15690 aquired lock @ Tue Nov 16 17:08:45 MST 2004
+
+
+polling attempt <14>...
+poll sleep <0.08>...
+polling attempt <15>...
+aquired lock <./lockfile>
+touched <./lockfile> @ <1100650125.16655>
+loaded <
+{"pid"=>"15684", "time"=>"2004-11-16 17:08:43.964636", "host"=>"jib.ngdc.noaa.gov", "ppid"=>"15672"}
+>
+
+
+
+15694 aquired lock @ Tue Nov 16 17:08:46 MST 2004
+
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: thoughtafter-lockfile
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
+platform: ruby
+authors: 
+- Ara T. Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-01 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ara.t.howard@gmail.com
+executables: 
+- rlock
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/rlock
+- doc/rlock.help
+- lib/lockfile.rb
+- rakefile
+- readme.erb
+- samples/a.rb
+- samples/lock
+- samples/lock.sh
+- samples/lockfile
+- samples/nfsstore.rb
+- samples/out
+has_rdoc: true
+homepage: http://github.com/ahoward/lockfile/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: codeforpeople
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: lockfile
+test_files: []
+