1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Locking using OS file locks or file existence.
20
This only does local locking using OS locks for now.
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.
22
24
This module causes two methods, lock() and unlock() to be defined in
23
25
any way that works on the current platform.
25
27
It is not specified whether these locks are reentrant (i.e. can be
26
28
taken repeatedly by a single process) or whether they exclude
27
different threads in a single process.
29
Eventually we may need to use some kind of lock representation that
30
will work on a dumb filesystem without actual locking primitives.
29
different threads in a single process. That reentrancy is provided by
32
32
This defines two classes: ReadLock and WriteLock, which can be
33
33
implemented in different ways on different platforms. Both have an
41
from bzrlib.trace import mutter, note, warning
42
from bzrlib.errors import LockError
44
class _base_Lock(object):
47
class _OSLock(object):
45
53
def _open(self, filename, filemode):
54
self.filename = osutils.realpath(filename)
48
self.f = open(filename, filemode)
56
self.f = open(self.filename, filemode)
59
if e.errno in (errno.EACCES, errno.EPERM):
60
raise errors.LockFailed(self.filename, str(e))
51
61
if e.errno != errno.ENOENT:
54
64
# maybe this is an old branch (before may 2005)
55
mutter("trying to create missing branch lock %r" % filename)
57
self.f = open(filename, 'wb')
65
trace.mutter("trying to create missing lock %r", self.filename)
67
self.f = open(self.filename, 'wb+')
71
"""Clear the self.f attribute cleanly."""
63
78
from warnings import warn
64
79
warn("lock on %r not released" % self.f)
69
83
raise NotImplementedError()
76
############################################################
83
class _fcntl_FileLock(_base_Lock):
87
fcntl.flock(self.f, fcntl.LOCK_UN)
93
if sys.platform == 'win32':
95
import win32con, win32file, pywintypes, winerror, msvcrt
105
LOCK_SH = fcntl.LOCK_SH
106
LOCK_NB = fcntl.LOCK_NB
107
lock_EX = fcntl.LOCK_EX
110
class _fcntl_FileLock(_OSLock):
113
fcntl.lockf(self.f, fcntl.LOCK_UN)
92
117
class _fcntl_WriteLock(_fcntl_FileLock):
93
121
def __init__(self, filename):
122
super(_fcntl_WriteLock, self).__init__()
123
# Check we can grab a lock before we actually open the file.
124
self.filename = osutils.realpath(filename)
125
if self.filename in _fcntl_WriteLock._open_locks:
127
raise errors.LockContention(self.filename)
129
self._open(self.filename, 'rb+')
130
# reserve a slot for this lock - even if the lockf call fails,
131
# at thisi point unlock() will be called, because self.f is set.
132
# TODO: make this fully threadsafe, if we decide we care.
133
_fcntl_WriteLock._open_locks.add(self.filename)
95
fcntl.flock(self._open(filename, 'wb'), fcntl.LOCK_EX)
135
# LOCK_NB will cause IOError to be raised if we can't grab a
137
fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
139
if e.errno in (errno.EAGAIN, errno.EACCES):
140
# We couldn't grab the lock
142
# we should be more precise about whats a locking
143
# error and whats a random-other error
144
raise errors.LockContention(e)
147
_fcntl_WriteLock._open_locks.remove(self.filename)
100
151
class _fcntl_ReadLock(_fcntl_FileLock):
101
def __init__(self, filename):
103
fcntl.flock(self._open(filename, 'rb'), fcntl.LOCK_SH)
107
WriteLock = _fcntl_WriteLock
108
ReadLock = _fcntl_ReadLock
155
def __init__(self, filename):
156
super(_fcntl_ReadLock, self).__init__()
157
self.filename = osutils.realpath(filename)
158
_fcntl_ReadLock._open_locks.setdefault(self.filename, 0)
159
_fcntl_ReadLock._open_locks[self.filename] += 1
160
self._open(filename, 'rb')
162
# LOCK_NB will cause IOError to be raised if we can't grab a
164
fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
166
# we should be more precise about whats a locking
167
# error and whats a random-other error
168
raise errors.LockContention(e)
171
count = _fcntl_ReadLock._open_locks[self.filename]
173
del _fcntl_ReadLock._open_locks[self.filename]
175
_fcntl_ReadLock._open_locks[self.filename] = count - 1
178
def temporary_write_lock(self):
179
"""Try to grab a write lock on the file.
181
On platforms that support it, this will upgrade to a write lock
182
without unlocking the file.
183
Otherwise, this will release the read lock, and try to acquire a
186
:return: A token which can be used to switch back to a read lock.
188
if self.filename in _fcntl_WriteLock._open_locks:
189
raise AssertionError('file already locked: %r'
192
wlock = _fcntl_TemporaryWriteLock(self)
193
except errors.LockError:
194
# We didn't unlock, so we can just return 'self'
199
class _fcntl_TemporaryWriteLock(_OSLock):
200
"""A token used when grabbing a temporary_write_lock.
202
Call restore_read_lock() when you are done with the write lock.
205
def __init__(self, read_lock):
206
super(_fcntl_TemporaryWriteLock, self).__init__()
207
self._read_lock = read_lock
208
self.filename = read_lock.filename
210
count = _fcntl_ReadLock._open_locks[self.filename]
212
# Something else also has a read-lock, so we cannot grab a
214
raise errors.LockContention(self.filename)
216
if self.filename in _fcntl_WriteLock._open_locks:
217
raise AssertionError('file already locked: %r'
220
# See if we can open the file for writing. Another process might
221
# have a read lock. We don't use self._open() because we don't want
222
# to create the file if it exists. That would have already been
223
# done by _fcntl_ReadLock
225
new_f = open(self.filename, 'rb+')
227
if e.errno in (errno.EACCES, errno.EPERM):
228
raise errors.LockFailed(self.filename, str(e))
231
# LOCK_NB will cause IOError to be raised if we can't grab a
233
fcntl.lockf(new_f, fcntl.LOCK_EX | fcntl.LOCK_NB)
235
# TODO: Raise a more specific error based on the type of error
236
raise errors.LockContention(e)
237
_fcntl_WriteLock._open_locks.add(self.filename)
241
def restore_read_lock(self):
242
"""Restore the original ReadLock."""
243
# For fcntl, since we never released the read lock, just release the
244
# write lock, and return the original lock.
245
fcntl.lockf(self.f, fcntl.LOCK_UN)
247
_fcntl_WriteLock._open_locks.remove(self.filename)
248
# Avoid reference cycles
249
read_lock = self._read_lock
250
self._read_lock = None
254
_lock_classes.append(('fcntl', _fcntl_WriteLock, _fcntl_ReadLock))
257
if have_pywin32 and sys.platform == 'win32':
258
LOCK_SH = 0 # the default
259
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
260
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
263
class _w32c_FileLock(_OSLock):
265
def _lock(self, filename, openmode, lockmode):
266
self._open(filename, openmode)
268
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
269
overlapped = pywintypes.OVERLAPPED()
271
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000,
273
except pywintypes.error, e:
275
if e.args[0] in (winerror.ERROR_LOCK_VIOLATION,):
276
raise errors.LockContention(filename)
277
## import pdb; pdb.set_trace()
281
raise errors.LockContention(e)
284
overlapped = pywintypes.OVERLAPPED()
286
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
289
raise errors.LockContention(e)
292
class _w32c_ReadLock(_w32c_FileLock):
293
def __init__(self, filename):
294
super(_w32c_ReadLock, self).__init__()
295
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
297
def temporary_write_lock(self):
298
"""Try to grab a write lock on the file.
300
On platforms that support it, this will upgrade to a write lock
301
without unlocking the file.
302
Otherwise, this will release the read lock, and try to acquire a
305
:return: A token which can be used to switch back to a read lock.
307
# I can't find a way to upgrade a read lock to a write lock without
308
# unlocking first. So here, we do just that.
311
wlock = _w32c_WriteLock(self.filename)
312
except errors.LockError:
313
return False, _w32c_ReadLock(self.filename)
317
class _w32c_WriteLock(_w32c_FileLock):
318
def __init__(self, filename):
319
super(_w32c_WriteLock, self).__init__()
320
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
322
def restore_read_lock(self):
323
"""Restore the original ReadLock."""
324
# For win32 we had to completely let go of the original lock, so we
325
# just unlock and create a new read lock.
327
return _w32c_ReadLock(self.filename)
330
_lock_classes.append(('pywin32', _w32c_WriteLock, _w32c_ReadLock))
333
have_ctypes_win32 = False
334
if sys.platform == 'win32':
112
import win32con, win32file, pywintypes
115
#LOCK_SH = 0 # the default
116
#LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
117
#LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
119
class _w32c_FileLock(_base_Lock):
120
def _lock(self, filename, openmode, lockmode):
122
self._open(filename, openmode)
123
self.hfile = win32file._get_osfhandle(self.f.fileno())
124
overlapped = pywintypes.OVERLAPPED()
125
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
131
overlapped = pywintypes.OVERLAPPED()
132
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
140
class _w32c_ReadLock(_w32c_FileLock):
141
def __init__(self, filename):
142
_w32c_FileLock._lock(self, filename, 'rb', 0)
144
class _w32c_WriteLock(_w32c_FileLock):
145
def __init__(self, filename):
146
_w32c_FileLock._lock(self, filename, 'wb',
147
win32con.LOCKFILE_EXCLUSIVE_LOCK)
151
WriteLock = _w32c_WriteLock
152
ReadLock = _w32c_ReadLock
336
import ctypes, msvcrt
337
have_ctypes_win32 = True
154
338
except ImportError:
159
# Unfortunately, msvcrt.locking() doesn't distinguish between
160
# read locks and write locks. Also, the way the combinations
161
# work to get non-blocking is not the same, so we
162
# have to write extra special functions here.
165
class _msvc_FileLock(_base_Lock):
173
class _msvc_ReadLock(_msvc_FileLock):
174
def __init__(self, filename):
175
_msvc_lock(self._open(filename, 'rb'), self.LOCK_SH)
178
class _msvc_WriteLock(_msvc_FileLock):
179
def __init__(self, filename):
180
_msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
184
def _msvc_lock(f, flags):
186
# Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
187
# according to the comments, LK_RLCK is open the lock for writing.
189
# Unfortunately, msvcrt.locking() also has the side effect that it
190
# will only block for 10 seconds at most, and then it will throw an
191
# exception, this isn't terrible, though.
198
fpos = os.lseek(fn, 0,0)
201
if flags & _msvc_FileLock.LOCK_SH:
202
if flags & _msvc_FileLock.LOCK_NB:
203
lock_mode = msvcrt.LK_NBLCK
205
lock_mode = msvcrt.LK_LOCK
206
elif flags & _msvc_FileLock.LOCK_EX:
207
if flags & _msvc_FileLock.LOCK_NB:
208
lock_mode = msvcrt.LK_NBRLCK
210
lock_mode = msvcrt.LK_RLCK
212
raise ValueError('Invalid lock mode: %r' % flags)
214
msvcrt.locking(fn, lock_mode, -1)
216
os.lseek(fn, fpos, 0)
228
fpos = os.lseek(fn, 0,0)
232
msvcrt.locking(fn, msvcrt.LK_UNLCK, -1)
234
os.lseek(fn, fpos, 0)
240
WriteLock = _msvc_WriteLock
241
ReadLock = _msvc_ReadLock
243
raise NotImplementedError("please write a locking method "
244
"for platform %r" % sys.platform)
341
if have_ctypes_win32:
342
# These constants were copied from the win32con.py module.
343
LOCKFILE_FAIL_IMMEDIATELY = 1
344
LOCKFILE_EXCLUSIVE_LOCK = 2
345
# Constant taken from winerror.py module
346
ERROR_LOCK_VIOLATION = 33
349
LOCK_EX = LOCKFILE_EXCLUSIVE_LOCK
350
LOCK_NB = LOCKFILE_FAIL_IMMEDIATELY
351
_LockFileEx = ctypes.windll.kernel32.LockFileEx
352
_UnlockFileEx = ctypes.windll.kernel32.UnlockFileEx
353
_GetLastError = ctypes.windll.kernel32.GetLastError
355
### Define the OVERLAPPED structure.
356
# http://msdn2.microsoft.com/en-us/library/ms684342.aspx
357
# typedef struct _OVERLAPPED {
358
# ULONG_PTR Internal;
359
# ULONG_PTR InternalHigh;
370
class _inner_struct(ctypes.Structure):
371
_fields_ = [('Offset', ctypes.c_uint), # DWORD
372
('OffsetHigh', ctypes.c_uint), # DWORD
375
class _inner_union(ctypes.Union):
376
_fields_ = [('anon_struct', _inner_struct), # struct
377
('Pointer', ctypes.c_void_p), # PVOID
380
class OVERLAPPED(ctypes.Structure):
381
_fields_ = [('Internal', ctypes.c_void_p), # ULONG_PTR
382
('InternalHigh', ctypes.c_void_p), # ULONG_PTR
383
('_inner_union', _inner_union),
384
('hEvent', ctypes.c_void_p), # HANDLE
387
class _ctypes_FileLock(_OSLock):
389
def _lock(self, filename, openmode, lockmode):
390
self._open(filename, openmode)
392
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
393
overlapped = OVERLAPPED()
394
result = _LockFileEx(self.hfile, # HANDLE hFile
395
lockmode, # DWORD dwFlags
396
0, # DWORD dwReserved
397
0x7fffffff, # DWORD nNumberOfBytesToLockLow
398
0x00000000, # DWORD nNumberOfBytesToLockHigh
399
ctypes.byref(overlapped), # lpOverlapped
403
last_err = _GetLastError()
404
if last_err in (ERROR_LOCK_VIOLATION,):
405
raise errors.LockContention(filename)
406
raise errors.LockContention('Unknown locking error: %s'
410
overlapped = OVERLAPPED()
411
result = _UnlockFileEx(self.hfile, # HANDLE hFile
412
0, # DWORD dwReserved
413
0x7fffffff, # DWORD nNumberOfBytesToLockLow
414
0x00000000, # DWORD nNumberOfBytesToLockHigh
415
ctypes.byref(overlapped), # lpOverlapped
420
last_err = _GetLastError()
421
raise errors.LockContention('Unknown unlocking error: %s'
425
class _ctypes_ReadLock(_ctypes_FileLock):
426
def __init__(self, filename):
427
super(_ctypes_ReadLock, self).__init__()
428
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
430
def temporary_write_lock(self):
431
"""Try to grab a write lock on the file.
433
On platforms that support it, this will upgrade to a write lock
434
without unlocking the file.
435
Otherwise, this will release the read lock, and try to acquire a
438
:return: A token which can be used to switch back to a read lock.
440
# I can't find a way to upgrade a read lock to a write lock without
441
# unlocking first. So here, we do just that.
444
wlock = _ctypes_WriteLock(self.filename)
445
except errors.LockError:
446
return False, _ctypes_ReadLock(self.filename)
449
class _ctypes_WriteLock(_ctypes_FileLock):
450
def __init__(self, filename):
451
super(_ctypes_WriteLock, self).__init__()
452
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
454
def restore_read_lock(self):
455
"""Restore the original ReadLock."""
456
# For win32 we had to completely let go of the original lock, so we
457
# just unlock and create a new read lock.
459
return _ctypes_ReadLock(self.filename)
462
_lock_classes.append(('ctypes', _ctypes_WriteLock, _ctypes_ReadLock))
465
if len(_lock_classes) == 0:
466
raise NotImplementedError(
467
"We must have one of fcntl, pywin32, or ctypes available"
468
" to support OS locking."
472
# We default to using the first available lock class.
473
_lock_type, WriteLock, ReadLock = _lock_classes[0]
added
removed
bzrlib/lock.py
