1
# Copyright (C) 2005, 2006, 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Locking using OS file locks or file existence.
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.
24
This module causes two methods, lock() and unlock() to be defined in
25
any way that works on the current platform.
27
It is not specified whether these locks are reentrant (i.e. can be
28
taken repeatedly by a single process) or whether they exclude
29
different threads in a single process. That reentrancy is provided by
32
This defines two classes: ReadLock and WriteLock, which can be
33
implemented in different ways on different platforms. Both have an
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
90
have_ctypes_win32 = False
91
if sys.platform == 'win32':
94
import win32con, win32file, pywintypes, winerror
101
have_ctypes_win32 = True
106
class _OSLock(object):
112
def _open(self, filename, filemode):
113
self.filename = osutils.realpath(filename)
115
self.f = open(self.filename, filemode)
118
if e.errno in (errno.EACCES, errno.EPERM):
119
raise errors.LockFailed(self.filename, str(e))
120
if e.errno != errno.ENOENT:
123
# maybe this is an old branch (before may 2005)
124
trace.mutter("trying to create missing lock %r", self.filename)
126
self.f = open(self.filename, 'wb+')
130
"""Clear the self.f attribute cleanly."""
137
from warnings import warn
138
warn("lock on %r not released" % self.f)
142
raise NotImplementedError()
149
LOCK_SH = fcntl.LOCK_SH
150
LOCK_NB = fcntl.LOCK_NB
151
lock_EX = fcntl.LOCK_EX
154
class _fcntl_FileLock(_OSLock):
157
fcntl.lockf(self.f, fcntl.LOCK_UN)
161
class _fcntl_WriteLock(_fcntl_FileLock):
165
def __init__(self, filename):
166
super(_fcntl_WriteLock, self).__init__()
167
# Check we can grab a lock before we actually open the file.
168
self.filename = osutils.realpath(filename)
169
if self.filename in _fcntl_WriteLock._open_locks:
171
raise errors.LockContention(self.filename)
173
self._open(self.filename, 'rb+')
174
# reserve a slot for this lock - even if the lockf call fails,
175
# at thisi point unlock() will be called, because self.f is set.
176
# TODO: make this fully threadsafe, if we decide we care.
177
_fcntl_WriteLock._open_locks.add(self.filename)
179
# LOCK_NB will cause IOError to be raised if we can't grab a
181
fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
183
if e.errno in (errno.EAGAIN, errno.EACCES):
184
# We couldn't grab the lock
186
# we should be more precise about whats a locking
187
# error and whats a random-other error
188
raise errors.LockContention(e)
191
_fcntl_WriteLock._open_locks.remove(self.filename)
195
class _fcntl_ReadLock(_fcntl_FileLock):
199
def __init__(self, filename):
200
super(_fcntl_ReadLock, self).__init__()
201
self.filename = osutils.realpath(filename)
202
_fcntl_ReadLock._open_locks.setdefault(self.filename, 0)
203
_fcntl_ReadLock._open_locks[self.filename] += 1
204
self._open(filename, 'rb')
206
# LOCK_NB will cause IOError to be raised if we can't grab a
208
fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
210
# we should be more precise about whats a locking
211
# error and whats a random-other error
212
raise errors.LockContention(e)
215
count = _fcntl_ReadLock._open_locks[self.filename]
217
del _fcntl_ReadLock._open_locks[self.filename]
219
_fcntl_ReadLock._open_locks[self.filename] = count - 1
222
def temporary_write_lock(self):
223
"""Try to grab a write lock on the file.
225
On platforms that support it, this will upgrade to a write lock
226
without unlocking the file.
227
Otherwise, this will release the read lock, and try to acquire a
230
:return: A token which can be used to switch back to a read lock.
232
if self.filename in _fcntl_WriteLock._open_locks:
233
raise AssertionError('file already locked: %r'
236
wlock = _fcntl_TemporaryWriteLock(self)
237
except errors.LockError:
238
# We didn't unlock, so we can just return 'self'
243
class _fcntl_TemporaryWriteLock(_OSLock):
244
"""A token used when grabbing a temporary_write_lock.
246
Call restore_read_lock() when you are done with the write lock.
249
def __init__(self, read_lock):
250
super(_fcntl_TemporaryWriteLock, self).__init__()
251
self._read_lock = read_lock
252
self.filename = read_lock.filename
254
count = _fcntl_ReadLock._open_locks[self.filename]
256
# Something else also has a read-lock, so we cannot grab a
258
raise errors.LockContention(self.filename)
260
if self.filename in _fcntl_WriteLock._open_locks:
261
raise AssertionError('file already locked: %r'
264
# See if we can open the file for writing. Another process might
265
# have a read lock. We don't use self._open() because we don't want
266
# to create the file if it exists. That would have already been
267
# done by _fcntl_ReadLock
269
new_f = open(self.filename, 'rb+')
271
if e.errno in (errno.EACCES, errno.EPERM):
272
raise errors.LockFailed(self.filename, str(e))
275
# LOCK_NB will cause IOError to be raised if we can't grab a
277
fcntl.lockf(new_f, fcntl.LOCK_EX | fcntl.LOCK_NB)
279
# TODO: Raise a more specific error based on the type of error
280
raise errors.LockContention(e)
281
_fcntl_WriteLock._open_locks.add(self.filename)
285
def restore_read_lock(self):
286
"""Restore the original ReadLock."""
287
# For fcntl, since we never released the read lock, just release the
288
# write lock, and return the original lock.
289
fcntl.lockf(self.f, fcntl.LOCK_UN)
291
_fcntl_WriteLock._open_locks.remove(self.filename)
292
# Avoid reference cycles
293
read_lock = self._read_lock
294
self._read_lock = None
298
_lock_classes.append(('fcntl', _fcntl_WriteLock, _fcntl_ReadLock))
301
if have_pywin32 and sys.platform == 'win32':
302
LOCK_SH = 0 # the default
303
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
304
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
307
class _w32c_FileLock(_OSLock):
309
def _lock(self, filename, openmode, lockmode):
310
self._open(filename, openmode)
312
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
313
overlapped = pywintypes.OVERLAPPED()
315
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000,
317
except pywintypes.error, e:
319
if e.args[0] in (winerror.ERROR_LOCK_VIOLATION,):
320
raise errors.LockContention(filename)
321
## import pdb; pdb.set_trace()
325
raise errors.LockContention(e)
328
overlapped = pywintypes.OVERLAPPED()
330
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
333
raise errors.LockContention(e)
336
class _w32c_ReadLock(_w32c_FileLock):
337
def __init__(self, filename):
338
super(_w32c_ReadLock, self).__init__()
339
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
341
def temporary_write_lock(self):
342
"""Try to grab a write lock on the file.
344
On platforms that support it, this will upgrade to a write lock
345
without unlocking the file.
346
Otherwise, this will release the read lock, and try to acquire a
349
:return: A token which can be used to switch back to a read lock.
351
# I can't find a way to upgrade a read lock to a write lock without
352
# unlocking first. So here, we do just that.
355
wlock = _w32c_WriteLock(self.filename)
356
except errors.LockError:
357
return False, _w32c_ReadLock(self.filename)
361
class _w32c_WriteLock(_w32c_FileLock):
362
def __init__(self, filename):
363
super(_w32c_WriteLock, self).__init__()
364
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
366
def restore_read_lock(self):
367
"""Restore the original ReadLock."""
368
# For win32 we had to completely let go of the original lock, so we
369
# just unlock and create a new read lock.
371
return _w32c_ReadLock(self.filename)
374
_lock_classes.append(('pywin32', _w32c_WriteLock, _w32c_ReadLock))
377
if have_ctypes_win32:
378
# These constants were copied from the win32con.py module.
379
LOCKFILE_FAIL_IMMEDIATELY = 1
380
LOCKFILE_EXCLUSIVE_LOCK = 2
381
# Constant taken from winerror.py module
382
ERROR_LOCK_VIOLATION = 33
385
LOCK_EX = LOCKFILE_EXCLUSIVE_LOCK
386
LOCK_NB = LOCKFILE_FAIL_IMMEDIATELY
387
_LockFileEx = ctypes.windll.kernel32.LockFileEx
388
_UnlockFileEx = ctypes.windll.kernel32.UnlockFileEx
389
_GetLastError = ctypes.windll.kernel32.GetLastError
391
### Define the OVERLAPPED structure.
392
# http://msdn2.microsoft.com/en-us/library/ms684342.aspx
393
# typedef struct _OVERLAPPED {
394
# ULONG_PTR Internal;
395
# ULONG_PTR InternalHigh;
406
class _inner_struct(ctypes.Structure):
407
_fields_ = [('Offset', ctypes.c_uint), # DWORD
408
('OffsetHigh', ctypes.c_uint), # DWORD
411
class _inner_union(ctypes.Union):
412
_fields_ = [('anon_struct', _inner_struct), # struct
413
('Pointer', ctypes.c_void_p), # PVOID
416
class OVERLAPPED(ctypes.Structure):
417
_fields_ = [('Internal', ctypes.c_void_p), # ULONG_PTR
418
('InternalHigh', ctypes.c_void_p), # ULONG_PTR
419
('_inner_union', _inner_union),
420
('hEvent', ctypes.c_void_p), # HANDLE
423
class _ctypes_FileLock(_OSLock):
425
def _lock(self, filename, openmode, lockmode):
426
self._open(filename, openmode)
428
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
429
overlapped = OVERLAPPED()
430
result = _LockFileEx(self.hfile, # HANDLE hFile
431
lockmode, # DWORD dwFlags
432
0, # DWORD dwReserved
433
0x7fffffff, # DWORD nNumberOfBytesToLockLow
434
0x00000000, # DWORD nNumberOfBytesToLockHigh
435
ctypes.byref(overlapped), # lpOverlapped
439
last_err = _GetLastError()
440
if last_err in (ERROR_LOCK_VIOLATION,):
441
raise errors.LockContention(filename)
442
raise errors.LockContention('Unknown locking error: %s'
446
overlapped = OVERLAPPED()
447
result = _UnlockFileEx(self.hfile, # HANDLE hFile
448
0, # DWORD dwReserved
449
0x7fffffff, # DWORD nNumberOfBytesToLockLow
450
0x00000000, # DWORD nNumberOfBytesToLockHigh
451
ctypes.byref(overlapped), # lpOverlapped
456
last_err = _GetLastError()
457
raise errors.LockContention('Unknown unlocking error: %s'
461
class _ctypes_ReadLock(_ctypes_FileLock):
462
def __init__(self, filename):
463
super(_ctypes_ReadLock, self).__init__()
464
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
466
def temporary_write_lock(self):
467
"""Try to grab a write lock on the file.
469
On platforms that support it, this will upgrade to a write lock
470
without unlocking the file.
471
Otherwise, this will release the read lock, and try to acquire a
474
:return: A token which can be used to switch back to a read lock.
476
# I can't find a way to upgrade a read lock to a write lock without
477
# unlocking first. So here, we do just that.
480
wlock = _ctypes_WriteLock(self.filename)
481
except errors.LockError:
482
return False, _ctypes_ReadLock(self.filename)
485
class _ctypes_WriteLock(_ctypes_FileLock):
486
def __init__(self, filename):
487
super(_ctypes_WriteLock, self).__init__()
488
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
490
def restore_read_lock(self):
491
"""Restore the original ReadLock."""
492
# For win32 we had to completely let go of the original lock, so we
493
# just unlock and create a new read lock.
495
return _ctypes_ReadLock(self.filename)
498
_lock_classes.append(('ctypes', _ctypes_WriteLock, _ctypes_ReadLock))
501
if len(_lock_classes) == 0:
502
raise NotImplementedError(
503
"We must have one of fcntl, pywin32, or ctypes available"
504
" to support OS locking."
508
# We default to using the first available lock class.
509
_lock_type, WriteLock, ReadLock = _lock_classes[0]
added
removed
bzrlib/lock.py
