1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Locking using OS file locks or file existence.
20
Note: This method of locking is generally deprecated in favour of LockDir, but
21
is used to lock local WorkingTrees, and by some old formats. It's accessed
22
through Transport.lock_read(), etc.
24
This module causes two methods, lock() and unlock() to be defined in
25
any way that works on the current platform.
27
It is not specified whether these locks are reentrant (i.e. can be
28
taken repeatedly by a single process) or whether they exclude
29
different threads in a single process. That reentrancy is provided by
32
This defines two classes: ReadLock and WriteLock, which can be
33
implemented in different ways on different platforms. Both have an
41
from bzrlib.errors import LockError, LockContention
42
from bzrlib.osutils import realpath
43
from bzrlib.trace import mutter
46
class _base_Lock(object):
48
def _open(self, filename, filemode):
50
self.f = open(filename, filemode)
53
if e.errno != errno.ENOENT:
56
# maybe this is an old branch (before may 2005)
57
mutter("trying to create missing branch lock %r", filename)
59
self.f = open(filename, 'wb+')
64
from warnings import warn
65
warn("lock on %r not released" % self.f)
69
raise NotImplementedError()
72
############################################################
79
class _fcntl_FileLock(_base_Lock):
84
fcntl.lockf(self.f, fcntl.LOCK_UN)
88
"""Clear the self.f attribute cleanly."""
93
class _fcntl_WriteLock(_fcntl_FileLock):
97
def __init__(self, filename):
98
# standard IO errors get exposed directly.
99
self._open(filename, 'rb+')
100
self.filename = realpath(filename)
101
if self.filename in self.open_locks:
103
raise LockContention("Lock already held.")
104
# reserve a slot for this lock - even if the lockf call fails,
105
# at thisi point unlock() will be called, because self.f is set.
106
# TODO: make this fully threadsafe, if we decide we care.
107
self.open_locks[self.filename] = self.filename
109
# LOCK_NB will cause IOError to be raised if we can't grab a
111
fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
113
if e.errno in (errno.EAGAIN, errno.EACCES):
114
# We couldn't grab the lock
116
# we should be more precise about whats a locking
117
# error and whats a random-other error
121
del self.open_locks[self.filename]
125
class _fcntl_ReadLock(_fcntl_FileLock):
127
def __init__(self, filename):
128
# standard IO errors get exposed directly.
129
self._open(filename, 'rb')
131
# LOCK_NB will cause IOError to be raised if we can't grab a
133
fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
135
# we should be more precise about whats a locking
136
# error and whats a random-other error
143
WriteLock = _fcntl_WriteLock
144
ReadLock = _fcntl_ReadLock
149
import win32con, win32file, pywintypes
152
LOCK_SH = 0 # the default
153
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
154
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
156
class _w32c_FileLock(_base_Lock):
157
def _lock(self, filename, openmode, lockmode):
159
self._open(filename, openmode)
160
self.hfile = win32file._get_osfhandle(self.f.fileno())
161
overlapped = pywintypes.OVERLAPPED()
162
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
171
overlapped = pywintypes.OVERLAPPED()
172
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
179
class _w32c_ReadLock(_w32c_FileLock):
180
def __init__(self, filename):
181
_w32c_FileLock._lock(self, filename, 'rb',
184
class _w32c_WriteLock(_w32c_FileLock):
185
def __init__(self, filename):
186
_w32c_FileLock._lock(self, filename, 'rb+',
190
WriteLock = _w32c_WriteLock
191
ReadLock = _w32c_ReadLock
198
# Unfortunately, msvcrt.locking() doesn't distinguish between
199
# read locks and write locks. Also, the way the combinations
200
# work to get non-blocking is not the same, so we
201
# have to write extra special functions here.
204
class _msvc_FileLock(_base_Lock):
215
class _msvc_ReadLock(_msvc_FileLock):
216
def __init__(self, filename):
217
_msvc_lock(self._open(filename, 'rb'),
218
self.LOCK_SH | self.LOCK_NB)
221
class _msvc_WriteLock(_msvc_FileLock):
222
def __init__(self, filename):
223
_msvc_lock(self._open(filename, 'rb+'),
224
self.LOCK_EX | self.LOCK_NB)
227
def _msvc_lock(f, flags):
229
# Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
230
# according to the comments, LK_RLCK is open the lock for writing.
232
# Unfortunately, msvcrt.locking() also has the side effect that it
233
# will only block for 10 seconds at most, and then it will throw an
234
# exception, this isn't terrible, though.
241
fpos = os.lseek(fn, 0,0)
244
if flags & _msvc_FileLock.LOCK_SH:
245
if flags & _msvc_FileLock.LOCK_NB:
246
lock_mode = msvcrt.LK_NBLCK
248
lock_mode = msvcrt.LK_LOCK
249
elif flags & _msvc_FileLock.LOCK_EX:
250
if flags & _msvc_FileLock.LOCK_NB:
251
lock_mode = msvcrt.LK_NBRLCK
253
lock_mode = msvcrt.LK_RLCK
255
raise ValueError('Invalid lock mode: %r' % flags)
257
msvcrt.locking(fn, lock_mode, -1)
259
os.lseek(fn, fpos, 0)
271
fpos = os.lseek(fn, 0,0)
275
msvcrt.locking(fn, msvcrt.LK_UNLCK, -1)
277
os.lseek(fn, fpos, 0)
282
WriteLock = _msvc_WriteLock
283
ReadLock = _msvc_ReadLock
285
raise NotImplementedError("please write a locking method "
286
"for platform %r" % sys.platform)
added
removed
bzrlib/lock.py
