1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008 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):
45
from bzrlib.hooks import Hooks
48
class LockHooks(Hooks):
53
# added in 1.8; called with a LockResult when a physical lock is
55
self['lock_acquired'] = []
57
# added in 1.8; called with a LockResult when a physical lock is
59
self['lock_released'] = []
63
"""Base class for locks.
65
:cvar hooks: Hook dictionary for operations on locks.
71
class LockResult(object):
72
"""Result of an operation on a lock; passed to a hook"""
74
def __init__(self, lock_url, details=None):
75
"""Create a lock result for lock with optional details about the lock."""
76
self.lock_url = lock_url
77
self.details = details
79
def __eq__(self, other):
80
return self.lock_url == other.lock_url and self.details == other.details
83
class _OSLock(object):
45
89
def _open(self, filename, filemode):
90
self.filename = osutils.realpath(filename)
48
self.f = open(filename, filemode)
92
self.f = open(self.filename, filemode)
95
if e.errno in (errno.EACCES, errno.EPERM):
96
raise errors.LockFailed(self.filename, str(e))
51
97
if e.errno != errno.ENOENT:
54
100
# 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')
101
trace.mutter("trying to create missing lock %r", self.filename)
103
self.f = open(self.filename, 'wb+')
107
"""Clear the self.f attribute cleanly."""
61
112
def __del__(self):
63
114
from warnings import warn
64
115
warn("lock on %r not released" % self.f)
69
119
raise NotImplementedError()
76
############################################################
83
class _fcntl_FileLock(_base_Lock):
87
fcntl.flock(self.f, fcntl.LOCK_UN)
128
import win32con, win32file, pywintypes, winerror, msvcrt
133
import ctypes, msvcrt
143
LOCK_SH = fcntl.LOCK_SH
144
LOCK_NB = fcntl.LOCK_NB
145
lock_EX = fcntl.LOCK_EX
148
class _fcntl_FileLock(_OSLock):
151
fcntl.lockf(self.f, fcntl.LOCK_UN)
92
155
class _fcntl_WriteLock(_fcntl_FileLock):
93
159
def __init__(self, filename):
160
super(_fcntl_WriteLock, self).__init__()
161
# Check we can grab a lock before we actually open the file.
162
self.filename = osutils.realpath(filename)
163
if self.filename in _fcntl_WriteLock._open_locks:
165
raise errors.LockContention(self.filename)
167
self._open(self.filename, 'rb+')
168
# reserve a slot for this lock - even if the lockf call fails,
169
# at thisi point unlock() will be called, because self.f is set.
170
# TODO: make this fully threadsafe, if we decide we care.
171
_fcntl_WriteLock._open_locks.add(self.filename)
95
fcntl.flock(self._open(filename, 'wb'), fcntl.LOCK_EX)
173
# LOCK_NB will cause IOError to be raised if we can't grab a
175
fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
177
if e.errno in (errno.EAGAIN, errno.EACCES):
178
# We couldn't grab the lock
180
# we should be more precise about whats a locking
181
# error and whats a random-other error
182
raise errors.LockContention(e)
185
_fcntl_WriteLock._open_locks.remove(self.filename)
100
189
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
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
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)
193
def __init__(self, filename):
194
super(_fcntl_ReadLock, self).__init__()
195
self.filename = osutils.realpath(filename)
196
_fcntl_ReadLock._open_locks.setdefault(self.filename, 0)
197
_fcntl_ReadLock._open_locks[self.filename] += 1
198
self._open(filename, 'rb')
200
# LOCK_NB will cause IOError to be raised if we can't grab a
202
fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
204
# we should be more precise about whats a locking
205
# error and whats a random-other error
206
raise errors.LockContention(e)
209
count = _fcntl_ReadLock._open_locks[self.filename]
211
del _fcntl_ReadLock._open_locks[self.filename]
213
_fcntl_ReadLock._open_locks[self.filename] = count - 1
216
def temporary_write_lock(self):
217
"""Try to grab a write lock on the file.
219
On platforms that support it, this will upgrade to a write lock
220
without unlocking the file.
221
Otherwise, this will release the read lock, and try to acquire a
224
:return: A token which can be used to switch back to a read lock.
226
if self.filename in _fcntl_WriteLock._open_locks:
227
raise AssertionError('file already locked: %r'
230
wlock = _fcntl_TemporaryWriteLock(self)
231
except errors.LockError:
232
# We didn't unlock, so we can just return 'self'
237
class _fcntl_TemporaryWriteLock(_OSLock):
238
"""A token used when grabbing a temporary_write_lock.
240
Call restore_read_lock() when you are done with the write lock.
243
def __init__(self, read_lock):
244
super(_fcntl_TemporaryWriteLock, self).__init__()
245
self._read_lock = read_lock
246
self.filename = read_lock.filename
248
count = _fcntl_ReadLock._open_locks[self.filename]
250
# Something else also has a read-lock, so we cannot grab a
252
raise errors.LockContention(self.filename)
254
if self.filename in _fcntl_WriteLock._open_locks:
255
raise AssertionError('file already locked: %r'
258
# See if we can open the file for writing. Another process might
259
# have a read lock. We don't use self._open() because we don't want
260
# to create the file if it exists. That would have already been
261
# done by _fcntl_ReadLock
263
new_f = open(self.filename, 'rb+')
265
if e.errno in (errno.EACCES, errno.EPERM):
266
raise errors.LockFailed(self.filename, str(e))
269
# LOCK_NB will cause IOError to be raised if we can't grab a
271
fcntl.lockf(new_f, fcntl.LOCK_EX | fcntl.LOCK_NB)
273
# TODO: Raise a more specific error based on the type of error
274
raise errors.LockContention(e)
275
_fcntl_WriteLock._open_locks.add(self.filename)
279
def restore_read_lock(self):
280
"""Restore the original ReadLock."""
281
# For fcntl, since we never released the read lock, just release the
282
# write lock, and return the original lock.
283
fcntl.lockf(self.f, fcntl.LOCK_UN)
285
_fcntl_WriteLock._open_locks.remove(self.filename)
286
# Avoid reference cycles
287
read_lock = self._read_lock
288
self._read_lock = None
292
_lock_classes.append(('fcntl', _fcntl_WriteLock, _fcntl_ReadLock))
295
if have_pywin32 and sys.platform == 'win32':
296
LOCK_SH = 0 # the default
297
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
298
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
301
class _w32c_FileLock(_OSLock):
303
def _lock(self, filename, openmode, lockmode):
304
self._open(filename, openmode)
306
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
307
overlapped = pywintypes.OVERLAPPED()
309
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000,
311
except pywintypes.error, e:
313
if e.args[0] in (winerror.ERROR_LOCK_VIOLATION,):
314
raise errors.LockContention(filename)
315
## import pdb; pdb.set_trace()
319
raise errors.LockContention(e)
322
overlapped = pywintypes.OVERLAPPED()
324
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
327
raise errors.LockContention(e)
330
class _w32c_ReadLock(_w32c_FileLock):
331
def __init__(self, filename):
332
super(_w32c_ReadLock, self).__init__()
333
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
335
def temporary_write_lock(self):
336
"""Try to grab a write lock on the file.
338
On platforms that support it, this will upgrade to a write lock
339
without unlocking the file.
340
Otherwise, this will release the read lock, and try to acquire a
343
:return: A token which can be used to switch back to a read lock.
345
# I can't find a way to upgrade a read lock to a write lock without
346
# unlocking first. So here, we do just that.
349
wlock = _w32c_WriteLock(self.filename)
350
except errors.LockError:
351
return False, _w32c_ReadLock(self.filename)
355
class _w32c_WriteLock(_w32c_FileLock):
356
def __init__(self, filename):
357
super(_w32c_WriteLock, self).__init__()
358
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
360
def restore_read_lock(self):
361
"""Restore the original ReadLock."""
362
# For win32 we had to completely let go of the original lock, so we
363
# just unlock and create a new read lock.
365
return _w32c_ReadLock(self.filename)
368
_lock_classes.append(('pywin32', _w32c_WriteLock, _w32c_ReadLock))
371
if have_ctypes and sys.platform == 'win32':
372
# These constants were copied from the win32con.py module.
373
LOCKFILE_FAIL_IMMEDIATELY = 1
374
LOCKFILE_EXCLUSIVE_LOCK = 2
375
# Constant taken from winerror.py module
376
ERROR_LOCK_VIOLATION = 33
379
LOCK_EX = LOCKFILE_EXCLUSIVE_LOCK
380
LOCK_NB = LOCKFILE_FAIL_IMMEDIATELY
381
_LockFileEx = ctypes.windll.kernel32.LockFileEx
382
_UnlockFileEx = ctypes.windll.kernel32.UnlockFileEx
383
_GetLastError = ctypes.windll.kernel32.GetLastError
385
### Define the OVERLAPPED structure.
386
# http://msdn2.microsoft.com/en-us/library/ms684342.aspx
387
# typedef struct _OVERLAPPED {
388
# ULONG_PTR Internal;
389
# ULONG_PTR InternalHigh;
400
class _inner_struct(ctypes.Structure):
401
_fields_ = [('Offset', ctypes.c_uint), # DWORD
402
('OffsetHigh', ctypes.c_uint), # DWORD
405
class _inner_union(ctypes.Union):
406
_fields_ = [('anon_struct', _inner_struct), # struct
407
('Pointer', ctypes.c_void_p), # PVOID
410
class OVERLAPPED(ctypes.Structure):
411
_fields_ = [('Internal', ctypes.c_void_p), # ULONG_PTR
412
('InternalHigh', ctypes.c_void_p), # ULONG_PTR
413
('_inner_union', _inner_union),
414
('hEvent', ctypes.c_void_p), # HANDLE
417
class _ctypes_FileLock(_OSLock):
419
def _lock(self, filename, openmode, lockmode):
420
self._open(filename, openmode)
422
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
423
overlapped = OVERLAPPED()
424
result = _LockFileEx(self.hfile, # HANDLE hFile
425
lockmode, # DWORD dwFlags
426
0, # DWORD dwReserved
427
0x7fffffff, # DWORD nNumberOfBytesToLockLow
428
0x00000000, # DWORD nNumberOfBytesToLockHigh
429
ctypes.byref(overlapped), # lpOverlapped
433
last_err = _GetLastError()
434
if last_err in (ERROR_LOCK_VIOLATION,):
435
raise errors.LockContention(filename)
436
raise errors.LockContention('Unknown locking error: %s'
440
overlapped = OVERLAPPED()
441
result = _UnlockFileEx(self.hfile, # HANDLE hFile
442
0, # DWORD dwReserved
443
0x7fffffff, # DWORD nNumberOfBytesToLockLow
444
0x00000000, # DWORD nNumberOfBytesToLockHigh
445
ctypes.byref(overlapped), # lpOverlapped
450
last_err = _GetLastError()
451
raise errors.LockContention('Unknown unlocking error: %s'
455
class _ctypes_ReadLock(_ctypes_FileLock):
456
def __init__(self, filename):
457
super(_ctypes_ReadLock, self).__init__()
458
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
460
def temporary_write_lock(self):
461
"""Try to grab a write lock on the file.
463
On platforms that support it, this will upgrade to a write lock
464
without unlocking the file.
465
Otherwise, this will release the read lock, and try to acquire a
468
:return: A token which can be used to switch back to a read lock.
470
# I can't find a way to upgrade a read lock to a write lock without
471
# unlocking first. So here, we do just that.
474
wlock = _ctypes_WriteLock(self.filename)
475
except errors.LockError:
476
return False, _ctypes_ReadLock(self.filename)
479
class _ctypes_WriteLock(_ctypes_FileLock):
480
def __init__(self, filename):
481
super(_ctypes_WriteLock, self).__init__()
482
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
484
def restore_read_lock(self):
485
"""Restore the original ReadLock."""
486
# For win32 we had to completely let go of the original lock, so we
487
# just unlock and create a new read lock.
489
return _ctypes_ReadLock(self.filename)
492
_lock_classes.append(('ctypes', _ctypes_WriteLock, _ctypes_ReadLock))
495
if len(_lock_classes) == 0:
496
raise NotImplementedError(
497
"We must have one of fcntl, pywin32, or ctypes available"
498
" to support OS locking."
502
# We default to using the first available lock class.
503
_lock_type, WriteLock, ReadLock = _lock_classes[0]
added
removed
bzrlib/lock.py
