Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 127 lines (118 sloc) 4.694 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
# daemon_controller, library for robust daemon management
# Copyright (c) 2010 Phusion
#
# 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 'fcntl'

class DaemonController

# A lock file is a synchronization mechanism, like a Mutex, but it also allows
# inter-process synchronization (as opposed to only inter-thread synchronization
# within a single process).
#
# Processes can obtain either a shared lock or an exclusive lock. It's possible
# for multiple processes to obtain a shared lock on a file as long as no
# exclusive lock has been obtained by a process. If a process has obtained an
# exclusive lock, then no other processes can lock the file, whether they're
# trying to obtain a shared lock or an exclusive lock.
#
# Note that on JRuby, LockFile can only guarantee synchronization between
# threads if the different threads use the same LockFile object. Specifying the
# same filename is not enough.
class LockFile
class AlreadyLocked < StandardError
end

# Create a LockFile object. The lock file is initially not locked.
#
# +filename+ may point to a nonexistant file. In that case, the lock
# file will not be created until one's trying to obtain a lock.
#
# Note that LockFile will use this exact filename. So if +filename+
# is a relative filename, then the actual lock file that will be used
# depends on the current working directory.
def initialize(filename)
@filename = filename
end

# Obtain an exclusive lock on the lock file, yield the given block,
# then unlock the lockfile. If the lock file was already locked (whether
# shared or exclusively) by another process/thread then this method will
# block until the lock file has been unlocked.
#
# The lock file *must* be writable, otherwise an Errno::EACCESS
# exception will be raised.
def exclusive_lock
File.open(@filename, 'w') do |f|
if Fcntl.const_defined? :F_SETFD
f.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
end
f.flock(File::LOCK_EX)
yield
end
end

# Obtain an exclusive lock on the lock file, yield the given block,
# then unlock the lockfile. If the lock file was already exclusively
# locked by another process/thread then this method will
# block until the exclusive lock has been released. This method will not
# block if only shared locks have been obtained.
#
# The lock file *must* be writable, otherwise an Errno::EACCESS
# exception will be raised.
def shared_lock
File.open(@filename, 'w+') do |f|
if Fcntl.const_defined? :F_SETFD
f.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
end
f.flock(File::LOCK_SH)
yield
end
end

# Try to obtain a shared lock on the lock file, similar to #shared_lock.
# But unlike #shared_lock, this method will raise AlreadyLocked if
# no lock can be obtained, instead of blocking.
#
# If a lock can be obtained, then the given block will be yielded.
def try_shared_lock
File.open(@filename, 'w+') do |f|
if Fcntl.const_defined? :F_SETFD
f.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
end
if f.flock(File::LOCK_SH | File::LOCK_NB)
yield
else
raise AlreadyLocked
end
end
end

# Try to obtain an exclusive lock on the lock file, similar to #exclusive_lock.
# But unlike #exclusive_lock, this method will raise AlreadyLocked if
# no lock can be obtained, instead of blocking.
#
# If a lock can be obtained, then the given block will be yielded.
def try_exclusive_lock
File.open(@filename, 'w') do |f|
if Fcntl.const_defined? :F_SETFD
f.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
end
if f.flock(File::LOCK_EX | File::LOCK_NB)
yield
else
raise AlreadyLocked
end
end
end
end # class LockFile
end # class DaemonController
Something went wrong with that request. Please try again.