48
from bzrlib.hooks import HookPoint, Hooks
51
class LockHooks(Hooks):
55
self.create_hook(HookPoint('lock_acquired',
56
"Called with a bzrlib.lock.LockResult when a physical lock is "
57
"acquired.", (1, 8), None))
58
self.create_hook(HookPoint('lock_released',
59
"Called with a bzrlib.lock.LockResult when a physical lock is "
60
"released.", (1, 8), None))
61
self.create_hook(HookPoint('lock_broken',
62
"Called with a bzrlib.lock.LockResult when a physical lock is "
63
"broken.", (1, 15), None))
67
"""Base class for locks.
69
:cvar hooks: Hook dictionary for operations on locks.
75
class LockResult(object):
76
"""Result of an operation on a lock; passed to a hook"""
78
def __init__(self, lock_url, details=None):
79
"""Create a lock result for lock with optional details about the lock."""
80
self.lock_url = lock_url
81
self.details = details
83
def __eq__(self, other):
84
return self.lock_url == other.lock_url and self.details == other.details
87
return '%s(%s, %s)' % (self.__class__.__name__,
88
self.lock_url, self.details)
91
def cant_unlock_not_held(locked_object):
92
"""An attempt to unlock failed because the object was not locked.
94
This provides a policy point from which we can generate either a warning
97
# This is typically masking some other error and called from a finally
98
# block, so it's useful to have the option not to generate a new error
99
# here. You can use -Werror to make it fatal. It should possibly also
101
if 'unlock' in debug.debug_flags:
102
warnings.warn("%r is already unlocked" % (locked_object,),
105
raise errors.LockNotHeld(locked_object)
115
have_ctypes_win32 = False
116
if sys.platform == 'win32':
119
import win32file, pywintypes, winerror
126
have_ctypes_win32 = True
131
class _OSLock(object):
41
from bzrlib import errors
42
from bzrlib.errors import LockError, LockContention
43
from bzrlib.osutils import realpath
44
from bzrlib.trace import mutter
47
class _base_Lock(object):
133
49
def __init__(self):
137
52
def _open(self, filename, filemode):
138
self.filename = osutils.realpath(filename)
140
self.f = open(self.filename, filemode)
54
self.f = open(filename, filemode)
142
56
except IOError, e:
143
57
if e.errno in (errno.EACCES, errno.EPERM):
144
raise errors.LockFailed(self.filename, str(e))
58
raise errors.ReadOnlyLockError(e)
145
59
if e.errno != errno.ENOENT:
148
62
# maybe this is an old branch (before may 2005)
149
trace.mutter("trying to create missing lock %r", self.filename)
63
mutter("trying to create missing branch lock %r", filename)
151
self.f = open(self.filename, 'wb+')
65
self.f = open(filename, 'wb+')
154
68
def _clear_f(self):
245
162
except IOError, e:
246
163
# we should be more precise about whats a locking
247
164
# error and whats a random-other error
248
raise errors.LockContention(self.filename, e)
250
167
def unlock(self):
251
count = _fcntl_ReadLock._open_locks[self.filename]
253
del _fcntl_ReadLock._open_locks[self.filename]
255
_fcntl_ReadLock._open_locks[self.filename] = count - 1
258
def temporary_write_lock(self):
259
"""Try to grab a write lock on the file.
261
On platforms that support it, this will upgrade to a write lock
262
without unlocking the file.
263
Otherwise, this will release the read lock, and try to acquire a
266
:return: A token which can be used to switch back to a read lock.
268
if self.filename in _fcntl_WriteLock._open_locks:
269
raise AssertionError('file already locked: %r'
272
wlock = _fcntl_TemporaryWriteLock(self)
273
except errors.LockError:
274
# We didn't unlock, so we can just return 'self'
279
class _fcntl_TemporaryWriteLock(_OSLock):
280
"""A token used when grabbing a temporary_write_lock.
282
Call restore_read_lock() when you are done with the write lock.
285
def __init__(self, read_lock):
286
super(_fcntl_TemporaryWriteLock, self).__init__()
287
self._read_lock = read_lock
288
self.filename = read_lock.filename
290
count = _fcntl_ReadLock._open_locks[self.filename]
292
# Something else also has a read-lock, so we cannot grab a
294
raise errors.LockContention(self.filename)
296
if self.filename in _fcntl_WriteLock._open_locks:
297
raise AssertionError('file already locked: %r'
300
# See if we can open the file for writing. Another process might
301
# have a read lock. We don't use self._open() because we don't want
302
# to create the file if it exists. That would have already been
303
# done by _fcntl_ReadLock
305
new_f = open(self.filename, 'rb+')
307
if e.errno in (errno.EACCES, errno.EPERM):
308
raise errors.LockFailed(self.filename, str(e))
311
# LOCK_NB will cause IOError to be raised if we can't grab a
313
fcntl.lockf(new_f, fcntl.LOCK_EX | fcntl.LOCK_NB)
315
# TODO: Raise a more specific error based on the type of error
316
raise errors.LockContention(self.filename, e)
317
_fcntl_WriteLock._open_locks.add(self.filename)
321
def restore_read_lock(self):
322
"""Restore the original ReadLock."""
323
# For fcntl, since we never released the read lock, just release the
324
# write lock, and return the original lock.
325
fcntl.lockf(self.f, fcntl.LOCK_UN)
327
_fcntl_WriteLock._open_locks.remove(self.filename)
328
# Avoid reference cycles
329
read_lock = self._read_lock
330
self._read_lock = None
334
171
_lock_classes.append(('fcntl', _fcntl_WriteLock, _fcntl_ReadLock))
337
if have_pywin32 and sys.platform == 'win32':
338
if os.path.supports_unicode_filenames:
339
# for Windows NT/2K/XP/etc
340
win32file_CreateFile = win32file.CreateFileW
343
win32file_CreateFile = win32file.CreateFile
345
class _w32c_FileLock(_OSLock):
347
def _open(self, filename, access, share, cflags, pymode):
348
self.filename = osutils.realpath(filename)
174
LOCK_SH = 0 # the default
175
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
176
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
179
class _w32c_FileLock(_base_Lock):
181
def _lock(self, filename, openmode, lockmode):
182
self._open(filename, openmode)
184
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
185
overlapped = pywintypes.OVERLAPPED()
350
self._handle = win32file_CreateFile(filename, access, share,
351
None, win32file.OPEN_ALWAYS,
352
win32file.FILE_ATTRIBUTE_NORMAL, None)
187
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000,
353
189
except pywintypes.error, e:
354
if e.args[0] == winerror.ERROR_ACCESS_DENIED:
355
raise errors.LockFailed(filename, e)
356
if e.args[0] == winerror.ERROR_SHARING_VIOLATION:
357
raise errors.LockContention(filename, e)
191
if e.args[0] in (winerror.ERROR_LOCK_VIOLATION,):
192
raise errors.LockContention(filename)
193
## import pdb; pdb.set_trace()
359
fd = win32file._open_osfhandle(self._handle, cflags)
360
self.f = os.fdopen(fd, pymode)
363
199
def unlock(self):
200
overlapped = pywintypes.OVERLAPPED()
202
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
368
208
class _w32c_ReadLock(_w32c_FileLock):
369
209
def __init__(self, filename):
370
210
super(_w32c_ReadLock, self).__init__()
371
self._open(filename, win32file.GENERIC_READ,
372
win32file.FILE_SHARE_READ, os.O_RDONLY, "rb")
374
def temporary_write_lock(self):
375
"""Try to grab a write lock on the file.
377
On platforms that support it, this will upgrade to a write lock
378
without unlocking the file.
379
Otherwise, this will release the read lock, and try to acquire a
382
:return: A token which can be used to switch back to a read lock.
384
# I can't find a way to upgrade a read lock to a write lock without
385
# unlocking first. So here, we do just that.
388
wlock = _w32c_WriteLock(self.filename)
389
except errors.LockError:
390
return False, _w32c_ReadLock(self.filename)
211
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
394
213
class _w32c_WriteLock(_w32c_FileLock):
395
214
def __init__(self, filename):
396
215
super(_w32c_WriteLock, self).__init__()
398
win32file.GENERIC_READ | win32file.GENERIC_WRITE, 0,
401
def restore_read_lock(self):
402
"""Restore the original ReadLock."""
403
# For win32 we had to completely let go of the original lock, so we
404
# just unlock and create a new read lock.
406
return _w32c_ReadLock(self.filename)
216
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
409
218
_lock_classes.append(('pywin32', _w32c_WriteLock, _w32c_ReadLock))
412
if have_ctypes_win32:
413
from ctypes.wintypes import DWORD, LPCSTR, LPCWSTR
414
LPSECURITY_ATTRIBUTES = ctypes.c_void_p # used as NULL no need to declare
415
HANDLE = ctypes.c_int # rather than unsigned as in ctypes.wintypes
416
if os.path.supports_unicode_filenames:
417
_function_name = "CreateFileW"
420
_function_name = "CreateFileA"
421
class LPTSTR(LPCSTR):
422
def __new__(cls, obj):
423
return LPCSTR.__new__(cls, obj.encode("mbcs"))
425
# CreateFile <http://msdn.microsoft.com/en-us/library/aa363858.aspx>
426
_CreateFile = ctypes.WINFUNCTYPE(
427
HANDLE, # return value
429
DWORD, # dwDesiredAccess
431
LPSECURITY_ATTRIBUTES, # lpSecurityAttributes
432
DWORD, # dwCreationDisposition
433
DWORD, # dwFlagsAndAttributes
434
HANDLE # hTemplateFile
435
)((_function_name, ctypes.windll.kernel32))
437
INVALID_HANDLE_VALUE = -1
439
GENERIC_READ = 0x80000000
440
GENERIC_WRITE = 0x40000000
443
FILE_ATTRIBUTE_NORMAL = 128
445
ERROR_ACCESS_DENIED = 5
446
ERROR_SHARING_VIOLATION = 32
448
class _ctypes_FileLock(_OSLock):
450
def _open(self, filename, access, share, cflags, pymode):
451
self.filename = osutils.realpath(filename)
452
handle = _CreateFile(filename, access, share, None, OPEN_ALWAYS,
453
FILE_ATTRIBUTE_NORMAL, 0)
454
if handle in (INVALID_HANDLE_VALUE, 0):
455
e = ctypes.WinError()
456
if e.args[0] == ERROR_ACCESS_DENIED:
457
raise errors.LockFailed(filename, e)
458
if e.args[0] == ERROR_SHARING_VIOLATION:
459
raise errors.LockContention(filename, e)
461
fd = msvcrt.open_osfhandle(handle, cflags)
462
self.f = os.fdopen(fd, pymode)
221
# These constants were copied from the win32con.py module.
222
LOCKFILE_FAIL_IMMEDIATELY = 1
223
LOCKFILE_EXCLUSIVE_LOCK = 2
224
# Constant taken from winerror.py module
225
ERROR_LOCK_VIOLATION = 33
228
LOCK_EX = LOCKFILE_EXCLUSIVE_LOCK
229
LOCK_NB = LOCKFILE_FAIL_IMMEDIATELY
230
_LockFileEx = ctypes.windll.kernel32.LockFileEx
231
_UnlockFileEx = ctypes.windll.kernel32.UnlockFileEx
232
_GetLastError = ctypes.windll.kernel32.GetLastError
234
### Define the OVERLAPPED structure.
235
# http://msdn2.microsoft.com/en-us/library/ms684342.aspx
236
# typedef struct _OVERLAPPED {
237
# ULONG_PTR Internal;
238
# ULONG_PTR InternalHigh;
249
class _inner_struct(ctypes.Structure):
250
_fields_ = [('Offset', ctypes.c_uint), # DWORD
251
('OffsetHigh', ctypes.c_uint), # DWORD
254
class _inner_union(ctypes.Union):
255
_fields_ = [('anon_struct', _inner_struct), # struct
256
('Pointer', ctypes.c_void_p), # PVOID
259
class OVERLAPPED(ctypes.Structure):
260
_fields_ = [('Internal', ctypes.c_void_p), # ULONG_PTR
261
('InternalHigh', ctypes.c_void_p), # ULONG_PTR
262
('_inner_union', _inner_union),
263
('hEvent', ctypes.c_void_p), # HANDLE
266
class _ctypes_FileLock(_base_Lock):
268
def _lock(self, filename, openmode, lockmode):
269
self._open(filename, openmode)
271
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
272
overlapped = OVERLAPPED()
273
p_overlapped = ctypes.pointer(overlapped)
274
result = _LockFileEx(self.hfile, # HANDLE hFile
275
lockmode, # DWORD dwFlags
276
0, # DWORD dwReserved
277
0x7fffffff, # DWORD nNumberOfBytesToLockLow
278
0x00000000, # DWORD nNumberOfBytesToLockHigh
279
p_overlapped, # lpOverlapped
283
last_err = _GetLastError()
284
if last_err in (ERROR_LOCK_VIOLATION,):
285
raise errors.LockContention(filename)
286
raise errors.LockError('Unknown locking error: %s'
465
289
def unlock(self):
290
overlapped = OVERLAPPED()
291
p_overlapped = ctypes.pointer(overlapped)
292
result = _UnlockFileEx(self.hfile, # HANDLE hFile
293
0, # DWORD dwReserved
294
0x7fffffff, # DWORD nNumberOfBytesToLockLow
295
0x00000000, # DWORD nNumberOfBytesToLockHigh
296
p_overlapped, # lpOverlapped
301
last_err = _GetLastError()
302
raise errors.LockError('Unknown unlocking error: %s'
469
306
class _ctypes_ReadLock(_ctypes_FileLock):
470
307
def __init__(self, filename):
471
308
super(_ctypes_ReadLock, self).__init__()
472
self._open(filename, GENERIC_READ, FILE_SHARE_READ, os.O_RDONLY,
475
def temporary_write_lock(self):
476
"""Try to grab a write lock on the file.
478
On platforms that support it, this will upgrade to a write lock
479
without unlocking the file.
480
Otherwise, this will release the read lock, and try to acquire a
483
:return: A token which can be used to switch back to a read lock.
485
# I can't find a way to upgrade a read lock to a write lock without
486
# unlocking first. So here, we do just that.
489
wlock = _ctypes_WriteLock(self.filename)
490
except errors.LockError:
491
return False, _ctypes_ReadLock(self.filename)
309
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
494
311
class _ctypes_WriteLock(_ctypes_FileLock):
495
312
def __init__(self, filename):
496
313
super(_ctypes_WriteLock, self).__init__()
497
self._open(filename, GENERIC_READ | GENERIC_WRITE, 0, os.O_RDWR,
500
def restore_read_lock(self):
501
"""Restore the original ReadLock."""
502
# For win32 we had to completely let go of the original lock, so we
503
# just unlock and create a new read lock.
505
return _ctypes_ReadLock(self.filename)
314
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
508
316
_lock_classes.append(('ctypes', _ctypes_WriteLock, _ctypes_ReadLock))
511
319
if len(_lock_classes) == 0:
512
raise NotImplementedError(
513
"We must have one of fcntl, pywin32, or ctypes available"
514
" to support OS locking."
320
raise NotImplementedError("We only have support for"
321
" fcntl, pywin32 or ctypes locking."
322
" If your platform (windows) does not"
323
" support fcntl locks, you must have"
324
" either pywin32 or ctypes installed.")
518
326
# We default to using the first available lock class.
519
327
_lock_type, WriteLock, ReadLock = _lock_classes[0]
522
class _RelockDebugMixin(object):
523
"""Mixin support for -Drelock flag.
330
class LockTreeTestProviderAdapter(object):
331
"""A tool to generate a suite testing multiple lock formats at once.
525
Add this as a base class then call self._note_lock with 'r' or 'w' when
526
acquiring a read- or write-lock. If this object was previously locked (and
527
locked the same way), and -Drelock is set, then this will trace.note a
333
This is done by copying the test once for each lock and injecting the
334
read_lock and write_lock classes.
335
They are also given a new test id.
533
def _note_lock(self, lock_type):
534
if 'relock' in debug.debug_flags and self._prev_lock == lock_type:
539
trace.note('%r was %s locked again', self, type_name)
540
self._prev_lock = lock_type
338
def __init__(self, lock_classes):
339
self._lock_classes = lock_classes
341
def _clone_test(self, test, write_lock, read_lock, variation):
342
"""Clone test for adaption."""
343
new_test = deepcopy(test)
344
new_test.write_lock = write_lock
345
new_test.read_lock = read_lock
346
def make_new_test_id():
347
new_id = "%s(%s)" % (test.id(), variation)
348
return lambda: new_id
349
new_test.id = make_new_test_id()
352
def adapt(self, test):
353
from bzrlib.tests import TestSuite
355
for name, write_lock, read_lock in self._lock_classes:
356
new_test = self._clone_test(test, write_lock, read_lock, name)
357
result.addTest(new_test)
added
removed
bzrlib/lock.py
