1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005 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
# 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.
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
This only does local locking using OS locks for now.
23
22
This module causes two methods, lock() and unlock() to be defined in
24
23
any way that works on the current platform.
26
25
It is not specified whether these locks are reentrant (i.e. can be
27
26
taken repeatedly by a single process) or whether they exclude
28
different threads in a single process. That reentrancy is provided by
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.
31
32
This defines two classes: ReadLock and WriteLock, which can be
32
33
implemented in different ways on different platforms. Both have an
48
from .hooks import Hooks
49
from .i18n import gettext
52
class LockHooks(Hooks):
55
Hooks.__init__(self, "breezy.lock", "Lock.hooks")
58
"Called with a breezy.lock.LockResult when a physical lock is "
62
"Called with a breezy.lock.LockResult when a physical lock is "
66
"Called with a breezy.lock.LockResult when a physical lock is "
71
"""Base class for locks.
73
:cvar hooks: Hook dictionary for operations on locks.
79
class LockResult(object):
80
"""Result of an operation on a lock; passed to a hook"""
82
def __init__(self, lock_url, details=None):
83
"""Create a lock result for lock with optional details about the lock."""
84
self.lock_url = lock_url
85
self.details = details
87
def __eq__(self, other):
88
return self.lock_url == other.lock_url and self.details == other.details
91
return '%s(%s, %s)' % (self.__class__.__name__,
92
self.lock_url, self.details)
95
class LogicalLockResult(object):
96
"""The result of a lock_read/lock_write/lock_tree_write call on lockables.
98
:ivar unlock: A callable which will unlock the lock.
101
def __init__(self, unlock, token=None):
106
return "LogicalLockResult(%s)" % (self.unlock)
111
def __exit__(self, exc_type, exc_val, exc_tb):
112
# If there was an error raised, prefer the original one
115
except BaseException:
121
def cant_unlock_not_held(locked_object):
122
"""An attempt to unlock failed because the object was not locked.
124
This provides a policy point from which we can generate either a warning or
127
# This is typically masking some other error and called from a finally
128
# block, so it's useful to have the option not to generate a new error
129
# here. You can use -Werror to make it fatal. It should possibly also
131
if 'unlock' in debug.debug_flags:
132
warnings.warn("%r is already unlocked" % (locked_object,),
135
raise errors.LockNotHeld(locked_object)
144
have_ctypes_win32 = False
145
if sys.platform == 'win32':
149
have_ctypes_win32 = True
154
class _OSLock(object):
41
from bzrlib.trace import mutter, note, warning
42
from bzrlib.errors import LockError
44
class _base_Lock(object):
160
45
def _open(self, filename, filemode):
161
self.filename = osutils.realpath(filename)
163
self.f = open(self.filename, filemode)
48
self.f = open(filename, filemode)
166
if e.errno in (errno.EACCES, errno.EPERM):
167
raise errors.LockFailed(self.filename, str(e))
168
51
if e.errno != errno.ENOENT:
171
54
# maybe this is an old branch (before may 2005)
172
trace.mutter("trying to create missing lock %r", self.filename)
174
self.f = open(self.filename, 'wb+')
55
mutter("trying to create missing branch lock %r", filename)
57
self.f = open(filename, 'wb')
178
"""Clear the self.f attribute cleanly."""
63
from warnings import warn
64
warn("lock on %r not released" % self.f)
184
69
raise NotImplementedError()
192
class _fcntl_FileLock(_OSLock):
76
############################################################
83
class _fcntl_FileLock(_base_Lock):
195
87
fcntl.lockf(self.f, fcntl.LOCK_UN)
198
92
class _fcntl_WriteLock(_fcntl_FileLock):
202
93
def __init__(self, filename):
203
super(_fcntl_WriteLock, self).__init__()
204
# Check we can grab a lock before we actually open the file.
205
self.filename = osutils.realpath(filename)
206
if self.filename in _fcntl_WriteLock._open_locks:
208
raise errors.LockContention(self.filename)
209
if self.filename in _fcntl_ReadLock._open_locks:
210
if 'strict_locks' in debug.debug_flags:
212
raise errors.LockContention(self.filename)
214
trace.mutter('Write lock taken w/ an open read lock on: %s'
217
self._open(self.filename, 'rb+')
218
# reserve a slot for this lock - even if the lockf call fails,
219
# at this point unlock() will be called, because self.f is set.
220
# TODO: make this fully threadsafe, if we decide we care.
221
_fcntl_WriteLock._open_locks.add(self.filename)
223
# LOCK_NB will cause IOError to be raised if we can't grab a
225
fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
227
if e.errno in (errno.EAGAIN, errno.EACCES):
228
# We couldn't grab the lock
230
# we should be more precise about whats a locking
231
# error and whats a random-other error
232
raise errors.LockContention(self.filename, e)
95
fcntl.lockf(self._open(filename, 'wb'), fcntl.LOCK_EX)
235
_fcntl_WriteLock._open_locks.remove(self.filename)
238
100
class _fcntl_ReadLock(_fcntl_FileLock):
242
def __init__(self, filename):
243
super(_fcntl_ReadLock, self).__init__()
244
self.filename = osutils.realpath(filename)
245
if self.filename in _fcntl_WriteLock._open_locks:
246
if 'strict_locks' in debug.debug_flags:
247
# We raise before calling _open so we don't need to
249
raise errors.LockContention(self.filename)
251
trace.mutter('Read lock taken w/ an open write lock on: %s'
253
_fcntl_ReadLock._open_locks.setdefault(self.filename, 0)
254
_fcntl_ReadLock._open_locks[self.filename] += 1
255
self._open(filename, 'rb')
257
# LOCK_NB will cause IOError to be raised if we can't grab a
259
fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
261
# we should be more precise about whats a locking
262
# error and whats a random-other error
263
raise errors.LockContention(self.filename, e)
266
count = _fcntl_ReadLock._open_locks[self.filename]
268
del _fcntl_ReadLock._open_locks[self.filename]
270
_fcntl_ReadLock._open_locks[self.filename] = count - 1
273
def temporary_write_lock(self):
274
"""Try to grab a write lock on the file.
276
On platforms that support it, this will upgrade to a write lock
277
without unlocking the file.
278
Otherwise, this will release the read lock, and try to acquire a
281
:return: A token which can be used to switch back to a read lock.
283
if self.filename in _fcntl_WriteLock._open_locks:
284
raise AssertionError('file already locked: %r'
287
wlock = _fcntl_TemporaryWriteLock(self)
288
except errors.LockError:
289
# We didn't unlock, so we can just return 'self'
293
class _fcntl_TemporaryWriteLock(_OSLock):
294
"""A token used when grabbing a temporary_write_lock.
296
Call restore_read_lock() when you are done with the write lock.
299
def __init__(self, read_lock):
300
super(_fcntl_TemporaryWriteLock, self).__init__()
301
self._read_lock = read_lock
302
self.filename = read_lock.filename
304
count = _fcntl_ReadLock._open_locks[self.filename]
306
# Something else also has a read-lock, so we cannot grab a
308
raise errors.LockContention(self.filename)
310
if self.filename in _fcntl_WriteLock._open_locks:
311
raise AssertionError('file already locked: %r'
314
# See if we can open the file for writing. Another process might
315
# have a read lock. We don't use self._open() because we don't want
316
# to create the file if it exists. That would have already been
317
# done by _fcntl_ReadLock
319
new_f = open(self.filename, 'rb+')
321
if e.errno in (errno.EACCES, errno.EPERM):
322
raise errors.LockFailed(self.filename, str(e))
325
# LOCK_NB will cause IOError to be raised if we can't grab a
327
fcntl.lockf(new_f, fcntl.LOCK_EX | fcntl.LOCK_NB)
329
# TODO: Raise a more specific error based on the type of error
330
raise errors.LockContention(self.filename, e)
331
_fcntl_WriteLock._open_locks.add(self.filename)
335
def restore_read_lock(self):
336
"""Restore the original ReadLock."""
337
# For fcntl, since we never released the read lock, just release
338
# the write lock, and return the original lock.
339
fcntl.lockf(self.f, fcntl.LOCK_UN)
341
_fcntl_WriteLock._open_locks.remove(self.filename)
342
# Avoid reference cycles
343
read_lock = self._read_lock
344
self._read_lock = None
347
_lock_classes.append(('fcntl', _fcntl_WriteLock, _fcntl_ReadLock))
350
if have_ctypes_win32:
351
from ctypes.wintypes import DWORD, LPWSTR
352
LPSECURITY_ATTRIBUTES = ctypes.c_void_p # used as NULL no need to declare
353
HANDLE = ctypes.c_int # rather than unsigned as in ctypes.wintypes
354
_function_name = "CreateFileW"
356
# CreateFile <http://msdn.microsoft.com/en-us/library/aa363858.aspx>
357
_CreateFile = ctypes.WINFUNCTYPE(
358
HANDLE, # return value
360
DWORD, # dwDesiredAccess
362
LPSECURITY_ATTRIBUTES, # lpSecurityAttributes
363
DWORD, # dwCreationDisposition
364
DWORD, # dwFlagsAndAttributes
365
HANDLE # hTemplateFile
366
)((_function_name, ctypes.windll.kernel32))
368
INVALID_HANDLE_VALUE = -1
370
GENERIC_READ = 0x80000000
371
GENERIC_WRITE = 0x40000000
374
FILE_ATTRIBUTE_NORMAL = 128
376
ERROR_ACCESS_DENIED = 5
377
ERROR_SHARING_VIOLATION = 32
379
class _ctypes_FileLock(_OSLock):
381
def _open(self, filename, access, share, cflags, pymode):
382
self.filename = osutils.realpath(filename)
383
handle = _CreateFile(filename, access, share, None, OPEN_ALWAYS,
384
FILE_ATTRIBUTE_NORMAL, 0)
385
if handle in (INVALID_HANDLE_VALUE, 0):
386
e = ctypes.WinError()
387
if e.args[0] == ERROR_ACCESS_DENIED:
388
raise errors.LockFailed(filename, e)
389
if e.args[0] == ERROR_SHARING_VIOLATION:
390
raise errors.LockContention(filename, e)
392
fd = msvcrt.open_osfhandle(handle, cflags)
393
self.f = os.fdopen(fd, pymode)
399
class _ctypes_ReadLock(_ctypes_FileLock):
400
def __init__(self, filename):
401
super(_ctypes_ReadLock, self).__init__()
402
self._open(filename, GENERIC_READ, FILE_SHARE_READ, os.O_RDONLY,
405
def temporary_write_lock(self):
406
"""Try to grab a write lock on the file.
408
On platforms that support it, this will upgrade to a write lock
409
without unlocking the file.
410
Otherwise, this will release the read lock, and try to acquire a
413
:return: A token which can be used to switch back to a read lock.
415
# I can't find a way to upgrade a read lock to a write lock without
416
# unlocking first. So here, we do just that.
419
wlock = _ctypes_WriteLock(self.filename)
420
except errors.LockError:
421
return False, _ctypes_ReadLock(self.filename)
424
class _ctypes_WriteLock(_ctypes_FileLock):
425
def __init__(self, filename):
426
super(_ctypes_WriteLock, self).__init__()
427
self._open(filename, GENERIC_READ | GENERIC_WRITE, 0, os.O_RDWR,
430
def restore_read_lock(self):
431
"""Restore the original ReadLock."""
432
# For win32 we had to completely let go of the original lock, so we
433
# just unlock and create a new read lock.
435
return _ctypes_ReadLock(self.filename)
437
_lock_classes.append(('ctypes', _ctypes_WriteLock, _ctypes_ReadLock))
440
if len(_lock_classes) == 0:
441
raise NotImplementedError(
442
"We must have one of fcntl or ctypes available"
443
" to support OS locking."
447
# We default to using the first available lock class.
448
_lock_type, WriteLock, ReadLock = _lock_classes[0]
451
class _RelockDebugMixin(object):
452
"""Mixin support for -Drelock flag.
454
Add this as a base class then call self._note_lock with 'r' or 'w' when
455
acquiring a read- or write-lock. If this object was previously locked (and
456
locked the same way), and -Drelock is set, then this will trace.note a
462
def _note_lock(self, lock_type):
463
if 'relock' in debug.debug_flags and self._prev_lock == lock_type:
468
trace.note(gettext('{0!r} was {1} locked again'), self, type_name)
469
self._prev_lock = lock_type
472
@contextlib.contextmanager
473
def write_locked(lockable):
474
lockable.lock_write()
101
def __init__(self, filename):
103
fcntl.lockf(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',
145
class _w32c_WriteLock(_w32c_FileLock):
146
def __init__(self, filename):
147
_w32c_FileLock._lock(self, filename, 'wb',
152
WriteLock = _w32c_WriteLock
153
ReadLock = _w32c_ReadLock
160
# Unfortunately, msvcrt.locking() doesn't distinguish between
161
# read locks and write locks. Also, the way the combinations
162
# work to get non-blocking is not the same, so we
163
# have to write extra special functions here.
166
class _msvc_FileLock(_base_Lock):
176
class _msvc_ReadLock(_msvc_FileLock):
177
def __init__(self, filename):
178
_msvc_lock(self._open(filename, 'rb'), self.LOCK_SH)
181
class _msvc_WriteLock(_msvc_FileLock):
182
def __init__(self, filename):
183
_msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
187
def _msvc_lock(f, flags):
189
# Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
190
# according to the comments, LK_RLCK is open the lock for writing.
192
# Unfortunately, msvcrt.locking() also has the side effect that it
193
# will only block for 10 seconds at most, and then it will throw an
194
# exception, this isn't terrible, though.
201
fpos = os.lseek(fn, 0,0)
204
if flags & _msvc_FileLock.LOCK_SH:
205
if flags & _msvc_FileLock.LOCK_NB:
206
lock_mode = msvcrt.LK_NBLCK
208
lock_mode = msvcrt.LK_LOCK
209
elif flags & _msvc_FileLock.LOCK_EX:
210
if flags & _msvc_FileLock.LOCK_NB:
211
lock_mode = msvcrt.LK_NBRLCK
213
lock_mode = msvcrt.LK_RLCK
215
raise ValueError('Invalid lock mode: %r' % flags)
217
msvcrt.locking(fn, lock_mode, -1)
219
os.lseek(fn, fpos, 0)
231
fpos = os.lseek(fn, 0,0)
235
msvcrt.locking(fn, msvcrt.LK_UNLCK, -1)
237
os.lseek(fn, fpos, 0)
243
WriteLock = _msvc_WriteLock
244
ReadLock = _msvc_ReadLock
246
raise NotImplementedError("please write a locking method "
247
"for platform %r" % sys.platform)
added
removed
bzrlib/lock.py
