1
# Copyright (C) 2005-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Locking using OS file locks or file existence.
19
Note: This method of locking is generally deprecated in favour of LockDir, but
20
is used to lock local WorkingTrees, and by some old formats. It's accessed
21
through Transport.lock_read(), etc.
23
This module causes two methods, lock() and unlock() to be defined in
24
any way that works on the current platform.
26
It is not specified whether these locks are reentrant (i.e. can be
27
taken repeatedly by a single process) or whether they exclude
28
different threads in a single process. That reentrancy is provided by
31
This defines two classes: ReadLock and WriteLock, which can be
32
implemented in different ways on different platforms. Both have an
36
from __future__ import absolute_import
50
from .hooks import Hooks
51
from .i18n import gettext
53
class LockHooks(Hooks):
56
Hooks.__init__(self, "breezy.lock", "Lock.hooks")
57
self.add_hook('lock_acquired',
58
"Called with a breezy.lock.LockResult when a physical lock is "
60
self.add_hook('lock_released',
61
"Called with a breezy.lock.LockResult when a physical lock is "
63
self.add_hook('lock_broken',
64
"Called with a breezy.lock.LockResult when a physical lock is "
69
"""Base class for locks.
71
:cvar hooks: Hook dictionary for operations on locks.
77
class LockResult(object):
78
"""Result of an operation on a lock; passed to a hook"""
80
def __init__(self, lock_url, details=None):
81
"""Create a lock result for lock with optional details about the lock."""
82
self.lock_url = lock_url
83
self.details = details
85
def __eq__(self, other):
86
return self.lock_url == other.lock_url and self.details == other.details
89
return '%s(%s, %s)' % (self.__class__.__name__,
90
self.lock_url, self.details)
93
class LogicalLockResult(object):
94
"""The result of a lock_read/lock_write/lock_tree_write call on lockables.
96
:ivar unlock: A callable which will unlock the lock.
99
def __init__(self, unlock, token=None):
104
return "LogicalLockResult(%s)" % (self.unlock)
109
def __exit__(self, exc_type, exc_val, exc_tb):
110
# If there was an error raised, prefer the original one
119
def cant_unlock_not_held(locked_object):
120
"""An attempt to unlock failed because the object was not locked.
122
This provides a policy point from which we can generate either a warning
125
# This is typically masking some other error and called from a finally
126
# block, so it's useful to have the option not to generate a new error
127
# here. You can use -Werror to make it fatal. It should possibly also
129
if 'unlock' in debug.debug_flags:
130
warnings.warn("%r is already unlocked" % (locked_object,),
133
raise errors.LockNotHeld(locked_object)
143
have_ctypes_win32 = False
144
if sys.platform == 'win32':
147
import win32file, pywintypes, winerror
154
have_ctypes_win32 = True
159
class _OSLock(object):
165
def _open(self, filename, filemode):
166
self.filename = osutils.realpath(filename)
168
self.f = open(self.filename, filemode)
171
if e.errno in (errno.EACCES, errno.EPERM):
172
raise errors.LockFailed(self.filename, str(e))
173
if e.errno != errno.ENOENT:
176
# maybe this is an old branch (before may 2005)
177
trace.mutter("trying to create missing lock %r", self.filename)
179
self.f = open(self.filename, 'wb+')
183
"""Clear the self.f attribute cleanly."""
189
raise NotImplementedError()
197
class _fcntl_FileLock(_OSLock):
200
fcntl.lockf(self.f, fcntl.LOCK_UN)
204
class _fcntl_WriteLock(_fcntl_FileLock):
208
def __init__(self, filename):
209
super(_fcntl_WriteLock, self).__init__()
210
# Check we can grab a lock before we actually open the file.
211
self.filename = osutils.realpath(filename)
212
if self.filename in _fcntl_WriteLock._open_locks:
214
raise errors.LockContention(self.filename)
215
if self.filename in _fcntl_ReadLock._open_locks:
216
if 'strict_locks' in debug.debug_flags:
218
raise errors.LockContention(self.filename)
220
trace.mutter('Write lock taken w/ an open read lock on: %s'
223
self._open(self.filename, 'rb+')
224
# reserve a slot for this lock - even if the lockf call fails,
225
# at this point unlock() will be called, because self.f is set.
226
# TODO: make this fully threadsafe, if we decide we care.
227
_fcntl_WriteLock._open_locks.add(self.filename)
229
# LOCK_NB will cause IOError to be raised if we can't grab a
231
fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
233
if e.errno in (errno.EAGAIN, errno.EACCES):
234
# We couldn't grab the lock
236
# we should be more precise about whats a locking
237
# error and whats a random-other error
238
raise errors.LockContention(self.filename, e)
241
_fcntl_WriteLock._open_locks.remove(self.filename)
245
class _fcntl_ReadLock(_fcntl_FileLock):
249
def __init__(self, filename):
250
super(_fcntl_ReadLock, self).__init__()
251
self.filename = osutils.realpath(filename)
252
if self.filename in _fcntl_WriteLock._open_locks:
253
if 'strict_locks' in debug.debug_flags:
254
# We raise before calling _open so we don't need to
256
raise errors.LockContention(self.filename)
258
trace.mutter('Read lock taken w/ an open write lock on: %s'
260
_fcntl_ReadLock._open_locks.setdefault(self.filename, 0)
261
_fcntl_ReadLock._open_locks[self.filename] += 1
262
self._open(filename, 'rb')
264
# LOCK_NB will cause IOError to be raised if we can't grab a
266
fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
268
# we should be more precise about whats a locking
269
# error and whats a random-other error
270
raise errors.LockContention(self.filename, e)
273
count = _fcntl_ReadLock._open_locks[self.filename]
275
del _fcntl_ReadLock._open_locks[self.filename]
277
_fcntl_ReadLock._open_locks[self.filename] = count - 1
280
def temporary_write_lock(self):
281
"""Try to grab a write lock on the file.
283
On platforms that support it, this will upgrade to a write lock
284
without unlocking the file.
285
Otherwise, this will release the read lock, and try to acquire a
288
:return: A token which can be used to switch back to a read lock.
290
if self.filename in _fcntl_WriteLock._open_locks:
291
raise AssertionError('file already locked: %r'
294
wlock = _fcntl_TemporaryWriteLock(self)
295
except errors.LockError:
296
# We didn't unlock, so we can just return 'self'
301
class _fcntl_TemporaryWriteLock(_OSLock):
302
"""A token used when grabbing a temporary_write_lock.
304
Call restore_read_lock() when you are done with the write lock.
307
def __init__(self, read_lock):
308
super(_fcntl_TemporaryWriteLock, self).__init__()
309
self._read_lock = read_lock
310
self.filename = read_lock.filename
312
count = _fcntl_ReadLock._open_locks[self.filename]
314
# Something else also has a read-lock, so we cannot grab a
316
raise errors.LockContention(self.filename)
318
if self.filename in _fcntl_WriteLock._open_locks:
319
raise AssertionError('file already locked: %r'
322
# See if we can open the file for writing. Another process might
323
# have a read lock. We don't use self._open() because we don't want
324
# to create the file if it exists. That would have already been
325
# done by _fcntl_ReadLock
327
new_f = open(self.filename, 'rb+')
329
if e.errno in (errno.EACCES, errno.EPERM):
330
raise errors.LockFailed(self.filename, str(e))
333
# LOCK_NB will cause IOError to be raised if we can't grab a
335
fcntl.lockf(new_f, fcntl.LOCK_EX | fcntl.LOCK_NB)
337
# TODO: Raise a more specific error based on the type of error
338
raise errors.LockContention(self.filename, e)
339
_fcntl_WriteLock._open_locks.add(self.filename)
343
def restore_read_lock(self):
344
"""Restore the original ReadLock."""
345
# For fcntl, since we never released the read lock, just release the
346
# write lock, and return the original lock.
347
fcntl.lockf(self.f, fcntl.LOCK_UN)
349
_fcntl_WriteLock._open_locks.remove(self.filename)
350
# Avoid reference cycles
351
read_lock = self._read_lock
352
self._read_lock = None
356
_lock_classes.append(('fcntl', _fcntl_WriteLock, _fcntl_ReadLock))
359
if have_pywin32 and sys.platform == 'win32':
360
win32file_CreateFile = win32file.CreateFileW
362
class _w32c_FileLock(_OSLock):
364
def _open(self, filename, access, share, cflags, pymode):
365
self.filename = osutils.realpath(filename)
367
self._handle = win32file_CreateFile(filename, access, share,
368
None, win32file.OPEN_ALWAYS,
369
win32file.FILE_ATTRIBUTE_NORMAL, None)
370
except pywintypes.error as e:
371
if e.args[0] == winerror.ERROR_ACCESS_DENIED:
372
raise errors.LockFailed(filename, e)
373
if e.args[0] == winerror.ERROR_SHARING_VIOLATION:
374
raise errors.LockContention(filename, e)
376
fd = win32file._open_osfhandle(self._handle, cflags)
377
self.f = os.fdopen(fd, pymode)
385
class _w32c_ReadLock(_w32c_FileLock):
386
def __init__(self, filename):
387
super(_w32c_ReadLock, self).__init__()
388
self._open(filename, win32file.GENERIC_READ,
389
win32file.FILE_SHARE_READ, os.O_RDONLY, "rb")
391
def temporary_write_lock(self):
392
"""Try to grab a write lock on the file.
394
On platforms that support it, this will upgrade to a write lock
395
without unlocking the file.
396
Otherwise, this will release the read lock, and try to acquire a
399
:return: A token which can be used to switch back to a read lock.
401
# I can't find a way to upgrade a read lock to a write lock without
402
# unlocking first. So here, we do just that.
405
wlock = _w32c_WriteLock(self.filename)
406
except errors.LockError:
407
return False, _w32c_ReadLock(self.filename)
411
class _w32c_WriteLock(_w32c_FileLock):
412
def __init__(self, filename):
413
super(_w32c_WriteLock, self).__init__()
415
win32file.GENERIC_READ | win32file.GENERIC_WRITE, 0,
418
def restore_read_lock(self):
419
"""Restore the original ReadLock."""
420
# For win32 we had to completely let go of the original lock, so we
421
# just unlock and create a new read lock.
423
return _w32c_ReadLock(self.filename)
426
_lock_classes.append(('pywin32', _w32c_WriteLock, _w32c_ReadLock))
429
if have_ctypes_win32:
430
from ctypes.wintypes import DWORD, LPCSTR, LPCWSTR
431
LPSECURITY_ATTRIBUTES = ctypes.c_void_p # used as NULL no need to declare
432
HANDLE = ctypes.c_int # rather than unsigned as in ctypes.wintypes
433
_function_name = "CreateFileW"
435
# CreateFile <http://msdn.microsoft.com/en-us/library/aa363858.aspx>
436
_CreateFile = ctypes.WINFUNCTYPE(
437
HANDLE, # return value
439
DWORD, # dwDesiredAccess
441
LPSECURITY_ATTRIBUTES, # lpSecurityAttributes
442
DWORD, # dwCreationDisposition
443
DWORD, # dwFlagsAndAttributes
444
HANDLE # hTemplateFile
445
)((_function_name, ctypes.windll.kernel32))
447
INVALID_HANDLE_VALUE = -1
449
GENERIC_READ = 0x80000000
450
GENERIC_WRITE = 0x40000000
453
FILE_ATTRIBUTE_NORMAL = 128
455
ERROR_ACCESS_DENIED = 5
456
ERROR_SHARING_VIOLATION = 32
458
class _ctypes_FileLock(_OSLock):
460
def _open(self, filename, access, share, cflags, pymode):
461
self.filename = osutils.realpath(filename)
462
handle = _CreateFile(filename, access, share, None, OPEN_ALWAYS,
463
FILE_ATTRIBUTE_NORMAL, 0)
464
if handle in (INVALID_HANDLE_VALUE, 0):
465
e = ctypes.WinError()
466
if e.args[0] == ERROR_ACCESS_DENIED:
467
raise errors.LockFailed(filename, e)
468
if e.args[0] == ERROR_SHARING_VIOLATION:
469
raise errors.LockContention(filename, e)
471
fd = msvcrt.open_osfhandle(handle, cflags)
472
self.f = os.fdopen(fd, pymode)
479
class _ctypes_ReadLock(_ctypes_FileLock):
480
def __init__(self, filename):
481
super(_ctypes_ReadLock, self).__init__()
482
self._open(filename, GENERIC_READ, FILE_SHARE_READ, os.O_RDONLY,
485
def temporary_write_lock(self):
486
"""Try to grab a write lock on the file.
488
On platforms that support it, this will upgrade to a write lock
489
without unlocking the file.
490
Otherwise, this will release the read lock, and try to acquire a
493
:return: A token which can be used to switch back to a read lock.
495
# I can't find a way to upgrade a read lock to a write lock without
496
# unlocking first. So here, we do just that.
499
wlock = _ctypes_WriteLock(self.filename)
500
except errors.LockError:
501
return False, _ctypes_ReadLock(self.filename)
504
class _ctypes_WriteLock(_ctypes_FileLock):
505
def __init__(self, filename):
506
super(_ctypes_WriteLock, self).__init__()
507
self._open(filename, GENERIC_READ | GENERIC_WRITE, 0, os.O_RDWR,
510
def restore_read_lock(self):
511
"""Restore the original ReadLock."""
512
# For win32 we had to completely let go of the original lock, so we
513
# just unlock and create a new read lock.
515
return _ctypes_ReadLock(self.filename)
518
_lock_classes.append(('ctypes', _ctypes_WriteLock, _ctypes_ReadLock))
521
if len(_lock_classes) == 0:
522
raise NotImplementedError(
523
"We must have one of fcntl, pywin32, or ctypes available"
524
" to support OS locking."
528
# We default to using the first available lock class.
529
_lock_type, WriteLock, ReadLock = _lock_classes[0]
532
class _RelockDebugMixin(object):
533
"""Mixin support for -Drelock flag.
535
Add this as a base class then call self._note_lock with 'r' or 'w' when
536
acquiring a read- or write-lock. If this object was previously locked (and
537
locked the same way), and -Drelock is set, then this will trace.note a
543
def _note_lock(self, lock_type):
544
if 'relock' in debug.debug_flags and self._prev_lock == lock_type:
549
trace.note(gettext('{0!r} was {1} locked again'), self, type_name)
550
self._prev_lock = lock_type
552
@contextlib.contextmanager
553
def write_locked(lockable):
554
lockable.lock_write()
added
removed
breezy/lock.py
